Validér og formatér et telefonnummer
| Parameter | Type | Påkrævet | Standard | Beskrivelse |
|---|---|---|---|---|
number | string | Ja | — | Påkrævet, 3–32 tegn. ASCII-cifre, mellemrum, parenteser og bindestreger med et valgfrit + i starten. Lokalnumre og bogstaver accepteres ikke. |
country | string | Betinget | — | ISO 3166-1 alpha-2-kode med store bogstaver. Påkrævet for et nationalt nummer og valgfri, når number starter med +. Udelad feltet, hvis du ikke bruger det. |
POST /phone/validate accepterer number og et valgfrit country. Brug et internationalt nummer, der starter med +, eller angiv en ISO-landekode med store bogstaver for et nationalt nummer. Svaret indeholder valid, possible, e164, country og country_calling_code i data samt den samme meta-struktur. Valideringen kontrollerer nummerets struktur, ikke om abonnenten findes. En gennemført validering koster 1 kredit, også ved ugyldige resultater. Det syntetiske svar nedenfor viser et ugyldigt nummer, uafhængigt af eksemplet på forespørgslen.
Vælg et programmeringssprog. Konfigurér din API-nøgle, og kør derefter eksemplet på din server.
Hver forespørgsel om en forudsigelse er en ny operation, der koster kreditter, også når den gentages. Eksemplerne prøver ikke automatisk igen. Kontrollér opkrævningsstatus, før du sender en ny forespørgsel.
Før du kører: adgang og fejlhåndtering
Kør eksemplerne på din server. Sæt GENDERAPI_API_KEY i procesmiljøet til din eksisterende API-nøgle. Bekræft, at meta.access.mode er api_key: En nøgle, der ikke genkendes, kan føre til IP-prøveadgangen.
JSON-svar med HTTP 4xx og 5xx bevarer fejlens body og returnerer en exitstatus, der ikke er nul. Kontrollér code, action og meta.usage.billing_status, før du prøver igen.
Guide til fejl og nye forsøg →cURL 7.76+ i en POSIX-shell. Kør i din terminal. Dokumentation for kørselsmiljøet
Node.js 22+, indbygget fetch. Gem som example.mjs, og kør node example.mjs. Dokumentation for kørselsmiljøet
Python 3.10+, standardbiblioteket. Gem som example.py, og kør python3 example.py. Dokumentation for kørselsmiljøet
PHP 8+ med cURL-udvidelsen. Gem som example.php, og kør php example.php. Dokumentation for kørselsmiljøet
Java 17+, standard-HTTP-klienten. Gem som GenderApiExample.java, og kør java GenderApiExample.java. Dokumentation for kørselsmiljøet
Konsolapplikation med .NET 8+. Brug som Program.cs i et konsolprojekt, og kør derefter dotnet run. Dokumentation for kørselsmiljøet
Go 1.22+, standardbiblioteket. Gem som main.go, og kør go run main.go. Dokumentation for kørselsmiljøet
{
"data": {
"valid": false,
"possible": false,
"e164": null,
"country": null,
"country_calling_code": null
},
"meta": {
"request_id": "11111111-1111-4111-8111-111111111111",
"duration_ms": 12,
"access": {
"mode": "ip_trial",
"reason": "api_key_missing"
},
"usage": {
"charged_credits": 1,
"remaining_credits": 7,
"billing_status": "confirmed",
"resets_at": "2026-09-26T12:00:00.000Z",
"limit": 10,
"period_seconds": 86400
}
}
}Læs felterne i valideringen af telefonnumre
Et 422-svar afviser input med forkert format, før der opkræves kreditter. En korrekt formateret forespørgsel, hvor nummeret ikke kan fortolkes, kan gennemføres med HTTP 200, valid: false og null i formateringsfelterne. Den gennemførte validering koster 1 kredit. Et nummer, der kan fortolkes, men er ugyldigt, kan stadig have en e164-værdi. Kontrollér valid i stedet for at betragte formateret output som bevis på gyldighed.
| Felt | Type | Kan være null | Eksempel | Beskrivelse |
|---|---|---|---|---|
data.valid | boolean | Nej | false | Om nummeret opfylder valideringsreglerne i nummerplanen. |
data.possible | boolean | Nej | false | Om nummeret har en plausibel længde for sin nummerplan. Svagere end valid. |
data.e164 | string | Ja | null | Internationalt formateret nummer, når fortolkningen lykkes, ellers null. |
data.country | string | Ja | null | Region udledt af nummeret eller null, når den ikke er tilgængelig. Den lokaliserer ikke abonnenten. |
data.country_calling_code | integer | Ja | null | Numerisk international landekode eller null, når den ikke er tilgængelig. |
Metadata om adgang, opkrævning og forespørgslen
| Felt | Type | Kan være null | Eksempel | Beskrivelse |
|---|---|---|---|---|
meta.request_id | string | Nej | "550e8400-e29b-41d4-a716-446655440000" | Entydigt id for dette HTTP-forsøg. Sendes også i X-Request-ID. |
meta.duration_ms | integer | Nej | 42 | Behandlingstid for forespørgslen i millisekunder. |
meta.access.mode | string | Nej | "api_key" | api_key, ip_trial eller unauthenticated. Kontrollér, at værdien er api_key, når du bruger en betalt konto. |
meta.access.reason | string | Ja | null | Årsag til IP-prøveadgangen: api_key_missing, api_key_invalid eller api_key_not_found, ellers null. |
meta.usage.charged_credits | integer | Ja | 1 | Opkrævede kreditter netto. Nul før opkrævning eller efter en fuld bekræftet refusion, null, når opkrævningen ikke er bekræftet. |
meta.usage.remaining_credits | integer | Ja | 99 | Saldo, når operationen afsluttes. Kan være negativ. null, når den ikke er tilgængelig, eller opkrævningen ikke er bekræftet. |
meta.usage.billing_status | string | Nej | "confirmed" | not_charged, confirmed eller unconfirmed. Kontrollér dette, før du prøver en mislykket forudsigelse igen. |
meta.usage.resets_at | string | Ja | "2026-09-27T12:00:00.000Z" | Tidspunkt for nulstilling af IP-prøveadgangen i UTC (ISO 8601). null for konti med API-nøgle, eller når det ikke er kendt. |
meta.usage.limit | integer | Ja | 10 | Kreditter i IP-prøveadgangen. null for konti med API-nøgle. |
meta.usage.period_seconds | integer | Ja | 86400 | Periode for IP-prøveadgangen i sekunder. null for konti med API-nøgle. |
Godkendelse og nye forsøg
Send din eksisterende API-nøgle i Bearer-headeren og Content-Type: application/json. Kodeeksemplerne læser GENDERAPI_API_KEY fra miljøet. Nationale numre kræver country. Feltet er valgfrit, når number starter med +.