Criar uma campanha de chamadas ativas

POST

/v1/convai/outbound-campaigns/campaigns/submit

POST

/v1/convai/outbound-campaigns/campaigns/submit

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "call_name",
  "agent_id": "agent_id",
  "recipients": [
    {}
  ],
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  }
}'

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

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.

Solicitação

This endpoint expects an object.

call_namestringObrigatório1-256 characters

O nome da campanha.

agent_idstringObrigatório1-256 characters

O agente que realiza as chamadas.

recipientslist of objectsObrigatório

Para quem fazer chamadas. Cada destinatário se torna um lead da campanha.

channel_configobjectObrigatório

scheduled_time_unixintegerOpcional>=0

Quando começar a fazer chamadas; omita para começar agora. As chamadas ainda aguardam a próxima janela de chamadas.

timezonestringOpcional

Fuso horário IANA no qual interpretar as janelas de chamada, substituindo o da política.

branch_idstringOpcional<=256 characters

A ramificação do agente a ser usada para chamar.

environmentstringOpcional<=256 characters

O ambiente no qual resolver as variáveis de ambiente do agente.

target_concurrency_limitintegerOpcional>=1

O número máximo de chamadas a realizar ao mesmo tempo.

idempotency_keystringOpcional1-256 characters

Torna a solicitação segura para novas tentativas: uma repetição com a mesma chave retorna a campanha que ela criou.

outcomeobjectOpcional

O resultado considerado bem-sucedido para as chamadas da campanha.

policyobjectOpcional

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.

variantenumOpcional

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.

Valores permitidos:

Resposta

Resposta bem-sucedida

campaignobject

createdboolean

False quando a solicitação repete uma solicitação anterior e retorna sua campanha.

within_calling_windowboolean

Se as chamadas começam imediatamente, em vez de na próxima janela de chamadas.

Erros

422

Outbound Campaigns Create Request Unprocessable Entity Error

Cabeçalhos

Solicitação

Resposta

Erros