Get batch call information

1 curl https://api.elevenlabs.io/v1/convai/batch-calling/batch_id \ 2 -H "xi-api-key: xi-api-key"

1 { 2 "id": "string", 3 "name": "string", 4 "agent_id": "string", 5 "created_at_unix": 1, 6 "scheduled_time_unix": 1, 7 "total_calls_dispatched": 1, 8 "total_calls_scheduled": 1, 9 "last_updated_at_unix": 1, 10 "status": "pending", 11 "agent_name": "string", 12 "recipients": [ 13 { 14 "id": "string", 15 "status": "pending", 16 "created_at_unix": 1, 17 "updated_at_unix": 1, 18 "conversation_id": "string", 19 "phone_number": "string", 20 "whatsapp_user_id": "string", 21 "conversation_initiation_client_data": { 22 "conversation_config_override": { 23 "tts": { 24 "voice_id": "string", 25 "stability": 1.1, 26 "speed": 1.1, 27 "similarity_boost": 1.1 28 }, 29 "conversation": { 30 "text_only": true 31 }, 32 "agent": { 33 "first_message": "string", 34 "language": "string", 35 "prompt": { 36 "prompt": "string", 37 "llm": "gpt-4o-mini", 38 "native_mcp_server_ids": [ 39 "string" 40 ] 41 } 42 } 43 }, 44 "custom_llm_extra_body": {}, 45 "user_id": "string", 46 "source_info": { 47 "source": "unknown", 48 "version": "string" 49 }, 50 "dynamic_variables": {} 51 } 52 } 53 ], 54 "phone_number_id": "string", 55 "phone_provider": "twilio", 56 "whatsapp_business_account_id": "string" 57 }

Get detailed information about a batch call including all recipients.

Path Parameters

batch_idstringRequired

Response

Successful Response

idstring

namestring

agent_idstring

created_at_unixinteger

scheduled_time_unixinteger

total_calls_dispatchedinteger

total_calls_scheduledinteger

last_updated_at_unixinteger

statusenum

Allowed values:

agent_namestring

recipientslist of objects

phone_number_idstring or null

phone_providerenum or null

Allowed values:

whatsapp_business_account_idstring or null

Path Parameters

Headers

Response

Errors