传递数据参数

本页介绍了如何从入站会话发起协议 (SIP) 标头捕获数据参数,并将其传递给虚拟代理、虚拟任务助理和出站 SIP 标头。

按渠道划分的数据参数

下表简要概述了各个渠道的数据参数可用性。

数据形参类型 客户支持虚拟客服 任务虚拟助理
Web 移动设备 IVR 短信 Web 移动设备 IVR 短信
已修复
动态 Contact Center AI 平台 (CCAI 平台) 元数据
已签名的参数
无符号形参
SIP 标头
形式

从入站 SIP 标头捕获数据参数

您可以从入站 SIP 标头捕获数据参数,并将其传递给以下对象:

您还可以将 CCAI 平台配置为在 CRM 记录和会话元数据文件中包含入站 SIP 标头数据。

如需从入站 SIP 标头捕获数据参数,请按以下步骤操作:

  1. 在 CCAI Platform 门户中,依次点击设置 > 操作管理。如果您没有看到设置菜单,请点击 菜单

  2. 前往数据参数窗格。

  3. 语音下,选择在 IVR 会话中从入站 SIP 标头捕获数据参数

  4. 如需使用 SIP 标头数据作为来电显示信息,请执行以下操作:

    1. 选择使用 SIP 标头数据作为来电显示信息

    2. 字段名称字段中,输入 SIP 标头字段名称。

  5. 选择在会议 CRM 记录中包含 SIP 标头数据,以在 CRM 记录中包含 SIP 标头数据作为注释。

  6. 选择在会话元数据文件中包含 SIP 标头数据,以在会话元数据文件中包含 SIP 标头数据。

  7. 点击保存数据参数

CRM 记录

以下代码示例展示了入站 SIP 标头中的数据参数在 CRM 记录中的显示方式:

Call redirected to external SIP.
SIP destination: <<SIP Destination URI>>
Data parameters passed:
{
   "<<destination_field_#1>>" : "<<destination_value_#1>>",
   "<<destination_field_#2>>" : "<<destination_value_#2>>"
 }

您可以将 SIP 标头数据纳入以下 CRM 的记录中:

会话元数据文件

以下代码示例展示了入站 SIP 标头中的数据参数在 会话元数据文件中的显示方式:

"sip_headers": {
  "header 1": "value 1",
  "header 2": "value 2"
}

将数据参数传递到出站 SIP 标头

如需了解价格和实现方式,请与支持团队联系。

如需将数据发送到外部 SIP 目的地,用于传递数据参数的出站 SIP 设置会使用自动重定向功能。系统会收集入站 SIP 标头中定义的数据参数,并将其传输到分配给所选 IVR 队列的外部目的地。

借助“将数据参数传递给出站 SIP”,您可以:

  • 在 IVR 队列级别设置静态动态数据参数。固定参数可帮助您传递静态值。借助动态参数,您可以检索值并动态传递该值。

  • 在自动重定向期间,在出站 SIP 标头中传递设置参数。

管理配置

  1. 依次前往设置 > 队列 > IVR,然后选择相应队列。

  2. 前往自动重定向部分,确保切换开关设置为显示

  3. 点击配置 SIP 转接链接。

  4. 出站 SIP 配置面板中,以 +ccNumber@fqdn 格式输入目标 SIP URI。此值的字符数限制为 256 个。

  5. 前往传递数据参数部分,确保切换开关设置为开启。在输入目标 SIP URI 之前,无法启用“传递数据参数”。

为 SIP 标头添加固定参数

  1. 点击添加参数按钮。

  2. 类型下,选择固定

  3. 输入以下字段

    目标字段:数据形参值将传递给 Dialogflow CX 的字段名称。

    目标值:要传递的值。

    参数示例显示在预览中。

  4. 点击保存

从 SIP 标头添加动态参数

  1. 点击添加参数按钮。

  2. 类型下,选择动态

  3. 来源下,选择 SIP 标头

  4. 输入以下字段:

    传入字段:传入 SIP 标头中的字段名称,其值将传递给 Dialogflow CX。这是一个自由文本条目(字符串)

    目标字段:数据形参值将传递给 Dialogflow CX 的字段名称。

    参数示例显示在预览中。

  5. 点击保存

数据记录

使用数据记录部分中的复选框来指明您是否希望将传递的数据参数包含在会话元数据文件或 CRM 记录中。

点击保存,然后点击返回到“设置”链接。

向虚拟助理和虚拟任务助理传递数据参数

数据参数从来电中收集数据,在通话期间保留数据,然后在通话转接到虚拟客服或虚拟任务助理时将数据传递回 Dialogflow CX 服务。当您调用 Dialogflow CX 代理时,数据参数会以设置格式在 Dialogflow API 中返回。

