> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Invia una richiesta di chiamata batch.

POST https://api.elevenlabs.io/v1/convai/batch-calling/submit
Content-Type: application/json

Invia una richiesta di chiamata batch per pianificare chiamate per più destinatari.

Reference: https://elevenlabs.io/docs/api-reference/batch-calling/create

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Body (application/json)

This endpoint expects a Body_Submit_a_batch_call_request__v1_convai_batch_calling_submit_post.

- `call_name` (string, required)
- `agent_id` (string, required)
- `recipients` (list of OutboundCallRecipient, required)
- `scheduled_time_unix` (integer, optional, nullable)
- `agent_phone_number_id` (string, optional, nullable)
- `whatsapp_params` (BatchCallWhatsAppParams, optional, nullable)
- `timezone` (string, optional, nullable)
- `branch_id` (string, optional, nullable)
- `environment` (string, optional, nullable)
- `telephony_call_config` (TelephonyCallConfig-Input, optional)
- `target_concurrency_limit` (integer, optional, nullable) — Numero massimo di chiamate simultanee per questo batch. Quando impostato, l'invio è regolato da questo limite anziché dalle percentuali di capacità del workspace o dell'agente.

## Response

### 200

Risposta riuscita

- `id` (string, required)
- `phone_number_id` (string, required, nullable)
- `phone_provider` (enum, required, nullable)
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `whatsapp_params` (BatchCallWhatsAppParams, required, nullable)
- `name` (string, required)
- `agent_id` (string, required)
- `branch_id` (string, required, nullable)
- `environment` (string, required, nullable)
- `created_at_unix` (integer, required)
- `scheduled_time_unix` (integer, required)
- `timezone` (string, required, nullable)
- `total_calls_dispatched` (integer, required, default: 0)
- `total_calls_scheduled` (integer, required, default: 0)
- `total_calls_finished` (integer, required, default: 0)
- `last_updated_at_unix` (integer, required)
- `status` (enum, required)
  - Allowed values: `pending`, `in_progress`, `completed`, `failed`, `cancelled`
- `retry_count` (integer, required, default: 0)
- `telephony_call_config` (TelephonyCallConfig-Output, required)
- `target_concurrency_limit` (integer, required, nullable) — Numero massimo di chiamate simultanee per questo batch. Quando impostato, l'invio è regolato da questo limite anziché dalle percentuali di capacità del workspace o dell'agente.
- `agent_name` (string, required)
- `branch_name` (string, required, nullable)

## Errors

### 422 Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### OutboundCallRecipient

- `id` (string, optional, nullable)
- `phone_number` (string, optional, nullable)
- `whatsapp_user_id` (string, optional, nullable)
- `conversation_initiation_client_data` (ConversationInitiationClientDataRequest-Input, optional, nullable)

### BatchCallWhatsAppParams

- `whatsapp_call_permission_request_template_name` (string, required)
- `whatsapp_call_permission_request_template_language_code` (string, required)
- `whatsapp_phone_number_id` (string, optional, nullable)

### TelephonyCallConfig-Input

- `ringing_timeout_secs` (integer, optional, default: 60) — Per quanti secondi far squillare il destinatario prima di interrompere. Tieni presente che sarà limitato anche dai vincoli del provider.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Indica se registrare la chiamata tramite la registrazione chiamate di Twilio. Ignorato per i provider diversi da Twilio. Le registrazioni vengono archiviate nel tuo account Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configurazione per il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio. Ometti o imposta su null per disabilitarlo. Viene ignorata per i provider diversi da Twilio e per le chiamate in entrata. Il verdetto risultante viene inviato come evento webhook `answering_machine_detection` separato, che richiede l'abilitazione di tale evento nelle impostazioni webhook del workspace o dell'agente; non fa parte della conversazione né del webhook post-chiamata. Il rilevamento viene eseguito in modo asincrono, quindi non ritarda mai l'inizio della conversazione, e il verdetto può arrivare in qualsiasi momento durante la chiamata -- con `detect_message_end`, anche dopo la sua conclusione. Twilio fattura AMD separatamente.

### TelephonyCallConfig-Output

