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

# Criar uma campanha de chamadas ativas

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

Crie uma campanha ativa que liga ou envia mensagens para cada destinatário com o agente, dentro das janelas de chamada da política, fazendo novas tentativas e acompanhamentos conforme permitido. Retorna `201` para uma nova campanha. Uma solicitação repetida, identificada por `idempotency_key` ou pelo corpo, retorna a campanha existente com `created` como false.

Reference: https://elevenlabs.io/docs/eleven-agents/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 an object.

- `call_name` (string, required) — O nome da campanha.
- `agent_id` (string, required) — O agente que realiza as chamadas.
- `recipients` (list of SubmitCampaignRecipient, required) — Para quem fazer chamadas. Cada destinatário se torna um lead da campanha.
- `channel_config` (SubmitCampaignRequestChannelConfig, required)
- `scheduled_time_unix` (integer, optional) — Quando começar a fazer chamadas; omita para começar agora. As chamadas ainda aguardam a próxima janela de chamadas.
- `timezone` (string, optional) — Fuso horário IANA no qual interpretar as janelas de chamada, substituindo o da política.
- `branch_id` (string, optional) — A ramificação do agente a ser usada para chamar.
- `environment` (string, optional) — O ambiente no qual resolver as variáveis de ambiente do agente.
- `target_concurrency_limit` (integer, optional) — O número máximo de chamadas a realizar ao mesmo tempo.
- `idempotency_key` (string, optional) — Torna a solicitação segura para novas tentativas: uma repetição com a mesma chave retorna a campanha que ela criou.
- `outcome` (SubmitCampaignRequestOutcome, optional) — O resultado considerado bem-sucedido para as chamadas da campanha.
- `policy` (PolicyConfigInput, optional) — Política a ser registrada na campanha. Quando definida, ela prevalece sobre o padrão do espaço de trabalho e qualquer substituição por agente; quando omitida, a configuração do espaço de trabalho deve existir e fornece a política.
- `variant` (enum, optional) — `simple` executa uma tentativa por destinatário, com janelas de chamada sempre ativas e sem coleta de dados, e não pode ser combinado com `policy`. `advanced` usa `policy` ou a configuração do espaço de trabalho e é o padrão para campanhas telefônicas.
  - Allowed values: `simple`, `advanced`

## Response

### 200

Resposta bem-sucedida

- `campaign` (CampaignResponse, required)
- `created` (boolean, required) — False quando a solicitação repete uma solicitação anterior e retorna sua campanha.
- `within_calling_window` (boolean, required) — Se as chamadas começam imediatamente, em vez de na próxima janela de chamadas.

## Errors

### 422 Outbound Campaigns Create Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### SubmitCampaignRecipient

- `phone_number` (string, optional) — O número para chamar, no formato E.164, como `+14155550100`.
- `phone_numbers` (list of string, optional) — Mais números para chamar, em ordem após `phone_number`. O lead passa para o próximo quando as chamadas para o número atual continuam falhando.
- `whatsapp_user_id` (string, optional) — O ID de usuário do WhatsApp do contato. As campanhas do WhatsApp o utilizam em vez dos números de telefone.
- `id` (string, optional) — Seu identificador para o destinatário, retornado como o `recipient_id` do lead.
- `conversation_initiation_client_data` (ConversationInitiationClientDataRequestInput, optional) — Variáveis dinâmicas e substituições para as chamadas deste destinatário.

### SubmitCampaignRequestChannelConfig

- `channel`: `phone`
  - `agent_phone_number_id` (string, required) — O número de telefone usado para realizar a chamada.
  - `mode_config` (PhoneVoiceConfigInput, optional)
