カスタムバーチャルエージェント統合の実装

このページでは、カスタムバーチャルエージェント連携を実施する際に従わなければならない一般的なプロセスについて説明します。すべての環境、すべてのカスタム連携は異なります。お客様の状況により、ここに記載されていない追加作業が必要な場合があります。連携に必要なものは何か、また、追加の作業が必要な場合は、このページに記載されているプロセスのどこに当てはまるかを理解することは、お客様の責任です。

これらの各タスクを指定された順序で実行します。

バーチャルエージェントと認可サーバーのセットアップ

プロバイダー環境にバーチャルエージェントをセットアップします。期待通りに動くかどうか、徹底的なテストを完了させます。

連携が動的認証を使用する場合、認可サーバーを設定します。

プロキシトンネルのエンドポイントをセットアップする

このタスクを完了するには、プロキシトンネルのコードを配置し、コードを開始し、エンドポイントを公開するコマンドを実行する必要があります。必要とされる正確なステップやコマンドは、環境ごとに異なります。

Studioスクリプトをセットアップ

必要な権限アプリケーション > Studio > スクリプト > 作成/編集、インポート/エクスポート、デバッグ、オーバーライドをロックアプリケーション > Studio > プロンプト > レコードアプリケーション > Studio > ファイルブラウザ > 編集、作成

必要なStudioスクリプトがすべて本稼働環境にあることを確認します。次のことが必要になる場合があります。

  • ある環境からスクリプト をエクスポートし、 それを別の環境にインポートします。カスタムバーチャルエージェント連携に関連するスクリプト専用のフォルダーを作成したい場合もあるでしょう。
  • スクリプトに新しい名前を付けて保存します。バージョン管理に命名規則を使用している場合、スクリプトを開発から本稼働に移動させるには、スクリプトの名前を変更する必要があります。Studioは、スクリプト名の変更に対応していません。名前を変更するには、ファイル > 名前を付けて保存オプションを使用する必要があります。

バーチャルエージェントのアクションが正しくセットアップされていることを確認します。これは次のことを意味します:

  • Custom Exchange Endpointアプリはバーチャルエージェントハブ作成されます。
  • スクリプト内のすべてのバーチャルエージェントアクションには、Custom Exchange Endpointアプリが割り当てられています
  • スクリプトとバーチャルエージェントの接続は、スクリプトを本稼働環境に移行した後、期待通りに動作します。バーチャルエージェントハブのCustom Exchange Endpointアプリからテストを行い、接続を確認します。

CXoneとバーチャルエージェントの間の接続を設定します。

必要な権限アプリケーション > Studio > スクリプト > 作成/編集

バーチャルエージェントとCXoneの接続は、Studioスクリプトの中のバーチャルエージェントアクションです。アクションは2つのシステムが通信できるように必要な詳細を設定しなければならない。これはバーチャルエージェントハブで構成アプリを作成し、それをスクリプト内のバーチャルエージェントアクションのすべてのインスタンスに割り当てることで実行します。

スクリプトに複数のバーチャルエージェントアクションがある場合でも、このタスクを完了するのは1回だけです。

バーチャルエージェントのアクションはVoiceBot ExchangeおよびTextBot Exchangeです。

Custom Exchange Endpointアプリの設定ページは、使用している連携バージョンによって異なります。お使いのバージョンに合わせて、以下のセクションの手順に従ってください。バージョン間の違いは以下の通りです。

  • 1.0.0:シングル認証ヘッダーに対応しています。このヘッダーは、ExternalIntegrationBotExchangeRequestリクエストとともに送信されます。
  • 2.0.0:複数の認証ヘッダーに対応しています。ヘッダーは、キーと値のペアとしてExternalIntegrationBotExchangeRequestリクエストとともに送信されます。
  • 3.0.0:複数の認可ヘッダーとStandardBotをサポートしています。ヘッダーは、キーと値のペアとしてExternalIntegrationBotExchangeRequestリクエストとともに送信されます。
  • 連携バージョン1.0.0と2.0.0は、将来のリリースで非推奨となります。バージョン3.0.0は、カスタムバーチャルエージェント連携で使用するのに適したバージョンです。現在、バージョン1.0.0または2.0.0を使用している場合は、3.0.0へのアップグレードを予定してください。バージョン3.0.0はバージョン2.0.0とほぼ同じです。主な違いは、3.0.0でStandardBotへのサポーが追加されたことです。

