Detener una campaña saliente

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": "campaign_id",
  "call_name": "call_name",
  "agent_id": "agent_id",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id",
    "mode_config": {
      "ringing_timeout_secs": 1,
      "twilio_call_recording_enabled": true,
      "mode": "voice"
    }
  },
  "status": "active",
  "policy": {
    "timezone": "timezone",
    "retry": {
      "retry_delay_seconds": 1,
      "max_short_retries": 1,
      "max_total_calls": 1,
      "max_callbacks": 1,
      "max_redirects": 1,
      "interval_placement": "start",
      "rotate_step_seconds": 1,
      "max_consecutive_failures_per_number": 1
    },
    "calling_periods": [
      {
        "weekdays": [
          1
        ],
        "intervals": [
          {
            "start": "start",
            "end": "end"
          }
        ]
      }
    ],
    "data_collection": {
      "callback_time": "callback_time",
      "redirect_phone_number": "redirect_phone_number",
      "stop": "stop",
      "mappings": {
        "key": "value"
      }
    },
    "followup_context": {
      "call_type": true,
      "previous_conversation_id": true,
      "previous_summary": true,
      "previous_transcript": true
    }
  },
  "variant": "simple",
  "created_at_unix": 1,
  "updated_at_unix": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 1,
      "delivered": 1,
      "read": 1,
      "replied": 1,
      "failed": 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
}

Detiene definitivamente una campaña saliente: se cancelan las llamadas en cola y no se vuelve a llamar a ningún contacto. Devuelve 202 con la campaña en stopping mientras las llamadas ya realizadas aún están finalizando.

Parámetros de ruta

campaign_idstringRequerido

Respuesta

Respuesta correcta.

campaign_idstring

call_namestring

El nombre de la campaña.

agent_idstring

channel_configobject

statusenum

attention significa que un elemento de atención abierto retiene algunas llamadas de la campaña mientras las demás continúan. stopping significa que se cancelan las llamadas en cola y finalizan las ya realizadas.

policyobject

La política que adoptó la campaña al crearse.

variantenum

Valores permitidos:

created_at_unixinteger

updated_at_unixinteger

channelenum

Valores permitidos:

modeenum

Valores permitidos:

countsobject

agent_namestringValor predeterminado:

sourceenumOpcional

Si la campaña se creó en la app o mediante la API.

Valores permitidos:

outcomeobjectOpcional

El resultado que se considera exitoso para las llamadas de la campaña.

scheduled_time_unixintegerOpcional

Cuándo empieza a llamar la campaña; déjalo sin definir para que empiece al crearse.

branch_idstringOpcional

La rama del agente con la que llama la campaña.

environmentstringOpcional

El entorno en el que se resuelven las variables de entorno del agente.

target_concurrency_limitintegerOpcional

El número máximo de llamadas que realiza la campaña a la vez.

Errores

422

Outbound Campaigns Stop Request Unprocessable Entity Error

Parámetros de ruta

Encabezados

Respuesta

Errores