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

# WhatsApp से आउटबाउंड कॉल करें

POST https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call
Content-Type: application/json

WhatsApp के ज़रिए आउटबाउंड कॉल करें

Reference: https://elevenlabs.io/docs/api-reference/integrations/whats-app/outbound-call

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

### Body (application/json)

This endpoint expects a Body_Make_an_outbound_call_via_WhatsApp_v1_convai_whatsapp_outbound_call_post.

- `whatsapp_phone_number_id` (string, required)
- `whatsapp_user_id` (string, required)
- `whatsapp_call_permission_request_template_name` (string, required)
- `whatsapp_call_permission_request_template_language_code` (string, required)
- `agent_id` (string, required)
- `conversation_initiation_client_data` (ConversationInitiationClientDataRequest-Input, optional, nullable)

## Response

### 200

सफल रिस्पॉन्स

- `success` (boolean, required)
- `message` (string, required)
- `conversation_id` (string, required, nullable)

## Errors

### 422 Unprocessable Entity Error

वैलिडेशन एरर

- `detail` (list of ValidationError, optional)

## Types

### ConversationInitiationClientDataRequest-Input

- `conversation_config_override` (ConversationConfigClientOverride-Input, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional, nullable) — इस बातचीत में भाग लेने वाले अंतिम यूज़र की ID (एजेंट के मालिक द्वारा यूज़र की पहचान के लिए)
- `source_info` (ConversationInitiationSourceInfo, optional) — बातचीत शुरू होने के स्रोत की जानकारी
- `branch_id` (string, optional, nullable) — इस बातचीत के लिए इस्तेमाल की जाने वाली एजेंट ब्रांच की ID
- `environment` (string, optional, nullable) — environment variables को resolve करने के लिए इस्तेमाल होने वाला environment
- `starting_workflow_node_id` (string, optional, nullable) — सेट होने पर, डिफ़ॉल्ट एंट्री के बजाय इस node id से workflow शुरू करें
- `procedure_ids` (list of string, optional, nullable) — सेट होने पर, शुरुआत करने वाले एजेंट के लिए केवल ये प्रक्रियाएं उपलब्ध होंगी। हर ID उस एजेंट से जुड़ी होनी चाहिए; अज्ञात ID होने पर बातचीत शुरू नहीं होगी। खाली सूची उस एजेंट की सभी प्रक्रियाएं अक्षम कर देती है। एजेंट ट्रांसफ़र के बाद लागू नहीं होता। enable_procedure_ids_from_client आवश्यक है।
- `dynamic_variables` (map from string to any, optional)

### ValidationError

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

### ConversationConfigClientOverride-Input

- `asr` (ASRConversationalConfigOverride, optional, nullable) — कन्वर्सेशनल ट्रांसक्रिप्शन के लिए कॉन्फ़िगरेशन
- `turn` (TurnConfigOverride, optional, nullable) — टर्न डिटेक्शन के लिए कॉन्फ़िगरेशन
- `tts` (TTSConversationalConfigOverride, optional, nullable) — कन्वर्सेशनल टेक्स्ट टू स्पीच के लिए कॉन्फ़िगरेशन
- `conversation` (ConversationConfigOverride, optional, nullable) — कन्वर्सेशनल इवेंट के लिए कॉन्फ़िगरेशन
- `agent` (AgentConfigOverride-Input, optional, nullable) — एजेंट-विशिष्ट कॉन्फ़िगरेशन

### ConversationInitiationSourceInfo

बातचीत शुरू होने के स्रोत की जानकारी

- `source` (enum, optional, nullable, default: unknown) — conversation initiation का source
  - 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, nullable) — SDK वर्ज़न नंबर

### ValidationErrorLocItems

### ASRConversationalConfigOverride

- `keywords` (list of string, optional, nullable) — जिनके लिए अनुमान की संभावना बढ़ानी है वे कीवर्ड्स

### TurnConfigOverride

- `soft_timeout_config` (SoftTimeoutConfigOverride, optional, nullable) — सॉफ्ट टाइमआउट सुविधा के लिए कॉन्फ़िगरेशन। लंबे LLM रिस्पॉन्स के दौरान तुरंत फ़ीडबैक देता है।

