Interrompi una campagna outbound

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

Interrompi definitivamente una campagna in uscita: le chiamate in coda vengono annullate e nessun lead verrà più chiamato. Restituisce 202 con la campagna in stato stopping mentre le chiamate già avviate si stanno ancora concludendo.

Parametri di percorso

campaign_idstringObbligatorio

Risposta

Risposta riuscita

campaign_idstring

call_namestring

Il nome della campagna.

agent_idstring

channel_configobject

statusenum

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.

policyobject

La policy adottata dalla campagna al momento della creazione.

variantenum

Valori consentiti:

sourceenum or null

Se la campagna è stata creata nell’app o tramite l’API.

Valori consentiti:

outcomeobject or null

Il risultato considerato un successo per le chiamate della campagna.

created_at_unixinteger

scheduled_time_unixinteger or null

Quando la campagna inizia a chiamare; non impostato per iniziare al momento della creazione.

updated_at_unixinteger

branch_idstring or null

Il ramo dell'agente usato dalla campagna per le chiamate.

environmentstring or null

L'ambiente in cui vengono risolte le variabili d'ambiente dell'agente.

target_concurrency_limitinteger or null

Il numero massimo di chiamate che la campagna effettua contemporaneamente.

channelenum

Valori consentiti:

modeenum

Valori consentiti:

countsobject

agent_namestringPredefinito a

Errori

422

Unprocessable Entity Error

Parametri di percorso

Header

Risposta

Errori