- `channel`: `whatsapp`
  - `mode_config` (SubmitWhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — O número de telefone do WhatsApp usado para fazer chamadas ou enviar mensagens.

### SubmitCampaignRequestOutcome

- `type`: `data_collection`
  - `data_collection_id` (string, required) — O item de coleta de dados do agente que uma chamada bem-sucedida define.
  - `equals` (list of DataCollectionOutcomeEqualsItem, required) — Valores considerados bem-sucedidos, todos do tipo do item.
- `type`: `evaluation_criteria`
  - `criteria_id` (string, required) — O critério de avaliação do agente atendido por uma chamada bem-sucedida.

### PolicyConfigInput

- `timezone` (string, optional, default: UTC) — Fuso horário IANA no qual os períodos de chamada são interpretados.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — As janelas semanais em que as chamadas podem ser feitas.
- `data_collection` (DataCollectionConfig, optional) — Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.
- `followup_context` (FollowupContextPolicy, optional) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### CampaignResponse

- `campaign_id` (string, required)
- `call_name` (string, required) — O nome da campanha.
- `agent_id` (string, required)
- `channel_config` (CampaignResponseChannelConfig, required)
- `status` (enum, required) — `attention` significa que um item de atenção em aberto retém algumas chamadas da campanha enquanto as demais prosseguem. `stopping` significa que as chamadas na fila são canceladas e as chamadas já realizadas estão sendo concluídas.
  - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention`
- `policy` (CampaignPolicySnapshot, required) — A política usada pela campanha quando foi criada.
- `variant` (enum, required)
  - Allowed values: `simple`, `advanced`
- `created_at_unix` (integer, required)
- `updated_at_unix` (integer, required)
- `channel` (enum, required)
  - Allowed values: `phone`, `whatsapp`
- `mode` (enum, required)
  - Allowed values: `voice`, `message`
- `counts` (CampaignSummaryCounts, required)
- `agent_name` (string, required, default: )
- `source` (enum, optional) — Se a campanha foi criada no app ou pela API.
  - Allowed values: `ui`, `api`
- `outcome` (CampaignResponseOutcome, optional) — O resultado considerado bem-sucedido para as chamadas da campanha.
- `scheduled_time_unix` (integer, optional) — Quando a campanha começa a fazer chamadas; deixe sem definir para iniciar assim que for criada.
- `branch_id` (string, optional) — A ramificação do agente usada pela campanha para chamar.
- `environment` (string, optional) — O ambiente no qual as variáveis de ambiente do agente são resolvidas.
- `target_concurrency_limit` (integer, optional) — O número máximo de chamadas que a campanha realiza ao mesmo tempo.

### ValidationError

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

### ConversationInitiationClientDataRequestInput

- `conversation_config_override` (ConversationConfigClientOverrideInput, optional)
- `custom_llm_extra_body` (map from string to any, optional)
- `user_id` (string, optional) — ID do usuário final que participa desta conversa (para identificação do usuário proprietário do agente)
- `source_info` (ConversationInitiationSourceInfo, optional) — Informações sobre a origem do início da conversa
- `branch_id` (string, optional) — ID da ramificação do agente a ser usada nesta conversa
- `environment` (string, optional) — Ambiente a ser usado para resolver variáveis de ambiente
- `starting_workflow_node_id` (string, optional) — Se definido, inicia o workflow neste ID de nó em vez da entrada padrão.
- `procedure_ids` (list of string, optional) — Se definido, somente estes procedimentos estarão disponíveis para o agente inicial. Cada ID deve estar vinculado a esse agente; IDs desconhecidos impedem o início da conversa. Uma lista vazia desativa todos os procedimentos desse agente. Não se aplica após uma transferência de agente. Requer enable_procedure_ids_from_client.
- `start_procedure_ids` (list of string, optional) — Se definido, estes procedimentos de formato livre serão iniciados quando a conversa começar. Aceita no máximo cinco IDs. Cada ID deve estar disponível depois que procedure_ids for aplicado. IDs desconhecidos e procedimentos estruturados impedem o início da conversa. Requer enable_procedure_ids_from_client.
- `dynamic_variables` (map from string to any, optional)

### PhoneVoiceConfigInput

- `ringing_timeout_secs` (integer, optional, default: 60) — Por quantos segundos o destinatário deve tocar antes de desistir. Isso também estará sujeito às limitações do próprio provedor.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Se deve gravar a chamada usando a gravação de chamadas da Twilio. Ignorado para provedores que não são da Twilio. As gravações são armazenadas na sua conta Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional) — Configuração da detecção de secretária eletrônica (AMD) no nível da operadora da Twilio. Omita ou defina como null para desativá-la. Ignorada para provedores que não são Twilio e para chamadas recebidas. O resultado é entregue como seu próprio evento de webhook `answering_machine_detection`, que exige que esse evento esteja ativado nas configurações de webhook do espaço de trabalho ou do agente; ele não faz parte da conversa nem do webhook pós-chamada. A detecção é executada de forma assíncrona, portanto nunca atrasa o início da conversa, e o resultado pode chegar em qualquer momento durante a chamada -- com `detect_message_end`, até mesmo após seu encerramento. A Twilio cobra separadamente pelo AMD.
- `mode` ("voice", optional)

### SubmitWhatsAppChannelConfigModeConfig

- `mode`: `message`
  - `template` (SubmitWhatsAppTemplateRef, required) — Nomeia o modelo aprovado pela Meta a ser enviado. O servidor carrega o modelo por conta própria, portanto o cliente nunca fornece seus componentes.
- `mode`: `voice`
  - `whatsapp_call_permission_request_template_language_code` (string, required) — O código de idioma desse modelo.
  - `whatsapp_call_permission_request_template_name` (string, required) — O modelo aprovado que pede permissão ao contato para ligar.

### DataCollectionOutcomeEqualsItem

- string
- integer
- double
- boolean

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Quanto tempo aguardar antes de uma nova tentativa curta.
- `max_short_retries` (integer, optional, default: 1) — Novas tentativas permitidas por uma janela de chamada após uma chamada com falha. Quando esgotadas, a próxima tentativa aguarda a janela seguinte, que começa do zero.
- `max_total_calls` (integer, optional, default: 6) — O número máximo de chamadas que um lead recebe, incluindo a primeira.
- `max_callbacks` (integer, optional, default: 2) — O número máximo de retornos de chamada a atender para um número.
- `max_redirects` (integer, optional, default: 2) — O número máximo de vezes que um lead atende a uma solicitação para ligar para outro número.
- `interval_placement` (enum, optional, default: start) — Em que ponto de uma janela de chamadas posterior uma chamada adiada será realizada: no `start`, em um horário `random` ou com `rotate` de `rotate_step_seconds` após o ponto em que a última chamada nessa janela falhou.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Quanto o posicionamento `rotate` desloca cada chamada. Usado somente por `rotate`.
- `max_consecutive_failures_per_number` (integer, optional) — Quantidade de chamadas consecutivas para um número que podem falhar antes de o lead passar para o próximo número listado ou encerrar, caso não haja outro. Uma chamada atendida ou um redirecionamento para um novo número reinicia a contagem. Se não for definido, apenas `max_total_calls` será aplicado.

### CallingPeriod

- `weekdays` (list of integer, required) — Dias aos quais os intervalos se aplicam, de `0` (segunda-feira) a `6` (domingo).
- `intervals` (list of CallingIntervalPolicy, required) — Janelas em cada um desses dias. Elas não podem se sobrepor em nenhum dia.

### DataCollectionConfig

Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.

- `callback_time` (string, optional) — O item que contém quando o contato pediu para receber um retorno de chamada.
- `redirect_phone_number` (string, optional) — O item que contém outro número para o qual o contato pediu que ligássemos.
- `stop` (string, optional) — O item que é verdadeiro quando o contato pede para não receber novas chamadas.
- `mappings` (map from string to string, optional) — Copia os resultados da coleta de dados para variáveis dinâmicas usadas em chamadas posteriores: cada chave é um ID de item de coleta de dados e seu valor é o nome da variável.

### FollowupContextPolicy

Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

- `call_type` (boolean, optional, default: true) — Passe o tipo de chamada como `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Passe o ID da última conversa como `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Passe o resumo da última conversa como `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Passe a transcrição da última conversa como `campaign__previous_transcript`.

### CampaignResponseChannelConfig

- `channel`: `phone`
  - `agent_phone_number_id` (string, required) — O número de telefone usado para realizar a chamada.
  - `mode_config` (PhoneVoiceConfigOutput, optional)
- `channel`: `whatsapp`
  - `mode_config` (WhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — O número de telefone do WhatsApp usado para fazer chamadas ou enviar mensagens.

### CampaignPolicySnapshot

A política usada pela campanha quando foi criada, estruturada como uma `policy` enviada.

- `timezone` (string, required)
- `retry` (RetryPolicy, required)
- `calling_periods` (list of CallingPeriodPolicy, required)
- `data_collection` (DataCollectionPolicy, required)
- `followup_context` (FollowupContextPolicy, required) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### CampaignSummaryCounts

- `leads` (integer, required)
- `terminal_leads` (integer, required) — Leads que não receberão mais chamadas.
- `open_attention` (integer, required) — Itens de atenção ainda não resolvidos.
- `delivery` (RecipientDeliveryCounts, optional) — Quantidade de mensagens que chegou a cada estágio; definido ao obter uma campanha de mensagens.

### CampaignResponseOutcome

- `type`: `data_collection`
  - `data_collection_id` (string, required) — O item de coleta de dados do agente que uma chamada bem-sucedida define.
  - `equals` (list of DataCollectionOutcomeEqualsItem, required) — Valores considerados bem-sucedidos, todos do tipo do item.
- `type`: `evaluation_criteria`
  - `criteria_id` (string, required) — O critério de avaliação do agente atendido por uma chamada bem-sucedida.

### ValidationErrorLocItem

- string
- integer

### ConversationConfigClientOverrideInput

- `asr` (AsrConversationalConfigOverride, optional) — Configuração para transcrição conversacional
- `turn` (TurnConfigOverride, optional) — Configuração para detecção de turnos
- `tts` (TtsConversationalConfigOverride, optional) — Configuração para Text to Speech conversacional
- `conversation` (ConversationConfigOverride, optional) — Configuração para eventos de conversa
- `agent` (AgentConfigOverrideInput, optional) — Configuração específica do agente

### ConversationInitiationSourceInfo

Informações sobre a origem do início da conversa

- `source` (enum, optional, default: unknown) — Origem do início da conversa
  - 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) — O número da versão do SDK

### TwilioMachineDetectionConfig

Como executar a detecção de secretária eletrônica (AMD) no nível da operadora do Twilio em uma chamada.

- `mode` (enum, optional, default: enable) — O quão completa deve ser a detecção. `enable` retorna um veredito assim que o Twilio consegue distinguir uma pessoa de uma máquina. `detect_message_end` também aguarda o fim da saudação da caixa postal, o que gera os vereditos `machine_end_*`, mas retorna um resultado mais tarde.
  - Allowed values: `enable`, `detect_message_end`
- `actions` (list of TwilioMachineDetectionRule, optional) — Ações a realizar na chamada para cada veredito AMD. Cada ação pode aparecer em no máximo uma regra, portanto liste todos os vereditos correspondentes juntos. Vereditos sem uma regra mantêm a chamada em andamento.

### SubmitWhatsAppTemplateRef

Nomeia o modelo aprovado pela Meta a ser enviado. O servidor carrega o modelo por conta própria, portanto o cliente nunca fornece seus componentes.

- `name` (string, required)
- `language` (string, required) — O código de idioma do modelo, como `en_US`.

### CallingIntervalPolicy

- `start` (string, required) — Horário local de início, como `HH:MM`.
- `end` (string, required) — Horário local de término, como `HH:MM`; `24:00` termina à meia-noite.

### PhoneVoiceConfigOutput

- `ringing_timeout_secs` (integer, optional, default: 60) — Por quantos segundos o destinatário deve tocar antes de desistir. Isso também estará sujeito às limitações do próprio provedor.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Se deve gravar a chamada usando a gravação de chamadas da Twilio. Ignorado para provedores que não são da Twilio. As gravações são armazenadas na sua conta Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional) — Configuração da detecção de secretária eletrônica (AMD) no nível da operadora da Twilio. Omita ou defina como null para desativá-la. Ignorada para provedores que não são Twilio e para chamadas recebidas. O resultado é entregue como seu próprio evento de webhook `answering_machine_detection`, que exige que esse evento esteja ativado nas configurações de webhook do espaço de trabalho ou do agente; ele não faz parte da conversa nem do webhook pós-chamada. A detecção é executada de forma assíncrona, portanto nunca atrasa o início da conversa, e o resultado pode chegar em qualquer momento durante a chamada -- com `detect_message_end`, até mesmo após seu encerramento. A Twilio cobra separadamente pelo AMD.
- `mode` ("voice", optional)

