Početak rada

Globalna infrastruktura mobilne mreže funkcionira na sustavu poznatom kao SS7 signalizacijska mreža. Ova mreža omogućuje razmjenu podataka o pretplatnicima, usmjeravanje poziva, prijenos SMS poruka i ažuriranja statusa mobilne povezivosti u stvarnom vremenu između operatera. Svaka mobilna mreža održava Home Location Register (HLR) - temeljnu bazu podataka koja pohranjuje ključne podatke o svojim pretplatnicima.

HLR Lookup tehnologija omogućuje tvrtkama da upite ove registre i dohvate podatke o povezivosti i mreži u stvarnom vremenu za bilo koji broj mobilnog telefona. To uključuje informacije je li telefon uključen, kojoj mreži je trenutno dodijeljen, je li broj prenesen, je li broj valjan ili deaktiviran te je li u roamingu.

HLR Lookups API pruža besprijekoran pristup ovim podacima u stvarnom vremenu, omogućujući tvrtkama provjeru mobilnih brojeva, optimizaciju usmjeravanja i poboljšanje komunikacije s kupcima. Ova dokumentacija će vas voditi kroz integraciju HLR Lookups u vaš softver, omogućujući automatizirano dohvaćanje mobilnih informacija u stvarnom vremenu.

Korištenje HLR Lookups API-ja

Izvršavanje HLR Lookup upita je brzo, sigurno i jednostavno. Nakon što se registrirate i dobijete svoj API ključ, možete se autentificirati i pokrenuti trenutne upite jednostavnim HTTP POST zahtjevima, putem POST /hlr-lookup. Alternativno, možete obraditi velike skupove podataka odabirom brzih asinkronih API zahtjeva s rezultatima poslanim natrag na vaš poslužitelj putem webhooka, kako je objašnjeno u odjeljku koncepti.

Primjer zahtjeva

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"

Autentifikacija se provodi putem HTTP zaglavlja, a payload.json bi trebao (minimalno) sadržavati sljedeći JSON objekt:

Primjer payload-a

{
   "msisdn": "+14156226819"
}

Nakon uspješnog izvršenja, primit ćete odgovor koji sadrži podatke o povezivosti u stvarnom vremenu za navedeni mobilni broj.

Uspješan 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 potpunu razradu atributa zahtjeva i odgovora te statusa povezivosti, pogledajte POST /hlr-lookup.

Dodatne usluge upita

Upiti o prenosivosti mobilnih brojeva (MNP)

Koristite MNP upite za utvrđivanje vlasništva nad mrežom i detalja o prenosivosti bez upita o povezivosti u stvarnom vremenu. Ako vam je potreban samo MCCMNC broja, pogledajte POST /mnp-lookup.

Upiti o detekciji vrste broja (NT)

Utvrdite pripada li telefonski broj fiksnoj liniji, mobilnoj mreži, premium broju, VoIP-u, pageru ili drugim rasponima numeracijskog plana s POST /nt-lookup.

Razvojni paketi (SDK-ovi)

HLR Lookups API radi s bilo kojim REST klijentom u bilo kojem programskom jeziku, a objavili smo SDK-ove za PHP, Ruby i NodeJS na našem GitHub-u kako bismo vam pomogli brzo započeti.

Alati

Kako bismo osigurali besprijekorno razvojno iskustvo, nudimo sveobuhvatan skup alata, uključujući praćenje API zahtjeva i webhooka u pregledniku, dodavanje IP adresa na popis dopuštenih, robusne opcije autentifikacije i testnu krajnju točku za autentifikaciju.

Niste programer?

HLR Lookups i upiti o prenosivosti brojeva mogu se izvršiti bez programiranja. Saznajte više o našem poslovnom web klijentu i funkcijama izvještavanja u pregledniku.

Autentifikacija

Kako bi se osigurala sigurnost i pravilna kontrola pristupa, većina zahtjeva prema HLR Lookups API-ju zahtijeva autentifikaciju. Krajnje točke kategorizirane su kao javne ili zaštićene. Prilikom pristupa zaštićenoj krajnjoj točki, vaš zahtjev mora biti autentificiran korištenjem vašeg API ključa i tajne putem Digest-Auth ili Basic-Auth metode. Digest-Auth je sigurnija opcija i snažno se preporučuje. Koristite krajnju točku GET /auth-test za provjeru vaših postavki autentifikacije.

API ključ i API tajna

Preuzmite svoj API ključ i tajnu sa stranice API postavki. Također možete konfigurirati preferiranu metodu autentifikacije i omogućiti popis dopuštenih IP adresa za poboljšanu sigurnost. Ako sumnjate da je vaša API tajna kompromitirana, možete generirati novu u bilo kojem trenutku.

Basic autentifikacija Digest autentifikacija IP Bijela Lista

Standardna Basic autentifikacija jednostavna je za implementaciju i široko podržana. Možete se autentificirati slanjem vašeg API ključa i tajne kao user:pass para u HTTP zahtjevu.

HTTP Basic autentifikacija

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

Ovo šalje Authorization zaglavlje:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Preporučeno: X-Basic zaglavlje sa SHA256

Za poboljšanu sigurnost, možete poslati SHA256 hash vaših vjerodajnica umjesto da ih prenosite izravno kao base64. Za korištenje ove metode, izračunajte hash vašeg YOUR_API_KEY:YOUR_API_SECRET para i pošaljite ga putem X-Basic zaglavlja:

Basic autentifikacijski zahtjev

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

Basic autentifikacijska zaglavlja

Ključ	Tip	Opis
`X-Basic`	string	SHA256 hash od `YOUR_API_KEY:YOUR_API_SECRET`. Uključite simbol dvotočke (:) u hash.	obavezno

Primjer koda

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

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

Digest-Auth je preporučena metoda za osiguranje pristupa zaštićenim krajnjim točkama HLR Lookup API-ja. Svaki zahtjev mora sadržavati sljedeća zaglavlja: X-Digest-Key, X-Digest-Signature i X-Digest-Timestamp, koja su objašnjena u nastavku.

Primjer zahtjeva

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"

Zaglavlja zahtjeva

Ključ	Tip	Opis
`X-Digest-Key`	string	Vaš jedinstveni HLR Lookups API ključ.	obavezno
`X-Digest-Signature`	string	Jedinstveni autentifikacijski potpis (vidi niže).	obavezno
`X-Digest-Timestamp`	integer	Trenutna Unix vremenska oznaka (također vidi `GET /time`).	obavezno

Kreiranje potpisa

X-Digest-Signature se kreira korištenjem SHA256 HMAC hash-a, s vašom API tajnom kao zajedničkim ključem.

Niz za hashiranje strukturiran je na sljedeći način:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Simbol . predstavlja spajanje nizova.

Komponente Digest potpisa

Komponenta	Tip	Opis
`ENDPOINT_PATH`	string	Zatražena API krajnja točka, npr. `/auth-test` malim slovima.
`UNIX_TIMESTAMP`	integer	Trenutna Unix vremenska oznaka (mora biti unutar 30 sekundi). Vidi `GET /time`.
`REQUEST_METHOD`	string	Korištena HTTP metoda, npr. `POST` ili `GET`.
`REQUEST_BODY`	string	Podaci tijela zahtjeva. Postavite na `null` za `GET` zahtjeve.

Primjeri koda

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)

Pomaknite se gore

Koncepti

Implementacija HLR upita u bilo kojem programskom jeziku ili sustavu putem našeg HTTP REST API-ja je jednostavna i učinkovita. Uz jednostavan proces integracije, možete započeti s upitima mobilnih mreža u stvarnom vremenu za trenutne uvide u valjanost telefonskih brojeva, status povezivosti i detalje usmjeravanja.

Odabir odgovarajućeg API-ja ovisi o vašem specifičnom slučaju uporabe. Ako vam trebaju rezultati upita u stvarnom vremenu za aplikacije poput VoIP telefonije, otkrivanja prijevara ili SMS usmjeravanja, sinkroni API je najbolji izbor. Međutim, ako vaš slučaj uporabe uključuje obradu velikih količina podataka, skupne upite ili provjeru podataka velikih razmjera, asinkroni API nudi optimiziranu izvedbu s učinkovitošću propusnosti i mogućnostima skupnih upita.

Konfigurirajte API za korištenje jedne od naših prilagođenih opcija usmjeravanja kako biste optimizirali brzinu, točnost i isplativost. Također možete pohraniti rezultate upita u spremišta za jednostavno preuzimanje CSV i JSON izvještaja, kao i naprednu analitiku putem web sučelja.

Sinkroni HLR Lookup API

Krajnja točka POST /hlr-lookup obrađuje jedan mobilni telefonski broj (MSISDN) po zahtjevu i vraća rezultate trenutno u tijelu HTTP odgovora. Rezultati su formatirani kao JSON i idealni su za aplikacije u stvarnom vremenu, uključujući validaciju mobilnih brojeva, usmjeravanje poziva i isporuku SMS poruka.

Sinkroni API poziv sastoji se od izravnog HTTP zahtjeva i odgovora. Vaš sustav šalje jedan MSISDN (mobilni broj) po zahtjevu i prima trenutni odgovor koji sadrži rezultate HLR upita u stvarnom vremenu u JSON formatu. Ovaj API je optimiziran za slučajeve uporabe koji zahtijevaju trenutnu provjeru i kontrolu povezivosti, poput otkrivanja prijevara, VoIP usmjeravanja poziva i optimizacije SMS pristupnika.

