Začetek dela

Globalna infrastruktura mobilnega omrežja deluje na sistemu, znanem kot SS7 signalizacijsko omrežje. To omrežje omogoča izmenjavo podatkov o naročnikih, usmerjanje klicev, prenos SMS sporočil in posodobitve statusa mobilne povezljivosti v realnem času med operaterji. Vsako mobilno omrežje vzdržuje register domače lokacije (HLR) - osrednjo podatkovno bazo, ki shranjuje bistvene podatke o svojih naročnikih.

Tehnologija HLR Lookup omogoča podjetjem poizvedovanje v teh registrih in pridobivanje podatkov o povezljivosti in omrežju v realnem času za katero koli mobilno telefonsko številko. To vključuje informacije o tem, ali je telefon vklopljen, kateremu omrežju je trenutno dodeljen, ali je bila številka prenesena, ali je številka veljavna ali deaktivirana ter ali je v gostovanju.

API HLR Lookups zagotavlja nemoten dostop do teh podatkov v realnem času, kar podjetjem omogoča preverjanje mobilnih številk, optimizacijo usmerjanja in izboljšanje komunikacije s strankami. Ta dokumentacija vas bo vodila skozi integracijo HLR Lookups v vašo programsko opremo, kar omogoča avtomatizirano pridobivanje mobilnih podatkov v realnem času.

Uporaba API-ja HLR Lookups

Izvajanje poizvedb HLR Lookup je hitro, varno in preprosto. Ko se registrirate in pridobite svoj API ključ, se lahko avtenticirate in začnete takojšnje poizvedbe s preprostimi HTTP POST zahtevki prek POST /hlr-lookup. Alternativno lahko obdelujete velike nabore podatkov z izbiro hitrih asinhronih API zahtevkov z rezultati, poslanimi nazaj na vaš strežnik prek webhooka, kot je razloženo v razdelku koncepti.

Primer zahtevka

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"

Avtentikacija se zagotovi prek HTTP glav, datoteka payload.json pa mora (vsaj minimalno) vsebovati naslednji JSON objekt:

Primer vsebine

{
   "msisdn": "+14156226819"
}

Po uspešnem izvajanju boste prejeli odgovor, ki vsebuje podatke o povezljivosti v realnem času za navedeno mobilno številko.

Uspešen odgovor 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"
}

Za popoln pregled atributov zahtevka in odgovora ter statusov povezljivosti glejte POST /hlr-lookup.

Dodatne storitve poizvedb

Poizvedbe o prenosljivosti mobilnih številk (MNP)

Uporabite MNP poizvedbe za ugotavljanje lastništva omrežja in podatkov o prenosljivosti brez poizvedovanja o povezljivosti v realnem času. Če potrebujete samo MCCMNC številke, glejte POST /mnp-lookup.

Poizvedbe o tipu številke (NT)

Ugotovite, ali telefonska številka pripada fiksni liniji, mobilnemu telefonu, številki s povečano tarifo, VoIP, pozivniku ali drugim obsegom številčnega načrta z POST /nt-lookup.

Razvojni kompleti (SDK)

API HLR Lookups deluje s katerim koli REST odjemalcem v katerem koli programskem jeziku in objavili smo SDK-je za PHP, Ruby in NodeJS na našem GitHubu, da vam pomagamo hitro začeti.

Orodja

Za zagotovitev nemotene razvojne izkušnje ponujamo celovit nabor orodij, vključno s spremljanjem API zahtevkov in webhookov v brskalniku, belim seznamom IP naslovov, robustnimi možnostmi avtentikacije in testno končno točko za avtentikacijo.

Niste razvijalec?

Poizvedbe HLR Lookup in prenosljivosti številk je mogoče izvajati brez kakršnega koli programiranja. Preberite več o našem poslovnem spletnem odjemalcu in funkcijah poročanja v brskalniku.

Avtentikacija

Za zagotovitev varnosti in ustreznega nadzora dostopa večina zahtevkov do HLR Lookups API zahteva avtentikacijo. Končne točke so razvrščene kot javne ali zaščitene. Pri dostopu do zaščitene končne točke mora biti vaš zahtevek avtenticiran z API ključem in skrivnostjo prek metode Digest-Auth ali Basic-Auth. Digest-Auth je varnejša možnost in jo močno priporočamo. Uporabite končno točko GET /auth-test za preverjanje nastavitev avtentikacije.

API ključ in API skrivnost

Pridobite svoj API ključ in skrivnost na strani nastavitve API. Prav tako lahko konfigurirate želeno metodo avtentikacije in omogočite seznam dovoljenih IP naslovov za dodatno varnost. Če sumite, da je bila vaša API skrivnost ogrožena, lahko kadarkoli ustvarite novo.

Basic Auth Digest Auth Beli seznam IP

Standardna osnovna avtentikacija je enostavna za implementacijo in široko podprta. Avtenticirate se lahko tako, da posredujete svoj API ključ in skrivnost kot par user:pass v HTTP zahtevku.

HTTP Basic Auth

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

To pošlje glavo Authorization:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Priporočeno: X-Basic glava s SHA256

Za izboljšano varnost lahko namesto neposrednega prenosa poverilnic kot base64 pošljete SHA256 zgoščeno vrednost. Za uporabo te metode izračunajte zgoščeno vrednost para YOUR_API_KEY:YOUR_API_SECRET in jo pošljite prek glave X-Basic:

Basic Auth zahtevek

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

Glave osnovne avtentikacije

Ključ	Tip	Opis
`X-Basic`	string	SHA256 zgoščena vrednost `YOUR_API_KEY:YOUR_API_SECRET`. V zgoščeno vrednost vključite dvopičje (:).	obvezno

Primer kode

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

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

Digest-Auth je priporočena metoda za zavarovanje dostopa do zaščitenih končnih točk HLR Lookup API. Vsak zahtevek mora vključevati naslednje glave: X-Digest-Key, X-Digest-Signature in X-Digest-Timestamp, ki so pojasnjene spodaj.

Primer zahtevka

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"

Glave zahtevka

Ključ	Tip	Opis
`X-Digest-Key`	string	Vaš unikatni HLR Lookups API ključ.	obvezno
`X-Digest-Signature`	string	Unikatni podpis avtentikacije (glejte spodaj).	obvezno
`X-Digest-Timestamp`	integer	Trenutna Unix časovna oznaka (glejte tudi `GET /time`).	obvezno

Sestavljanje podpisa

X-Digest-Signature se ustvari z uporabo SHA256 HMAC zgoščene vrednosti, pri čemer je vaša API skrivnost skupni ključ.

Niz za zgoščevanje je strukturiran na naslednji način:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Simbol . predstavlja združevanje nizov.

Komponente Digest podpisa

Komponenta	Tip	Opis
`ENDPOINT_PATH`	string	Zahtevana API končna točka, npr. `/auth-test` z malimi črkami.
`UNIX_TIMESTAMP`	integer	Trenutna Unix časovna oznaka (mora biti v 30 sekundah). Glejte `GET /time`.
`REQUEST_METHOD`	string	Uporabljena HTTP metoda, npr. `POST` ali `GET`.
`REQUEST_BODY`	string	Podatki v telesu zahtevka. Nastavite na `null` za zahtevke `GET`.

Primeri kode

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)

Pomakni se gor

Koncepti

Implementacija HLR poizvedb v kateremkoli programskem jeziku ali sistemu prek našega HTTP REST API je enostavna in učinkovita. Z enostavnim integracijskim procesom lahko začnete z poizvedbami v mobilnih omrežjih v realnem času za takojšnje vpoglede v veljavnost telefonskih številk, stanje povezljivosti in podrobnosti usmerjanja.

Izbira ustreznega API-ja je odvisna od vašega specifičnega primera uporabe. Če potrebujete rezultate poizvedb v realnem času za aplikacije, kot so VoIP telefonija, odkrivanje goljufij ali usmerjanje SMS sporočil, je sinhroni API najboljša izbira. Če pa vaš primer uporabe vključuje obdelavo velikih količin, množične poizvedbe ali preverjanje podatkov v velikem obsegu, asinhroni API ponuja optimizirano zmogljivost z učinkovitostjo pasovne širine in možnostmi paketnih poizvedb.

Konfigurirajte API za uporabo ene od naših možnosti usmerjevalnega usmerjanja za optimizacijo hitrosti, natančnosti in stroškovne učinkovitosti. Rezultate poizvedb lahko shranite tudi v shrambe za enostavno prenašanje CSV in JSON poročil ter napredno analitiko prek spletnega vmesnika.

Sinhroni HLR Lookup API

Končna točka POST /hlr-lookup obdela eno mobilno telefonsko številko (MSISDN) na zahtevo in takoj vrne rezultate v telesu HTTP odgovora. Rezultati so formatirani kot JSON in so idealni za aplikacije v realnem času, vključno s preverjanjem mobilnih številk, usmerjanjem klicev in dostavo SMS sporočil.

Sinhroni API klic sestoji iz neposredne HTTP zahteve in odgovora. Vaš sistem odda en MSISDN (mobilno številko) na zahtevo in prejme takojšen odgovor, ki vsebuje rezultate HLR poizvedbe v realnem času v formatu JSON. Ta API je optimiziran za primere uporabe, ki zahtevajo takojšnje preverjanje in preverjanje povezljivosti, kot so odkrivanje goljufij, usmerjanje VoIP klicev in optimizacija SMS prehoda.

Asinhroni HLR Lookup API

