聊天的 API 直接访问点

借助 Chat 的 API 直接访问点 (DAP),您可以根据配置的外部 API 端点的响应,自动将传入的聊天会话路由到队列。这样一来,最终用户无需从队列菜单中进行选择。端点可以是您自己的,也可以是第三方服务的。

启用此功能后,当最终用户开始聊天时,CCAI 平台会向您的 API 端点发送请求。API 会返回路由数据(键值对),CCAI 平台会使用这些数据将最终用户与正确的队列进行匹配。如果未找到匹配项,系统会显示标准队列菜单作为备用选项。

API DAP 适用于以下情况:

  • 网页和移动聊天

  • 新聊天和续聊

准备工作

默认情况下,此功能处于停用状态。如需为您的实例启用此功能,请与 Google Cloud 支持团队联系。

DAP 类型

DAP 有两种类型:API 响应和网络钩子响应。每种 DAP 类型都有不同的工作流。

API 响应

以下是 API 响应工作流:

  1. 最终用户开始新的聊天或续聊。

  2. 在队列菜单显示之前,CCAI 平台会向您的 API 端点发送请求,其中包含您定义的任何参数,例如会话元数据或自定义数据。

  3. API 会返回一个或多个键值对。

  4. CCAI 平台会将这些键值对与聊天队列中配置的键值对进行匹配。所有键值对都必须匹配,聊天才能路由到队列。

  5. 如果找到匹配项,最终用户将直接路由到该队列。

  6. 如果发生以下任一情况,系统会显示标准队列菜单:

    • 未找到匹配项。

    • API 未在配置的 API 请求超时期限内做出响应。

网络钩子响应

以下是网络钩子响应工作流:

  1. 最终用户开始新的聊天或续聊。

  2. 在队列菜单显示之前,CCAI 平台会向您的 API 端点发送请求,其中包含网络钩子网址。

  3. API 会在 API 请求超时期限内返回确认响应 (HTTP 200)。

  4. 您的系统会处理该请求,并使用网络钩子向 CCAI 平台发送路由数据(键值对)。

  5. CCAI 平台会将这些键值对与聊天队列中配置的键值对进行匹配。所有键值对都必须匹配,聊天才能路由到队列。

  6. 如果找到匹配项,最终用户将直接路由到该队列。

  7. 如果发生以下任一情况,系统会显示标准队列菜单:

    • 未找到匹配项。

    • 未在 API 请求超时期限内收到确认。

    • 未在 API 回调超时期限内收到网络钩子响应。

为聊天全局配置 API DAP