Asinkroni HLR Lookup API

Krajnja točka POST /hlr-lookups dizajnirana je za skupnu obradu i obradu velikih količina podataka, omogućujući vam slanje do 1,000 MSISDN-ova po zahtjevu. Umjesto trenutnog vraćanja rezultata, ovaj API koristi automatizirane webhookove za progresivno slanje rezultata na vaš poslužitelj. Rezultati upita vraćaju se kao JSON objekti putem HTTP POST povratnih poziva.

Asinkroni API je optimiziran za brzinu, učinkovitost i skalabilnost. Eliminira probleme mrežne latencije povezane sa sinkronim pozivima, što ga čini idealnim za tvrtke kojima su potrebni upiti visokog protoka. Vaš sustav šalje do 1,000 MSISDN-ova po zahtjevu, a naša platforma ih obrađuje paralelno, isporučujući rezultate natrag na vaš poslužitelj putem HTTP webhookova u grupama od do 1,000 rezultata po povratnom pozivu.

SDK-ovi (Software Development Kits)

Naši Software Development Kitovi (SDK-ovi) za PHP, NodeJS i Ruby pojednostavljuju proces integracije, omogućujući vam učinkovito i s minimalnim naporom povezivanje s HLR Lookups API-jem.

Ovi SDK-ovi pružaju unaprijed izrađene funkcije, upravljanje autentifikacijom i strukturirane predloške API zahtjeva, smanjujući vrijeme razvoja i osiguravajući najbolje prakse.

Pregledajte naš cjeloviti popis dostupnih SDK-ova na GitHubu i započnite s integracijom danas.

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

Pogledaj 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   }

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

Pogledaj na GitHubu README.md

Pomaknite se gore

POST/hlr-lookupzaštićeno

Izvršava sinkronu HLR provjeru, isporučujući podatke o povezivosti i prenosivosti mobilnih brojeva u stvarnom vremenu izravno od mrežnih operatera. Ovaj endpoint je idealan za scenarije uživo gdje aplikacije osjetljive na vrijeme zahtijevaju trenutnu provjeru je li telefonski broj trenutno dostupan (povezan) ili nedostupan (isključen). Dodatno pomaže u razlikovanju aktivnih brojeva od nevažećih, nepoznatih ili lažnih.

Za skupnu obradu velikih skupova podataka koji ne zahtijevaju trenutne rezultate, razmotrite korištenje asinkronog POST /hlr-lookups, koji je optimiziran za brzu obradu u serijama.

Ako je vaš primarni fokus dohvaćanje podataka o prenosivosti mobilnih brojeva (MCCMNC) i ne zahtijevate status povezivosti uživo, POST /mnp-lookup pruža isplativu alternativu za upite o prenosivosti mobilnih brojeva.

