Submit batch calling job | ElevenLabs Documentation

curl -X POST https://api.elevenlabs.io/v1/convai/batch-calling/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ]
}'

{
  "id": "string",
  "phone_number_id": "string",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "string",
    "whatsapp_call_permission_request_template_language_code": "string",
    "whatsapp_phone_number_id": "string"
  },
  "name": "string",
  "agent_id": "string",
  "branch_id": "string",
  "environment": "string",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "timezone": "string",
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 0,
  "total_calls_finished": 0,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 0,
  "telephony_call_config": {
    "ringing_timeout_secs": 60
  },
  "target_concurrency_limit": 1,
  "agent_name": "string",
  "branch_name": "string"
}

Submit a batch call request to schedule calls for multiple recipients.

Request

This endpoint expects an object.

call_namestringRequired

agent_idstringRequired

recipientslist of objectsRequired

scheduled_time_unixinteger or nullOptional

agent_phone_number_idstring or nullOptional

whatsapp_paramsobject or nullOptional

timezonestring or nullOptional

branch_idstring or nullOptional

environmentstring or nullOptional

telephony_call_configobjectOptional

target_concurrency_limitinteger or nullOptional>=1

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

Response

Successful Response

idstring

phone_number_idstring or null

phone_providerenum or null

Allowed values:

whatsapp_paramsobject or null

namestring

agent_idstring

branch_idstring or null

environmentstring or null

created_at_unixinteger

scheduled_time_unixinteger

timezonestring or null

total_calls_dispatchedintegerDefaults to 0

total_calls_scheduledintegerDefaults to 0

total_calls_finishedintegerDefaults to 0

last_updated_at_unixinteger

statusenum

Allowed values:

retry_countintegerDefaults to 0

telephony_call_configobject

target_concurrency_limitinteger or null>=1

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

agent_namestring

branch_namestring or null

Errors

422

Unprocessable Entity Error

Headers

Request

Response

Errors