您可以添加数据形参,以便:

  • 在 IVR 队列级别收集静态动态数据设置。固定参数可帮助您传递静态值。借助动态形参,您可以检索值并动态传递该值。

  • 通过动态表单参数收集数据:仅当配置了表单参数时,才适用于虚拟任务助理。当客服人员部署虚拟任务助理时,代理适配器会向其提供数据采集表单。表单参数用于定义客服人员必须填写的字段。例如,如果表单字段值为 booking_id,则适配器中会显示相应的手动输入字段。为了让客服人员调度任务助理来收款,您必须提供 booking_id

您可以向现有或新的虚拟代理或虚拟任务助理添加以下参数:

  • 固定参数

  • CCAI Platform 元数据参数

  • SIP 标头参数

  • 代理表单参数(仅适用于虚拟任务助理)

添加固定形参

固定数据参数是指系统自动传递给虚拟助理和任务助理的字段。

  1. 点击添加参数按钮。
  2. 类型下,选择固定
  3. 填写以下字段:
    1. 目标字段:数据参数值将传递给 Dialogflow CX 的字段名称。
    2. 目标值:要传递的值。
  4. 预览中将显示参数示例。

从 CCAI 平台元数据添加动态参数

  1. 点击添加参数按钮。

  2. 类型下,选择动态

  3. 来源下,选择 CCAIP 元数据

  4. 传入字段下拉菜单中,选择将传递给 Dialogflow CX 的 CCAIP 元数据类型。可以传递以下 CCAIP 元数据参数:

    • ANI(手机号码):最终用户拨打电话时使用的号码。

    • 使用方 ID:平台中最终用户的唯一 ID。

    • 通话 ID:平台中通话的唯一 ID。

    • 支持请求 ID (CRM):与会话相关联的 CRM 支持请求 ID。

    • 队列 ID:升级前的会话的队列 ID。

    • DNIS/TFN:DNIS(拨号号码识别服务)或 TFN(免费手机号码)是指最终用户拨打的用于联系您的客户支持系统的唯一手机号码。

    • 最新代理 ID:系统为在 CCAI Platform 平台上运行的每个代理生成的 ID。此 ID 用于唯一标识负责处理正在进行的通话的最新通话段的客服人员。

    • 最新客服人员电子邮件地址:处理过有效通话的最新一段的客服人员所关联的电子邮件地址。

    • 队列语言:用于标识指定队列或部门的语言简短代码,系统会根据语言要求将通话转接到该队列或部门。

    • 当前情绪得分:通话最新片段的平均情绪得分。

    • 总体情绪得分:对整个通话过程中(直到转接时)的情绪或满意度的累积评估。

  5. 目标字段中,输入数据参数值将传递到 Dialogflow CX 的字段名称。预览中将显示参数示例。

  6. 点击保存

从 SIP 标头添加动态参数

  1. 点击添加参数按钮。

  2. 类型下,选择动态

  3. 来源下,选择 SIP 标头。输入以下字段:

    1. 传入字段:将传递给 CCAI 平台的传入 SIP 标头中的字段名称。这是一个自由文本条目(字符串)。

    2. 目标字段:数据参数值将传递到 CCAI 平台的字段名称。

  4. 预览中将显示参数示例。

添加动态自定义表单参数

配置代理表单参数后,当代理部署虚拟任务助理时,代理适配器会向代理提供数据捕获表单。表单参数用于定义代理必须填写的字段。例如,如果表单字段值为 booking_id,则适配器中会显示相应的手动输入字段。客服人员必须输入 booking_id,才能调度任务助理来收款。

  1. 点击 +添加参数

  2. 类型下拉菜单中,选择动态

  3. 来源下拉菜单中,选择表单

  4. 输入要在代理适配器上显示的字段名称。

  5. 选中必填复选框,以指定在将对话转给虚拟任务助理之前,必须填写相应参数。

  6. 输入目标参数。在提交参数之前,请在预览窗口中查看该参数,因为所有更改都将在未经验证的情况下被接受。

  7. 点击保存

在队列级层启用传递数据参数

  1. 在 CCAI Platform 门户中,依次前往设置 > 队列 > IVR,然后选择相应队列。

  2. 确认队列已分配虚拟客服,然后点击修改虚拟客服分配链接。如果所选队列未分配虚拟代理,请点击添加虚拟代理按钮以配置新的虚拟代理,然后再继续。

  3. 前往传递数据参数部分,并确保相应开关已设置为开启

将数据参数从 Web SDK 传递给虚拟客服