Zahtjev Uspješan odgovor Odgovor s greškom Referenca statusa

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdn`	string	Mobilni telefonski broj (MSISDN) za upit, naveden u međunarodnom formatu (npr. +14156226819 ili 0014156226819). Pozivni brojevi moraju biti uključeni.	null	obavezno
`route`	string(3)	Neobavezni identifikator od tri znaka koji određuje rutu za ovu provjeru. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili vaše prilagođeno mapiranje ruta ili dopustili našem sustavu da automatski odredi najbolju rutu za ovu provjeru.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni identifikator dodijeljen ovom zahtjevu za pretraživanje.	false
`msisdn`	string	Broj mobilnog telefona koji se pretražuje, formatiran u međunarodnom formatu (npr. +14156226819 ili 0014156226819).	false
`connectivity_status`	string	Označava je li status povezivosti broja uspješno dohvaćen. Moguće vrijednosti: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` ili `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Pet- ili šesteroznamenkasti Mobile Country Code (MCC) i Mobile Network Code (MNC) koji identificiraju mrežu trenutno povezanu s brojem telefona.	true
`mcc`	string(3)	Troznamenkasti Mobile Country Code (MCC) koji identificira zemlju u kojoj je broj telefona registriran.	true
`mnc`	string(2\|3)	Dvo- ili troznamenkasti Mobile Network Code (MNC) koji identificira specifičnu mrežu kojoj broj telefona pripada.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), jedinstveni identifikator za SIM karticu povezanu s ovim brojem. Dostupnost ovisi o konfiguraciji mreže.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) unutar baze podataka mobilnog operatera. Dostupnost ovisi o konfiguraciji mreže.	true
`msc`	string(12)	Mobile Switching Center (MSC) koji trenutno obrađuje komunikacije ovog pretplatnika. Dostupnost ovisi o konfiguraciji mreže.	true
`original_network_name`	string	Naziv izvornog (matičnog) mrežnog operatera povezanog s ovim brojem.	true
`original_country_name`	string	Puni naziv zemlje u kojoj je broj mobilnog telefona izvorno registriran, naveden na engleskom jeziku.	true
`original_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u kojoj je broj telefona prvotno dodijeljen.	true
`original_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) koji odgovara izvornoj zemlji broja mobilnog telefona.	true
`is_ported`	boolean	Označava je li mobilni broj prenesen s izvorne mreže na drugog operatera.	true
`ported_network_name`	string	Naziv mrežnog operatera na kojeg je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_name`	string	Naziv zemlje u koju je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u koju je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) za zemlju u koju je mobilni broj prenesen, ako je primjenjivo.	true
`is_roaming`	boolean	Označava je li mobilni broj trenutno u roamingu na stranoj mreži. Dostupnost statusa roaminga ovisi o mobilnom mrežnom operateru.	true
`roaming_network_name`	string	Naziv mreže na kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_name`	string	Naziv zemlje u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_code`	string(2)	Dvoslovni ISO kod zemlje u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) za zemlju u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`cost`	string	Decimalna vrijednost prikazana kao niz znakova, koja označava trošak pretraživanja u EUR.	true
`timestamp`	string	Vremenska oznaka u W3C formatu uključujući vremensku zonu, koja specificira kada je pretraživanje završeno.	true
`storage`	string	Naziv pohrane u kojoj su rezultati pretraživanja spremljeni. Ovo odgovara nazivima izvješća i CSV preuzimanjima dostupnima putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji označava metodu usmjeravanja korištenu za ovaj zahtjev za pretraživanje.	true
`processing_status`	string	Ishod obrade pretraživanja. Moguće vrijednosti: `COMPLETED` (uspješno), `REJECTED` (mreža nedostupna, naplata nije primijenjena) ili `FAILED` (došlo je do pogreške tijekom obrade).	false
`error_code`	integer	Opcionalni interni kod pogreške koji pruža dodatne dijagnostičke informacije za korisničku podršku.	true
`error_description`	string	Kratko objašnjenje danog koda pogreške (ako postoji) na engleskom jeziku u običnom tekstu.	true
`data_source`	string	Izvor podataka korišten za ovaj zahtjev. Moguće vrijednosti: `LIVE_HLR` (HLR upit u stvarnom vremenu) ili `MNP_DB` (statička baza podataka o prenosivosti mobilnih brojeva). Pogledajte opcije usmjeravanja za detalje.	false
`routing_instruction`	string	Niz znakova odvojen dvotočkama koji opisuje instrukciju usmjeravanja korištenu u zahtjevu. Prva komponenta je `STATIC` kada ste specificirali rutu ili `AUTO` za automatsko usmjeravanje; druga komponenta je identifikator rute, a za zahtjeve automatskog usmjeravanja treća komponenta prikazuje izvor na kojem se temelji odluka o usmjeravanju (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 odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Status	Opis
CONNECTED	Broj je valjan, a ciljni uređaj trenutno je povezan na mobilnu mrežu. Pozivi, SMS poruke i druge usluge trebali bi uspješno stići do primatelja.
ABSENT	Broj je valjan, ali je ciljni uređaj ili isključen ili privremeno izvan dosega mreže. Poruke ili pozivi možda neće biti isporučeni dok se uređaj ponovno ne poveže na mrežu.
INVALID_MSISDN	Broj je nevaljan ili trenutno nije dodijeljen nijednom pretplatniku na mobilnoj mreži. Pozivi i poruke na ovaj broj neće uspjeti.
UNDETERMINED	Status povezanosti broja nije bilo moguće utvrditi. To može biti zbog nevaljanog broja, SS7 odgovora s greškom ili nedostatka povezanosti s ciljnim mrežnim operatorom. Pregledajte kod greške i polje s opisom za dodatnu dijagnostiku.

Pomaknite se gore

POST/hlr-lookupszaštićeno

Pokreće skupinu asinkronih HLR upita, dohvaćajući podatke o mobilnoj povezivosti i prenosivosti brojeva uživo od mrežnih operatera. Rezultati se isporučuju putem webhookova na vaš poslužitelj. Ova metoda je optimizirana za obradu velikih količina brojeva koji ne zahtijevaju trenutne odgovore, poput čišćenja i provjere baza podataka. Za aplikacije u stvarnom vremenu poput usmjeravanja poziva ili SMS dostave, razmotrite korištenje POST /hlr-lookup endpointa.

Ovaj endpoint je idealan za masovnu obradu kada je cilj identificirati telefonske brojeve koji su trenutno dostupni (povezani) ili nedostupni (telefon isključen), uz filtriranje nevažećih, nedodijeljenih ili lažnih brojeva. Dodatno, pruža status prenosivosti uživo (MCCMNC) uz detalje o povezivosti.

Prije korištenja ovog endpointa, provjerite je li konfiguriran webhook URL za asinkrino primanje rezultata upita. Možete to postaviti u vašim API postavkama.

Zahtjev Uspješan odgovor Odgovor s greškom Webhooks Referenca statusa

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdns`	array	Niz mobilnih telefonskih brojeva (MSISDN) u međunarodnom formatu (npr. +14156226819 ili 0014156226819). Po zahtjevu možete uključiti do 1000 brojeva.	null	obavezno
`route`	string(3)	Neobavezni identifikator od tri znaka koji određuje rutu za ovu provjeru. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili vaše prilagođeno mapiranje ruta ili dopustili našem sustavu da automatski odredi najbolju rutu za ovu provjeru.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`accepted`	array	Popis objekata koji sadrže jedinstvene identifikatore i MSISDN brojeve prihvaćene za obradu.	false
`accepted_count`	integer	Ukupan broj MSISDN brojeva uspješno prihvaćenih za obradu.	false
`rejected`	array	Popis objekata koji sadrže jedinstvene identifikatore i MSISDN brojeve odbijene za obradu, obično zbog nevažećih brojeva. Za odbijene unose ne naplaćuje se naknada.	false
`rejected_count`	integer	Ukupan broj MSISDN brojeva odbijenih zbog grešaka pri validaciji.	false
`total_count`	integer	Ukupan broj prihvaćenih i odbijenih MSISDN brojeva koji su poslani na obradu.	false
`cost`	string	Decimalna vrijednost prikazana kao tekst, koja označava ukupan trošak u EUR za prihvaćene upite.	false
`storage`	string	Naziv pohrane gdje se dodaju rezultati upita, koristi se za izvještavanje i preuzimanje CSV datoteka putem web sučelja.	false
`route`	string(3\|4)	Identifikator od tri ili četiri znaka koji određuje rutu korištenu za ovaj upit. Sadrži AUTO ako je zatraženo automatsko usmjeravanje prema broju.	false
`webhook_urls`	array	Webhook URL-ovi konfigurirani u vašim API postavkama. Rezultati se šalju natrag ovdje.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Obrada Webhookova

Nakon slanja, naša platforma počinje obrađivati dostavljene telefonske brojeve i šalje rezultate na prethodno navedeni webhook URL na vašem poslužitelju. Rezultati se prenose kao HTTP POST zahtjev s JSON objektom u tijelu zahtjeva.

Autentifikacija

Autentificirajte webhook provjerom X-Signatures HTTP zaglavlja.

X-Signatures zaglavlje sadrži popis potpisa odvojenih točkom-zarezom. Svaki potpis na popisu generiran je pomoću jedne od API tajni konfiguriranih u vašem računu. Za provjeru webhooka generirajte SHA-256 hash koristeći vaš API ključ, tajnu i sirovo HTTP tijelo - zatim ga usporedite s potpisima na popisu.

Podudaranje potvrđuje da je zahtjev autentičan i potpisan tajnom koju vi kontrolirate.

Primjer koda

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

Zahtjev je valjan ako bilo koji od potpisa navedenih u zaglavlju odgovara SHA256 hashu izračunatom nad spojenim nizom vašeg API ključa, tajne i HTTP tijela.

Potvrda Primitka

Od vašeg poslužitelja se očekuje da odgovori s HTTP statusnim kodom 200 OK kako bi potvrdio uspješan primitak. Ako se vrati bilo koji drugi statusni kod, dođe do isteka vremena (10 sekundi) ili se pojavi bilo koji drugi problem s dostavom, sustav će automatski ponoviti webhook nakon jedne minute. Ako zahtjev nastavi s neuspjehom, ponovni pokušaji će slijediti strategiju eksponencijalnog odgađanja, s naknadnim pokušajima nakon 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuta.

Ovaj mehanizam ponovnog pokušaja osigurava maksimalnu pouzdanost u isporuci rezultata provjere na vašu infrastrukturu. Minimizira rizik od gubitka podataka zbog privremenih mrežnih problema ili zastoja poslužitelja.

Webhook Sadržaj

{
   "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 payload-a

JSON objekt sadrži atribut type => HLR uz atribut results koji uključuje popis objekata upita, kako je dokumentirano u nastavku.

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni identifikator dodijeljen ovom zahtjevu za pretraživanje.	false
`msisdn`	string	Broj mobilnog telefona koji se pretražuje, formatiran u međunarodnom formatu (npr. +14156226819 ili 0014156226819).	false
`connectivity_status`	string	Označava je li status povezivosti broja uspješno dohvaćen. Moguće vrijednosti: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` ili `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Pet- ili šesteroznamenkasti Mobile Country Code (MCC) i Mobile Network Code (MNC) koji identificiraju mrežu trenutno povezanu s brojem telefona.	true
`mcc`	string(3)	Troznamenkasti Mobile Country Code (MCC) koji identificira zemlju u kojoj je broj telefona registriran.	true
`mnc`	string(2\|3)	Dvo- ili troznamenkasti Mobile Network Code (MNC) koji identificira specifičnu mrežu kojoj broj telefona pripada.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), jedinstveni identifikator za SIM karticu povezanu s ovim brojem. Dostupnost ovisi o konfiguraciji mreže.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) unutar baze podataka mobilnog operatera. Dostupnost ovisi o konfiguraciji mreže.	true
`msc`	string(12)	Mobile Switching Center (MSC) koji trenutno obrađuje komunikacije ovog pretplatnika. Dostupnost ovisi o konfiguraciji mreže.	true
`original_network_name`	string	Naziv izvornog (matičnog) mrežnog operatera povezanog s ovim brojem.	true
`original_country_name`	string	Puni naziv zemlje u kojoj je broj mobilnog telefona izvorno registriran, naveden na engleskom jeziku.	true
`original_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u kojoj je broj telefona prvotno dodijeljen.	true
`original_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) koji odgovara izvornoj zemlji broja mobilnog telefona.	true
`is_ported`	boolean	Označava je li mobilni broj prenesen s izvorne mreže na drugog operatera.	true
`ported_network_name`	string	Naziv mrežnog operatera na kojeg je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_name`	string	Naziv zemlje u koju je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u koju je mobilni broj prenesen, ako je primjenjivo.	true
`ported_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) za zemlju u koju je mobilni broj prenesen, ako je primjenjivo.	true
`is_roaming`	boolean	Označava je li mobilni broj trenutno u roamingu na stranoj mreži. Dostupnost statusa roaminga ovisi o mobilnom mrežnom operateru.	true
`roaming_network_name`	string	Naziv mreže na kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_name`	string	Naziv zemlje u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_code`	string(2)	Dvoslovni ISO kod zemlje u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`roaming_country_prefix`	string	Međunarodni pozivni broj (pozivni broj zemlje) za zemlju u kojoj je mobilni broj trenutno u roamingu, ako je primjenjivo.	true
`cost`	string	Decimalna vrijednost prikazana kao niz znakova, koja označava trošak pretraživanja u EUR.	true
`timestamp`	string	Vremenska oznaka u W3C formatu uključujući vremensku zonu, koja specificira kada je pretraživanje završeno.	true
`storage`	string	Naziv pohrane u kojoj su rezultati pretraživanja spremljeni. Ovo odgovara nazivima izvješća i CSV preuzimanjima dostupnima putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji označava metodu usmjeravanja korištenu za ovaj zahtjev za pretraživanje.	true
`processing_status`	string	Ishod obrade pretraživanja. Moguće vrijednosti: `COMPLETED` (uspješno), `REJECTED` (mreža nedostupna, naplata nije primijenjena) ili `FAILED` (došlo je do pogreške tijekom obrade).	false
`error_code`	integer	Opcionalni interni kod pogreške koji pruža dodatne dijagnostičke informacije za korisničku podršku.	true
`error_description`	string	Kratko objašnjenje danog koda pogreške (ako postoji) na engleskom jeziku u običnom tekstu.	true
`data_source`	string	Izvor podataka korišten za ovaj zahtjev. Moguće vrijednosti: `LIVE_HLR` (HLR upit u stvarnom vremenu) ili `MNP_DB` (statička baza podataka o prenosivosti mobilnih brojeva). Pogledajte opcije usmjeravanja za detalje.	false
`routing_instruction`	string	Niz znakova odvojen dvotočkama koji opisuje instrukciju usmjeravanja korištenu u zahtjevu. Prva komponenta je `STATIC` kada ste specificirali rutu ili `AUTO` za automatsko usmjeravanje; druga komponenta je identifikator rute, a za zahtjeve automatskog usmjeravanja treća komponenta prikazuje izvor na kojem se temelji odluka o usmjeravanju (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	Broj je valjan, a ciljni uređaj trenutno je povezan na mobilnu mrežu. Pozivi, SMS poruke i druge usluge trebali bi uspješno stići do primatelja.
ABSENT	Broj je valjan, ali je ciljni uređaj ili isključen ili privremeno izvan dosega mreže. Poruke ili pozivi možda neće biti isporučeni dok se uređaj ponovno ne poveže na mrežu.
INVALID_MSISDN	Broj je nevaljan ili trenutno nije dodijeljen nijednom pretplatniku na mobilnoj mreži. Pozivi i poruke na ovaj broj neće uspjeti.
UNDETERMINED	Status povezanosti broja nije bilo moguće utvrditi. To može biti zbog nevaljanog broja, SS7 odgovora s greškom ili nedostatka povezanosti s ciljnim mrežnim operatorom. Pregledajte kod greške i polje s opisom za dodatnu dijagnostiku.

Pomaknite se gore

POST/mnp-lookupzaštićeno

Pokreće sinkronu MNP provjeru i pruža informacije o prenosivosti mobilnog broja i mreži. Ovaj endpoint je prikladan ako je vaš primarni cilj izvući trenutni MCCMNC određenog mobilnog broja i identificirati izvornu i trenutnu mrežu u stvarnom vremenu.

Za skupnu obradu velikih skupova podataka koji ne zahtijevaju trenutne rezultate, razmotrite korištenje asinkronog POST /mnp-lookups, koji je optimiziran za brzu obradu u serijama.

MNP upiti pouzdano utvrđuju prenosivost i informacije o mreži, ali ne pokazuju je li ciljni mobilni telefon trenutno povezan na mrežu i dostupan. Za izvlačenje informacija o povezivosti uživo, molimo koristite POST /hlr-lookup endpoint.

Zahtjev Uspješan odgovor Odgovor s greškom

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdn`	string	Mobilni telefonski broj (MSISDN) za upit, naveden u međunarodnom formatu (npr. +14156226819 ili 0014156226819). Pozivni brojevi moraju biti uključeni.	null	obavezno
`route`	string(3)	Neobavezni identifikator od tri znaka koji određuje rutu za ovu provjeru. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili vaše prilagođeno mapiranje ruta ili dopustili našem sustavu da automatski odredi najbolju rutu za ovu provjeru.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni 12-znamenkasti identifikator za ovu provjeru.	false
`msisdn`	string	Broj mobilnog telefona koji se provjerava u ovom zahtjevu.	false
`query_status`	string	Označava je li dohvaćanje informacija o prenosivosti i mreži bilo uspješno. Moguće vrijednosti su `OK` ili `FAILED`.	false
`mccmnc`	string(5\|6)	Pet- ili šestoznamenkasti MCCMNC (kombinacija mobilnog koda zemlje i mobilnog mrežnog koda) koji identificira mrežu kojoj trenutno pripada broj mobilnog telefona.	true
`mcc`	string(3)	Troznamenkasti MCC (mobilni kod zemlje) koji predstavlja zemlju povezanu s trenutnom mrežom broja mobilnog telefona.	true
`mnc`	string(2\|3)	Dvo- ili troznamenkasti MNC (mobilni mrežni kod) koji identificira trenutnog mrežnog operatera za broj mobilnog telefona.	true
`is_ported`	boolean	Označava je li telefonski broj prenesen s izvorne mreže na novog operatera.	true
`original_network_name`	string	Proizvoljan tekst (na engleskom) koji navodi naziv izvornog mrežnog operatera provjeravanog broja mobilnog telefona.	true
`original_country_name`	string	Proizvoljan tekst (na engleskom) koji označava izvornu zemlju provjeravanog broja mobilnog telefona.	true
`original_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja izvornu zemlju provjeravanog broja mobilnog telefona.	true
`original_country_prefix`	string	Pozivni broj izvorne zemlje povezane s provjeravanim brojem mobilnog telefona.	true
`ported_network_name`	string	Navodi mrežnog operatera na kojeg je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_name`	string	Navodi zemlju u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_prefix`	string	Pozivni broj zemlje u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`extra`	string	Proizvoljan tekst koji pruža opcionalne dodatne detalje o telefonskom broju.	true
`cost`	string	Decimalna vrijednost, prikazana kao tekst, koja označava trošak u EUR za ovu provjeru.	true
`timestamp`	string	Vremenska oznaka u W3C formatu, uključujući informacije o vremenskoj zoni, koja označava kada je provjera dovršena.	true
`storage`	string	Naziv pohrane (ili naziv izvještaja) u koji su dodani rezultati provjere. Koristi se za preuzimanje CSV datoteka i izvještavanje putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji navodi rutu korištenu za ovaj zahtjev provjere.	true
`error_code`	integer	Opcionalni interni kod greške koji pruža dodatni kontekst za dijagnostiku korisničke podrške.	true

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

POST/mnp-lookupszaštićeno

Pokreće grupu asinkronih MNP (prenosivost mobilnog broja) upita, dohvaćajući trenutni MCCMNC i precizno određujući izvorne i trenutne mreže u stvarnom vremenu. Rezultati se isporučuju putem webhookova na vaš poslužitelj. Ova metoda je optimizirana za obradu velikih količina brojeva koji ne zahtijevaju trenutne odgovore, poput čišćenja i provjere baza podataka. Za aplikacije u stvarnom vremenu poput usmjeravanja poziva ili SMS dostave, razmotrite korištenje POST /mnp-lookup endpointa.

MNP upiti pouzdano utvrđuju prenosivost i informacije o mreži, ali ne pokazuju je li ciljni mobilni telefon trenutno povezan na mrežu i dostupan. Za izvlačenje informacija o povezivosti uživo, molimo koristite POST /hlr-lookups endpoint.

Prije korištenja ovog endpointa, provjerite je li konfiguriran webhook URL za asinkrino primanje rezultata upita. Možete to postaviti u vašim API postavkama.

Zahtjev Uspješan odgovor Odgovor s greškom Webhooks

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdns`	array	Niz mobilnih telefonskih brojeva (MSISDN) u međunarodnom formatu (npr. +14156226819 ili 0014156226819). Po zahtjevu možete uključiti do 1000 brojeva.	null	obavezno
`route`	string(3)	Opcionalni identifikator od tri znaka koji određuje rutu za ovaj upit. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili svoju prilagođenu mapu usmjeravanja ili automatski dopustili našem sustavu da automatski odredi najbolje rute za ovaj zahtjev.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`accepted`	array	Popis objekata koji sadrže jedinstvene identifikatore i MSISDN brojeve prihvaćene za obradu.	false
`accepted_count`	integer	Ukupan broj MSISDN brojeva uspješno prihvaćenih za obradu.	false
`rejected`	array	Popis objekata koji sadrže jedinstvene identifikatore i MSISDN brojeve odbijene za obradu, obično zbog nevažećih brojeva. Za odbijene unose ne naplaćuje se naknada.	false
`rejected_count`	integer	Ukupan broj MSISDN brojeva odbijenih zbog grešaka pri validaciji.	false
`total_count`	integer	Ukupan broj prihvaćenih i odbijenih MSISDN brojeva koji su poslani na obradu.	false
`cost`	string	Decimalna vrijednost prikazana kao tekst, koja označava ukupan trošak u EUR za prihvaćene upite.	false
`storage`	string	Naziv pohrane gdje se dodaju rezultati upita, koristi se za izvještavanje i preuzimanje CSV datoteka putem web sučelja.	false
`route`	string(3)	Troznamenkasti identifikator koji navodi rutu korištenu za ovaj zahtjev provjere.	false
`webhook_urls`	array	Webhook URL-ovi konfigurirani u vašim API postavkama. Rezultati se šalju natrag ovdje.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Obrada Webhookova

Nakon slanja, naša platforma počinje obrađivati dostavljene telefonske brojeve i šalje rezultate na prethodno navedeni webhook URL na vašem poslužitelju. Rezultati se prenose kao HTTP POST zahtjev s JSON objektom u tijelu zahtjeva.

Autentifikacija

Autentificirajte webhook provjerom X-Signatures HTTP zaglavlja.

X-Signatures zaglavlje sadrži popis potpisa odvojenih točkom-zarezom. Svaki potpis na popisu generiran je pomoću jedne od API tajni konfiguriranih u vašem računu. Za provjeru webhooka generirajte SHA-256 hash koristeći vaš API ključ, tajnu i sirovo HTTP tijelo - zatim ga usporedite s potpisima na popisu.

Podudaranje potvrđuje da je zahtjev autentičan i potpisan tajnom koju vi kontrolirate.

Primjer koda

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

Zahtjev je valjan ako bilo koji od potpisa navedenih u zaglavlju odgovara SHA256 hashu izračunatom nad spojenim nizom vašeg API ključa, tajne i HTTP tijela.

Potvrda Primitka

Od vašeg poslužitelja se očekuje da odgovori s HTTP statusnim kodom 200 OK kako bi potvrdio uspješan primitak. Ako se vrati bilo koji drugi statusni kod, dođe do isteka vremena (10 sekundi) ili se pojavi bilo koji drugi problem s dostavom, sustav će automatski ponoviti webhook nakon jedne minute. Ako zahtjev nastavi s neuspjehom, ponovni pokušaji će slijediti strategiju eksponencijalnog odgađanja, s naknadnim pokušajima nakon 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuta.

Ovaj mehanizam ponovnog pokušaja osigurava maksimalnu pouzdanost u isporuci rezultata provjere na vašu infrastrukturu. Minimizira rizik od gubitka podataka zbog privremenih mrežnih problema ili zastoja poslužitelja.

Webhook Sadržaj

{
    "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 payload-a

JSON objekt sadrži atribut type => MNP uz atribut results koji uključuje popis objekata upita, kako je dokumentirano u nastavku.

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni 12-znamenkasti identifikator za ovu provjeru.	false
`msisdn`	string	Broj mobilnog telefona koji se provjerava u ovom zahtjevu.	false
`query_status`	string	Označava je li dohvaćanje informacija o prenosivosti i mreži bilo uspješno. Moguće vrijednosti su `OK` ili `FAILED`.	false
`mccmnc`	string(5\|6)	Pet- ili šestoznamenkasti MCCMNC (kombinacija mobilnog koda zemlje i mobilnog mrežnog koda) koji identificira mrežu kojoj trenutno pripada broj mobilnog telefona.	true
`mcc`	string(3)	Troznamenkasti MCC (mobilni kod zemlje) koji predstavlja zemlju povezanu s trenutnom mrežom broja mobilnog telefona.	true
`mnc`	string(2\|3)	Dvo- ili troznamenkasti MNC (mobilni mrežni kod) koji identificira trenutnog mrežnog operatera za broj mobilnog telefona.	true
`is_ported`	boolean	Označava je li telefonski broj prenesen s izvorne mreže na novog operatera.	true
`original_network_name`	string	Proizvoljan tekst (na engleskom) koji navodi naziv izvornog mrežnog operatera provjeravanog broja mobilnog telefona.	true
`original_country_name`	string	Proizvoljan tekst (na engleskom) koji označava izvornu zemlju provjeravanog broja mobilnog telefona.	true
`original_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja izvornu zemlju provjeravanog broja mobilnog telefona.	true
`original_country_prefix`	string	Pozivni broj izvorne zemlje povezane s provjeravanim brojem mobilnog telefona.	true
`ported_network_name`	string	Navodi mrežnog operatera na kojeg je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_name`	string	Navodi zemlju u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_code`	string(2)	Dvoslovni ISO kod zemlje koji predstavlja zemlju u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`ported_country_prefix`	string	Pozivni broj zemlje u koju je prenesen provjeravani broj mobilnog telefona, ako je primjenjivo.	true
`extra`	string	Proizvoljan tekst koji pruža opcionalne dodatne detalje o telefonskom broju.	true
`cost`	string	Decimalna vrijednost, prikazana kao tekst, koja označava trošak u EUR za ovu provjeru.	true
`timestamp`	string	Vremenska oznaka u W3C formatu, uključujući informacije o vremenskoj zoni, koja označava kada je provjera dovršena.	true
`storage`	string	Naziv pohrane (ili naziv izvještaja) u koji su dodani rezultati provjere. Koristi se za preuzimanje CSV datoteka i izvještavanje putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji navodi rutu korištenu za ovaj zahtjev provjere.	true
`error_code`	integer	Opcionalni interni kod greške koji pruža dodatni kontekst za dijagnostiku korisničke podrške.	true

Pomaknite se gore

POST/nt-lookupzaštićeno

Pokreće sinkronu provjeru tipa broja (NT). Ova krajnja točka idealna je ako vam je primarni cilj utvrditi pripadaju li navedeni telefonski brojevi fiksnim, mobilnim, premium, VoIP, pager ili drugim rasponima numeracijskog plana u stvarnom vremenu.

NT upiti pouzdano detektiraju tip telefonskog broja, no ne pokazuju je li ciljni broj trenutno spojen na mrežu i dostupan. Za izvlačenje podataka o aktivnoj povezivosti koristite krajnju točku POST /hlr-lookup.

Ako vaš slučaj upotrebe zahtijeva točne podatke o mreži i prenosivosti (MCCMNC), ali ne i status aktivne povezivosti, koristite krajnju točku POST /mnp-lookup za upite o prenosivosti mobilnih brojeva.

Zahtjev Uspješan odgovor Odgovor s greškom Referenca tipova

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`number`	string	Telefonski broj u međunarodnom formatu (npr. +4989702626 ili 004989702626).	null	mandatory
`route`	string(3)	Opcionalni identifikator od tri znaka koji specificira rutu za ovu provjeru. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili svoju prilagođenu mapu usmjeravanja ili dopustili našem sustavu da automatski odredi najbolje rute za ovaj zahtjev.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
     "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni identifikator dodijeljen ovom zahtjevu za pretraživanje.	false
`number`	string	Telefonski broj koji je evaluiran tijekom ovog zahtjeva za provjeru.	false
`number_type`	string	Otkrivena vrsta broja. Moguće vrijednosti uključuju: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Označava je li informacija o vrsti broja uspješno dohvaćena. Vraća `OK` ako je uspješno, ili `FAILED` ako je provjera neuspjela.	false
`is_valid`	boolean	Označava je li telefonski broj sintaktički valjan.	true
`invalid_reason`	string	Poruka u obliku običnog teksta na engleskom jeziku koja specificira zašto se telefonski broj smatra neispravnim (npr. "too short" ili "invalid prefix"), ili `null` ako je broj valjan.	true
`is_possibly_ported`	boolean	Označava je li telefonski broj možda prebačen s izvornog operatera na drugog pružatelja usluga. Za definitivne informacije o prenosivosti koristite MNP provjere.	true
`is_vanity_number`	boolean	Označava je li telefonski broj vanity broj, što znači da uključuje abecedne znakove.	true
`qualifies_for_hlr_lookup`	boolean	Označava je li telefonski broj prihvatljiv za dodatne upite putem HLR provjera.	true
`mccmnc`	string(5\|6)	Niz od pet ili šest znakova koji predstavlja MCCMNC tuple (mobilni kod države i mobilni mrežni kod) koji identificira izvornu mrežu mobilnog telefonskog broja.	true
`mcc`	string(3)	Niz od tri znaka koji predstavlja MCC (mobilni kod države) koji identificira državu povezanu s izvornom mobilnom mrežom telefonskog broja.	true
`mnc`	string(2\|3)	Niz od dva ili tri znaka koji predstavlja MNC (mobilni mrežni kod) koji identificira izvornog operatera mobilne mreže telefonskog broja.	true
`original_network_name`	string	Proizvoljan niz običnog teksta na engleskom jeziku koji specificira naziv izvornog mrežnog operatera provjerenog mobilnog telefonskog broja.	true
`original_country_name`	string	Proizvoljan niz običnog teksta na engleskom jeziku koji specificira izvornu državu povezanu s provjerenim mobilnim telefonskim brojem.	true
`original_country_code`	string(2)	ISO kod države od dva znaka koji označava izvornu državu provjerenog mobilnog telefonskog broja.	true
`regions`	array	Popis čitljivih nizova na engleskom jeziku koji specificiraju geografsku regiju(e) povezanu s ovim telefonskim brojem.	true
`timezones`	array	Popis vremenskih zona (u Olson formatu) povezanih s ovim telefonskim brojem.	true
`info_text`	string	Proizvoljan niz koji može sadržavati dodatne informacije o telefonskom broju.	true
`cost`	string	Decimalna vrijednost predstavljena kao niz, koja označava trošak (u EUR) ove provjere.	true
`timestamp`	string	W3C formatirani vremenski žig (uključujući vremensku zonu) koji označava kada je provjera završena.	true
`storage`	string	Specificira naziv pohrane gdje su rezultati provjere dodani. Ovo odgovara nazivu izvještaja koji se koristi za CSV preuzimanja i analitiku putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji navodi rutu korištenu za ovaj zahtjev provjere.	true

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Tip	Opis
LANDLINE	Fiksni telefonski broj.
MOBILE	Mobilni telefonski broj. Kvalificira se za HLR provjere radi dobivanja dodatnih informacija o statusu veze, mreži, prenosivosti i roamingu.
MOBILE_OR_LANDLINE	Fiksni ili mobilni telefonski broj. Može se kvalificirati za HLR provjeru.
TOLL_FREE	Besplatni telefonski broj.
PREMIUM_RATE	Telefonski broj s premijskom tarifom i dodatnim troškovima.
SHARED_COST	Telefonski broj s podijeljenim troškovima. Obično jeftiniji od brojeva s premijskom tarifom.
VOIP	Voice over IP telefonski broj. Uključuje TSoIP brojeve (Telephony Service over IP).
PAGER	Broj pagera. Obično bez glasovne funkcionalnosti.
UAN	Univerzalni pristupni broj (broj tvrtke). Može biti preusmjeren na određene urede, ali omogućuje korištenje jednog broja za cijelu tvrtku.
VOICEMAIL	Broj govorne pošte.
UNKNOWN	Tip broja nije moguće odrediti.

Pomaknite se gore

POST/nt-lookups zaštićeno

Ovaj endpoint pokreće niz asinkronih provjera tipa broja s rezultatima koji se šalju natrag na vaš poslužitelj putem webhooka. Prikladan je ako je vaš primarni cilj utvrditi pripadaju li dani telefonski brojevi fiksnoj telefoniji, mobilnoj mreži, premium tarifama, VoIP-u, pageru ili drugim rasponima numeracijskog plana. Optimiziran za brzu obradu velikih količina brojeva, ovaj endpoint je idealan za masovne operacije (npr. sanitizaciju baze podataka). Za aktivni promet i vremenski kritične slučajeve uporabe, molimo koristite POST /nt-lookup endpoint.

Morate navesti webhook URL u vašim API postavkama kao preduvjet za pozivanje ovog endpointa.

Zahtjev Uspješan odgovor Odgovor s greškom Webhooks Referenca tipova

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

Sadržaj

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`numbers`	array	Niz telefonskih brojeva u međunarodnom formatu (npr. +14156226819 ili 004989702626). Maksimalno 1000 brojeva može biti uključeno po zahtjevu.	null	obavezno
`route`	string(3)	Opcionalni troznakovni identifikator koji specificira rutu za ovu provjeru. Postavite na `null` ili izostavite ovaj parametar kako biste primijenili vašu prilagođenu mapu usmjeravanja ili dopustili našem sustavu da automatski odredi najbolju rutu za ovaj zahtjev.	null	opcionalno
`storage`	string	Neobavezni identifikator za pohranu koji određuje izvješće u koje će rezultati biti spremljeni za ručni pregled, analitiku i izvještavanje. Sustav automatski dodaje vremensku oznaku s tekućim mjesecom. Ako se izostavi ili postavi na `null`, sustav će automatski grupirati rezultate po mjesecu u svrhu izvještavanja.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`accepted`	array	Niz objekata, od kojih svaki sadrži jedinstveni identifikator i telefonski broj koji je prihvaćen za obradu.	false
`accepted_count`	integer	Ukupan broj telefonskih brojeva prihvaćenih za obradu.	false
`rejected`	array	Niz objekata, od kojih svaki sadrži jedinstveni identifikator i telefonski broj koji je odbijen za obradu. Obično su ovi brojevi nevažeći i ne naplaćuju se.	false
`rejected_count`	integer	Ukupan broj telefonskih brojeva koji su odbijeni za obradu.	false
`total_count`	integer	Ukupan broj prihvaćenih i odbijenih telefonskih brojeva koji su poslani na obradu.	false
`cost`	string	Niz znakova koji predstavlja decimalnu vrijednost troška u EUR za ove provjere.	false
`storage`	string	Naziv pohrane (izvješća) u koju su dodani rezultati provjere. Ovaj naziv se koristi za CSV preuzimanja i analitiku putem web sučelja.	false
`route`	string(3)	Troznakovni identifikator koji specificira rutu korištenu za ovaj zahtjev provjere.	false
`webhook_urls`	array	Webhook URL-ovi konfigurirani u vašim API postavkama. Rezultati se šalju natrag ovdje.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Obrada Webhookova

Nakon slanja, naša platforma počinje obrađivati dostavljene telefonske brojeve i šalje rezultate na prethodno navedeni webhook URL na vašem poslužitelju. Rezultati se prenose kao HTTP POST zahtjev s JSON objektom u tijelu zahtjeva.

Autentifikacija

Autentificirajte webhook provjerom X-Signatures HTTP zaglavlja.

X-Signatures zaglavlje sadrži popis potpisa odvojenih točkom-zarezom. Svaki potpis na popisu generiran je pomoću jedne od API tajni konfiguriranih u vašem računu. Za provjeru webhooka generirajte SHA-256 hash koristeći vaš API ključ, tajnu i sirovo HTTP tijelo - zatim ga usporedite s potpisima na popisu.

Podudaranje potvrđuje da je zahtjev autentičan i potpisan tajnom koju vi kontrolirate.

Primjer koda

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

Zahtjev je valjan ako bilo koji od potpisa navedenih u zaglavlju odgovara SHA256 hashu izračunatom nad spojenim nizom vašeg API ključa, tajne i HTTP tijela.

Potvrda Primitka

Od vašeg poslužitelja se očekuje da odgovori s HTTP statusnim kodom 200 OK kako bi potvrdio uspješan primitak. Ako se vrati bilo koji drugi statusni kod, dođe do isteka vremena (10 sekundi) ili se pojavi bilo koji drugi problem s dostavom, sustav će automatski ponoviti webhook nakon jedne minute. Ako zahtjev nastavi s neuspjehom, ponovni pokušaji će slijediti strategiju eksponencijalnog odgađanja, s naknadnim pokušajima nakon 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuta.

Ovaj mehanizam ponovnog pokušaja osigurava maksimalnu pouzdanost u isporuci rezultata provjere na vašu infrastrukturu. Minimizira rizik od gubitka podataka zbog privremenih mrežnih problema ili zastoja poslužitelja.

Webhook Sadržaj

{
   "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 payload-a

JSON objekt sadrži atribut type => NT uz atribut results koji uključuje popis objekata upita, kako je dokumentirano u nastavku.

Ime	Tip	Opis	Može biti null
`id`	string(12)	Jedinstveni identifikator dodijeljen ovom zahtjevu za pretraživanje.	false
`number`	string	Telefonski broj koji je evaluiran tijekom ovog zahtjeva za provjeru.	false
`number_type`	string	Otkrivena vrsta broja. Moguće vrijednosti uključuju: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Označava je li informacija o vrsti broja uspješno dohvaćena. Vraća `OK` ako je uspješno, ili `FAILED` ako je provjera neuspjela.	false
`is_valid`	boolean	Označava je li telefonski broj sintaktički valjan.	true
`invalid_reason`	string	Poruka u obliku običnog teksta na engleskom jeziku koja specificira zašto se telefonski broj smatra neispravnim (npr. "too short" ili "invalid prefix"), ili `null` ako je broj valjan.	true
`is_possibly_ported`	boolean	Označava je li telefonski broj možda prebačen s izvornog operatera na drugog pružatelja usluga. Za definitivne informacije o prenosivosti koristite MNP provjere.	true
`is_vanity_number`	boolean	Označava je li telefonski broj vanity broj, što znači da uključuje abecedne znakove.	true
`qualifies_for_hlr_lookup`	boolean	Označava je li telefonski broj prihvatljiv za dodatne upite putem HLR provjera.	true
`mccmnc`	string(5\|6)	Niz od pet ili šest znakova koji predstavlja MCCMNC tuple (mobilni kod države i mobilni mrežni kod) koji identificira izvornu mrežu mobilnog telefonskog broja.	true
`mcc`	string(3)	Niz od tri znaka koji predstavlja MCC (mobilni kod države) koji identificira državu povezanu s izvornom mobilnom mrežom telefonskog broja.	true
`mnc`	string(2\|3)	Niz od dva ili tri znaka koji predstavlja MNC (mobilni mrežni kod) koji identificira izvornog operatera mobilne mreže telefonskog broja.	true
`original_network_name`	string	Proizvoljan niz običnog teksta na engleskom jeziku koji specificira naziv izvornog mrežnog operatera provjerenog mobilnog telefonskog broja.	true
`original_country_name`	string	Proizvoljan niz običnog teksta na engleskom jeziku koji specificira izvornu državu povezanu s provjerenim mobilnim telefonskim brojem.	true
`original_country_code`	string(2)	ISO kod države od dva znaka koji označava izvornu državu provjerenog mobilnog telefonskog broja.	true
`regions`	array	Popis čitljivih nizova na engleskom jeziku koji specificiraju geografsku regiju(e) povezanu s ovim telefonskim brojem.	true
`timezones`	array	Popis vremenskih zona (u Olson formatu) povezanih s ovim telefonskim brojem.	true
`info_text`	string	Proizvoljan niz koji može sadržavati dodatne informacije o telefonskom broju.	true
`cost`	string	Decimalna vrijednost predstavljena kao niz, koja označava trošak (u EUR) ove provjere.	true
`timestamp`	string	W3C formatirani vremenski žig (uključujući vremensku zonu) koji označava kada je provjera završena.	true
`storage`	string	Specificira naziv pohrane gdje su rezultati provjere dodani. Ovo odgovara nazivu izvještaja koji se koristi za CSV preuzimanja i analitiku putem web sučelja.	true
`route`	string(3)	Troznamenkasti identifikator koji navodi rutu korištenu za ovaj zahtjev provjere.	true

Tip	Opis
LANDLINE	Fiksni telefonski broj.
MOBILE	Mobilni telefonski broj. Kvalificira se za HLR provjere radi dobivanja dodatnih informacija o statusu veze, mreži, prenosivosti i roamingu.
MOBILE_OR_LANDLINE	Fiksni ili mobilni telefonski broj. Može se kvalificirati za HLR provjeru.
TOLL_FREE	Besplatni telefonski broj.
PREMIUM_RATE	Telefonski broj s premijskom tarifom i dodatnim troškovima.
SHARED_COST	Telefonski broj s podijeljenim troškovima. Obično jeftiniji od brojeva s premijskom tarifom.
VOIP	Voice over IP telefonski broj. Uključuje TSoIP brojeve (Telephony Service over IP).
PAGER	Broj pagera. Obično bez glasovne funkcionalnosti.
UAN	Univerzalni pristupni broj (broj tvrtke). Može biti preusmjeren na određene urede, ali omogućuje korištenje jednog broja za cijelu tvrtku.
VOICEMAIL	Broj govorne pošte.
UNKNOWN	Tip broja nije moguće odrediti.

Pomaknite se gore

GET/routezaštićeno

Dohvaća rutu koja će biti automatski odabrana kada pokrenete HLR upit bez navođenja parametra route.

Automatski odabir rute temelji se na mapi usmjeravanja koja se može dohvatiti putem GET /hlr-coverage endpointa, a koja je primarno izvedena iz GET /routing-map. Možete prilagoditi svoju mapu usmjeravanja i definirati prilagođena pravila u postavkama računa.

Zahtjev Uspješan odgovor Odgovor s greškom

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdn`	string	MSISDN za koji se dohvaćaju informacije o automatski odabranom usmjeravanju.	null	obavezno

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

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`route`	string	Preporučena ruta.	false
`confidence_level`	string	Razina pouzdanosti s kojom je ova ruta odabrana, tj. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	MCCMNC temeljen na planu numeracije za ovaj broj.	false
`origin`	string	Izvor na kojem se temelji odluka o usmjeravanju, 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 odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/routeszaštićeno

Ovaj endpoint vraća popis dostupnih HLR, MNP i NT ruta. Svaka ruta, zajedno s njezinim značajkama i ograničenjima, objašnjena je na stranici detalji usmjeravanja.

Zahtjev Uspješan odgovor Odgovor s greškom

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

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

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`routes`	object	Objekt s rutama grupiranim prema vrsti rute.	false
`HLR\|MNP\|NT`	string[]	Sadrži popis identifikatora ruta.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/routing-mapzaštićeno

Dohvaća konfiguraciju automatskog usmjeravanja koja se trenutno primjenjuje na HLR upite za vaš račun. Ova zadana konfiguracija koristi se svaki put kada pošaljete HLR upite bez navođenja parametra route. Možete prilagoditi svoju mapu usmjeravanja i kreirati prilagođena pravila u postavkama računa.

Hijerarhija konfiguracije kaskadno prelazi s pravila na razini države na pravila na razini MCCMNC-a, te konačno na mapiranja pojedinih prefiksa telefonskih brojeva. U praksi to znači da mapiranja pojedinih prefiksa telefonskih brojeva imaju prednost nad konfliktnim MCCMNC dodijelama, koje zauzvrat nadjačavaju pravila na razini države. Napominjemo da MNP fallback nadjačava sva konfliktna prilagođena pravila dok je omogućen.

Zahtjev Uspješan odgovor Odgovor s greškom

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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`default_route`	string	Zadana ruta koja se koristi kada se ne može odrediti preferirana opcija usmjeravanja za MSISDN i ne primjenjuju se prilagođena pravila usmjeravanja.	false
`mnp_fallback`	boolean	Označava je li MNP fallback omogućen. Kada je omogućen i HLR upiti nisu podržani od strane mreže (status povezivosti nije dostupan), sustav će umjesto toga izvršiti MNP upit.	false
`mccmncs`	array	Mapiranje MCCMNC kodova na njihove automatski odabrane rute. Prilikom izvođenja HLR upita za broj u određenom MCCMNC-u, koristi se odgovarajuća ruta.	false
`mccmnc`	string(5\|6)	Pet- ili šestznamenkasti MCCMNC (kombinacija mobilne oznake države i mobilne mrežne oznake) koji identificira mobilnog mrežnog operatera.	false
`countrycode`	string(2)	Dvoslovni ISO kod države koji identificira državu mreže.	false
`route`	string(3)	Odabrana ruta za mrežu.	false
`mno`	string	Komercijalni brend pod kojim ova mreža posluje.	false
`confidence`	string	Razina pouzdanosti s kojom je odabir napravljen. Moguće vrijednosti su: HIGH, NORMAL, LOW, MNP_REDIRECT. U slučaju potonjeg, sustav preusmjerava promet na ovu mrežu na MNP, ako je takvo ponašanje omogućeno na vašem računu. U suprotnom koristi zadanu rutu na računu.	false
`origin`	string	Izvor na kojem se temelji odabir. Moguće vrijednosti su: `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	Popis prilagođenih pravila usmjeravanja temeljenih na prefiksima konfiguriranih na vašem računu, ako postoje.	false
`countrycode`	string(2)	Dvoslovni ISO kod države koji identificira državu prefiksa.	false
`cns`	string	Prefiks na koji se primjenjuje pravilo usmjeravanja.	false
`route`	string(3)	Odabrana ruta za prefiks.	false
`mccmnc`	string(5\|6)	Pet- ili šestznamenkasti MCCMNC (kombinacija mobilne oznake države i mobilne mrežne oznake) koji identificira mobilnog mrežnog operatera.	true
`mno`	string	Komercijalni brend pod kojim ova mreža posluje.	true
`countries`	array	Popis prilagođenih pravila temeljenih na državama konfiguriranih na vašem računu, ako postoje.	false
`countrycode`	string(2)	Dvoslovni ISO kod države koji identificira državu.	false
`route`	string(3)	Odabrana ruta za državu.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/hlr-coverage zaštićeno

Vraća uvide u HLR pokrivenost za potporu odlučivanju temeljenom na podacima. Ova krajnja točka pomaže vam analizirati opcije HLR usmjeravanja u realnom vremenu preko mobilnih mreža, identificirati najučinkovitije putove za vaše ciljne regije i konfigurirati automatsko usmjeravanje.

Preporučeni putovi iz GET /route temelje se na podacima o pokrivenosti dohvaćenim ovdje. Podaci o pokrivenosti također su dostupni na stranici mrežne pokrivenosti. Možete dodatno prilagoditi svoju kartu usmjeravanja i definirati pravila u postavkama računa.

Preporučujemo da se upoznate s ovim vodičem koji će vam pomoći u tumačenju rezultata.

Zahtjev Uspješan odgovor Odgovor s greškom Referenca statusa

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`countrycode`	string(2)	Obavezna dvoslovna ISO oznaka države koja se koristi za filtriranje rezultata, vraćajući samo zapise povezane s navedenom državom.	null	obavezno
`sample_size`	string	Neobavezni parametar koji određuje veličinu uzorka. Moguće vrijednosti su `LARGE`, `MEDIUM`, `SMALL`. Veći uzorci pokrivaju duže vremensko razdoblje, manji uzorci pokrivaju vrlo nedavno vremensko razdoblje.	LARGE	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`name`	string	Naziv odabrane države na engleskom jeziku u običnom tekstu.	false
`countrycode`	string(2)	Dvoslovna ISO oznaka odabrane države.	false
`prefix`	string	Međunarodni pozivni broj odabrane države.	false
`mccs`	string[]	Popis MCC-ova (mobilnih oznaka država) povezanih s odabranom državom.	false
`carriers`	object[]	Popis objekata operatera s metrikama povezivosti specifičnim za rute.	false
`mno`	string	Naziv mobilnog mrežnog operatera na engleskom jeziku u običnom tekstu.	false
`mccmnc`	string	MCCMNC mobilnog mrežnog operatera.	false
`mcc`	string	MCC (mobilna oznaka države) mobilnog mrežnog operatera.	false
`mnc`	string	MNC (mobilna mrežna oznaka) mobilnog mrežnog operatera.	false
`routes`	object[]	Popis rezultata povezivosti specifičnih za rute.	false
`route`	string	Ruta na koju se odnose informacije o povezivosti.	false
`selected`	bool	Označava je li ovo odabrana ruta za automatizirano usmjeravanje.	false
`selection_confidence`	string	Razina pouzdanosti s kojom je ova ruta odabrana, tj. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Sadrži null ako ovo nije odabrana ruta.	true
`n`	int	Ukupan broj pretraživanja u ovom uzorku.	false
`CONNECTED`	int	Broj HLR pretraživanja koja su vratila status CONNECTED.	false
`CONNECTED_PCT`	float	Postotak HLR pretraživanja koja su vratila status CONNECTED.	false
`ABSENT`	int	Broj HLR pretraživanja koja su vratila status ABSENT.	false
`ABSENT_PCT`	float	Postotak HLR pretraživanja koja su vratila status ABSENT.	false
`INVALID_MSISDN`	int	Broj HLR pretraživanja koja su vratila status INVALID_MSISDN.	false
`INVALID_MSISDN_PCT`	float	Postotak HLR pretraživanja koja su vratila status INVALID_MSISDN.	false
`UNDETERMINED`	int	Broj HLR pretraživanja koja su vratila status UNDETERMINED.	false
`UNDETERMINED_PCT`	float	Postotak HLR pretraživanja koja su vratila status UNDETERMINED.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Status	Opis
CONNECTED	Broj je valjan, a ciljni uređaj trenutno je povezan na mobilnu mrežu. Pozivi, SMS poruke i druge usluge trebali bi uspješno stići do primatelja.
ABSENT	Broj je valjan, ali je ciljni uređaj ili isključen ili privremeno izvan dosega mreže. Poruke ili pozivi možda neće biti isporučeni dok se uređaj ponovno ne poveže na mrežu.
INVALID_MSISDN	Broj je nevaljan ili trenutno nije dodijeljen nijednom pretplatniku na mobilnoj mreži. Pozivi i poruke na ovaj broj neće uspjeti.
UNDETERMINED	Status povezanosti broja nije bilo moguće utvrditi. To može biti zbog nevaljanog broja, SS7 odgovora s greškom ili nedostatka povezanosti s ciljnim mrežnim operatorom. Pregledajte kod greške i polje s opisom za dodatnu dijagnostiku.

Pomaknite se gore

GET/mnp-coveragezaštićeno

Ovaj endpoint vraća popis mobilnih mrežnih operatera, zajedno s pripadajućim MCCMNC identifikatorima, koji su trenutno podržani za provjere prenosivosti mobilnih brojeva.

Zahtjev Uspješan odgovor Odgovor s greškom

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`countrycode`	string(2)	Neobavezna dvoslovna ISO oznaka države koja se koristi za filtriranje MCCMNC rezultata, vraćajući samo podatke relevantne za navedenu državu.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`items[]`	array	Popis mobilnih mrežnih operatera.	false
`country_name`	string	Naziv države na engleskom jeziku.	false
`country_code`	string(2)	Dvoslovna ISO oznaka države.	false
`mccmnc`	string(5\|6)	Pet- ili šestznamenkasti MCCMNC (kombinacija mobilne oznake države i mobilne mrežne oznake) koji identificira mobilnog mrežnog operatera.	false
`mcc`	string(3)	Troznamenkasti MCC (mobilna oznaka države) koji predstavlja državu mreže.	false
`mnc`	string(2\|3)	Dvo- ili troznamenkasti MNC (mobilna mrežna oznaka) koji predstavlja specifičnog mobilnog mrežnog operatera.	false
`brand`	string	Komercijalni brend pod kojim ova mreža posluje.	true
`operator`	string	Pravni naziv mobilnog mrežnog operatera.	true

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/price-listzaštićeno

Ovaj endpoint vraća popis zemalja u kojima su podržani samo MNP upiti, dok HLR upiti nisu dostupni za te destinacije.

Zahtjev Uspješan odgovor Odgovor s greškom

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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`countries`	string[]	Popis dvoslovnih ISO kodova zemalja.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/mccmncszaštićeno

Ova krajnja točka vraća sveobuhvatan popis mobilnih mrežnih operatera zajedno s njihovim odgovarajućim MCCMNC identifikatorima i dodatnim kontekstualnim informacijama.

Zahtjev Uspješan odgovor Odgovor s greškom

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`countrycode`	string(2)	Neobavezni dvoslovni ISO kod države koji se koristi za filtriranje MCCMNC rezultata, vraćajući samo zapise povezane s navedenom državom.	null	opcionalno

{
   "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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`items`	object[]	Popis mobilnih mrežnih operatera.	false
`country_name`	string	Puni naziv države na engleskom jeziku.	false
`country_code`	string(2)	Dvoslovni ISO kod države koji predstavlja državu mobilnog operatera.	false
`mccmnc`	string(5\|6)	Niz znakova od pet ili šest znakova koji predstavlja MCCMNC, a koji jedinstveno identificira mobilnog mrežnog operatera.	false
`mcc`	string(3)	Troznamenkasti mobilni kod države (MCC) koji identificira državu u kojoj mobilna mreža posluje.	false
`mnc`	string(2\|3)	Dvoznamenkasti ili troznamenkasti mobilni mrežni kod (MNC) koji specificira mobilnu mrežu unutar zadanog MCC-a.	false
`brand`	string	Komercijalni naziv brenda pod kojim mreža posluje i koji prepoznaju korisnici.	true
`operator`	string	Službeni naziv mobilnog mrežnog operatera, obično pravni subjekt koji upravlja mrežom.	true
`parent_mccmnc`	string(5\|6)	Niz znakova od pet ili šest znakova koji predstavlja MCCMNC nadređenog mobilnog mrežnog operatera, ako postoji.	true

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/pricezaštićeno

Ovaj endpoint vraća cijenu za HLR, MNP ili NT upit.

Zahtjev Uspješan odgovor Odgovor s greškom

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

Parametri zahtjeva

Ključ	Tip	Opis	Zadano	Obavezno
`msisdn`	string	Telefonski broj za koji se dohvaća cijena. U međunarodnom formatu.	null	obavezno
`route_type`	string	Vrsta rute, tj. `HLR`, `MNP`, `NT`.	null	obavezno
`route`	string(3)	Ruta za koju treba izračunati cijenu. Zadana vrijednost je ruta određena automatskim usmjeravanjem.	null	opcionalno

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

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`price`	object	Objekt s detaljima o cijeni.	false
`amount`	string	Iznos u EUR.	false
`msisdn`	string	MSISDN za koji se primjenjuje ova cijena.	false
`route_type`	string(2\|3)	Vrsta rute za koju se primjenjuje ova cijena.	false
`route`	string(3)	Ruta za koju se primjenjuje ova cijena.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/price-listzaštićeno

Ovaj endpoint vraća cijene u vašem računu.

Zahtjev Uspješan odgovor Odgovor s greškom

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 uspješnog odgovora

Ime	Tip	Opis	Može biti null
`pricing`	object[]	Popis objekata s informacijama o cijenama.	false
`route`	string	Ruta na koju se primjenjuje ovo cijenjenje.	false
`countrycode`	string	Dvoslovni ISO kod zemlje na koji se primjenjuje ovo cijenjenje za odgovarajuću rutu, ako postoji.	true
`countryname`	string	Engleski naziv zemlje koji odgovara kodu zemlje, ako postoji.	true
`mccmnc`	string	MCCMNC na koji se primjenjuje ovo cijenjenje za odgovarajuću rutu, ako postoji. Nadjačava cijene na razini zemlje.	true
`cns`	string	Pozivni prefiks na koji se primjenjuje ovo cijenjenje za odgovarajuću rutu, ako postoji. Nadjačava cijene na razini zemlje i cijene na razini MCCMNC-a.	true
`route_type`	string	Odgovarajuća vrsta rute, tj. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Odgovarajuća cijena u EUR.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/balancezaštićeno

Ovaj endpoint dohvaća trenutno stanje vašeg računa, omogućujući vam automatizaciju procesa na temelju vašeg kreditnog statusa. Besprijekorno funkcionira s obavijestima o niskom kreditu putem e-pošte koje možete konfigurirati na svojoj stranici za plaćanja.

Zahtjev Uspješan odgovor Odgovor s greškom

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

{
    "balance":"1002.90"
}

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`balance`	string	Trenutno stanje vašeg računa u EUR. Decimalna vrijednost tipa string.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/pingjavno

Ova krajnja točka šalje ping zahtjev prema API-ju, pružajući jednostavan način za testiranje vaše veze s HLR Lookups API-jem.

Zahtjev Uspješan odgovor Odgovor s greškom

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

{
    "success":true
}

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`success`	boolean	Označava da je zahtjev uspješno obrađen.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/timejavno

Ovaj endpoint vraća Unix vremensku oznaku koja predstavlja trenutno vrijeme na HLR Lookups serveru. Koristite ga za sinkronizaciju sata vašeg servera prilikom generiranja Digest-Auth potpisa za autentifikaciju, čime se osigurava korekcija bilo kakvih neslaganja između vremena vašeg servera i vremena HLR Lookups servera.

Zahtjev Uspješan odgovor Odgovor s greškom

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

{
    "time":1525898643
}

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`time`	integer	Unix vremenska oznaka koja predstavlja trenutno vrijeme HLR Lookups servera.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

GET/auth-testzaštićeno

Ova krajnja točka služi kao početni test za vašu Basic-Auth ili, po mogućnosti, Digest-Auth implementaciju.

Basic autentifikacijski zahtjev Digest Auth zahtjev Uspješan odgovor Odgovor s greškom

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

Zaglavlja zahtjeva

Ključ	Tip	Opis
`X-Basic`	string	SHA256 hash od `YOUR_API_KEY:YOUR_API_SECRET`. Uključite simbol dvotočke (:) u hash.

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"

Zaglavlja zahtjeva

Ključ	Tip	Opis
`X-Digest-Key`	string	Vaš HLR Lookups API ključ
`X-Digest-Signature`	string	Jedinstveni Digest-Auth potpis (pogledajte autentifikacija)
`X-Digest-Timestamp`	integer	Trenutna Unix vremenska oznaka (također pogledajte `GET /time`)

{
    "success":true
}

Atributi uspješnog odgovora

Ime	Tip	Opis	Može biti null
`success`	boolean	Označava da je zahtjev uspješno obrađen.	false

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

Parametri odgovora o grešci

Ime	Tip	Opis	Može biti null
`errors[]`	string[]	Popis tekstualnih opisa greške.	false

Pomaknite se gore

Dokumentacija zastarjelog API-ja

Napominjemo da je zastarjeli API zastario i planiran je za uklanjanje u budućnosti. Toplo preporučujemo nadogradnju na najnoviju verziju pri prvoj prilici.

Ako ste implementirali naš HLR Lookups API između 2013. i početka 2020. godine, koristite naš zastarjeli API. U tom slučaju molimo pogledajte našu dokumentaciju zastarjelog API-ja.

Dokumentacija zastarjelog API-ja

API dokumentacija

Početak rada

HLR Provjere

MNP Provjere

NT Provjere

Usmjeravanje

Cijenik

Alati

Početak rada

Korištenje HLR Lookups API-ja

Primjer zahtjeva

Primjer payload-a

Uspješan odgovor application/json

Dodatne usluge upita

Upiti o prenosivosti mobilnih brojeva (MNP)

Upiti o detekciji vrste broja (NT)

Razvojni paketi (SDK-ovi)

Alati

Niste programer?

Autentifikacija

API ključ i API tajna

HTTP Basic autentifikacija

Preporučeno: X-Basic zaglavlje sa SHA256

Basic autentifikacijski zahtjev

Basic autentifikacijska zaglavlja

Primjer koda

Primjer zahtjeva

Zaglavlja zahtjeva

Kreiranje potpisa

Komponente Digest potpisa

Primjeri koda

Koncepti

Sinkroni HLR Lookup API

Asinkroni HLR Lookup API

SDK-ovi (Software Development Kits)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupzaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci

POST/hlr-lookupszaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci

Obrada Webhookova

Autentifikacija

Primjer koda

Potvrda Primitka

Webhook Sadržaj

Atributi webhook payload-a

POST/mnp-lookupzaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci

POST/mnp-lookupszaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci

Obrada Webhookova

Autentifikacija

Primjer koda

Potvrda Primitka

Webhook Sadržaj

Atributi webhook payload-a

POST/nt-lookupzaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci

POST/nt-lookups zaštićeno

Sadržaj

Parametri zahtjeva

Atributi uspješnog odgovora

Parametri odgovora o grešci