Skip to main content
自動化由儀表板管理,定義要使用的代理、等待步驟、撥號行為、重試規則、分支流程與後續動作。REST API 只會列出摘要及建立自動化執行,不會在請求中重新定義這些行為。

選取已啟用的自動化

GET /automations?status=active 會傳回組織可見的摘要,包含 idnamedescriptionstatusinput_fields。請將傳回的 id 作為 automation_id。本 API 只提供唯讀目錄。

理解 input_fields 宣告

目前版本的宣告為空:
input_fields 為空時,請在 POST /automation-runs 省略 input,或只傳送 {}。不要傳送未宣告的名稱。

啟動執行

POST /automation-runs 接受一個對應至已啟用自動化的 automation_id,以及一個既有聯絡人或內嵌收話人資料。它不接受代理覆寫、時間覆寫、重試規則或分支選擇。回應是一個非同步的自動化執行 API 資源。 只有後續 API 回應傳回非空的 input_fields 宣告時,客戶端才能傳送其中明確列出的欄位。請以 API 傳回的宣告為準。

追蹤及取消

請查詢自動化執行,直到 status 進入終止狀態。同一個自動化與聯絡人的組合已有另一個仍在進行的自動化執行時,可能傳回 409 duplicate_active_run,並在安全的 details 中提供既有執行 ID。 取消會阻止排隊中的工作啟動,或在步驟之間將非終止狀態的自動化執行標記為 cancelled。取消不會中斷正在執行的步驟,外部效果仍採盡力而為。所有 API 狀態請參閱狀態生命週期