Cancel batch calling job

1 from elevenlabs import ElevenLabs 2 3 client = ElevenLabs( 4 base_url="https://api.elevenlabs.io" 5 ) 6 7 client.conversational_ai.batch_calls.cancel( 8 batch_id="batch_id" 9 )

1 { 2 "id": "b7a1f3d2-9c4e-4f6a-8a2e-3d5f7b9c1e2a", 3 "phone_number_id": "pn_987654321", 4 "phone_provider": "twilio", 5 "whatsapp_params": { 6 "whatsapp_call_permission_request_template_name": "call_permission_request", 7 "whatsapp_call_permission_request_template_language_code": "en_US", 8 "whatsapp_phone_number_id": "wa_123456789" 9 }, 10 "name": "March Sales Outreach", 11 "agent_id": "agent_4567", 12 "created_at_unix": 1710000000, 13 "scheduled_time_unix": 1710050000, 14 "total_calls_dispatched": 150, 15 "total_calls_scheduled": 200, 16 "total_calls_finished": 120, 17 "last_updated_at_unix": 1710060000, 18 "status": "cancelled", 19 "retry_count": 2, 20 "agent_name": "Sophia Martinez" 21 }

Cancel a running batch call and set all recipients to cancelled status.

Path parameters

batch_idstringRequired

Response

Successful Response

idstring

phone_number_idstring or null

phone_providerenum or null

Allowed values:

whatsapp_paramsobject or null

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

Path parameters

Headers

Response

Errors