Een uitgaande campagne 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": "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
}

Stop een uitgaande campagne definitief: oproepen in de wachtrij worden geannuleerd en geen enkele lead wordt opnieuw gebeld. Retourneert 202 met de campagne op stopping zolang reeds geplaatste oproepen nog worden afgerond.

Padparameters

campaign_idstringVerplicht

Response

Geslaagde response

campaign_idstring

call_namestring

De naam van de campagne.

agent_idstring

channel_configobject

statusenum

attention betekent dat een open aandachtspunt sommige oproepen van de campagne tegenhoudt, terwijl de overige doorgaan. stopping betekent dat oproepen in de wachtrij worden geannuleerd en al geplaatste oproepen worden afgerond.

policyobject

Het beleid dat de campagne gebruikte toen deze werd gemaakt.

variantenum

Toegestane waarden:

created_at_unixinteger

updated_at_unixinteger

channelenum

Toegestane waarden:

modeenum

Toegestane waarden:

countsobject

agent_namestringStandaard

sourceenumOptioneel

Of de campagne in de app of via de API is gemaakt.

Toegestane waarden:

outcomeobjectOptioneel

Het resultaat dat als succes geldt voor de oproepen van de campagne.

scheduled_time_unixintegerOptioneel

Wanneer de campagne begint met bellen; niet ingesteld om te starten zodra deze is gemaakt.

branch_idstringOptioneel

De agentbranch waarmee de campagne belt.

environmentstringOptioneel

De omgeving waarin de omgevingsvariabelen van de agent worden opgelost.

target_concurrency_limitintegerOptioneel

Het maximale aantal oproepen dat de campagne tegelijk plaatst.

Fouten

422

Outbound Campaigns Stop Request Unprocessable Entity Error

Padparameters

Headers

Response

Fouten