Puhelinnumeroiden validointi ja E.164-muotoilu API

Kansainväliset puhelintiedot

Yksi numero, yhdenmukainen tulos

Lähetä kansallisia, kansainvälisiä tai epäsäännöllisesti muotoiltuja numeroita ja vastaanota standardoidut muodot sekä validointitiedot 242 maasta ja alueelta.

Raakasyöte+358 40 123 4567

E.164-tulos+358401234567

ValidointiisValid og isPossible

MuotoiluKansallinen, kansainvälinen ja E.164

LuokitteluMatkapuhelin, lankapuhelin, VoIP ja muut

SijaintiAlue, suuntanumero ja sijainti

Syöteparametrit

Numero ja osoitekonteksti

Parametri	Vaatimus	Kuvaus
`number`	Pakollinen	Puhelinnumero kansallisessa, kansainvälisessä tai E.164-muodossa.
`address`	Ehdollinen	Kansallisen numeron tulkintaan käytettävä ISO-maakoodi, maa, kaupunki tai alue.

Milloin address on pakollinen

Jos number ei ala +-merkillä ja kansainvälisellä maatunnuksella, anna konteksti, kuten FI, Finland tai Helsinki.

FISuomiHelsinkiTampereFinland

GET

Tunnistautuminen kyselymerkkijonossa

Yksinkertainen GET-pyyntö

cURL

curl "https://api.genderapi.io/api/phone?key=YOUR_API_KEY&number=%2B358401234567&address=FI"

URL-koodaus: Koodaa + muodossa %2B ja välilyönnit muodossa %20. Käytä mieluiten kielen URL- tai URLSearchParams-työkaluja merkkijonon manuaalisen rakentamisen sijaan.

POST

Bearer-tunnistautuminen

POST-pyyntö palvelimelta

Lähetä numero ja valinnainen osoite JSON-muodossa sekä API-avain Authorization-headerissa.

cURL

curl -X POST "https://api.genderapi.io/api/phone" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"number":"+358401234567","address":"FI"}'

JavaScript

const response = await fetch("https://api.genderapi.io/api/phone", {
  method: "POST", headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
  body: JSON.stringify({ number: "+358401234567", address: "Finland" })
});

API-vastaus

Validointi, formatering og metadata

JSON

{
  "status": true, "remaining_credits": 15709, "expires": 0, "duration": "18ms",
  "regionCode": "FI", "countryCode": 358, "country": "Finland",
  "national": "040 1234567", "international": "+358 40 1234567", "e164": "+358401234567",
  "isValid": true, "isPossible": true, "numberType": "MOBILE",
  "nationalSignificantNumber": "401234567", "rawInput": "+358 40 123 4567",
  "isGeographical": false, "areaCode": "", "location": ""
}

Vastauskentät

Kenttä	Tyyppi	Kuvaus
`status`	boolean	Suoritettiinko pyyntö onnistuneesti.
`remaining_credits`	integer	Pyynnön jälkeen käytettävissä olevat krediitit.
`expires`	integer	Krediittien vanhenemisaika UNIX-aikaleimana.
`duration`	string	Palvelimen käsittelyaika.
`regionCode`	string	Tunnistettu ISO 3166-1 alpha-2 -aluekoodi.
`countryCode`	integer	Kansainvälinen maatunnus.
`country`	string	Maan luettava nimi.
`national`	string	Kansalliseen käyttöön muotoiltu numero.
`international`	string	Kansainväliseen esitykseen muotoiltu numero.
`e164`	string	Numeron vakiomuotoinen E.164-esitys.
`isValid`	boolean	Täyttääkö numero alueelliset validointisäännöt.
`isPossible`	boolean	Voiko numero rakenteensa perusteella olla olemassa.
`numberType`	string	Tunnistettu numerotyyppi.
`nationalSignificantNumber`	string	Kansallinen numero ilman maatunnusta.
`rawInput`	string	Pyynnössä annettu alkuperäinen numero.
`isGeographical`	boolean	Voidaanko numero yhdistää maantieteelliseen alueeseen.
`areaCode`	string	Tunnistettu suuntanumero.
`location`	string	Suuntanumeroon liittyvä sijainti.

Luokittelun viite

Numerotyyppien arvot

FIXED_LINE

Maantieteelliseen alueeseen liittyvä lankapuhelin.

MOBILE

Matkapuhelinnumero.

FIXED_LINE_OR_MOBILE

Numerointisuunnitelma ei erottele lanka- ja matkapuhelinta.

TOLL_FREE

Maksuton numero, jossa vastaanottaja maksaa puhelun.

PREMIUM_RATE

Korotetun hinnan palvelunumero.

SHARED_COST

Puhelun hinta jaetaan soittajan ja vastaanottajan kesken.

VOIP

Voice over IP -puhelinnumero.

PERSONAL_NUMBER

Henkilökohtainen numero, joka voidaan ohjata toiselle linjalle.

PAGER

Hakulaitepalvelun numero.

UAN

Yrityksen yhteisenä yhteysnumerona käytetty yleinen palvelunumero.

VOICEMAIL

Vastaajapalvelun oma yhteysnumero.

UNKNOWN

Numerotyyppiä ei voitu määrittää.

Usein kysytyt kysymykset

Puhelin-APIn usein kysytyt kysymykset

Mitä puhelinnumeron validointi-API tekee?

Se validoi ja normalisoi puhelinnumerot, palauttaa kansallisen, kansainvälisen ja E.164-muodon sekä tunnistaa alueen, numerotyypin ja saatavilla olevat sijaintitiedot.

Mitä eroa on isValid- ja isPossible-kentillä?

isValid tarkistaa numeron alueellisia numerointisääntöjä vasten. isPossible kertoo, että rakenne voi vastata puhelinnumeroa, vaikka sen kelvollisuutta ei voida vahvistaa.

Milloin address on pakollinen?

Anna address, kun numero ei ala plusmerkillä ja kansainvälisellä maatunnuksella. Arvo voi olla ISO-maakoodi, maa, kaupunki tai alue.

Miten erikoismerkit lähetetään?

URL-koodaa välilyönnit, plusmerkit ja muut erikoismerkit GET-parametreissa. HTTP-asiakas koodaa POST-pyyntöjen JSON-datan.

Seuraava viite

Seuraa käyttöä ja kiintiötä

Käyttö ja kiintiöYmmärrä krediitit ja rajat →AsiakaskirjastotAsenna paketti puhelinnumeron validointiin →