Skip to content

Query or list invalid phone numbers

get

/sms/invalid_phone_numbers

This endpoint allows you to pull a list of phone numbers that have been deemed “invalid” within a certain time frame.

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Request parameters

Parameter Required Data Type Description
start_date Optional
(see note)
String in YYYY-MM-DD format Start date of the range to retrieve invalid phone numbers, must be earlier than end_date. This is treated as midnight in UTC time by the API.
end_date Optional
(see note)
String in YYYY-MM-DD format End date of the range to retrieve invalid phone numbers. This is treated as midnight in UTC time by the API.
limit Optional Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500.
offset Optional Integer Optional beginning point in the list to retrieve from.
phone_numbers Optional
(see note)
Array of Strings in e.164 format If provided, we will return the phone number if it has been found to be invalid.

If your date range has more than the limit number of invalid phone numbers, you will need to make multiple API calls with increasing the offset each time until a call returns either fewer than limit or zero results.

Example request

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'

Response

Entries are listed in descending order.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "sms": [
    {
      "phone": "12345678900",
      "invalid_detected_at": "2016-08-25 15:24:32 +0000"
    },
    {
      "phone": "12345678901",
      "invalid_detected_at": "2016-08-24 17:41:58 +0000"
    },
    {
      "phone": "12345678902",
      "invalid_detected_at": "2016-08-24 12:01:13 +0000"
    }
  ],
  "message": "success"
}
WAS THIS PAGE HELPFUL?
New Stuff!