- `ringing_timeout_secs` (integer, optional, default: 60) — Per quanti secondi far squillare il destinatario prima di interrompere. Tieni presente che sarà limitato anche dai vincoli del provider.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Indica se registrare la chiamata tramite la registrazione chiamate di Twilio. Ignorato per i provider diversi da Twilio. Le registrazioni vengono archiviate nel tuo account Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configurazione per il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio. Ometti o imposta su null per disabilitarlo. Viene ignorata per i provider diversi da Twilio e per le chiamate in entrata. Il verdetto risultante viene inviato come evento webhook `answering_machine_detection` separato, che richiede l'abilitazione di tale evento nelle impostazioni webhook del workspace o dell'agente; non fa parte della conversazione né del webhook post-chiamata. Il rilevamento viene eseguito in modo asincrono, quindi non ritarda mai l'inizio della conversazione, e il verdetto può arrivare in qualsiasi momento durante la chiamata -- con `detect_message_end`, anche dopo la sua conclusione. Twilio fattura AMD separatamente.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ConversationInitiationClientDataRequest-Input

- `conversation_config_override` (ConversationConfigClientOverride-Input, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional, nullable) — ID dell'utente finale che partecipa a questa conversazione, per l'identificazione dell'utente proprietario dell'agente
- `source_info` (ConversationInitiationSourceInfo, optional) — Informazioni sull'origine dell'avvio della conversazione
- `branch_id` (string, optional, nullable) — ID del branch dell'agente da usare per questa conversazione
- `environment` (string, optional, nullable) — Ambiente da usare per risolvere le variabili di ambiente
- `starting_workflow_node_id` (string, optional, nullable) — Se impostato, avvia il workflow dall'ID di questo nodo anziché dal punto di ingresso predefinito.
- `procedure_ids` (list of string, optional, nullable) — Se impostato, solo queste procedure sono disponibili per l'agente iniziale. Ogni ID deve essere associato a quell'agente; gli ID sconosciuti impediscono l'avvio della conversazione. Un elenco vuoto disabilita tutte le procedure dell'agente. Non viene applicato dopo un trasferimento dell'agente. Richiede enable_procedure_ids_from_client.
- `dynamic_variables` (map from string to any, optional)

### TwilioMachineDetectionConfig

Come eseguire il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio durante una chiamata.

- `mode` (enum, optional, default: enable) — Quanto deve essere approfondito il rilevamento. `enable` restituisce un verdetto non appena Twilio riesce a distinguere una persona da una macchina. `detect_message_end` attende anche la fine del messaggio di segreteria telefonica, producendo i verdetti `machine_end_*`, ma restituisce il risultato più tardi.
  - Allowed values: `enable`, `detect_message_end`

### ValidationErrorLocItems

### ConversationConfigClientOverride-Input

- `asr` (ASRConversationalConfigOverride, optional, nullable) — Configurazione per la trascrizione conversazionale
- `turn` (TurnConfigOverride, optional, nullable) — Configurazione per il rilevamento dei turni
- `tts` (TTSConversationalConfigOverride, optional, nullable) — Configurazione per la sintesi vocale conversazionale
- `conversation` (ConversationConfigOverride, optional, nullable) — Configurazione per gli eventi conversazionali
- `agent` (AgentConfigOverride-Input, optional, nullable) — Configurazione specifica dell'agente

### ConversationInitiationSourceInfo

Informazioni sull'origine dell'avvio della conversazione

