Byrjaðu hér

Alþjóðlegt farsímanetkerfi starfar á grundvelli SS7 merkjakerfa. Þetta net gerir kleift að skiptast á áskrifendagögnum, símtalsleiðsögn, SMS sendingum og rauntíma uppfærslum á tengistöðu farsíma milli símafyrirtækja. Hvert farsímanet heldur úti Home Location Register (HLR) - kjarnagagnagrunni sem geymir nauðsynlegar upplýsingar um áskrifendur sína.

HLR uppflettingartækni gerir fyrirtækjum kleift að spyrjast fyrir um þessi skrá og sækja rauntíma tengingar- og netupplýsingar fyrir hvaða farsímanúmer sem er. Þetta felur í sér hvort síminn sé í gangi, hvaða neti hann er skráður á, hvort númerið hafi verið flutt, hvort númerið sé gilt eða óvirkt og hvort það sé í roaming.

HLR Lookups API veitir hnökralausan rauntíma aðgang að þessum gögnum og gerir fyrirtækjum kleift að staðfesta farsímanúmer, hagræða leiðsögn og bæta samskipti við viðskiptavini. Þessi leiðbeiningar munu leiða þig í gegnum samþættingu HLR Lookups í hugbúnaðinn þinn og gera sjálfvirka sókn rauntíma farsímaupplýsinga mögulega.

Notkun HLR Lookups API

Framkvæmd HLR uppflettinga er hröð, örugg og einföld. Þegar þú hefur skráð þig og fengið API lykilinn þinn geturðu auðkennt þig og hafið uppflettingar strax með einföldum HTTP POST beiðnum, í gegnum POST /hlr-lookup. Að öðrum kosti geturðu unnið úr stórum gagnasöfnum með því að velja hraðar ósamstilltar API beiðnir með niðurstöðum sem sendar eru aftur á þjóninn þinn í gegnum webhook, eins og útskýrt er í hugtakakaflanum.

Dæmi um beiðni

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookup' \
          -H "X-Digest-Key: YOUR_API_KEY" \
          -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
          -H "X-Digest-Timestamp: UNIX_TIMESTAMP" \
          -d "@payload.json"

Auðkenning er veitt í gegnum HTTP headers og payload.json ætti (að lágmarki) að innihalda eftirfarandi JSON hlut:

Dæmi um gagnaskjal

{
   "msisdn": "+14156226819"
}

Við árangursríka framkvæmd færðu svar sem inniheldur rauntíma tengiupplýsingar fyrir tilgreint farsímanúmer.

Árangursrík svarskil application/json

{
   "id":"f94ef092cb53",
   "msisdn":"+14156226819",
   "connectivity_status":"CONNECTED",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "imsi":"***************",
   "msin":"**********",
   "msc":"************",
   "original_network_name":"Verizon Wireless",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1",
   "is_ported":true,
   "ported_network_name":"T-Mobile US",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "is_roaming":false,
   "roaming_network_name":null,
   "roaming_country_name":null,
   "roaming_country_code":null,
   "roaming_country_prefix":null,
   "cost":"0.0100",
   "timestamp":"2020-08-07 19:16:17.676+0300",
   "storage":"SYNC-API-2020-08",
   "route":"IP1",
   "processing_status":"COMPLETED",
   "error_code":null,
   "error_description":null,
   "data_source":"LIVE_HLR",
   "routing_instruction":"STATIC:IP1"
}

Fyrir ítarlega sundurliðun á eigindum beiðna og svara og tengistöðu, sjá POST /hlr-lookup.

Viðbótar uppflettingarþjónustur

Númeraflutninga uppflettingar (MNP)

Notaðu MNP uppflettingar til að ákvarða neteign og flutningsmöguleika án þess að spyrjast fyrir um rauntíma tengingu. Ef þú þarft aðeins MCCMNC númers skaltu vísa í POST /mnp-lookup.

Númerategund uppflettingar (NT)

Ákvarðaðu hvort símanúmer tilheyri fastanúmeri, farsíma, gjaldskrárnúmeri, VoIP, símboða eða öðrum númerasvæðum með POST /nt-lookup.

Hugbúnaðarþróunarsett (SDK)

HLR Lookups API virkar með öllum REST biðlurum í öllum forritunarmálum og við höfum gefið út SDK fyrir PHP, Ruby og NodeJS á GitHub síðunni okkar til að hjálpa þér að byrja hratt.

Verkfæri

Til að tryggja hnökralausa þróunarupplifun bjóðum við upp á alhliða verkfærasett, þar á meðal API beiðna- og webhook vöktun í vafra, IP heimildalista, öfluga auðkenningar valkosti og auðkenningar prófunarslóð.

Ekki forritari?

HLR uppflettingar og númeraflutninga fyrirspurnir er hægt að framkvæma án nokkurrar forritunar. Lærðu meira um vefbiðlara fyrir fyrirtæki og skýrslugerðareiginleika í vafra.

Auðkenning

Til að tryggja öryggi og rétta aðgangsstýringu krefjast flestar beiðnir til HLR Lookups API auðkenningar. Endapunktar eru flokkaðir sem annaðhvort opnir eða verndaðir. Þegar verndaður endapunktur er opnaður verður beiðnin þín að vera auðkennd með API lykli og leyniorði með annaðhvort Digest-Auth eða Basic-Auth aðferð. Digest-Auth er öruggari kosturinn og er eindregið mælt með honum. Notaðu GET /auth-test endapunktinn til að staðfesta auðkenningaruppsetninguna þína.

API lykill og API leyniorð

Náðu í API lykilinn þinn og leyniorð af API stillingar síðunni. Þú getur einnig stillt valda auðkenningaraðferð og virkjað hvítlista IP talna fyrir aukið öryggi. Ef þú grunar að API leyniorðinu þínu hafi verið stolið geturðu búið til nýtt hvenær sem er.

Basic Auth Digest Auth IP Heimildarlisti

Venjuleg Basic Authentication er auðveld í notkun og víða studd. Þú getur auðkennt með því að senda API lykilinn þinn og leyniorð sem user:pass par í HTTP beiðninni.

HTTP Basic Auth

curl 'https://YOUR_API_KEY:YOUR_API_SECRET@www.hlr-lookups.com/api/v2/auth-test'

Þetta sendir Authorization haus:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Mælt með: X-Basic haus með SHA256

Fyrir bætt öryggi geturðu sent SHA256 tætigildi af auðkenningarupplýsingunum þínum í stað þess að senda þær beint sem base64. Til að nota þessa aðferð skaltu reikna út tætigildi af YOUR_API_KEY:YOUR_API_SECRET parinu þínu og senda það með X-Basic hausnum:

Basic Auth beiðni

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: BASIC_AUTH_HASH"

Basic Authentication hausar

Lykill	Tegund	Lýsing
`X-Basic`	string	SHA256 tætigildi af `YOUR_API_KEY:YOUR_API_SECRET`. Láttu tvípunktinn (:) fylgja með í tætigildinu.	skyldubundið

Kóðadæmi

$key = 'YOUR_API_KEY';
$secret = 'YOUR_API_SECRET';

$basicAuthHash = hash('sha256', $key . ':' . $secret);

Digest-Auth er ráðlögð aðferð til að tryggja aðgang að vernduðum HLR Lookup API endapunktum. Hver beiðni verður að innihalda eftirfarandi hausa: X-Digest-Key, X-Digest-Signature og X-Digest-Timestamp, sem útskýrðir eru hér að neðan.

Beiðnidæmi

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Digest-Key: YOUR_API_KEY" \
  -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
  -H "X-Digest-Timestamp: UNIX_TIMESTAMP"

Beiðnihausa

Lykill	Tegund	Lýsing
`X-Digest-Key`	string	Einstakur HLR Lookups API lykillinn þinn.	skyldubundið
`X-Digest-Signature`	string	Einstök auðkenningarundirskrift (sjá hér að neðan).	skyldubundið
`X-Digest-Timestamp`	integer	Núverandi Unix tímastimpill (sjá einnig `GET /time`).	skyldubundið

Smíði undirskriftar

X-Digest-Signature er búið til með SHA256 HMAC tætigildi, með API leyniorðinu þínu sem sameiginlegum lykli.

Strengurinn sem á að tæta er uppbyggður svona:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. táknið táknar strengjasamsetningu.

Digest undirskriftaríhlutir

Íhlutur	Tegund	Lýsing
`ENDPOINT_PATH`	string	Umbeðni API endapunkturinn, t.d. `/auth-test` með lágstöfum.
`UNIX_TIMESTAMP`	integer	Núverandi Unix tímastimpill (verður að vera innan 30 sekúndna). Sjá `GET /time`.
`REQUEST_METHOD`	string	HTTP aðferðin sem notuð er, t.d. `POST` eða `GET`.
`REQUEST_BODY`	string	Gögn í beiðniteli. Stilltu á `null` fyrir `GET` beiðnir.

Kóðadæmi

PHP

NodeJS

Ruby

$path = '/auth-test'
    $timestamp = time();
    $method = 'GET';
    $body = $method == 'GET' ? null : json_encode($params);
    $secret = 'YOUR_API_SECRET';

    $signature = hash_hmac('sha256', $path . $timestamp . $method . $body, $secret);

require('crypto');

    let path = '/auth-test'
    let timestamp = Date.now() / 1000 | 0;
    let method = 'GET'
    let body = method === 'GET' ? '' : JSON.stringify(params)
    let secret = 'YOUR_API_SECRET'

    let signature = crypto.createHmac('sha256', secret)
                    .update(path + timestamp + method + body)
                    .digest('hex');

require 'openssl'

path = '/auth-test'
timestamp = Time.now.to_i
method = 'GET'
body = method == 'GET' ? NIL : params.to_json
secret = 'YOUR_API_SECRET'

signature = OpenSSL::HMAC.hexdigest('sha256', secret, path + timestamp.to_s + method + body.to_s)

Skruna upp

Hugtök

Innleiðing HLR uppflettinga í hvaða forritunarmáli eða kerfi sem er í gegnum HTTP REST API okkar er einföld og skilvirk. Með einföldu samþættingarferli geturðu byrjað að senda fyrirspurnir til farsímaneta í rauntíma til að fá tafarlausar upplýsingar um gildi símanúmera, tengistöðu og leiðarupplýsingar.

Val á viðeigandi API fer eftir þínu tiltekna notkunartilviki. Ef þú þarft rauntíma uppflettiniðurstöður fyrir forrit eins og VoIP símakerfi, svikavarnir eða SMS leiðarstjórnun, er samstillt API besti kosturinn. Hins vegar, ef notkunartilvikið þitt felur í sér stórmagnsvinnslu, magnuppflettingar eða gagnasannprófun í stórum stíl, býður ósamstillt API upp á bestu afköstin með bandbreiddarskilvirkni og magnuppflettingarmöguleikum.

Stilltu API til að nota einn af sérsniðnu leiðarvalkostunum okkar til að hámarka hraða, nákvæmni og hagkvæmni. Þú getur einnig vistað uppflettiniðurstöður í gagnageymslum til að auðvelda niðurhal CSV og JSON skýrslna, auk háþróaðrar greiningar í gegnum vefviðmótið.

Samstillt HLR uppflettingar API

