エージェント アダプターは、ブラウザの postMessage() API を使用して、親 iFrame にイベントを送信できます。これらのイベントは、親 iFrame の JavaScript で使用して、カスタム CRM 実装でさまざまなアクションを実行できます。そのためには、アプリで親ウィンドウの MessageEvent をリッスンする必要があります。イベントに基づいて、特定のセッション ID のチケットタブを開くなどのアクションをトリガーできます。通話アダプターとチャット アダプターには、CRM の機能を強化するために使用できる特定のイベントがあります。
コンタクト センター AI プラットフォームは、次の仮想タスク アシスタント イベントをサポートしています。
仮想タスク アシスタントが参加した
仮想タスク アシスタントが退出した
仮想タスク アシスタントのカスタム セッション変数が受信された
エージェント アダプターに関連する投稿イベントの完全なリストについては、 エージェント アダプターをご覧ください。
仮想タスク アシスタントが参加した
このイベントは、仮想タスク アシスタントがセッションに参加したときに渡されます。
データ フィールド
call_id: 音声(IVR)セッションの ID。chat_id: ウェブまたはモバイルのチャット セッションの ID。campaign_id: キャンペーン通話の ID。campaign_name: キャンペーンの名前。virtual_agent_id: 仮想タスク アシスタントの ID。virtual_agent_name: 仮想タスク アシスタントの名前。participant_id: 仮想タスク アシスタントの参加者 ID。queue_id: セッションの発生元のキューの ID。 この ID は、セッションがキューから発生した場合にのみ含まれます。queue_path: セッションの発生元のキューのパス。この ID は、セッションがキューから発生した場合にのみ含まれます。queue_language_id: セッションの発生元のキューの言語。この ID は、セッションがキューから発生した場合にのみ含まれます。session_type: セッションのタイプ(ウェブチャット経由のメッセージング インバウンドなど)。conversation_id: 会話プロファイルを使用する仮想エージェント セッションの ID。session_id: 会話プロファイルを使用しない仮想エージェント セッションの ID。timestamp: イベントの日時。data_parameters: CCAI プラットフォーム ポータルで構成され、仮想タスク アシスタントに送信される変数。
ペイロードのサンプル
{
"type": "Task_VA_Joined",
"data": {
"chat_id": 103646,
"campaign_id": 1432,// omitted if not available
"campaign_name": "Survey Movie", // omitted if not available
"virtual_agent_id": 1,
"virtual_agent_name": "name",
"participant_id": 1,
"queue_id": 8469, // omitted if not available
"queue_path": "Developers / James", // omitted if not available
"queue_language_id": "en", // omitted if not available
"session_type": "Messaging Inbound (SMS)",
"conversation_id": "12345",
"session_id": "78534G4RT4284", // omitted if not available
"timestamp": "1727853575",
"data_parameters": {
"param1": "one",
"param2": "two"
}
}
}
仮想タスク アシスタントが退出した
このイベントは、仮想タスク アシスタントがセッションを退出したときに渡されます。
データ フィールド
call_id: 音声(IVR)セッションの ID。chat_id: ウェブまたはモバイルのチャット セッションの ID。campaign_id: キャンペーン通話の ID。campaign_name: キャンペーンの名前。virtual_agent_id: 仮想タスク アシスタントの ID。virtual_agent_name: 仮想タスク アシスタントの名前。participant_id: 仮想タスク アシスタントの参加者 ID。queue_id: セッションの発生元のキューの ID。 この ID は、セッションがキューから発生した場合にのみ含まれます。queue_path: セッションの発生元のキューのパス。この ID は、セッションがキューから発生した場合にのみ含まれます。queue_language_id: セッションの発生元のキューの言語。この ID は、セッションがキューから発生した場合にのみ含まれます。session_type: セッションのタイプ(ウェブチャット経由のメッセージング インバウンドなど)。conversation_id: 会話プロファイルを使用する仮想エージェント セッションの ID。session_id: 会話プロファイルを使用しない仮想エージェント セッションの ID。timestamp: イベントの日時。finish_reason: 仮想エージェント セッションが終了した理由。data_parameters: CCAI プラットフォーム ポータルで構成され、仮想タスク アシスタントに送信される変数。captured_variables: 仮想タスク アシスタントによってキャプチャされたセッション変数。
ペイロードのサンプル
{
"type": "Task_VA_Left",
"data": {
"chat_id": 103646,
"campaign_id": 1432, // omitted if not available
"campaign_name": "Survey Movie", // omitted if not available
"virtual_agent_id": 1,
"virtual_agent_name": "name",
"participant_id": 1,
"queue_id": 8469, // omitted if not available
"queue_path": "Developers / James", // omitted if not available
"queue_language_id": "en", // omitted if not available
"session_type": "Messaging Inbound (SMS)",
"conversation_id": "12345",
"session_id": "78534G4RT4284", // omitted if not available
"timestamp": "1727853575",
"finish_reason": "Task VA failed", // Finish reason passed when the VTA session ends
"data_parameters": {
"param1": "one",
"param2": "two"
},
"captured_variables": [
{
"intent_name": null,
"variables": {
"testkey": "testvalue"
},
"captured_at": "2024-11-15 16:46:31 UTC",
"timestamp": "1727853575"
},
{
"intent_name": null,
"variables": {
"testkey2": "testvalue2"
},
"captured_at": "2024-11-15 16:46:31 UTC",
"timestamp": "1727853575"
}
]
}
}
仮想タスク アシスタントのセッション変数が受信された
仮想タスク アシスタントがカスタム セッション変数ペイロードを送信すると、この値が渡されます。
データ フィールド
call_id: 音声(IVR)セッションの ID。chat_id: ウェブまたはモバイルのチャット セッションの ID。campaign_id: キャンペーン通話の ID。campaign_name: キャンペーンの名前。virtual_agent_id: 仮想タスク アシスタントの ID。virtual_agent_name: 仮想タスク アシスタントの名前。queue_id: セッションの発生元のキューの ID。 この ID は、セッションがキューから発生した場合にのみ含まれます。queue_path: セッションの発生元のキューのパス。この ID は、セッションがキューから発生した場合にのみ含まれます。queue_language_id: セッションの発生元のキューの言語。この ID は、セッションがキューから発生した場合にのみ含まれます。session_type: セッションのタイプ(ウェブチャット経由のメッセージング インバウンドなど)。conversation_id: 会話プロファイルを使用する仮想エージェント セッションの ID。session_id: 会話プロファイルを使用しない仮想エージェント セッションの ID。timestamp: イベントの日時。data_parameters: CCAI プラットフォーム ポータルで構成され、仮想タスク アシスタントに送信される変数。captured_variables: 仮想タスク アシスタントによってキャプチャされたセッション変数。
ペイロードのサンプル
{
"type": "Task_VA_Variables_Received",
"data": {
"chat_id": 103646,
"campaign_id": 1432, // omitted if not available
"campaign_name": "Survey Movie", // omitted if not available
"virtual_agent_id": 1,
"virtual_agent_name": "name",
"participant_id": 1,
"queue_id": 8469, // omitted if not available
"queue_path": "Developers / James", // omitted if not available
"queue_language_id": "en", // omitted if not available
"session_type": "Messaging Inbound (SMS)",
"conversation_id": "12345",
"session_id": "78534G4RT4284", // omitted if not available
"timestamp": "1727853575",
"data_parameters": {
"param1": "one",
"param2": "two"
},
"captured_variables": [
{
"intent_name": null,
"variables": {
"testkey_1": "testvalue"
},
"captured_at": "2024-11-15 16:46:31 UTC",
"timestamp": "1727853575"
},
{
"intent_name": null,
"variables": {
"testkey_2": "testvalue2"
},
"captured_at": "2024-11-15 16:46:31 UTC",
"timestamp" : "1727853575"
}
]
}
}
カスタム セッション変数の Dialogflow ペイロード
Dialogflow のカスタム セッション変数ペイロードは、仮想タスク アシスタントの投稿イベントをサポートしています。
顧客セッション変数ペイロードで使用できるプロパティは次のとおりです。
capture_type:event: 顧客セッション変数ペイロードで返される値は、仮想タスク アシスタントの投稿イベントで渡す必要があることを示します。capture_type:agent: 顧客セッション変数ペイロードで返される値は、エージェント アダプターに渡す必要があることを示します。capture_type:comment: 顧客セッション変数ペイロードで返される値は、コメントとして CRM レコードに渡す必要があることを示します。invisible_to_adapter_events: このプロパティで指定されたキーの値は、仮想タスク アシスタントの投稿イベントから除外する必要があります。
ペイロードのサンプル
{
"ujet": {
"session_variable": {
"payload": {
"key_two": "$session.params.favfood",
"key_three": "$session.params.budget",
"key_one": "$session.params.location",
"key_four": "$session.params.startdate",
"key_five": "$session.params.enddate"
},
"capture_type": [
"comment",
"agent",
"event"
],
"capture_target": "payload",
"invisible_to_agent": [
"key_one",
"key_two"
],
"invisible_to_adapter_events": [
"key_three",
"key_two"
]
}
}
}