Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Make An Outbound Call Via Whatsapp

Make an outbound call via WhatsApp

post/v1/convai/whatsapp/outbound-call

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

whatsapp_phone_number_idstring required
whatsapp_user_idstring required
whatsapp_call_permission_request_template_namestring required
whatsapp_call_permission_request_template_language_codestring required
agent_idstring required

Example request

{
  "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

successboolean required
messagestring required
conversation_idstring nullable required