Skip to main content
POST
Submit A Batch Call Request

Authorizations

x-api-key
string
header
required

API key for programmatic access

Body

application/json

Request model for submitting a batch call job.

call_name
string
required

Name of the batch call job

agent_id
string
required

Agent ID to use for calls

recipients
OutboundCallRecipient · object[]
required

List of recipients to call

Maximum array length: 10000
scheduled_time_unix
integer | null

Unix timestamp to schedule the batch call (None = immediate)

agent_phone_number_id
string | null

Caller phone number ID (from your purchased numbers)

whatsapp_params
BatchCallWhatsAppParams · object | null

WhatsApp parameters (future support)

Response

Successful Response

Response model for a single batch call job.

id
string
required

Unique batch call ID

name
string
required

Name of the batch call job

agent_id
string
required

Agent ID to use for calls

created_at_unix
integer
required

Unix timestamp when created

scheduled_time_unix
integer
required

Unix timestamp when scheduled to start

last_updated_at_unix
integer
required

Unix timestamp of last update

status
enum<string>
required

Current status of the batch job

Available options:
pending,
in_progress,
completed,
failed,
cancelled
agent_name
string
required

Name of the agent

phone_number_id
string | null

Caller phone number ID

phone_provider
enum<string> | null

Telephony provider for batch calls.

Available options:
twilio,
vobiz,
sip_trunk
whatsapp_params
BatchCallWhatsAppParams · object | null

WhatsApp parameters for batch calls (future support).

total_calls_dispatched
integer
default:0

Number of calls dispatched

total_calls_scheduled
integer
default:0

Number of calls scheduled

total_calls_finished
integer
default:0

Number of calls finished (completed + failed)

retry_count
integer
default:0

Number of retries attempted