Končna točka POST /hlr-lookups je zasnovana za množično obdelavo in obdelavo velikih količin, kar vam omogoča oddajo do 1,000 MSISDN-ov na zahtevo. Namesto takojšnjega vračanja rezultatov ta API uporablja avtomatizirane webhooks za postopno pošiljanje rezultatov na vaš strežnik. Rezultati poizvedb se vrnejo kot JSON objekti prek HTTP POST povratnih klicev.

Asinhroni API je optimiziran za hitrost, učinkovitost in razširljivost. Odpravlja težave z omrežno zakasnitvijo, povezane s sinhronimi klici, kar ga dela idealnega za podjetja, ki potrebujejo poizvedbe z visoko prepustnostjo. Vaš sistem odda do 1,000 MSISDN-ov na zahtevo, naša platforma pa jih obdela vzporedno in rezultate dostavi nazaj na vaš strežnik prek HTTP webhooks v paketih do 1,000 rezultatov na povratni klic.

SDK-ji (kompleti za razvoj programske opreme)

Naši kompleti za razvoj programske opreme (SDK-ji) za PHP, NodeJS in Ruby poenostavijo postopek integracije in vam omogočajo učinkovito povezavo z API-jem HLR Lookups z minimalnim naporom.

Ti SDK-ji zagotavljajo vnaprej pripravljene funkcije, upravljanje avtentikacije in strukturirane predloge za API zahteve, s čimer skrajšajo čas razvoja in zagotovijo najboljše prakse.

Raziščite celoten seznam razpoložljivih SDK-jev na GitHubu in začnite z integracijo še danes.

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);

Poglej na GitHubu 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   }

Poglej na GitHubu 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)

Poglej na GitHubu README.md

Pomakni se gor

POST/hlr-lookupzaščiteno

Izvede sinhrono HLR poizvedbo, ki v realnem času dostavi podatke o povezljivosti in prenosljivosti mobilnih telefonov neposredno od omrežnih operaterjev. Ta končna točka je idealna za scenarije s trenutnim prometom, kjer časovno občutljive aplikacije zahtevajo takojšnjo preverjanje, ali je telefonska številka trenutno dosegljiva (povezana) ali nedostopna (izklopljena). Poleg tega pomaga razlikovati aktivne številke od neveljavnih, neznanih ali lažnih.

Za paketno obdelavo velikih podatkovnih nizov, ki ne zahtevajo takojšnjih rezultatov, razmislite o uporabi asinhrone končne točke POST /hlr-lookups, ki je optimizirana za hitro paketno obdelavo.

Če je vaš glavni cilj pridobivanje podatkov o prenosljivosti mobilnih številk (MCCMNC) in ne potrebujete statusa povezave v realnem času, končna točka POST /mnp-lookup ponuja stroškovno učinkovito alternativo za poizvedbe o prenosljivosti mobilnih številk.

Zahteva Uspešen odgovor Odgovor ob napaki Referenca stanj

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdn`	string	Mobilna telefonska številka (MSISDN), ki jo želite poizvedovati, podana v mednarodni obliki (npr. +14156226819 ali 0014156226819). Državne kode morajo biti vključene.	null	obvezno
`route`	string(3)	Neobvezen tristaven identifikator, ki določa pot za to poizvedbo. Nastavite na `null` ali izpustite ta parameter, da uporabite svoj prilagojen zemljevid usmerjanja ali pustite našemu sistemu, da samodejno določi najboljšo pot za to poizvedbo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
   "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"
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni identifikator, dodeljen tej zahtevi za poizvedbo.	false
`msisdn`	string	Mobilna telefonska številka, ki se preverja, oblikovana v mednarodni obliki (npr. +14156226819 ali 0014156226819).	false
`connectivity_status`	string	Označuje, ali je bilo stanje povezljivosti številke uspešno pridobljeno. Možne vrednosti: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` ali `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Pet- ali šestmestna koda Mobile Country Code (MCC) in Mobile Network Code (MNC), ki identificira omrežje, trenutno povezano s telefonsko številko.	true
`mcc`	string(3)	Trimestna koda Mobile Country Code (MCC), ki identificira državo, v kateri je telefonska številka registrirana.	true
`mnc`	string(2\|3)	Dvo- ali trimestna koda Mobile Network Code (MNC), ki identificira specifično omrežje, ki mu pripada telefonska številka.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), edinstveni identifikator za SIM kartico, povezano s to številko. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) v bazi podatkov mobilnega operaterja. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`msc`	string(12)	Mobile Switching Center (MSC), ki trenutno upravlja komunikacije tega naročnika. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`original_network_name`	string	Ime izvirnega (domačega) omrežnega operaterja, povezanega s to številko.	true
`original_country_name`	string	Polno ime države, v kateri je bila mobilna telefonska številka prvotno registrirana, podano v angleščini.	true
`original_country_code`	string(2)	Dvomestna ISO koda države, ki predstavlja državo, v kateri je bila telefonska številka prvič dodeljena.	true
`original_country_prefix`	string	Mednarodna klicna koda (koda države), ki ustreza izvirni državi mobilne telefonske številke.	true
`is_ported`	boolean	Označuje, ali je bila mobilna številka prenesena iz izvirnega omrežja k drugemu operaterju.	true
`ported_network_name`	string	Ime omrežnega operaterja, h kateremu je bila mobilna številka prenesena, če je primerno.	true
`ported_country_name`	string	Ime države, v katero je bila mobilna številka prenesena, če je primerno.	true
`ported_country_code`	string(2)	Dvomestna ISO koda države, ki predstavlja državo, v katero je bila mobilna številka prenesena, če je primerno.	true
`ported_country_prefix`	string	Mednarodna klicna koda (koda države) za državo, v katero je bila mobilna številka prenesena, če je primerno.	true
`is_roaming`	boolean	Označuje, ali mobilna številka trenutno gostuje v tujem omrežju. Razpoložljivost statusa gostovanja je odvisna od mobilnega omrežnega operaterja.	true
`roaming_network_name`	string	Ime omrežja, v katerem mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_name`	string	Ime države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_code`	string(2)	Dvomestna ISO koda države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_prefix`	string	Mednarodna klicna koda (koda države) države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške poizvedbe v EUR.	true
`timestamp`	string	Časovni žig v formatu W3C, vključno s časovnim pasom, ki določa, kdaj je bila poizvedba zaključena.	true
`storage`	string	Ime shrambe, v kateri so bili shranjeni rezultati poizvedbe. To ustreza imenom poročil in prenosom CSV, dostopnim prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki označuje metodo usmerjanja, uporabljeno za to zahtevo za poizvedbo.	true
`processing_status`	string	Rezultat obdelave poizvedbe. Možne vrednosti: `COMPLETED` (uspešno), `REJECTED` (omrežje ni dosegljivo, brez zaračunavanja) ali `FAILED` (napaka med obdelavo).	false
`error_code`	integer	Neobvezna interna koda napake, ki zagotavlja dodatne diagnostične informacije za podporo strankam.	true
`error_description`	string	Kratek opis podane kode napake (če obstaja) v angleškem besedilu.	true
`data_source`	string	Vir podatkov, uporabljen za to zahtevo. Možne vrednosti: `LIVE_HLR` (HLR poizvedba v realnem času) ali `MNP_DB` (statična baza podatkov o prenosljivosti mobilnih številk). Za podrobnosti glejte možnosti usmerjanja.	false
`routing_instruction`	string	Z dvopičjem ločen niz, ki opisuje navodilo za usmerjanje, uporabljeno v zahtevi. Prva komponenta je `STATIC`, ko ste določili pot, ali `AUTO` za samodejno usmerjanje; druga komponenta je identifikator poti, pri zahtevah za samodejno usmerjanje pa tretja komponenta prikazuje izvor, na katerem temelji odločitev o usmerjanju (tj. `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."
    ]
}

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Status	Opis
CONNECTED	Številka je veljavna in ciljna naprava je trenutno povezana z mobilnim omrežjem. Klici, SMS sporočila in druge storitve bi morali uspešno doseči prejemnika.
ABSENT	Številka je veljavna, vendar je ciljna naprava bodisi izklopljena bodisi začasno izven dosega omrežja. Sporočila ali klici morda ne bodo dostavljeni, dokler se naprava ponovno ne poveže z omrežjem.
INVALID_MSISDN	Številka je neveljavna ali trenutno ni dodeljena nobenemu naročniku v mobilnem omrežju. Klici in sporočila na to številko ne bodo uspeli.
UNDETERMINED	Statusa povezljivosti številke ni bilo mogoče določiti. To je lahko posledica neveljavne številke, SS7 napake ali pomanjkanja povezljivosti s ciljnim omrežnim operaterjem. Za dodatno diagnostiko preverite kodo napake in njeno polje z opisom.

Pomakni se gor

POST/hlr-lookupszaščiteno

Sproži paketno asinhrono HLR poizvedovanje, ki pridobi podatke o povezljivosti in prenosljivosti mobilnih telefonov v realnem času od omrežnih operaterjev. Rezultati se dostavijo prek webhookov na vaš strežnik. Ta metoda je optimizirana za obdelavo velikih količin številk, ki ne zahtevajo takojšnjega odziva, kot je čiščenje in preverjanje baz podatkov. Za aplikacije v realnem času, kot sta usmerjanje klicev ali dostava SMS sporočil, namesto tega uporabite končno točko POST /hlr-lookup.

Ta končna točka je idealna za množično obdelavo, ko je cilj identificirati telefonske številke, ki so trenutno dosegljive (povezane) ali nedosegljive (telefon izklopljen), ter hkrati izločiti neveljavne, nedodeljene ali lažne številke. Poleg tega zagotavlja status prenosljivosti v realnem času (MCCMNC) skupaj s podrobnostmi o povezljivosti.

Pred uporabo te končne točke zagotovite, da je konfiguriran webhook URL za asinhroni sprejem rezultatov poizvedovanja. To lahko nastavite v vaših nastavitvah API-ja.

Zahteva Uspešen odgovor Odgovor ob napaki Webhooks Referenca stanj

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdns`	array	Tabela mobilnih telefonskih številk (MSISDN) v mednarodni obliki (npr. +14156226819 ali 0014156226819). V posamezno zahtevo lahko vključite do 1000 številk.	null	obvezno
`route`	string(3)	Neobvezen tristaven identifikator, ki določa pot za to poizvedbo. Nastavite na `null` ali izpustite ta parameter, da uporabite svoj prilagojen zemljevid usmerjanja ali pustite našemu sistemu, da samodejno določi najboljšo pot za to poizvedbo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
   "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"
   ]
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`accepted`	array	Seznam objektov, ki vsebujejo edinstvene identifikatorje in MSISDN številke, ki so bile sprejete v obdelavo.	false
`accepted_count`	integer	Skupno število MSISDN številk, ki so bile uspešno sprejete v obdelavo.	false
`rejected`	array	Seznam objektov, ki vsebujejo edinstvene identifikatorje in MSISDN številke, ki so bile zavrnjene pri obdelavi, običajno zaradi neveljavnih številk. Za zavrnjene vnose se ne zaračunava.	false
`rejected_count`	integer	Skupno število MSISDN številk, zavrnjenih zaradi napak pri validaciji.	false
`total_count`	integer	Skupno število sprejetih in zavrnjenih MSISDN številk, ki so bile poslane v obdelavo.	false
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje skupne stroške v EUR za sprejeta poizvedovanja.	false
`storage`	string	Ime shrambe, kjer se dodajajo rezultati poizvedovanja, uporabljeno za poročanje in prenos CSV datotek prek spletnega vmesnika.	false
`route`	string(3\|4)	Tri- ali štirizmestni identifikator, ki določa pot, uporabljeno za to zahtevo poizvedovanja. Vsebuje AUTO, če je bilo zahtevano samodejno usmerjanje na podlagi številke.	false
`webhook_urls`	array	Webhook URL-ji, konfigurirani v vaših nastavitvah API-ja. Rezultati se vrnejo na te naslove.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Obdelava webhookov

