Submit batch calling job | ElevenLabs Documentation

from elevenlabs import ElevenLabs, OutboundCallRecipient
client = ElevenLabs()
client.conversational_ai.batch_calls.create(
    call_name="Customer Satisfaction Survey April 2024",
    agent_id="agent_78945",
    recipients=[
        OutboundCallRecipient()
    ],
)

{
  "id": "batchcall_1234567890abcdef",
  "name": "Customer Satisfaction Survey April 2024",
  "agent_id": "agent_78945",
  "created_at_unix": 1712000000,
  "scheduled_time_unix": 1712604800,
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 1,
  "total_calls_finished": 0,
  "last_updated_at_unix": 1712003600,
  "status": "pending",
  "retry_count": 0,
  "telephony_call_config": {
    "ringing_timeout_secs": 60
  },
  "agent_name": "John Doe",
  "phone_number_id": "phone_9876543210",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "permission_request_template_v1",
    "whatsapp_call_permission_request_template_language_code": "en_US",
    "whatsapp_phone_number_id": "wa_phone_123456789"
  },
  "branch_id": "branch_001",
  "environment": "production",
  "timezone": "America/New_York",
  "target_concurrency_limit": 10,
  "branch_name": "New York Customer Service"
}

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_unixintegerOptional

agent_phone_number_idstringOptional

whatsapp_paramsobjectOptional

timezonestringOptional

branch_idstringOptional

environmentstringOptional

telephony_call_configobjectOptional

target_concurrency_limitintegerOptional>=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

namestring

agent_idstring

created_at_unixinteger

scheduled_time_unixinteger

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

agent_namestring

phone_number_idstring

phone_providerenum

Allowed values:

whatsapp_paramsobject

branch_idstring

environmentstring

timezonestring

target_concurrency_limitinteger>=1

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

branch_namestring

Errors

422

Batch Calls Create Request Unprocessable Entity Error

Headers

Request

Response

Errors