パスのデータ パラメータ

このページでは、インバウンド セッション開始プロトコル（SIP）ヘッダーからデータ パラメータをキャプチャし、仮想エージェント、仮想タスク アシスタント、アウトバウンド SIP ヘッダーに渡す方法について説明します。

チャネル別のデータ パラメータ

次の表は、チャネル別のデータ パラメータの可用性の概要を示しています。

注: この表の精度を維持するよう努めていますが、新しいデータ パラメータ機能が定期的に追加されるため、不整合が生じる可能性があります。使用可能なパラメータについては、CCAI プラットフォーム ポータルをご覧ください。

データ パラメータの型		カスタマー サポートの仮想エージェント				タスク仮想アシスタント
		ウェブ	モバイル	IVR	SMS	ウェブ	モバイル	IVR	SMS
修正済み		✔	✔	✔				✔
動的読み込み	コンタクト センター AI プラットフォーム（CCAI プラットフォーム）のメタデータ	✔	✔	✔				✔
	署名付きパラメータ	✔	✔
	符号なしパラメータ	✔	✔
	SIP ヘッダー			✔				✔
	フォーム							✔

インバウンド SIP ヘッダーからデータ パラメータをキャプチャする

インバウンド SIP ヘッダーからデータ パラメータをキャプチャし、次の場所に渡すことができます。

• アウトバウンド SIP ヘッダー。

• 仮想エージェントと仮想タスク アシスタント。

CCAI Platform を構成して、インバウンド SIP ヘッダー データを CRM レコードとセッション メタデータ ファイルに含めることもできます。

注: メタデータを含むデータ パラメータは、仮想エージェントにのみ渡すことができます。アウトバウンド SIP ヘッダーに渡すことはできません。

インバウンド SIP ヘッダーからデータ パラメータをキャプチャする手順は次のとおりです。

1. CCAI Platform ポータルで、[設定] > [運用管理] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。

2. [データ パラメータ] ペインに移動します。

3. [音声] で、[IVR セッションのインバウンド SIP ヘッダーからデータ パラメータをキャプチャする] を選択します。

4. 発信者番号に SIP ヘッダー データを使用する手順は次のとおりです。

   1. [発信者番号に SIP ヘッダー データを使用する] を選択します。

   2. [フィールド名] フィールドに、SIP ヘッダー フィールド名を入力します。

5. [Include SIP header data in session CRM records] を選択して、SIP ヘッダー データを CRM レコードのコメントとして含めます。

6. [Include SIP header data in session metadata files] を選択して、セッション メタデータ ファイルに SIP ヘッダー データを含めます。

7. [Save Data Parameters] をクリックします。

CRM レコード

次のコードサンプルは、インバウンド SIP ヘッダーのデータ パラメータが CRM レコードでどのように表示されるかを示しています。

Call redirected to external SIP.
SIP destination: <<SIP Destination URI>>
Data parameters passed:
{
   "<<destination_field_#1>>" : "<<destination_value_#1>>",
   "<<destination_field_#2>>" : "<<destination_value_#2>>"
 }

次の CRM のレコードに SIP ヘッダー データを含めることができます。

• Salesforce

• Zendesk

• Kustomer

• カスタム CRM

セッション メタデータ ファイル

次のコードサンプルは、インバウンド SIP ヘッダーのデータ パラメータがセッション メタデータ ファイルでどのように表示されるかを示しています。

"sip_headers": {
  "header 1": "value 1",
  "header 2": "value 2"
}

アウトバウンド SIP ヘッダーにデータ パラメータを渡す

料金と実装については、サポートにお問い合わせください。

外部 SIP 宛先にデータを送信するために、[Pass Data Parameters] の [Outbound SIP setup] は自動転送機能を使用します。インバウンド SIP ヘッダーで定義されたデータ パラメータが収集され、選択した IVR キューに割り当てられた外部宛先に送信されます。

Pass Data Parameters to an Outbound SIP を使用すると、次のことができます。

• IVR キューレベルで静的または動的データ パラメータを設定します。固定パラメータは、静的な値を渡すのに役立ちます。動的パラメータを使用すると、値を取得して（動的に）渡すことができます。

• 自動リダイレクト時に、送信 SIP ヘッダーで設定パラメータを渡します。

管理設定

1. [Settings > Queue > IVR] に移動し、キューを選択します。