如需为聊天全局配置 API DAP,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击 设置 > 开发者设置。 如果您没有看到设置 菜单,请点击 Menu

  2. 前往 API 请求直接访问点 窗格,然后点击管理 API 请求直接访问点

  3. 点击聊天 标签页。

  4. 点击 Chat 的 API 请求直接访问点 开关,将其切换到“开启”位置。

  5. 对于直接访问点类型,请选择以下 DAP 类型之一:

    • API 响应:API 会在其响应中返回路由数据。

    • 网络钩子响应:API 会确认请求,然后将 路由数据发送到网络钩子。

  6. 如需指定哪些聊天类型会触发 API DAP,请在 聊天类型 中选择 以下一项或两项:

    • 新聊天

    • 续聊

  7. API 请求 字段中,输入要用于 DAP 的 API 端点网址。

  8. 如需配置身份验证,请执行以下操作之一:

    • 如需配置基本身份验证,请执行以下操作:

      1. 对于身份验证方法 ,选择基本身份验证

      2. 对于身份验证凭据,输入您的用户名和 密码。

    • 如需配置自定义标头,请执行以下操作:

      1. 对于身份验证方法 ,选择自定义标头

      2. 点击添加字段 。系统随即会显示添加字段 对话框。

      3. 输入字段键和字段值,然后点击保存

  9. 如需配置 API 请求超时期限,请执行以下操作:

    1. 对于 API 请求超时期限 ,设置 CCAI 平台在 API 超时之前等待 API 响应的秒数。

    2. 可选(仅当您选择 Webhook Response DAP 类型时才会显示):对于 API 回调超时期限,设置 CCAI 平台在网络钩子超时之前等待网络钩子返回路由数据(在 初始确认之后)的秒数。

  10. 如需设置请求方法,请在 API 请求方法 中选择 POSTGET

  11. 如需配置数据参数,请执行以下操作:

    1. 点击传递数据参数 开关,将其切换到“开启”位置。

    2. 点击添加参数 。系统随即会显示添加参数 对话框。

    3. 执行下列其中一项操作:

      • 如需配置固定数据参数,请执行以下操作:

        1. 类型 列表中,点击固定

        2. 目标字段 字段中,输入目标键。

        3. 目标值 字段中,输入目标值。 您的数据参数的预览会显示在预览 字段中。

      • 如需配置动态数据参数,请执行以下操作:

        1. 类型 列表中,点击动态

        2. 执行下列其中一项操作:

          • 如需配置会话元数据,请执行以下操作:

            1. 来源 列表中,选择会话元数据

            2. 传入字段 列表中,选择元数据类型。

          • 如需配置已签名的自定义数据,请执行以下操作:

            1. 来源 列表中,选择已签名的自定义数据

            2. 传入字段 列表中,输入传入字段。

          • 如需配置未签名的自定义数据,请执行以下操作:

            1. 来源 列表中,选择未签名的自定义数据

            2. 传入字段 列表中,输入传入字段。

        3. 目标字段 字段中,输入目标字段。 您的数据参数的预览会显示在预览 字段中。

    4. 点击添加参数 。您的数据参数会显示在数据参数 列表中。

  12. 可选:如需测试您的配置,请执行以下操作:

    1. 前往测试连接 部分。您的数据参数会显示在列表中。

    2. 可选:如需尝试不同的参数值,请修改列表中的参数值。

    3. 点击测试此连接

  13. 点击保存 Chat API

更改路由逻辑

路由逻辑是指 CCAI 平台尝试各种匹配类型以将聊天与队列进行匹配的顺序。CCAI 平台会按顺序评估每种匹配类型,并将聊天路由到第一个匹配的队列。如果未找到匹配项,系统会显示标准队列菜单。

以下是三种匹配类型:

  • API 响应:根据 API 响应键值对进行匹配。

  • 常规接入点标签:根据队列的常规接入 点标签进行匹配。

  • 用户细分:根据细分用户群数据进行匹配。

如需更改路由逻辑,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击 设置 > 开发者设置。 如果您没有看到设置 菜单,请点击 Menu

  2. 前往 API 请求直接访问点 窗格,然后点击管理 API 请求直接访问点

  3. 点击聊天 标签页。

  4. 对于路由逻辑,将指针悬停在匹配类型上,然后将其拖动到 新位置。

  5. 根据需要重复此步骤。

  6. 点击保存 Chat API

在队列级为聊天配置 DAP

如需在队列级为聊天配置 DAP,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击设置 > 队列。如果您没有 看到 设置 菜单,请点击 菜单。系统随即会显示队列菜单设置 页面。

  2. 根据所需的渠道,执行以下操作之一:

    • 移动设备 窗格中,点击修改 / 查看

    • 网页 窗格中,点击修改 / 查看

  3. 点击要修改的队列。

  4. 设置 窗格中,前往访问点 部分。

  5. 点击创建直接访问点 。系统随即会显示创建直接访问点 对话框。

  6. 访问点类型 列表中,点击 API 响应

  7. 接入点名称 (APN) 字段中,输入接入点名称。

  8. 点击添加键和值 。输入键值对,以与 API 响应中返回的键值对进行匹配。

  9. 重复上一步骤,以添加更多键值对。

  10. 可选:在欢迎消息 字段中,输入您希望在最终用户被定向到此菜单选项时使用的欢迎消息。

  11. 点击创建 。您的 DAP 会显示在访问点 列表中。