Referência da API para desenvolvedores

Gere números de teste de forma programática com simples solicitações HTTP GET.

Endpoint

Envie solicitações HTTP GET para a seguinte URL:

GEThttps://phone-number.loveyouall.qzz.io/api/generate

Teste online (Try It)

Preencha os parâmetros abaixo e chame diretamente a API real para ver a resposta JSON.

Parâmetros de consulta

ParâmetroTipoObrigatórioDescrição
countrystringNãoCódigo do país. Suporta "US", "CN", "CA", "GB", "AU", "DE", "FR", "JP", "KR", "IN", "SG", "ES", "IT", "BR", "MX", "RU", "NL". Padrão: "US".
regionstringNãoNome da região/estado/operadora (ex.: "California", "Ontario", "China Mobile"). Não diferencia maiúsculas de minúsculas.
citystringNãoNome da cidade ou prefixo/código específico (ex.: "Los Angeles", "138"). Não diferencia maiúsculas de minúsculas. Requer especificar region.
quantityintegerNãoQuantidade de registros a gerar. Intervalo: 1–1000 (valores acima de 1000 são limitados). Padrão: 10.
customPrefixstringNãoDígitos de prefixo personalizados (somente dígitos, 0-9). Opcional.
safetyModestringNãoModo de segurança. Suporta "realistic" (regras realistas) e "safe" (faixas fictícias oficiais reservadas, ex.: 555-XXXX). Padrão: "realistic".
uniqueOnlybooleanNãoGerar somente números únicos. Suporta "true" ou "false". Padrão: "true".

Exemplos de integração

Escolha seu idioma ou ferramenta preferidos para integrar a API:

curl -X GET "https://phone-number.loveyouall.qzz.io/api/generate?country=US&quantity=5&safetyMode=safe&uniqueOnly=true"

Formato de resposta

Retorna um array JSON de objetos de número. Cada objeto contém campos localizados, formato de exibição e string E.164 padronizada.

[
  {
    "id": "c852d129-4112-4981-8ddb",
    "country": "US",
    "region": "California",
    "regionCode": "CA",
    "city": "Los Angeles",
    "areaCode": "213",
    "display": "+1 (213) 932-8419",
    "e164": "+12139328419"
  }
]

Campos de resposta

CampoTipoDescrição
idstringIdentificador exclusivo UUID v4 do registro.
countrystringCódigo do país com duas letras (ex.: US, CN).
regionstringNome do estado/província/operadora, ex.: California ou China Mobile.
regionCodestringCódigo curto da região, ex.: CA para Califórnia.
areaCodestringCódigo de área ou prefixo do número, ex.: 213 ou 138.
citystringNome da cidade ou segmento de prefixo, ex.: Los Angeles ou 138.
displaystringNúmero formatado legível, ex.: +1 (213) 555-1234.
e164stringFormato E.164 padrão, ex.: +12135551234.

Códigos de erro

A API usa códigos de status HTTP padrão e sempre retorna um corpo JSON com um campo "error" em caso de falha.

Código de statusQuando ocorreCorpo da resposta
400Código de país não suportado{"error":"Unsupported country code: XX"}
400Região ou cidade desconhecida para o país selecionado{"error":"Unknown region ... for country US"}
400customPrefix contém caracteres não numéricos{"error":"customPrefix must contain digits only"}
400city fornecido sem region{"error":"city requires region"}
500Erro interno durante a geração{"error":"Internal Server Error"}

Limites de uso

  • Gratuito e sem autenticação, nenhuma chave de API necessária
  • Máximo de 1.000 números por solicitação (valores maiores são limitados)
  • Padrões: country=US, quantity=10, safetyMode=realistic, uniqueOnly=true
  • safetyMode=safe usa faixas fictícias oficiais reservadas (ex.: 555-XXXX) que nunca pertencem a assinantes reais