Zatrzymaj kampanię wychodzącą

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

Zatrzymaj kampanię wychodzącą na stałe: połączenia w kolejce są anulowane, a żaden lead nie otrzyma kolejnego połączenia. Zwraca 202 z kampanią stopping, gdy rozpoczęte połączenia są jeszcze kończone.

Parametry ścieżki

campaign_idstringWymagany

Odpowiedź

Pomyślna odpowiedź

campaign_idstring

call_namestring

Nazwa kampanii.

agent_idstring

channel_configobject

statusenum

attention oznacza, że otwarta pozycja wymagająca uwagi wstrzymuje część połączeń kampanii, a pozostałe są realizowane. stopping oznacza, że połączenia w kolejce są anulowane, a rozpoczęte połączenia są kończone.

policyobject

Polityka przyjęta przez kampanię podczas jej tworzenia.

variantenum

Dozwolone wartości:

sourceenum or null

Czy kampanię utworzono w aplikacji czy przez API.

Dozwolone wartości:

outcomeobject or null

Wynik uznawany za sukces połączeń kampanii.

created_at_unixinteger

scheduled_time_unixinteger or null

Kiedy kampania zaczyna dzwonić; pozostaw puste, aby zaczęła po utworzeniu.

updated_at_unixinteger

branch_idstring or null

Gałąź agenta, z którą kampania wykonuje połączenia.

environmentstring or null

Środowisko, w którym rozwiązywane są zmienne środowiskowe agenta.

target_concurrency_limitinteger or null

Maksymalna liczba połączeń wykonywanych jednocześnie przez kampanię.

channelenum

Dozwolone wartości:

modeenum

Dozwolone wartości:

countsobject

agent_namestringDomyślnie

Błędy

422

Unprocessable Entity Error

Parametry ścieżki

Nagłówki

Odpowiedź

Błędy