Submit batch calling job

1 var client = new RestClient("https://api.elevenlabs.io/v1/convai/batch-calling/submit"); 2 var request = new RestRequest(Method.POST); 3 request.AddHeader("xi-api-key", "xi-api-key"); 4 request.AddHeader("Content-Type", "application/json"); 5 request.AddParameter("application/json", "{\n \"call_name\": \"Customer Satisfaction Survey April 2024\",\n \"agent_id\": \"agent_9f8b7c6d5e4a3b2c1d0e\",\n \"recipients\": [\n {\n \"id\": \"recipient_001\",\n \"phone_number\": \"+14155552671\",\n \"whatsapp_user_id\": \"wa_user_1234567890\",\n \"conversation_initiation_client_data\": {\n \"conversation_config_override\": {\n \"turn\": {\n \"soft_timeout_config\": {\n \"message\": \"Please hold on a moment while I process your response.\"\n }\n },\n \"tts\": {\n \"voice_id\": \"cjVigY5qzO86Huf0OWal\",\n \"stability\": 0.7,\n \"speed\": 1,\n \"similarity_boost\": 0.85\n },\n \"conversation\": {\n \"text_only\": false\n },\n \"agent\": {\n \"first_message\": \"Hello John, thank you for being a valued customer!\",\n \"language\": \"en\",\n \"prompt\": {\n \"prompt\": \"You are a friendly assistant conducting a customer satisfaction survey.\",\n \"llm\": \"gpt-4o-mini\"\n }\n }\n },\n \"custom_llm_extra_body\": {\n \"survey_version\": \"v2.1\",\n \"priority\": \"high\"\n },\n \"user_id\": \"user_abc123\",\n \"source_info\": {\n \"source\": \"twilio\",\n \"version\": \"1.4.2\"\n },\n \"dynamic_variables\": {\n \"customer_name\": \"John Doe\",\n \"last_purchase_date\": \"2024-03-20\",\n \"vip_status\": true\n }\n }\n }\n ]\n}", ParameterType.RequestBody); 6 IRestResponse response = client.Execute(request);

1 { 2 "id": "batchcall_5a3f9e7d8c2b4f1a9e0d", 3 "phone_number_id": "phone_num_7890abcd1234", 4 "phone_provider": "twilio", 5 "whatsapp_params": { 6 "whatsapp_call_permission_request_template_name": "survey_permission_request", 7 "whatsapp_call_permission_request_template_language_code": "en_US", 8 "whatsapp_phone_number_id": "wa_phone_5678efgh9012" 9 }, 10 "name": "Customer Satisfaction Survey April 2024", 11 "agent_id": "agent_9f8b7c6d5e4a3b2c1d0e", 12 "created_at_unix": 1711305600, 13 "scheduled_time_unix": 1711392000, 14 "total_calls_dispatched": 0, 15 "total_calls_scheduled": 1, 16 "total_calls_finished": 0, 17 "last_updated_at_unix": 1711305600, 18 "status": "pending", 19 "retry_count": 0, 20 "agent_name": "SurveyBot Alpha" 21 }

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

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

Headers

Request

Response

Errors