Batch Calls
Manage high-volume outbound calling batches.List Batch Calls
Query:agent_id (optional), status (optional), limit (default 50, max 100), offset (default 0). Response includes data (array of batch call objects) and pagination.
Get Batch Call
Create Batch Call
Request body
Send
X-Idempotency-Key for safe retries. The agent must exist and be active and ready for calls; at least one valid outbound phone number is required (assigned to the agent or in phone_number_ids).
Example
data (batch call object: id, name, agent_id, status (e.g. draft), contact_source, and other configured fields) and meta.
Update Batch Call
Body: Any ofname, phone_number_ids, phone_rotation_strategy, scheduled_at, start_time, end_time, working_days, max_concurrent_calls, max_calls_per_day, retry_failed, max_retry_attempts. Only allowed when the batch is in draft status.
Delete Batch Call
Schedule Batch Call
Starts the batch (draft with contacts). Returns 422 if the batch is not in draft, has no contacts, or scheduling fails (e.g. provider error).Pause Batch Call
Pauses an active or scheduled batch. Returns 422 with a message if the batch is not inactive or scheduled status (e.g. already paused or still draft).
Resume Batch Call
Resumes a paused batch. Returns 422 if the batch is not inpaused status.
Bulk Delete Batch Calls
Delete draft, failed, or cancelled batches in one request. Active or scheduled batches are counted as failures and are not deleted.200 OK with { "data": { "deleted_count": 1, "failed_count": 1 }, "meta": { "request_id": "...", "ts": "..." } }.
List Batch Contacts
List contacts attached to a batch. Query parameters arestatus (pending, scheduled, completed, or failed), limit (1–200, default 50), and offset (default 0). Response: 200 OK with data, pagination.total, pagination.limit, pagination.offset, pagination.has_more, and meta.
Upload Batch Contacts
Upload contacts to a draft batch either as structured contacts or a base64-encoded CSV. Provide one ofcontacts or csv_base64; add_to_folder defaults to true, and folder_id optionally selects the destination folder.
200 OK with data.batch_call_id, data.contacts_added, data.folder_id, and meta. Uploading to a non-draft batch returns 422.