Create a batch call
Creates a batch of outbound calls that are dialed over time as your account’s concurrency allows. Provide batch_call_id to append more recipients to an existing batch instead of creating a new one. A batch holds up to 1000000 recipients in total, and is canceled along with its queued recipients if it has not finished within seven days.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
tasks
The recipients to call. Between 1 and 10000 per request. Append to the batch to go beyond that, up to 1000000 recipients in total.
name
A display name for the batch.
model_id
The agent that places the calls. Required when creating a new batch, ignored when appending to an existing one.
from_phone_number
The caller ID used for every call in the batch. Required when creating a new batch, ignored when appending.
batch_call_id
An existing batch to append the recipients to. When set, model_id, from_phone_number, trigger_timestamp, reserved_concurrency and call_time_window are ignored.
trigger_timestamp
Unix timestamp in milliseconds at which dialing starts. Omit to start dialing immediately.
reserved_concurrency
Number of concurrent call slots held back for calls outside this batch. Must be lower than the account's maximum concurrent calls.
call_time_window
Calling window evaluated in the agent's timezone. Recipients that come up while the window is shut wait for it to open. This does not replace the agent's working hours, which are checked separately when the call is placed, so a window that falls outside them fails every call. When neither is configured, recipients are dialed at any time.
Response
200
status
response
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error