### TTSConversationalConfigOverride

- `model_id` (enum, optional, nullable, default: eleven_v4_turbo) — TTS के लिए इस्तेमाल किया जाने वाला मॉडल
  - 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, nullable) — TTS के लिए इस्तेमाल की जाने वाली वॉइस ID
- `supported_voices` (list of SupportedVoice, optional, nullable) — एजेंट के लिए अतिरिक्त समर्थित वॉइसेज़
- `stability` (double, optional, nullable) — जनरेट की गई स्पीच की स्थिरता
- `speed` (double, optional, nullable) — जनरेट की गई स्पीच की गति
- `similarity_boost` (double, optional, nullable) — जनरेट की गई स्पीच के लिए सिमिलैरिटी बूस्ट
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional, nullable) — उच्चारण शब्दकोश लोकेटर्स

### ConversationConfigOverride

- `text_only` (boolean, optional, nullable) — इसे सक्षम करने पर ऑडियो प्रोसेस नहीं होगा और केवल टेक्स्ट का इस्तेमाल होगा। ऑडियो की कीमत से बचने के लिए इसका इस्तेमाल करें।
- `max_duration_seconds` (integer, optional, nullable) — बातचीत की अधिकतम अवधि, सेकंड में

### AgentConfigOverride-Input

- `first_message` (string, optional, nullable) — खाली न होने पर, एजेंट का पहला संदेश। खाली होने पर एजेंट चर्चा शुरू करने के लिए यूज़र का इंतज़ार करता है।
- `language` (string, optional, nullable) — एजेंट की भाषा — ASR और TTS के लिए इस्तेमाल होती है
- `max_conversation_duration_message` (string, optional, nullable) — खाली न होने पर, अधिकतम बातचीत अवधि पूरी होने पर एजेंट द्वारा भेजा जाने वाला संदेश।
- `prompt` (PromptAgentAPIModelOverride-Input, optional, nullable) — एजेंट के लिए प्रॉम्प्ट

### SoftTimeoutConfigOverride

- `message` (string, optional, nullable) — LLM जवाब की प्रतीक्षा के दौरान पहला सॉफ्ट टाइमआउट होने पर दिखाया जाने वाला संदेश। डायनामिक वेरिएबल समर्थित हैं (जैसे, \{\{system\_\_time}}, \{\{custom\_variable}})।
- `additional_soft_timeout_messages` (list of string, optional, nullable) — उसी LLM जनरेशन में बाद के soft timeout के लिए अतिरिक्त स्थिर filler संदेश। पहला timeout `message` का उपयोग करता है। यदि कॉन्फ़िगर किए गए संदेश `max_soft_timeouts_per_generation` से कम हैं, तो आखिरी कॉन्फ़िगर किया गया संदेश दोहराया जाता है; अन्यथा built-in filler इस्तेमाल होता है।

### SupportedVoice

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

### PydanticPronunciationDictionaryVersionLocator

अन्य दस्तावेज़ों के लिए किसी खास शब्दकोश और उसके संस्करण का संदर्भ देने वाला लोकेटर। यह PronunciationDictionaryVersionLocatorDBModel का pydantic संस्करण है। अन्य एजेंट डेटा मॉडल्स के साथ संगतता सुनिश्चित करने के लिए आवश्यक है।

- `pronunciation_dictionary_id` (string, required) — उच्चारण डिक्शनरी की ID
- `version_id` (string, required, nullable) — उच्चारण डिक्शनरी के वर्ज़न की ID

### PromptAgentAPIModelOverride-Input

- `prompt` (string, optional, nullable) — एजेंट के लिए प्रॉम्प्ट
- `llm` (enum, optional, nullable) — prompt और चैट हिस्ट्री के साथ क्वेरी करने वाला LLM। data residency इस्तेमाल करने पर, LLM का data residency एनवायरनमेंट में समर्थित होना ज़रूरी है।
  - 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`, `nemotron-35-super-vl-nvfp4`, `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, nullable) — एजेंट द्वारा इस्तेमाल किए गए टूल की IDs की सूची।
