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。

如果要求成功，系統會傳回 200 OK，其中包含更新後的通話物件。如果通話正在等待排定的時間，或正在進入或等待佇列，通話物件的 status 為 cancelled；如果您取消已嘗試首次撥號的有效虛擬服務專員回電，則為 completed。如果通話已取消，要求會傳回 204 No Content，且主體為空白。如果要求取消的通話已因取消以外的原因失敗，或處於無法取消的狀態，則會傳回 400。

取消多個排定的通話

如要取消多個排定的呼叫，請呼叫 PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel。要求主體必須包含 call_ids 陣列，列出要取消的通話 ID。

請參閱下列程式碼範例：

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

如果要求成功，系統會傳回 202 Accepted，並附上 Location 回應標頭，指向可輪詢完成狀態的工作資源。202 Accepted 回應不代表所有呼叫都已取消，請按照 Location 標頭確認完成並檢查部分失敗。

搭配使用回呼和客戶關係管理系統

您可以搭配 Salesforce、Zendesk 和 ServiceNow CRM 整合功能，使用回電 API。

一般回呼行為

如果您使用任何支援的 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 後發現記錄已關閉，系統就不會安排通話。下列備註已附加至客戶關係管理記錄：A scheduled call was not created because the record is closed。

  • Salesforce 使用者：請參閱「使用 Salesforce 進行回呼通話」，瞭解如何設定執行個體處理已關閉記錄的排定通話。

使用 Salesforce 進行回電

如果您已將 CCAI 平台與 Salesforce 整合，可以設定執行個體如何處理已關閉記錄的排定通話。Salesforce 整合的設定選項如下：

不檢查記錄狀態

您可以設定 CCAI Platform，讓系統在撥打預約通話前不檢查記錄狀態。採用這項設定時，無論記錄是開啟或關閉，系統都會按照排程發出呼叫。

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

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

  2. 依序前往 「CRM Record Creation Details」(CRM 記錄建立詳細資料) >「Closed record options when initiating an API-scheduled call」(發起 API 排定通話時的已關閉記錄選項)。

  3. 選取「不檢查記錄狀態。一律由 API 發起排定的通話。

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

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

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

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

  • 重新開啟記錄。

  • 下列註解已附加至客戶關係管理記錄：The record was reopened at the time of a scheduled call。

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

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

  2. 依序前往 「CRM Record Creation Details」(CRM 記錄建立詳細資料) >「Closed record options when initiating an API-scheduled call」(發起 API 排定通話時的已關閉記錄選項)。

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

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

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

您可以設定 CCAI Platform，在撥打預約通話前檢查記錄狀態，並取消已關閉記錄的預約通話。採用這項設定後，如果記錄狀態為「已關閉」，系統會執行下列動作：

  • 排定的通話已取消。

  • 下列註解已附加至客戶關係管理記錄：A scheduled call was canceled because the record is closed。

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

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

  2. 依序前往 「CRM Record Creation Details」(CRM 記錄建立詳細資料) >「Closed record options when initiating an API-scheduled call」(發起 API 排定通話時的已關閉記錄選項)。

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

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