チャットの API 直接アクセス ポイント

チャットの API ダイレクト アクセス ポイント(DAP)を使用すると、構成した外部 API エンドポイントからのレスポンスに基づいて、受信したチャット セッションをキューに自動的にルーティングできます。これにより、エンドユーザーがキューメニューから選択する必要がなくなります。エンドポイントは、独自のサービスまたはサードパーティ サービスのいずれかを使用できます。

この機能を有効にすると、エンドユーザーがチャットを開始したときに、CCAI Platform は API エンドポイントにリクエストを送信します。API はルーティングデータ(Key-Value ペア)を返します。CCAI Platform はこのデータを使用して、エンドユーザーを適切なキューに照合します。一致するものが見つからない場合は、フォールバックとして標準のキューメニューが表示されます。

API DAP は次の用途に使用できます。

  • ウェブチャットとモバイルチャット

  • 新規チャットと再開チャット

始める前に

デフォルトでは、この機能は無効になっています。インスタンスで有効にするには、サポート Google Cloud にお問い合わせください。

DAP の種類

DAP には、API レスポンスと Webhook レスポンスの 2 種類があります。DAP の種類ごとにワークフローが異なります。

API レスポンス

API レスポンスのワークフローは次のとおりです。

  1. エンドユーザーが新規チャットまたは再開チャットを開始します。

  2. キューメニューが表示される前に、CCAI Platform は API エンドポイントにリクエストを送信します。これには、セッション メタデータやカスタムデータなど、定義したパラメータが含まれます。

  3. API は 1 つ以上の Key-Value ペアを返します。

  4. CCAI Platform は、これらのペアをチャットキューで構成された Key-Value ペアと照合します。チャットをキューにルーティングするには、すべてのペアが一致する必要があります。

  5. 一致するものが見つかった場合、エンドユーザーはそのキューに直接ルーティングされます。

  6. 次のいずれかが発生すると、標準のキューメニューが表示されます。

    • 一致するものが見つからない。

    • API が、構成された API リクエスト タイムアウト内に応答しない。

Webhook レスポンス

Webhook レスポンスのワークフローは次のとおりです。

  1. エンドユーザーが新規チャットまたは再開チャットを開始します。

  2. キューメニューが表示される前に、CCAI Platform は API エンドポイントにリクエストを送信します。これには、Webhook URL が含まれます。

  3. API は、API リクエスト タイムアウト内に確認応答(HTTP 200)を返します。

  4. システムはリクエストを処理し、Webhook を使用してルーティングデータ(Key-Value ペア)を CCAI Platform に送信します。

  5. CCAI Platform は、これらのペアをチャットキューで構成された Key-Value ペアと照合します。チャットをキューにルーティングするには、すべてのペアが一致する必要があります。

  6. 一致するものが見つかった場合、エンドユーザーはそのキューに直接ルーティングされます。

  7. 次のいずれかが発生すると、標準のキューメニューが表示されます。

    • 一致するものが見つからない。

    • API リクエスト タイムアウト内に確認応答を受信しない。

    • API コールバック タイムアウト内に Webhook レスポンスを受信しない。

チャットの API DAP をグローバルに構成する

