結構描述

本頁定義了自訂虛擬客服專員整合中使用的結構描述。 對於自訂虛擬客服專員整合，請務必參考 CXone MpowerSwagger 一個正方形，箭頭從中心指向外。，以確保您使用的是最新版本的結構描述。

請求：ExternalIntegrationBotExchangeRequest

參數

類型

描述
virtualAgentId 字串

在 Virtual Agent Hub 中為自訂交換終點應用程式提供的名稱。 此名稱標識了應用程式叫用的虛擬客服專員。
botConfig 物件

透過虛擬客服專員註冊的設定物件。
userInput 字串 從指令碼被指派到的聯絡點Closed 呼入聯絡人用來發起互動的入口點，如電話號碼或電郵地址。接收的來自使用者的文字輸入。
userInputType 列舉

指令碼提供的使用者輸入類型。 可能的值包括：NO_INPUT、TEXT、BASE64_ENCODED_G711_ULAW_WAV_FILE、USER_INPUT_ARCHIVED_AS_SPECIFIED、USER_ENDED_SESSION、AUTOMATED_TEXT、DTMF_AS_TEXT
executionInfo ActionExecutionInfo 在指令碼中執行動作的遙測資料Closed 在Studio指令碼內執行一個流程，如收集客戶資料、播放訊息或音樂，或將聯絡人路由至客服專員。。
systemTelemetryData SystemTelemetryData 可用於偵錯的資料。 包含有關 CXone Mpower 基礎結構的資訊。
base64wavFile 字串 包含 Base64 進制編碼的 WAV 檔案，其中包含請求的標頭。
botSessionState 物件 可用於從虛擬客服專員處接收的往返會話資訊變數。
customPayload 物件 可用於從 Studio 指令碼的上下文中傳送額外的變數和參數。
mediaType 字串 表示正在運行的指令碼的媒體類型。

請求：ActionExecutionInfo

包含有關執行的動作和指令碼的資訊。

參數

類型

詳細資訊
contactId 整數 互動的唯一識別碼。
busNo 整數 指令碼所在的CXone Mpower網路Closed 用於管理 CXone Mpower 環境的技術支援、計費和全域設定的高級組織分組的 ID。
requestId 整數

迭代數，用於確定特定互動中的每個請求。 如果您在請求中包括requestId，它可以包括在回應中。

這可以幫助疑難排解或解決其他問題。 如果requestID是唯一的值，它可以用來在記錄檔案中定位單個請求/回應。
actionType

字串

 向自訂端點發出請求的動作類型。
actionId

整數

 指令碼中Studio動作的 ID 號。 動作 ID 是基於動作被新增到指令碼中的順序。
scriptName

字串

 提出請求的指令碼的路徑和名稱。

請求：SystemTelemetryData

包含有關執行的動作和指令碼的資訊。

參數

類型

詳細資訊
contactId 整數 互動的唯一識別碼。
busNo 整數 指令碼所在的CXone Mpower網路Closed 用於管理 CXone Mpower 環境的技術支援、計費和全域設定的高級組織分組的 ID。
requestId 整數

迭代數，用於確定特定互動中的每個請求。 如果您在請求中包括requestId，它可以包括在回應中。

這可以幫助疑難排解或解決其他問題。 如果requestID是唯一的值，它可以用來在記錄檔案中定位單個請求/回應。
actionType

字串

 向自訂端點發出請求的動作類型。
actionId

整數

 指令碼中Studio動作的 ID 號。 動作 ID 是基於動作被新增到指令碼中的順序。
scriptName

字串

 提出請求的指令碼的路徑和名稱。

回應：CustomExchangeResponse_V1

參數

類型

描述
branchName 列舉 指令碼要採取的分支。 可以包含以下值：DoNotBegin、PromptAndCollectNextResponse、ReturnControlToScript、EndContact、AudioInputUntranscribeable、Error、DTMFBreakout、UserInputTimeout、UserInputNotUnderstood
nextPromptSequence PromptSequence 指定要為聯絡人播放的提示序列。 可直接用於 Play 動作。
intentInfo IntentInfo 可用於在包含 NLUClosed 此過程在自然語言處理 (NLP) 基礎之上擴展，以根據其理解的資訊做出決策或採取行動。 的整合中填充終端識別的意圖資訊。
nextPromptBehaviors PromptBehaviors 用於音訊收集和無聲控制的配置。 僅用於語音通道Closed 聯絡人與客服專員或機器人互動的方式。 通道可以是語音、電郵、聊天、社交媒體等等。整合。
customPayload 物件

可用於在終點和 CXone Mpower 之間傳送額外的自訂變數。 這是一個通用的容器，用於儲存終點所需的任何變數或參數。 常見的用例包括：

關於包括自訂工作負載的更多資訊，請見 Textbot Exchange動作 和 Voicebot Exchange動作 的説明頁面。

{ "param1": "value1"
	"param2": "value2"
}
errorDetails BotErrorDetails

錯誤處理的設定，包括如何提示和處理指令碼中的錯誤。
botSessionState 物件

可用於傳送 CXone Mpower 維護的會話環境變數。

有關該參數的更多資訊，請參閱 機器人會話狀態説明頁面。

