Extraire les numéros de téléphone non valides

Utilisez cet endpoint pour obtenir une liste des numéros de téléphone qui ont été marqués comme “invalides” dans un certain laps de temps. Pour plus d’informations, consultez la documentation sur la gestion des numéros de téléphone non valides.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation sms.invalid_phone_numbers.

Limite de débit

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

Paramètres de demande

Si votre plage de dates dépasse le nombre limit de numéros de téléphone non valides, vous devrez effectuer plusieurs appels d’API, en augmentant à chaque fois le offset jusqu’à ce qu’un appel renvoie un résultat inférieur à limit ou égal à zéro.

Exemple de demande

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'

Réponse

Les entrées sont répertoriées par ordre décroissant.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "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"
}