如需使用未签名的自定义数据,通过队列将数据参数从 Web SDK 传递到虚拟客服,请按照以下步骤操作:

  1. 在 CCAI Platform 门户中,依次点击设置 > 队列。如果您没有看到设置菜单,请点击 菜单

  2. 网站窗格中,点击修改 / 查看

  3. 点击要添加参数的队列。

  4. 在 SDK 中,使用以下示例格式添加自定义数据:

var ujet = new UJET({
[...]
  customData: {
  "k1": {
    "label": "Version",
    "value": "1.2.3"
  },
  "k2": {
    "label": "Dashboard",
    "value": "<http://example.com>"
  }
  }

})

然后,您可以使用以下命令在 VA 中访问它:

$session.params.valuek1

此命令应输出 1.2.3

需要为每个参数添加一个数据参数命令,因此若要像上例中那样使用 k2,则需要再创建一个。

管理员配置

  1. 依次前往设置 > 队列 > IVR,然后选择相应队列。

  2. 确认队列已分配虚拟客服,然后点击修改虚拟客服分配链接。

    注意:如果所选队列未分配虚拟代理,请点击添加虚拟代理按钮以配置新的虚拟代理,然后再继续。

  3. 前往传递数据参数部分,然后检查开关是否设置为“开启”。

添加固定参数

  1. 点击添加参数按钮。

  2. 类型下,选择固定

  3. 输入以下字段

    目标字段:数据形参值将传递给 Dialogflow CX 的字段名称。

    目标值:要传递的值。

    预览中会显示参数示例。

从 CCAI 平台元数据添加动态参数

  1. 点击添加参数按钮。

  2. 类型下,选择动态

  3. 来源下,选择 CCAI Platform 元数据

  4. 传入字段下拉菜单中,选择需要传递给 Dialogflow 的 CCAI 平台元数据类型。

    可以传递以下 CCAI Platform 元数据数据参数:

    ANI(手机号码)

    消费者 ID

    通话 ID

    工单 ID (CRM)

    队列 ID

  5. 目标字段中,输入数据参数值将传递到 Dialogflow CX 的字段名称。

    预览中会显示参数示例。

  6. 点击保存

从 SIP 标头添加动态参数

  1. 点击添加参数按钮。

  2. 类型下,选择动态

  3. 来源下,选择 SIP 标头

  4. 输入以下字段:

    传入字段:传入 SIP 标头中的字段名称,其值将传递给 Dialogflow CX。这是一个自由文本条目(字符串)。

    目标字段:数据形参值将传递给 Dialogflow CX 的字段名称。

    预览中会显示参数示例。

数据记录

使用数据记录部分中的复选框来指明您是否希望将传递的数据参数包含在会话元数据文件或 CRM 记录中。

点击保存,然后点击返回到“设置”链接。

在会话期间将数据参数传递给虚拟代理

此功能允许在会话期间传输数据参数。它支持在会话中与虚拟代理共享情境数据,从而鼓励动态互动并提升用户体验。此更新引入了一个新的 API 端点,可让客户在聊天会话期间从 SDK 接收数据参数,并在相应会话正在进行时将这些参数传递给虚拟客服。这对于会话中身份验证等场景非常有用。

可以通过 Apps API 发送安全(已签名)或不安全(未签名)的数据。 不过,对该 API 的所有请求都通过 API 密钥进行保护,有助于确保数据在传输过程中受到保护。

自定义数据会经历以下流程:

  1. 自定义数据通过 SDK 或 Apps API 端点传入。

  2. 自定义数据会存储或与现有聊天数据合并。

  3. 自定义数据会附加到最终用户的 detect_response 调用中,并随其消息一起发送。

  4. 自定义数据会传递给虚拟客服。

  5. 所有新的自定义数据都会发布到 CRM。

API 端点

需要使用 Apps API 端点才能接受通话或聊天会话期间的自定义数据。

POST
/apps/api/v1/[chats|calls]/:id/custom_data

它会接收 2 种可能的载荷类型:安全(已签名)或不安全(未签名)。

安全数据(使用 JWT 签名):

{
"signed": true,
"signed_data": "JWT_SIGNED_DATA"
}
{
  "custom_data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  },
  "exp": 1734567890,
  "iat": 1734560000
}

不安全的数据:

{
  "signed": false,
  "data": {
    "reserved_verified_customer": {
      "value": true
    },
    "reserved_bad_actor": {
      "value": false
    },
    "reserved_repeat_customer": {
      "value": true
    },
    "field1": {
      "value": "dummy1"
    },
    "field2": {
      "value": "dummy2"
    }
  }
}