アウトバウンドキャンペーンのリードを一覧表示

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"
}

アウトバウンドキャンペーンのリードを、受信者ごとに1件ずつ一覧表示します。

パスパラメータ

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

パスパラメータ

ヘッダー

クエリパラメータ

レスポンス

エラー