- `tool_ids_strict` (boolean, optional, nullable) — यह केवल कन्वर्सेशन ओवरराइड के रूप में लागू होता है और जब भी tool_ids को ओवरराइड किया जा सकता हो, तब अनुमत है। true होने पर, ओवरराइड किया गया tool_ids कन्वर्सेशन में अनुमत टूल की पूरी सूची होता है, जिसमें workflow नोड्स के टूल भी शामिल हैं। एजेंट पर सेट होने पर इसे अनदेखा किया जाता है।
- `native_mcp_server_ids` (list of string, optional, nullable) — एजेंट द्वारा उपयोग किए जाने वाले Native MCP सर्वर ids की सूची
- `knowledge_base` (list of KnowledgeBaseLocator, optional, nullable) — एजेंट द्वारा उपयोग किए जाने वाले नॉलेज बेस की सूची

### KnowledgeBaseLocator

- `type` (enum, required) — नॉलेज बेस का टाइप
  - Allowed values: `file`, `url`, `text`, `folder`
- `name` (string, required) — knowledge base का नाम
- `id` (string, required) — नॉलेज बेस की ID
- `usage_mode` (enum, optional, default: auto) — नॉलेज बेस का उपयोग मोड
  - Allowed values: `prompt`, `auto`

## Examples

**Request**

```json
{
  "whatsapp_phone_number_id": "string",
  "whatsapp_user_id": "string",
  "whatsapp_call_permission_request_template_name": "string",
  "whatsapp_call_permission_request_template_language_code": "string",
  "agent_id": "string"
}
```

**Response**

```json
{
  "success": true,
  "message": "string",
  "conversation_id": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call"

payload = {
    "whatsapp_phone_number_id": "string",
    "whatsapp_user_id": "string",
    "whatsapp_call_permission_request_template_name": "string",
    "whatsapp_call_permission_request_template_language_code": "string",
    "agent_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"whatsapp_phone_number_id":"string","whatsapp_user_id":"string","whatsapp_call_permission_request_template_name":"string","whatsapp_call_permission_request_template_language_code":"string","agent_id":"string"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call"

	payload := strings.NewReader("{\n  \"whatsapp_phone_number_id\": \"string\",\n  \"whatsapp_user_id\": \"string\",\n  \"whatsapp_call_permission_request_template_name\": \"string\",\n  \"whatsapp_call_permission_request_template_language_code\": \"string\",\n  \"agent_id\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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/whatsapp/outbound-call")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"whatsapp_phone_number_id\": \"string\",\n  \"whatsapp_user_id\": \"string\",\n  \"whatsapp_call_permission_request_template_name\": \"string\",\n  \"whatsapp_call_permission_request_template_language_code\": \"string\",\n  \"agent_id\": \"string\"\n}"

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.post("https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call")
  .header("Content-Type", "application/json")
  .body("{\n  \"whatsapp_phone_number_id\": \"string\",\n  \"whatsapp_user_id\": \"string\",\n  \"whatsapp_call_permission_request_template_name\": \"string\",\n  \"whatsapp_call_permission_request_template_language_code\": \"string\",\n  \"agent_id\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call', [
  'body' => '{
  "whatsapp_phone_number_id": "string",
  "whatsapp_user_id": "string",
  "whatsapp_call_permission_request_template_name": "string",
  "whatsapp_call_permission_request_template_language_code": "string",
  "agent_id": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"whatsapp_phone_number_id\": \"string\",\n  \"whatsapp_user_id\": \"string\",\n  \"whatsapp_call_permission_request_template_name\": \"string\",\n  \"whatsapp_call_permission_request_template_language_code\": \"string\",\n  \"agent_id\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "whatsapp_phone_number_id": "string",
  "whatsapp_user_id": "string",
  "whatsapp_call_permission_request_template_name": "string",
  "whatsapp_call_permission_request_template_language_code": "string",
  "agent_id": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/whatsapp/outbound-call")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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