Custom Payload Snippet

本帮助页面上的信息同时适用于 CXone Studio 和 Desktop Studio。

将此代码段与具有 customPayload 属性的操作一起使用，如 Voicebot Exchange 或 Textbot Conversation。它用于将数据从 CXone 传递给虚拟坐席关闭 代替现场人工坐席处理客户交互的软件应用程序。提供程序。如需要从虚拟坐席接收自定义数据，请使用 customPayloadVarName (out) 变量。

以下虚拟坐席需使用此代码段：

对于所有其他虚拟坐席，仅当在有自定义有效负载数据要传递给机器人时，才需要包含该代码段。如果使用 Dialogflow CX，请遵循包含自定义有效负载的最佳实践。

Pass a Placeholder

如果您使用 Amazon Lex V1 或 Amazon Lex V2，并且不需要向虚拟坐席传递信息，请遵循以下示例：

DYNAMIC customPayload 
 customPayload.placeholder=""

如果您需要将信息传递给虚拟坐席，请按照下一节中的示例进行操作。

Pass Data

对于所有虚拟坐席提供程序，请按照此示例将信息传递给虚拟坐席。将示例中的参数替换为需要传递的信息。


customPayload.context.id="information"
customPayload.context.lifespan=1
customPayload.context.parameters.name="Fenrir"
customPayload.context.parameters.age="19"
customPayload.context.parameters.date="20201020"

Google Dialogflow CX Custom Payload 的最佳实践

  • DialogflowCX 不像 Dialogflow ES 使用上下文将数据传递给 Dialogflow 意图关闭 联系人所说/输入内容背后的含义或目的；联系人想要沟通或完成的内容。

  • 您可以使用 JSON 键值对将自定义数据传递到 Dialogflow CX。在脚本的 Snippet action操作中，创建一个动态 customPayload 对象，并向其添加键值。例如： 

    DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"
  • 在脚本的 Exchange 或 Conversation 操作中，通过其值中包含 asJSON() 函数的变量来配置 customPayload 属性。您可以在 customPayload 对象中找到该变量。
  • 使用 QueryParameters 的 Payload 属性将 customPayload JSON 传递给虚拟坐席。请参阅 Google 文档，了解 Google Dialogflow CX 的 QueryParameters 一个方块，右上角有一个从中心向外的箭头。。
  • 通过 QueryParameters 传递的数据由 Dialogflow CX 中的 Webhook 接收。您可以在 Dialogflow CX 控制台中编写代码来处理传递的数据。
  • 不要在 customPayload 对象中嵌套对象。嵌套的对象作为文字字符串进行发送。
  • 要将自定义数据从 Dialogflow CX 虚拟坐席传递回脚本，请使用 Dialogflow CX 控制台中的 Custom Payload 字段。确保您位于与 CXone 结合使用的虚拟坐席的控制台中。在脚本中的语音或聊天 Studio 操作中，使用 customPayloadVarName (out) 变量将其映射到脚本。例如，您可以使用此来设置下一个提示行为。

  • 使用 customPayload 设置的参数只能在外部 Webhook 中使用。如果要设置参数以便在外部 webhook 之外使用，请在包含 session_params 字段的 Snippet 操作中设置参数。例如： 

    {
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"location": "Hundred Acre Wood"
	}
}

    使用以下语法访问 Dialogflow CX 坐席意图中的会话参数：

    $session.params.name = Winnie Le Pooh

    $session.params.job = Food critic

    $session.params.location = 100 Acre Wood

    会话参数仅与 Dialogflow CX 虚拟坐席一起使用。要通过 Dialogflow 获得类似的结果，请使用上下文。

  • 语音上下文提示可以通过 speechContexts 参数中的自定义有效负载进行传递。voiceContexts.phrases 的值必须是您想要给出的提示的 Google 类令牌 一个方块，箭头从中心指向右上角。。该令牌必须与您的联系人的语言和区域设置相匹配。例如： 

    DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10
  • 使用VOICEBOT EXCHANGE时：要配置联系人在讲话时暂停时虚拟坐席等待的时间，请将 maxPostEnergySilenceMS 参数添加到 Next Prompt Behaviors 或 Default Next Prompt Behaviors Snippet 操作中。

Google Dialogflow ES Custom Payload 的最佳实践

  • CustomPayload 用于传递意图关闭 联系人所说/输入内容背后的含义或目的；联系人想要沟通或完成的内容的上下文。上下文有助于虚拟坐席理解用户的意图。上下文不是必需的，但有助于虚拟坐席将话语关闭 联系人所说或输入的内容。与意图相匹配。
  • 在脚本的 Snippet 操作中，创建一个 customPayload 对象，其遵循 REST 资源： projects.agent.sessions.context 的 Google Dialogflow ES 文档指示链接到外部网站的图标中概述的格式。Studio 联机帮助提供有关动态数据对象的附加信息。
  • 您还可以在没有上下文的情况下使用 customPayload 传递自定义数据。为此，请在动态数据对象中包含标准的 JSON 键值对。
  • 语音上下文在 speech_contact 参数中的自定义有效负载中进行传递。您可以在 Studio 跟踪和应用程序日志中查看该参数的内容。
  • customPayload 动态对象以 JSON 格式作为虚拟坐席参数传递，如示例脚本中所示。

  • 语音上下文提示可以通过 speechContexts 参数中的自定义有效负载进行传递。voiceContexts.phrases 的值必须是您想要给出的提示的 Google 类令牌 一个方块，箭头从中心指向右上角。。该令牌必须与您的联系人的语言和区域设置相匹配。例如： 

    DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10

该脚本是如何将自定义有效负载与 Google Dialogflow ES 虚拟坐席相集成的一个示例。此脚本使用 Voicebot Exchange 操作，但如果您改用 TEXTBOT EXCHaNGE，它也可以工作。

说明如何使用 Google Dialogflow CX 处理自定义有效负载的示例脚本。

下载此脚本。