Valider og formater et telefonnummer
| Parameter | Type | Påkrevd | Standardverdi | Beskrivelse |
|---|---|---|---|---|
number | string | Ja | — | Påkrevd, 3–32 tegn. ASCII-sifre, mellomrom, parenteser og bindestreker, med valgfri + først. Internnumre og bokstaver godtas ikke. |
country | string | Betinget | — | ISO 3166-1 alpha-2-kode med store bokstaver. Påkrevd for et nasjonalt nummer; valgfri når number starter med +. Utelat feltet hvis det ikke brukes. |
POST /phone/validate godtar number og et valgfritt country. Bruk et internasjonalt nummer som starter med +, eller angi en ISO-landkode med store bokstaver for et nasjonalt nummer. Svaret inneholder valid, possible, e164, country og country_calling_code i data, samt den samme meta-strukturen. Dette kontrollerer nummerets oppbygning, ikke om abonnenten finnes. En fullført validering koster 1 kreditt, også ved ugyldige resultater. Det syntetiske svaret nedenfor viser et ugyldig nummer, uavhengig av forespørselseksemplet.
Velg et programmeringsspråk. Konfigurer API-nøkkelen, og kjør deretter eksemplet på serveren din.
Hver prediksjonsforespørsel er en ny operasjon som belastes, også nye forsøk. Disse eksemplene prøver ikke automatisk på nytt. Sjekk belastningsstatusen før du sender en ny forespørsel.
Før du kjører: tilgang og feilhåndtering
Kjør disse eksemplene på serveren din. Sett GENDERAPI_API_KEY i prosessmiljøet til din eksisterende API-nøkkel. Bekreft at meta.access.mode er api_key: en nøkkel som ikke gjenkjennes, kan føre til IP-prøveperioden.
Ved JSON-svar med HTTP 4xx og 5xx beholdes feilinnholdet, og eksemplet avsluttes med en exit-status som ikke er null. Sjekk code, action og meta.usage.billing_status før du prøver på nytt.
Veiledning om feil og nye forsøk →cURL 7.76+ i et POSIX-skall. Kjør i terminalen. Dokumentasjon for kjøretidsmiljøet
Node.js 22+; innebygd fetch. Lagre som example.mjs og kjør node example.mjs. Dokumentasjon for kjøretidsmiljøet
Python 3.10+; standardbiblioteket. Lagre som example.py og kjør python3 example.py. Dokumentasjon for kjøretidsmiljøet
PHP 8+ med cURL-utvidelsen. Lagre som example.php og kjør php example.php. Dokumentasjon for kjøretidsmiljøet
Java 17+; standard HTTP-klient. Lagre som GenderApiExample.java og kjør java GenderApiExample.java. Dokumentasjon for kjøretidsmiljøet
Konsollapplikasjon i .NET 8+. Bruk som Program.cs i et konsollprosjekt, og kjør deretter dotnet run. Dokumentasjon for kjøretidsmiljøet
Go 1.22+; standardbiblioteket. Lagre som main.go og kjør go run main.go. Dokumentasjon for kjøretidsmiljø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
}
}
}Les feltene for telefonvalidering
Et 422-svar avviser ugyldige inndata før belastning. En korrekt formet forespørsel med et nummer som ikke kan tolkes, kan fullføres med HTTP 200, valid: false og null i formateringsfeltene; denne fullførte valideringen koster 1 kreditt. Et nummer som kan tolkes, men er ugyldig, kan likevel ha en e164-verdi. Sjekk valid i stedet for å behandle formatert utdata som bevis på gyldighet.
| Felt | Type | Kan være null | Eksempel | Beskrivelse |
|---|---|---|---|---|
data.valid | boolean | Nei | false | Om nummeret oppfyller valideringsreglene i nummerplanen. |
data.possible | boolean | Nei | false | Om nummeret har en plausibel lengde for nummerplanen; svakere enn valid. |
data.e164 | string | Ja | null | Internasjonalt formatert nummer når tolkningen lykkes, ellers null. |
data.country | string | Ja | null | Region utledet fra nummeret, eller null når den ikke er tilgjengelig; den viser ikke hvor abonnenten befinner seg. |
data.country_calling_code | integer | Ja | null | Numerisk internasjonalt landnummer, eller null når det ikke er tilgjengelig. |
Metadata om tilgang, belastning og forespørsel
| Felt | Type | Kan være null | Eksempel | Beskrivelse |
|---|---|---|---|---|
meta.request_id | string | Nei | "550e8400-e29b-41d4-a716-446655440000" | Unik ID for dette HTTP-forsøket; sendes også i X-Request-ID. |
meta.duration_ms | integer | Nei | 42 | Behandlingstid for forespørselen i millisekunder. |
meta.access.mode | string | Nei | "api_key" | api_key, ip_trial eller unauthenticated. Kontroller at verdien er api_key når du bruker en betalt konto. |
meta.access.reason | string | Ja | null | Årsak til at IP-prøveperioden ble brukt: api_key_missing, api_key_invalid eller api_key_not_found; ellers null. |
meta.usage.charged_credits | integer | Ja | 1 | Netto belastede kreditter. 0 før belastning eller etter en bekreftet full refusjon; null når belastningen ikke er bekreftet. |
meta.usage.remaining_credits | integer | Ja | 99 | Saldo når operasjonen er fullført. Kan være negativ; null når saldoen ikke er tilgjengelig eller belastningen ikke er bekreftet. |
meta.usage.billing_status | string | Nei | "confirmed" | not_charged, confirmed eller unconfirmed. Sjekk dette før du prøver en mislykket prediksjon på nytt. |
meta.usage.resets_at | string | Ja | "2026-09-27T12:00:00.000Z" | Tidspunkt for tilbakestilling av IP-prøveperioden i UTC (ISO 8601); null for kontoer med API-nøkkel eller når tidspunktet er ukjent. |
meta.usage.limit | integer | Ja | 10 | Kvoten i IP-prøveperioden; null for kontoer med API-nøkkel. |
meta.usage.period_seconds | integer | Ja | 86400 | Lengden på IP-prøveperioden i sekunder; null for kontoer med API-nøkkel. |
Autentisering og nye forsøk
Send din eksisterende API-nøkkel med Bearer og Content-Type: application/json. Kodeeksemplene leser GENDERAPI_API_KEY fra miljøet. Nasjonale numre krever country; feltet er valgfritt når number starter med +.