停止外呼活动

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
}

永久停止外呼活动：排队中的呼叫会被取消，所有潜在客户均不会再次被呼叫。已发起的呼叫仍在完成时，会返回活动 stopping 状态和 202。

路径参数

campaign_idstring必需

响应

成功响应

campaign_idstring

call_namestring

活动名称。

agent_idstring

channel_configobject

statusenum

attention 表示未解决的待处理项会暂停活动中的部分呼叫，其他呼叫继续进行。stopping 表示已排队的呼叫会被取消，已发起的呼叫将完成。

policyobject

活动创建时采用的策略。

variantenum

允许的值:

created_at_unixinteger

updated_at_unixinteger

channelenum

允许的值:

modeenum

允许的值:

countsobject

agent_namestring默认为

sourceenum可选

活动是在应用中还是通过 API 创建。

允许的值:

outcomeobject可选

视为活动呼叫成功的结果。

scheduled_time_unixinteger可选

活动开始呼叫的时间；未设置时，创建后立即开始。

branch_idstring可选

活动呼叫时使用的智能体分支。

environmentstring可选

解析智能体环境变量所用的环境。

target_concurrency_limitinteger可选

活动可同时发起的最大呼叫数。

错误

422

Outbound Campaigns Stop Request Unprocessable Entity Error

路径参数

请求头

响应

错误