Po oddaji naša platforma začne obdelovati navedene telefonske številke in pošlje rezultate na predhodno določen URL webhook na vašem strežniku. Rezultati se prenašajo kot zahteva HTTP POST z objektom JSON v telesu zahteve.

Avtentikacija

Avtenticirajte webhook s preverjanjem glave HTTP X-Signatures.

Glava X-Signatures vsebuje seznam podpisov, ločenih s podpičjem. Vsak podpis na seznamu je ustvarjen z eno od skrivnosti API, konfiguriranih v vašem računu. Za preverjanje webhooka ustvarite zgoščeno vrednost SHA-256 z uporabo vašega ključa API, skrivnosti in surovega telesa HTTP - nato jo primerjajte s podpisi na seznamu.

Ujemanje potrjuje, da je zahteva pristna in podpisana s skrivnostjo, ki jo nadzorujete.

Primer kode

$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;
    }
}

Zahteva je veljavna, če kateri koli podpis v glavi ustreza zgoščeni vrednosti SHA256, izračunani nad povezanim nizom vašega ključa API, skrivnosti in telesa HTTP.

Potrditev prejema

Pričakuje se, da vaš strežnik odgovori s kodo stanja HTTP 200 OK za potrditev uspešnega prejema. Če je vrnjena katera koli druga koda odgovora, pride do časovne omejitve (10 sekund) ali nastane katera koli druga težava pri dostavi, bo sistem samodejno ponovil webhook po eni minuti. Če zahteva še naprej ne uspe, bodo ponovni poskusi sledili strategiji eksponentnega umika, s kasnejšimi poskusi po 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutah.

Ta mehanizem ponovnih poskusov zagotavlja največjo zanesljivost pri dostavi rezultatov poizvedb v vašo infrastrukturo. Zmanjšuje tveganje izgube podatkov zaradi začasnih težav z omrežjem ali nedelovanja strežnika.

Vsebina webhooka

{
   "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"
      }
   ]
}

Atributi webhook podatkovnega tovora