回應：PromptSequence

參數

類型

描述
prompts 陣列 [PromptDefinition] PromptDefinition 物件的陣列，用於從終點返回多個提示。 對於語音交互，該序列可以是文字轉語音和預先錄製的音訊檔案的組合。

回應：PromptDefinition

關於定義提示序列的更多資訊，請參閱管理說明頁面。

參數

類型

描述
transcript 字串

將在聊天中為使用者顯示或由 STTClosed 亦稱 STT，此流程會將語音轉換為文字。 合成的虛擬客服專員回應文本。
base64EndcodedG711ulawWithWavHeader 字串 來自終點的回應的 base64 編碼的 WAV 檔案，如果終點能夠在回應中返回音訊，則在下一輪次播放。 音訊回應必須採用 µ-law G711 轉碼器。
audioFilePath 字串 可以被終點用於指定任何存在於 CXone Mpower租戶 中的音訊檔，這些檔案可以存取並且格式正確，可以在下一輪次播放。
textToSpeech 字串 可用於傳回，供 CXone Mpower 文字轉語音服務合成。
mediaSpecificObject 物件 包含發生在 Digital Experience 文字通道Closed 聯絡人與客服專員或機器人互動的方式。 通道可以是語音、電郵、聊天、社交媒體等等。的互動的富媒體內容。

回應：IntentInfo

參數

類型

描述
intent 字串 用於傳回 NLUClosed 此過程在自然語言處理 (NLP) 基礎之上擴展，以根據其理解的資訊做出決策或採取行動。 元件在聯絡人輸入中識別的意圖Closed 聯絡人所說/所輸入內容背後的含義或目的；聯絡要傳達或實現什麼。
context 字串 用於傳回上下文資訊或 NLU 元件主動用來處理意圖的名稱。
intentConfidence 字串 用於傳回 NLU 元件為意圖確定的置信度。
lastUserUtterance 字串 用於儲存聯絡人的最後一句話。 此參數透過客服專員隧道傳送給虛擬客服專員，並在工作負載中隨虛擬客服專員的回應返回給 CXone Mpower。 此參數在測試和偵錯時很有用。
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 列舉 用於指定如何在下一輪次收集聯絡人的輸入。 可能的值為：DO_NOT_COLLECT_USER_RESPONSE、SEND_UTTERANCe_AUDIO、SEND_DTMF_ONLY_AS_TEXT
dtmfRules CollectDtmfRules 保留收集 DTMFClosed 使用者點擊或輕點電話鍵盤上的某個鍵而產生的訊號音。 音調的設定。
bargeConfiguration PromptBargeConfiguration 保留干預行為的設定。 干預允許聯絡人打斷正在播放的提示。

回應：CollectDtmfRules

DTMF 收集規則是一組定義為提示行為組成部分的參數。 有關在 Studio 指令碼中定義這些規則的更多資訊，請見下一個提示行為説明頁面。

參數

類型

描述
detectDtmf 布爾 控制是否對 DTMF 音進行處理和動作。
clearDigits 布爾

控制先前檢測到的 DTMF 音調是否應從緩衝區中清除。
terminationCharacters 字串

用於指定您希望聯絡人輸入的字元，以表示他們已經完成了數字輸入。 例如，井字號 (#) 通常用作結尾字元。
stripTerminator 布爾 控制結尾字元是否需要在傳送的聯絡人輸入中連接起來。
interDigitTimeoutMilliseconds 整數 用於指定指令碼在聯絡人輸入的數位之間等待的時間，以毫秒為單位。
maxDigits 整數 用於指定要收集的 DTMF 數位的最大數量。 如果您使用結尾字元，當您計算最大數量時，將其作為字元之一。

回應：PromptBargeConfiguration

干預是可以定義為提示行為組成部分的選項。 有關在 Studio 指令碼中包含此選項的更多資訊，請見下一個提示行為説明頁面。

參數

類型

描述
enableSpeakerBarge 布爾 用於控制聯絡人是否可以在播放提示時進行干預。

回應：AudioTranscriptionConfig

如果您的想使用 CXone Mpower Turn-by-Turn Transcription，而不是您的虛擬客服專員的預設轉錄服務，請使用 AudioTranscriptionConfig。

參數

類型

描述
transcriptionProfileId 字串 指定現有轉錄設定檔的 ID。 如果您在這裡指定了設定檔，則其將覆蓋 Virtual Agent Hub 中自訂交換終點應用程式的設定。
hintPhrases 陣列 提供可選的短語清單，為轉錄服務提供提示。 例如，您可以包括上下文模型、產品名稱、常用的名稱或短語，等等。

回應：BotErrorDetails

參數

類型

描述
errorLoopBehavior 列舉 用於控制指令碼在終點返回錯誤時的行為。 可以包含以下值：ReturnControlToScriptThroughErrorBranch、EndContact
errorPromptSequence PromptSequence 用於在出現錯誤時為聯絡人播放提示。
systemErrorMessage 字串 用於偵錯。 在 Virtual Agent Hub 中的「自訂交換終點」屬性頁面的「測試」視窗中，可以看到錯誤訊息。