> 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. # Crea una campagna outbound POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit Content-Type: application/json Crea una campagna in uscita che chiama o invia messaggi a ogni destinatario con l'agente, nelle finestre di chiamata della policy, riprovando e ricontattando quando consentito. Restituisce `201` per una nuova campagna. Una richiesta ripetuta, identificata tramite `idempotency_key` o altrimenti tramite il suo body, restituisce la campagna esistente con `created` impostato su 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) — Il nome della campagna. - `agent_id` (string, required) — L'agente che effettua le chiamate. - `recipients` (list of SubmitCampaignRecipient, required) — Chi chiamare. Ogni destinatario diventa un lead della campagna. - `channel_config` (SubmitCampaignRequestChannelConfig, required) - `scheduled_time_unix` (integer, optional, nullable) — Quando iniziare a chiamare; ometti per iniziare subito. Le chiamate attendono comunque la successiva finestra di chiamata. - `timezone` (string, optional, nullable) — Fuso orario IANA in cui interpretare le finestre di chiamata, in sostituzione di quello della policy. - `branch_id` (string, optional, nullable) — Il ramo dell'agente da usare per chiamare. - `environment` (string, optional, nullable) — L'ambiente in cui risolvere le variabili d'ambiente dell'agente. - `target_concurrency_limit` (integer, optional, nullable) — Il numero massimo di chiamate da effettuare contemporaneamente. - `idempotency_key` (string, optional, nullable) — Rende la richiesta sicura da ritentare: una ripetizione con la stessa chiave restituisce la campagna creata. - `outcome` (SubmitCampaignRequestOutcome, optional, nullable) — Il risultato considerato un successo per le chiamate della campagna. - `policy` (PolicyConfig-Input, optional, nullable) — Policy di cui acquisire uno snapshot nella campagna. Se impostata, ha la precedenza sull'impostazione predefinita del workspace e su qualsiasi override per agente; se omessa, deve esistere la configurazione del workspace, che fornisce la policy. - `variant` (enum, optional, nullable) — `simple` esegue un tentativo per destinatario con finestre di chiamata sempre attive e senza raccogliere dati, e non può essere combinato con `policy`. `advanced` usa `policy` o la configurazione del workspace ed è l'impostazione predefinita per le campagne telefoniche. - Allowed values: `simple`, `advanced` ## Response ### 200 Risposta riuscita - `campaign` (CampaignResponse, required) - `created` (boolean, required) — False quando la richiesta ripete una richiesta precedente e restituisce la relativa campagna. - `within_calling_window` (boolean, required) — Se le chiamate iniziano subito anziché alla successiva finestra di chiamata. ## Errors ### 422 Unprocessable Entity Error Errore di convalida - `detail` (list of ValidationError, optional) ## Types ### SubmitCampaignRecipient - `phone_number` (string, optional, nullable) — Il numero da chiamare, in formato E.164, ad esempio `+14155550100`. - `phone_numbers` (list of string, optional, nullable) — Altri numeri da chiamare, in ordine dopo `phone_number`. Il lead passa a quello successivo quando le chiamate al numero attuale continuano a non riuscire. - `whatsapp_user_id` (string, optional, nullable) — L'ID utente WhatsApp del contatto. Le campagne WhatsApp lo usano al posto dei numeri di telefono. - `id` (string, optional, nullable) — Il tuo identificatore per il destinatario, restituito come `recipient_id` del relativo lead. - `conversation_initiation_client_data` (ConversationInitiationClientDataRequest-Input, optional, nullable) — Variabili dinamiche e override per le chiamate di questo destinatario. ### SubmitCampaignRequestChannelConfig - `channel`: `phone` (PhoneChannelConfig) - `agent_phone_number_id` (string, required) — Il numero di telefono da cui chiamare. - `mode_config` (PhoneVoiceConfig-Input, optional) - `channel`: `whatsapp` (SubmitWhatsAppChannelConfig) - `mode_config` (SubmitWhatsAppChannelConfigModeConfig, required) - `whatsapp_phone_number_id` (string, required) — Il numero di telefono WhatsApp da cui effettuare chiamate o inviare messaggi. ### SubmitCampaignRequestOutcome Il risultato considerato un successo per le chiamate della campagna. - `type`: `data_collection` (DataCollectionOutcome) - `data_collection_id` (string, required) — L'elemento di raccolta dati dell'agente impostato da una chiamata riuscita. - `equals` (list of CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems, required) — Valori considerati un successo, tutti del tipo dell'elemento. - `type`: `evaluation_criteria` (EvaluationCriterionOutcome) - `criteria_id` (string, required) — Il criterio di valutazione dell'agente soddisfatto da una chiamata riuscita. ### PolicyConfig-Input - `timezone` (string, optional, default: UTC) — Fuso orario IANA in cui vengono interpretati i periodi di chiamata. - `retry` (RetryPolicy, optional) - `calling_periods` (list of CallingPeriod, optional) — Le finestre settimanali in cui è possibile effettuare chiamate. - `data_collection` (DataCollectionConfig, optional) — Gli elementi di raccolta dati dell'agente che guidano le chiamate di follow-up. Ognuno usa per impostazione predefinita l'elemento integrato per il proprio scopo; `null` lo disattiva. - `followup_context` (FollowupContextPolicy, optional) — Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up. ### CampaignResponse - `campaign_id` (string, required) - `call_name` (string, required) — Il nome della campagna. - `agent_id` (string, required) - `channel_config` (CampaignResponseChannelConfig, required) - `status` (enum, required) — `attention` indica che un elemento di attenzione aperto trattiene alcune chiamate della campagna, mentre le altre procedono. `stopping` indica che le chiamate in coda vengono annullate e quelle già avviate si stanno concludendo. - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention` - `policy` (CampaignPolicySnapshot, required) — La policy adottata dalla campagna al momento della creazione. - `variant` (enum, required) - Allowed values: `simple`, `advanced` - `source` (enum, required, nullable) — Se la campagna è stata creata nell'app o tramite l'API. - Allowed values: `ui`, `api` - `outcome` (CampaignResponseOutcome, required, nullable) — Il risultato considerato un successo per le chiamate della campagna. - `created_at_unix` (integer, required) - `scheduled_time_unix` (integer, required, nullable) — Quando la campagna inizia a chiamare; non impostato per iniziare al momento della creazione. - `updated_at_unix` (integer, required) - `branch_id` (string, required, nullable) — Il ramo dell'agente usato dalla campagna per le chiamate. - `environment` (string, required, nullable) — L'ambiente in cui vengono risolte le variabili d'ambiente dell'agente. - `target_concurrency_limit` (integer, required, nullable) — Il numero massimo di chiamate che la campagna effettua contemporaneamente. - `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 dell'utente finale che partecipa a questa conversazione, per l'identificazione dell'utente proprietario dell'agente - `source_info` (ConversationInitiationSourceInfo, optional) — Informazioni sull'origine dell'avvio della conversazione - `branch_id` (string, optional, nullable) — ID del branch dell'agente da usare per questa conversazione - `environment` (string, optional, nullable) — Ambiente da usare per risolvere le variabili di ambiente - `starting_workflow_node_id` (string, optional, nullable) — Se impostato, avvia il workflow dall'ID di questo nodo anziché dal punto di ingresso predefinito. - `procedure_ids` (list of string, optional, nullable) — Se impostato, solo queste procedure sono disponibili per l'agente iniziale. Ogni ID deve essere associato a quell'agente; gli ID sconosciuti impediscono l'avvio della conversazione. Un elenco vuoto disabilita tutte le procedure dell'agente. Non viene applicato dopo un trasferimento dell'agente. Richiede enable_procedure_ids_from_client. - `start_procedure_ids` (list of string, optional, nullable) — Se impostate, queste procedure in formato libero vengono avviate all'inizio della conversazione. Accetta al massimo cinque ID. Ogni ID deve essere disponibile dopo l'applicazione di procedure_ids. ID sconosciuti e procedure strutturate impediscono l'avvio della conversazione. Richiede enable_procedure_ids_from_client. - `dynamic_variables` (map from string to any, optional) ### PhoneVoiceConfig-Input - `ringing_timeout_secs` (integer, optional, default: 60) — Per quanti secondi far squillare il destinatario prima di interrompere. Tieni presente che sarà limitato anche dai vincoli del provider. - `twilio_call_recording_enabled` (boolean, optional, default: false) — Indica se registrare la chiamata tramite la registrazione chiamate di Twilio. Ignorato per i provider diversi da Twilio. Le registrazioni vengono archiviate nel tuo account Twilio. - `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configurazione per il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio. Ometti o imposta su null per disabilitarlo. Viene ignorata per i provider diversi da Twilio e per le chiamate in entrata. Il verdetto risultante viene inviato come evento webhook `answering_machine_detection` separato, che richiede l'abilitazione di tale evento nelle impostazioni webhook del workspace o dell'agente; non fa parte della conversazione né del webhook post-chiamata. Il rilevamento viene eseguito in modo asincrono, quindi non ritarda mai l'inizio della conversazione, e il verdetto può arrivare in qualsiasi momento durante la chiamata -- con `detect_message_end`, anche dopo la sua conclusione. Twilio fattura AMD separatamente. - `mode` ("voice", optional, default: voice) ### SubmitWhatsAppChannelConfigModeConfig - `mode`: `message` (SubmitWhatsAppMessageConfig) - `template` (SubmitWhatsAppTemplateRef, required) — Indica il template Meta approvato da inviare. Il server carica il template direttamente, quindi il client non ne fornisce mai i componenti. - `mode`: `voice` (WhatsAppVoiceConfig) - `whatsapp_call_permission_request_template_language_code` (string, required) — Il codice lingua di quel template. - `whatsapp_call_permission_request_template_name` (string, required) — Il template approvato che chiede al contatto l'autorizzazione a chiamare. ### CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems - string - integer - double - boolean ### RetryPolicy - `retry_delay_seconds` (integer, optional, default: 600) — Tempo di attesa prima di un breve tentativo successivo. - `max_short_retries` (integer, optional, default: 1) — Tentativi successivi consentiti da una finestra di chiamata dopo una chiamata non riuscita. Una volta esauriti, il tentativo successivo attende la finestra seguente, che riparte da zero. - `max_total_calls` (integer, optional, default: 6) — Il numero massimo di chiamate ricevute da un lead, inclusa la prima. - `max_callbacks` (integer, optional, default: 2) — Il numero massimo di richiamate da rispettare per un singolo numero. - `max_redirects` (integer, optional, default: 2) — Il numero massimo di volte in cui un lead segue una richiesta di chiamare un altro numero. - `interval_placement` (enum, optional, default: start) — Where in a later calling window a pushed-back call lands: at its `start`, at a `random` time, or `rotate`d `rotate_step_seconds` past where the last call in that window failed. - Allowed values: `start`, `random`, `rotate` - `rotate_step_seconds` (integer, optional, default: 900) — Di quanto il posizionamento `rotate` sposta ogni chiamata. Usato solo da `rotate`. - `max_consecutive_failures_per_number` (integer, optional, nullable) — Numero di chiamate consecutive a un numero che possono non riuscire prima che il lead passi al numero successivo nell'elenco o termini, se non ce ne sono altri. Una chiamata risposta o un reindirizzamento a un nuovo numero riavvia il conteggio. Se non impostato, rimane solo `max_total_calls`. ### CallingPeriod - `weekdays` (list of integer, required) — Giorni in cui si applicano gli intervalli, da `0` (lunedì) a `6` (domenica). - `intervals` (list of CallingIntervalPolicy, required) — Finestre per ciascuno di quei giorni. Non possono sovrapporsi in nessun giorno. ### DataCollectionConfig Gli elementi di raccolta dati dell'agente che guidano le chiamate di follow-up. Ognuno usa per impostazione predefinita l'elemento integrato per il proprio scopo; `null` lo disattiva. - `callback_time` (string, optional, nullable, default: __system_data_collection_callback_time) — L'elemento contenente quando il contatto ha chiesto di essere richiamato. - `redirect_phone_number` (string, optional, nullable, default: __system_data_collection_redirect_phone_number) — L'elemento contenente un altro numero su cui il contatto ha chiesto di essere chiamato. - `stop` (string, optional, nullable, default: __system_data_collection_do_not_call) — L'elemento che è true quando il contatto ha chiesto di non essere chiamato di nuovo. - `mappings` (map from string to string, optional) — Copia i risultati della raccolta dati nelle variabili dinamiche per le chiamate successive: ogni chiave è un ID dell'elemento di raccolta dati e il relativo valore è il nome della variabile. ### FollowupContextPolicy Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up. - `call_type` (boolean, optional, default: true) — Passa il tipo di chiamata come `campaign__call_type`. - `previous_conversation_id` (boolean, optional, default: true) — Passa l'ID dell'ultima conversazione come `campaign__previous_conversation_id`. - `previous_summary` (boolean, optional, default: true) — Passa il riepilogo dell'ultima conversazione come `campaign__previous_summary`. - `previous_transcript` (boolean, optional, default: true) — Passa la trascrizione dell'ultima conversazione come `campaign__previous_transcript`. ### CampaignResponseChannelConfig - `channel`: `phone` (PhoneChannelConfig) - `agent_phone_number_id` (string, required) — Il numero di telefono da cui chiamare. - `mode_config` (PhoneVoiceConfig-Output, optional) - `channel`: `whatsapp` (WhatsAppChannelConfig) - `mode_config` (WhatsAppChannelConfigModeConfig, required) - `whatsapp_phone_number_id` (string, required) — Il numero di telefono WhatsApp da cui effettuare chiamate o inviare messaggi. ### CampaignPolicySnapshot La policy adottata dalla campagna al momento della creazione, strutturata come una `policy` inviata. - `timezone` (string, required) - `retry` (RetryPolicy, required) - `calling_periods` (list of CallingPeriodPolicy, required) - `data_collection` (DataCollectionPolicy, required) - `followup_context` (FollowupContextPolicy, required) — Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up. ### CampaignResponseOutcome Il risultato considerato un successo per le chiamate della campagna. - `type`: `data_collection` (DataCollectionOutcome) - `data_collection_id` (string, required) — L'elemento di raccolta dati dell'agente impostato da una chiamata riuscita. - `equals` (list of CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems, required) — Valori considerati un successo, tutti del tipo dell'elemento. - `type`: `evaluation_criteria` (EvaluationCriterionOutcome) - `criteria_id` (string, required) — Il criterio di valutazione dell'agente soddisfatto da una chiamata riuscita. ### CampaignSummaryCounts - `leads` (integer, required) - `terminal_leads` (integer, required) — Lead che non verranno più chiamati. - `open_attention` (integer, required) — Elementi di attenzione non ancora risolti. - `delivery` (RecipientDeliveryCounts, optional, nullable) — Numero di messaggi che hanno raggiunto ogni fase; impostato quando si ottiene una singola campagna di messaggi. ### ValidationErrorLocItems - string - integer ### ConversationConfigClientOverride-Input - `asr` (ASRConversationalConfigOverride, optional, nullable) — Configurazione per la trascrizione conversazionale - `turn` (TurnConfigOverride, optional, nullable) — Configurazione per il rilevamento dei turni - `tts` (TTSConversationalConfigOverride, optional, nullable) — Configurazione per la sintesi vocale conversazionale - `conversation` (ConversationConfigOverride, optional, nullable) — Configurazione per gli eventi conversazionali - `agent` (AgentConfigOverride-Input, optional, nullable) — Configurazione specifica dell'agente ### ConversationInitiationSourceInfo Informazioni sull'origine dell'avvio della conversazione - `source` (enum, optional, nullable, default: unknown) — Origine dell'avvio della conversazione - 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) — Il numero di versione dell'SDK ### TwilioMachineDetectionConfig Come eseguire il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio durante una chiamata. - `mode` (enum, optional, default: enable) — Quanto deve essere approfondito il rilevamento. `enable` restituisce un verdetto non appena Twilio riesce a distinguere una persona da una macchina. `detect_message_end` attende anche la fine del messaggio di segreteria telefonica, producendo i verdetti `machine_end_*`, ma restituisce il risultato più tardi. - Allowed values: `enable`, `detect_message_end` - `actions` (list of TwilioMachineDetectionRule, optional) — Azioni da eseguire sulla chiamata per ciascun verdetto AMD. Ogni azione può comparire al massimo in una regola, quindi elenca insieme tutti i relativi verdetti. I verdetti senza una regola lasciano la chiamata in corso. ### SubmitWhatsAppTemplateRef Indica il template Meta approvato da inviare. Il server carica il template direttamente, quindi il client non ne fornisce mai i componenti. - `name` (string, required) - `language` (string, required) — Il codice lingua del template, ad esempio `en_US`. ### CallingIntervalPolicy - `start` (string, required) — Ora di inizio locale, nel formato `HH:MM`. - `end` (string, required) — Ora di fine locale, nel formato `HH:MM`; `24:00` termina a mezzanotte. ### PhoneVoiceConfig-Output - `ringing_timeout_secs` (integer, optional, default: 60) — Per quanti secondi far squillare il destinatario prima di interrompere. Tieni presente che sarà limitato anche dai vincoli del provider. - `twilio_call_recording_enabled` (boolean, optional, default: false) — Indica se registrare la chiamata tramite la registrazione chiamate di Twilio. Ignorato per i provider diversi da Twilio. Le registrazioni vengono archiviate nel tuo account Twilio. - `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configurazione per il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio. Ometti o imposta su null per disabilitarlo. Viene ignorata per i provider diversi da Twilio e per le chiamate in entrata. Il verdetto risultante viene inviato come evento webhook `answering_machine_detection` separato, che richiede l'abilitazione di tale evento nelle impostazioni webhook del workspace o dell'agente; non fa parte della conversazione né del webhook post-chiamata. Il rilevamento viene eseguito in modo asincrono, quindi non ritarda mai l'inizio della conversazione, e il verdetto può arrivare in qualsiasi momento durante la chiamata -- con `detect_message_end`, anche dopo la sua conclusione. Twilio fattura AMD separatamente. - `mode` ("voice", optional, default: voice) ### WhatsAppChannelConfigModeConfig - `mode`: `message` (WhatsAppMessageConfig) - `template` (WhatsAppTemplate, required) — Il template Meta come approvato al momento dell'invio. - `mode`: `voice` (WhatsAppVoiceConfig) - `whatsapp_call_permission_request_template_language_code` (string, required) — Il codice lingua di quel template. - `whatsapp_call_permission_request_template_name` (string, required) — Il template approvato che chiede al contatto l'autorizzazione a chiamare. ### CallingPeriodPolicy - `weekdays` (list of integer, required) - `intervals` (list of CallingIntervalPolicy, required) — Finestre per ciascuno di quei giorni. Non possono sovrapporsi in nessun giorno. ### DataCollectionPolicy - `callback_time` (string, optional, nullable) - `redirect_phone_number` (string, optional, nullable) - `stop` (string, optional, nullable) - `mappings` (map from string to string, optional) — Copia i risultati della raccolta dati nelle variabili dinamiche per le chiamate successive: ogni chiave è un ID dell'elemento di raccolta dati e il relativo valore è il nome della variabile. ### 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) — Parole chiave per aumentare la probabilità di previsione per ### TurnConfigOverride - `soft_timeout_config` (SoftTimeoutConfigOverride, optional, nullable) — Configurazione della funzionalità di soft timeout. Fornisce feedback immediato durante risposte LLM più lunghe. - `noisy_environment_message` (string, optional, nullable) — Cosa dice l'agente quando rileva un ambiente rumoroso. ### TTSConversationalConfigOverride - `model_id` (enum, optional, nullable, default: eleven_v4_turbo) — Il modello da usare per il 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) — L'ID della voce da usare per TTS - `supported_voices` (list of SupportedVoice, optional, nullable) — Voci supportate aggiuntive per l'agente - `stability` (double, optional, nullable) — La stabilità del parlato generato - `speed` (double, optional, nullable) — La velocità del parlato generato - `similarity_boost` (double, optional, nullable) — L'aumento di somiglianza per il parlato generato - `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional, nullable) — I locator del dizionario di pronuncia ### ConversationConfigOverride - `text_only` (boolean, optional, nullable) — Se abilitato, l'audio non verrà elaborato e verrà usato solo il testo, per evitare i costi dell'audio. - `max_duration_seconds` (integer, optional, nullable) — La durata massima di una conversazione in secondi ### AgentConfigOverride-Input - `first_message` (string, optional, nullable) — Se non è vuoto, è il primo messaggio che l'agente pronuncerà. Se è vuoto, l'agente attende che l'utente avvii la conversazione. - `language` (string, optional, nullable) — Lingua dell'agente, usata per ASR e TTS - `max_conversation_duration_message` (string, optional, nullable) — Se non è vuoto, è il messaggio che l'agente invierà al raggiungimento della durata massima della conversazione. - `prompt` (PromptAgentAPIModelOverride-Input, optional, nullable) — Il prompt per l'agente ### TwilioMachineDetectionRule Azione da eseguire su una chiamata in corso per i verdetti AMD specificati. - `action` (enum, required) - Allowed values: `hang_up` - `answered_by` (list of enum, required) — Verdetti che attivano l'azione. - 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) — Messaggio da mostrare quando viene raggiunto il primo timeout flessibile durante l'attesa della risposta LLM. Supporta le variabili dinamiche (ad esempio \{\{system\_\_time}}, \{\{custom\_variable}}). - `additional_soft_timeout_messages` (list of string, optional, nullable) — Messaggi di riempimento statici aggiuntivi per i soft timeout successivi nella stessa generazione LLM. Il primo timeout usa `message`. Se sono configurati meno messaggi di `max_soft_timeouts_per_generation`, viene ripetuto l'ultimo messaggio configurato; altrimenti viene usato un messaggio di riempimento integrato. ### 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 Un locator che consente ad altri documenti di fare riferimento a un dizionario specifico e alla sua versione. Questa è una versione Pydantic di PronunciationDictionaryVersionLocatorDBModel. Necessaria per garantire la compatibilità con gli altri modelli di dati dell'agente. - `pronunciation_dictionary_id` (string, required) — L'ID del dizionario di pronuncia - `version_id` (string, required, nullable) — L'ID della versione del dizionario di pronuncia ### PromptAgentAPIModelOverride-Input - `prompt` (string, optional, nullable) — Il prompt per l'agente - `llm` (enum, optional, nullable) — L'LLM da interrogare con il prompt e la cronologia della chat. Se utilizzi la residenza dei dati, l'LLM deve essere supportato nell'ambiente di residenza dei dati. - 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) — Un elenco di ID degli strumenti usati dall'agente. - `tool_ids_strict` (boolean, optional, nullable) — Si applica solo come override della conversazione ed è consentito ogni volta che tool_ids può essere sovrascritto. Se true, il valore tool_ids sovrascritto è l'elenco completo degli strumenti consentiti nella conversazione, inclusi quelli nei nodi del workflow. Viene ignorato se impostato sull'agente. - `native_mcp_server_ids` (list of string, optional, nullable) — Un elenco di ID dei server MCP nativi da usare con l'agente - `knowledge_base` (list of KnowledgeBaseLocator, optional, nullable) — Un elenco di knowledge base da usare con l'agente ### WhatsAppTemplateComponent - `type` (string, required) - `format` (string, optional, nullable) - `text` (string, optional, nullable) - `buttons` (list of WhatsAppTemplateComponentButton, optional, nullable) ### KnowledgeBaseLocator - `type` (enum, required) — Il tipo di knowledge base - Allowed values: `file`, `url`, `text`, `folder` - `name` (string, required) — Il nome della knowledge base - `id` (string, required) — L'ID della knowledge base - `usage_mode` (enum, optional, default: auto) — La modalità di utilizzo della knowledge base - 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 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 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() ```