### WhatsAppChannelConfigModeConfig

- `mode`: `message`
  - `template` (WhatsAppTemplate, required) — O modelo da Meta conforme foi aprovado no envio.
- `mode`: `voice`
  - `whatsapp_call_permission_request_template_language_code` (string, required) — O código de idioma desse modelo.
  - `whatsapp_call_permission_request_template_name` (string, required) — O modelo aprovado que pede permissão ao contato para ligar.

### CallingPeriodPolicy

- `weekdays` (list of integer, required)
- `intervals` (list of CallingIntervalPolicy, required) — Janelas em cada um desses dias. Elas não podem se sobrepor em nenhum dia.

### DataCollectionPolicy

- `callback_time` (string, optional)
- `redirect_phone_number` (string, optional)
- `stop` (string, optional)
- `mappings` (map from string to string, optional) — Copia os resultados da coleta de dados para variáveis dinâmicas usadas em chamadas posteriores: cada chave é um ID de item de coleta de dados e seu valor é o nome da variável.

### 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) — Palavras-chave para aumentar a probabilidade de previsão

### TurnConfigOverride

- `soft_timeout_config` (SoftTimeoutConfigOverride, optional) — Configuração da funcionalidade de timeout flexível. Fornece feedback imediato durante respostas mais longas da LLM.
- `noisy_environment_message` (string, optional) — O que o agente diz quando detecta um ambiente barulhento.

