Get batch call information | ElevenLabs Documentation

curl https://api.elevenlabs.io/v1/convai/batch-calling/batch_id \
     -H "xi-api-key: xi-api-key"

{
  "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
  },
  "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": {
          "turn": {
            "soft_timeout_config": {
              "message": "Hhmmmm...yeah."
            }
          },
          "tts": {
            "voice_id": "cjVigY5qzO86Huf0OWal",
            "stability": 0.5,
            "speed": 1,
            "similarity_boost": 0.8
          },
          "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",
        "dynamic_variables": {},
        "tool_mock_config": {
          "mocking_strategy": "none",
          "fallback_strategy": "raise_error",
          "mocked_tool_names": [
            "string"
          ]
        }
      }
    }
  ]
}

Get detailed information about a batch call including all recipients.

Path parameters

batch_idstringRequired

Response

Successful Response

idstring

phone_number_idstring or null

phone_providerenum or null

Allowed values:

whatsapp_paramsobject or null

namestring

agent_idstring

branch_idstring or null

environmentstring or null

created_at_unixinteger

scheduled_time_unixinteger

timezonestring or null

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

telephony_call_configobject

target_concurrency_limitinteger or null>=1

Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.

agent_namestring

branch_namestring or null

recipientslist of objects

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Response

Errors