Consulta de números de telefone inválidos

Use esse endpoint para obter uma lista de números de telefone que foram marcados como “inválidos” em um determinado período. Para saber mais, consulte a documentação sobre tratamento de números de telefone inválidos.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão sms.invalid_phone_numbers.

Limite de frequência

Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.

Parâmetros de solicitação

Nota

Você deve fornecer um start_date e um end_date OU phone_numbers. Se você fornecer todos os três, start_date, end_date e phone_numbers, priorizaremos os números de telefone fornecidos e desconsideraremos o intervalo de datas.

Se o seu intervalo de datas tiver mais do que o número limit de números de telefone inválidos, será necessário fazer várias chamadas à API, aumentando o offset a cada vez até que uma chamada retorne menos do que limit ou zero resultados.

Exemplo de solicitação

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'

Resposta

As entradas são listadas em ordem decrescente.

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