2. [自動リダイレクト] セクションに移動し、切り替えスイッチが [表示] に設定されていることを確認します。

3. [SIP 転送を設定] リンクをクリックします。

4. [Outbound SIP Configuration panel] で、+ccNumber@fqdn 形式で [Destination SIP URI] を入力します。この値には 256 文字の制限があります。

5. [Pass Data Parameters] セクションに移動し、切り替えスイッチが [On] に設定されていることを確認します。宛先 SIP URI を入力するまで、データ パラメータの受け渡しを有効にすることはできません。

SIP ヘッダーの固定パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [タイプ] で [固定] を選択します。

3. 次のフィールドを入力します。

   宛先フィールド: データ パラメータ値が Dialogflow CX に渡されるフィールド名。

   リンク先の値: 渡される値。

   パラメータのサンプルは [プレビュー] に表示されます。

4. [保存] をクリックします。

SIP ヘッダーから動的パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Dynamic] を選択します。

3. [ソース] で [SIP ヘッダー] を選択します。

4. 次のフィールドを入力します。

   Incoming Field: 値が Dialogflow CX に渡される受信 SIP ヘッダーのフィールド名。これは自由テキスト入力（文字列）です

   宛先フィールド: データ パラメータ値が Dialogflow CX に渡されるフィールド名。

   パラメータのサンプルは [プレビュー] に表示されます。

5. [保存] をクリックします。

データレコード

[データレコード] セクションのチェックボックスを使用して、渡されるデータ パラメータをセッション メタデータ ファイルまたは CRM レコードに含めるかどうかを指定します。

[保存] をクリックし、[設定に戻る] リンクをクリックします。

データ パラメータを仮想エージェントと仮想タスク アシスタントに渡す

データ パラメータは、着信通話からデータを収集し、通話中に保持します。その後、通話が仮想エージェントまたは仮想タスク アシスタントに転送されると、Dialogflow CX サービスにデータを渡します。Dialogflow CX エージェントを呼び出すと、データ パラメータは Dialogflow API で設定された形式で返されます。

データ パラメータを追加すると、次のことができます。

• IVR キューレベルで静的データまたは動的データの設定を収集します。固定パラメータを使用すると、静的な値を渡すことができます。動的パラメータを使用すると、値を取得して（動的に）渡すことができます。

• 動的なフォーム パラメータを使用してデータを収集する: フォーム パラメータが構成されている場合にのみ、Virtual Task Assistant で使用できます。仮想タスク アシスタントをデプロイすると、エージェント アダプタでエージェントにデータ収集フォームが提供されます。フォーム パラメータは、エージェントが入力する必要があるフィールドを定義します。たとえば、フォーム フィールドの値が booking_id の場合、対応する手動入力フィールドがアダプタに表示されます。エージェントが Task Assistant を派遣して支払いを受け取るには、booking_id を提供する必要があります。

次のパラメータは、既存または新規のバーチャル エージェントまたはバーチャル タスク アシスタントに追加できます。

• 固定パラメータ

• CCAI プラットフォームのメタデータ パラメータ

• SIP ヘッダー パラメータ

• エージェント フォーム パラメータ（Virtual Task Assistant でのみ使用可能）

固定パラメータを追加する

固定データ パラメータは、システムが VA とタスク アシスタントに自動的に渡すフィールドです。

1. [パラメータを追加] ボタンをクリックします。
2. [Type] で [Fixed] を選択します。
3. 次の項目を入力します。
   1. 宛先フィールド: データ パラメータの値が Dialogflow CX に渡されるフィールド名。
   2. リンク先の値: 渡される値。
4. プレビューにパラメータのサンプルが表示されます。

CCAI Platform メタデータから動的パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Dynamic] を選択します。

3. [ソース] で [CCAIP メタデータ] を選択します。

