通过 API 进行会话中身份验证

本页面介绍了如何在 SDK 渠道中使用通话和聊天 API 端点进行会话中身份验证。

用户无需进行身份验证即可发起支持会话，例如支持聊天。当需要进行最终用户身份验证时，您可以启动身份验证流程。身份验证成功后，您可以更新 end_user 标识符，将相应会话与经过验证的最终用户关联起来。

URI 和身份验证

此新端点的基本 URI 因 comm_type 而异。

对于 call comm_type：

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user

对于 chat comm_type：

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user

API 操作

在以下部分中，您可以找到有关 API 操作的详细信息。

参数

API 请求的正文应包含以下字段：

ID 字段名称 类型 是否必需？ 说明 示例值
0 identifier 字符串 是 提供了唯一的外部标识符。
1 name 字符串 否 与互动相关联的通用名称或标识符。有助于客户查找。 John Doe
2 email 字符串 否 与互动关联的通用邮箱。有助于客户查找。 john@doe.com
3 phone 字符串 否 与互动相关联的通用手机号码。有助于客户查找。 123-456-7890

API 示例

在接下来的部分中，您可以找到示例 API 请求和响应。

成功响应示例

202 Accepted

{
 "message": "accepted"
}

失败响应示例

在接下来的部分中，您可以找到失败响应示例。

错误响应

400 错误请求 - 请求中缺少必需的标识符字段。

{
  "message": "param is missing or the value is empty: identifier"
}

401 未经授权 - 身份验证失败。

{
  "message": "Not Found"
}

404 Not Found - 提供的 ID 没有任何通话或聊天记录。

会话未处于活跃状态

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

不支持的 CRM 请求

400 错误请求 - 实例的 CRM 配置不支持此更新路径。

{
  "message": "Unsupported CRM request"
}

重复请求

400 {"message": "Duplicate request: Please wait for the interval to expire"}

API 请求示例

在下一部分中，您可以找到通话和聊天通信类型的示例 API 请求。

通话通信类型

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

Chat Comm Type

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

Apps API 文档

如需了解其他应用 API 端点，请参阅应用 API 发布。