Objekt JSON vsebuje atribut type => HLR skupaj z atributom results, ki vključuje seznam objektov poizvedovanja, kot je dokumentirano spodaj.

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni identifikator, dodeljen tej zahtevi za poizvedbo.	false
`msisdn`	string	Mobilna telefonska številka, ki se preverja, oblikovana v mednarodni obliki (npr. +14156226819 ali 0014156226819).	false
`connectivity_status`	string	Označuje, ali je bilo stanje povezljivosti številke uspešno pridobljeno. Možne vrednosti: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` ali `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Pet- ali šestmestna koda Mobile Country Code (MCC) in Mobile Network Code (MNC), ki identificira omrežje, trenutno povezano s telefonsko številko.	true
`mcc`	string(3)	Trimestna koda Mobile Country Code (MCC), ki identificira državo, v kateri je telefonska številka registrirana.	true
`mnc`	string(2\|3)	Dvo- ali trimestna koda Mobile Network Code (MNC), ki identificira specifično omrežje, ki mu pripada telefonska številka.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), edinstveni identifikator za SIM kartico, povezano s to številko. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) v bazi podatkov mobilnega operaterja. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`msc`	string(12)	Mobile Switching Center (MSC), ki trenutno upravlja komunikacije tega naročnika. Razpoložljivost je odvisna od konfiguracije omrežja.	true
`original_network_name`	string	Ime izvirnega (domačega) omrežnega operaterja, povezanega s to številko.	true
`original_country_name`	string	Polno ime države, v kateri je bila mobilna telefonska številka prvotno registrirana, podano v angleščini.	true
`original_country_code`	string(2)	Dvomestna ISO koda države, ki predstavlja državo, v kateri je bila telefonska številka prvič dodeljena.	true
`original_country_prefix`	string	Mednarodna klicna koda (koda države), ki ustreza izvirni državi mobilne telefonske številke.	true
`is_ported`	boolean	Označuje, ali je bila mobilna številka prenesena iz izvirnega omrežja k drugemu operaterju.	true
`ported_network_name`	string	Ime omrežnega operaterja, h kateremu je bila mobilna številka prenesena, če je primerno.	true
`ported_country_name`	string	Ime države, v katero je bila mobilna številka prenesena, če je primerno.	true
`ported_country_code`	string(2)	Dvomestna ISO koda države, ki predstavlja državo, v katero je bila mobilna številka prenesena, če je primerno.	true
`ported_country_prefix`	string	Mednarodna klicna koda (koda države) za državo, v katero je bila mobilna številka prenesena, če je primerno.	true
`is_roaming`	boolean	Označuje, ali mobilna številka trenutno gostuje v tujem omrežju. Razpoložljivost statusa gostovanja je odvisna od mobilnega omrežnega operaterja.	true
`roaming_network_name`	string	Ime omrežja, v katerem mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_name`	string	Ime države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_code`	string(2)	Dvomestna ISO koda države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`roaming_country_prefix`	string	Mednarodna klicna koda (koda države) države, v kateri mobilna številka trenutno gostuje, če je primerno.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške poizvedbe v EUR.	true
`timestamp`	string	Časovni žig v formatu W3C, vključno s časovnim pasom, ki določa, kdaj je bila poizvedba zaključena.	true
`storage`	string	Ime shrambe, v kateri so bili shranjeni rezultati poizvedbe. To ustreza imenom poročil in prenosom CSV, dostopnim prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki označuje metodo usmerjanja, uporabljeno za to zahtevo za poizvedbo.	true
`processing_status`	string	Rezultat obdelave poizvedbe. Možne vrednosti: `COMPLETED` (uspešno), `REJECTED` (omrežje ni dosegljivo, brez zaračunavanja) ali `FAILED` (napaka med obdelavo).	false
`error_code`	integer	Neobvezna interna koda napake, ki zagotavlja dodatne diagnostične informacije za podporo strankam.	true
`error_description`	string	Kratek opis podane kode napake (če obstaja) v angleškem besedilu.	true
`data_source`	string	Vir podatkov, uporabljen za to zahtevo. Možne vrednosti: `LIVE_HLR` (HLR poizvedba v realnem času) ali `MNP_DB` (statična baza podatkov o prenosljivosti mobilnih številk). Za podrobnosti glejte možnosti usmerjanja.	false
`routing_instruction`	string	Z dvopičjem ločen niz, ki opisuje navodilo za usmerjanje, uporabljeno v zahtevi. Prva komponenta je `STATIC`, ko ste določili pot, ali `AUTO` za samodejno usmerjanje; druga komponenta je identifikator poti, pri zahtevah za samodejno usmerjanje pa tretja komponenta prikazuje izvor, na katerem temelji odločitev o usmerjanju (tj. `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

Status	Opis
CONNECTED	Številka je veljavna in ciljna naprava je trenutno povezana z mobilnim omrežjem. Klici, SMS sporočila in druge storitve bi morali uspešno doseči prejemnika.
ABSENT	Številka je veljavna, vendar je ciljna naprava bodisi izklopljena bodisi začasno izven dosega omrežja. Sporočila ali klici morda ne bodo dostavljeni, dokler se naprava ponovno ne poveže z omrežjem.
INVALID_MSISDN	Številka je neveljavna ali trenutno ni dodeljena nobenemu naročniku v mobilnem omrežju. Klici in sporočila na to številko ne bodo uspeli.
UNDETERMINED	Statusa povezljivosti številke ni bilo mogoče določiti. To je lahko posledica neveljavne številke, SS7 napake ali pomanjkanja povezljivosti s ciljnim omrežnim operaterjem. Za dodatno diagnostiko preverite kodo napake in njeno polje z opisom.

Pomakni se gor

POST/mnp-lookupzaščiteno

Izvede sinhroni MNP poizvedbo in zagotovi informacije o prenosljivosti mobilnih številk ter omrežju. Ta končna točka je primerna, če je vaš glavni cilj pridobiti trenutni MCCMNC dane mobilne telefonske številke ter v realnem času določiti izvorno in trenutno omrežje.

Za paketno obdelavo velikih podatkovnih nizov, ki ne zahtevajo takojšnjih rezultatov, razmislite o uporabi asinhrone končne točke POST /mnp-lookups, ki je optimizirana za hitro paketno obdelavo.

MNP poizvedbe zanesljivo določijo prenosljivost in informacije o omrežju, vendar ne pokažejo, ali je ciljna mobilna naprava trenutno povezana z omrežjem in dosegljiva. Za pridobitev informacij o povezljivosti v realnem času uporabite končno točko POST /hlr-lookup.

Zahteva Uspešen odgovor Odgovor ob napaki

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdn`	string	Mobilna telefonska številka (MSISDN), ki jo želite poizvedovati, podana v mednarodni obliki (npr. +14156226819 ali 0014156226819). Državne kode morajo biti vključene.	null	obvezno
`route`	string(3)	Neobvezen tristaven identifikator, ki določa pot za to poizvedbo. Nastavite na `null` ali izpustite ta parameter, da uporabite svoj prilagojen zemljevid usmerjanja ali pustite našemu sistemu, da samodejno določi najboljšo pot za to poizvedbo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
   "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
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni 12-mestni identifikator za to poizvedbo.	false
`msisdn`	string	Mobilna telefonska številka, ki je bila preverjena v tej poizvedbi.	false
`query_status`	string	Označuje, ali je bilo pridobivanje informacij o prenosljivosti in omrežju uspešno. Možne vrednosti so `OK` ali `FAILED`.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestna koda MCCMNC (kombinacija kode mobilne države in kode mobilnega omrežja), ki identificira omrežje, kateremu mobilna telefonska številka trenutno pripada.	true
`mcc`	string(3)	Trimestna koda MCC (koda mobilne države), ki predstavlja državo, povezano s trenutnim omrežjem mobilne telefonske številke.	true
`mnc`	string(2\|3)	Dvo- ali trimestna koda MNC (koda mobilnega omrežja), ki identificira trenutnega omrežnega operaterja za mobilno telefonsko številko.	true
`is_ported`	boolean	Označuje, ali je bila telefonska številka prenesena iz izvirnega omrežja k novemu operaterju.	true
`original_network_name`	string	Poljuben niz (v angleščini), ki določa ime izvirnega omrežnega operaterja preverjene mobilne telefonske številke.	true
`original_country_name`	string	Poljuben niz (v angleščini), ki označuje izvirno državo preverjene mobilne telefonske številke.	true
`original_country_code`	string(2)	Dvomestna koda države ISO, ki predstavlja izvirno državo preverjene mobilne telefonske številke.	true
`original_country_prefix`	string	Klicna koda izvorne države, povezane s preverjeno mobilno telefonsko številko.	true
`ported_network_name`	string	Določa omrežnega operaterja, h kateremu je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_name`	string	Določa državo, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_code`	string(2)	Dvomestna koda države ISO, ki predstavlja državo, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_prefix`	string	Klicna koda države, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`extra`	string	Poljuben niz, ki podaja dodatne podrobnosti o telefonski številki, če so na voljo.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške v EUR za to poizvedbo.	true
`timestamp`	string	Časovni žig v formatu W3C, vključno z informacijami o časovnem pasu, ki označuje, kdaj je bila poizvedba zaključena.	true
`storage`	string	Ime shranjevanja (ali ime poročila), h kateremu so bili dodani rezultati poizvedbe. Uporablja se za prenos CSV in poročanje prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki določa pot, uporabljeno za to poizvedbo.	true
`error_code`	integer	Dodatna interna koda napake, ki zagotavlja dodatne informacije za diagnostiko podpore strankam.	true

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

POST/mnp-lookupszaščiteno

Sproži paketno asinhrono preverjanje MNP (prenosljivost mobilnih številk), pridobi trenutni MCCMNC in v realnem času določi izvorno in trenutno omrežje. Rezultati se dostavijo prek webhookov na vaš strežnik. Ta metoda je optimizirana za obdelavo velikih količin številk, ki ne zahtevajo takojšnjega odziva, kot je čiščenje in preverjanje baz podatkov. Za aplikacije v realnem času, kot sta usmerjanje klicev ali dostava SMS sporočil, namesto tega uporabite končno točko POST /mnp-lookup.

MNP poizvedbe zanesljivo določijo prenosljivost in informacije o omrežju, vendar ne pokažejo, ali je ciljna mobilna naprava trenutno povezana z omrežjem in dosegljiva. Za pridobitev informacij o povezljivosti v realnem času uporabite končno točko POST /hlr-lookups.

Pred uporabo te končne točke zagotovite, da je konfiguriran webhook URL za asinhroni sprejem rezultatov poizvedovanja. To lahko nastavite v vaših nastavitvah API-ja.

Zahteva Uspešen odgovor Odgovor ob napaki Webhooks

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdns`	array	Tabela mobilnih telefonskih številk (MSISDN) v mednarodni obliki (npr. +14156226819 ali 0014156226819). V posamezno zahtevo lahko vključite do 1000 številk.	null	obvezno
`route`	string(3)	Neobvezen tristaven identifikator, ki določa pot za to poizvedbo. Nastavite na `null` ali izpustite ta parameter za uporabo vašega zemljevida usmerjanja po meri ali da sistem samodejno določi najboljše poti za to zahtevo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
   "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"
   ]
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`accepted`	array	Seznam objektov, ki vsebujejo edinstvene identifikatorje in MSISDN številke, ki so bile sprejete v obdelavo.	false
`accepted_count`	integer	Skupno število MSISDN številk, ki so bile uspešno sprejete v obdelavo.	false
`rejected`	array	Seznam objektov, ki vsebujejo edinstvene identifikatorje in MSISDN številke, ki so bile zavrnjene pri obdelavi, običajno zaradi neveljavnih številk. Za zavrnjene vnose se ne zaračunava.	false
`rejected_count`	integer	Skupno število MSISDN številk, zavrnjenih zaradi napak pri validaciji.	false
`total_count`	integer	Skupno število sprejetih in zavrnjenih MSISDN številk, ki so bile poslane v obdelavo.	false
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje skupne stroške v EUR za sprejeta poizvedovanja.	false
`storage`	string	Ime shrambe, kjer se dodajajo rezultati poizvedovanja, uporabljeno za poročanje in prenos CSV datotek prek spletnega vmesnika.	false
`route`	string(3)	Trimestni identifikator, ki določa pot, uporabljeno za to poizvedbo.	false
`webhook_urls`	array	Webhook URL-ji, konfigurirani v vaših nastavitvah API-ja. Rezultati se vrnejo na te naslove.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Obdelava webhookov

Po oddaji naša platforma začne obdelovati navedene telefonske številke in pošlje rezultate na predhodno določen URL webhook na vašem strežniku. Rezultati se prenašajo kot zahteva HTTP POST z objektom JSON v telesu zahteve.

Avtentikacija

Avtenticirajte webhook s preverjanjem glave HTTP X-Signatures.

Glava X-Signatures vsebuje seznam podpisov, ločenih s podpičjem. Vsak podpis na seznamu je ustvarjen z eno od skrivnosti API, konfiguriranih v vašem računu. Za preverjanje webhooka ustvarite zgoščeno vrednost SHA-256 z uporabo vašega ključa API, skrivnosti in surovega telesa HTTP - nato jo primerjajte s podpisi na seznamu.

Ujemanje potrjuje, da je zahteva pristna in podpisana s skrivnostjo, ki jo nadzorujete.

Primer kode

$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;
    }
}

Zahteva je veljavna, če kateri koli podpis v glavi ustreza zgoščeni vrednosti SHA256, izračunani nad povezanim nizom vašega ključa API, skrivnosti in telesa HTTP.

Potrditev prejema

Pričakuje se, da vaš strežnik odgovori s kodo stanja HTTP 200 OK za potrditev uspešnega prejema. Če je vrnjena katera koli druga koda odgovora, pride do časovne omejitve (10 sekund) ali nastane katera koli druga težava pri dostavi, bo sistem samodejno ponovil webhook po eni minuti. Če zahteva še naprej ne uspe, bodo ponovni poskusi sledili strategiji eksponentnega umika, s kasnejšimi poskusi po 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutah.

