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

# Een batchoproep op ID ophalen.

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

Haal gedetailleerde informatie op over een batchcall, inclusief alle ontvangers.

Reference: https://elevenlabs.io/docs/eleven-agents/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

Geslaagde response

- `id` (string, required)
- `name` (string, required)
- `agent_id` (string, required)
- `created_at_unix` (integer, required)
- `scheduled_time_unix` (integer, required)
- `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` (TelephonyCallConfigOutput, required)
- `agent_name` (string, required)
- `recipients` (list of OutboundCallRecipientResponseModel, required)
- `phone_number_id` (string, optional)
- `phone_provider` (enum, optional)
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `whatsapp_params` (BatchCallWhatsAppParams, optional)
- `branch_id` (string, optional)
- `environment` (string, optional)
- `timezone` (string, optional)
- `target_concurrency_limit` (integer, optional) — Maximumaantal gelijktijdige gesprekken voor deze batch. Indien ingesteld, wordt de verzending bepaald door deze limiet in plaats van door capaciteitspercentages van de workspace of agent.
- `branch_name` (string, optional)

## Errors

### 422 Batch Calls Get Request Unprocessable Entity Error

Validatiefout

- `detail` (list of ValidationError, optional)

## Types

### TelephonyCallConfigOutput

- `ringing_timeout_secs` (integer, optional, default: 60) — Hoe lang de ontvanger moet worden gebeld voordat wordt gestopt, in seconden. Dit wordt ook beperkt door de eigen beperkingen van de provider.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Of het gesprek moet worden opgenomen met Twilio-gespreksopname. Wordt genegeerd voor niet-Twilio-providers. Opnames worden opgeslagen in je Twilio-account.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional) — Configuratie voor detectie van voicemail op providerniveau van Twilio (AMD). Laat weg of stel in op null om deze uit te schakelen. Wordt genegeerd voor niet-Twilio-providers en voor inkomende gesprekken. Het resulterende oordeel wordt geleverd als een eigen `answering_machine_detection`-webhookgebeurtenis. Hiervoor moet die gebeurtenis zijn ingeschakeld in de webhookinstellingen van de workspace of agent; deze maakt geen deel uit van het gesprek of de webhook na het gesprek. Detectie wordt asynchroon uitgevoerd, zodat deze de start van het gesprek nooit vertraagt. Het oordeel kan op elk moment tijdens het gesprek binnenkomen -- met `detect_message_end` zelfs nadat het gesprek is beëindigd. Twilio factureert AMD afzonderlijk.

### 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)
- `phone_number` (string, optional)
- `whatsapp_user_id` (string, optional)
- `conversation_id` (string, optional)
- `conversation_initiation_client_data` (ConversationInitiationClientDataInternal, optional)

### BatchCallWhatsAppParams

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

### ValidationError

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

### TwilioMachineDetectionConfig

Hoe Twilio's detectie van antwoordapparaten op providerniveau (AMD) moet worden uitgevoerd voor een gesprek.

- `mode` (enum, optional, default: enable) — Hoe grondig de detectie moet zijn. `enable` retourneert een beoordeling zodra Twilio een mens van een machine kan onderscheiden. `detect_message_end` wacht ook tot de voicemailbegroeting is afgelopen, wat de `machine_end_*`-beoordelingen oplevert, maar retourneert later een resultaat.
  - Allowed values: `enable`, `detect_message_end`

### ConversationInitiationClientDataInternal

- `conversation_config_override` (ConversationConfigClientOverrideOutput, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional) — ID van de eindgebruiker die aan dit gesprek deelneemt (voor gebruikersidentificatie van de eigenaar van de agent)
- `source_info` (ConversationInitiationSourceInfo, optional) — Informatie over de bron van de gespreksstart
- `branch_id` (string, optional) — ID van de agentbranch die voor dit gesprek moet worden gebruikt
- `environment` (string, optional) — Omgeving voor het oplossen van omgevingsvariabelen
- `starting_workflow_node_id` (string, optional) — Als dit is ingesteld, start je de workflow bij deze node-ID in plaats van bij het standaardbeginpunt
- `procedure_ids` (list of string, optional) — Als dit is ingesteld, zijn alleen deze procedures beschikbaar voor de startende agent. Elke ID moet aan die agent zijn gekoppeld; onbekende ID's verhinderen het starten van het gesprek. Een lege lijst schakelt alle procedures van die agent uit. Niet van toepassing na een agentoverdracht. Vereist enable_procedure_ids_from_client.
- `dynamic_variables` (map from string to any, optional)
- `tool_mock_config` (OrchestratorToolMockBehaviorConfig, optional) — Configuratie voor de tools die moeten worden gemockt en het fallbackgedrag
- `tool_mock_overrides` (map from string to list of ToolResponseMockConfigOutput, optional) — Overschrijvingen van response mocks per tool, met de opgeloste toolnaam als sleutel, die vóór de gedeelde mocks van de tool worden toegepast. Gebruikt voor testspecifieke mocks.

