Callback call 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 陣列，其中列出要取消的通話 ID。

請參閱下列程式碼範例：

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

成功的要求會傳回回應，其中包含的回應標頭含有 Location 網址，可供檢查取消狀態。

搭配 CRM 使用回呼電話

您可以搭配 Salesforce、Zendesk 和 ServiceNow 客戶關係管理系統整合功能，使用回呼通話 API。

一般回呼行為

如果您使用任何支援的客戶關係管理系統 (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 使用者：請參閱「Callback calls with Salesforce」，瞭解如何設定執行個體處理已結案記錄排定通話的方式。

透過 Salesforce 進行回撥通話

如果已將 CCAI Platform 與 Salesforce 整合，您可以設定執行個體處理已結案記錄排定通話的方式。以下是 Salesforce 整合的設定選項：

不要檢查記錄狀態

您可以設定 CCAI Platform，讓系統在排定通話時間前，不必檢查錄音狀態。完成這項設定後，系統就會依排程撥打電話，無論記錄是否開啟。

如要設定 CCAI Platform，使其不檢查記錄狀態，請按照下列步驟操作：

  1. 在 CCAI Platform 入口網站中，依序點選「Settings」(設定) >「Operation Management」(作業管理)。如果沒有看到「設定」選單，請按一下「選單」圖示 。

  2. 前往「CRM Record Creation Details > Closed record options when initiating an API-scheduled call」(CRM 記錄建立詳細資料 > 啟動 API 排定呼叫時的已結案記錄選項)。

  3. 選取「不要檢查記錄狀態」。一律啟動 API 排程呼叫。

  4. 按一下「儲存一般設定」。

查看記錄狀態，並重新開啟已關閉的記錄

您可以設定 CCAI Platform，在排定通話前檢查記錄狀態，並重新開啟已關閉的記錄。完成這項設定後，如果記錄狀態為「已結案」，系統會執行下列動作：

  • 系統會按照排定的時間撥打電話。

  • 記錄已重新開啟。

  • 以下註解已附加至 CRM 記錄：The record was reopened at the time of a scheduled call。

如要設定 CCAI Platform 檢查記錄狀態並重新開啟已結案的記錄，請按照下列步驟操作：

  1. 在 CCAI Platform 入口網站中，依序點選「Settings」(設定) >「Operation Management」(作業管理)。如果沒有看到「設定」選單，請按一下「選單」圖示 。

  2. 前往「CRM Record Creation Details > Closed record options when initiating an API-scheduled call」(CRM 記錄建立詳細資料 > 啟動 API 排定呼叫時的已結案記錄選項)。

  3. 選取「查看記錄狀態」。如果記錄已關閉 > 重新開啟記錄。

  4. 按一下「儲存一般設定」。

查看記錄狀態，並取消已結案記錄的預定通話

您可以設定 CCAI Platform，在排定通話前檢查記錄狀態，並取消已結案記錄的排定通話。完成這項設定後，如果記錄狀態為「已結案」，系統會執行下列動作：

  • 已取消預約通話。

  • 以下註解已附加至 CRM 記錄：A scheduled call was canceled because the record is closed。

如要設定 CCAI Platform 檢查記錄狀態，並取消已結案記錄的預約通話，請按照下列步驟操作：

  1. 在 CCAI Platform 入口網站中，依序點選「Settings」(設定) >「Operation Management」(作業管理)。如果沒有看到「設定」選單，請按一下「選單」圖示 。

  2. 前往「CRM Record Creation Details > Closed record options when initiating an API-scheduled call」(CRM 記錄建立詳細資料 > 啟動 API 排定呼叫時的已結案記錄選項)。

  3. 選取「查看記錄狀態」。如果記錄已關閉 > 取消預約通話。

  4. 按一下「儲存一般設定」。