POST /hlr-lookup endapunkturinn vinnur úr einu farsímanúmeri (MSISDN) á hverja beiðni og skilar niðurstöðum samstundis í HTTP svartextanum. Niðurstöðurnar eru á JSON sniði og eru tilvalin fyrir rauntímaforrit, þar á meðal staðfestingu farsímanúmera, símtalsleiðarstjórnun og SMS skilaboðasendingar.

Samstillt API köll samanstanda af beinni HTTP beiðni og svari. Kerfið þitt sendir eitt MSISDN (farsímanúmer) á hverja beiðni og fær tafarlaust svar sem inniheldur rauntíma HLR uppflettiniðurstöður á JSON sniði. Þetta API er fínstillt fyrir notkunartilvik sem krefjast tafarlausrar staðfestingar og tengiprófana, svo sem svikavarna, VoIP símtalsleiðarstjórnunar og SMS gáttahámörkunar.

Ósamstillt HLR uppflettingar API

POST /hlr-lookups endapunkturinn er hannaður fyrir magnvinnslu og stórmagnsúrvinnslu, sem gerir þér kleift að senda allt að 1,000 MSISDN á hverja beiðni. Í stað þess að skila niðurstöðum samstundis notar þetta API sjálfvirka webhook til að senda niðurstöður smám saman til þjónsins þíns. Uppflettiniðurstöður eru skilaðar sem JSON hlutir í gegnum HTTP POST tilkynningar.

Ósamstillta API er fínstillt fyrir hraða, skilvirkni og sveigjanleika. Það útilokar nettöfvandamál sem tengjast samstilltum köllum, sem gerir það tilvalið fyrir fyrirtæki sem þurfa uppflettingar með háa afköst. Kerfið þitt sendir allt að 1,000 MSISDN á hverja beiðni og vettvangur okkar vinnur úr þeim samhliða og skilar niðurstöðum til baka til þjónsins þíns í gegnum HTTP webhook í lotum með allt að 1,000 niðurstöðum á hverja tilkynningu.

SDK (hugbúnaðarþróunarsett)

Hugbúnaðarþróunarsett okkar (SDK) fyrir PHP, NodeJS og Ruby einfalda samþættingarferlið og gera þér kleift að tengjast HLR Lookups API á skilvirkan hátt með lágmarks fyrirhöfn.

Þessi SDK bjóða upp á forsmíðaðar aðgerðir, meðhöndlun auðkenningar og skipulagðar API beiðnisniðmát sem stytta þróunartíma og tryggja bestu starfsvenjur.

Skoðaðu heildarlista yfir tiltæk SDK á GitHub og byrjaðu að samþætta í dag.

PHP

NodeJS

Ruby

1   include('HLRLookupClient.class.php');
2
3   $client = new HLRLookupClient(
4       'YOUR-API-KEY',
5       'YOUR-API-SECRET',
6       '/var/log/hlr-lookups.log'
7   );
8
9   $params = array('msisdn' => '+14156226819');
10  $response = $client->post('/hlr-lookup', $params);

Skoða á GitHub README.md

1   require('node-hlr-client');
2
3   let response = await client.post('/hlr-lookup', {msisdn: '+491788735000'});
4
5   if (response.status === 200) {
6      // lookup was successful
7      let data = response.data;
8   }

Skoða á GitHub README.md

1   require 'ruby_hlr_client/client'
2
3   client = HlrLookupsSDK::Client.new(
4       'YOUR-API-KEY',
5       'YOUR-API-SECRET',
6       '/var/log/hlr-lookups.log'
7   )
8
9   params = { :msisdn => '+14156226819' }
10  response = client.get('/hlr-lookup', params)

Skoða á GitHub README.md

Skruna upp

POST/hlr-lookupvarið

Framkvæmir samstillta HLR uppflettingu sem skilar rauntíma tengigögnum og flutningsgögnum farsímanúmera beint frá símafyrirtækjum. Þessi endapunktur hentar vel fyrir rauntímaforrit þar sem tímaviðkvæm kerfi þurfa tafarlausa staðfestingu á því hvort símanúmer sé aðgengilegt (tengt) eða óaðgengilegt (slökkt). Að auki hjálpar þetta til við að greina virk númer frá ógildum, óþekktum eða fölsuðum númerum.

Fyrir magnvinnslu stórra gagnasafna sem krefjast ekki tafarlausra niðurstaðna er mælt með ósamstilltum POST /hlr-lookups, sem er fínstillt fyrir háhraða magnvinnslu.

Ef þú leitar fyrst og fremst að flutningsgögnum farsímanúmera (MCCMNC) og þarft ekki rauntíma tengiupplýsingar, þá býður POST /mnp-lookup upp á hagkvæman valkost fyrir fyrirspurnir um númeraflutning.

Beiðni Árangursrík svarskil Villuskil Stöðutilvísun

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookup' \
          -d "@payload.json"

Gögn

