Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Submit A Batch Call Request.

Submit a batch call request to schedule calls for multiple recipients.

post/v1/convai/batch-calling/submit

Headers

xi-api-keystring 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.

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.

Request body

call_namestring required
agent_idstring required
scheduled_time_unixinteger nullable
agent_phone_number_idstring nullable
timezonestring nullable
branch_idstring nullable
environmentstring nullable
target_concurrency_limitinteger nullable

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

Example request

{
  "recipients": [
    {
      "conversation_initiation_client_data": {
        "conversation_config_override": {
          "agent": {
            "first_message": "Hello, how can I help you today?",
            "language": "en",
            "prompt": {
              "knowledge_base": [],
              "llm": "gemini-2.0-flash-001",
              "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
              "tool_ids": []
            }
          },
          "asr": {
            "keywords": [
              "hello",
              "world"
            ]
          },
          "tts": {
            "model_id": "eleven_turbo_v2",
            "similarity_boost": 0.8,
            "speed": 1,
            "stability": 0.5,
            "voice_id": "cjVigY5qzO86Huf0OWal"
          },
          "turn": {
            "soft_timeout_config": {
              "message": "Hhmmmm...yeah."
            }
          }
        }
      }
    }
  ]
}

Response

Successful Response

idstring required
phone_number_idstring nullable required
phone_provider'twilio' | 'sip_trunk' | 'exotel' required
namestring required
agent_idstring required
branch_idstring nullable required
environmentstring nullable required
created_at_unixinteger required
scheduled_time_unixinteger required
timezonestring nullable required
total_calls_dispatchedinteger required
total_calls_scheduledinteger required
total_calls_finishedinteger required
last_updated_at_unixinteger required
status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required
retry_countinteger required
target_concurrency_limitinteger 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_namestring required
branch_namestring nullable required