列出外呼活动线索

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads

curl -G https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads \
     -d cursor=cursor \
     -d disposition=campaign_ended \
     -d page_size=1 \
     -d search=search \
     -d status=in_progress

{
  "leads": [
    {
      "lead_id": "lead_id",
      "phone_number": "phone_number",
      "phone_numbers_index": 1,
      "user_id": "user_id",
      "attempt_count": 1,
      "failure_count": 1,
      "callback_count": 1,
      "redirect_count": 1,
      "do_not_call": true,
      "updated_at_unix": 1,
      "dynamic_variables": {
        "key": "value"
      },
      "overrides": {},
      "recipient_id": "recipient_id",
      "phone_numbers": [
        "phone_numbers"
      ],
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": null,
        "delivered_at_unix": null,
        "read_at_unix": null,
        "replied_at_unix": null,
        "failed_at_unix": null,
        "error_message": null
      }
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

列出外呼活动的潜在客户，每位收件人一条。

路径参数

campaign_idstring必需

查询参数

page_sizeinteger可选1-500默认为 100

最多返回的项目数。

searchstring可选<=100 characters

仅 ID、用户 ID 或电话号码包含此文本的潜在客户。

statusenum可选

仍在呼叫的潜在客户为 in_progress，不会再次呼叫的潜在客户为 finished。

允许的值:

dispositionenum可选

仅以这些方式之一完成的潜在客户。

cursorstring可选

用于获取下一页。响应中会返回游标。

响应

成功响应

leadslist of objects

has_moreboolean

next_cursorstring可选

错误

422

Leads List Request Unprocessable Entity Error

路径参数

请求头

查询参数

响应

错误