{
   "msisdn":"+14156226819",
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdn`	string	Farsímanúmerið (MSISDN) sem á að fletta upp, gefið upp á alþjóðlegu sniði (t.d. +14156226819 eða 0014156226819). Landsnúmer verður að vera með.	null	skyldubundið
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa uppflettingu. Stilltu á `null` eða sleppu þessum færibreytu til að nota þitt sérsniðna leiðakerfi eða láta kerfið okkar sjálfkrafa ákveða bestu leiðina fyrir þessa uppflettingu.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
   "id":"f94ef092cb53",
   "msisdn":"+14156226819",
   "connectivity_status":"CONNECTED",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "imsi":"***************",
   "msin":"**********",
   "msc":"************",
   "original_network_name":"Verizon Wireless",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1",
   "is_ported":true,
   "ported_network_name":"T-Mobile US",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "is_roaming":false,
   "roaming_network_name":null,
   "roaming_country_name":null,
   "roaming_country_code":null,
   "roaming_country_prefix":null,
   "cost":"0.0100",
   "timestamp":"2020-08-07 19:16:17.676+0300",
   "storage":"SYNC-API-2020-08",
   "route":"IP1",
   "processing_status":"COMPLETED",
   "error_code":null,
   "error_description":null,
   "data_source":"LIVE_HLR",
   "routing_instruction":"STATIC:IP1"
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einkvæmt auðkenni sem úthlutað er á þessa uppflettingarbeiðni.	false
`msisdn`	string	Farsímanúmerið sem verið er að fletta upp, sniðið á alþjóðlegu formi (t.d. +14156226819 eða 0014156226819).	false
`connectivity_status`	string	Gefur til kynna hvort tengingarstaða númerisins hafi náðst. Möguleg gildi: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` eða `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa landakóði farsíma (MCC) og netkóði farsíma (MNC) sem auðkennir netið sem farsímanúmerið er nú tengt við.	true
`mcc`	string(3)	Þriggja stafa landakóði farsíma (MCC) sem auðkennir landið þar sem farsímanúmerið er skráð.	true
`mnc`	string(2\|3)	Tveggja eða þriggja stafa netkóði farsíma (MNC) sem auðkennir tiltekið net sem farsímanúmerið tilheyrir.	true
`imsi`	string	Alþjóðlegt auðkenni farsímanotanda (IMSI), einkvæmt auðkenni fyrir SIM-kortið sem tengt er þessu númeri. Framboð fer eftir uppsetningu nets.	true
`msin`	string(10)	Auðkennisnúmer farsímaáskriftar (MSIN) í gagnagrunni farsímafyrirtækisins. Framboð fer eftir uppsetningu nets.	true
`msc`	string(12)	Farsímaskiptistöð (MSC) sem sér um samskipti þessa áskrifanda. Framboð fer eftir uppsetningu nets.	true
`original_network_name`	string	Upprunalegt (innlent) nafn netrekanda sem tengt er þessu númeri.	true
`original_country_name`	string	Fullt nafn landsins þar sem farsímanúmerið var upphaflega skráð, gefið upp á ensku.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið þar sem farsímanúmerið var fyrst úthlutað.	true
`original_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) sem samsvarar upprunalega landi farsímanúmersins.	true
`is_ported`	boolean	Gefur til kynna hvort farsímanúmerið hafi verið flutt frá upprunalega netinu til annars rekanda.	true
`ported_network_name`	string	Nafn netrekanda sem farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_name`	string	Nafn landsins þar sem farsímanúmerið var flutt til, ef við á.	true
`ported_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið þar sem farsímanúmerið var flutt til, ef við á.	true
`ported_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) fyrir landið þar sem farsímanúmerið var flutt til, ef við á.	true
`is_roaming`	boolean	Gefur til kynna hvort farsímanúmerið sé nú í reiki á erlendu neti. Framboð á reikistöðu fer eftir farsímanetrekanda.	true
`roaming_network_name`	string	Nafn netsins sem farsímanúmerið er nú í reiki á, ef við á.	true
`roaming_country_name`	string	Nafn landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`roaming_country_code`	string(2)	Tveggja stafa ISO landakóði landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`roaming_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`cost`	string	Tugabrotagildi sett fram sem strengur, sem gefur til kynna uppflettingarkostnað í EUR.	true
`timestamp`	string	W3C-sniðið tímamerki með tímabelti sem tilgreinir hvenær uppflettingin var lokið.	true
`storage`	string	Nafn geymslu þar sem niðurstöður uppflettingar voru vistaðar. Þetta samsvarar skýrsluheitum og CSV niðurhölum sem eru aðgengileg í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem gefur til kynna leiðaraðferðina sem notuð var fyrir þessa uppflettingarbeiðni.	true
`processing_status`	string	Úrvinnsluniðurstaða uppflettingar. Möguleg gildi: `COMPLETED` (tókst), `REJECTED` (net óaðgengilegt, ekkert gjald lagt á) eða `FAILED` (villa kom upp við úrvinnslu).	false
`error_code`	integer	Valfrjáls innri villukóði sem veitir viðbótar greiningarupplýsingar fyrir þjónustuver.	true
`error_description`	string	Stutt skýring á tilteknum villukóða (ef einhver er) á ensku í látlausum texta.	true
`data_source`	string	Gagnagjafinn sem notaður var fyrir þessa beiðni. Möguleg gildi: `LIVE_HLR` (rauntíma HLR fyrirspurn) eða `MNP_DB` (föst gagnagrunnur fyrir flutning farsímanúmera). Sjá leiðarvalkosti fyrir nánari upplýsingar.	false
`routing_instruction`	string	Strengur aðskilinn með tvípunkti sem lýsir leiðarleiðbeiningum sem notaðar voru í beiðninni. Fyrsti hlutinn er `STATIC` þegar þú tilgreindir leið eða `AUTO` fyrir sjálfvirka leiðarval; annar hlutinn er leiðarauðkennið og fyrir sjálfvirkar leiðarbeiðnir sýnir þriðji hlutinn uppruna sem leiðarákvörðunin byggir á (þ.e. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`).	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Staða	Lýsing
CONNECTED	Númerið er gilt og síminn er tengdur við farsímanetið. Símtöl, SMS og önnur þjónusta ættu að ná til viðtakanda.
ABSENT	Númerið er gilt, en síminn er annaðhvort slökkt eða tímabundið utan netsviðs. Skilaboð eða símtöl berast hugsanlega ekki fyrr en tækið tengist aftur við netið.
INVALID_MSISDN	Númerið er ógilt eða ekki úthlutað til neins áskrifanda á farsímanetinu. Símtöl og skilaboð til þessa númers munu mistakast.
UNDETERMINED	Ekki var hægt að ákvarða tengistöðu númerisins. Þetta getur stafað af ógilt númeri, SS7 villuskilaboðum eða skorti á tengingu við farsímarekandann. Skoðaðu villukóðann og lýsinguna fyrir frekari greiningu.

Skruna upp

POST/hlr-lookupsvarið

Ræsir safnvinnslu af ósamstilltum HLR uppflettingum sem sækja rauntímagögn um tengingu og flutningsstöðu farsímanúmera frá netrekendum. Niðurstöður eru sendar með webhooks á þinn netþjón. Þessi aðferð er fínstillt fyrir vinnslu á stórum fjölda númera sem krefjast ekki tafarlausra svara, svo sem gagnagrunnshreinsun og sannprófun. Fyrir rauntímaforrit eins og símtalsleiðsögn eða SMS afhendingu skaltu íhuga að nota POST /hlr-lookup endapunktinn í staðinn.

Þessi endapunktur hentar vel fyrir magnvinnslu þegar markmiðið er að greina símanúmer sem eru aðgengileg (tengd) eða ótæk (síminn slökkt) á sama tíma og ógild, óúthlutuð eða fölsuð númer eru síuð út. Að auki veitir hann rauntíma flutningsstöðu (MCCMNC) ásamt tengingarupplýsingum.

Áður en þú notar þennan endapunkt skaltu ganga úr skugga um að webhook vefslóð sé stillt til að taka á móti niðurstöðum uppflettinga ósamstillt. Þú getur sett þetta upp í API stillingunum þínum.

Beiðni Árangursrík svarskil Villuskil Webhooks Stöðutilvísun

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookups' \
          -d "@payload.json"

Gögn

{
   "msisdns":["+14156226819","+491788735000","+905536939460"],
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdns`	array	Fylki af farsímanúmerum (MSISDN) á alþjóðlegu sniði (t.d. +14156226819 eða 0014156226819). Þú getur sett inn allt að 1000 númer í hverri beiðni.	null	skyldubundið
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa uppflettingu. Stilltu á `null` eða sleppu þessum færibreytu til að nota þitt sérsniðna leiðakerfi eða láta kerfið okkar sjálfkrafa ákveða bestu leiðina fyrir þessa uppflettingu.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
   "accepted":[
      {
         "id":"0424928f332e",
         "msisdn":"+491788735000"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "msisdn":"+31"
      }
   ],
   "rejected_count":1,
   "total_count":2,
   "cost":"0.01",
   "storage":"ASYNC-API-2020-08",
   "route":"IP1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`accepted`	array	Listi af hlutum sem innihalda einkvæm auðkenni og MSISDN númer sem hafa verið samþykkt til vinnslu.	false
`accepted_count`	integer	Heildarfjöldi MSISDN númera sem samþykkt voru til vinnslu.	false
`rejected`	array	Listi af hlutum sem innihalda einkvæm auðkenni og MSISDN númer sem hefur verið hafnað til vinnslu, venjulega vegna ógildra númera. Engin gjöld falla til vegna hafnaðra færslna.	false
`rejected_count`	integer	Heildarfjöldi MSISDN númera sem hafnað var vegna villna við sannprófun.	false
`total_count`	integer	Heildarfjöldi samþykktra og hafnaðra MSISDN númera sem send voru til vinnslu.	false
`cost`	string	Tugabrotsgildið sett fram sem strengur sem gefur til kynna heildarkostnað í EUR fyrir samþykktar uppflettingar.	false
`storage`	string	Heiti geymslu þar sem niðurstöður uppflettinga eru vistaðar, notað fyrir skýrslugerð og CSV niðurhal í gegnum vefviðmótið.	false
`route`	string(3\|4)	Þriggja eða fjögurra stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni. Inniheldur AUTO ef sjálfvirk leiðsögn byggð á númeri var beðin um.	false
`webhook_urls`	array	Webhook vefslóðirnar sem stilltar eru í API stillingunum þínum. Niðurstöður eru sendar hingað til baka.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Vinnsla vefkrókanna

Þegar beiðni hefur verið send byrjar kerfið okkar að vinna úr uppgefnum símanúmerum og sendir niðurstöðurnar á áður tilgreinda vefkrókaslóðina á þjóninum þínum. Niðurstöðurnar eru sendar sem HTTP POST beiðni með JSON hlut í meginmáli beiðninnar.

Auðkenning

Staðfestu vefkrókann með því að skoða X-Signatures HTTP hausinn.

X-Signatures hausinn inniheldur semíkommuskipaðan lista af undirskriftum. Hver undirskrift á listanum er mynduð með einu af API leyniorðunum sem stillt eru á reikningnum þínum. Til að staðfesta vefkrókann skaltu búa til SHA-256 kóða með API lyklinum þínum, leyniorðinu og óunnið HTTP meginmálið - samanberðu það síðan við undirskriftirnar á listanum.

Samsvörun staðfestir að beiðnin sé ósvikin og undirrituð með leyniorði sem þú hefur stjórn á.

Kóðadæmi

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Beiðnin er gild ef einhver af undirskriftunum í hausnum samsvarar SHA256 kóða sem reiknaður er út frá sameinaðri streng API lykilsins þíns, leyniorðsins og HTTP meginmálsins.

Staðfesting á móttöku

Gert er ráð fyrir að þjónninn þinn svari með HTTP stöðukóðanum 200 OK til að staðfesta móttöku. Ef annar svararkóði er sendur, tímamörk renna út (10 sekúndur) eða önnur afhendingarvandamál koma upp mun kerfið sjálfkrafa reyna vefkrókann aftur eftir eina mínútu. Ef beiðnin heldur áfram að mistakast munu endurtekningar fylgja veldisvísislegri biðstefnu með síðari tilraunum eftir 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 mínútur.

Þessi endurtekningaraðferð tryggir hámarks áreiðanleika við að afhenda uppflettingarniðurstöður til innviða þinna. Það lágmarkar hættuna á gagnatapi vegna tímabundinna netvandamála eða niðurtíma þjóns.

Gagnafarmur vefkróka

{
   "type":"HLR",
   "results":[
      {
         "id":"3b4ac4b6ed1b",
         "msisdn":"+905536939460",
         "connectivity_status":"CONNECTED",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "imsi":"28603XXXXXXXXXX",
         "msin":"XXXXXXXXXX",
         "msc":"XXXXXXXXXX",
         "original_network_name":"Turk Telekom (AVEA)",
         "original_country_name":"Turkey",
         "original_country_code":"TR",
         "original_country_prefix":"+90",
         "is_ported":false,
         "ported_network_name":null,
         "ported_country_name":null,
         "ported_country_code":null,
         "ported_country_prefix":null,
         "is_roaming":false,
         "roaming_network_name":null,
         "roaming_country_name":null,
         "roaming_country_code":null,
         "roaming_country_prefix":null,
         "cost":"0.0100",
         "timestamp":"2020-08-13 00:04:38.261+0300",
         "storage":"ASYNC-API-2020-08",
         "route":"IP1",
         "processing_status":"COMPLETED",
         "error_code":null,
         "error_description":null,
         "data_source":"LIVE_HLR",
         "routing_instruction":"STATIC:IP1"
      }
   ]
}

Eiginleikar Webhook Gagna

JSON hluturinn inniheldur eiginleikann type => HLR ásamt eiginleikanum results sem inniheldur lista af uppflettingarhlutum eins og skjalfest er hér að neðan.

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einkvæmt auðkenni sem úthlutað er á þessa uppflettingarbeiðni.	false
`msisdn`	string	Farsímanúmerið sem verið er að fletta upp, sniðið á alþjóðlegu formi (t.d. +14156226819 eða 0014156226819).	false
`connectivity_status`	string	Gefur til kynna hvort tengingarstaða númerisins hafi náðst. Möguleg gildi: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` eða `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa landakóði farsíma (MCC) og netkóði farsíma (MNC) sem auðkennir netið sem farsímanúmerið er nú tengt við.	true
`mcc`	string(3)	Þriggja stafa landakóði farsíma (MCC) sem auðkennir landið þar sem farsímanúmerið er skráð.	true
`mnc`	string(2\|3)	Tveggja eða þriggja stafa netkóði farsíma (MNC) sem auðkennir tiltekið net sem farsímanúmerið tilheyrir.	true
`imsi`	string	Alþjóðlegt auðkenni farsímanotanda (IMSI), einkvæmt auðkenni fyrir SIM-kortið sem tengt er þessu númeri. Framboð fer eftir uppsetningu nets.	true
`msin`	string(10)	Auðkennisnúmer farsímaáskriftar (MSIN) í gagnagrunni farsímafyrirtækisins. Framboð fer eftir uppsetningu nets.	true
`msc`	string(12)	Farsímaskiptistöð (MSC) sem sér um samskipti þessa áskrifanda. Framboð fer eftir uppsetningu nets.	true
`original_network_name`	string	Upprunalegt (innlent) nafn netrekanda sem tengt er þessu númeri.	true
`original_country_name`	string	Fullt nafn landsins þar sem farsímanúmerið var upphaflega skráð, gefið upp á ensku.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið þar sem farsímanúmerið var fyrst úthlutað.	true
`original_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) sem samsvarar upprunalega landi farsímanúmersins.	true
`is_ported`	boolean	Gefur til kynna hvort farsímanúmerið hafi verið flutt frá upprunalega netinu til annars rekanda.	true
`ported_network_name`	string	Nafn netrekanda sem farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_name`	string	Nafn landsins þar sem farsímanúmerið var flutt til, ef við á.	true
`ported_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið þar sem farsímanúmerið var flutt til, ef við á.	true
`ported_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) fyrir landið þar sem farsímanúmerið var flutt til, ef við á.	true
`is_roaming`	boolean	Gefur til kynna hvort farsímanúmerið sé nú í reiki á erlendu neti. Framboð á reikistöðu fer eftir farsímanetrekanda.	true
`roaming_network_name`	string	Nafn netsins sem farsímanúmerið er nú í reiki á, ef við á.	true
`roaming_country_name`	string	Nafn landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`roaming_country_code`	string(2)	Tveggja stafa ISO landakóði landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`roaming_country_prefix`	string	Alþjóðleg símakóði (símakóði lands) landsins þar sem farsímanúmerið er nú í reiki, ef við á.	true
`cost`	string	Tugabrotagildi sett fram sem strengur, sem gefur til kynna uppflettingarkostnað í EUR.	true
`timestamp`	string	W3C-sniðið tímamerki með tímabelti sem tilgreinir hvenær uppflettingin var lokið.	true
`storage`	string	Nafn geymslu þar sem niðurstöður uppflettingar voru vistaðar. Þetta samsvarar skýrsluheitum og CSV niðurhölum sem eru aðgengileg í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem gefur til kynna leiðaraðferðina sem notuð var fyrir þessa uppflettingarbeiðni.	true
`processing_status`	string	Úrvinnsluniðurstaða uppflettingar. Möguleg gildi: `COMPLETED` (tókst), `REJECTED` (net óaðgengilegt, ekkert gjald lagt á) eða `FAILED` (villa kom upp við úrvinnslu).	false
`error_code`	integer	Valfrjáls innri villukóði sem veitir viðbótar greiningarupplýsingar fyrir þjónustuver.	true
`error_description`	string	Stutt skýring á tilteknum villukóða (ef einhver er) á ensku í látlausum texta.	true
`data_source`	string	Gagnagjafinn sem notaður var fyrir þessa beiðni. Möguleg gildi: `LIVE_HLR` (rauntíma HLR fyrirspurn) eða `MNP_DB` (föst gagnagrunnur fyrir flutning farsímanúmera). Sjá leiðarvalkosti fyrir nánari upplýsingar.	false
`routing_instruction`	string	Strengur aðskilinn með tvípunkti sem lýsir leiðarleiðbeiningum sem notaðar voru í beiðninni. Fyrsti hlutinn er `STATIC` þegar þú tilgreindir leið eða `AUTO` fyrir sjálfvirka leiðarval; annar hlutinn er leiðarauðkennið og fyrir sjálfvirkar leiðarbeiðnir sýnir þriðji hlutinn uppruna sem leiðarákvörðunin byggir á (þ.e. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`).	false

Staða	Lýsing
CONNECTED	Númerið er gilt og síminn er tengdur við farsímanetið. Símtöl, SMS og önnur þjónusta ættu að ná til viðtakanda.
ABSENT	Númerið er gilt, en síminn er annaðhvort slökkt eða tímabundið utan netsviðs. Skilaboð eða símtöl berast hugsanlega ekki fyrr en tækið tengist aftur við netið.
INVALID_MSISDN	Númerið er ógilt eða ekki úthlutað til neins áskrifanda á farsímanetinu. Símtöl og skilaboð til þessa númers munu mistakast.
UNDETERMINED	Ekki var hægt að ákvarða tengistöðu númerisins. Þetta getur stafað af ógilt númeri, SS7 villuskilaboðum eða skorti á tengingu við farsímarekandann. Skoðaðu villukóðann og lýsinguna fyrir frekari greiningu.

Skruna upp

POST/mnp-lookupvarið

Framkvæmir samstillta MNP uppflettingu og veitir upplýsingar um flutningshæfni símanúmera og netupplýsingar. Þessi endapunktur hentar ef meginmarkmið þitt er að sækja núverandi MCCMNC tiltekins farsímanúmers og staðsetja upprunalegt og núverandi net í rauntíma.

Fyrir magnvinnslu stórra gagnasafna sem krefjast ekki tafarlausra niðurstaðna er mælt með ósamstilltum POST /mnp-lookups, sem er fínstillt fyrir háhraða magnvinnslu.

MNP fyrirspurnir ákvarða á áreiðanlegan hátt flutningshæfni og netupplýsingar en gefa ekki til kynna hvort viðkomandi farsími sé tengdur neti og tiltækur. Til að sækja rauntíma tengiupplýsingar skaltu nota POST /hlr-lookup endapunktinn í staðinn.

Beiðni Árangursrík svarskil Villuskil

curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookup' \
          -d "@payload.json"

Gögn

{
   "msisdn":"+14156226819",
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdn`	string	Farsímanúmerið (MSISDN) sem á að fletta upp, gefið upp á alþjóðlegu sniði (t.d. +14156226819 eða 0014156226819). Landsnúmer verður að vera með.	null	skyldubundið
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa uppflettingu. Stilltu á `null` eða sleppu þessum færibreytu til að nota þitt sérsniðna leiðakerfi eða láta kerfið okkar sjálfkrafa ákveða bestu leiðina fyrir þessa uppflettingu.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
   "id":"e428acb1c0ae",
   "msisdn":"+14156226819",
   "query_status":"OK",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "is_ported":true,
   "original_network_name":"Verizon Wireless:6006 - SVR/2",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1415",
   "ported_network_name":"T-Mobile US:6529 - SVR/2",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "extra":"LRN:4154250000",
   "cost":"0.0050",
   "timestamp":"2020-08-05 21:21:33.490+0300",
   "storage":"WEB-CLIENT-SOLO-MNP-2020-08",
   "route":"PTX",
   "error_code":null
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einstakt 12 stafa auðkenni fyrir þessa uppflettingu.	false
`msisdn`	string	Farsímanúmerið sem metið var í þessari uppflettingarbeiðni.	false
`query_status`	string	Gefur til kynna hvort sótt hafi tekist að sækja upplýsingar um flutningshæfni og net. Möguleg gildi eru `OK` eða `FAILED`.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa MCCMNC (landakóði farsíma og netkóði farsíma) sem auðkennir netið sem farsímanúmerið tilheyrir nú.	true
`mcc`	string(3)	Þriggja stafa MCC (landakóði farsíma) sem táknar landið sem tengist núverandi neti farsímanúmersins.	true
`mnc`	string(2\|3)	Tveggja eða þriggja stafa MNC (netkóði farsíma) sem auðkennir núverandi netrekanda farsímanúmersins.	true
`is_ported`	boolean	Gefur til kynna hvort símanúmerið hafi verið flutt frá upprunalegu neti sínu til nýs rekanda.	true
`original_network_name`	string	Handahófskenndar strengur (á ensku) sem tilgreinir nafn upprunalegs netrekanda skoðaða farsímanúmersins.	true
`original_country_name`	string	Handahófskenndar strengur (á ensku) sem gefur til kynna upprunalegt land skoðaða farsímanúmersins.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar upprunalegt land skoðaða farsímanúmersins.	true
`original_country_prefix`	string	Símakóði upprunalega landsins sem tengist skoðaða farsímanúmerinu.	true
`ported_network_name`	string	Tilgreinir netrekandann sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_name`	string	Tilgreinir landið sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_prefix`	string	Símakóði landsins sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`extra`	string	Handahófskenndar strengur sem veitir valfrjálsar viðbótarupplýsingar um símanúmerið.	true
`cost`	string	Tugabrotagildi, táknað sem strengur, sem gefur til kynna kostnað í EUR fyrir þessa uppflettingu.	true
`timestamp`	string	W3C-sniðinn tímastimpill, þar með talið upplýsingar um tímabelti, sem gefur til kynna hvenær uppflettingin var lokið.	true
`storage`	string	Geymslunafn (eða skýrslunafn) sem niðurstöður uppflettingar voru bættar við. Þetta er notað fyrir CSV niðurhal og skýrslugerð í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni.	true
`error_code`	integer	Valfrjáls innri villukóði sem veitir viðbótarupplýsingar fyrir greiningu þjónustuvers.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

POST/mnp-lookupsvarið

Hefur runuleit af ósamstilltum MNP (flutningur farsímanúmera) uppflettingum, sækir núverandi MCCMNC og staðsetur upprunalegt og núverandi net í rauntíma. Niðurstöður eru sendar með webhooks á þinn netþjón. Þessi aðferð er fínstillt fyrir vinnslu á stórum fjölda númera sem krefjast ekki tafarlausra svara, svo sem gagnagrunnshreinsun og sannprófun. Fyrir rauntímaforrit eins og símtalsleiðsögn eða SMS afhendingu skaltu íhuga að nota POST /mnp-lookup endapunktinn í staðinn.

MNP fyrirspurnir ákvarða á áreiðanlegan hátt flutningshæfni og netupplýsingar en gefa ekki til kynna hvort viðkomandi farsími sé tengdur neti og tiltækur. Til að sækja rauntíma tengiupplýsingar skaltu nota POST /hlr-lookups endapunktinn í staðinn.

Áður en þú notar þennan endapunkt skaltu ganga úr skugga um að webhook vefslóð sé stillt til að taka á móti niðurstöðum uppflettinga ósamstillt. Þú getur sett þetta upp í API stillingunum þínum.

Beiðni Árangursrík svarskil Villuskil Webhooks

curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookups' \
          -d "@payload.json"

Gögn

{
   "msisdns":["+14156226819","+491788735000","+905536939460"],
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdns`	array	Fylki af farsímanúmerum (MSISDN) á alþjóðlegu sniði (t.d. +14156226819 eða 0014156226819). Þú getur sett inn allt að 1000 númer í hverri beiðni.	null	skyldubundið
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa uppflettingu. Stilltu á `null` eða sleppu þessum færibreytu til að nota sérsniðna leiðarkortið þitt eða láta kerfið okkar sjálfkrafa ákvarða bestu leiðirnar fyrir þessa beiðni.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
   "accepted":[
      {
         "id":"0424928f332e",
         "msisdn":"+491788735000"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "msisdn":"+31"
      }
   ],
   "rejected_count":1,
   "total_count":2,
   "cost":"0.01",
   "storage":"ASYNC-API-2020-08",
   "route":"IP1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`accepted`	array	Listi af hlutum sem innihalda einkvæm auðkenni og MSISDN númer sem hafa verið samþykkt til vinnslu.	false
`accepted_count`	integer	Heildarfjöldi MSISDN númera sem samþykkt voru til vinnslu.	false
`rejected`	array	Listi af hlutum sem innihalda einkvæm auðkenni og MSISDN númer sem hefur verið hafnað til vinnslu, venjulega vegna ógildra númera. Engin gjöld falla til vegna hafnaðra færslna.	false
`rejected_count`	integer	Heildarfjöldi MSISDN númera sem hafnað var vegna villna við sannprófun.	false
`total_count`	integer	Heildarfjöldi samþykktra og hafnaðra MSISDN númera sem send voru til vinnslu.	false
`cost`	string	Tugabrotsgildið sett fram sem strengur sem gefur til kynna heildarkostnað í EUR fyrir samþykktar uppflettingar.	false
`storage`	string	Heiti geymslu þar sem niðurstöður uppflettinga eru vistaðar, notað fyrir skýrslugerð og CSV niðurhal í gegnum vefviðmótið.	false
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni.	false
`webhook_urls`	array	Webhook vefslóðirnar sem stilltar eru í API stillingunum þínum. Niðurstöður eru sendar hingað til baka.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Vinnsla vefkrókanna

Þegar beiðni hefur verið send byrjar kerfið okkar að vinna úr uppgefnum símanúmerum og sendir niðurstöðurnar á áður tilgreinda vefkrókaslóðina á þjóninum þínum. Niðurstöðurnar eru sendar sem HTTP POST beiðni með JSON hlut í meginmáli beiðninnar.

Auðkenning

Staðfestu vefkrókann með því að skoða X-Signatures HTTP hausinn.

X-Signatures hausinn inniheldur semíkommuskipaðan lista af undirskriftum. Hver undirskrift á listanum er mynduð með einu af API leyniorðunum sem stillt eru á reikningnum þínum. Til að staðfesta vefkrókann skaltu búa til SHA-256 kóða með API lyklinum þínum, leyniorðinu og óunnið HTTP meginmálið - samanberðu það síðan við undirskriftirnar á listanum.

Samsvörun staðfestir að beiðnin sé ósvikin og undirrituð með leyniorði sem þú hefur stjórn á.

Kóðadæmi

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Beiðnin er gild ef einhver af undirskriftunum í hausnum samsvarar SHA256 kóða sem reiknaður er út frá sameinaðri streng API lykilsins þíns, leyniorðsins og HTTP meginmálsins.

Staðfesting á móttöku

Gert er ráð fyrir að þjónninn þinn svari með HTTP stöðukóðanum 200 OK til að staðfesta móttöku. Ef annar svararkóði er sendur, tímamörk renna út (10 sekúndur) eða önnur afhendingarvandamál koma upp mun kerfið sjálfkrafa reyna vefkrókann aftur eftir eina mínútu. Ef beiðnin heldur áfram að mistakast munu endurtekningar fylgja veldisvísislegri biðstefnu með síðari tilraunum eftir 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 mínútur.

Þessi endurtekningaraðferð tryggir hámarks áreiðanleika við að afhenda uppflettingarniðurstöður til innviða þinna. Það lágmarkar hættuna á gagnatapi vegna tímabundinna netvandamála eða niðurtíma þjóns.

Gagnafarmur vefkróka

{
    "type":"MNP",
    "results":[
        {
           "id":"e428acb1c0ae",
           "msisdn":"+14156226819",
           "query_status":"OK",
           "mccmnc":"310260",
           "mcc":"310",
           "mnc":"260",
           "is_ported":true,
           "original_network_name":"Verizon Wireless:6006 - SVR/2",
           "original_country_name":"United States",
           "original_country_code":"US",
           "original_country_prefix":"+1415",
           "ported_network_name":"T-Mobile US:6529 - SVR/2",
           "ported_country_name":"United States",
           "ported_country_code":"US",
           "ported_country_prefix":"+1",
           "extra":"LRN:4154250000",
           "cost":"0.0050",
           "timestamp":"2020-08-05 21:21:33.490+0300",
           "storage":"WEB-CLIENT-SOLO-MNP-2020-08",
           "route":"PTX",
           "error_code":null
        }
    ]
}

Eiginleikar Webhook Gagna

JSON hluturinn inniheldur eiginleikann type => MNP ásamt eiginleikanum results sem inniheldur lista af uppflettingarhlutum eins og skjalfest er hér að neðan.

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einstakt 12 stafa auðkenni fyrir þessa uppflettingu.	false
`msisdn`	string	Farsímanúmerið sem metið var í þessari uppflettingarbeiðni.	false
`query_status`	string	Gefur til kynna hvort sótt hafi tekist að sækja upplýsingar um flutningshæfni og net. Möguleg gildi eru `OK` eða `FAILED`.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa MCCMNC (landakóði farsíma og netkóði farsíma) sem auðkennir netið sem farsímanúmerið tilheyrir nú.	true
`mcc`	string(3)	Þriggja stafa MCC (landakóði farsíma) sem táknar landið sem tengist núverandi neti farsímanúmersins.	true
`mnc`	string(2\|3)	Tveggja eða þriggja stafa MNC (netkóði farsíma) sem auðkennir núverandi netrekanda farsímanúmersins.	true
`is_ported`	boolean	Gefur til kynna hvort símanúmerið hafi verið flutt frá upprunalegu neti sínu til nýs rekanda.	true
`original_network_name`	string	Handahófskenndar strengur (á ensku) sem tilgreinir nafn upprunalegs netrekanda skoðaða farsímanúmersins.	true
`original_country_name`	string	Handahófskenndar strengur (á ensku) sem gefur til kynna upprunalegt land skoðaða farsímanúmersins.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar upprunalegt land skoðaða farsímanúmersins.	true
`original_country_prefix`	string	Símakóði upprunalega landsins sem tengist skoðaða farsímanúmerinu.	true
`ported_network_name`	string	Tilgreinir netrekandann sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_name`	string	Tilgreinir landið sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_code`	string(2)	Tveggja stafa ISO landakóði sem táknar landið sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`ported_country_prefix`	string	Símakóði landsins sem skoðaða farsímanúmerið hefur verið flutt til, ef við á.	true
`extra`	string	Handahófskenndar strengur sem veitir valfrjálsar viðbótarupplýsingar um símanúmerið.	true
`cost`	string	Tugabrotagildi, táknað sem strengur, sem gefur til kynna kostnað í EUR fyrir þessa uppflettingu.	true
`timestamp`	string	W3C-sniðinn tímastimpill, þar með talið upplýsingar um tímabelti, sem gefur til kynna hvenær uppflettingin var lokið.	true
`storage`	string	Geymslunafn (eða skýrslunafn) sem niðurstöður uppflettingar voru bættar við. Þetta er notað fyrir CSV niðurhal og skýrslugerð í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni.	true
`error_code`	integer	Valfrjáls innri villukóði sem veitir viðbótarupplýsingar fyrir greiningu þjónustuvers.	true

Skruna upp

POST/nt-lookupvarið

Framkvæmir samstillta númeragerðaruppflettingu (NT). Þessi endapunktur hentar vel ef meginmarkmið þitt er að ákvarða hvort gefin símanúmer tilheyri jarðlínu-, farsíma-, yfirverðsgjaldsskrá-, VoIP-, símboða- eða öðrum númerakerfi í rauntíma.

NT fyrirspurnir greina númeragerð á áreiðanlegan hátt, en þær gefa ekki til kynna hvort viðkomandi númer sé tengdur við net og aðgengilegt. Til að fá rauntímaupplýsingar um tengingu, vinsamlegast notaðu POST /hlr-lookup endapunktinn.

Ef notkunartilvikið þitt krefst nákvæmra nets- og flutningsupplýsinga (MCCMNC) en ekki rauntíma tengingarstöðu, vinsamlegast notaðu POST /mnp-lookup endapunktinn fyrir farsímanúmeraflutningsfyrirspurnir.

Beiðni Árangursrík svarskil Villuskil Gerðartilvísun

curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookup' \
          -d "@payload.json"

Gögn

{
   "number":"+14156226819",
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`number`	string	Símanúmer á alþjóðlegu sniði (t.d. +4989702626 eða 004989702626).	null	mandatory
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa uppflettingu. Stilltu á `null` eða slepptu þessum færibreytu til að nota sérsniðna leiðakortið þitt eða láta kerfið okkar ákvarða sjálfvirkt bestu leiðirnar fyrir þessa beiðni.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
     "id":"2ed0788379c6",
     "number":"+4989702626",
     "number_type":"LANDLINE",
     "query_status":"OK",
     "is_valid":true,
     "invalid_reason":null,
     "is_possibly_ported":false,
     "is_vanity_number":false,
     "qualifies_for_hlr_lookup":false,
     "mccmnc":null,
     "mcc":null,
     "mnc":null,
     "original_network_name":null,
     "original_country_name":"Germany",
     "original_country_code":"DE",
     "regions":[
        "Munich"
     ],
     "timezones":[
        "Europe/Berlin"
     ],
     "info_text":"This is a landline number.",
     "cost":"0.0050",
     "timestamp":"2015-12-04 10:36:41.866283+00",
     "storage":"SYNC-API-NT-2015-12",
     "route":"LC1"
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einkvæmt auðkenni sem úthlutað er á þessa uppflettingarbeiðni.	false
`number`	string	Símanúmerið sem var metið við þessa uppflettingarbeiðni.	false
`number_type`	string	Greind númerategund. Möguleg gildi eru: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Gefur til kynna hvort upplýsingar um númerategund hafi náðst. Skilar `OK` ef vel tókst, eða `FAILED` ef uppfletting mistókst.	false
`is_valid`	boolean	Gefur til kynna hvort símanúmerið sé setningarfræðilega gilt.	true
`invalid_reason`	string	Skilaboð á ensku sem tilgreina hvers vegna símanúmerið telst ógilt (t.d. "too short" eða "invalid prefix"), eða `null` ef númerið er gilt.	true
`is_possibly_ported`	boolean	Gefur til kynna hvort símanúmerið kunni að hafa verið flutt frá upprunalegum rekstraraðila til annars símafyrirtækis. Fyrir endanlegar upplýsingar um flutning skal nota MNP uppflettingar.	true
`is_vanity_number`	boolean	Gefur til kynna hvort símanúmerið sé sérsniðið númer sem inniheldur bókstafi.	true
`qualifies_for_hlr_lookup`	boolean	Gefur til kynna hvort símanúmerið sé hæft fyrir frekari fyrirspurnir í gegnum HLR uppflettingar.	true
`mccmnc`	string(5\|6)	Fimm eða sex stafa strengur sem táknar MCCMNC parið (farsímakóði lands og farsímanetkóði) sem auðkennir upprunalegt net farsímanúmersins.	true
`mcc`	string(3)	Þrír stafir sem tákna MCC (farsímakóði lands) sem auðkennir landið sem tengist upprunalega farsímaneti númersins.	true
`mnc`	string(2\|3)	Tveir eða þrír stafir sem tákna MNC (farsímanetkóði) sem auðkennir upprunalegan farsímarekstraraðila númersins.	true
`original_network_name`	string	Texti á ensku sem tilgreinir nafn upprunalegs netrekstraraðila farsímanúmersins.	true
`original_country_name`	string	Texti á ensku sem tilgreinir upprunalegt land farsímanúmersins.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem gefur til kynna upprunalegt land farsímanúmersins.	true
`regions`	array	Listi yfir lesanleg heiti á ensku sem tilgreina landfræðilegt svæði eða svæði sem tengjast þessu símanúmeri.	true
`timezones`	array	Listi yfir tímabelti (á Olson sniði) sem tengjast þessu símanúmeri.	true
`info_text`	string	Texti sem getur innihaldið viðbótarupplýsingar um símanúmerið.	true
`cost`	string	Tugabrotagildi sem strengur, sem gefur til kynna kostnað (í EUR) við þessa uppflettingu.	true
`timestamp`	string	W3C snið tímastimpill (með tímabelti) sem gefur til kynna hvenær uppflettingin lauk.	true
`storage`	string	Tilgreinir heiti geymslu þar sem niðurstöður uppflettingar hafa verið vistaðar. Þetta samsvarar skýrsluheitinu sem notað er fyrir CSV niðurhal og greiningar í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Tegund	Lýsing
LANDLINE	Jarðlínusímanúmer.
MOBILE	Farsímanúmer. Uppfyllir skilyrði fyrir HLR uppflettingar til að fá viðbótarupplýsingar um tengistöðu, net, flutningshæfni og reikiupplýsingar.
MOBILE_OR_LANDLINE	Jarðlínu- eða farsímanúmer. Gæti uppfyllt skilyrði fyrir HLR uppflettingu.
TOLL_FREE	Gjaldfrjáls símanúmer.
PREMIUM_RATE	Aukagjaldssímanúmer með viðbótargjöldum.
SHARED_COST	Símanúmer með skiptum kostnaði. Venjulega ódýrara en aukagjaldssímanúmer.
VOIP	Voice over IP símanúmer. Inniheldur TSoIP símanúmer (Telephony Service over IP).
PAGER	Símboðssímanúmer. Venjulega engin raddvirkni.
UAN	Almennt aðgangsnúmer (fyrirtækjanúmer). Getur verið beint á tiltekin skrifstofur en gerir kleift að nota eitt númer fyrir fyrirtækið.
VOICEMAIL	Talhólfsímanúmer.
UNKNOWN	Ekki tókst að ákvarða númerategund.

Skruna upp

POST/nt-lookups varið

Þessi endapunktur keyrir röð af ósamstilltum númerategundarleitum með niðurstöðum sem sendar eru aftur á þjóninn þinn í gegnum webhook. Hann hentar ef meginmarkmið þitt er að ákvarða hvort tiltekin símanúmer tilheyri jarðlínu-, farsíma-, aukagjaldsnúmerum, VoIP, símboðum eða öðrum númeraáætlunum. Fínstillt fyrir hraða vinnslu á miklu magni númera, þessi endapunktur er tilvalinn fyrir magnvinnslu (t.d. gagnagrunnshreinsunar). Fyrir rauntímavinnslu og tímakrafa notkunartilvik, vinsamlegast notaðu POST /nt-lookup endapunktinn í staðinn.

Þú þarft að tilgreina webhook vefslóð í API stillingum þínum sem forsendur til að keyra þennan endapunkt.

Beiðni Árangursrík svarskil Villuskil Webhooks Gerðartilvísun

curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookups' \
          -d "@payload.json"

Gögn

{
   "numbers":["+14156226819","+4989702626"],
   "route":null,
   "storage":null
}

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`numbers`	array	Fylki af símanúmerum á alþjóðlegu sniði (t.d. +14156226819 eða 004989702626). Að hámarki 1000 númer má hafa með í hverri beiðni.	null	skyldubundið
`route`	string(3)	Valfrjáls þriggja stafa auðkenni sem tilgreinir leiðina fyrir þessa leit. Stilltu á `null` eða slepptu þessum breytu til að nota sérsniðna leiðarkortið þitt eða láta kerfið okkar ákvarða sjálfkrafa bestu leiðina fyrir þessa beiðni.	null	valfrjálst
`storage`	string	Valfrjálst geymsluauðkenni sem tilgreinir skýrsluna þar sem niðurstöður verða vistaðar fyrir handvirka yfirferð, greiningar og skýrslugerð. Kerfið bætir sjálfkrafa við tímastimpli með núverandi mánuði. Ef sleppt eða stillt á `null`, mun kerfið sjálfkrafa flokka niðurstöður eftir mánuðum í skýrsluhaldi.	null	valfrjálst

{
   "accepted":[
      {
         "id":"9f8a52cfa7d2",
         "number":"+905536939460"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "number":"+31"
      }
   ],
   "rejected_count":2,
   "total_count":3,
   "cost":0.005,
   "storage":"ASYNC-API-NT-2020-08",
   "route":"LC1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`accepted`	array	Fylki af hlutum, hver með einstakt auðkenni og símanúmer sem hefur verið samþykkt til vinnslu.	false
`accepted_count`	integer	Heildarfjöldi símanúmera sem samþykkt voru til vinnslu.	false
`rejected`	array	Fylki af hlutum, hver með einstakt auðkenni og símanúmer sem var hafnað til vinnslu. Venjulega eru þessi númer ógild og engin gjöld eru innheimt.	false
`rejected_count`	integer	Heildarfjöldi símanúmera sem var hafnað til vinnslu.	false
`total_count`	integer	Heildarfjöldi samþykktra og hafnaðra símanúmera sem send voru til vinnslu.	false
`cost`	string	Strengur sem táknar tugabrotsgildi sem gefur til kynna kostnað í EUR fyrir þessar leitir.	false
`storage`	string	Heiti geymslu (skýrslu) þar sem leitarniðurstöður hafa verið vistaðar. Þetta heiti er notað fyrir CSV niðurhal og greiningar í gegnum vefviðmótið.	false
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa leitarbeiðni.	false
`webhook_urls`	array	Webhook vefslóðirnar sem stilltar eru í API stillingunum þínum. Niðurstöður eru sendar hingað til baka.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Vinnsla vefkrókanna

Þegar beiðni hefur verið send byrjar kerfið okkar að vinna úr uppgefnum símanúmerum og sendir niðurstöðurnar á áður tilgreinda vefkrókaslóðina á þjóninum þínum. Niðurstöðurnar eru sendar sem HTTP POST beiðni með JSON hlut í meginmáli beiðninnar.

Auðkenning

Staðfestu vefkrókann með því að skoða X-Signatures HTTP hausinn.

X-Signatures hausinn inniheldur semíkommuskipaðan lista af undirskriftum. Hver undirskrift á listanum er mynduð með einu af API leyniorðunum sem stillt eru á reikningnum þínum. Til að staðfesta vefkrókann skaltu búa til SHA-256 kóða með API lyklinum þínum, leyniorðinu og óunnið HTTP meginmálið - samanberðu það síðan við undirskriftirnar á listanum.

Samsvörun staðfestir að beiðnin sé ósvikin og undirrituð með leyniorði sem þú hefur stjórn á.

Kóðadæmi

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Beiðnin er gild ef einhver af undirskriftunum í hausnum samsvarar SHA256 kóða sem reiknaður er út frá sameinaðri streng API lykilsins þíns, leyniorðsins og HTTP meginmálsins.

Staðfesting á móttöku

Gert er ráð fyrir að þjónninn þinn svari með HTTP stöðukóðanum 200 OK til að staðfesta móttöku. Ef annar svararkóði er sendur, tímamörk renna út (10 sekúndur) eða önnur afhendingarvandamál koma upp mun kerfið sjálfkrafa reyna vefkrókann aftur eftir eina mínútu. Ef beiðnin heldur áfram að mistakast munu endurtekningar fylgja veldisvísislegri biðstefnu með síðari tilraunum eftir 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 mínútur.

Þessi endurtekningaraðferð tryggir hámarks áreiðanleika við að afhenda uppflettingarniðurstöður til innviða þinna. Það lágmarkar hættuna á gagnatapi vegna tímabundinna netvandamála eða niðurtíma þjóns.

Gagnafarmur vefkróka

{
   "type":"NT",
   "results":[
      {
         "id":"9f8a52cfa7d2",
         "number":"+905536939460",
         "numbertype":"MOBILE",
         "state":"COMPLETED",
         "isvalid":"Yes",
         "invalidreason":null,
         "ispossiblyported":"Yes",
         "isvanitynumber":"No",
         "qualifiesforhlrlookup":"Yes",
         "originalcarrier":"Turk Telekom (AVEA)",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "countrycode":"TR",
         "regions":[
            "Turkey"
         ],
         "timezones":[
            "Europe\/Istanbul"
         ],
         "infotext":"This number qualifies for HLR lookups. Determine if this subscriber number is connected, absent or invalid by running an HLR lookup. This is a mobile number and might be in roaming state. Run an HLR lookup to obtain roaming information (if available). This number is possibly ported and the carrier information might be inaccurate. To obtain portability information run an HLR lookup.",
         "usercharge":"0.0050",
         "inserttime":"2020-08-13 01:57:15.897+0300",
         "storage":"ASYNC-API-NT-2020-08",
         "route":"LC1",
         "interface":"Async API"
      }
   ]
}

Eiginleikar Webhook Gagna

JSON hluturinn inniheldur eiginleikann type => NT ásamt eiginleikanum results sem inniheldur lista af uppflettingarhlutum eins og skjalfest er hér að neðan.

Nafn	Tegund	Lýsing	Má vera tómt
`id`	string(12)	Einkvæmt auðkenni sem úthlutað er á þessa uppflettingarbeiðni.	false
`number`	string	Símanúmerið sem var metið við þessa uppflettingarbeiðni.	false
`number_type`	string	Greind númerategund. Möguleg gildi eru: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Gefur til kynna hvort upplýsingar um númerategund hafi náðst. Skilar `OK` ef vel tókst, eða `FAILED` ef uppfletting mistókst.	false
`is_valid`	boolean	Gefur til kynna hvort símanúmerið sé setningarfræðilega gilt.	true
`invalid_reason`	string	Skilaboð á ensku sem tilgreina hvers vegna símanúmerið telst ógilt (t.d. "too short" eða "invalid prefix"), eða `null` ef númerið er gilt.	true
`is_possibly_ported`	boolean	Gefur til kynna hvort símanúmerið kunni að hafa verið flutt frá upprunalegum rekstraraðila til annars símafyrirtækis. Fyrir endanlegar upplýsingar um flutning skal nota MNP uppflettingar.	true
`is_vanity_number`	boolean	Gefur til kynna hvort símanúmerið sé sérsniðið númer sem inniheldur bókstafi.	true
`qualifies_for_hlr_lookup`	boolean	Gefur til kynna hvort símanúmerið sé hæft fyrir frekari fyrirspurnir í gegnum HLR uppflettingar.	true
`mccmnc`	string(5\|6)	Fimm eða sex stafa strengur sem táknar MCCMNC parið (farsímakóði lands og farsímanetkóði) sem auðkennir upprunalegt net farsímanúmersins.	true
`mcc`	string(3)	Þrír stafir sem tákna MCC (farsímakóði lands) sem auðkennir landið sem tengist upprunalega farsímaneti númersins.	true
`mnc`	string(2\|3)	Tveir eða þrír stafir sem tákna MNC (farsímanetkóði) sem auðkennir upprunalegan farsímarekstraraðila númersins.	true
`original_network_name`	string	Texti á ensku sem tilgreinir nafn upprunalegs netrekstraraðila farsímanúmersins.	true
`original_country_name`	string	Texti á ensku sem tilgreinir upprunalegt land farsímanúmersins.	true
`original_country_code`	string(2)	Tveggja stafa ISO landakóði sem gefur til kynna upprunalegt land farsímanúmersins.	true
`regions`	array	Listi yfir lesanleg heiti á ensku sem tilgreina landfræðilegt svæði eða svæði sem tengjast þessu símanúmeri.	true
`timezones`	array	Listi yfir tímabelti (á Olson sniði) sem tengjast þessu símanúmeri.	true
`info_text`	string	Texti sem getur innihaldið viðbótarupplýsingar um símanúmerið.	true
`cost`	string	Tugabrotagildi sem strengur, sem gefur til kynna kostnað (í EUR) við þessa uppflettingu.	true
`timestamp`	string	W3C snið tímastimpill (með tímabelti) sem gefur til kynna hvenær uppflettingin lauk.	true
`storage`	string	Tilgreinir heiti geymslu þar sem niðurstöður uppflettingar hafa verið vistaðar. Þetta samsvarar skýrsluheitinu sem notað er fyrir CSV niðurhal og greiningar í vefviðmótinu.	true
`route`	string(3)	Þriggja stafa auðkenni sem tilgreinir leiðina sem notuð var fyrir þessa uppflettingarbeiðni.	true

Tegund	Lýsing
LANDLINE	Jarðlínusímanúmer.
MOBILE	Farsímanúmer. Uppfyllir skilyrði fyrir HLR uppflettingar til að fá viðbótarupplýsingar um tengistöðu, net, flutningshæfni og reikiupplýsingar.
MOBILE_OR_LANDLINE	Jarðlínu- eða farsímanúmer. Gæti uppfyllt skilyrði fyrir HLR uppflettingu.
TOLL_FREE	Gjaldfrjáls símanúmer.
PREMIUM_RATE	Aukagjaldssímanúmer með viðbótargjöldum.
SHARED_COST	Símanúmer með skiptum kostnaði. Venjulega ódýrara en aukagjaldssímanúmer.
VOIP	Voice over IP símanúmer. Inniheldur TSoIP símanúmer (Telephony Service over IP).
PAGER	Símboðssímanúmer. Venjulega engin raddvirkni.
UAN	Almennt aðgangsnúmer (fyrirtækjanúmer). Getur verið beint á tiltekin skrifstofur en gerir kleift að nota eitt númer fyrir fyrirtækið.
VOICEMAIL	Talhólfsímanúmer.
UNKNOWN	Ekki tókst að ákvarða númerategund.

Skruna upp

GET/routevarið

Sækir leiðina sem verður sjálfkrafa valin þegar þú keyrir HLR uppflettingu án þess að tilgreina route breytuna.

Sjálfvirk leiðarval byggist á leiðarkortinu sem hægt er að sækja með GET /hlr-coverage endapunktinum, sem er fyrst og fremst dregið af GET /routing-map. Þú getur sérsniðið leiðarkortið þitt og skilgreint sérsniðnar reglur í reikningsstillingum.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/route?msisdn=+491788735000'

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdn`	string	MSISDN númerið sem á að sækja sjálfvirkt valdar leiðarupplýsingar fyrir.	null	skyldubundið

{
   "route":"V11",
   "confidence_level":"HIGH",
   "mccmnc":"26203",
   "origin":"SCORE"
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`route`	string	Ráðlögð leið.	false
`confidence_level`	string	Öryggisstigið sem þessi leið var valin með, þ.e. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Númerakerfisbundið MCCMNC fyrir þetta númer.	false
`origin`	string	Uppruni sem leiðarvalið byggist á, þ.e. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/routesvarið

Þessi endapunktur skilar lista yfir tiltækar HLR, MNP og NT leiðir. Hver leið, ásamt eiginleikum og takmörkunum, er útskýrð á leiðarupplýsinga síðunni.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/routes'

{
   "routes":{
      "HLR":[
         "V11",
         "E10",
         "MS9",
         "DV8",
         "SV3",
         "IP1"
      ],
      "MNP":[
         "PTX",
         "IP4"
      ],
      "NT":[
         "LC1"
      ]
   }
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`routes`	object	Hlutur með leiðum flokkuðum eftir leiðartegund.	false
`HLR\|MNP\|NT`	string[]	Inniheldur lista yfir leiðarauðkenni.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/routing-mapvarið

Sækir sjálfvirka leiðarstillingu sem nú er í notkun fyrir HLR uppflettingar á reikningnum þínum. Þessi sjálfgefna stilling er notuð þegar þú sendir inn HLR uppflettingar án þess að tilgreina route breytu. Þú getur sérsniðið leiðarkortið þitt og búið til sérsniðnar reglur í reikningsstillingum.

Stigveldi stillinga flæðir frá reglum á landsvísu til reglna á MCCMNC-stigi og að lokum til einstakra símaforskeytavarpana. Í framkvæmd þýðir þetta að einstakar símaforskeytavarpanir hafa forgang fram yfir mótsagnakenndar MCCMNC úthlutanir, sem aftur hnekkja reglum á landsvísu. Vinsamlegast athugið að MNP varakostur hnekkir öllum mótsagnakenndum sérsniðnum reglum meðan hann er virkur.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/routing-map'

{
   "routing":{
      "map":{
         "defaultRoute":"V11",
         "mnpFallback":true,
         "mccmncs":[
            {
               "mccmnc":20201,
               "countrycode":"GR",
               "route":"E10",
               "mno":"Cosmote",
               "confidence":"HIGH",
               "origin":"SCORE"
            }
         ],
         "prefixes":[
            {
               "countrycode":"DE",
               "cns":"+4917821",
               "route":"DV8",
               "mccmnc":"26203",
               "mno":"O2"
            }
         ],
         "countries":[
            {
               "countrycode":"US",
               "route":"DV8"
            }
         ]
      }
   }
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`default_route`	string	Sjálfgefin leið sem notuð er þegar ekki er hægt að ákvarða ákjósanlegan leiðarkost fyrir MSISDN og engar sérsniðnar leiðarreglur eiga við.	false
`mnp_fallback`	boolean	Gefur til kynna hvort MNP varakostur sé virkur. Þegar hann er virkur og HLR fyrirspurnir eru ekki studdar af neti (tengistaða ekki tiltæk), mun kerfið framkvæma MNP uppflettingu í staðinn.	false
`mccmncs`	array	Vörpun MCCMNC kóða yfir í sjálfkrafa valdar leiðir þeirra. Þegar HLR uppfletting er framkvæmd fyrir númer í tilteknu MCCMNC er samsvarandi leið notuð.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa MCCMNC (samsetning af landakóða farsíma og netakóða farsíma) sem auðkennir farsímakerfið.	false
`countrycode`	string(2)	Tveggja stafa ISO landskóði sem auðkennir land netsins.	false
`route`	string(3)	Valin leið fyrir netið.	false
`mno`	string	Neytendavænt vörumerki sem þetta net starfar undir.	false
`confidence`	string	Öryggisstig sem valið var með. Möguleg gildi eru: HIGH, NORMAL, LOW, MNP_REDIRECT. Ef um hið síðarnefnda er að ræða vísar kerfið umferð til þessa nets yfir á MNP, ef þessi hegðun er virk á reikningnum þínum. Annars notar það sjálfgefna leið reikningsins.	false
`origin`	string	Uppruni sem valið byggir á. Möguleg gildi eru: `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`	false
`prefixes`	array	Listi yfir sérsniðnar forskeytatengdar leiðarreglur sem stilltar eru á reikningnum þínum, ef einhverjar eru.	false
`countrycode`	string(2)	Tveggja stafa ISO landskóði sem auðkennir land forskeytisins.	false
`cns`	string	Forskeytið sem leiðarreglan á við um.	false
`route`	string(3)	Valin leið fyrir forskeytið.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa MCCMNC (samsetning af landakóða farsíma og netakóða farsíma) sem auðkennir farsímakerfið.	true
`mno`	string	Neytendavænt vörumerki sem þetta net starfar undir.	true
`countries`	array	Listi yfir sérsniðnar landatengdar reglur sem stilltar eru á reikningnum þínum, ef einhverjar eru.	false
`countrycode`	string(2)	Tveggja stafa ISO landskóði sem auðkennir landið.	false
`route`	string(3)	Valin leið fyrir landið.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/hlr-coverage varið

Skilar HLR umfjöllunarupplýsingum til að styðja við gagnastýrðar ákvarðanir. Þessi endapunktur hjálpar þér að greina rauntíma HLR leiðarvalkosti þvert á farsímanet, bera kennsl á skilvirkustu leiðirnar fyrir markhérað þitt og stilla sjálfvirka leiðarvísun þína.

Ráðlagðar leiðir frá GET /route eru byggðar á umfjöllunargögnum sem sótt eru hér. Umfjöllunargögn eru einnig aðgengileg á netumfjöllun síðunni. Þú getur enn frekar sérsniðið leiðarvísunarkortið þitt og skilgreint reglur í reikningsstillingum þínum.

Við mælum með að þú kynni þér þessa leiðbeiningar til að aðstoða við túlkun niðurstaðna.

Beiðni Árangursrík svarskil Villuskil Stöðutilvísun

curl 'https://www.hlr-lookups.com/api/v2/hlr-coverage?countrycode=XX'

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`countrycode`	string(2)	Skylda tveggja stafa ISO landskóði sem notaður er til að sía niðurstöður og skila aðeins færslum sem tengjast tilgreindu landi.	null	skyldubundið
`sample_size`	string	Valfrjáls færibreyta sem tilgreinir úrtaksstærð. Möguleg gildi eru `LARGE`, `MEDIUM`, `SMALL`. Stærri úrtök ná yfir lengra tímabil, minni úrtök ná yfir nýlegt tímabil.	LARGE	valfrjálst

{
   "name":"Germany",
   "countrycode":"DE",
   "prefix":"+49",
   "mccs":[
      "262"
   ],
   "carriers":[
      {
         "mno":"Telekom",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "routes":[
            {
               "route":"V11",
               "selected":true,
               "selection_confidence":"HIGH",
               "n":361579,
               "CONNECTED":275273,
               "CONNECTED_PCT":76.13,
               "ABSENT":21529,
               "ABSENT_PCT":5.95,
               "INVALID_MSISDN":62582,
               "INVALID_MSISDN_PCT":17.3,
               "UNDETERMINED":2195,
               "UNDETERMINED_PCT":0.6
            },
            {
               "route":"E10",
               "selected":false,
               "selection_confidence":null,
               "n":122600,
               "CONNECTED":13721,
               "CONNECTED_PCT":11.19,
               "ABSENT":133,
               "ABSENT_PCT":0.1,
               "INVALID_MSISDN":55,
               "INVALID_MSISDN_PCT":0.04,
               "UNDETERMINED":108691,
               "UNDETERMINED_PCT":88.65
            }
         ]
      }
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`name`	string	Valið landsnafn á ensku í ósniðnum texta.	false
`countrycode`	string(2)	Tveggja stafa ISO landskóði valins lands.	false
`prefix`	string	Alþjóðleg símaforskeytið fyrir valið land.	false
`mccs`	string[]	Listi yfir MCC (farsímalandakóða) sem tengjast völdu landi.	false
`carriers`	object[]	Listi yfir símafyrirtæki með leiðarsértækum tengimælikvörðum.	false
`mno`	string	Nafn farsímarekanda á ensku í ósniðnum texta.	false
`mccmnc`	string	MCCMNC farsímarekanda.	false
`mcc`	string	MCC (farsímalandakóði) farsímarekanda.	false
`mnc`	string	MNC (farsímanetskóði) farsímarekanda.	false
`routes`	object[]	Listi yfir leiðarsértækar tengiupplýsingar.	false
`route`	string	Leiðin sem tengiupplýsingarnar eiga við.	false
`selected`	bool	Gefur til kynna hvort þetta sé valin leið fyrir sjálfvirka leiðarvísun.	false
`selection_confidence`	string	Öryggisstigið sem þessi leið var valin með, þ.e. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Inniheldur null ef þetta er ekki valin leið.	true
`n`	int	Heildarfjöldi uppflettinga í þessu úrtaki.	false
`CONNECTED`	int	Fjöldi HLR uppflettinga sem skiluðu CONNECTED stöðu.	false
`CONNECTED_PCT`	float	Hlutfall HLR uppflettinga sem skiluðu CONNECTED stöðu.	false
`ABSENT`	int	Fjöldi HLR uppflettinga sem skiluðu ABSENT stöðu.	false
`ABSENT_PCT`	float	Hlutfall HLR uppflettinga sem skiluðu ABSENT stöðu.	false
`INVALID_MSISDN`	int	Fjöldi HLR uppflettinga sem skiluðu INVALID_MSISDN stöðu.	false
`INVALID_MSISDN_PCT`	float	Hlutfall HLR uppflettinga sem skiluðu INVALID_MSISDN stöðu.	false
`UNDETERMINED`	int	Fjöldi HLR uppflettinga sem skiluðu UNDETERMINED stöðu.	false
`UNDETERMINED_PCT`	float	Hlutfall HLR uppflettinga sem skiluðu UNDETERMINED stöðu.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Staða	Lýsing
CONNECTED	Númerið er gilt og síminn er tengdur við farsímanetið. Símtöl, SMS og önnur þjónusta ættu að ná til viðtakanda.
ABSENT	Númerið er gilt, en síminn er annaðhvort slökkt eða tímabundið utan netsviðs. Skilaboð eða símtöl berast hugsanlega ekki fyrr en tækið tengist aftur við netið.
INVALID_MSISDN	Númerið er ógilt eða ekki úthlutað til neins áskrifanda á farsímanetinu. Símtöl og skilaboð til þessa númers munu mistakast.
UNDETERMINED	Ekki var hægt að ákvarða tengistöðu númerisins. Þetta getur stafað af ógilt númeri, SS7 villuskilaboðum eða skorti á tengingu við farsímarekandann. Skoðaðu villukóðann og lýsinguna fyrir frekari greiningu.

Skruna upp

GET/mnp-coveragevarið

Þessi endapunktur skilar lista yfir farsímakerfi ásamt tilheyrandi MCCMNC auðkennum sem eru studd fyrir númerflutningsleit.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/mnp-coverage?countrycode=XX'

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`countrycode`	string(2)	Valfrjáls tveggja stafa ISO landakóði sem notaður er til að sía MCCMNC niðurstöður og skila aðeins gögnum sem eiga við tilgreint land.	null	valfrjálst

{
   "items":[
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "brand":"Telekom",
         "operator":"Telekom Deutschland GmbH"
      },
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26202",
         "mcc":"262",
         "mnc":"02 ",
         "brand":"Vodafone",
         "operator":"Vodafone D2 GmbH"
      }
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`items[]`	array	Listi yfir farsímafyrirtæki.	false
`country_name`	string	Heiti lands á ensku.	false
`country_code`	string(2)	Tveggja stafa ISO landakóði.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa MCCMNC (samsetning af landakóða farsíma og netakóða farsíma) sem auðkennir farsímakerfið.	false
`mcc`	string(3)	Þriggja stafa MCC (landakóði farsíma) sem táknar land netsins.	false
`mnc`	string(2\|3)	Tveggja eða þriggja stafa MNC (netakóði farsíma) sem táknar tiltekið farsímakerfi.	false
`brand`	string	Neytendavænt vörumerki sem þetta net starfar undir.	true
`operator`	string	Löglegt heiti farsímakerfisins.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/price-listvarið

Þessi endapunktur skilar lista yfir lönd þar sem aðeins MNP uppflettingar eru studdar og HLR fyrirspurnir eru ekki tiltækar fyrir þessar áfangastaðir.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/mnp-countries'

{
   "countries":[
      "AG",
      "AI",
      "AR",
      "AS",
      "AW",
      "BB",
      "BM",
      ...
      "US",
      "UY",
      "VC",
      "VE",
      "VG",
      "VN"
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`countries`	string[]	Listi yfir tveggja stafa ISO landskóða.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/mccmncsvarið

Þessi endapunktur skilar yfirgripsmiklu yfirliti yfir farsímafyrirtæki ásamt samsvarandi MCCMNC auðkennum og viðbótarupplýsingum.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/mccmncs?countrycode=XX'

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`countrycode`	string(2)	Valfrjáls tveggja stafa ISO landskóði sem notaður er til að sía MCCMNC niðurstöður og skila aðeins færslum sem tengjast tilgreindu landi.	null	valfrjálst

{
   "items":[
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "brand":"Telekom",
         "operator":"Telekom Deutschland GmbH"
      },
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26202",
         "mcc":"262",
         "mnc":"02 ",
         "brand":"Vodafone",
         "operator":"Vodafone D2 GmbH"
      }
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`items`	object[]	Listi yfir farsímafyrirtæki.	false
`country_name`	string	Fullt heiti lands á ensku.	false
`country_code`	string(2)	Tveggja stafa ISO landskóði sem táknar land farsímafyrirtækisins.	false
`mccmnc`	string(5\|6)	Fimm eða sex stafa strengur sem táknar MCCMNC, sem auðkennir farsímafyrirtækið á einkvæman hátt.	false
`mcc`	string(3)	Þriggja stafa landskóði farsímanets (MCC) sem auðkennir landið þar sem farsímanetið starfar.	false
`mnc`	string(2\|3)	Tveggja eða þriggja stafa netakóði farsímanets (MNC) sem tilgreinir farsímanetið innan tiltekins MCC.	false
`brand`	string	Viðskiptaheiti sem netið starfar undir og er þekkt fyrir meðal neytenda.	true
`operator`	string	Opinbert heiti farsímafyrirtækisins, venjulega lögaðilinn sem rekur netið.	true
`parent_mccmnc`	string(5\|6)	Fimm eða sex stafa strengur sem táknar MCCMNC móðurfarsímafyrirtækisins, ef við á.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/pricevarið

Þessi endapunktur skilar verði fyrir HLR, MNP eða NT uppflettingu.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/price?msisdn=+491788735000&route_type=HLR'

Beiðnifæribreytur

Lykill	Tegund	Lýsing	Sjálfgefið	Skylda
`msisdn`	string	Símanúmerið sem á að sækja verð fyrir. Á alþjóðlegu sniði.	null	skyldubundið
`route_type`	string	Leiðargerðin, þ.e. `HLR`, `MNP`, `NT`.	null	skyldubundið
`route`	string(3)	Leiðin sem verð á að reikna fyrir. Sjálfgefið er leiðin sem sjálfvirk leiðarval ákvarðar.	null	valfrjálst

{
   "price":{
      "amount":"0.01000",
      "msisdn":"+491788735000",
      "route_type":"HLR",
      "route":"DV8"
   }
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`price`	object	Hlutur með verðupplýsingum.	false
`amount`	string	Upphæðin í EUR.	false
`msisdn`	string	MSISDN sem þetta verð á við um.	false
`route_type`	string(2\|3)	Leiðargerðin sem þetta verð á við um.	false
`route`	string(3)	Leiðin sem þetta verð á við um.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/price-listvarið

Þessi endapunktur skilar verðlagningu á reikningnum þínum.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/price-list'

{
   "pricing":[
      {
         "route":"V11",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"HLR",
         "price":"0.0090"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":"26201",
         "cns":null,
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":"26203",
         "cns":"4917821",
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":null,
         "cns":null,
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"PTX",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"MNP",
         "price":"0.00500"
      },
      ...
      {
         "route":"IP1",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"MIX",
         "price":"0.01000"
      },
      {
         "route":"LC1",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"NT",
         "price":"0.00500"
      }
   ]
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`pricing`	object[]	Listi yfir hluti með verðupplýsingum.	false
`route`	string	Leiðin sem þessi verðlagning á við um.	false
`countrycode`	string	Tveggja stafa ISO landskóðinn sem þessi verðlagning á við um fyrir viðkomandi leið, ef við á.	true
`countryname`	string	Enska heiti landsins sem samsvarar landskóðanum, ef við á.	true
`mccmnc`	string	MCCMNC sem þessi verðlagning á við um fyrir viðkomandi leið, ef við á. Hefur forgang fram yfir verðlagningu á landsvísu.	true
`cns`	string	Símaforskeytið sem þessi verðlagning á við um fyrir viðkomandi leið, ef við á. Hefur forgang fram yfir verðlagningu á landsvísu og MCCMNC-verðlagningu.	true
`route_type`	string	Viðkomandi leiðartegund, þ.e. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Viðkomandi verð í EUR.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/balancevarið

Þessi endapunktur sækir núverandi stöðu reikningsins þíns og gerir þér kleift að gera sjálfvirka ferla sem byggjast á inneignarstöðu þinni. Hann virkar hnökralaust með tilkynningum um lága inneign sem hægt er að stilla á greiðslusíðunni.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/balance'

{
    "balance":"1002.90"
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`balance`	string	Núverandi staða reikningsins þíns í EUR. Tugabrot af gerðinni strengur.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/pingopinbert

Þessi endapunktur sendir ping-beiðni til API-ins og veitir einfalda aðferð til að prófa tenginguna þína við HLR Lookups API.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/ping'

{
    "success":true
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`success`	boolean	Gefur til kynna að beiðnin hafi verið unnin með góðum árangri.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/timeopinbert

Þessi endapunktur skilar Unix tímastimpli sem táknar núverandi tíma á HLR Lookups netþjóninum. Notaðu hann til að samstilla klukku netþjónsins þíns þegar þú býrð til Digest-Auth undirskriftina fyrir auðkenningu, til að tryggja að misræmi á milli tíma netþjónsins þíns og HLR Lookups netþjónsins verði leiðrétt.

Beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/time'

{
    "time":1525898643
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`time`	integer	Unix tímastimpill sem táknar núverandi tíma HLR Lookups netþjónsins.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

GET/auth-testvarið

Þessi endapunktur þjónar sem upphafspróf fyrir Basic-Auth eða, helst, Digest-Auth útfærsluna þína.

Basic Auth beiðni Digest Auth beiðni Árangursrík svarskil Villuskil

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: YOUR_API_KEY"

Beiðnihausa

Lykill	Tegund	Lýsing
`X-Basic`	string	SHA256 tætigildi af `YOUR_API_KEY:YOUR_API_SECRET`. Láttu tvípunktinn (:) fylgja með í tætigildinu.

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Digest-Key: YOUR_API_KEY" \
  -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
  -H "X-Digest-Timestamp: UNIX_TIMESTAMP"

Beiðnihausa

Lykill	Tegund	Lýsing
`X-Digest-Key`	string	HLR Lookups API lykillinn þinn
`X-Digest-Signature`	string	Einkvæm Digest-Auth undirskrift (sjá auðkenningu)
`X-Digest-Timestamp`	integer	Núverandi Unix tímastimpill (sjá einnig `GET /time`)

{
    "success":true
}

Eiginleikar árangursríkra svarskila

Nafn	Tegund	Lýsing	Má vera tómt
`success`	boolean	Gefur til kynna að beiðnin hafi verið unnin með góðum árangri.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Færibreytur villuskilaboða

Nafn	Tegund	Lýsing	Má vera tómt
`errors[]`	string[]	Listi af textastrengjum sem útskýra villuna.	false

Skruna upp

Eldri API skjöl

Vinsamlegast athugið að eldra API er úrelt og verður tekið úr notkun í framtíðinni. Við mælum eindregið með því að uppfæra í nýjustu útgáfuna eins fljótt og auðið er.

Ef þú innleiddir HLR Lookups API okkar á árunum 2013 til byrjun árs 2020 ertu að nota eldra API okkar. Vinsamlegast skoðaðu eldri API skjölin okkar í því tilviki.

Eldri API skjöl

API skjöl

Byrjaðu hér

HLR uppflettingar

MNP uppflettingar

NT uppflettingar

Leiðarval

Verðskrá

Verkfæri

Byrjaðu hér

Notkun HLR Lookups API

Dæmi um beiðni

Dæmi um gagnaskjal

Árangursrík svarskil application/json

Viðbótar uppflettingarþjónustur

Númeraflutninga uppflettingar (MNP)

Númerategund uppflettingar (NT)

Hugbúnaðarþróunarsett (SDK)

Verkfæri

Ekki forritari?

Auðkenning

API lykill og API leyniorð

HTTP Basic Auth

Mælt með: X-Basic haus með SHA256

Basic Auth beiðni

Basic Authentication hausar

Kóðadæmi

Beiðnidæmi

Beiðnihausa

Smíði undirskriftar

Digest undirskriftaríhlutir

Kóðadæmi

Hugtök

Samstillt HLR uppflettingar API

Ósamstillt HLR uppflettingar API

SDK (hugbúnaðarþróunarsett)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupvarið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða

POST/hlr-lookupsvarið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða

Vinnsla vefkrókanna

Auðkenning

Kóðadæmi

Staðfesting á móttöku

Gagnafarmur vefkróka

Eiginleikar Webhook Gagna

POST/mnp-lookupvarið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða

POST/mnp-lookupsvarið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða

Vinnsla vefkrókanna

Auðkenning

Kóðadæmi

Staðfesting á móttöku

Gagnafarmur vefkróka

Eiginleikar Webhook Gagna

POST/nt-lookupvarið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða

POST/nt-lookups varið

Gögn

Beiðnifæribreytur

Eiginleikar árangursríkra svarskila

Færibreytur villuskilaboða