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

アウトバウンドキャンペーンのリードを取得

アウトバウンドキャンペーンのリードを1件取得します。

パスパラメータ

campaign_idstring必須
lead_idstring必須

ヘッダー

xi-api-keystringオプション

レスポンス

成功レスポンス。

lead_idstring
phone_numberstring

リードへの次回の通話で発信する番号。リードが登録済みの別の番号に移った場合や、連絡先が別の番号への通話を希望した場合に変更されます。

phone_numbers_indexinteger

発信先番号の phone_numbers 内での位置。

user_idstring

連絡先の識別情報。conversation_initiation_client_data で送信されたuser_id、またはそれがない場合はリードの電話番号です。

attempt_countinteger

発信済みの通話。ポリシーのmax_total_calls にカウントされます。

failure_countinteger

現在の番号への通話失敗数。新しい番号に移るとリセットされます。

callback_countinteger

連絡先から依頼されたコールバック。

redirect_countinteger

連絡先が別の番号への発信を希望した回数。

do_not_callboolean

連絡先が今後の電話を拒否した場合、リードが削除された場合、またはキャンペーンが停止した場合に設定されます。そのリードには再度電話しません。

updated_at_unixinteger
dynamic_variablesmap from strings to any

リードに対して送信された動的変数。シークレットは伏せられます。

overridesobject

リードに対して送信された会話オーバーライド。

recipient_idstringオプション

キャンペーン作成時にこの受信者へ付与されたid。

phone_numberslist of stringsオプション

リードに登録された電話番号(発信順)。

terminal_dispositionenumオプション

リードに再度発信しない理由。再発信の可能性がある間は未設定です。

created_at_unixintegerオプション

リードがキャンペーンに参加した日時。古いリードでは未設定です。

deliveryobjectオプション

リードへの最新メッセージの配信状況。メッセージキャンペーンで設定されます。

エラー

422
Leads Get Request Unprocessable Entity Error