ナビゲーションにスキップ

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

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

パスパラメータ

campaign_idstring必須

ヘッダー

xi-api-keystringオプション

クエリパラメータ

page_sizeintegerオプション1-500デフォルト値 100

返す項目の最大数。

searchstring or nullオプション<=100 characters

ID、ユーザーID、または電話番号にこのテキストを含むリードのみ。

statusenum or nullオプション

引き続き電話するリードはin_progress、今後電話しないリードはfinishedです。

許可された値:
dispositionlist of enums or nullオプション

これらのいずれかの理由で完了したリードのみ。

cursorstring or nullオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

leadslist of objects
next_cursorstring or null
has_moreboolean

エラー

422
Unprocessable Entity Error