4. [Incoming Field] プルダウンで、Dialogflow CX に渡される CCAIP メタデータのタイプを選択します。次の CCAIP メタデータ パラメータを渡すことができます。

   • ANI（電話番号）: エンドユーザーが発信している電話番号。

   • コンシューマー ID: プラットフォーム内のエンドユーザーの一意の ID。

   • 通話 ID: プラットフォームでの通話の一意の ID。

   • チケット ID（CRM）: セッションにリンクされている CRM チケット ID。

   • キュー ID: エスカレーション元のセッションのキュー ID。

   • DNIS/TFN: DNIS（Dialed Number Identification Service）または TFN（フリーダイヤル）は、エンドユーザーがお客様のサポート システムに電話をかける際に使用する一意の電話番号を指します。

   • 最新のエージェント ID: CCAI プラットフォーム内で動作する各エージェントに割り当てられるシステム生成 ID。この ID は、進行中の通話の最新のセグメントの処理を担当するエージェントを一意に識別します。

   • Latest agent email（最新のエージェントのメールアドレス）: アクティブな通話の最新のセグメントに対応したエージェントに関連付けられているメールアドレス。

   • キューの言語: 言語要件に基づいて通話の転送先となる指定のキューまたは部門を識別する言語の短いコード。

   • 現在のセンチメント スコア: 通話の最新セグメントの平均センチメント スコア。

   • 全体的な感情スコア: 転送時点までの通話全体における感情または満足度の累積評価。

5. [Destination Field] に、データ パラメータ値が Dialogflow CX に渡されるフィールド名を入力します。パラメータのサンプルがプレビューに表示されます。

6. [保存] をクリックします。

SIP ヘッダーから動的パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Dynamic] を選択します。

3. [ソース] で [SIP ヘッダー] を選択します。次のフィールドを入力します。

   1. Incoming Field: CCAI Platform に渡される着信 SIP ヘッダーのフィールド名。これは自由形式のテキスト入力（文字列）です。

   2. 宛先フィールド: データ パラメータ値が CCAI Platform に渡されるフィールド名。

4. パラメータのサンプルがプレビューに表示されます。

動的なカスタム フォーム パラメータを追加する

注: この機能は Virtual Task Assistant でのみ使用できます。

エージェント フォームのパラメータが構成されると、仮想タスク アシスタントのデプロイ時に、エージェント アダプタでデータ キャプチャ フォームがエージェントに提供されます。フォーム パラメータは、エージェントが入力する必要があるフィールドを定義します。たとえば、フォーム フィールドの値が booking_id の場合、アダプタに手動入力フィールドが表示されます。エージェントが Task Assistant を派遣して支払いを受け取るには、booking_id を入力する必要があります。

1. [+ パラメータを追加] をクリックします。

2. [タイプ] プルダウンで、[動的] を選択します。

3. [ソース] プルダウンで、[フォーム] を選択します。

4. Agent Adapter に表示するフィールド名を入力します。

5. [必須] チェックボックスをオンにして、セッションを仮想タスク アシスタントに転送する前にパラメータを入力する必要があることを指定します。

6. 宛先パラメータを入力します。送信する前にプレビュー ウィンドウでパラメータを確認してください。すべての変更は検証なしで承認されます。

7. [保存] をクリックします。

キューレベルでデータ パラメータの受け渡しを有効にする

注: 選択したキューに仮想エージェントが割り当てられていない場合は、[仮想エージェントを追加] ボタンをクリックして、続行する前に新しい仮想エージェントを構成します。

1. CCAI Platform ポータルで、[設定] > [キュー] > [IVR] に移動し、キューを選択します。

2. キューに仮想エージェントが割り当てられていることを確認し、[仮想エージェントの割り当てを編集] リンクをクリックします。選択したキューにバーチャル エージェントが割り当てられていない場合は、[バーチャル エージェントを追加] ボタンをクリックして、続行する前に新しいバーチャル エージェントを構成します。

3. [Pass Data Parameters] セクションに移動し、切り替えが [On] に設定されていることを確認します。

ウェブ SDK から仮想エージェントにデータ パラメータを渡す

署名なしのカスタムデータを使用して、ウェブ SDK からキューを介して仮想エージェントにデータ パラメータを渡すには、次の手順を行います。

1. CCAI Platform ポータルで、[設定>キュー] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。

2. [ウェブ] ペインで、[編集 / 表示] をクリックします。

3. パラメータを追加するキューをクリックします。

4. SDK で、次の例の形式を使用してカスタムデータを追加します。

var ujet = new UJET({
[...]
  customData: {
  "k1": {
    "label": "Version",
    "value": "1.2.3"
  },
  "k2": {
    "label": "Dashboard",
    "value": "<http://example.com>"
  }
  }

})

次のコマンドを使用して、VA でアクセスできます。