チャットの API DAP をグローバルに構成する手順は次のとおりです。

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

  2. [API リクエスト ダイレクト アクセス ポイント] ペインに移動し、[API リクエスト ダイレクト アクセス ポイントを管理] をクリックします。

  3. [チャット] タブをクリックします。

  4. [チャットの API リクエスト ダイレクト アクセス ポイント] 切り替えボタンをクリックしてオンにします。

  5. [ダイレクト アクセス ポイント タイプ] で、次のいずれかの DAP タイプを選択します。

    • API レスポンス: API はレスポンスでルーティングデータを返します。

    • Webhook レスポンス: API はリクエストを確認し、 ルーティングデータを Webhook に送信します。

  6. API DAP をトリガーするチャットタイプを指定するには、[チャットタイプ] で 次のいずれかまたは両方を選択します。

    • 新規チャット

    • 再開チャット

  7. [API リクエスト] フィールドに、DAP に使用する API エンドポイント URL を入力します。

  8. 認証を構成するには、次のいずれかを行います。

    • 基本認証を構成する手順は次のとおりです。

      1. [**認証方法**] で [**基本認証**] を選択します。

      2. [認証情報] にユーザー名と パスワードを入力します。

    • カスタム ヘッダーを構成する手順は次のとおりです。

      1. [**認証方法**] で [**カスタム ヘッダー**] を選択します。

      2. [フィールドを追加] をクリックします。[フィールドを追加] ダイアログが表示されます。

      3. フィールドキーとフィールド値を入力し、[保存] をクリックします。

  9. API リクエスト タイムアウトを構成する手順は次のとおりです。

    1. [API リクエスト タイムアウト] に、 CCAI Platform が API からのレスポンスを待機してからタイムアウトするまでの秒数を設定します。

    2. 省略可([Webhook レスポンス] DAP タイプを選択した場合にのみ表示されます): [API コールバック タイムアウト] に、CCAI Platform が(最初の確認応答の後に)Webhook からのルーティングデータを待機してからタイムアウトするまでの秒数を設定します。

  10. リクエスト メソッドを設定するには、[API リクエスト メソッド] で [POST] または [GET] を選択します。

  11. データ パラメータを構成する手順は次のとおりです。

    1. [データ パラメータを渡す] 切り替えボタンをクリックしてオンにします。

    2. [パラメータを追加] をクリックします。[パラメータを追加] ダイアログが表示されます。

    3. 次のいずれかを行います。

      • 固定データ パラメータを構成する手順は次のとおりです。

        1. [タイプ] リストで [固定] をクリックします。

        2. [宛先フィールド] フィールドに、宛先キーを入力します。

        3. [宛先値] フィールドに、宛先値を入力します。 データ パラメータのプレビューが [プレビュー] フィールドに表示されます。

      • 動的データ パラメータを構成する手順は次のとおりです。

        1. [タイプ] リストで [動的] をクリックします。

        2. 次のいずれかを行います。

          • セッション メタデータを構成する手順は次のとおりです。

            1. [ソース] リストで [セッション メタデータ] を選択します。

            2. [受信フィールド] リストで、メタデータ タイプを選択します。

          • 署名付きカスタムデータを構成する手順は次のとおりです。

            1. [ソース] リストで [署名付きカスタムデータ] を選択します。

            2. [受信フィールド] リストに、受信フィールドを入力します。

          • 署名なしカスタムデータを構成する手順は次のとおりです。

            1. [ソース] リストで [署名なしカスタムデータ] を選択します。

            2. [受信フィールド] リストに、受信フィールドを入力します。

        3. [宛先フィールド] フィールドに、宛先フィールドを入力します。 データ パラメータのプレビューが [プレビュー] フィールドに表示されます。

    4. [パラメータを追加] をクリックします。データ パラメータが [データ パラメータ] リストに表示されます。

  12. 省略可: 構成をテストする手順は次のとおりです。

    1. [接続をテスト] セクションに移動します。データ パラメータがリストに表示されます。

    2. 省略可: 別のパラメータ値を試すには、リストでパラメータ値を編集します。

    3. [この接続をテスト] をクリックします。

  13. [チャット API を保存] をクリックします。

ルーティング ロジックを変更する

ルーティング ロジックとは、CCAI Platform がチャットをキューに照合するためにさまざまな照合タイプを試す順序のことです。CCAI Platform は各照合タイプを順番に評価し、最初に一致したキューにチャットをルーティングします。一致するものが見つからない場合は、標準のキューメニューが表示されます。

照合タイプは次の 3 つです。

  • API レスポンス: API レスポンスの Key-Value ペアに基づいて照合します。

  • 一般的なアクセス ポイント ラベル: キューの一般的なアクセス ポイント ラベルに基づいて照合します。

  • ユーザー セグメンテーション: ユーザー セグメント データに基づいて照合します。

ルーティング ロジックを変更する手順は次のとおりです。

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

  2. [API リクエスト ダイレクト アクセス ポイント] ペインに移動し、[API リクエスト ダイレクト アクセス ポイントを管理] をクリックします。

  3. [チャット] タブをクリックします。

  4. [Routing Logic] で、照合タイプにポインタを合わせて 新しい位置にドラッグします。

  5. 必要に応じて、この手順を繰り返します。

  6. [チャット API を保存] をクリックします。

キューレベルでチャットの DAP を構成する

キューレベルでチャットの DAP を構成する手順は次のとおりです。

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

  2. 必要なチャネルに応じて、次のいずれかを行います。

    • [モバイル] ペインで、[編集 / 表示] をクリックします。

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

  3. 編集するキューをクリックします。

  4. [設定] ペインで、[アクセス ポイント] セクションに移動します。

  5. [ダイレクト アクセス ポイントを作成] をクリックします。[ダイレクト アクセス ポイントを作成] ダイアログが表示されます。

  6. [アクセス ポイント タイプ] リストで [API レスポンス] をクリックします。

  7. [アクセス ポイント名] フィールドに、アクセス ポイント名を入力します。

  8. [Key-Value を追加] をクリックします。API レスポンスで返される Key-Value ペアと照合する Key-Value ペアを入力します。

  9. 前の手順を繰り返して、Key-Value ペアを追加します。

  10. 省略可: [挨拶メッセージ] フィールドに、エンドユーザーがこのメニュー オプションに誘導されたときに使用する挨拶メッセージを入力します。

  11. [作成] をクリックします。DAP が [アクセス ポイント] リストに表示されます。