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

# आउटबाउंड कैंपेन बनाएं

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

एक आउटबाउंड अभियान बनाएं, जो पॉलिसी की कॉलिंग विंडो के भीतर एजेंट के ज़रिए हर प्राप्तकर्ता को कॉल या मैसेज करे, और अनुमति के अनुसार रीट्राई व फ़ॉलो-अप करे। नए अभियान के लिए `201` लौटाता है। `idempotency_key` या अनुरोध बॉडी से मेल खाने वाला दोहराया गया अनुरोध, `created` को false के साथ मौजूदा अभियान लौटाता है।

Reference: https://elevenlabs.io/docs/api-reference/campaigns/create

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

- `call_name` (string, required) — अभियान का नाम।
- `agent_id` (string, required) — कॉल करने वाला एजेंट।
- `recipients` (list of SubmitCampaignRecipient, required) — किसे कॉल करना है। हर प्राप्तकर्ता कैंपेन की एक लीड बन जाता है।
- `channel_config` (SubmitCampaignRequestChannelConfig, required)
- `scheduled_time_unix` (integer, optional, nullable) — कॉल करना कब शुरू करें; अभी शुरू करने के लिए इसे छोड़ दें। कॉल्स फिर भी अगले कॉलिंग विंडो का इंतज़ार करती हैं।
- `timezone` (string, optional, nullable) — कॉलिंग विंडो पढ़ने के लिए IANA टाइमज़ोन, जो पॉलिसी वाले टाइमज़ोन को ओवरराइड करता है।
- `branch_id` (string, optional, nullable) — कॉल करने के लिए एजेंट ब्रांच।
- `environment` (string, optional, nullable) — एजेंट के एनवायरनमेंट वैरिएबल रिज़ॉल्व करने का एनवायरनमेंट।
- `target_concurrency_limit` (integer, optional, nullable) — एक साथ की जाने वाली अधिकतम कॉल।
- `idempotency_key` (string, optional, nullable) — अनुरोध को रीट्राई के लिए सुरक्षित बनाता है: उसी कुंजी के साथ दोहराने पर उसके द्वारा बनाया गया अभियान लौटता है।
- `outcome` (SubmitCampaignRequestOutcome, optional, nullable) — वह परिणाम जिसे कैंपेन की कॉल के लिए सफलता माना जाता है।
- `policy` (PolicyConfig-Input, optional, nullable) — अभियान पर स्नैपशॉट करने के लिए पॉलिसी। सेट होने पर यह वर्कस्पेस डिफ़ॉल्ट और किसी भी प्रति-एजेंट ओवरराइड पर प्राथमिकता पाती है; छोड़ने पर वर्कस्पेस कॉन्फ़िगरेशन मौजूद होना चाहिए और वही पॉलिसी देता है।
- `variant` (enum, optional, nullable) — `simple` हर प्राप्तकर्ता के लिए हमेशा खुले कॉलिंग विंडो के साथ एक प्रयास चलाता है और कोई डेटा एकत्र नहीं करता; इसे `policy` के साथ नहीं जोड़ा जा सकता। `advanced`, `policy` या वर्कस्पेस कॉन्फ़िगरेशन का उपयोग करता है और फ़ोन अभियानों के लिए डिफ़ॉल्ट है।
  - Allowed values: `simple`, `advanced`

## Response

### 200

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

- `campaign` (CampaignResponse, required)
- `created` (boolean, required) — जब अनुरोध पहले वाले अनुरोध की पुनरावृत्ति हो और उसका अभियान लौटाए, तब false।
- `within_calling_window` (boolean, required) — क्या कॉलिंग अगली कॉलिंग विंडो के बजाय तुरंत शुरू होती है।

## Errors

### 422 Unprocessable Entity Error

वैलिडेशन एरर

- `detail` (list of ValidationError, optional)

## Types

### SubmitCampaignRecipient

