Interromper uma campanha de chamadas ativas

POST

/v1/convai/outbound-campaigns/campaigns/:campaign_id/stop

POST

/v1/convai/outbound-campaigns/campaigns/:campaign_id/stop

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/stop

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

Interrompa definitivamente uma campanha ativa: as chamadas na fila são canceladas e nenhum lead recebe novas chamadas. Retorna 202 com a campanha em stopping enquanto as chamadas já realizadas ainda estão sendo concluídas.

Parâmetros de caminho

campaign_idstringObrigatório

Resposta

Resposta bem-sucedida

campaign_idstring

call_namestring

O nome da campanha.

agent_idstring

channel_configobject

statusenum

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.

policyobject

A política usada pela campanha quando foi criada.

variantenum

Valores permitidos:

sourceenum or null

Se a campanha foi criada no app ou pela API.

Valores permitidos:

outcomeobject or null

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

created_at_unixinteger

scheduled_time_unixinteger or null

Quando a campanha começa a fazer chamadas; deixe sem definir para iniciar assim que for criada.

updated_at_unixinteger

branch_idstring or null

A ramificação do agente usada pela campanha para chamar.

environmentstring or null

O ambiente no qual as variáveis de ambiente do agente são resolvidas.

target_concurrency_limitinteger or null

O número máximo de chamadas que a campanha realiza ao mesmo tempo.

channelenum

Valores permitidos:

modeenum

Valores permitidos:

countsobject

agent_namestringPadrão é

Erros

422

Unprocessable Entity Error

Parâmetros de caminho

Cabeçalhos

Resposta

Erros