### TtsConversationalConfigOverride

- `model_id` (enum, optional, default: eleven_v4_turbo) — O modelo a ser usado para 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) — O ID da voz a usar para TTS
- `supported_voices` (list of SupportedVoice, optional) — Vozes adicionais compatíveis com o agente
- `stability` (double, optional) — A estabilidade da fala gerada
- `speed` (double, optional) — A velocidade da fala gerada
- `similarity_boost` (double, optional) — O aumento de similaridade para a fala gerada
- `pronunciation_dictionary_locators` (list of PydanticPronunciationDictionaryVersionLocator, optional) — Os localizadores do dicionário de pronúncia

### ConversationConfigOverride

- `text_only` (boolean, optional) — Se ativado, o áudio não será processado e apenas o texto será usado. Use para evitar a cobrança de áudio.
- `max_duration_seconds` (integer, optional) — A duração máxima de uma conversa em segundos

### AgentConfigOverrideInput

- `first_message` (string, optional) — Se não estiver vazio, será a primeira mensagem que o agente dirá. Se estiver vazio, o agente aguardará o usuário iniciar a conversa.
- `language` (string, optional) — Idioma do agente — usado para ASR e TTS
- `max_conversation_duration_message` (string, optional) — Se não estiver vazio, será a mensagem que o agente enviará quando a duração máxima da conversa for atingida.
- `prompt` (PromptAgentApiModelOverrideInput, optional) — O prompt do agente