- `source` (enum, optional, nullable, default: unknown) — Origine dell'avvio della conversazione
  - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool`
- `version` (string, optional, nullable) — Il numero di versione dell'SDK

### ASRConversationalConfigOverride

- `keywords` (list of string, optional, nullable) — Parole chiave per aumentare la probabilità di previsione per

### TurnConfigOverride

- `soft_timeout_config` (SoftTimeoutConfigOverride, optional, nullable) — Configurazione della funzionalità di soft timeout. Fornisce feedback immediato durante risposte LLM più lunghe.

### TTSConversationalConfigOverride

- `model_id` (enum, optional, nullable, default: eleven_v4_turbo) — Il modello da usare per il TTS
  - Allowed values: `eleven_turbo_v2`, `eleven_turbo_v2_5`, `eleven_flash_v2`, `eleven_flash_v2_5`, `eleven_multilingual_v2`, `eleven_v3_conversational`, `eleven_v4`, `eleven_v4_turbo`
- `voice_id` (string, optional, nullable) — L'ID della voce da usare per TTS
- `supported_voices` (list of SupportedVoice, optional, nullable) — Voci supportate aggiuntive per l'agente
- `stability` (double, optional, nullable) — La stabilità del parlato generato
- `speed` (double, optional, nullable) — La velocità del parlato generato
- `similarity_boost` (double, optional, nullable) — L'aumento di somiglianza per il parlato generato
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional, nullable) — I locator del dizionario di pronuncia

### ConversationConfigOverride

- `text_only` (boolean, optional, nullable) — Se abilitato, l'audio non verrà elaborato e verrà usato solo il testo, per evitare i costi dell'audio.
- `max_duration_seconds` (integer, optional, nullable) — La durata massima di una conversazione in secondi

### AgentConfigOverride-Input

- `first_message` (string, optional, nullable) — Se non è vuoto, è il primo messaggio che l'agente pronuncerà. Se è vuoto, l'agente attende che l'utente avvii la conversazione.
- `language` (string, optional, nullable) — Lingua dell'agente, usata per ASR e TTS
- `max_conversation_duration_message` (string, optional, nullable) — Se non è vuoto, è il messaggio che l'agente invierà al raggiungimento della durata massima della conversazione.
- `prompt` (PromptAgentAPIModelOverride-Input, optional, nullable) — Il prompt per l'agente

### SoftTimeoutConfigOverride

- `message` (string, optional, nullable) — Messaggio da mostrare quando viene raggiunto il primo timeout flessibile durante l'attesa della risposta LLM. Supporta le variabili dinamiche (ad esempio \{\{system\_\_time}}, \{\{custom\_variable}}).
- `additional_soft_timeout_messages` (list of string, optional, nullable) — Messaggi di riempimento statici aggiuntivi per i soft timeout successivi nella stessa generazione LLM. Il primo timeout usa `message`. Se sono configurati meno messaggi di `max_soft_timeouts_per_generation`, viene ripetuto l'ultimo messaggio configurato; altrimenti viene usato un messaggio di riempimento integrato.

### SupportedVoice

- `label` (string, required)
- `voice_id` (string, required)
- `description` (string, optional, nullable)
- `language` (string, optional, nullable)
- `model_family` (enum, optional, nullable)
  - Allowed values: `turbo`, `flash`, `multilingual`, `v3_conversational`, `v4`, `v4_turbo`
- `optimize_streaming_latency` (enum, optional, nullable)
  - Allowed values: `0`, `1`, `2`, `3`, `4`
- `stability` (double, optional, nullable)
- `speed` (double, optional, nullable)
- `similarity_boost` (double, optional, nullable)

### PydanticPronunciationDictionaryVersionLocator

Un locator che consente ad altri documenti di fare riferimento a un dizionario specifico e alla sua versione. Questa è una versione Pydantic di PronunciationDictionaryVersionLocatorDBModel. Necessaria per garantire la compatibilità con gli altri modelli di dati dell'agente.

- `pronunciation_dictionary_id` (string, required) — L'ID del dizionario di pronuncia
- `version_id` (string, required, nullable) — L'ID della versione del dizionario di pronuncia

### PromptAgentAPIModelOverride-Input

- `prompt` (string, optional, nullable) — Il prompt per l'agente
- `llm` (enum, optional, nullable) — L'LLM da interrogare con il prompt e la cronologia della chat. Se utilizzi la residenza dei dati, l'LLM deve essere supportato nell'ambiente di residenza dei dati.
  - Allowed values: `gpt-4o-mini`, `gpt-4o`, `gpt-4`, `gpt-4-turbo`, `gpt-4.1`, `gpt-4.1-mini`, `gpt-4.1-nano`, `gpt-5`, `gpt-5.1`, `gpt-5.2`, `gpt-5.2-chat-latest`, `gpt-5.4`, `gpt-5.4-mini`, `gpt-5.4-nano`, `gpt-5.5`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-6-astra`, `gpt-6-sol`, `gpt-6-luna`, `gpt-6.1-sol`, `gpt-5-mini`, `gpt-5-nano`, `gpt-3.5-turbo`, `gemini-1.5-pro`, `gemini-1.5-flash`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`, `gemini-2.5-flash-lite`, `gemini-2.5-flash`, `gemini-3-pro-preview`, `gemini-3-flash-preview`, `gemini-3.1-pro-preview`, `gemini-3.1-flash-lite-preview`, `gemini-3.1-flash-lite`, `gemini-3.5-flash`, `gemini-3.5-flash-lite`, `gemini-3.6-flash`, `gemini-3.7-flash`, `gemini-3.8-flash`, `claude-sonnet-4-5`, `claude-opus-4-7`, `claude-opus-4-8`, `claude-opus-5`, `claude-opus-5-5`, `claude-sonnet-4-6`, `claude-sonnet-5`, `claude-sonnet-5-5`, `claude-sonnet-4`, `claude-haiku-4-5`, `claude-3-7-sonnet`, `claude-3-5-sonnet`, `claude-3-5-sonnet-v1`, `claude-3-haiku`, `grok-beta`, `custom-llm`, `qwen3-4b`, `qwen3-30b-a3b`, `qwen36-35b-a3b`, `qwen35-397b-a17b`, `gpt-oss-20b`, `gpt-oss-120b`, `glm-45-air-fp8`, `glm-52`, `deepseek-v41-flash`, `gemini-2.5-flash-preview-09-2025`, `gemini-2.5-flash-lite-preview-09-2025`, `gemini-2.5-flash-preview-05-20`, `gemini-2.5-flash-preview-04-17`, `gemini-2.5-flash-lite-preview-06-17`, `gemini-2.0-flash-lite-001`, `gemini-2.0-flash-001`, `gemini-1.5-flash-002`, `gemini-1.5-flash-001`, `gemini-1.5-pro-002`, `gemini-1.5-pro-001`, `claude-sonnet-4@20250514`, `claude-sonnet-4-5@20250929`, `claude-haiku-4-5@20251001`, `claude-3-7-sonnet@20250219`, `claude-3-5-sonnet@20240620`, `claude-3-5-sonnet-v2@20241022`, `claude-3-haiku@20240307`, `gpt-5-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.5-2026-04-23`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-2024-05-13`, `gpt-4-0613`, `gpt-4-0314`, `gpt-4-turbo-2024-04-09`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `watt-tool-8b`, `watt-tool-70b`
