Stoppa en utgående kampanj

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
}

Stoppa en utgående kampanj permanent: köade samtal avbryts och inga leads rings upp igen. Returnerar 202 med kampanjen stopping medan redan påbörjade samtal fortfarande avslutas.

Sökvägsparametrar

campaign_idstringObligatorisk

Svar

Lyckat svar

campaign_idstring

call_namestring

Kampanjens namn.

agent_idstring

channel_configobject

statusenum

attention innebär att ett öppet uppmärksamhetsobjekt håller tillbaka vissa av kampanjens samtal medan övriga fortsätter. stopping innebär att köade samtal avbryts och att redan uppringda samtal avslutas.

policyobject

Den policy som kampanjen använde när den skapades.

variantenum

Tillåtna värden:

created_at_unixinteger

updated_at_unixinteger

channelenum

Tillåtna värden:

modeenum

Tillåtna värden:

countsobject

agent_namestringStandard är

sourceenumValfri

Om kampanjen skapades i appen eller via API:et.

Tillåtna värden:

outcomeobjectValfri

Resultatet som räknas som lyckat för kampanjens samtal.

scheduled_time_unixintegerValfri

När kampanjen börjar ringa; lämna tomt för att starta när den har skapats.

branch_idstringValfri

Agentgrenen som kampanjen ringer med.

environmentstringValfri

Miljön där agentens miljövariabler löses.

target_concurrency_limitintegerValfri

Det högsta antalet samtal kampanjen genomför samtidigt.

Fel

422

Outbound Campaigns Stop Request Unprocessable Entity Error

Sökvägsparametrar

Headers

Svar

Fel