---
title: "Get A Batch Call By Id."
method: GET
path: "/v1/convai/batch-calling/{batch_id}"
tags: ["Agents Platform"]
---

# Get A Batch Call By Id.

`GET /v1/convai/batch-calling/{batch_id}`

Get detailed information about a batch call including all recipients.

## Path parameters

- `batch_id` string, required

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- BatchCallDetailedResponse — Detailed response model for a batch call including all recipients.
  - `id` string, required
  - `phone_number_id` string, nullable, required
  - `phone_provider` 'twilio' | 'sip_trunk' | 'exotel', required
  - `whatsapp_params` BatchCallWhatsAppParams, required
    - `whatsapp_phone_number_id` string, nullable
    - `whatsapp_call_permission_request_template_name` string, required
    - `whatsapp_call_permission_request_template_language_code` string, required
  - `name` string, required
  - `agent_id` string, required
  - `branch_id` string, nullable, required
  - `environment` string, nullable, required
  - `created_at_unix` integer, required
  - `scheduled_time_unix` integer, required
  - `timezone` string, nullable, required
  - `total_calls_dispatched` integer, required
  - `total_calls_scheduled` integer, required
  - `total_calls_finished` integer, required
  - `last_updated_at_unix` integer, required
  - `status` 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled', required
  - `retry_count` integer, required
  - `telephony_call_config` TelephonyCallConfig, required
    - `ringing_timeout_secs` integer — How long to ring the recipient before giving up, in seconds. Note that this will also be limited by the provider's own constraints.
    - `twilio_call_recording_enabled` boolean — Whether to record the call using Twilio call recording. Ignored for non-Twilio providers. Recordings are stored in your Twilio account.
  - `target_concurrency_limit` integer, nullable, required — Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.
  - `agent_name` string, required
  - `branch_name` string, nullable, required
  - `recipients` OutboundCallRecipientResponseModel[], required
    - `id` string, required
    - `phone_number` string, nullable
    - `whatsapp_user_id` string, nullable
    - `status` 'pending' | 'dispatched' | 'initiated' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'voicemail', required
    - `created_at_unix` integer, required
    - `updated_at_unix` integer, required
    - `conversation_id` string, nullable, required
    - `conversation_initiation_client_data` ConversationInitiationClientDataInternal
      - `conversation_config_override` ConversationConfigClientOverrideOutput
        - `asr` ASRConversationalConfigOverride
          - `keywords` string[], nullable — Keywords to boost prediction probability for
        - `turn` TurnConfigOverride
          - `soft_timeout_config` SoftTimeoutConfigOverride
            - `message` string, nullable — Message to show when the first soft timeout is reached while waiting for LLM response. Supports dynamic variables (e.g., {{system__time}}, {{custom_variable}}).
        - `tts` TTSConversationalConfigOverride
          - `model_id` 'eleven_turbo_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3_conversational', nullable — The model to use for TTS
          - `voice_id` string, nullable — The voice ID to use for TTS
          - `stability` number, nullable — The stability of generated speech
          - `speed` number, nullable — The speed of generated speech
          - `similarity_boost` number, nullable — The similarity boost for generated speech
        - `conversation` ConversationConfigOverride
          - `text_only` boolean, nullable — If enabled audio will not be processed and only text will be used, use to avoid audio pricing.
        - `agent` AgentConfigOverrideOutput
          - `first_message` string, nullable — If non-empty, the first message the agent will say. If empty, the agent waits for the user to start the discussion.
          - `language` string, nullable — Language of the agent - used for ASR and TTS
          - `max_conversation_duration_message` string, nullable — If non-empty, the message the agent will send when max conversation duration is reached.
          - `prompt` PromptAgentAPIModelOverrideOutput
            - `prompt` string, nullable — The prompt for the agent
            - `llm` '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-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' | 'claude-sonnet-4-5' | 'claude-opus-4-7' | 'claude-opus-4-8' | 'claude-sonnet-4-6' | 'claude-sonnet-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' | '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', nullable — The LLM to query with the prompt and the chat history. If using data residency, the LLM must be supported in the data residency environment
            - `tool_ids` string[], nullable — A list of IDs of tools used by the agent
            - `native_mcp_server_ids` string[], nullable — A list of Native MCP server ids to be used by the agent
            - `knowledge_base` KnowledgeBaseLocator[], nullable — A list of knowledge bases to be used by the agent
              - …
      - `custom_llm_extra_body` object
      - `user_id` string, nullable — ID of the end user participating in this conversation (for agent owner's user identification)
      - `source_info` ConversationInitiationSourceInfo — Information about the source of conversation initiation
        - `source` 'unknown' | 'android_sdk' | 'node_js_sdk' | 'react_native_sdk' | 'react_sdk' | 'js_sdk' | 'python_sdk' | 'widget' | 'sip_trunk' | 'twilio' | 'exotel' | 'genesys' | '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' — Enum representing the possible sources for conversation initiation.
        - `version` string, nullable — The SDK version number
      - `branch_id` string, nullable — ID of the agent branch to use for this conversation
      - `environment` string, nullable — Environment to use for resolving environment variables
      - `starting_workflow_node_id` string, nullable — If set, start the workflow at this node id instead of the default entry
      - `dynamic_variables` object
      - `tool_mock_config` OrchestratorToolMockBehaviorConfig — Orchestrator-side config: tools are identified by resolved names.
        - `mocking_strategy` 'all' | 'selected' | 'none'
        - `fallback_strategy` 'call_real_tool' | 'raise_error'
        - `mocked_tool_names` string[] — Tool names to mock. Only used when mocking_strategy is 'selected'.
      - `tool_mock_overrides` object — Per-tool response mock overrides keyed by resolved tool name, applied ahead of the tool's shared mocks. Used for test-specific mocks.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/57d56f34628a/schema)