連携バージョン1.0.0を設定する

  1. Studioで、スクリプトを開くか作成し、バーチャルエージェントのアクションを追加します(まだ含まれていない場合)。
  2. 仮想エージェントアクションをダブルクリックして、 バーチャルエージェントハブ
  3. ボットの追加をクリックします。
  4. バーチャルエージェント(ボット)名 を入力し、Custom Exchange Endpointボットプロバイダーとして選択します。
  5. [次へ] をクリックします。
  6. 統合バージョン1.0.0選択します。

  7. バーチャルエージェントのWebhook URLを入力します。これは、スクリプトがすべてのリクエストを送信するエンドポイントです。
  8. カスタムバーチャルエージェント統合で認可を使用している場合は、バーチャルエージェントサービスから認可ヘッダーを入力します。このヘッダーは、ExternalIntegrationBotExchangeRequestリクエストとともに送信されます。
  9. バーチャルエージェントサービスに送信される各リクエストにパラメーターを含めるには、エンドポイントパラメーターを追加をクリックします。ユーザーの名前を入力します。このステップを繰り返して、さらにパラメーターを追加します。

  10. デフォルトのタイムアウトを変更するには、スクリプトがタイムアウトするまでにバーチャルエージェントサービスが応答するのを待機するミリ秒数を入力します。デフォルトは10000です。

  11. 構成ページでをクリックします。
  12. ボットの追加ウィザードで、音声とトランスクリプトのページの入力を完了します。
  13. 統合をテストします
  14. スクリプトのバーチャルエージェントアクションにカスタムExchangeエンドポイント構成を割り当てます。

連携バージョン2.0.0および3.0.0を設定する

  1. Studioで、スクリプトを開くか作成し、バーチャルエージェントのアクションを追加します(まだ含まれていない場合)。
  2. 仮想エージェントアクションをダブルクリックして、 バーチャルエージェントハブ
  3. ボットの追加をクリックします。
  4. バーチャルエージェント(ボット)名 を入力し、Custom Exchange Endpointボットプロバイダーとして選択します。
  5. [次へ] をクリックします。
  6. 統合バージョン1.0.0統合バージョン2.0.0または3.0.0を選択する

  7. バーチャルエージェントのWebhook URLを入力します。これは、スクリプトがすべてのリクエストを送信するエンドポイントです。
  8. Webhook URLとともにヘッダーを送信するには、カスタムヘッダーを追加をクリックします。これには認可ヘッダーが含まれます。ユーザーの名前を入力します。このステップを繰り返して、さらにヘッダーを追加します。

    OAuthダイナミック認証を使用している場合は、このステップをスキップしてください。

  9. バーチャルエージェントサービスに送信される各リクエストにパラメーターを含めるには、エンドポイントパラメーターを追加をクリックします。ユーザーの名前を入力します。このステップを繰り返して、さらにパラメーターを追加します。

  10. デフォルトのタイムアウトを変更するには、スクリプトがタイムアウトするまでにバーチャルエージェントサービスが応答するのを待機するミリ秒数を入力します。デフォルトは10000です。

  11. カスタムバーチャルエージェント統合によりmTLS認証を使用するには、Webhooクライアント証明書の追加をクリックし、証明書の詳細を構成します
  12. カスタム統合によりダイナミック認証を構成するには、O Authが必要ですをクリックして、 オンに切り替え、必須フィールドを構成します
  13. 構成ページでをクリックします。
  14. ボットの追加ウィザードで、音声とトランスクリプトのページの入力を完了します。
  15. 統合をテストします
  16. スクリプトのバーチャルエージェントアクションにカスタムExchangeエンドポイント構成を割り当てます。

クライアント証明書を使用してmTLS認証を設定する

mTLS認証をカスタム連携で使用するために、クライアント証明書とキーをカスタムExchangeエンドポイントアプリに追加できます。

