私人測試版。 新組織預設已啟用。組織管理員仍須在 Brightalk 設定中建立具權限範圍的 API 金鑰,請求才能通過驗證。可用範圍與限制以本文件和 OpenAPI 契約為準。
先建立草稿,再啟動
POST /batches 會建立 status: draft。僅建立資源絕不會開始撥號。請只提供一種收話人格式:contact_ids 或內嵌 recipients。
POST /batches/{batch_id}/start 是唯一能啟動或排程草稿的狀態轉換,並以 202 Accepted 傳回更新後的批次。
收話人識別與限制
批次必須包含 1–1,000 位不重複且具權威性的聯絡人紀錄。重複的聯絡人 ID 會遭拒絕。內嵌recipients 會先依聯絡人採用規則解析;若兩筆內嵌識別資料解析至同一筆聯絡人紀錄,也視為重複。
排程與撥號時段
選用的schedule.start_at 可設定工作最早符合執行資格的 RFC 3339 時間點。選用的 schedule.calling_window 則以 time_zone、不重複的 weekdays、start_time 與較晚的 end_time 定義一段連續的每日撥號時段。
批次啟動後,只有在 start_at 之後且位於該時段內,工作才符合執行資格。批次契約不提供多段每日時段或分支流程;需要這類行為時,請使用儀表板管理的 Automation。
彙總資料與控制
批次資源會回報total_recipients、pending_recipients、queued_recipients、in_progress_recipients、completed_recipients、failed_recipients、cancelled_recipients、answered_recipients、no_answer_recipients 與 busy_recipients 等彙總數量。請使用 GET /batches/{batch_id} 監控。
暫停會停止後續收話人派送,但不保證停止已進行的通話。繼續會將符合資格的剩餘收話人重新加入佇列。取消會停止剩餘工作,並以盡力而為方式要求取消進行中的下游通話。有效狀態請參閱狀態生命週期。