### TwilioMachineDetectionRule

Ação a realizar em uma chamada em andamento para os vereditos AMD especificados.

- `action` ("hang_up", required)
- `answered_by` (list of enum, required) — Vereditos que acionam a ação.
  - 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) — https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/

### SoftTimeoutConfigOverride

- `message` (string, optional) — Mensagem a exibir quando o primeiro tempo limite flexível for atingido durante a espera pela resposta do LLM. Compatível com variáveis dinâmicas (por exemplo, \{\{system\_\_time}}, \{\{custom\_variable}}).
- `additional_soft_timeout_messages` (list of string, optional) — Mensagens estáticas extras de preenchimento para os soft timeouts subsequentes na mesma geração de LLM. O primeiro timeout usa `message`. Se houver menos mensagens configuradas que `max_soft_timeouts_per_generation`, a última mensagem configurada será repetida; caso contrário, será usada uma mensagem de preenchimento integrada.

### SupportedVoice

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

### PydanticPronunciationDictionaryVersionLocator

Um localizador para que outros documentos possam fazer referência a um dicionário específico e à sua versão. Esta é uma versão pydantic de PronunciationDictionaryVersionLocatorDBModel. Necessário para garantir compatibilidade com os demais modelos de dados do agente.

- `pronunciation_dictionary_id` (string, required) — O ID do dicionário de pronúncia
- `version_id` (string, optional) — O ID da versão do dicionário de pronúncia