始める前に、PEM形式の証明書と秘密鍵が必要です。

  1. バーチャルエージェントハブで、変更するカスタムExchangeエンドポイントアプリを選択します。

  2. Webhookクライアント証明書の追加をクリックします。

  3. オプションで証明書名を入力します。これは証明書を識別する任意の単語またはフレーズである可能性があります。

  4. 証明書のPEMファイルからエンコードされたプレーンテキストをコピーし、証明書フィールドに貼り付けます。

  5. PEMファイルから秘密鍵のエンコードされたプレーンテキストをコピーし、秘密鍵フィールドに貼り付けます。

  6. 証明書パスワードを入力します。

  7. さらにクライアント証明書を追加する必要がある場合は、クライアント証明書を追加をクリックし、手順2~5を繰り返します。

  8. 変更を保存します。

バージョン2.0.0または3.0.0用にOAuthでダイナミック認証を構成する

カスタム連携でダイナミック認証を使用している場合、カスタムエクスチェンジエンドポイントアプリにトークンを管理させることができます。このオプションを有効にすると、認可サーバーが取得したカスタムヘッダーの値がオーバーライドされます。

  1. バーチャルエージェントハブで、変更するカスタムExchangeエンドポイントアプリを選択します。
  2. OAuthが必要ですをクリックすると、オンに切り替わります。
  3. OAuth URLフィールドに認可サーバーのURLを入力します。
  4. リクエストコンテンツタイプの下でJSONまたはフォームURLのエンコードを選択します。これはOAuthリクエストの本文タイプです。
  5. OAuthリクエストの追加をクリックし、認証リクエスト本文を形成するキーと値のペアを入力します。これには、APIシークレットやクライアント認証情報などが含まれます。キーの名前を入力します。このステップを繰り返して、さらにリクエストパラメーターを追加します。
  6. OAuthヘッダーの追加をクリックし、認可サーバーがリクエストに含めることを要求するヘッダーのキーと値のペアを入力します。キーの名前を入力します。このステップを繰り返して、さらにヘッダーパラメーターを追加します。
  7. バーチャルエージェントプロバイダーへのリクエストで送信される認証ヘッダーをカスタマイズするには、カスタムヘッダー認証をクリックしてオンに切り替えてから、次のようにします。

    1. 認証ヘッダーのキーと値のペアキーの名前を変更するには、新規の認証ヘッダー名を入力します。デフォルトは認可です。
    2. ヘッダー値とともに送信されるプレフィックスを変更するには、新規の認証ヘッダー値プレフィックス を入力します。デフォルトは、 ベアラです。
  8. 認証トークンの有効期限をカスタマイズするには、新規の認証有効期限を入力します。デフォルトは0です。

  9. OAuth証明書の選択のドロップダウンからオプションを選択し、OAuth認可サーバーで証明書を使用するかどうかを示します。証明書を使用する場合は、Webhookクライアント証明書または認可サーバー用の新規クライアント証明書を追加を選択することができます。

  10. 保存をクリックします。

音声と写しのオプションを設定する

音声のページでは、カスタムExchangeエンドポイントアプリを音声バーチャルエージェントまたはテキストバーチャルエージェントに設定できます。テキストバーチャルエージェントについては、追加の設定はありません。音声バーチャルエージェントについては、次から選択できます:

  • 実行している音声連携の種類。
  • 使用するテキスト読み上げサービス(TTS)を選択します。
  • 使用するトランスクリプション(音声テキスト化/STT)サービス。

