Submit batch calling job

from elevenlabs import ElevenLabs
from elevenlabs.environment import ElevenLabsEnvironment
client = ElevenLabs(
    environment=ElevenLabsEnvironment.PRODUCTION
)
client.conversational_ai.batch_calls.create(
    call_name="call_name",
    agent_id="agent_id",
    recipients=[
        {}
    ]
)

{
  "id": "id",
  "name": "name",
  "agent_id": "agent_id",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "total_calls_dispatched": 1,
  "total_calls_scheduled": 1,
  "total_calls_finished": 1,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 1,
  "agent_name": "agent_name",
  "phone_number_id": "phone_number_id",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "whatsapp_call_permission_request_template_name",
    "whatsapp_call_permission_request_template_language_code": "whatsapp_call_permission_request_template_language_code",
    "whatsapp_phone_number_id": "whatsapp_phone_number_id"
  },
  "timezone": "timezone"
}

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

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

agent_namestring

phone_number_idstring or null

phone_providerenum or null

Allowed values:

whatsapp_paramsobject or null

timezonestring or null

Headers

Request

Response

Errors