- `tool_ids` (list of string, optional, nullable) — Un elenco di ID degli strumenti usati dall'agente.
- `native_mcp_server_ids` (list of string, optional, nullable) — Un elenco di ID dei server MCP nativi da usare con l'agente
- `knowledge_base` (list of KnowledgeBaseLocator, optional, nullable) — Un elenco di knowledge base da usare con l'agente

### KnowledgeBaseLocator

- `type` (enum, required) — Il tipo di knowledge base
  - Allowed values: `file`, `url`, `text`, `folder`
- `name` (string, required) — Il nome della knowledge base
- `id` (string, required) — L'ID della knowledge base
- `usage_mode` (enum, optional, default: auto) — La modalità di utilizzo della knowledge base
  - Allowed values: `prompt`, `auto`

## Examples

**Request**

```json
{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ]
}
```

**Response**

```json
{
  "id": "string",
  "phone_number_id": "string",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "string",
    "whatsapp_call_permission_request_template_language_code": "string",
    "whatsapp_phone_number_id": "string"
  },
  "name": "string",
  "agent_id": "string",
  "branch_id": "string",
  "environment": "string",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "timezone": "string",
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 0,
  "total_calls_finished": 0,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 0,
  "telephony_call_config": {
    "ringing_timeout_secs": 60,
    "twilio_call_recording_enabled": false,
    "twilio_machine_detection": {
      "mode": "enable"
    }
  },
  "target_concurrency_limit": 1,
  "agent_name": "string",
  "branch_name": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/batch-calling/submit"

payload = {
    "call_name": "string",
    "agent_id": "string",
    "recipients": [{}]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/batch-calling/submit';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"call_name":"string","agent_id":"string","recipients":[{}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/batch-calling/submit"

	payload := strings.NewReader("{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/batch-calling/submit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.elevenlabs.io/v1/convai/batch-calling/submit")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/batch-calling/submit', [
  'body' => '{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/batch-calling/submit");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "call_name": "string",
  "agent_id": "string",
  "recipients": [[]]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/batch-calling/submit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```