Tarkista ja muotoile puhelinnumero
| Parametri | Tyyppi | Pakollinen | Oletusarvo | Kuvaus |
|---|---|---|---|---|
number | string | Kyllä | — | Pakollinen, 3–32 merkkiä. ASCII-numerot, välilyönnit, sulkeet ja yhdysmerkit sekä valinnainen +-merkki alussa. Alanumeroita ja kirjaimia ei hyväksytä. |
country | string | Ehdollinen | — | ISO 3166-1 -alpha-2-koodi isoilla kirjaimilla. Vaaditaan kansallista puhelinnumeroa varten. Valinnainen, kun number-arvo alkaa +. Jätä tämä kenttä pois, kun sitä ei tarvita. |
POST /phone/validate hyväksyy number-kentän ja valinnaisen country-kentän. Käytä +-merkillä alkavaa kansainvälistä numeroa; kansallinen numero tarvitsee ISO-maakoodin isoilla kirjaimilla. Vastauksen data sisältää kentät valid, possible, e164, country ja country_calling_code sekä yhteisen meta-objektin. Tarkistus koskee numeron rakennetta, ei liittymän olemassaoloa. Jokainen loppuun käsitelty tarkistus maksaa 1 krediitin, myös virheellisen numeron tulos. Alla oleva havainnollistava vastaus on riippumaton esimerkkipyynnöstä.
Valitse ohjelmointikieli. Määritä API-avain, suorita sitten esimerkki palvelimellasi.
Jokainen ennustepyyntö on uusi laskutettava toiminto, myös uudelleenyritys. Nämä esimerkit eivät yritä uudelleen automaattisesti. Tarkista laskutuksen tila ennen uuden pyynnön lähettämistä.
Ennen suorittamista: käyttöoikeus ja virheiden käsittely
Suorita esimerkit palvelimellasi. Aseta prosessin ympäristömuuttujan GENDERAPI_API_KEY arvoksi nykyinen API-avaimesi. Varmista, että meta.access.mode on api_key: tunnistamaton avain voi siirtää pyynnön IP-kokeiluun.
HTTP 4xx- ja 5xx-JSON-vastauksissa esimerkit säilyttävät virherungon ja palauttavat nollasta poikkeavan poistumiskoodin. Tarkista code, action ja meta.usage.billing_status ennen uutta yritystä.
Virhe- ja uudelleenyritysopas →cURL 7.76+ POSIX-komentotulkissa. Suorita päätteessä. Suoritusympäristön dokumentaatio
Node.js 22+; sisäänrakennettu fetch. Tallenna nimellä example.mjs ja suorita node example.mjs. Suoritusympäristön dokumentaatio
Python 3.10+; standardikirjasto. Tallenna nimellä example.py ja suorita python3 example.py. Suoritusympäristön dokumentaatio
PHP 8+ cURL-laajennuksella. Tallenna nimellä example.php ja suorita php example.php. Suoritusympäristön dokumentaatio
Java 17+; standardikirjaston HTTP-asiakas. Tallenna nimellä GenderApiExample.java ja suorita java GenderApiExample.java. Suoritusympäristön dokumentaatio
.NET 8+ -konsolisovellus. Käytä konsoliprojektissa nimellä Program.cs ja suorita sitten dotnet run. Suoritusympäristön dokumentaatio
Go 1.22+; standardikirjasto. Tallenna nimellä main.go ja suorita go run main.go. Suoritusympäristön dokumentaatio
{
"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
}
}
}Puhelinnumeron tarkistuskenttien tulkinta
Virheellisen muotoinen syöte hylätään HTTP 422 -vastauksella ennen laskutusta. Jos pyyntö on oikein muotoiltu mutta numeroa ei voida jäsentää, tarkistus voi valmistua HTTP 200 -vastauksella, jossa valid: false ja muotoilukentät ovat null; tällainen valmis tarkistus maksaa 1 krediitin. Jäsennettävällä mutta virheellisellä numerolla voi silti olla e164-arvo. Tarkista valid-kenttä äläkä pidä muotoiltua tulosta todisteena kelvollisuudesta.
| Kenttä | Tyyppi | Voi olla null | Esimerkki | Kuvaus |
|---|---|---|---|---|
data.valid | boolean | Ei | false | Vastaako numero numerointisuunnitelman kelpoisuussääntöjä. |
data.possible | boolean | Ei | false | Onko numeron pituus uskottava sen numerointisuunnitelmassa; heikompi ehto kuin valid. |
data.e164 | string | Kyllä | null | Kansainvälisesti muotoiltu numero, jos jäsennys onnistuu, muuten null. |
data.country | string | Kyllä | null | Numerosta johdettu alue tai null, jos sitä ei ole saatavilla; se ei paikanna tilaajaa. |
data.country_calling_code | integer | Kyllä | null | Numeerinen maatunnus tai null, jos sitä ei ole saatavilla. |
Käyttöoikeus, veloitus ja pyynnön metatiedot
| Kenttä | Tyyppi | Voi olla null | Esimerkki | Kuvaus |
|---|---|---|---|---|
meta.request_id | string | Ei | "550e8400-e29b-41d4-a716-446655440000" | Tämän HTTP-yrityksen yksilöllinen tunniste; myös X-Request-ID-otsakkeessa. |
meta.duration_ms | integer | Ei | 42 | Pyynnön käsittelyaika millisekunteina. |
meta.access.mode | string | Ei | "api_key" | api_key, ip_trial tai unauthenticated. Tarkista api_key käyttäessäsi maksullista tiliä. |
meta.access.reason | string | Kyllä | null | Kokeiluun siirtymisen syy: api_key_missing, api_key_invalid tai api_key_not_found; muuten null. |
meta.usage.charged_credits | integer | Kyllä | 1 | Veloitetut nettokrediitit. Nolla ennen veloitusta tai vahvistetun täyden palautuksen jälkeen; null, jos veloitusta ei ole vahvistettu. |
meta.usage.remaining_credits | integer | Kyllä | 99 | Saldo toiminnon valmistuessa. Voi olla negatiivinen; null, jos saldoa ei saada tai veloitusta ei ole vahvistettu. |
meta.usage.billing_status | string | Ei | "confirmed" | not_charged, confirmed tai unconfirmed. Tarkista ennen epäonnistuneen ennusteen uutta yritystä. |
meta.usage.resets_at | string | Kyllä | "2026-09-27T12:00:00.000Z" | IP-kokeilun nollausaika UTC-ajassa (ISO 8601); null API-avaintileillä tai jos aika ei ole tiedossa. |
meta.usage.limit | integer | Kyllä | 10 | IP-kokeilun krediittikiintiö; null API-avaintileille. |
meta.usage.period_seconds | integer | Kyllä | 86400 | IP-kokeilujakson pituus sekunteina; null API-avaintileille. |
Todennus ja uudelleenyritykset
Lähetä nykyinen API-avaimesi Bearer-otsakkeessa ja Content-Type: application/json. Koodiesimerkit lukevat GENDERAPI_API_KEY-arvon ympäristöstä. Kansalliset numerot vaativat country-kentän; kenttä on valinnainen, kun number alkaa +-merkillä.