### ValidationErrorLocItem

### ConversationConfigClientOverrideOutput

- `asr` (AsrConversationalConfigOverride, optional) — Configuratie voor conversationele transcriptie
- `turn` (TurnConfigOverride, optional) — Configuratie voor beurtdetectie
- `tts` (TtsConversationalConfigOverride, optional) — Configuratie voor conversationele Text to Speech
- `conversation` (ConversationConfigOverride, optional) — Configuratie voor gespreksgebeurtenissen
- `agent` (AgentConfigOverrideOutput, optional) — Agentspecifieke configuratie

### ConversationInitiationSourceInfo

Informatie over de bron van de gespreksstart

- `source` (enum, optional, default: unknown) — Bron van de gespreksstart
  - 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) — Het versienummer van de SDK

### OrchestratorToolMockBehaviorConfig

Configuratie aan de kant van de orchestrator: tools worden geïdentificeerd aan de hand van opgeloste namen.

- `mocking_strategy` (enum, optional, default: none) — Welke tools moeten worden gemockt: 'all' mockt elke mockbare tool, 'selected' mockt alleen de tools in mocked_tool_names/mocked_tool_ids en 'none' schakelt mocking uit.
  - Allowed values: `all`, `selected`, `none`
- `fallback_strategy` (enum, optional, default: raise_error) — Gedrag wanneer geen mock overeenkomt met een toolaanroep.
  - Allowed values: `call_real_tool`, `raise_error`
- `mocked_tool_names` (list of string, optional) — Toolnamen die moeten worden gemockt. Alleen gebruikt wanneer mocking_strategy 'selected' is.

### ToolResponseMockConfigOutput

- `mock_result` (string, required) — De retourwaarde die de LLM ziet wanneer deze mock actief is.
- `parameter_conditions` (list of UnitTestToolCallParameter, optional) — Als de lijst leeg is, wordt de mock altijd geactiveerd.
- `is_error` (boolean, optional, default: false) — Als true, wordt het mockresultaat aan het LLM weergegeven als een toolfout in plaats van als een geslaagd resultaat.

### AsrConversationalConfigOverride

- `keywords` (list of string, optional) — Trefwoorden waarvoor de voorspellingskans moet worden verhoogd

### TurnConfigOverride

- `soft_timeout_config` (SoftTimeoutConfigOverride, optional) — Configuratie voor soft-time-outfunctionaliteit. Geeft direct feedback tijdens langere LLM-responses.

### TtsConversationalConfigOverride

- `model_id` (enum, optional, default: eleven_v4_turbo) — Het model dat voor TTS moet worden gebruikt
  - 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) — De stem-ID die voor TTS moet worden gebruikt
- `supported_voices` (list of SupportedVoice, optional) — Aanvullende ondersteunde stemmen voor de agent
- `stability` (double, optional) — De stabiliteit van gegenereerde spraak
- `speed` (double, optional) — De snelheid van gegenereerde spraak
- `similarity_boost` (double, optional) — De similariteitsboost voor gegenereerde spraak
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional) — De locators voor het uitspraakwoordenboek

### ConversationConfigOverride

- `text_only` (boolean, optional) — Als dit is ingeschakeld, wordt audio niet verwerkt en wordt alleen tekst gebruikt. Gebruik dit om audiokosten te vermijden.
- `max_duration_seconds` (integer, optional) — De maximale duur van een conversatie in seconden

### AgentConfigOverrideOutput

- `first_message` (string, optional) — Als dit niet leeg is, het eerste bericht dat de agent uitspreekt. Als het leeg is, wacht de agent tot de gebruiker het gesprek start.
- `language` (string, optional) — Taal van de agent - gebruikt voor ASR en TTS
- `max_conversation_duration_message` (string, optional) — Als dit niet leeg is, het bericht dat de agent verstuurt wanneer de maximale gespreksduur is bereikt.
- `prompt` (PromptAgentApiModelOverrideOutput, optional) — De prompt voor de agent

### UnitTestToolCallParameter

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

### SoftTimeoutConfigOverride

