Skip to content

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

get

/sms/invalid_phone_numbers

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.

See me in Postman

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

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
start_date Facultatif
(voir la note)		 Chaîne de caractères au format YYYY-MM-DD Date de début de la plage pour récupérer les numéros de téléphone non valides, doit être antérieure à end_date. Ce paramètre est traité comme minuit (UTC) par l’API.
end_date Facultatif
(voir la note)		 Chaîne de caractères au format YYYY-MM-DD Date de fin de la plage pour récupérer les numéros de téléphone non valides. Ce paramètre est traité comme minuit (UTC) par l’API.
limit Facultatif Entier Champ facultatif pour limiter le nombre de résultats renvoyés. Par défaut à 100, le maximum est 500.
offset Facultatif Entier Point de départ facultatif dans la liste où commencer la récupération.
phone_numbers Facultatif
(voir la note)		 Tableau de chaînes de caractères au format e.164 S’il est fourni, nous renverrons le numéro de téléphone s’il s’avère non valide.
reason Facultatif
(voir la note)		 Chaîne de caractères Les valeurs disponibles sont “provider_error” (une erreur de l’opérateur indique que le téléphone ne peut pas recevoir de SMS) ou “deactivated” (le numéro de téléphone a été désactivé). En cas d’omission, tous les motifs sont renvoyés.

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 requête

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

{
  "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!