Schemas

此页面定义自定义虚拟坐席集成中使用的架构。 请始终参考有关自定义虚拟坐席集成的 CXone Mpower Swagger ，以确保您使用的是最新版本架构的版本。

请求：ExternalIntegrationBotExchangeRequest

参数	类型	说明
virtualAgentId	字符串	Virtual Agent Hub 中为 Custom Exchange Endpoint 应用程序指定的名称。 该名称标识应用程序调用的虚拟坐席。
botConfig	对象	向虚拟坐席注册的配置对象。
userInput	字符串	从分配到脚本的联络点 呼入联系人用来发起交互的入口点，如电话号码或电子邮件地址。接收到的用户输入的文本。
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	在脚本中执行操作 在Studio脚本中执行流程，例如收集客户数据或播放音乐。的遥测数据。
systemTelemetryData	SystemTelemetryData	可用于调试的数据。 包含有关 CXone Mpower 基础设施的信息。
base64wavFile	字符串	包含 Base 64 编码的 WAV 文件，该文件包含请求的标头。
botSessionState	对象	可用于从虚拟坐席接收的往返会话信息变量。
customPayload	对象	可用于从 Studio 脚本的上下文发送其他变量和参数。
mediaType	字符串	指示正在运行的脚本的媒体类型。

请求：ActionExecutionInfo

包含有关正在执行的操作和脚本的信息。

参数	类型	详细信息
contactId	整数	交互的唯一标识符。
busNo	整数	脚本所在的 CXone Mpower 业务部门的 ID 用于管理CXone Mpower系统的技术支持、计费和全局设置的高级组织分组。。
requestId	整数	标识特定交互中的每个请求的迭代数。 如果您在请求中包含 requestId，则它可以包含在响应中。 这有助于排除故障或解决其他问题。 如果 requestID 是唯一值，则可用于在日志文件中查找单个请求/响应。
actionType	字符串	向自定义端点发出请求的操作类型。
actionId	整数	脚本中 Studio 操作的 ID 号码。 操作 ID 基于操作添加到脚本的顺序。
scriptName	字符串	发出请求的脚本的路径和名称。

请求：SystemTelemetryData

包含有关正在执行的操作和脚本的信息。

参数	类型	详细信息
contactId	整数	交互的唯一标识符。
busNo	整数	脚本所在的 CXone Mpower 业务部门的 ID 用于管理CXone Mpower系统的技术支持、计费和全局设置的高级组织分组。。
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	可用于在包含 NLU 该流程扩展了自然语言处理 (NLP)，以根据它所理解的内容做出决定或采取行动。 的集成中填充有关端点识别的意图的信息。
nextPromptBehaviors	PromptBehaviors	音频采集和静音控制的配置。 仅适用于语音渠道 促进客户在联系中心交互的各种语音和数字通信媒介。集成。
customPayload	对象	可用于在端点和 CXone Mpower 之间发送其他自定义变量。 这是端点所需的任何变量或参数的通用容器。 常见用例包括： 身份验证，发送安全密钥或令牌以在端点进行验证。 自定义报告，包括用于生成 KPI 用于衡量坐席绩效的既定指标。 等的自定义指标或计算。 有关包含自定义有效负载的更多信息，请参阅 Textbot Exchange 操作和 Voicebot Exchange 操作的帮助页面。 { "param1": "value1" "param2": "value2" }
errorDetails	BotErrorDetails	错误处理的配置，包括如何提示和处理脚本中的错误。
botSessionState	对象	可用于发送CXone Mpower维护的会话上下文变量。 您可以在机器人会话状态帮助页面上了解有关此参数的更多信息。

响应：PromptSequence

参数	类型	说明
prompts	数组 [PromptDefinition]	PromptDefinition 对象的数组，用于从端点返回多个提示。 对于语音交互，序列可以是文字转语音和预先录制的音频文件组合。

响应：PromptDefinition

有关定义提示序列的更多信息，请参阅提示帮助页面。

参数	类型	说明
transcript	字符串	将在聊天中向用户显示或由 STT 这个过程也被称为 STT，它将口语转换为文本。 合成的虚拟坐席响应文本。
base64EndcodedG711ulawWithWavHeader	字符串	来自端点的响应的 base64 编码的 WAV 文件（如果端点能够在响应中返回要在下一回合播放的音频）。 音频响应​​必须采用 µ-law G711 编解码器。
audioFilePath	字符串	可由端点用来指定可访问且位于 CXone Mpower租户 中的任何音频文件，且处于下一回合要播放的正确格式。
textToSpeech	字符串	可用于发送回由 CXone Mpower 文本转语音服务合成。
mediaSpecificObject	对象	包含富媒体内容，用于通过Digital Experience基于文本的渠道 促进客户在联系中心交互的各种语音和数字通信媒介。进行的交互。

响应：IntentInfo

参数	类型	说明
intent	字符串	用于发回NLU 该流程扩展了自然语言处理 (NLP)，以根据它所理解的内容做出决定或采取行动。 组件已在联系人的输入中识别的意图 联系人所说/键入的内容背后的含义或目的;联系人想要传达或完成的内容。。
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	保留 DTMF 当联系人按下电话键盘上的按键时产生的信号音。 铃声集合的配置设置。
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中的自定义 Exchange 端点应用程序中所做的设置。
hintPhrases	数组	提供可以为转录服务提供提示的可选短语列表。 例如，您可能包括上下文模型、产品名称、常用名称或短语等。

响应：BotErrorDetails

参数	类型	说明
errorLoopBehavior	枚举	用于控制端点返回错误时脚本执行的操作。 可以包含以下值：ReturnControlToScriptThroughErrorBranch、EndContact
errorPromptSequence	PromptSequence	用于在发生错误时为联系人提供提示播放。
systemErrorMessage	字符串	用于调试。 在Virtual Agent Hub中的自定义 Exchange 端点属性页面中的测试窗口中可以看到错误消息。