Skip to content

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

get

/sms/invalid_phone_numbers

Utiliza este endpoint para obtener una lista de números de teléfono que se han marcado como “no válidos” en un periodo de tiempo determinado. Consulta Manejo de números de teléfono no válidos para obtener más información.

See me in Postman

Requisitos previos

Para utilizar este endpoint, 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 endpoint, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
start_date Opcional
(ver nota)		 Cadena en formato AAAA-MM-DD Fecha de inicio del intervalo para recuperar números de teléfono no válidos, debe ser anterior a end_date. La API la considera medianoche en hora UTC.
end_date Opcional
(ver nota)		 Cadena en formato AAAA-MM-DD Fecha final del intervalo para recuperar números de teléfono no válidos. La API la considera medianoche en hora UTC. Los resultados incluyen números no válidos detectados hasta el final de ese día del calendario en UTC (inclusive).
limit Opcional Entero Campo opcional para limitar el número de resultados devueltos. De forma predeterminada es 100, el máximo es 500.
offset Opcional Entero Punto de inicio opcional de la lista desde el que recuperar.
phone_numbers Opcional
(ver nota)		 Matriz de cadenas en formato e.164 Si se proporciona, Braze devuelve el número de teléfono si se comprueba que no es válido.
reason Opcional
(ver nota)		 Cadena Los valores disponibles son provider_error (el proveedor indica que el teléfono no puede recibir SMS), deactivated (el número de teléfono ha sido desactivado) o invalid_format (el número no pasó la validación de formato, como un valor que no cumple con E.164). Si se omite, se devuelven todas las razones.

Si tu intervalo de fechas tiene un número de teléfonos no válidos superior a limit, tendrás 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

{
  "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" : "invalid_format"
    }
  ],
  "message": "success"
}
New Stuff!