Outbound-Kampagne stoppen

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

Stoppt eine Outbound-Kampagne endgültig: Geplante Anrufe werden abgebrochen und kein Lead wird erneut angerufen. Gibt 202 mit der Kampagne stopping zurück, während bereits gestartete Anrufe noch beendet werden.

Pfadparameter

campaign_idstringErforderlich

Antwort

Erfolgreiche Antwort

campaign_idstring

call_namestring

Der Name der Kampagne.

agent_idstring

channel_configobject

statusenum

attention bedeutet, dass ein offener Prüfpunkt einige Anrufe der Kampagne zurückhält, während die übrigen fortgesetzt werden. stopping bedeutet, dass geplante Anrufe abgebrochen werden und bereits gestartete Anrufe beendet werden.

policyobject

Die Richtlinie, die die Kampagne bei ihrer Erstellung verwendet hat.

variantenum

Erlaubte Werte:

sourceenum or null

Ob die Kampagne in der App oder über die API erstellt wurde.

Erlaubte Werte:

outcomeobject or null

Das Ergebnis, das für die Anrufe der Kampagne als Erfolg zählt.

created_at_unixinteger

scheduled_time_unixinteger or null

Zeitpunkt, zu dem die Kampagne mit Anrufen beginnt; nicht gesetzt, um nach der Erstellung zu starten.

updated_at_unixinteger

branch_idstring or null

Der Agent-Zweig, mit dem die Kampagne anruft.

environmentstring or null

Die Umgebung, in der die Umgebungsvariablen des Agenten aufgelöst werden.

target_concurrency_limitinteger or null

Die maximale Anzahl von Anrufen, die die Kampagne gleichzeitig tätigt.

channelenum

Erlaubte Werte:

modeenum

Erlaubte Werte:

countsobject

agent_namestringStandardwert ist

Fehler

422

Unprocessable Entity Error

Pfadparameter

Header

Antwort

Fehler