チャットリンクについて
チャットリンクは、djr://chat/send-message/ に続けて送信したい「チャット送信」ブロックに記述することで、
メッセージ送信リンクとして利用できる機能です。
特定のメッセージを受信したときをきっかけとして VA を動作させたいとき、
VAアクションに定型文として登録しておくことも出来ますが、
VAアクションに全機能を登録しておくと利用者が選択に迷ったり誤選択してしまうことがあります。
「VAアクション」では「機能呼び出し」だけしてVAを呼び出すようにし、
チャットリンクで特定の文字列を表示して個別機能を選択させる際に利用します。
本ページでは、チャットリンクの書式ルールと記述方法(設定方法)、利用方法、活用シーンをご案内します。
1. チャットリンクとは
チャットリンクは、次の共通書式で表されるURL形式の文字列です。
djr://chat/send-message/<メッセージ文字列>
djr://chat/send-message/のあとに続けた部分が、送信されるメッセージ本文になります。- メッセージの書き方は 2種類 あり、メッセージに含める文字によって使い分けます。
- どちらの書き方でも、改行を含めることはできません。メッセージは1行で記述します。
2. チャットリンクの書き方(設定方法)
チャットリンクのメッセージ部分は、次のいずれかの書き方で記述します。
書き方1：そのまま記述する
書式は次のとおりです。メッセージ文字列をそのまま続けて記述します。
djr://chat/send-message/<半角スペースを含まない文字列>
- 半角スペース・半角スラッシュ(/)・改行が現れるまでの間が、チャットリンクとして処理されます。
(これらの文字を含めると、その位置でメッセージが区切られます)。 - 全角スペースは含むことができます。
▼ 記述例(例文中のスペースは全角スペースです)
djr://chat/send-message/これは チャットリンクとして有効です。
▶️ これは チャットリンクとして有効です。
書き方2：ダブルクォーテーションで囲む
書式は次のとおりです。メッセージ文字列全体をダブルクォーテーション " で囲んで記述します。
djr://chat/send-message/"<文字列>"
- ダブルクォーテーション
"で囲むことで、半角スペースおよび半角スラッシュ(/)を含めることができます。 - 改行を含めることはできません。
- 文字列中のダブルクォーテーション
"とバックスラッシュ\は、エスケープ処理が必要です(「3. エスケープ処理のルール」を参照)。
▼ 記述例(仕様書記載の例)
djr://chat/send-message/"これは チャットリンクとして有効ですか？ \"はい。有効です！\""
▶️ これは チャットリンクとして有効ですか？ "はい。有効です！"
3. 書き方2のエスケープ処理のルール
書き方2では、メッセージ文字列中にダブルクォーテーション " やバックスラッシュ \ が含まれる場合、
次のようにすることでエスケープ処理を行えます。
| 送りたい文字 | 記述方法 |
|---|---|
ダブルクォーテーション " | \" と記述する |
バックスラッシュ \ | \\ と記述する |
- 文字列中のダブルクォーテーション
"は、バックスラッシュ\でエスケープ処理をします(\")。 - 文字列中のバックスラッシュ
\は、バックスラッシュ\でエスケープ処理をします(\\)。バックスラッシュ文字は原則エスケープ処理であり、バックスラッシュをエスケープするためにバックスラッシュを重ねます。 - メッセージ文字列がダブルクォーテーション
"で始まっている場合は、「"<文字列>"」を意図しているのか見分けがつかないため、書き方2として処理されます。
書き方1として記述しても区別できませんので、"から始まる文字列を送りたい場合は書き方2で\"とエスケープして記述してください。
4. 記述例 早見表
| 記述例 | 送信されるメッセージ | 備考 |
|---|---|---|
djr://chat/send-message/これは チャットリンクとして有効です。 | これは チャットリンクとして有効です。 | 仕様書記載の例(全角スペースを含む) |
djr://chat/send-message/"これは チャットリンクとして有効ですか？ \"はい。有効です！\"" | これは チャットリンクとして有効ですか？ "はい。有効です！" | 半角スペースとダブルクォーテーションのエスケープ処理あり |
djr://chat/send-message/お世話になっております。 | お世話になっております。 | 記述例(書き方1) |
djr://chat/send-message/"半角スペース と /スラッシュ/ を含めます" | 半角スペース と /スラッシュ/ を含めます | 記述例(書き方2) |
5. 利用方法
- 「チャット送信」ブロックを編集します。
- メッセージに「半角スペース」「半角スラッシュ(/)」「ダブルクォーテーション(“)」「バックスラッシュ(\)」が含まれるかを確認します。
- 含まれない場合は 書き方1(そのまま記述)、含まれる場合は 書き方2(ダブルクォーテーションで囲み、必要に応じてエスケープ)を選びます。
- メッセージ欄に
djr://chat/send-message/に続けて、選んだ書き方のルールでメッセージを記述します。
▼ 書き方の使い分けまとめ
| メッセージに含まれる文字 | 使用する書き方 | 記述方法 |
|---|---|---|
| 半角スペース・半角スラッシュを含まない | 書き方1 | そのまま記述する |
| 半角スペース・半角スラッシュを含む | 書き方2 | " で囲んで記述する |
ダブルクォーテーション(")やバックスラッシュ(\)も含む | 書き方2 | " で囲み、\" や \\ とエスケープして記述する |
6. 設定例
7. よくあるつまずき(Q&A)
Q1. 半角スペースを入れたら、スペースの後ろが送信されません
書き方1では、半角スペースが区切りになります。
全角スペースに置き換えるか、書き方2(ダブルクォーテーションで囲む)をご利用ください。
Q2. メッセージに「/」(半角スラッシュ)を含めたい
書き方1では、半角スラッシュも区切りになります。
書き方2でダブルクォーテーションで囲んでください。
Q3. 改行を含めたい
どちらの書き方でも、改行を含めることはできません。
メッセージは1行で記述してください。
Q4. メッセージ中の「”」(ダブルクォーテーション)をそのまま送りたい
書き方2で \" とエスケープして記述してください。
Q5. メッセージ中の「\」(バックスラッシュ)をそのまま送りたい
書き方2で \\ とエスケープして記述してください。
Q6. 「”」で始まる文字列を送りたい
文字列がダブルクォーテーションで始まっている場合は、書き方2として処理されます。
書き方2の書式で、送りたい " をすべて \" とエスケープして記述してください。
#チャットリンク #ChatLink #定型メッセージ #エスケープ #送信メッセージ