Ta mehanizem ponovnih poskusov zagotavlja največjo zanesljivost pri dostavi rezultatov poizvedb v vašo infrastrukturo. Zmanjšuje tveganje izgube podatkov zaradi začasnih težav z omrežjem ali nedelovanja strežnika.

Vsebina webhooka

{
    "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
        }
    ]
}

Atributi webhook podatkovnega tovora

Objekt JSON vsebuje atribut type => MNP skupaj z atributom results, ki vključuje seznam objektov poizvedovanja, kot je dokumentirano spodaj.

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni 12-mestni identifikator za to poizvedbo.	false
`msisdn`	string	Mobilna telefonska številka, ki je bila preverjena v tej poizvedbi.	false
`query_status`	string	Označuje, ali je bilo pridobivanje informacij o prenosljivosti in omrežju uspešno. Možne vrednosti so `OK` ali `FAILED`.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestna koda MCCMNC (kombinacija kode mobilne države in kode mobilnega omrežja), ki identificira omrežje, kateremu mobilna telefonska številka trenutno pripada.	true
`mcc`	string(3)	Trimestna koda MCC (koda mobilne države), ki predstavlja državo, povezano s trenutnim omrežjem mobilne telefonske številke.	true
`mnc`	string(2\|3)	Dvo- ali trimestna koda MNC (koda mobilnega omrežja), ki identificira trenutnega omrežnega operaterja za mobilno telefonsko številko.	true
`is_ported`	boolean	Označuje, ali je bila telefonska številka prenesena iz izvirnega omrežja k novemu operaterju.	true
`original_network_name`	string	Poljuben niz (v angleščini), ki določa ime izvirnega omrežnega operaterja preverjene mobilne telefonske številke.	true
`original_country_name`	string	Poljuben niz (v angleščini), ki označuje izvirno državo preverjene mobilne telefonske številke.	true
`original_country_code`	string(2)	Dvomestna koda države ISO, ki predstavlja izvirno državo preverjene mobilne telefonske številke.	true
`original_country_prefix`	string	Klicna koda izvorne države, povezane s preverjeno mobilno telefonsko številko.	true
`ported_network_name`	string	Določa omrežnega operaterja, h kateremu je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_name`	string	Določa državo, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_code`	string(2)	Dvomestna koda države ISO, ki predstavlja državo, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`ported_country_prefix`	string	Klicna koda države, v katero je bila prenesena preverjena mobilna telefonska številka, če je primerno.	true
`extra`	string	Poljuben niz, ki podaja dodatne podrobnosti o telefonski številki, če so na voljo.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške v EUR za to poizvedbo.	true
`timestamp`	string	Časovni žig v formatu W3C, vključno z informacijami o časovnem pasu, ki označuje, kdaj je bila poizvedba zaključena.	true
`storage`	string	Ime shranjevanja (ali ime poročila), h kateremu so bili dodani rezultati poizvedbe. Uporablja se za prenos CSV in poročanje prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki določa pot, uporabljeno za to poizvedbo.	true
`error_code`	integer	Dodatna interna koda napake, ki zagotavlja dodatne informacije za diagnostiko podpore strankam.	true

Pomakni se gor

POST/nt-lookupzaščiteno

Izvede sinhrono poizvedbo tipa številke (NT). Ta končna točka je idealna, če je vaš primarni cilj ugotoviti, ali podane telefonske številke spadajo v razpone fiksnih, mobilnih, premium, VoIP, pozivniških ali drugih številčnih načrtov v realnem času.

NT poizvedbe zanesljivo odkrijejo tip telefonske številke, vendar ne pokažejo, ali je ciljna številka trenutno povezana z omrežjem in dosegljiva. Za pridobitev informacij o trenutni povezljivosti uporabite končno točko POST /hlr-lookup.

Če vaš primer uporabe zahteva natančne informacije o omrežju in prenosljivosti (MCCMNC), ne pa tudi status trenutne povezljivosti, uporabite končno točko POST /mnp-lookup za poizvedbe o prenosljivosti mobilnih številk.

Zahteva Uspešen odgovor Odgovor ob napaki Referenca tipov

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`number`	string	Telefonska številka v mednarodni obliki (npr. +4989702626 ali 004989702626).	null	mandatory
`route`	string(3)	Neobvezen tristanovni identifikator, ki določa pot za to poizvedbo. Nastavite na `null` ali izpustite ta parameter, da uporabite svoj zemljevid usmeritev po meri ali pustite našemu sistemu, da samodejno določi najboljše poti za to zahtevo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
     "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"
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni identifikator, dodeljen tej zahtevi za poizvedbo.	false
`number`	string	Telefonska številka, ki je bila ovrednotena med to zahtevo za poizvedbo.	false
`number_type`	string	Zaznana vrsta številke. Možne vrednosti vključujejo: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Označuje, ali so bile informacije o vrsti številke uspešno pridobljene. Vrne `OK`, če je bilo uspešno, ali `FAILED`, če je poizvedba spodletela.	false
`is_valid`	boolean	Označuje, ali je telefonska številka sintaktično veljavna.	true
`invalid_reason`	string	Besedilno sporočilo v angleščini, ki navaja, zakaj se telefonska številka šteje za neveljavno (npr. "too short" ali "invalid prefix"), ali `null`, če je številka veljavna.	true
`is_possibly_ported`	boolean	Označuje, ali je bila telefonska številka morda prenesena od prvotnega operaterja k drugemu ponudniku. Za dokončne informacije o prenosljivosti uporabite MNP poizvedbe.	true
`is_vanity_number`	boolean	Označuje, ali je telefonska številka vanity številka, kar pomeni, da vključuje abecedne znake.	true
`qualifies_for_hlr_lookup`	boolean	Označuje, ali je telefonska številka primerna za dodatne poizvedbe prek HLR poizvedb.	true
`mccmnc`	string(5\|6)	Pet ali šest znakov dolg niz, ki predstavlja MCCMNC tuple (mobilna koda države in mobilna omrežna koda), ki identificira prvotno omrežje mobilne telefonske številke.	true
`mcc`	string(3)	Tri znake dolg niz, ki predstavlja MCC (mobilna koda države), ki identificira državo, povezano s prvotnim mobilnim omrežjem telefonske številke.	true
`mnc`	string(2\|3)	Dva ali tri znake dolg niz, ki predstavlja MNC (mobilna omrežna koda), ki identificira prvotnega mobilnega omrežnega operaterja telefonske številke.	true
`original_network_name`	string	Poljuben besedilni niz v angleščini, ki določa ime prvotnega omrežnega operaterja preverjene mobilne telefonske številke.	true
`original_country_name`	string	Poljuben besedilni niz v angleščini, ki določa prvotno državo, povezano s preverjeno mobilno telefonsko številko.	true
`original_country_code`	string(2)	Dvoznamenkasta ISO koda države, ki označuje prvotno državo preverjene mobilne telefonske številke.	true
`regions`	array	Seznam berljivih nizov v angleščini, ki določajo geografsko regijo(-e), povezano(-e) s to telefonsko številko.	true
`timezones`	array	Seznam časovnih pasov (v Olson formatu), povezanih s to telefonsko številko.	true
`info_text`	string	Poljuben niz, ki lahko vsebuje dodatne informacije o telefonski številki.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške (v EUR) te poizvedbe.	true
`timestamp`	string	Časovni žig v W3C formatu (vključno s časovnim pasom), ki označuje, kdaj je bila poizvedba zaključena.	true
`storage`	string	Določa ime shrambe, kjer so bili rezultati poizvedbe dodani. To ustreza imenu poročila, uporabljenem za prenose CSV in analitiko prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki določa pot, uporabljeno za to poizvedbo.	true

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Tip	Opis
LANDLINE	Številka fiksnega telefona.
MOBILE	Številka mobilnega telefona. Primerna za HLR poizvedbe za pridobitev dodatnih informacij o stanju povezave, omrežju, prenosljivosti in gostovanju.
MOBILE_OR_LANDLINE	Številka fiksnega ali mobilnega telefona. Morda primerna za HLR poizvedbo.
TOLL_FREE	Brezplačna telefonska številka.
PREMIUM_RATE	Telefonska številka s povečano tarifo z dodatnimi stroški.
SHARED_COST	Telefonska številka z deljenim stroškom. Običajno cenejša od številk s povečano tarifo.
VOIP	Telefonska številka Voice over IP. Vključuje TSoIP telefonske številke (Telephony Service over IP).
PAGER	Številka pozivnika. Običajno brez glasovne funkcionalnosti.
UAN	Univerzalna dostopna številka (številka podjetja). Lahko je usmerjena v določene pisarne, vendar omogoča uporabo ene številke za celotno podjetje.
VOICEMAIL	Številka glasovne pošte.
UNKNOWN	Vrste številke ni bilo mogoče določiti.

Pomakni se gor

POST/nt-lookups zaščiteno

Ta končna točka sproži serijo asinhronih preverjanj tipa številke, rezultati pa se pošljejo nazaj na vaš strežnik prek webhooka. Primerna je, če je vaš glavni cilj ugotoviti, ali dane telefonske številke pripadajo fiksnim, mobilnim, premium, VoIP, pozivniškim ali drugim obsegom številčnega načrta. Optimizirana za hitro obdelavo velikih količin številk, ta končna točka je idealna za masovne operacije (npr. čiščenje baze podatkov). Za prenos v živo in časovno kritične primere uporabe prosimo uporabite končno točko POST /nt-lookup.

Pred uporabo te končne točke morate v nastavitvah API določiti URL webhooka.