- `phone_number` (string, optional, nullable) — कॉल करने का नंबर, E.164 फ़ॉर्मैट में, जैसे `+14155550100`।
- `phone_numbers` (list of string, optional, nullable) — `phone_number` के बाद क्रम में कॉल करने के लिए और नंबर। मौजूदा नंबर पर कॉल लगातार विफल होने पर लीड अगले नंबर पर जाती है।
- `whatsapp_user_id` (string, optional, nullable) — संपर्क की WhatsApp यूज़र ID। WhatsApp अभियान फ़ोन नंबर के बजाय इसका उपयोग करते हैं।
- `id` (string, optional, nullable) — प्राप्तकर्ता के लिए आपका आइडेंटिफ़ायर, जो उसकी लीड के `recipient_id` के रूप में लौटाया जाता है।
- `conversation_initiation_client_data` (ConversationInitiationClientDataRequest-Input, optional, nullable) — इस प्राप्तकर्ता की कॉल के लिए डायनामिक वैरिएबल और ओवरराइड।

### SubmitCampaignRequestChannelConfig

- `channel`: `phone` (PhoneChannelConfig)
  - `agent_phone_number_id` (string, required) — जिस फ़ोन नंबर से कॉल करनी है।
  - `mode_config` (PhoneVoiceConfig-Input, optional)