カスタムExchangeエンドポイントウィザードのトランスクリプトのページでは、コンタクトとのバーチャルエージェントの会話のトランスクリプトをキャプチャするため連携を希望するかどうかを選択できます。

  1. バーチャルエージェントハブで、カスタムのExchangeエンドポイントのアプリを追加し、バージョン1.0.0またはバージョン 2.0.0の設定ページを完了します。
  2. 設定ページでをクリックします。
  3. テキストバーチャルエージェント連携をセットアップする場合、[音声連携オプション]の下の[音声]ページでテキストのみを選択し、次いで次へをクリックします。このセクションのステップ10までスキップしてください。

  4. 音声バーチャルエージェントをセットアップする場合は、[音声連携オプション]の下の[音声]ページのリストから、セットアップする音声連携の種類のオプションを選択します。

  5. SIPバックチャネルまたはカスタムのテレフォニー接続との連携をセットアップしている場合は、次へをクリックし、このセクションのステップ10にスキップします。
  6. [Text-to-Speechオプション]の下で、CXone Cloud TTSを使用を選択します。これは、カスタムのバーチャルエージェント連携のための唯一のオプションです。したがって、チェックボックスをクリアすることについてのページのテキストは無視して、バーチャルエージェントプロバイダーのTTSサービスを使用するオプションを選択することができます。

  7. カスタム連携で使用するTTSベンダーを選択します。オプションは、CXoneCloud TTSが現在サポートしているベンダーです。
  8. [トランスクリプションオプション]の下で、使用する音声テキスト化サービスを選択します。

  9. 次へをクリックします。
  10. トランスクリプトのページで、バーチャルエージェントの会話のトランスクリプトをキャプチャするかどうかのオプションを選択します。

  11. [次へ] をクリックします。
  12. 希望に応じてバーチャルエージェント連携をテストするか、または追加をクリックしてカスタムExchangeエンドポイント設定アプリをバーチャルエージェントハブに追加します。

カスタムバーチャルエージェント連携のテスト

必要な権限アプリケーション > Studio > スクリプト > 作成/編集

このステップでは、CXoneとバーチャルエージェントの間の接続をテストします。CXoneとのコミュニケーションにおいて、バーチャルエージェントがお客様の期待通りに機能することを保証します。

バーチャルエージェントの多くの側面をテストして、すべてが意図したとおりに機能することを確認できます。バーチャルエージェントハブのバーチャルエージェントアプリのプロパティページからテストを実行できます。テストでは次のことを行えます:

  • バーチャルエージェントアプリがバーチャルエージェントプロバイダーと通信するように正しく構成されていることを確認します。
  • カスタムペイロードJSONを追加して、バーチャルエージェントによるカスタムペイロードデータの処理をテストします。
  • ウェルカムインテントイベントをトリガーして、バーチャルエージェントが会話を開始する方法をテストします。
  • カスタムインテントイベントをトリガーして、バーチャルエージェント用に作成したカスタムイベントをテストします。
  • タイムアウトイベントをトリガーして、コンタクトがタイムアウトしたときにバーチャルエージェントがどのように応答するかをテストします。
  • バーチャルエージェントがDTMF閉じた ユーザーが電話のキーパッドのキーを押すかタップしたときに生成される信号音。入力を処理する方法をテストします。

次の画像はバーチャルエージェントハブのバーチャルエージェントアプリのプロパティページの例です。構成と音声タブおよびテストペインが表示されます。

  1. Studioで、スクリプトを開くか作成し、バーチャルエージェントのアクションを追加します(まだ含まれていない場合)。
  2. 仮想エージェントアクションをダブルクリックして、 バーチャルエージェントハブ
  3. 左側のリストから、テストしたいバーチャルエージェント用の構成アプリをクリックして選択します。
  4. [テスト]ペインで、[メッセージを入力]フィールドにテストメッセージを入力し、エンターキーを押して送信します。マイクマイクの形をしたアイコン。をクリックして、コンピューターのマイクに向かって話すこともできます。

  5. ウェルカムインテントで開始をクリックして、最初からテスト会話を開始します。バーチャルエージェントはデフォルトのウェルカムメッセージで応答します。テストメッセージを入力することができます。
  6. その他のオプション 3つのドットを縦に重ねたアイコン。をクリックして、バーチャルエージェントの他の側面をテストします。

  7. [リセット]をクリックして、テストを再開します。
  8. テストの結果に基づいて変更を加える必要がある場合は、次のことができます。

    • バーチャルエージェントのStudioスクリプトを変更します。
    • バーチャルエージェントハブのバーチャルエージェントアプリの構成設定を変更します。
    • プロバイダのコンソールでバーチャルエージェントの構成設定を変更します。バーチャルエージェントハブのアプリのプロパティのページにある大きな四角いボタンをクリックします。このセクションの冒頭の例では、プロバイダーボタン付きのGoogle Dialogflow CXアプリとを表示しています。リンクが外部サイトを開くことを示す四角の上に矢印が重ねられたアイコン。矢印は、正方形の中心から正方形の右上隅を指しています。アイコンが表示されます。
  9. スクリプトまたは構成設定を変更するたびにバーチャルエージェントを徹底的にテストします。
  10. テストが終了したら、[閉じる]をクリックします。

