複数のプロバイダーアプリケーションの構成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：2分

    • 仮想エージェント API を使用して複数のプライマリボットがあり、それらを区別する必要があるユースケースをサポートするように、複数のプロバイダーアプリケーションを構成できます。

    始める前に

    必要なロール：admin

    仮想エージェント API アプリケーションスコープ内にいることを確認してください。

    手順

    1. 移動先 すべて > sys_cs_provider_application.
    2. [新規] をクリックして、新しいプロバイダーアプリケーションを作成します。
    3. フォームのフィールドに入力します。
      フィールド 説明
      名前 「VA API カスタムボット」などのプロバイダーアプリケーションの名前。
      プロバイダー プロバイダーとして [VA ボットとボット間のプロバイダー (VA Bot to Bot Provider)] を選択します。
      受信 ID 要求メッセージで使用される一意の受信 ID (例：custom_1)。
      メッセージ認証 受信通信用のトークン付きメッセージ認証の設定。詳細は、「受信通信用のメッセージ認証の設定」を参照してください。
    4. [送信] をクリックします。
    5. 移動先 すべて > System Web Services > REST メッセージ.
    6. [新規] をクリックし、新しい REST メッセージを作成します。
    7. REST メッセージレコードで、フォームフィールドに入力します。
      フィールド 説明
      名前 REST メッセージレコードの名前。これは、新しく作成されたプロバイダーアプリケーションと同じでなければなりません。
      エンドポイント プライマリボットの応答エンドポイント。
    8. [送信] をクリックします。
    9. [HTTP メソッド] セクションで、[新規] をクリックして新しいメソッドを作成するか、デフォルトの GET メソッドを上書きできます。
      フィールド 説明
      名前 HTTP メソッドの名前。「postMessage」と入力します。
      HTTP メソッド [POST] を選択します。
      エンドポイント プライマリボットの応答エンドポイントを入力します。
      認証タイプ 要件に応じて基本認証または OAuth 2.0 認証を構成します。ベーシック認証の構成の詳細については、「ベーシック認証を使用する REST メッセージの構成」を参照してください。OAuth 2.0 の構成の詳細については、「OAuth を使用する REST メッセージの構成」を参照してください。
    10. 新しく作成されたプロバイダーアプリケーションを使用するには、 仮想エージェント API 要求の appInboundId パラメーターでプロバイダーアプリケーションの受信 ID を渡します。
      仮想エージェント API 要求ごとに appInboundId パラメーターでプロバイダーアプリケーションの受信 ID を渡す必要があります。新しく作成されたプロバイダーアプリケーションを使用するサンプル仮想エージェント API 要求を次に示します。
      
{
    "userId": "adminuser1",
    "emailId": "admin@example.com",
    "action": "START_CONVERSATION",
    "message": {
        "text": "",
        "typed": true
    },
    "appInboundId": "custom_1",
    "contextVariables": {
        "app_name": "test"
    }
}

      送信 HTTP ログを表示して、応答エンドポイントが呼び出されたことを確認することで、構成をテストできます。