Zahteva Uspešen odgovor Odgovor ob napaki Webhooks Referenca tipov

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

Podatki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`numbers`	array	Niz telefonskih številk v mednarodnem formatu (npr. +14156226819 ali 004989702626). Največ 1000 številk je lahko vključenih v posamezno zahtevo.	null	obvezno
`route`	string(3)	Neobvezen triznačni identifikator, ki določa pot za to preverjanje. Nastavite na `null` ali izpustite ta parameter, da uporabite vaš zemljevid usmeritve po meri ali pustite našemu sistemu, da samodejno določi najboljšo pot za to zahtevo.	null	neobvezno
`storage`	string	Neobvezen identifikator shranjevanja, ki določa poročilo, kjer bodo rezultati shranjeni za ročni pregled, analitiko in poročanje. Sistem samodejno doda časovni žig s trenutnim mesecem. Če je izpuščeno ali nastavljeno na `null`, bo sistem samodejno združil rezultate po mesecih za namene poročanja.	null	neobvezno

{
   "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"
   ]
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`accepted`	array	Niz objektov, od katerih vsak vsebuje unikatni identifikator in telefonsko številko, ki je bila sprejeta v obdelavo.	false
`accepted_count`	integer	Skupno število telefonskih številk, sprejetih v obdelavo.	false
`rejected`	array	Niz objektov, od katerih vsak vsebuje unikatni identifikator in telefonsko številko, ki je bila zavrnjena za obdelavo. Običajno so te številke neveljavne in se ne zaračunajo.	false
`rejected_count`	integer	Skupno število telefonskih številk, ki so bile zavrnjene za obdelavo.	false
`total_count`	integer	Skupno število sprejetih in zavrnjenih telefonskih številk, poslanih v obdelavo.	false
`cost`	string	Niz, ki predstavlja decimalno vrednost in označuje stroške v EUR za ta preverjanja.	false
`storage`	string	Ime shrambe (poročila), kamor so bili dodani rezultati preverjanja. To ime se uporablja za prenose CSV in analitiko prek spletnega vmesnika.	false
`route`	string(3)	Triznačni identifikator, ki določa pot, uporabljeno za to zahtevo preverjanja.	false
`webhook_urls`	array	Webhook URL-ji, konfigurirani v vaših nastavitvah API-ja. Rezultati se vrnejo na te naslove.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Obdelava webhookov

Po oddaji naša platforma začne obdelovati navedene telefonske številke in pošlje rezultate na predhodno določen URL webhook na vašem strežniku. Rezultati se prenašajo kot zahteva HTTP POST z objektom JSON v telesu zahteve.

Avtentikacija

Avtenticirajte webhook s preverjanjem glave HTTP X-Signatures.

Glava X-Signatures vsebuje seznam podpisov, ločenih s podpičjem. Vsak podpis na seznamu je ustvarjen z eno od skrivnosti API, konfiguriranih v vašem računu. Za preverjanje webhooka ustvarite zgoščeno vrednost SHA-256 z uporabo vašega ključa API, skrivnosti in surovega telesa HTTP - nato jo primerjajte s podpisi na seznamu.

Ujemanje potrjuje, da je zahteva pristna in podpisana s skrivnostjo, ki jo nadzorujete.

Primer kode

$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;
    }
}

Zahteva je veljavna, če kateri koli podpis v glavi ustreza zgoščeni vrednosti SHA256, izračunani nad povezanim nizom vašega ključa API, skrivnosti in telesa HTTP.

Potrditev prejema

Pričakuje se, da vaš strežnik odgovori s kodo stanja HTTP 200 OK za potrditev uspešnega prejema. Če je vrnjena katera koli druga koda odgovora, pride do časovne omejitve (10 sekund) ali nastane katera koli druga težava pri dostavi, bo sistem samodejno ponovil webhook po eni minuti. Če zahteva še naprej ne uspe, bodo ponovni poskusi sledili strategiji eksponentnega umika, s kasnejšimi poskusi po 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutah.

Ta mehanizem ponovnih poskusov zagotavlja največjo zanesljivost pri dostavi rezultatov poizvedb v vašo infrastrukturo. Zmanjšuje tveganje izgube podatkov zaradi začasnih težav z omrežjem ali nedelovanja strežnika.

Vsebina webhooka

{
   "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"
      }
   ]
}

Atributi webhook podatkovnega tovora

Objekt JSON vsebuje atribut type => NT skupaj z atributom results, ki vključuje seznam objektov poizvedovanja, kot je dokumentirano spodaj.

Ime	Tip	Opis	Lahko je null
`id`	string(12)	Edinstveni identifikator, dodeljen tej zahtevi za poizvedbo.	false
`number`	string	Telefonska številka, ki je bila ovrednotena med to zahtevo za poizvedbo.	false
`number_type`	string	Zaznana vrsta številke. Možne vrednosti vključujejo: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Označuje, ali so bile informacije o vrsti številke uspešno pridobljene. Vrne `OK`, če je bilo uspešno, ali `FAILED`, če je poizvedba spodletela.	false
`is_valid`	boolean	Označuje, ali je telefonska številka sintaktično veljavna.	true
`invalid_reason`	string	Besedilno sporočilo v angleščini, ki navaja, zakaj se telefonska številka šteje za neveljavno (npr. "too short" ali "invalid prefix"), ali `null`, če je številka veljavna.	true
`is_possibly_ported`	boolean	Označuje, ali je bila telefonska številka morda prenesena od prvotnega operaterja k drugemu ponudniku. Za dokončne informacije o prenosljivosti uporabite MNP poizvedbe.	true
`is_vanity_number`	boolean	Označuje, ali je telefonska številka vanity številka, kar pomeni, da vključuje abecedne znake.	true
`qualifies_for_hlr_lookup`	boolean	Označuje, ali je telefonska številka primerna za dodatne poizvedbe prek HLR poizvedb.	true
`mccmnc`	string(5\|6)	Pet ali šest znakov dolg niz, ki predstavlja MCCMNC tuple (mobilna koda države in mobilna omrežna koda), ki identificira prvotno omrežje mobilne telefonske številke.	true
`mcc`	string(3)	Tri znake dolg niz, ki predstavlja MCC (mobilna koda države), ki identificira državo, povezano s prvotnim mobilnim omrežjem telefonske številke.	true
`mnc`	string(2\|3)	Dva ali tri znake dolg niz, ki predstavlja MNC (mobilna omrežna koda), ki identificira prvotnega mobilnega omrežnega operaterja telefonske številke.	true
`original_network_name`	string	Poljuben besedilni niz v angleščini, ki določa ime prvotnega omrežnega operaterja preverjene mobilne telefonske številke.	true
`original_country_name`	string	Poljuben besedilni niz v angleščini, ki določa prvotno državo, povezano s preverjeno mobilno telefonsko številko.	true
`original_country_code`	string(2)	Dvoznamenkasta ISO koda države, ki označuje prvotno državo preverjene mobilne telefonske številke.	true
`regions`	array	Seznam berljivih nizov v angleščini, ki določajo geografsko regijo(-e), povezano(-e) s to telefonsko številko.	true
`timezones`	array	Seznam časovnih pasov (v Olson formatu), povezanih s to telefonsko številko.	true
`info_text`	string	Poljuben niz, ki lahko vsebuje dodatne informacije o telefonski številki.	true
`cost`	string	Decimalna vrednost, predstavljena kot niz, ki označuje stroške (v EUR) te poizvedbe.	true
`timestamp`	string	Časovni žig v W3C formatu (vključno s časovnim pasom), ki označuje, kdaj je bila poizvedba zaključena.	true
`storage`	string	Določa ime shrambe, kjer so bili rezultati poizvedbe dodani. To ustreza imenu poročila, uporabljenem za prenose CSV in analitiko prek spletnega vmesnika.	true
`route`	string(3)	Trimestni identifikator, ki določa pot, uporabljeno za to poizvedbo.	true

Tip	Opis
LANDLINE	Številka fiksnega telefona.
MOBILE	Številka mobilnega telefona. Primerna za HLR poizvedbe za pridobitev dodatnih informacij o stanju povezave, omrežju, prenosljivosti in gostovanju.
MOBILE_OR_LANDLINE	Številka fiksnega ali mobilnega telefona. Morda primerna za HLR poizvedbo.
TOLL_FREE	Brezplačna telefonska številka.
PREMIUM_RATE	Telefonska številka s povečano tarifo z dodatnimi stroški.
SHARED_COST	Telefonska številka z deljenim stroškom. Običajno cenejša od številk s povečano tarifo.
VOIP	Telefonska številka Voice over IP. Vključuje TSoIP telefonske številke (Telephony Service over IP).
PAGER	Številka pozivnika. Običajno brez glasovne funkcionalnosti.
UAN	Univerzalna dostopna številka (številka podjetja). Lahko je usmerjena v določene pisarne, vendar omogoča uporabo ene številke za celotno podjetje.
VOICEMAIL	Številka glasovne pošte.
UNKNOWN	Vrste številke ni bilo mogoče določiti.

Pomakni se gor

GET/routezaščiteno

Pridobi pot, ki bo samodejno izbrana, ko izvedete HLR poizvedbo brez določitve parametra route.

Samodejni izbor poti temelji na zemljevidu usmerjanja, ki ga lahko pridobite z vmesnikom GET /hlr-coverage, ta pa izhaja predvsem iz GET /routing-map. Svoj zemljevid usmerjanja lahko prilagodite in določite pravila po meri v nastavitvah računa.

