Valide e formate números de telefone internacionais ou nacionais com GenderAPI v2. Consulte o contexto obrigatório do país, os campos JSON e a cobrança de um crédito.
Validar e formatar um número de telefone
POST /phone/validate aceita number e o campo opcional country. Use um número de telefone internacional começando com +. Para um número de telefone nacional, forneça um código de país ISO maiúsculo. A resposta possui valid, possible, e164, country e country_calling_code dentro de data, além do objeto meta compartilhado. Isso verifica a estrutura do número de telefone e não se o assinante existe. Cada validação concluída custa 1 crédito, incluindo resultados inválidos. A resposta ilustrativa abaixo mostra um número inválido e é independente do exemplo da solicitação.
Campo JSON
Tipo
Regra
number
string
Obrigatório, 3–32 caracteres. ASCII dígitos, espaços, parênteses e hífens, com um + opcional à esquerda. Extensões e caracteres alfabéticos não são aceitos.
country
string
Código ISO 3166-1 alfa-2 em letras maiúsculas. Obrigatório para um número de telefone nacional. Opcional quando o valor number começa com +. Omita este campo quando não for necessário.
Escolha uma linguagem de programação.Configure sua chave API, e execute o exemplo em seu servidor.
Cada solicitação de previsão é uma nova operação faturável, incluindo novas tentativas. Esses exemplos não repetem automaticamente. Verifique o status do faturamento antes de enviar outra solicitação.
Antes de executar: acesso e tratamento de erros
Execute estes exemplos em seu servidor. Configure GENDERAPI_API_KEY no ambiente de processo para sua chave API existente. Confirme que meta.access.mode é api_key: uma chave não reconhecida pode retornar à avaliação IP.
As respostas HTTP 4xx e 5xx JSON preservam o corpo do erro e retornam um status de saída diferente de zero. Verifique code, action e meta.usage.billing_status antes de tentar novamente.
import jsonimport osimport sysimport urllib.errorimport urllib.requestapi_key = os.environ.get("GENDERAPI_API_KEY")if not api_key: raise RuntimeError("Set GENDERAPI_API_KEY")body = json.loads("{\"number\":\"+905321234567\"}")class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return Nonerequest = urllib.request.Request( "https://api.genderapi.io/api/v2/phone/validate", method="POST", data=json.dumps(body).encode("utf-8"), headers={ "Authorization": "Bearer " + api_key, "Content-Type": "application/json", },)opener = urllib.request.build_opener(NoRedirect())try: response = opener.open(request, timeout=30)except urllib.error.HTTPError as error: response = error # Keep the Problem Details body on non-2xx responses.with response: status = response.status raw = response.read().decode("utf-8") if "json" not in response.headers.get("Content-Type", ""): raise RuntimeError(f"HTTP {status}: expected a JSON response") result = json.loads(raw)print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)if not 200 <= status < 300: sys.exit(1) # Inspect code, action and billing before retrying.# For batches, inspect every item even when HTTP status is 200.
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.nio.charset.StandardCharsets;import java.time.Duration;public class GenderApiExample { private static String requiredEnv(String name) { String value = System.getenv(name); if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name); return value; } public static void main(String[] args) throws Exception { String apiKey = requiredEnv("GENDERAPI_API_KEY"); String body = "{\"number\":\"+905321234567\"}"; HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .followRedirects(HttpClient.Redirect.NEVER) .build(); HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/phone/validate")) .timeout(Duration.ofSeconds(30)) .header("Authorization", "Bearer " + apiKey) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8)); if (!response.headers().firstValue("content-type").orElse("").contains("json")) { throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON"); } // JSON text; parse with your application's JSON library when integrating. if (response.statusCode() < 200 || response.statusCode() >= 300) { System.err.println(response.body()); // Includes Problem Details. System.exit(1); } System.out.println(response.body()); // For batches, inspect each item's data or error, including on HTTP 200. }}
Java 17+; cliente HTTP padrão. Salve como GenderApiExample.java e execute java GenderApiExample.java. Documentação de tempo de execução
C# / .NET
using System;using System.Net.Http;using System.Net.Http.Headers;using System.Text;using System.Text.Json;string RequiredEnv(string name) => !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name)) ? Environment.GetEnvironmentVariable(name)! : throw new InvalidOperationException($"Set {name}");var apiKey = RequiredEnv("GENDERAPI_API_KEY");using var handler = new HttpClientHandler { AllowAutoRedirect = false };using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.genderapi.io/api/v2/phone/validate");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);request.Content = new StringContent("{\"number\":\"+905321234567\"}", Encoding.UTF8, "application/json");using var response = await client.SendAsync(request);var raw = await response.Content.ReadAsStringAsync();if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false)) throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");using var result = JsonDocument.Parse(raw);if (!response.IsSuccessStatusCode){ Console.Error.WriteLine(result.RootElement); // Preserve Problem Details. Environment.ExitCode = 1;}else{ Console.WriteLine(result.RootElement); // For batches, inspect every item even on HTTP 200.}
A entrada malformada é rejeitada com HTTP 422 antes do faturamento. Se o formato da solicitação estiver correto, mas o número de telefone não puder ser analisado, a operação poderá retornar HTTP 200 com os campos de formatação valid: false e null. Esta validação concluída custa 1 crédito. Um número que pode ser analisado, mas é inválido, ainda pode ter um valor e164. Verifique valid; um número formatado por si só não é prova de validade.
Campo dentro de data
Significado
valid
Se o número corresponde às regras de validação do plano de numeração.
possible
Se o número tem comprimento plausível para seu plano de numeração; mais fraco do que válido.
e164
Número formatado internacionalmente quando a análise é bem-sucedida, caso contrário, null.
country
Região derivada do número ou null quando indisponível; ele não localiza o assinante.
country_calling_code
Código numérico de chamada internacional ou null quando indisponível.
Autenticação e novas tentativas
Envie sua chave de API existente usando autenticação de portador e tipo de conteúdo: application/json. Os exemplos leem GENDERAPI_API_KEY do ambiente. O campo country é obrigatório para números de telefone nacionais e opcional quando o valor number inicia com +.