- `channel`: `whatsapp` (SubmitWhatsAppChannelConfig)
  - `mode_config` (SubmitWhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — वह WhatsApp फ़ोन नंबर जिससे कॉल या मैसेज किया जाएगा।

### SubmitCampaignRequestOutcome

वह परिणाम जिसे कैंपेन की कॉल के लिए सफलता माना जाता है।

- `type`: `data_collection` (DataCollectionOutcome)
  - `data_collection_id` (string, required) — एजेंट का वह डेटा कलेक्शन आइटम जिसे सफल कॉल सेट करती है।
  - `equals` (list of CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems, required) — वे मान जो सफलता माने जाते हैं और सभी आइटम के प्रकार के हैं।
- `type`: `evaluation_criteria` (EvaluationCriterionOutcome)
  - `criteria_id` (string, required) — एजेंट का वह मूल्यांकन मानदंड जिसे सफल कॉल पूरा करती है।

### PolicyConfig-Input

- `timezone` (string, optional, default: UTC) — IANA टाइमज़ोन जिसमें कॉलिंग अवधि पढ़ी जाती है।
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — वे साप्ताहिक समय-सीमाएं जिनमें कॉल की जा सकती हैं।
- `data_collection` (DataCollectionConfig, optional) — एजेंट के डेटा कलेक्शन आइटम, जो फ़ॉलो-अप कॉल को निर्देशित करते हैं। हर आइटम अपने उद्देश्य के लिए अंतर्निहित आइटम पर डिफ़ॉल्ट होता है; `null` इसे बंद कर देता है।
- `followup_context` (FollowupContextPolicy, optional) — फ़ॉलो-अप कॉल्स को कौन से `campaign__` डायनामिक वेरिएबल्स मिलते हैं।

### CampaignResponse

- `campaign_id` (string, required)
- `call_name` (string, required) — अभियान का नाम।
- `agent_id` (string, required)
- `channel_config` (CampaignResponseChannelConfig, required)
- `status` (enum, required) — `attention` का मतलब है कि एक खुला ध्यान आइटम अभियान की कुछ कॉल को रोकता है, जबकि बाकी आगे बढ़ती हैं। `stopping` का मतलब है कि कतार में मौजूद कॉल रद्द हो जाती हैं और पहले से की गई कॉल पूरी हो रही होती हैं।
  - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention`
- `policy` (CampaignPolicySnapshot, required) — कैंपेन बनाते समय अपनाई गई नीति।
- `variant` (enum, required)
  - Allowed values: `simple`, `advanced`
- `source` (enum, required, nullable) — क्या कैंपेन ऐप में या API के ज़रिए बनाया गया था।
  - Allowed values: `ui`, `api`
- `outcome` (CampaignResponseOutcome, required, nullable) — वह परिणाम जिसे कैंपेन की कॉल के लिए सफलता माना जाता है।
- `created_at_unix` (integer, required)
- `scheduled_time_unix` (integer, required, nullable) — कैंपेन कब कॉल करना शुरू करता है; बनते ही शुरू करने के लिए इसे सेट न करें।
- `updated_at_unix` (integer, required)
- `branch_id` (string, required, nullable) — वह एजेंट ब्रांच जिसके साथ अभियान कॉल करता है।
- `environment` (string, required, nullable) — वह एनवायरनमेंट जिसमें एजेंट के एनवायरनमेंट वैरिएबल रिज़ॉल्व होते हैं।
- `target_concurrency_limit` (integer, required, nullable) — अभियान द्वारा एक साथ की जाने वाली अधिकतम कॉल।
- `channel` (enum, required)
  - Allowed values: `phone`, `whatsapp`
- `mode` (enum, required)
  - Allowed values: `voice`, `message`
- `counts` (CampaignSummaryCounts, required)
- `agent_name` (string, required, default: )

### ValidationError

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

### 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 आवश्यक है।
- `start_procedure_ids` (list of string, optional, nullable) — सेट होने पर, बातचीत शुरू होते ही ये फ्री-फ़ॉर्म प्रक्रियाएं शुरू हो जाती हैं। अधिकतम पांच IDs स्वीकार की जाती हैं। procedure_ids लागू होने के बाद हर ID उपलब्ध होनी चाहिए। अज्ञात IDs और स्ट्रक्चर्ड प्रक्रियाओं से बातचीत शुरू नहीं हो पाती। इसके लिए enable_procedure_ids_from_client आवश्यक है।
- `dynamic_variables` (map from string to any, optional)

### PhoneVoiceConfig-Input

- `ringing_timeout_secs` (integer, optional, default: 60) — कॉल बंद करने से पहले रिसीपिएंट को कितने सेकंड तक रिंग करना है। ध्यान दें कि यह प्रोवाइडर की अपनी सीमाओं से भी सीमित होगा।
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Twilio कॉल रिकॉर्डिंग का इस्तेमाल करके कॉल रिकॉर्ड करनी है या नहीं। गैर-Twilio प्रदाताओं के लिए इसे अनदेखा किया जाता है। रिकॉर्डिंग आपके Twilio अकाउंट में स्टोर होती हैं।
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Twilio के कैरियर-स्तरीय आंसरिंग मशीन डिटेक्शन (AMD) के लिए कॉन्फ़िगरेशन। इसे बंद करने के लिए छोड़ दें या null सेट करें। गैर-Twilio प्रोवाइडर और इनबाउंड कॉल के लिए इसे अनदेखा किया जाता है। मिलने वाला निर्णय अलग `answering_machine_detection` वेबहुक इवेंट के रूप में दिया जाता है, जिसके लिए उस इवेंट को workspace या एजेंट वेबहुक सेटिंग्स में इनेबल करना ज़रूरी है; यह बातचीत या पोस्ट-कॉल वेबहुक का हिस्सा नहीं है। डिटेक्शन एसिंक्रोनस रूप से चलता है, इसलिए यह बातचीत शुरू होने में कभी देरी नहीं करता, और निर्णय कॉल के दौरान किसी भी समय आ सकता है -- `detect_message_end` के साथ, कॉल खत्म होने के बाद भी। Twilio AMD के लिए अलग से शुल्क लेता है।
- `mode` ("voice", optional, default: voice)

### SubmitWhatsAppChannelConfigModeConfig

- `mode`: `message` (SubmitWhatsAppMessageConfig)
  - `template` (SubmitWhatsAppTemplateRef, required) — भेजे जाने वाले अनुमोदित Meta टेम्पलेट का नाम देता है। सर्वर स्वयं टेम्पलेट लोड करता है, इसलिए क्लाइंट कभी उसके कंपोनेंट नहीं देता।
- `mode`: `voice` (WhatsAppVoiceConfig)
  - `whatsapp_call_permission_request_template_language_code` (string, required) — उस टेम्पलेट का भाषा कोड।
  - `whatsapp_call_permission_request_template_name` (string, required) — वह अनुमोदित टेम्पलेट जो संपर्क से कॉल करने की अनुमति मांगता है।

### CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems

- string
- integer
- double
- boolean

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — छोटे रीट्राई से पहले कितना इंतज़ार करना है।
- `max_short_retries` (integer, optional, default: 1) — विफल कॉल के बाद किसी कॉलिंग विंडो द्वारा अनुमत रीट्राई। इनके समाप्त होने पर अगला रीट्राई अगली विंडो की प्रतीक्षा करता है, जो नई गिनती के साथ शुरू होती है।
- `max_total_calls` (integer, optional, default: 6) — पहली कॉल सहित, लीड को मिलने वाली अधिकतम कॉल।
- `max_callbacks` (integer, optional, default: 2) — एक नंबर के लिए स्वीकार किए जाने वाले कॉलबैक की अधिकतम संख्या।
- `max_redirects` (integer, optional, default: 2) — लीड द्वारा किसी दूसरे नंबर पर कॉल करने के अनुरोध का अनुसरण करने की अधिकतम संख्या।
- `interval_placement` (enum, optional, default: start) — बाद की कॉलिंग विंडो में टाली गई कॉल कहां होगी: उसके `start` पर, किसी `random` समय पर, या उस विंडो में पिछली कॉल जहां विफल हुई थी उसके `rotate_step_seconds` बाद `rotate` करके।
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — `rotate` प्लेसमेंट हर कॉल को कितनी दूरी तक ले जाता है। केवल `rotate` द्वारा उपयोग किया जाता है।
- `max_consecutive_failures_per_number` (integer, optional, nullable) — किसी एक नंबर पर लगातार विफल हो सकने वाली कॉल की संख्या, जिसके बाद लीड अपने अगले सूचीबद्ध नंबर पर जाती है; यदि कोई अगला नंबर नहीं है, तो प्रक्रिया समाप्त हो जाती है। जवाब दी गई कॉल या नए नंबर पर रीडायरेक्ट होने पर गिनती फिर से शुरू होती है। सेट न होने पर केवल `max_total_calls` लागू रहता है।

### CallingPeriod

- `weekdays` (list of integer, required) — वे दिन जिन पर अंतराल लागू होते हैं, `0` (सोमवार) से `6` (रविवार) तक।
- `intervals` (list of CallingIntervalPolicy, required) — उनमें से हर दिन की समय-सीमाएं। वे किसी भी दिन ओवरलैप नहीं हो सकतीं।

### DataCollectionConfig

एजेंट के डेटा कलेक्शन आइटम, जो फ़ॉलो-अप कॉल को निर्देशित करते हैं। हर आइटम अपने उद्देश्य के लिए अंतर्निहित आइटम पर डिफ़ॉल्ट होता है; `null` इसे बंद कर देता है।

- `callback_time` (string, optional, nullable, default: __system_data_collection_callback_time) — वह आइटम जिसमें संपर्क द्वारा कॉलबैक के लिए मांगा गया समय है।
- `redirect_phone_number` (string, optional, nullable, default: __system_data_collection_redirect_phone_number) — वह आइटम जिसमें संपर्क द्वारा कॉल करने के लिए मांगा गया दूसरा नंबर है।
- `stop` (string, optional, nullable, default: __system_data_collection_do_not_call) — वह आइटम जो संपर्क के दोबारा कॉल न करने के अनुरोध पर true होता है।
- `mappings` (map from string to string, optional) — बाद की कॉल के लिए डेटा कलेक्शन नतीजों को डायनामिक वैरिएबल में कॉपी करता है: हर कुंजी एक डेटा कलेक्शन आइटम ID है और उसका मान वैरिएबल का नाम है।

### FollowupContextPolicy

फ़ॉलो-अप कॉल्स को कौन से `campaign__` डायनामिक वेरिएबल्स मिलते हैं।

- `call_type` (boolean, optional, default: true) — कॉल टाइप को `campaign__call_type` के रूप में पास करें।
- `previous_conversation_id` (boolean, optional, default: true) — पिछली बातचीत की ID को `campaign__previous_conversation_id` के रूप में पास करें।
- `previous_summary` (boolean, optional, default: true) — पिछली बातचीत का सारांश `campaign__previous_summary` के रूप में पास करें।
- `previous_transcript` (boolean, optional, default: true) — पिछली बातचीत का ट्रांसक्रिप्ट `campaign__previous_transcript` के रूप में पास करें।

### CampaignResponseChannelConfig

- `channel`: `phone` (PhoneChannelConfig)
  - `agent_phone_number_id` (string, required) — जिस फ़ोन नंबर से कॉल करनी है।
  - `mode_config` (PhoneVoiceConfig-Output, optional)
- `channel`: `whatsapp` (WhatsAppChannelConfig)
  - `mode_config` (WhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — वह WhatsApp फ़ोन नंबर जिससे कॉल या मैसेज किया जाएगा।

### CampaignPolicySnapshot

कैंपेन बनाते समय अपनाई गई नीति, जिसे सबमिट की गई `policy` की तरह दर्शाया गया है।

- `timezone` (string, required)
- `retry` (RetryPolicy, required)
- `calling_periods` (list of CallingPeriodPolicy, required)
- `data_collection` (DataCollectionPolicy, required)
- `followup_context` (FollowupContextPolicy, required) — फ़ॉलो-अप कॉल्स को कौन से `campaign__` डायनामिक वेरिएबल्स मिलते हैं।

### CampaignResponseOutcome

वह परिणाम जिसे कैंपेन की कॉल के लिए सफलता माना जाता है।

- `type`: `data_collection` (DataCollectionOutcome)
  - `data_collection_id` (string, required) — एजेंट का वह डेटा कलेक्शन आइटम जिसे सफल कॉल सेट करती है।
  - `equals` (list of CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems, required) — वे मान जो सफलता माने जाते हैं और सभी आइटम के प्रकार के हैं।
- `type`: `evaluation_criteria` (EvaluationCriterionOutcome)
  - `criteria_id` (string, required) — एजेंट का वह मूल्यांकन मानदंड जिसे सफल कॉल पूरा करती है।

### CampaignSummaryCounts

- `leads` (integer, required)
- `terminal_leads` (integer, required) — वे लीड जिन्हें दोबारा कॉल नहीं की जाएगी।
- `open_attention` (integer, required) — ध्यान आइटम जिनका अभी समाधान नहीं हुआ है।
- `delivery` (RecipientDeliveryCounts, optional, nullable) — कितने मैसेज हर चरण तक पहुंचे; एक मैसेज अभियान प्राप्त करते समय सेट होता है।

### ValidationErrorLocItems

- string
- integer

### 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 वर्ज़न नंबर

### TwilioMachineDetectionConfig

कॉल पर Twilio का कैरियर-लेवल आंसरिंग मशीन डिटेक्शन (AMD) कैसे चलाना है।

- `mode` (enum, optional, default: enable) — डिटेक्शन कितना विस्तृत होना चाहिए। जैसे ही Twilio किसी इंसान और मशीन में अंतर पहचान पाता है, `enable` एक निर्णय लौटाता है। `detect_message_end` वॉइसमेल ग्रीटिंग खत्म होने तक भी इंतज़ार करता है, जिससे `machine_end_*` निर्णय मिलते हैं, लेकिन नतीजा बाद में लौटता है।
  - Allowed values: `enable`, `detect_message_end`
- `actions` (list of TwilioMachineDetectionRule, optional) — हर AMD निर्णय के लिए कॉल पर की जाने वाली कार्रवाइयाँ। हर कार्रवाई अधिकतम एक नियम में हो सकती है, इसलिए उससे जुड़े सभी निर्णय एक साथ सूचीबद्ध करें। जिन निर्णयों का कोई नियम नहीं है, उनमें कॉल चलती रहती है।

### SubmitWhatsAppTemplateRef

भेजे जाने वाले अनुमोदित Meta टेम्पलेट का नाम देता है। सर्वर स्वयं टेम्पलेट लोड करता है, इसलिए क्लाइंट कभी उसके कंपोनेंट नहीं देता।

- `name` (string, required)
- `language` (string, required) — टेम्पलेट का भाषा कोड, जैसे `en_US`।

### CallingIntervalPolicy

- `start` (string, required) — स्थानीय प्रारंभ समय, `HH:MM` के रूप में।
- `end` (string, required) — स्थानीय समाप्ति समय, `HH:MM` के रूप में; `24:00` आधी रात को समाप्त होता है।

### PhoneVoiceConfig-Output

- `ringing_timeout_secs` (integer, optional, default: 60) — कॉल बंद करने से पहले रिसीपिएंट को कितने सेकंड तक रिंग करना है। ध्यान दें कि यह प्रोवाइडर की अपनी सीमाओं से भी सीमित होगा।
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Twilio कॉल रिकॉर्डिंग का इस्तेमाल करके कॉल रिकॉर्ड करनी है या नहीं। गैर-Twilio प्रदाताओं के लिए इसे अनदेखा किया जाता है। रिकॉर्डिंग आपके Twilio अकाउंट में स्टोर होती हैं।
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Twilio के कैरियर-स्तरीय आंसरिंग मशीन डिटेक्शन (AMD) के लिए कॉन्फ़िगरेशन। इसे बंद करने के लिए छोड़ दें या null सेट करें। गैर-Twilio प्रोवाइडर और इनबाउंड कॉल के लिए इसे अनदेखा किया जाता है। मिलने वाला निर्णय अलग `answering_machine_detection` वेबहुक इवेंट के रूप में दिया जाता है, जिसके लिए उस इवेंट को workspace या एजेंट वेबहुक सेटिंग्स में इनेबल करना ज़रूरी है; यह बातचीत या पोस्ट-कॉल वेबहुक का हिस्सा नहीं है। डिटेक्शन एसिंक्रोनस रूप से चलता है, इसलिए यह बातचीत शुरू होने में कभी देरी नहीं करता, और निर्णय कॉल के दौरान किसी भी समय आ सकता है -- `detect_message_end` के साथ, कॉल खत्म होने के बाद भी। Twilio AMD के लिए अलग से शुल्क लेता है।
- `mode` ("voice", optional, default: voice)

### WhatsAppChannelConfigModeConfig

- `mode`: `message` (WhatsAppMessageConfig)
  - `template` (WhatsAppTemplate, required) — Meta टेम्पलेट, जैसा सबमिशन के समय अनुमोदित किया गया था।
- `mode`: `voice` (WhatsAppVoiceConfig)
  - `whatsapp_call_permission_request_template_language_code` (string, required) — उस टेम्पलेट का भाषा कोड।
  - `whatsapp_call_permission_request_template_name` (string, required) — वह अनुमोदित टेम्पलेट जो संपर्क से कॉल करने की अनुमति मांगता है।

### CallingPeriodPolicy

- `weekdays` (list of integer, required)
- `intervals` (list of CallingIntervalPolicy, required) — उनमें से हर दिन की समय-सीमाएं। वे किसी भी दिन ओवरलैप नहीं हो सकतीं।

### DataCollectionPolicy

- `callback_time` (string, optional, nullable)
- `redirect_phone_number` (string, optional, nullable)
- `stop` (string, optional, nullable)
- `mappings` (map from string to string, optional) — बाद की कॉल के लिए डेटा कलेक्शन नतीजों को डायनामिक वैरिएबल में कॉपी करता है: हर कुंजी एक डेटा कलेक्शन आइटम ID है और उसका मान वैरिएबल का नाम है।

### RecipientDeliveryCounts

- `sent` (integer, optional, default: 0)
- `delivered` (integer, optional, default: 0)
- `read` (integer, optional, default: 0)
- `replied` (integer, optional, default: 0)
- `failed` (integer, optional, default: 0)

### ASRConversationalConfigOverride

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

### TurnConfigOverride

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

### 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) — एजेंट के लिए प्रॉम्प्ट

### TwilioMachineDetectionRule

दिए गए AMD निर्णयों के लिए लाइव कॉल पर की जाने वाली कार्रवाई।

- `action` (enum, required)
  - Allowed values: `hang_up`
- `answered_by` (list of enum, required) — वे निर्णय जो कार्रवाई ट्रिगर करते हैं।
  - Allowed values: `human`, `fax`, `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`

### WhatsAppTemplate

- `name` (string, required)
- `language` (string, required) — https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages
- `components` (list of WhatsAppTemplateComponent, required)
- `parameter_format` (enum, optional, default: POSITIONAL)
  - Allowed values: `POSITIONAL`, `NAMED`
- `category` (string, optional, nullable) — https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/

### 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-6.1-terra`, `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) — एजेंट द्वारा उपयोग किए जाने वाले नॉलेज बेस की सूची

### WhatsAppTemplateComponent

- `type` (string, required)
- `format` (string, optional, nullable)
- `text` (string, optional, nullable)
- `buttons` (list of WhatsAppTemplateComponentButton, 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`

### WhatsAppTemplateComponentButton

- `type` (string, required)
- `text` (string, optional, nullable)
- `url` (string, optional, nullable)

## Examples

**Request**

```json
{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ],
  "channel_config": {
    "agent_phone_number_id": "string"
  }
}
```

**Response**

```json
{
  "campaign": {
    "campaign_id": "string",
    "call_name": "string",
    "agent_id": "string",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "string",
      "mode_config": {
        "ringing_timeout_secs": 60,
        "twilio_call_recording_enabled": false,
        "twilio_machine_detection": {
          "mode": "enable",
          "actions": [
            {
              "action": "hang_up",
              "answered_by": [
                "human"
              ]
            }
          ]
        },
        "mode": "voice"
      }
    },
    "status": "active",
    "policy": {
      "timezone": "string",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    },
    "variant": "simple",
    "source": "ui",
    "outcome": {
      "type": "evaluation_criteria",
      "criteria_id": "string"
    },
    "created_at_unix": 1,
    "scheduled_time_unix": 1,
    "updated_at_unix": 1,
    "branch_id": "string",
    "environment": "string",
    "target_concurrency_limit": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 1,
      "delivery": {
        "sent": 0,
        "delivered": 0,
        "read": 0,
        "replied": 0,
        "failed": 0
      }
    },
    "agent_name": ""
  },
  "created": true,
  "within_calling_window": true
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit"

payload = {
    "call_name": "string",
    "agent_id": "string",
    "recipients": [{}],
    "channel_config": { "agent_phone_number_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/outbound-campaigns/campaigns/submit';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"call_name":"string","agent_id":"string","recipients":[{}],"channel_config":{"agent_phone_number_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/outbound-campaigns/campaigns/submit"

	payload := strings.NewReader("{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"agent_phone_number_id\": \"string\"\n  }\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/outbound-campaigns/campaigns/submit")

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  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"agent_phone_number_id\": \"string\"\n  }\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/outbound-campaigns/campaigns/submit")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"agent_phone_number_id\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit', [
  'body' => '{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ],
  "channel_config": {
    "agent_phone_number_id": "string"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"call_name\": \"string\",\n  \"agent_id\": \"string\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"agent_phone_number_id\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "call_name": "string",
  "agent_id": "string",
  "recipients": [[]],
  "channel_config": ["agent_phone_number_id": "string"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit")! 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()
```