### PromptAgentApiModelOverrideInput

- `prompt` (string, optional) — O prompt do agente
- `llm` (enum, optional) — O LLM a ser consultado com o prompt e o histórico do chat. Se estiver usando residência de dados, o LLM deve ser compatível com o ambiente de residência de dados.
  - 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) — Uma lista de IDs das ferramentas usadas pelo agente.
- `tool_ids_strict` (boolean, optional) — Aplica-se apenas como uma substituição na conversa e é permitido sempre que tool_ids puder ser substituído. Quando verdadeiro, o tool_ids substituído é a lista completa de ferramentas permitidas na conversa, incluindo ferramentas em nós do workflow. É ignorado quando definido no agente.
- `native_mcp_server_ids` (list of string, optional) — Uma lista de IDs de servidores MCP nativos a serem usados pelo agente
- `knowledge_base` (list of KnowledgeBaseLocator, optional) — Uma lista de bases de conhecimento a serem usadas pelo agente

### WhatsAppTemplateComponent

- `type` (string, required)
- `format` (string, optional)
- `text` (string, optional)
- `buttons` (list of WhatsAppTemplateComponentButton, optional)

### KnowledgeBaseLocator

- `type` (enum, required) — O tipo da base de conhecimento
  - Allowed values: `file`, `url`, `text`, `folder`
- `name` (string, required) — O nome da base de conhecimento
- `id` (string, required) — O ID da base de conhecimento
- `usage_mode` (enum, optional, default: auto) — O modo de uso da base de conhecimento
  - Allowed values: `prompt`, `auto`

### WhatsAppTemplateComponentButton

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

## Examples

**Request**

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

**Response**

```json
{
  "campaign": {
    "campaign_id": "campaign_id",
    "call_name": "call_name",
    "agent_id": "agent_id",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "agent_phone_number_id"
    },
    "status": "active",
    "policy": {
      "timezone": "timezone",
      "retry": {},
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ],
      "data_collection": {},
      "followup_context": {}
    },
    "variant": "simple",
    "created_at_unix": 1,
    "updated_at_unix": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 1
    },
    "agent_name": "agent_name",
    "source": "ui",
    "outcome": {
      "type": "data_collection",
      "data_collection_id": "data_collection_id",
      "equals": [
        "equals"
      ]
    },
    "scheduled_time_unix": 1,
    "branch_id": "branch_id",
    "environment": "environment",
    "target_concurrency_limit": 1
  },
  "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": "call_name",
    "agent_id": "agent_id",
    "recipients": [{}],
    "channel_config": {
        "channel": "phone",
        "agent_phone_number_id": "agent_phone_number_id"
    }
}
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":"call_name","agent_id":"agent_id","recipients":[{}],"channel_config":{"channel":"phone","agent_phone_number_id":"agent_phone_number_id"}}'
};

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\": \"call_name\",\n  \"agent_id\": \"agent_id\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"channel\": \"phone\",\n    \"agent_phone_number_id\": \"agent_phone_number_id\"\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\": \"call_name\",\n  \"agent_id\": \"agent_id\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"channel\": \"phone\",\n    \"agent_phone_number_id\": \"agent_phone_number_id\"\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\": \"call_name\",\n  \"agent_id\": \"agent_id\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"channel\": \"phone\",\n    \"agent_phone_number_id\": \"agent_phone_number_id\"\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": "call_name",
  "agent_id": "agent_id",
  "recipients": [
    {}
  ],
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  }
}',
  '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\": \"call_name\",\n  \"agent_id\": \"agent_id\",\n  \"recipients\": [\n    {}\n  ],\n  \"channel_config\": {\n    \"channel\": \"phone\",\n    \"agent_phone_number_id\": \"agent_phone_number_id\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "call_name": "call_name",
  "agent_id": "agent_id",
  "recipients": [[]],
  "channel_config": [
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  ]
] 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()
```