GETRICHMESSAGE

This help page is for Desktop Studio.This information is also available for CXone Studio.

Three shapes containing iconograhic representations of lists, imgs, and music files.

将富消息 JSON 传递到数字AskCaller 操作TExtMsg 操作。这可使您在脚本中使用在 ACD 中的“联系点数字”页面上创建的富消息模板,而不是在脚本中构建 JSON。

依赖关系

  • 这个操作需要 Digital Experience
  • 在使用数字脚本之前,了解传统 ACD 脚本与数字脚本之间的区别
  • 必须与下列一个操作一起使用:AskCallerTExtMsg
  • 在脚本中将 GETRICHMESSAGE 放在 AskCallerTExtMsg 之前。
  • 对富消息内容类型的支持因渠道而异,如以下下拉列表所示。

  • 创建富消息模板,以便与 CXone 中的“联络点数字”页面上的此操作一起使用。您可以为列表选取器、时间选取器、富链接和快速回复创建模板。如果需要使用其他富媒体,则不能使用 GETRICHMESSAGE。您必须在 Snippet 操作中构建 JSON,并将其直接传递给 AskCallerTExtMsg。有关详细信息,请参阅这些操作的在线帮助中的“依赖关系”部分。

支持的脚本类型

The icon for the Digital script type - a computer monitor with a smartphone next to it.

数字

类似操作比较

以下操作具有类似功能,但存在一些关键区别:

输入属性

这些属性定义操作在执行时使用的数据。

属性

说明

说明文字

输入在脚本中唯一标识此操作的短语。标题显示在脚本画布上的操作图标下方。The default is the action name.

channelID

选择此脚本用于发送消息的数字渠道。

输出属性

这些属性包含保存执行操作返回的数据的变量。它们在操作完成后供引用和使用。

属性

说明

resultSet 保存从 CXone 返回的 JSON。将此变量的内容作为 JSON 字符串传递给 AskcallerTExtmsg

结果分支条件

结果分支条件允许您在脚本中创建分支,以在执行操作时处理不同的结果。

条件

说明

Default

除了脚本满足条件要求其接受其他分支的情况之外,所要采用的路径。如果未定义操作的其他分支,也会执行此操作。

OnError

操作无法正确执行时所采用的路径。例如,出现连接不良、语法错误等意外问题时。_ERR 变量以单个下划线字符填充,应包含对问题的简要解释。

OnSucess

完成操作而无错误,且 API 调用或数据返回全部成功时所采用的路径(2xx 响应代码)。

所需的 SNIPPET 操作代码

此操作可能需要具有代码的 Snippet 操作,用以处理 GETRICHMESSAGE 操作从数字联络点返回的富媒体模板。如果联络点只有一个模板,则您不需要代码片段。您可以使用在 resultId 属性中指定的变量。对于具有多个模板的联络点,您需要代码片段。

  1. ACD 应用 中的“联络点数字”页面上创建模板,并将其分配给与其一起使用的联络点。您可能需要 CXone 管理员的帮助来完成此步骤。

  2. 使用数字媒体类型创建脚本。

  3. 添加 GETRICHMESSAGE 操作ASKCALLER 操作TeXTMSG 操作。如果联络点有多个模板,您还需要 SNIPPET 操作
  4. 使用您为其分配了该模板的联络点在 GETRICHMESSAGE 中配置 ChannelId 属性。
  5. 将适当的代码添加到 SNIPPET 操作中:
    • 如果您只有一个模板,或者您只想使用此脚本发送一个模板,请使用诸如以下代码:

      DYNAMIC json1 
      ASSIGN json1.data[1] = resultset.data[1]
    • 如果您有多个模板,并且希望能够使用此脚本发送多个模板,请使用诸如以下代码:

      DYNAMIC json1
      DYNAMIC json2
      DYNAMIC json3
      				 
      ASSIGN json1.data[1] = resultset.data[1]
      ASSIGN json2.data[1] = resultset.data[2]
      ASSIGN json3.data[1] = resultset.data[3]
  6. 更改标识您要发送的模板的索引号。在上一步的示例代码中,您将更改 resultset.data[x] 变量中的索引号。不要更改您正在为其分配该模板的变量中的索引。在示例代码中,此变量为 jsonY.data[Z],您可以更改 Y,但不能更改 Z。每个 jsonY 变量都有一个模板。
  7. 如果需要,修改变量名称。要执行此操作,请根据需要在脚本的其他操作中更改变量名称。例如,resultSetGETRICHMESSAGeresultSet 属性中的默认变量名称。在 AskCallerTextmsgMessage 属性中使用 jsonY 变量。
  8. 配置 AskCallerTextmsg
    1. MessageFormat 属性设置为 JSON
    2. 使用拥有您正在发送的模板的 JSON 的变量名称配置 Message。它必须作为 JSON 字符串进行发送。您可以在此字段中使用变量替换。要执行此操作,请将代码添加到 Snippet,以便选择要发送的模板并传递正确的变量。
    3. 根据需要配置这些操作的其他属性,包括连接分支。请参阅 ASKCALLER 操作TeXTMSG 操作的在线帮助。

脚本示例

这是一个示例,说明如何在脚本中使用此操作。它并不是一个完整的脚本。可能还需要编写其他脚本。

此示例显示连接到 SNIPPET 操作(已连接到 TeXTMSG)的 GETRICHMESSAGE 操作。此外还可将其连接到 ASKCALLER。当脚本运行时,GETRICHMESSAGE 检索 channelId 中指定的数字渠道的可用富消息模板。它们存储在 resultId 属性中指定的变量中。在此示例中,变量为 resultId。该代码片段包含一个动态数据对象,该对象将保存特定的富消息模板 JSON 并将其传递给 TeXTMSG

包含 BEGIN、GETRICHMESSAGE、SNIPPET 和 TEXTMSG 操作的示例脚本。

下载此脚本