バーチャルエージェントをStudioアクションに割り当てます。

必要な権限アプリケーション > Studio > スクリプト > 作成/編集

バーチャルエージェント閉じた 連絡先の発言/入力する内容の背後にある意味または目的。連絡先が伝えたいこと、または達成したいこと。アプリをバーチャルエージェントハブでセットアップして設定すると、それをスクリプトのバーチャルエージェントのアクションに割り当てる必要があります。これにより、アクションとスクリプトがバーチャルエージェントプロバイダーに接続されます。

  1. Studioで、変更するスクリプトを開きます。
  2. スクリプトでバーチャルエージェントアクションを見つけ、ダブルクリックしてバーチャルエージェントハブを開きます。

  3. 左の列で、アクションに割り当てるバーチャルエージェントを見つけて、その横にあるチェックマーク円の中にチェックマークが入ったアイコン。をクリックします。
  4. 閉じるをクリックします。

チャネル固有の要件を満たす

必要な権限コンタクト対応 > ACD> ポイントオブコンタクト(PoC) > 編集、作成コンタクト対応 > ACD> チャットプロファイル > 編集、作成グローバル > ユーザー設定 > スキル > 編集、作成グローバル > ユーザー設定 > キャンペーン > 編集、作成グローバル > ユーザー設定 > ユーザー > 編集、作成

バーチャルエージェントとのインタラクションを開始するためにコンタクトが使用する チャネル閉じた コンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。 をセットアップします。

CXoneチャットや音声チャネルでは:

バージョン管理のような命名規則をStudioスクリプトで使用する場合は、連絡先に割り当てる前に、必ず本稼働名でスクリプトを保存してください。

次のものなど、チャネルの要件がすべて満たされていることを確認します。

ポイントオブコンタクト(PoC)からスクリプトをテストする

必要な権限コンタクト対応 > ACD > ポイントオブコンタクト(PoC) > 表示、編集

ポイントオブコンタクト(PoC)閉じた 着信連絡先が電話番号やEメールアドレスなどの対話を開始するために使用するエントリポイント。がセットアップされたら、連絡先から始まるスクリプトをテストする必要があります。スクリプトトレーシングを使って、スクリプトの有効性を確認し、発生した問題を特定することができます。

実装プロセスの初期に行ったテストでは、バーチャルエージェントとCXoneの接続をテストしました。このステップのテストでは、コンタクトからCXone、バーチャルエージェントに至るまで、連携全体を検証します。

  1. Studioで、連絡先が呼び出すスクリプトを開きます。
  2. デバッグ > スクリプトのキャプチャ > 次のインスタンスのみ
  3. インタラクションを開始します。どのように開始するかは、 チャネルによって閉じた コンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。異なります。例:

    Studioで、トレース出力ウィンドウが開きます。レスポンスを入力し、バーチャルエージェントが応答すると、スクリプトの進行状況が表示されます。

  4. トレース出力ウィンドウのメインペインで、アクションをクリックします。

    • 変数タブには、選択したアクションが完了したときにスクリプト内に存在するすべての変数が表示されます。また、スクリプトのその時点で各変数が持っている値も表示されます。
    • プロパティタブには、選択したアクションのプロパティが表示されます。アクションの現在の設定を確認するために使用することができます。
  5. スクリプトに戻り、必要であれば変更します。
  6. アクションを選択し、キーボードで F1 を押すと、そのアクションのオンラインヘルプにアクセスできます。各アクションのオンラインヘルプページでは、スクリプトでアクションを使用する際のプロパティやその他の情報について説明しています。
  7. やり直す場合は、チャットの終了をクリックし、ブラウザウィンドウを更新してから、ステップ2からこの作業を繰り返してください。