回拨 API

回拨是指最终用户请求的通话。借助回调调用 API，您可以以编程方式安排回调调用并取消已安排的调用。借助这些功能，您可以创建应用，让最终用户从您指定的队列中请求回拨电话。最终用户还可以取消之前安排的通话。如需了解如何使用回调调用 API 进行身份验证，请参阅基本身份验证。

使用回拨 API

您可以使用回调 API 来安排回调和取消安排的回调。

预约电话咨询

如需安排通话，请调用 POST https://<subdomain>.<domain>/apps/api/v1/calls 并添加类似于以下内容的请求正文：

{
    "call_type": "ScheduledCall",
    "menu_id": 12345,
    "end_user_number": "+18005550100",
    "scheduled_at": "2025-09-02T14:30:00Z"
}

如果请求成功，则会返回一个包含通话 ID 的通话对象。

取消已安排的通话

如需取消已安排的通话，请调用 PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel。指定要取消的调用的 ID。

如果请求成功，则会返回有关已取消通话的信息。

取消多个已安排的通话

如需取消多个已安排的通话，请调用 PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel。添加一个请求正文，其中包含要取消的通话的 call_ids 数组。

请参阅以下代码示例：

{
    "call_ids": [123, 456, 789]
}

如果请求成功，则返回的响应会包含一个响应标头，其中包含用于检查取消状态的 Location 网址。

将回电功能与 CRM 搭配使用

您可以将回调调用 API 与 Salesforce、Zendesk 和 ServiceNow CRM 集成搭配使用。

一般回调行为

如果您使用的是任何受支持的 CRM（Salesforce、Zendesk 或 ServiceNow），则以下条件会影响预定回电行为：

  • 记录处于打开状态，并且已安排了有效的预定通话：如果工单 ID 查找结果表明记录处于打开状态，并且已安排了有效的预定通话，则不会安排通话。以下评论已附加到 CRM 记录：A scheduled call was not created because the record already has an active scheduled call。

  • 无法访问 CRM：如果工单 ID 查找结果表明无法访问 CRM，则取消通话。以下评论已附加到 CRM 记录：A scheduled call was canceled because the CRM was unreachable。

已关闭记录的回调行为

对于已关闭的记录，系统处理回拨的方式因您使用的 CRM 而异：

  • Zendesk 和 ServiceNow 用户：如果工单 ID 查找结果表明记录已关闭，则不会安排通话。以下评论附加到了 CRM 记录中：A scheduled call was not created because the record is closed。

  • Salesforce 用户：请参阅使用 Salesforce 的回拨通话，了解如何配置实例以处理已关闭记录的预定通话。

使用 Salesforce 进行回拨通话

如果您已将 CCAI 平台与 Salesforce 集成，则可以配置实例如何处理已关闭记录的预定通话。以下是 Salesforce 集成的配置选项：

不检查记录状态

您可以配置 CCAI Platform，使其在拨打预定电话之前不检查记录状态。采用此配置时，系统会按计划拨打电话，无论记录是处于打开状态还是关闭状态。

如需将 CCAI 平台配置为不检查记录状态，请按以下步骤操作：

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

  2. 前往 CRM 记录创建详情 > 发起 API 预定调用时关闭记录的选项。

  3. 选择不检查记录状态。始终发起 API 预定调用。

  4. 点击保存常规。

检查记录状态并重新打开已关闭的记录

您可以配置 CCAI 平台，使其在拨打预定电话之前检查记录状态，并重新打开已关闭的记录。采用此配置后，如果记录状态为“已关闭”，则会执行以下操作：

  • 系统会按计划发起通话。

  • 记录已重新打开。

  • 以下评论附加到了 CRM 记录中：The record was reopened at the time of a scheduled call。

如需配置 CCAI 平台以检查记录状态并重新打开已关闭的记录，请按以下步骤操作：

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

  2. 前往 CRM 记录创建详情 > 发起 API 预定调用时关闭记录的选项。

  3. 选择查看记录状态。如果记录已关闭，请依次点击> 重新打开记录。

  4. 点击保存常规。

检查记录状态并取消已关闭记录的预定通话

您可以配置 CCAI 平台，使其在拨打预定电话之前检查记录状态，并取消已关闭记录的预定电话。 采用此配置时，如果记录状态为“已关闭”，则会发生以下操作：

  • 已取消预定通话。

  • 以下评论附加到了 CRM 记录中：A scheduled call was canceled because the record is closed。

如需将 CCAI Platform 配置为检查记录状态并取消已关闭记录的预定通话，请按以下步骤操作：

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

  2. 前往 CRM 记录创建详情 > 发起 API 预定调用时关闭记录的选项。

  3. 选择查看记录状态。如果记录已关闭，请>取消预约的通话。

  4. 点击保存常规。