Skip to content

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

get

/sms/invalid_phone_numbers

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

See me in Postman

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエストパラメーター

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

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

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/sms/invalid_phone_numbers?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&phone_numbers[]=12345678901' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

応答

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "sms": [
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "provider_error"
    },
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "deactivated"
    },
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "provider_error"
    }
  ],
  "message": "success"
}
New Stuff!