> 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.

# Obter uma chamada em lote por ID.

GET https://api.elevenlabs.io/v1/convai/batch-calling/{batch_id}

Obtém informações detalhadas sobre uma chamada em lote, incluindo todos os destinatários.

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

## 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

### Path parameters

- `batch_id` (string, required)

## Response

### 200

Resposta bem-sucedida

- `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) — Número máximo de chamadas simultâneas para este lote. Quando definido, o envio é controlado por esse limite, em vez das porcentagens de capacidade do espaço de trabalho/agente.
- `agent_name` (string, required)
- `branch_name` (string, required, nullable)
- `recipients` (list of OutboundCallRecipientResponseModel, required)

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### 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-Output

- `ringing_timeout_secs` (integer, optional, default: 60) — Por quantos segundos o destinatário deve tocar antes de desistir. Isso também estará sujeito às limitações do próprio provedor.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Se deve gravar a chamada usando a gravação de chamadas da Twilio. Ignorado para provedores que não são da Twilio. As gravações são armazenadas na sua conta Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configuração da detecção de secretária eletrônica (AMD) no nível da operadora da Twilio. Omita ou defina como null para desativá-la. Ignorada para provedores que não são Twilio e para chamadas recebidas. O resultado é entregue como seu próprio evento de webhook `answering_machine_detection`, que exige que esse evento esteja ativado nas configurações de webhook do espaço de trabalho ou do agente; ele não faz parte da conversa nem do webhook pós-chamada. A detecção é executada de forma assíncrona, portanto nunca atrasa o início da conversa, e o resultado pode chegar em qualquer momento durante a chamada -- com `detect_message_end`, até mesmo após seu encerramento. A Twilio cobra separadamente pelo AMD.

### OutboundCallRecipientResponseModel

- `id` (string, required)
- `status` (enum, required)
  - Allowed values: `pending`, `dispatched`, `initiated`, `in_progress`, `completed`, `failed`, `cancelled`, `voicemail`
- `created_at_unix` (integer, required)
- `updated_at_unix` (integer, required)
- `conversation_id` (string, required, nullable)
- `phone_number` (string, optional, nullable)
- `whatsapp_user_id` (string, optional, nullable)
- `conversation_initiation_client_data` (ConversationInitiationClientDataInternal, optional, nullable)

### ValidationError

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

### TwilioMachineDetectionConfig

Como executar a detecção de secretária eletrônica (AMD) no nível da operadora do Twilio em uma chamada.

- `mode` (enum, optional, default: enable) — O quão completa deve ser a detecção. `enable` retorna um veredito assim que o Twilio consegue distinguir uma pessoa de uma máquina. `detect_message_end` também aguarda o fim da saudação da caixa postal, o que gera os vereditos `machine_end_*`, mas retorna um resultado mais tarde.
  - Allowed values: `enable`, `detect_message_end`

### ConversationInitiationClientDataInternal

- `conversation_config_override` (ConversationConfigClientOverride-Output, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional, nullable) — ID do usuário final que participa desta conversa (para identificação do usuário proprietário do agente)
- `source_info` (ConversationInitiationSourceInfo, optional) — Informações sobre a origem do início da conversa
- `branch_id` (string, optional, nullable) — ID da ramificação do agente a ser usada nesta conversa
- `environment` (string, optional, nullable) — Ambiente a ser usado para resolver variáveis de ambiente
- `starting_workflow_node_id` (string, optional, nullable) — Se definido, inicia o workflow neste ID de nó em vez da entrada padrão.
- `procedure_ids` (list of string, optional, nullable) — Se definido, somente estes procedimentos estarão disponíveis para o agente inicial. Cada ID deve estar vinculado a esse agente; IDs desconhecidos impedem o início da conversa. Uma lista vazia desativa todos os procedimentos desse agente. Não se aplica após uma transferência de agente. Requer enable_procedure_ids_from_client.
- `dynamic_variables` (map from string to any, optional)
- `tool_mock_config` (OrchestratorToolMockBehaviorConfig, optional) — Configuração das ferramentas a simular e do comportamento de fallback
- `tool_mock_overrides` (map from string to list of ToolResponseMockConfig-Output, optional) — Substituições de mocks de resposta por ferramenta, indexadas pelo nome resolvido da ferramenta e aplicadas antes dos mocks compartilhados da ferramenta. Usadas para mocks específicos de teste.

### ValidationErrorLocItems

### ConversationConfigClientOverride-Output

- `asr` (ASRConversationalConfigOverride, optional, nullable) — Configuração para transcrição conversacional
- `turn` (TurnConfigOverride, optional, nullable) — Configuração para detecção de turnos
- `tts` (TTSConversationalConfigOverride, optional, nullable) — Configuração para Text to Speech conversacional
- `conversation` (ConversationConfigOverride, optional, nullable) — Configuração para eventos de conversa
- `agent` (AgentConfigOverride-Output, optional, nullable) — Configuração específica do agente

### ConversationInitiationSourceInfo

Informações sobre a origem do início da conversa

- `source` (enum, optional, nullable, default: unknown) — Origem do início da conversa
  - 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) — O número da versão do SDK

### OrchestratorToolMockBehaviorConfig

Configuração do orquestrador: as ferramentas são identificadas pelos nomes resolvidos.

- `mocking_strategy` (enum, optional, default: none) — Quais ferramentas simular: 'all' simula todas as ferramentas que podem ser simuladas, 'selected' simula apenas as presentes em mocked_tool_names/mocked_tool_ids, e 'none' desativa a simulação.
  - Allowed values: `all`, `selected`, `none`
- `fallback_strategy` (enum, optional, default: raise_error) — Comportamento quando nenhum mock corresponde a uma chamada de ferramenta.
  - Allowed values: `call_real_tool`, `raise_error`
- `mocked_tool_names` (list of string, optional) — Nomes de ferramentas a serem simuladas. Usado somente quando mocking_strategy for 'selected'.

### ToolResponseMockConfig-Output

- `mock_result` (string, required) — O valor retornado que o LLM vê quando este mock está ativo.
- `parameter_conditions` (list of UnitTestToolCallParameter, optional) — Se a lista estiver vazia, o mock sempre será ativado.
- `is_error` (boolean, optional, default: false) — Se for true, o resultado do mock será apresentado ao LLM como um erro da ferramenta, em vez de um resultado bem-sucedido.

### ASRConversationalConfigOverride

- `keywords` (list of string, optional, nullable) — Palavras-chave para aumentar a probabilidade de previsão

### TurnConfigOverride

- `soft_timeout_config` (SoftTimeoutConfigOverride, optional, nullable) — Configuração da funcionalidade de timeout flexível. Fornece feedback imediato durante respostas mais longas da LLM.

### TTSConversationalConfigOverride

- `model_id` (enum, optional, nullable, default: eleven_v4_turbo) — O modelo a ser usado para 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) — O ID da voz a usar para TTS
- `supported_voices` (list of SupportedVoice, optional, nullable) — Vozes adicionais compatíveis com o agente
- `stability` (double, optional, nullable) — A estabilidade da fala gerada
- `speed` (double, optional, nullable) — A velocidade da fala gerada
- `similarity_boost` (double, optional, nullable) — O aumento de similaridade para a fala gerada
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional, nullable) — Os localizadores do dicionário de pronúncia

### ConversationConfigOverride

- `text_only` (boolean, optional, nullable) — Se ativado, o áudio não será processado e apenas o texto será usado. Use para evitar a cobrança de áudio.
- `max_duration_seconds` (integer, optional, nullable) — A duração máxima de uma conversa em segundos

### AgentConfigOverride-Output

- `first_message` (string, optional, nullable) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa.
- `language` (string, optional, nullable) — Idioma do agente — usado para ASR e TTS
- `max_conversation_duration_message` (string, optional, nullable) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida.
- `prompt` (PromptAgentAPIModelOverride-Output, optional, nullable) — O prompt do agente

### UnitTestToolCallParameter

- `eval` (UnitTestToolCallParameterEval, required)
- `path` (string, required)

### SoftTimeoutConfigOverride

- `message` (string, optional, nullable) — Mensagem a exibir quando o primeiro tempo limite flexível for atingido durante a espera pela resposta do LLM. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}).
- `additional_soft_timeout_messages` (list of string, optional, nullable) — Mensagens estáticas extras de preenchimento para os soft timeouts subsequentes na mesma geração de LLM. O primeiro timeout usa `message`. Se houver menos mensagens configuradas que `max_soft_timeouts_per_generation`, a última mensagem configurada será repetida; caso contrário, será usada uma mensagem de preenchimento integrada.

### 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

Um localizador para que outros documentos possam fazer referência a um dicionário específico e à sua versão. Esta é uma versão pydantic de PronunciationDictionaryVersionLocatorDBModel. Necessário para garantir compatibilidade com os demais modelos de dados do agente.

- `pronunciation_dictionary_id` (string, required) — O ID do dicionário de pronúncia
- `version_id` (string, required, nullable) — O ID da versão do dicionário de pronúncia

### PromptAgentAPIModelOverride-Output

- `prompt` (string, optional, nullable) — O prompt do agente
- `llm` (enum, optional, nullable) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados.
  - 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`, `gemini-4-argon`, `claude-sonnet-4-5`, `claude-opus-4-6`, `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-haiku-5-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`, `nemotron-35-super-vl-nvfp4`, `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) — Uma lista de IDs das ferramentas usadas pelo agente.
- `tool_ids_strict` (boolean, optional, nullable) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente.
- `native_mcp_server_ids` (list of string, optional, nullable) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente
- `knowledge_base` (list of KnowledgeBaseLocator, optional, nullable) — Uma lista de bases de conhecimento a serem usadas pelo agente

### UnitTestToolCallParameterEval

- `type`: `anything` (MatchAnythingParameterEvaluationStrategy)
- `type`: `exact` (ExactParameterEvaluationStrategy)
  - `expected_value` (string, required) — O valor exato da string ao qual o parâmetro deve corresponder.
- `type`: `llm` (LLMParameterEvaluationStrategy)
  - `description` (string, required) — Uma descrição da estratégia de avaliação a ser usada no teste.
- `type`: `regex` (RegexParameterEvaluationStrategy)
  - `pattern` (string, required) — Um padrão regex para comparar com a resposta do agente.

### KnowledgeBaseLocator

- `type` (enum, required) — O tipo da base de conhecimento
  - Allowed values: `file`, `url`, `text`, `folder`
- `name` (string, required) — O nome da base de conhecimento
- `id` (string, required) — O ID da base de conhecimento
- `usage_mode` (enum, optional, default: auto) — O modo de uso da base de conhecimento
  - Allowed values: `prompt`, `auto`

## Examples

**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",
  "recipients": [
    {
      "id": "string",
      "status": "pending",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "conversation_id": "string",
      "phone_number": "string",
      "whatsapp_user_id": "string",
      "conversation_initiation_client_data": {
        "conversation_config_override": {
          "asr": {
            "keywords": [
              "hello",
              "world"
            ]
          },
          "turn": {
            "soft_timeout_config": {
              "message": "Hhmmmm...yeah."
            }
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8,
            "pronunciation_dictionary_locators": []
          },
          "conversation": {
            "max_duration_seconds": 600
          },
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "prompt": {
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "llm": "gemini-2.0-flash-001",
              "tool_ids": [],
              "knowledge_base": []
            }
          }
        },
        "custom_llm_extra_body": {},
        "user_id": "string",
        "source_info": {
          "source": "unknown",
          "version": "string"
        },
        "branch_id": "string",
        "environment": "string",
        "starting_workflow_node_id": "string",
        "procedure_ids": [
          "string"
        ],
        "dynamic_variables": {},
        "tool_mock_config": {
          "mocking_strategy": "none",
          "fallback_strategy": "raise_error",
          "mocked_tool_names": [
            "string"
          ]
        },
        "tool_mock_overrides": {}
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/batch-calling/batch_id';
const options = {method: 'GET'};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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/batch_id")

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

request = Net::HTTP::Get.new(url)

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.get("https://api.elevenlabs.io/v1/convai/batch-calling/batch_id")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/batch-calling/batch_id');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/batch-calling/batch_id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/batch-calling/batch_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```