Sign in
batchCalls

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.

post/calls/batch

Headers

Authorizationstring required

Bearer authentication

Request body

namestring

A display name for the batch.

model_idstring

The agent that places the calls. Required when creating a new batch, ignored when appending to an existing one.

from_phone_numberstring

The caller ID used for every call in the batch. Required when creating a new batch, ignored when appending.

batch_call_idstring uuid

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_timestampinteger

Unix timestamp in milliseconds at which dialing starts. Omit to start dialing immediately.

reserved_concurrencyinteger

Number of concurrent call slots held back for calls outside this batch. Must be lower than the account's maximum concurrent calls.

Response

200

statusstring

Changes