スキーマ
このページでは、カスタムバーチャルエージェント統合で使用されるスキーマを定義します。常にカスタムのバーチャルエージェント統合用のバーチャルエージェント統合CXoneSwaggerを参照し、スキーマの最新バージョンを使用していることを確認してください。
リクエスト:ExternalIntegrationBotExchangeRequest
パラメーター |
タイプ |
説明 |
---|---|---|
virtualAgentId | 文字列 |
バーチャルエージェントハブのCustom Exchange Endpointアプリに付けられた名前です。アプリが呼び出すバーチャルエージェントを特定するための名前です。 |
botConfig | オブジェクト |
バーチャルエージェントに登録されている設定オブジェクトです。 |
userInput | 文字列 | スクリプトが割り当てられている連絡先 着信連絡先が電話番号やEメールアドレスなどの対話を開始するために使用するエントリポイント。から受信したユーザーからのテキスト入力です。 |
userInputType | Enum |
スクリプトが提供するユーザー入力タイプ。可能な値は以下の通りです:NO_INPUT、TEXT、BASE64_ENCODED_G711_ULAW_WAV_FILE、USER_INPUT_ARCHIVED_AS_SPECIFIED、USER_ENDED_SESSION、AUTOMATED_TEXT、DTMF_AS_TEXT |
executionInfo | ActionExecutionInfo | スクリプト内のアクション 顧客データの収集、メッセージや音楽の再生、エージェントへの連絡先のルーティングなど、Studioスクリプト内のプロセスを実行します。を実行するためのテレメトリデータ。 |
systemTelemetryData | SystemTelemetryData | デバッグに使用できるデータ。CXoneインフラに関する情報が含まれています。 |
base64wavFile | 文字列 | リクエストのヘッダーを含むBase 64エンコードされたWAV ファイルが含まれます。 |
botSessionState | オブジェクト | バーチャルエージェントから受信した往復のセッション情報変数に使用できます。 |
customPayload | オブジェクト | Studioスクリプトのコンテキストから、追加の変数やパラメーターを送信するために使用することができます。 |
mediaType | 文字列 | 実行中のスクリプトのメディアタイプを示します。 |
リクエスト:ActionExecutionInfo
実行中のアクションとスクリプトに関する情報が含まれています。
パラメーター |
タイプ |
詳細 |
---|---|---|
contactId | 整数 | インタラクションの一意の識別子。 |
busNo | 整数 | スクリプトが配置されているCXoneビジネスユニット テクニカルサポート、請求、およびCXone環境のグローバル設定の管理に使用される高レベルの組織グループのID。 |
requestId | 整数 |
特定のインタラクションにおける各リクエストを識別するための反復番号。リクエストにrequestIdを含めると、レスポンスに含めることができます。 トラブルシューティングなどの問題解決に役立ちます。requestIDが一意な値である場合、ログファイルから単一のリクエスト/レスポンスを探し出すために使用することができます。 |
actionType |
文字列 |
カスタムエンドポイントへのリクエストを行うアクションタイプ。 |
actionId |
整数 |
スクリプト内のStudioアクションのID番号。アクションIDは、アクションがスクリプトに追加された順にリストされます。 |
scriptName |
文字列 |
リクエストを行うスクリプトのパスと名前。 |
リクエスト:SystemTelemetryData
実行中のアクションとスクリプトに関する情報が含まれています。
パラメーター |
タイプ |
詳細 |
---|---|---|
contactId | 整数 | インタラクションの一意の識別子。 |
busNo | 整数 | スクリプトが配置されているCXoneビジネスユニット テクニカルサポート、請求、およびCXone環境のグローバル設定の管理に使用される高レベルの組織グループのID。 |
requestId | 整数 |
特定のインタラクションにおける各リクエストを識別するための反復番号。リクエストにrequestIdを含めると、レスポンスに含めることができます。 トラブルシューティングなどの問題解決に役立ちます。requestIDが一意な値である場合、ログファイルから単一のリクエスト/レスポンスを探し出すために使用することができます。 |
actionType |
文字列 |
カスタムエンドポイントへのリクエストを行うアクションタイプ。 |
actionId |
整数 |
スクリプト内のStudioアクションのID番号。アクションIDは、アクションがスクリプトに追加された順にリストされます。 |
scriptName |
文字列 |
リクエストを行うスクリプトのパスと名前。 |
レスポンス:CustomExchangeResponse_V1
パラメーター |
タイプ |
説明 |
---|---|---|
branchName | Enum | スクリプトが行う分岐。以下の値を含む可能性があります: DoNotBegin、PromptAndCollectNextResponse、ReturnControlToScript、EndContact、AudioInputUntranscribeable、Error、DTMFBreakout、UserInputTimeout、UserInputNotUnderstood |
nextPromptSequence | PromptSequence | コンタクトに対して再生するプロンプトシーケンスを指定します。Playアクションに直接使用することができます。 |
intentInfo | IntentInfo | NLU このプロセスは、理解した内容に基づいて判断またはアクションを実行する、自然言語処理(NLP)を拡張したものです。を含む統合において、エンドポイントが認識したインテントに関する情報を入力するために使用することができます。 |
nextPromptBehaviors | PromptBehaviors | 音声収集と沈黙制御のための構成。音声チャネル コンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。 の統合に限ります。 |
customPayload | オブジェクト |
エンドポイントとCXoneの間で、追加のカスタム変数を送信するために使用することができます。これは、エンドポイントが必要とする任意の変数やパラメーターの一般的なコンテナです。一般的な使用例としては、以下のようなものがあります:
カスタムペイロードの組み込みに関する詳細は Textbot ExchangeアクションおよびVoicebot Exchangeアクションのヘルプページでご確認ください。 { "param1": "value1" } |
errorDetails | BotErrorDetails |
スクリプトのプロンプトやエラーの処理方法など、エラー処理に関する設定。 |
botSessionState | オブジェクト |
CXoneが保持するセッションコンテキスト変数を送信するために使用することができます。 このパラメーターの詳細については、ボットセッション状態のヘルプページを参照してください。 |
レスポンス:PromptSequence
パラメーター |
タイプ |
説明 |
---|---|---|
prompts | 配列[PromptDefinition] | PromptDefinitionオブジェクトの配列で、エンドポイントから複数のプロンプトを返すために使用します。音声インタラクションでは、シーケンスは、 テキスト読み上げと録音済みの音声ファイルの組合せにすることができます。 |
レスポンス:PromptDefinition
プロンプトシーケンスの定義の詳細については、プロンプトのヘルプページを参照してください。
パラメーター |
タイプ |
説明 |
---|---|---|
transcript | 文字列 |
チャットでユーザーに表示される、またはSTT STTとも呼ばれるこのプロセスは、音声言語をテキストに変換します。で合成されるバーチャルエージェントのレスポンステキスト。 |
base64EndcodedG711ulawWithWavHeader | 文字列 | エンドポイントが次のターンで再生されるレスポンスの音声を返すことができる場合は、エンドポイントからのレスポンスのBase64エンコードされたWAVファイル。音声レスポンスはμ-law G711コーデックでなければなりません。 |
audioFilePath | 文字列 | エンドポイントによって使用され、 NICE CXone |
textToSpeech | 文字列 | CXoneテキスト読み上げサービスで合成するために送り返すのに使用できます。 |
mediaSpecificObject | オブジェクト | Digital Experienceテキストベースのチャネル コンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。で行われるインタラクションのためのリッチメディアコンテンツを含みます。 |
レスポンス:IntentInfo
パラメーター |
タイプ |
説明 |
---|---|---|
intent | 文字列 | NLU このプロセスは、理解した内容に基づいて判断またはアクションを実行する、自然言語処理(NLP)を拡張したものです。コンポーネントがコンタクトの入力で識別したインテント 連絡先の発言/入力する内容の背後にある意味または目的。連絡先が伝えたいこと、または達成したいこと。を送り返すために使用します。 |
context | 文字列 | コンテキスト情報、またはNLUコンポーネントがインテントを処理するためにアクティブに使用している名前を送り返すために使用します。 |
intentConfidence | 文字列 | NLUコンポーネントがインテントに対して決定した確実性を送り返すために使用します。 |
lastUserUtterance | 文字列 | コンタクトの最後の発話を保持するために使用します。このパラメーターはプロキシトンネルを通してバーチャルエージェントに送信され、バーチャルエージェントのレスポンスとともにペイロードでCXoneに返されます。このパラメーターは、テストやデバッグの際に便利です。 |
slots | オブジェクト | このオブジェクトを使用して、情報またはスロット(インテントで使用されるエンティティまたはパラメーター)の値を送信します。 |
レスポンス:PromptBehaviors
Studioスクリプトでのプロンプト動作の定義についての詳細は、次のプロンプト行動のヘルプページに記載されています。
パラメーター |
タイプ |
説明 |
---|---|---|
silenceRules | SilenceRules | 会話の特定部分のタイムアウトを制御できるようにするための設定です。 |
audioCollectionRules | AudioCollectionRules | 音声の収集方法を制御できるようにするための設定です。DTMF収集のための追加設定を含みます。 |
レスポンス:SilenceRules
沈黙ルールとは、プロンプト動作の一部として定義されるパラメーターのセットです。Studioスクリプトでのこれらのルールを定義する方法の詳細については、次のプロンプト行動のヘルプページに記載されています。
パラメーター |
タイプ |
説明 |
---|---|---|
engageComfortSequence | ブーリアン | コンタクトから次のユーザー入力を収集した後、エンドポイント処理に大きな待ち時間が発生する可能性がある場合に、プロンプトを再生するかどうかを制御するために使用します。例えば、コンタクトに「これを調べるのでお待ちください」というプロンプトが流れるようにするのです。 |
botResponseDelayTolerance | 整数 | スクリプトがエンドポイントのレスポンスを待つ時間をミリ秒単位で指定します。タイムアウトになると、コンフォートシークエンスがトリガーされます。このパラメーターは、engageComfortSequenceがtrueに設定されている場合にのみ使用されます。 |
comfortPromptSequence | PromptSequence | base64EndcodedG711ulawWithWavHeader、audioFilePath、textToSpeech、transcriptを通して、多数のプロンプトを再生します。このパラメーターは、engageComfortSequenceがtrueに設定されている場合にのみ使用されます。 |
millisecondsToWaitForUserResponse | 整数 | スクリプトがコンタクトからのレスポンスを待つ時間をミリ秒単位で指定するために使用します。このタイムアウトに達すると、スクリプトはエンドポイントにNo_Inputリクエストを送信します。 |
レスポンス:AudioCollectionRules
音声収集ルールは、プロンプト動作ーの一部として定義されるパラメーターのセットです。Studioスクリプトでのこれらのルールを定義する方法の詳細については、次のプロンプト行動のヘルプページに記載されています。
パラメーター |
タイプ |
説明 |
---|---|---|
collectionType | Enum | 次のターンでコンタクトの入力を収集する方法を指定するために使用します。可能な値は以下の通りです: DO_NOT_COLLECT_USER_RESPONSE、SEND_UTTERANCE_AUDIO、SEND_DTMF_ONLY_AS_TEXT |
dtmfRules | CollectDtmfRules | DTMF ユーザーが電話のキーパッドのキーを押すかタップしたときに生成される信号音。トーンの収集のための構成設定を保持します。 |
bargeConfiguration | PromptBargeConfiguration | 割り込み動作の構成設定を保持します。割り込みは、コンタクトが再生中のプロンプトを中断することができます。 |
レスポンス:CollectDtmfRules
DTMF収集ルールは、プロンプト動作の一部として定義されるパラメーターのセットです。Studioスクリプトでのこれらのルールを定義する方法の詳細については、次のプロンプト行動のヘルプページに記載されています。
パラメーター |
タイプ |
説明 |
---|---|---|
detectDtmf | ブーリアン | DTMF トーンの処理と動作の可否を制御します。 |
clearDigits | ブーリアン |
以前に検出されたDTMFトーンをバッファからクリアするかどうかを制御します。 |
terminationCharacters | 文字列 |
コンタクトが数字の入力を終えたことを示すために入力させたい文字を指定するために使用します。たとえば、シャープ記号(#)は一般的にターミネーターとして使用されます。 |
stripTerminator | ブーリアン | 送信されたコンタクト入力において、終端文字を連結する必要があるかどうかを制御します。 |
interDigitTimeoutMilliseconds | 整数 | コンタクトが入力する数字の間にスクリプトが待機する時間をミリ秒単位で指定するために使用します。 |
maxDigits | 整数 | 収集するDTMFの最大桁数を指定するときに使用します。ターミネーターを使用する場合は、最大桁数をカウントする際に、文字の一つとして含めます。 |
レスポンス:PromptBargeConfiguration
割り込みは、プロンプト動作に含まれるオプションとして定義できます。このオプションをStudioスクリプトに含めることについての詳細は、次のプロンプト行動のヘルプページに記載されています。
パラメーター |
タイプ |
説明 |
---|---|---|
enableSpeakerBarge | ブーリアン | プロンプトの再生中にコンタクトが割り込むことができるかどうかを制御するために使用します。 |
レスポンス:AudioTranscriptionConfig
バーチャルエージェントのデフォルトのトランスクリプションサービスではなく、 CXoneターンバイターンのトランスクリプション を使用したい場合は、 AudioTranscriptionConfigを使用します。
パラメーター |
タイプ |
説明 |
---|---|---|
transcriptionProfileId | 文字列 | 既存の転写プロファイルのIDを指定します。ここでプロファイルを指定すると、 バーチャルエージェントハブのCustom Exchange Endpointアプリで行った設定をオーバーライドします。 |
hintPhrases | 配列 | 転写サービスのヒントになるようなフレーズをオプションで用意してください。例えば、コンテキストモデル、製品名、よく使われる名称やフレーズなどを含めるとよいでしょう。 |
レスポンス:BotErrorDetails
パラメーター |
タイプ |
説明 |
---|---|---|
errorLoopBehavior | Enum | エンドポイントがエラーを返した場合。スクリプトの動作を制御するために使用します。以下の値を含むことができます: ReturnControlToScriptThroughErrorBranch、EndContact |
errorPromptSequence | PromptSequence | エラー時にコンタクトのプロンプトを再生させたい場合に使用します。 |
systemErrorMessage | 文字列 | デバッグに使用します。エラーメッセージは、バーチャルエージェントハブのCustom Exchange Endpointプロパティのテストウィンドウで確認できます。 |