Pular para o conteúdo principal

Endpoint

POST https://api.bunny.build/api/v1/phone-validation

Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)
Content-TypeSimapplication/json

Visão geral

Valide qualquer número de telefone e obtenha metadados estruturados incluindo país, operadora, tipo de linha e saída formatada em E.164. A API de Validação de Telefone da Bunny normaliza entradas brutas em dados legíveis por máquina, ajudando a reduzir fraudes, melhorar a entregabilidade e controlar fluxos de SMS com números reais.

Casos de uso

  • Validar números de telefone no cadastro para reduzir contas falsas
  • Detectar linhas VoIP ou pré-pagas antes de enviar SMS
  • Normalizar números internacionais para o formato E.164
  • Rotear chamadas ou mensagens com base na operadora ou região

Detalhes

Aceita números em qualquer formato local ou internacional. O campo opcional country (ISO 3166-1 alpha-2, ex.: BR, US) melhora a precisão ao interpretar números locais sem código de país.

Corpo da requisição

CampoTipoObrigatórioDescrição
phonestringSimNúmero de telefone a validar (qualquer formato)
countrystringNãoCódigo de país ISO 3166-1 alpha-2 como dica (ex.: US, BR)

Exemplo

{
  "phone": "+14155552671",
  "country": "US"
}

Resposta

200 OK

CampoTipoDescrição
validbooleanSe o número é válido
e164stringNúmero formatado em E.164
countrystringCódigo de país ISO
carrierstringNome da operadora (quando disponível)
line_typestringTipo de linha: mobile, landline, voip, toll_free, unknown
Exemplo
{
  "valid": true,
  "e164": "+14155552671",
  "country": "US",
  "carrier": "AT&T",
  "line_type": "mobile"
}

401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

422 Unprocessable Entity

{
  "detail": "Invalid or unparseable phone number"
}

429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

Exemplo cURL

curl -X POST https://api.bunny.build/api/v1/phone-validation \
  -H "X-API-Key: bun_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+14155552671", "country": "US"}'