Ungültige Telefonnummern abfragen

Verwenden Sie diesen Endpunkt, um eine Liste der Telefonnummern abzurufen, die innerhalb eines bestimmten Zeitraums als „ungültig“ markiert wurden. Weitere Informationen finden Sie in der Dokumentation Behandlung ungültiger Telefonnummern.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung sms.invalid_phone_numbers.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Hinweis

Sie müssen entweder start_date und end_date ODER phone_numbers angeben. Wenn Sie alle drei Parameter – start_date, end_date und phone_numbers – angeben, werden die angegebenen Telefonnummern priorisiert und der Datumsbereich ignoriert.

Wenn Ihr Datumsbereich mehr ungültige Telefonnummern enthält als der limit-Wert zulässt, müssen Sie mehrere API-Aufrufe tätigen und dabei jedes Mal den offset erhöhen, bis ein Aufruf entweder weniger als limit oder null Ergebnisse zurückgibt.

Beispielanfrage

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'

Antwort

Die Einträge sind in absteigender Reihenfolge aufgeführt.

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"
}