创建外呼活动

POST

/v1/convai/outbound-campaigns/campaigns/submit

POST

/v1/convai/outbound-campaigns/campaigns/submit

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "call_name",
  "agent_id": "agent_id",
  "recipients": [
    {}
  ],
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  }
}'

{
  "campaign": {
    "campaign_id": "campaign_id",
    "call_name": "call_name",
    "agent_id": "agent_id",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "agent_phone_number_id"
    },
    "status": "active",
    "policy": {
      "timezone": "timezone",
      "retry": {},
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ],
      "data_collection": {},
      "followup_context": {}
    },
    "variant": "simple",
    "created_at_unix": 1,
    "updated_at_unix": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 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
  },
  "created": true,
  "within_calling_window": true
}

创建外呼活动，在策略允许的呼叫时段内由智能体向每位收件人呼叫或发送消息，并按策略重试和跟进。新活动返回 201。重复请求会根据 idempotency_key 或请求正文匹配，并返回现有活动，created 为 false。

请求

This endpoint expects an object.

call_namestring必需1-256 characters

活动名称。

agent_idstring必需1-256 characters

发起呼叫的智能体。

recipientslist of objects必需

要呼叫的对象。每位收件人都会成为活动中的一名潜在客户。

channel_configobject必需

scheduled_time_unixinteger可选>=0

开始呼叫的时间；省略则立即开始。呼叫仍会等待下一个呼叫时间窗口。

timezonestring可选

读取呼叫时段所用的 IANA 时区，会覆盖策略中的设置。

branch_idstring可选<=256 characters

用于呼叫的智能体分支。

environmentstring可选<=256 characters

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

target_concurrency_limitinteger可选>=1

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

idempotency_keystring可选1-256 characters

使请求可安全重试：使用相同键的重复请求会返回其创建的活动。

outcomeobject可选

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

policyobject可选

要快照到活动中的策略。设置后，它会优先于工作区默认策略和所有按智能体设置的覆盖项；省略时，必须存在工作区配置并由其提供策略。

variantenum可选

simple 会在始终开放的呼叫时段内向每位收件人尝试呼叫一次，不收集任何数据，且不能与 policy 结合使用。advanced 使用 policy 或工作区配置，是电话活动的默认值。

允许的值:

响应

成功响应

campaignobject

createdboolean

如果请求重复了之前的请求并返回其活动，则为 false。

within_calling_windowboolean

是否立即开始呼叫，而非在下一个呼叫时间窗口开始。

错误

422

Outbound Campaigns Create Request Unprocessable Entity Error

请求头

请求

响应

错误