Skip to main content
POST
Submit A Batch Call Request.

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json
call_name
string
required
agent_id
string
required
recipients
OutboundCallRecipient · object[]
required
Maximum array length: 10000
scheduled_time_unix
integer | null
agent_phone_number_id
string | null
whatsapp_params
BatchCallWhatsAppParams · object | null
timezone
string | null
branch_id
string | null
environment
string | null
telephony_call_config
TelephonyCallConfig · object
target_concurrency_limit
integer | null

Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.

Required range: x >= 1

Response

Successful Response

id
string
required
phone_number_id
string | null
required
phone_provider
enum<string> | null
required
Available options:
twilio,
sip_trunk,
exotel
whatsapp_params
BatchCallWhatsAppParams · object | null
required
name
string
required
agent_id
string
required
branch_id
string | null
required
environment
string | null
required
created_at_unix
integer
required
scheduled_time_unix
integer
required
timezone
string | null
required
total_calls_dispatched
integer
default:0
required
total_calls_scheduled
integer
default:0
required
total_calls_finished
integer
default:0
required
last_updated_at_unix
integer
required
status
enum<string>
required
Available options:
pending,
in_progress,
completed,
failed,
cancelled
retry_count
integer
default:0
required
telephony_call_config
TelephonyCallConfig · object
required
target_concurrency_limit
integer | null
required

Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.

Required range: x >= 1
agent_name
string
required
branch_name
string | null
required