跳轉到主要內容
私人測試版。 新組織預設已啟用。組織管理員仍須在 Brightalk 設定中建立具權限範圍的 API 金鑰,請求才能通過驗證。可用範圍與限制以本文件和 OpenAPI 契約為準。
通話是為單一聯絡人立即執行的非同步 AI 語音工作。POST /calls 在工作持久加入佇列後傳回 202 Accepted,不會等待開始撥號或完成。

立即非同步執行

請求會選取一個符合資格的 agent_id,以及一個既有聯絡人或內嵌收話人資料。請求無法選擇排程時間;需要時間控制行為時,請使用批次或由儀表板管理的 Automation。 容量限制可能讓已接受的通話保持 queued。請使用 API 資源的 id 查詢通話,直到 status 進入終止狀態。

生命週期與接聽分類

status 說明執行為排隊中、進行中、已結束、失敗或取消。answer_status 則獨立將目的端分類為 answeredno_answerbusyvoicemailunknown 因此,正常的 no_answerbusyvoicemail 結果仍可搭配 status: completedfailed 僅用於服務無法安全執行的情況。完整模型請參閱狀態生命週期

API 純量結果

通話 API 資源只包含核准的純量欄位: 請將 ID 視為不透明值;選用結果欄位在適用前會省略。

取消

POST /calls/{call_id}/cancel 採盡力而為且具冪等性。若取消及早勝出,會阻止後續派送;若工作已啟動,則要求終止。完成競態仍可能讓最終 status 成為 completed;重複取消會傳回目前的通話資源,不會建立另一個動作。