Skip to content

無効な電話番号を照会する

get

/sms/invalid_phone_numbers

このエンドポイントを使用して、一定期間内に「無効」とされた電話番号のリストを引き出す。詳細については、「無効な電話番号の処理」のドキュメントを参照してください。

前提条件

このエンドポイントを使用するには、API キーsms.invalid_phone_numbersの権限が必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

リクエストパラメーター

パラメーター required データ型 説明
start_date オプション
(注を参照)
YYYY-MM-DD形式の文字列 無効な電話番号を取得する範囲の開始日であり、end_date より前である必要があります。これは API によって UTC 時間の真夜中として扱われます。
end_date オプション
(注を参照)
YYYY-MM-DD形式の文字列 無効な電話番号を取得する範囲の終了日。これは API によって UTC 時間の真夜中として扱われます。
limit オプション 整数 返される結果の数を制限するためのオプション・フィールド。デフォルトは100で、最大は500です。
offset オプション 整数 取得先となるリスト内のオプションの開始点。
phone_numbers オプション
(注を参照)
e.164 形式の文字列の配列 提供された場合、電話番号が無効であることが判明した場合は返却する。
reason オプション
(注を参照)
文字列 利用可能な値は、”provider_error”(プロバイダーエラーで電話がSMSを受信できないことを示す)または “deactivated”(電話番号が無効化された)である。省略された場合は、すべての理由が返される。

日付範囲に limit の数を超える無効な電話番号がある場合、複数回の API 呼び出しが必要になります。呼び出しによって返されるのが limit を下回るか、結果がゼロになるまで、その都度 offset を増やします。

例のリクエスト

応答

エントリは降順で表示されます。

「このページはどの程度役に立ちましたか?」
New Stuff!