Zahteva Uspešen odgovor Odgovor ob napaki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdn`	string	MSISDN, za katerega želite pridobiti samodejno izbrane podatke o usmerjanju.	null	obvezno

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

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`route`	string	Priporočena pot.	false
`confidence_level`	string	Stopnja zaupanja, s katero je bila izbrana ta pot, tj. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	MCCMNC na podlagi oštevilčevalnega načrta za to številko.	false
`origin`	string	Izvor, na katerem temelji odločitev o usmerjanju, tj. `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."
    ]
}

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/routeszaščiteno

Ta končna točka vrne seznam razpoložljivih HLR, MNP in NT poti. Vsaka pot, skupaj z njenimi funkcijami in omejitvami, je razložena na strani podrobnosti usmerjanja.

Zahteva Uspešen odgovor Odgovor ob napaki

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

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

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`routes`	object	Objekt s potmi, razvrščenimi po vrsti poti.	false
`HLR\|MNP\|NT`	string[]	Vsebuje seznam identifikatorjev poti.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/routing-mapzaščiteno

Pridobi konfiguracijo avtomatskega usmerjanja, ki se trenutno uporablja za HLR poizvedbe v vašem računu. Ta privzeta konfiguracija se uporabi vsakič, ko oddate HLR poizvedbe brez določitve parametra route. Svojo shemo usmerjanja lahko prilagodite in ustvarite pravila po meri v nastavitvah računa.

Hierarhija konfiguracije se razširja od pravil na ravni države do pravil na ravni MCCMNC in nazadnje do preslikav posameznih predpon telefonskih številk. V praksi to pomeni, da imajo preslikave posameznih predpon telefonskih številk prednost pred konfliktnimi dodelitvami MCCMNC, ki pa prevladajo nad pravili na ravni države. Upoštevajte, da MNP nadomestno usmerjanje preglasi vsa konfliktna pravila po meri, ko je omogočeno.

