Consultar números de teléfono no válidos

Utilice este punto final para obtener una lista de números de teléfono que se han marcado como “no válidos” en un periodo de tiempo determinado. Consulte la documentación Manejo de números de teléfono no válidos para obtener más información.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso sms.invalid_phone_numbers.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Si su intervalo de fechas tiene un número de números de teléfono no válidos superior a limit, tendrá que realizar varias llamadas a la API aumentando offset cada vez hasta que una llamada devuelva menos de limit o cero resultados.

Ejemplo de solicitud

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'

Respuesta

Las entradas aparecen en orden descendente.

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