- `message` (string, optional) — Bericht dat wordt weergegeven wanneer de eerste zachte time-out wordt bereikt tijdens het wachten op een reactie van de LLM. Ondersteunt dynamische variabelen (bijv. \{\{system\_\_time}}, \{\{custom\_variable}}).
- `additional_soft_timeout_messages` (list of string, optional) — Extra statische opvulberichten voor volgende soft time-outs in dezelfde LLM-generatie. De eerste time-out gebruikt `message`. Als er minder berichten zijn geconfigureerd dan `max_soft_timeouts_per_generation`, wordt het laatst geconfigureerde bericht herhaald; anders wordt een ingebouwd opvulbericht gebruikt.

### SupportedVoice

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

### PydanticPronunciationDictionaryVersionLocator

Een locator waarmee andere documenten naar een specifiek woordenboek en de bijbehorende versie kunnen verwijzen. Dit is een pydantic-versie van PronunciationDictionaryVersionLocatorDBModel. Vereist om compatibiliteit met de overige datamodellen van de agent te waarborgen.

- `pronunciation_dictionary_id` (string, required) — De ID van het uitspraakwoordenboek
- `version_id` (string, optional) — De ID van de versie van het uitspraakwoordenboek

### PromptAgentApiModelOverrideOutput

- `prompt` (string, optional) — De prompt voor de agent
- `llm` (enum, optional) — De LLM die met de prompt en de chatgeschiedenis moet worden bevraagd. Bij gebruik van dataresidency moet de LLM worden ondersteund in de dataresidencyomgeving.
  - 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`, `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) — Een lijst met ID's van tools die door de agent worden gebruikt
- `tool_ids_strict` (boolean, optional) — Alleen van toepassing als overschrijving voor een gesprek en toegestaan wanneer tool_ids mag worden overschreven. Wanneer true is, bevat de overschreven tool_ids de volledige lijst met tools die in het gesprek zijn toegestaan, inclusief tools op workflownodes. Genegeerd wanneer ingesteld op de agent.
- `native_mcp_server_ids` (list of string, optional) — Een lijst met Native MCP-server-id's die door de agent moeten worden gebruikt
- `knowledge_base` (list of KnowledgeBaseLocator, optional) — Een lijst met kennisbanken die door de agent moeten worden gebruikt

### UnitTestToolCallParameterEval

- `type`: `anything`
- `type`: `exact`
  - `expected_value` (string, required) — De exacte tekenreekswaarde waarmee de parameter moet overeenkomen.
- `type`: `llm`
  - `description` (string, required) — Een beschrijving van de evaluatiestrategie voor de test.
- `type`: `regex`
  - `pattern` (string, required) — Een regex-patroon waarmee het antwoord van de agent wordt vergeleken.

### KnowledgeBaseLocator

- `type` (enum, required) — Het type kennisbank
  - Allowed values: `file`, `url`, `text`, `folder`
- `name` (string, required) — De naam van de kennisbank
- `id` (string, required) — De ID van de kennisbank
- `usage_mode` (enum, optional, default: auto) — De gebruiksmodus van de kennisbank
  - Allowed values: `prompt`, `auto`

## Examples

**Response**

```json
{
  "id": "id",
  "name": "name",
  "agent_id": "agent_id",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "total_calls_dispatched": 1,
  "total_calls_scheduled": 1,
  "total_calls_finished": 1,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 1,
  "telephony_call_config": {
    "ringing_timeout_secs": 1,
    "twilio_call_recording_enabled": true,
    "twilio_machine_detection": {
      "mode": "enable"
    }
  },
  "agent_name": "agent_name",
  "recipients": [
    {
      "id": "id",
      "status": "pending",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "phone_number": "phone_number",
      "whatsapp_user_id": "whatsapp_user_id",
      "conversation_id": "conversation_id",
      "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": [
              {
                "pronunciation_dictionary_id": "pronunciation_dictionary_id",
                "version_id": null
              }
            ]
          },
          "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": [
                "tool_ids"
              ],
              "knowledge_base": [
                {
                  "type": "file",
                  "name": "My Knowledge Base",
                  "id": "123",
                  "usage_mode": "auto"
                }
              ]
            }
          }
        }
      }
    }
  ],
  "phone_number_id": "phone_number_id",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "whatsapp_call_permission_request_template_name",
    "whatsapp_call_permission_request_template_language_code": "whatsapp_call_permission_request_template_language_code",
    "whatsapp_phone_number_id": "whatsapp_phone_number_id"
  },
  "branch_id": "branch_id",
  "environment": "environment",
  "timezone": "timezone",
  "target_concurrency_limit": 1,
  "branch_name": "branch_name"
}
```

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