$session.params.valuek1

このコマンドを実行すると、1.2.3 が出力されます。

それぞれにデータ パラメータ コマンドを追加する必要があるため、前の例のように k2 を使用するには、もう 1 つ作成する必要があります。

管理設定

1. [Settings > Queue > IVR] に移動し、キューを選択します。

2. キューにバーチャル エージェントが割り当てられていることを確認し、[バーチャル エージェントの割り当てを編集] リンクをクリックします。

   注: 選択したキューに仮想エージェントが割り当てられていない場合は、[仮想エージェントを追加] ボタンをクリックして、続行する前に新しい仮想エージェントを構成します。

3. [Pass Data Parameters] セクションに移動し、切り替えがオンになっていることを確認します。

固定パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Fixed] を選択します。

3. 次のフィールドを入力します。

   宛先フィールド: データ パラメータ値が Dialogflow CX に渡されるフィールド名。

   リンク先の値: 渡される値。

   パラメータのサンプルがプレビューに表示されます。

CCAI Platform メタデータから動的パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Dynamic] を選択します。

3. [ソース] で [CCAI プラットフォーム メタデータ] を選択します。

4. [Incoming Field] プルダウンで、Dialogflow に渡す必要がある CCAI Platform メタデータのタイプを選択します。

   次の CCAI Platform メタデータ パラメータを渡すことができます。

   ANI（電話番号）

   コンシューマ ID

   通話 ID

   チケット ID（CRM）

   キュー ID

5. [宛先フィールド] に、データ パラメータ値が Dialogflow CX に渡されるフィールド名を入力します。

   パラメータのサンプルがプレビューに表示されます。

6. [保存] をクリックします。

SIP ヘッダーから動的パラメータを追加する

1. [パラメータを追加] ボタンをクリックします。

2. [Type] で [Dynamic] を選択します。

3. [ソース] で [SIP ヘッダー] を選択します。

4. 次のフィールドを入力します。

   Incoming Field: 値が Dialogflow CX に渡される受信 SIP ヘッダーのフィールド名。これは自由入力のテキスト（文字列）です。

   宛先フィールド: データ パラメータ値が Dialogflow CX に渡されるフィールド名。

   パラメータのサンプルがプレビューに表示されます。

データレコード

[データレコード] セクションのチェックボックスを使用して、渡されるデータ パラメータをセッション メタデータ ファイルまたは CRM レコードに含めるかどうかを指定します。

[保存] をクリックし、[設定に戻る] リンクをクリックします。

セッション中に仮想エージェントにデータ パラメータを渡す

この機能により、セッション中にデータ パラメータを送信できます。セッション中に仮想エージェントとコンテキスト データを共有できるため、動的なやり取りが促進され、ユーザー エクスペリエンスが向上します。このアップデートでは、チャット セッション中に SDK からデータ パラメータを受け取り、対応するセッションが進行中の場合は仮想エージェントに渡すことができる新しい API エンドポイントが導入されます。これは、セッション中の認証などのシナリオで役立ちます。

Apps API を介して、保護された（署名付き）データまたは保護されていない（署名なし）データを送信できます。ただし、API へのすべてのリクエストは API キーによって保護されるため、転送中にデータが保護されます。

カスタムデータは次のプロセスで処理されます。

1. カスタムデータは、SDK または Apps API エンドポイントを介して取り込まれます。

2. カスタムデータは、チャットの既存のデータとともに保存または統合されます。

3. カスタムデータは、エンドユーザーのレスポンスからの detect_response 呼び出しに、メッセージとともに添付されます。

4. カスタムデータが仮想エージェントに渡されます。

5. 新しいカスタムデータはすべて CRM に投稿されます。

API エンドポイント

通話またはチャットのセッション中にカスタムデータを受け入れるには、Apps API エンドポイントを使用する必要があります。

POST
/apps/api/v1/[chats|calls]/:id/custom_data

ペイロードは、セキュア（署名付き）または非セキュア（署名なし）の 2 種類のいずれかを受け取ります。

保護されたデータ（JWT を使用して署名）:

{
"signed": true,
"signed_data": "JWT_SIGNED_DATA"
}
{
  "custom_data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  },
  "exp": 1734567890,
  "iat": 1734560000
}

保護されていないデータ:

{
  "signed": false,
  "data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  }
}