Zahteva Uspešen odgovor Odgovor ob napaki

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"
            }
         ]
      }
   }
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`default_route`	string	Privzeta pot, ki se uporabi, ko za MSISDN ni mogoče določiti prednostne možnosti usmerjanja in ne veljajo nobena pravila usmerjanja po meri.	false
`mnp_fallback`	boolean	Označuje, ali je omogočeno MNP nadomestno usmerjanje. Ko je omogočeno in omrežje ne podpira HLR poizvedb (stanje povezljivosti ni na voljo), bo sistem namesto tega izvedel MNP poizvedbo.	false
`mccmncs`	array	Preslikava kod MCCMNC na njihove samodejno izbrane poti. Pri izvajanju HLR poizvedbe za številko v določenem MCCMNC se uporabi ustrezna pot.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestni MCCMNC (kombinacija mobilne kode države in mobilne omrežne kode), ki identificira mobilnega omrežnega operaterja.	false
`countrycode`	string(2)	Dvomestna koda države ISO, ki identificira državo omrežja.	false
`route`	string(3)	Izbrana pot za omrežje.	false
`mno`	string	Potrošniška blagovna znamka, pod katero deluje to omrežje.	false
`confidence`	string	Raven zaupanja, s katero je bila opravljena izbira. Možne vrednosti so: HIGH, NORMAL, LOW, MNP_REDIRECT. V primeru slednjega sistem preusmeri promet v to omrežje na MNP, če je to obnašanje omogočeno v vašem računu. V nasprotnem primeru uporabi privzeto pot v računu.	false
`origin`	string	Izvor, na katerem temelji izbira. Možne vrednosti so: `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	Seznam pravil usmerjanja po meri na podlagi predpon, konfiguriranih v vašem računu, če obstajajo.	false
`countrycode`	string(2)	Dvomestna koda države ISO, ki identificira državo predpone.	false
`cns`	string	Predpona, za katero velja pravilo usmerjanja.	false
`route`	string(3)	Izbrana pot za predpono.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestni MCCMNC (kombinacija mobilne kode države in mobilne omrežne kode), ki identificira mobilnega omrežnega operaterja.	true
`mno`	string	Potrošniška blagovna znamka, pod katero deluje to omrežje.	true
`countries`	array	Seznam pravil po meri na podlagi države, konfiguriranih v vašem računu, če obstajajo.	false
`countrycode`	string(2)	Dvomestna koda države ISO, ki identificira državo.	false
`route`	string(3)	Izbrana pot za državo.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/hlr-coverage zaščiteno

Vrne vpoglede v HLR pokritost za podporo odločanju na podlagi podatkov. Ta končna točka vam pomaga analizirati možnosti usmerjanja HLR v realnem času po mobilnih omrežjih, prepoznati najučinkovitejše poti za vaše ciljne regije in konfigurirati samodejno usmerjanje.

Priporočene poti iz GET /route temeljijo na podatkih o pokritosti, pridobljenih tukaj. Podatki o pokritosti so na voljo tudi na strani pokritost omrežja. Svojo karto usmerjanja lahko dodatno prilagodite in določite pravila v nastavitvah računa.

Priporočamo, da se seznanite s tem vodnikom, ki vam bo pomagal pri razlagi rezultatov.

Zahteva Uspešen odgovor Odgovor ob napaki Referenca stanj

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`countrycode`	string(2)	Obvezna dvočrkovna ISO koda države, uporabljena za filtriranje rezultatov, ki vrne samo zapise, povezane z določeno državo.	null	obvezno
`sample_size`	string	Neobvezen parameter, ki določa velikost vzorca. Možne vrednosti so `LARGE`, `MEDIUM`, `SMALL`. Večji vzorci pokrivajo daljše časovno obdobje, manjši vzorci pokrivajo zelo nedavno časovno obdobje.	LARGE	neobvezno

{
   "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
            }
         ]
      }
   ]
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`name`	string	Ime izbrane države v angleškem besedilu.	false
`countrycode`	string(2)	Dvočrkovna ISO koda izbrane države.	false
`prefix`	string	Mednarodna klicna predpona izbrane države.	false
`mccs`	string[]	Seznam MCC (mobilnih kod držav), povezanih z izbrano državo.	false
`carriers`	object[]	Seznam operaterjev z metrikami povezljivosti, specifičnimi za posamezno pot.	false
`mno`	string	Ime mobilnega operaterja v angleškem besedilu.	false
`mccmnc`	string	MCCMNC mobilnega operaterja.	false
`mcc`	string	MCC (mobilna koda države) mobilnega operaterja.	false
`mnc`	string	MNC (mobilna omrežna koda) mobilnega operaterja.	false
`routes`	object[]	Seznam rezultatov povezljivosti, specifičnih za posamezno pot.	false
`route`	string	Pot, na katero se nanašajo informacije o povezljivosti.	false
`selected`	bool	Označuje, ali je to izbrana pot za samodejno usmerjanje.	false
`selection_confidence`	string	Stopnja zaupanja, s katero je bila izbrana ta pot, tj. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Vsebuje null, če to ni izbrana pot.	true
`n`	int	Skupno število poizvedb v tem vzorcu.	false
`CONNECTED`	int	Število HLR poizvedb, ki so vrnile status CONNECTED.	false
`CONNECTED_PCT`	float	Odstotek HLR poizvedb, ki so vrnile status CONNECTED.	false
`ABSENT`	int	Število HLR poizvedb, ki so vrnile status ABSENT.	false
`ABSENT_PCT`	float	Odstotek HLR poizvedb, ki so vrnile status ABSENT.	false
`INVALID_MSISDN`	int	Število HLR poizvedb, ki so vrnile status INVALID_MSISDN.	false
`INVALID_MSISDN_PCT`	float	Odstotek HLR poizvedb, ki so vrnile status INVALID_MSISDN.	false
`UNDETERMINED`	int	Število HLR poizvedb, ki so vrnile status UNDETERMINED.	false
`UNDETERMINED_PCT`	float	Odstotek HLR poizvedb, ki so vrnile status UNDETERMINED.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Status	Opis
CONNECTED	Številka je veljavna in ciljna naprava je trenutno povezana z mobilnim omrežjem. Klici, SMS sporočila in druge storitve bi morali uspešno doseči prejemnika.
ABSENT	Številka je veljavna, vendar je ciljna naprava bodisi izklopljena bodisi začasno izven dosega omrežja. Sporočila ali klici morda ne bodo dostavljeni, dokler se naprava ponovno ne poveže z omrežjem.
INVALID_MSISDN	Številka je neveljavna ali trenutno ni dodeljena nobenemu naročniku v mobilnem omrežju. Klici in sporočila na to številko ne bodo uspeli.
UNDETERMINED	Statusa povezljivosti številke ni bilo mogoče določiti. To je lahko posledica neveljavne številke, SS7 napake ali pomanjkanja povezljivosti s ciljnim omrežnim operaterjem. Za dodatno diagnostiko preverite kodo napake in njeno polje z opisom.

Pomakni se gor

GET/mnp-coveragezaščiteno

Ta končna točka vrne seznam mobilnih omrežnih operaterjev skupaj z njihovimi ustreznimi identifikatorji MCCMNC, ki so trenutno podprti za poizvedbe o prenosljivosti mobilnih številk.

Zahteva Uspešen odgovor Odgovor ob napaki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`countrycode`	string(2)	Neobvezna dvočrkovna koda države ISO, ki se uporablja za filtriranje rezultatov MCCMNC in vrača samo podatke, relevantne za določeno državo.	null	neobvezno

{
   "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"
      }
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`items[]`	array	Seznam operaterjev mobilnih omrežij.	false
`country_name`	string	Ime države v angleškem jeziku.	false
`country_code`	string(2)	Dvočrkovna koda države ISO.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestni MCCMNC (kombinacija mobilne kode države in mobilne omrežne kode), ki identificira mobilnega omrežnega operaterja.	false
`mcc`	string(3)	Tričrkovna MCC (mobilna koda države), ki predstavlja državo omrežja.	false
`mnc`	string(2\|3)	Dvo- ali tričrkovna MNC (mobilna omrežna koda), ki predstavlja določenega mobilnega omrežnega operaterja.	false
`brand`	string	Potrošniška blagovna znamka, pod katero deluje to omrežje.	true
`operator`	string	Pravno ime mobilnega omrežnega operaterja.	true

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/price-listzaščiteno

Ta končna točka vrne seznam držav, kjer so podprte samo MNP poizvedbe, medtem ko HLR poizvedbe za te destinacije niso na voljo.

Zahteva Uspešen odgovor Odgovor ob napaki

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

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

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`countries`	string[]	Seznam dvomestnih ISO kod držav.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/mccmncszaščiteno

Ta končna točka vrne celovit seznam operaterjev mobilnih omrežij skupaj z njihovimi ustreznimi identifikatorji MCCMNC in dodatnimi kontekstualnimi informacijami.

Zahteva Uspešen odgovor Odgovor ob napaki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`countrycode`	string(2)	Neobvezna dvočrkovna ISO koda države, uporabljena za filtriranje rezultatov MCCMNC, ki vrne samo zapise, povezane z določeno državo.	null	neobvezno

{
   "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"
      }
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`items`	object[]	Seznam operaterjev mobilnih omrežij.	false
`country_name`	string	Polno ime države v angleškem jeziku.	false
`country_code`	string(2)	Dvočrkovna ISO koda države, ki predstavlja državo mobilnega operaterja.	false
`mccmnc`	string(5\|6)	Pet- ali šestmestni niz, ki predstavlja MCCMNC in edinstveno identificira operaterja mobilnega omrežja.	false
`mcc`	string(3)	Trimestna koda mobilne države (MCC), ki identificira državo, v kateri deluje mobilno omrežje.	false
`mnc`	string(2\|3)	Dvo- ali trimestna koda mobilnega omrežja (MNC), ki določa mobilno omrežje znotraj dane kode MCC.	false
`brand`	string	Komercialno blagovno ime, pod katerim omrežje deluje in ga prepoznavajo potrošniki.	true
`operator`	string	Uradno ime operaterja mobilnega omrežja, običajno pravna oseba, ki upravlja omrežje.	true
`parent_mccmnc`	string(5\|6)	Pet- ali šestmestni niz, ki predstavlja MCCMNC nadrejenega operaterja mobilnega omrežja, če obstaja.	true

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/pricezaščiteno

Ta končna točka vrne ceno za HLR, MNP ali NT poizvedbo.

Zahteva Uspešen odgovor Odgovor ob napaki

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

Parametri zahteve

Ključ	Tip	Opis	Privzeto	Obvezno
`msisdn`	string	Telefonska številka, za katero želite pridobiti ceno. V mednarodni obliki.	null	obvezno
`route_type`	string	Vrsta poti, npr. `HLR`, `MNP`, `NT`.	null	obvezno
`route`	string(3)	Pot, za katero naj se izračuna cena. Privzeto se uporabi pot, določena z avtomatskim usmerjanjem.	null	neobvezno

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

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`price`	object	Objekt s podrobnostmi o ceni.	false
`amount`	string	Znesek v EUR.	false
`msisdn`	string	MSISDN, za katerega velja ta cena.	false
`route_type`	string(2\|3)	Vrsta poti, za katero velja ta cena.	false
`route`	string(3)	Pot, za katero velja ta cena.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/price-listzaščiteno

Ta končna točka vrne cene v vašem računu.

Zahteva Uspešen odgovor Odgovor ob napaki

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"
      }
   ]
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`pricing`	object[]	Seznam objektov s podatki o cenah.	false
`route`	string	Pot, za katero velja ta cena.	false
`countrycode`	string	Dvomestna ISO koda države, za katero velja ta cena za ustrezno pot, če obstaja.	true
`countryname`	string	Angleško ime države, ki ustreza kodi države, če obstaja.	true
`mccmnc`	string	MCCMNC, za katerega velja ta cena za ustrezno pot, če obstaja. Preglasi cene na ravni države.	true
`cns`	string	Klicna predpona, za katero velja ta cena za ustrezno pot, če obstaja. Preglasi cene na ravni države in cene na ravni MCCMNC.	true
`route_type`	string	Ustrezna vrsta poti, tj. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Ustrezna cena v EUR.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/balancezaščiteno

Ta končna točka pridobi trenutno stanje vašega računa, kar vam omogoča avtomatizacijo procesov na podlagi vašega kreditnega statusa. Deluje brezhibno z obvestili o nizkem kreditu po e-pošti, ki jih lahko nastavite na vaši strani za plačila.

Zahteva Uspešen odgovor Odgovor ob napaki

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

{
    "balance":"1002.90"
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`balance`	string	Trenutno stanje vašega računa v EUR. Decimalna vrednost tipa string.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/pingjavno

Ta končna točka pošlje ping zahtevo API-ju in omogoča preprost način za testiranje povezave z HLR Lookups API-jem.

Zahteva Uspešen odgovor Odgovor ob napaki

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

{
    "success":true
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`success`	boolean	Označuje, da je bila zahteva uspešno obdelana.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/timejavno

Ta končna točka vrne časovni žig Unix, ki predstavlja trenutni čas na strežniku HLR Lookups. Uporabite jo za sinhronizacijo ure vašega strežnika pri generiranju podpisa Digest-Auth za avtentikacijo, s čimer zagotovite, da so morebitna neskladja med časom vašega strežnika in časom strežnika HLR Lookups popravljena.

Zahteva Uspešen odgovor Odgovor ob napaki

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

{
    "time":1525898643
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`time`	integer	Časovni žig Unix, ki predstavlja trenutni čas strežnika HLR Lookups.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

GET/auth-testzaščiteno

Ta končna točka služi kot začetni test za vašo implementacijo Basic-Auth ali, po možnosti, Digest-Auth.

Basic Auth zahtevek Zahteva Digest Auth Uspešen odgovor Odgovor ob napaki

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

Glave zahtevka

Ključ	Tip	Opis
`X-Basic`	string	SHA256 zgoščena vrednost `YOUR_API_KEY:YOUR_API_SECRET`. V zgoščeno vrednost vključite dvopičje (:).

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"

Glave zahtevka

Ključ	Tip	Opis
`X-Digest-Key`	string	Vaš API ključ za HLR Lookups
`X-Digest-Signature`	string	Edinstven podpis Digest-Auth (glejte avtentikacija)
`X-Digest-Timestamp`	integer	Trenutna časovna značka Unix (glejte tudi `GET /time`)

{
    "success":true
}

Atributi uspešnega odgovora

Ime	Tip	Opis	Lahko je null
`success`	boolean	Označuje, da je bila zahteva uspešno obdelana.	false

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

Parametri odziva napake

Ime	Tip	Opis	Lahko je null
`errors[]`	string[]	Seznam nizov, ki pojasnjujejo napako.	false

Pomakni se gor

Dokumentacija starega API-ja

Opozarjamo, da je stari API opuščen in bo v prihodnosti umaknjen. Močno priporočamo nadgradnjo na najnovejšo različico ob prvi priložnosti.

Če ste naš HLR Lookups API implementirali med letoma 2013 in začetkom leta 2020, uporabljate naš stari API. V tem primeru si oglejte našo dokumentacijo starega API-ja.

Dokumentacija starega API-ja

Dokumentacija API

Začetek dela

HLR poizvedbe

MNP poizvedbe

NT poizvedbe

Usmerjanje

Cenik

Orodja

Začetek dela

Uporaba API-ja HLR Lookups

Primer zahtevka

Primer vsebine

Uspešen odgovor application/json

Dodatne storitve poizvedb

Poizvedbe o prenosljivosti mobilnih številk (MNP)

Poizvedbe o tipu številke (NT)

Razvojni kompleti (SDK)

Orodja

Niste razvijalec?

Avtentikacija

API ključ in API skrivnost

HTTP Basic Auth

Priporočeno: X-Basic glava s SHA256

Basic Auth zahtevek

Glave osnovne avtentikacije

Primer kode

Primer zahtevka

Glave zahtevka

Sestavljanje podpisa

Komponente Digest podpisa

Primeri kode

Koncepti

Sinhroni HLR Lookup API

Asinhroni HLR Lookup API

SDK-ji (kompleti za razvoj programske opreme)

SDK za PHP

SDK za NodeJS

SDK za Ruby

POST/hlr-lookupzaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake

POST/hlr-lookupszaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake

Obdelava webhookov

Avtentikacija

Primer kode

Potrditev prejema

Vsebina webhooka

Atributi webhook podatkovnega tovora

POST/mnp-lookupzaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake

POST/mnp-lookupszaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake

Obdelava webhookov

Avtentikacija

Primer kode

Potrditev prejema

Vsebina webhooka

Atributi webhook podatkovnega tovora

POST/nt-lookupzaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake

POST/nt-lookups zaščiteno

Podatki

Parametri zahteve

Atributi uspešnega odgovora

Parametri odziva napake