Kezdő lépések

A globális mobilhálózati infrastruktúra az SS7 jelzőhálózatként ismert rendszeren működik. Ez a hálózat lehetővé teszi az előfizetői adatok cseréjét, a hívásirányítást, az SMS-továbbítást és a valós idejű mobilkapcsolati állapotfrissítéseket a szolgáltatók között. Minden mobilhálózat egy Home Location Register (HLR) rendszert tart fenn - egy központi adatbázist, amely az előfizetőinek lényeges adatait tárolja.

Az HLR Lookup technológia lehetővé teszi a vállalkozások számára, hogy lekérdezzék ezeket a regisztereket, és valós idejű kapcsolati és hálózati adatokat kérjenek le bármely mobilszámhoz. Ez magában foglalja, hogy a telefon be van-e kapcsolva, jelenleg melyik hálózathoz van rendelve, át lett-e hordozva, érvényes vagy deaktivált-e a szám, valamint hogy roamingban van-e.

Az HLR Lookups API zökkenőmentes, valós idejű hozzáférést biztosít ezekhez az adatokhoz, lehetővé téve a vállalkozások számára a mobilszámok ellenőrzését, az irányítás optimalizálását és az ügyfélkommunikáció javítását. Ez a dokumentáció végigvezeti Önt az HLR Lookups szoftverbe történő integrálásán, lehetővé téve a valós idejű mobilintelligencia automatizált lekérését.

Az HLR Lookups API használata

Az HLR Lookup lekérdezések végrehajtása gyors, biztonságos és egyszerű. Miután regisztrált és megszerezte az API kulcsát, hitelesíthet és azonnali lekérdezéseket indíthat egyszerű HTTP POST kérésekkel a POST /hlr-lookup végponton keresztül. Alternatív megoldásként nagy adathalmazokat is feldolgozhat gyors aszinkron API kérések segítségével, ahol az eredményeket webhook útján kapja vissza a szerverére, ahogyan azt a koncepciók szakaszban ismertetjük.

Példa kérés

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"

A hitelesítés HTTP fejléceken keresztül történik, és a payload.json fájlnak (minimálisan) a következő JSON objektumot kell tartalmaznia:

Példa adatcsomag

{
   "msisdn": "+14156226819"
}

Sikeres végrehajtás esetén egy választ kap, amely a megadott mobilszám valós idejű kapcsolati adatait tartalmazza.

Sikeres válasz 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"
}

A kérés és válasz attribútumok, valamint a kapcsolati állapotok teljes részletezéséért lásd a POST /hlr-lookup dokumentációt.

További lekérdezési szolgáltatások

Mobilszám-hordozhatósági (MNP) lekérdezések

Az MNP lekérdezések segítségével meghatározhatja a hálózati tulajdonjogot és a hordozhatósági adatokat anélkül, hogy valós idejű kapcsolatot kérdezne le. Ha csak egy szám MCCMNC kódjára van szüksége, tekintse meg a POST /mnp-lookup dokumentációt.

Számtípus-észlelési (NT) lekérdezések

Határozza meg, hogy egy telefonszám vezetékes, mobil, emelt díjas, VoIP, személyhívó vagy más számozási tartományba tartozik-e a POST /nt-lookup segítségével.

Szoftverfejlesztői készletek (SDK-k)

Az HLR Lookups API bármely REST klienssel működik, bármilyen programozási nyelven, és közzétettünk SDK-kat PHP, Ruby és NodeJS nyelvekhez a GitHub oldalunkon, hogy gyorsan elindulhasson.

Eszközök

A zökkenőmentes fejlesztési élmény biztosítása érdekében átfogó eszközkészletet kínálunk, beleértve a böngészőalapú API kérés- és webhook monitorozást, az IP-cím fehérlistázást, robusztus hitelesítési lehetőségeket és egy hitelesítési teszt végpontot.

Nem fejlesztő?

Az HLR lekérdezések és számhordozhatósági lekérdezések programozás nélkül is elvégezhetők. Tudjon meg többet vállalati webes kliensünkről és böngészőalapú jelentéskészítési funkcióinkról.

Hitelesítés

A biztonság és a megfelelő hozzáférés-kezelés érdekében a HLR Lookups API-hoz intézett legtöbb kérés hitelesítést igényel. A végpontok nyilvános vagy védett kategóriákba sorolhatók. Védett végpont elérésekor a kérést hitelesíteni kell az API kulcs és titok használatával, Digest-Auth vagy Basic-Auth módszer segítségével. A Digest-Auth a biztonságosabb megoldás, ezért erősen ajánlott. Használja az GET /auth-test végpontot a hitelesítési beállítások ellenőrzéséhez.

API kulcs és API titok

API kulcsát és titkát az API beállítások oldalon érheti el. Beállíthatja az előnyben részesített hitelesítési módszert, valamint engedélyezheti az IP-cím fehérlistázást a fokozott biztonság érdekében. Ha úgy véli, hogy API titka veszélybe került, bármikor létrehozhat egy újat.

Egyszerű hitelesítés Digest hitelesítés IP Engedélyezés

A szabványos egyszerű hitelesítés könnyen megvalósítható és széles körben támogatott. A hitelesítéshez adja meg API kulcsát és titkát user:pass párként a HTTP kérésben.

HTTP egyszerű hitelesítés

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

Ez egy Authorization fejlécet küld:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Ajánlott: X-Basic fejléc SHA256-tal

A fokozott biztonság érdekében elküldheti hitelesítő adatai SHA256 hash-ét ahelyett, hogy közvetlenül base64 formátumban továbbítaná azokat. Ezen módszer használatához számítsa ki YOUR_API_KEY:YOUR_API_SECRET párja hash-ét, és küldje el a X-Basic fejlécen keresztül:

Egyszerű hitelesítési kérés

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

Egyszerű hitelesítési fejlécek

Kulcs	Típus	Leírás
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` SHA256 hash-e. A kettőspont szimbólumot (:) is vegye figyelembe a hash-ben.	kötelező

Kódpélda

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

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

A Digest-Auth az ajánlott módszer a védett HLR Lookup API végpontokhoz való hozzáférés biztosítására. Minden kérésnek tartalmaznia kell a következő fejléceket: X-Digest-Key, X-Digest-Signature és X-Digest-Timestamp, amelyeket alább ismertetünk.

Kérés példa

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"

Kérés fejlécek

Kulcs	Típus	Leírás
`X-Digest-Key`	string	Az Ön egyedi HLR Lookups API kulcsa.	kötelező
`X-Digest-Signature`	string	Egyedi hitelesítési aláírás (lásd alább).	kötelező
`X-Digest-Timestamp`	integer	Aktuális Unix időbélyeg (lásd még `GET /time`).	kötelező

Az aláírás létrehozása

A X-Digest-Signature SHA256 HMAC hash segítségével jön létre, az API titok megosztott kulcsként való használatával.

A hash-elendő karakterlánc felépítése a következő:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

A . szimbólum karakterlánc-összefűzést jelent.

Digest aláírás komponensei

Komponens	Típus	Leírás
`ENDPOINT_PATH`	string	A kért API végpont, pl. `/auth-test` kisbetűvel.
`UNIX_TIMESTAMP`	integer	Aktuális Unix időbélyeg (30 másodpercen belül kell lennie). Lásd `GET /time`.
`REQUEST_METHOD`	string	A használt HTTP metódus, pl. `POST` vagy `GET`.
`REQUEST_BODY`	string	Kérés törzs adatok. `GET` kéréseknél állítsa `null` értékre.

Kódpéldák

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)

Görgetés felfelé

Alapfogalmak

A HLR lekérdezések implementálása bármilyen programozási nyelven vagy rendszerben HTTP REST API-nkon keresztül egyszerű és hatékony. Az egyszerű integrációs folyamatnak köszönhetően valós időben lekérdezheti a mobilhálózatokat, és azonnali betekintést nyerhet a telefonszámok érvényességébe, kapcsolati állapotába és útválasztási részleteibe.

A megfelelő API kiválasztása az Ön konkrét felhasználási esetétől függ. Ha valós idejű lekérdezési eredményekre van szüksége olyan alkalmazásokhoz, mint a VoIP telefónia, csalásfelderítés vagy SMS útválasztás, a szinkron API a legjobb választás. Ha azonban a felhasználási eset nagy volumenű feldolgozást, tömeges lekérdezéseket vagy nagyszabású adatellenőrzést foglal magában, az aszinkron API optimalizált teljesítményt kínál sávszélesség-hatékonysággal és kötegelt lekérdezési képességekkel.

Konfigurálja az API-t, hogy egyéni útválasztási lehetőségeink egyikét használja a sebesség, pontosság és költséghatékonyság optimalizálása érdekében. A lekérdezési eredményeket tárolókban is elmentheti a könnyű CSV és JSON riportletöltés, valamint a webes felületen keresztül elérhető fejlett elemzések érdekében.

Szinkron HLR lekérdezési API

A POST /hlr-lookup végpont kérésenként egy mobiltelefon-számot (MSISDN) dolgoz fel, és az eredményeket azonnal visszaadja a HTTP válasz törzsében. Az eredmények JSON formátumban kerülnek visszaadásra, és ideálisak valós idejű alkalmazásokhoz, beleértve a mobilszám-validálást, hívásirányítást és SMS üzenetkézbesítést.

A szinkron API hívás egy közvetlen HTTP kérésből és válaszból áll. A rendszere kérésenként egyetlen MSISDN-t (mobilszámot) küld be, és azonnali választ kap, amely valós idejű HLR lekérdezési eredményeket tartalmaz JSON formátumban. Ez az API olyan felhasználási esetekre optimalizált, amelyek azonnali ellenőrzést és kapcsolódási vizsgálatokat igényelnek, mint például a csalásfelderítés, VoIP hívásirányítás és SMS átjáró optimalizálás.

Aszinkron HLR Lookup API

Az POST /hlr-lookups végpont tömeges és nagy volumenű feldolgozásra lett tervezve, lehetővé téve, hogy kérésenként akár 1,000 MSISDN-t küldjön be. Az azonnali eredmények visszaadása helyett ez az API automatizált webhookok segítségével fokozatosan küldi el az eredményeket a szerverére. A lekérdezési eredmények JSON objektumokként kerülnek visszaküldésre HTTP POST visszahívások révén.

Az aszinkron API sebességre, hatékonyságra és skálázhatóságra van optimalizálva. Kiküszöböli a szinkron hívásokhoz kapcsolódó hálózati késleltetési problémákat, így ideális a nagy áteresztőképességű lekérdezéseket igénylő vállalkozások számára. A rendszere kérésenként akár 1,000 MSISDN-t küld be, platformunk pedig párhuzamosan dolgozza fel azokat, és HTTP webhookok révén kötegekben, visszahívásonként akár 1,000 eredménnyel küldi vissza azokat a szerverére.

SDK-k (szoftverfejlesztői készletek)

PHP, NodeJS és Ruby szoftverfejlesztői készleteink (SDK-k) egyszerűsítik az integrációs folyamatot, lehetővé téve a HLR Lookups API-hoz való hatékony és minimális erőfeszítéssel történő csatlakozást.

Ezek az SDK-k előre elkészített függvényeket, hitelesítéskezelést és strukturált API kéréssablonokat biztosítanak, csökkentve a fejlesztési időt és garantálva a bevált gyakorlatokat.

Tekintse meg a rendelkezésre álló SDK-k teljes listáját a GitHubon, és kezdje el az integrációt még ma.

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

Megtekintés a GitHubon 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   }

Megtekintés a GitHubon 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)

Megtekintés a GitHubon README.md

Görgetés felfelé

POST/hlr-lookupvédett

Valós idejű HLR lekérdezést hajt végre, amely a mobiltelefon csatlakozási és hordozhatósági adatokat közvetlenül a hálózati szolgáltatóktól szolgáltatja. Ez a végpont ideális olyan élő forgalmi forgatókönyvekhez, ahol az időérzékeny alkalmazások azonnali ellenőrzést igényelnek arról, hogy egy telefonszám jelenleg elérhető-e (csatlakoztatva) vagy nem elérhető (kikapcsolva). Ezen kívül segít megkülönböztetni az aktív számokat az érvénytelen, ismeretlen vagy hamis számoktól.

Nagy adathalmazok tömeges feldolgozásához, amelyek nem igényelnek azonnali eredményt, fontolja meg az aszinkron POST /hlr-lookups használatát, amely nagy sebességű kötegelt feldolgozásra van optimalizálva.

Ha elsődleges célja a mobilszám-hordozhatósági adatok (MCCMNC) lekérése, és nincs szüksége élő csatlakozási állapotra, az POST /mnp-lookup költséghatékony alternatívát kínál a mobilszám-hordozhatósági lekérdezésekhez.

Kérés Sikeres válasz Hibaválasz Státusz referencia

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdn`	string	A lekérdezendő mobiltelefon-szám (MSISDN) nemzetközi formátumban megadva (pl. +14156226819 vagy 0014156226819). Az országkódot kötelező megadni.	null	kötelező
`route`	string(3)	Opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre vagy hagyja ki ezt a paramétert az egyéni útválasztási térképe alkalmazásához, vagy hagyja, hogy rendszerünk automatikusan meghatározza a legjobb útvonalat ehhez a lekérdezéshez.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`id`	string(12)	A lekérdezési kérelemhez rendelt egyedi azonosító.	false
`msisdn`	string	A lekérdezett mobiltelefon-szám nemzetközi formátumban (pl. +14156226819 vagy 0014156226819).	false
`connectivity_status`	string	Jelzi, hogy a szám kapcsolódási állapota sikeresen lekérdezésre került-e. Lehetséges értékek: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` vagy `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Öt- vagy hatjegyű Mobile Country Code (MCC) és Mobile Network Code (MNC), amely a telefonszámhoz jelenleg társított hálózatot azonosítja.	true
`mcc`	string(3)	Háromjegyű Mobile Country Code (MCC), amely azt az országot azonosítja, ahol a telefonszám regisztrálva van.	true
`mnc`	string(2\|3)	Két- vagy háromjegyű Mobile Network Code (MNC), amely a telefonszámhoz tartozó konkrét hálózatot azonosítja.	true
`imsi`	string	Az International Mobile Subscriber Identity (IMSI), a telefonszámhoz társított SIM-kártya egyedi azonosítója. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`msin`	string(10)	A Mobile Subscription Identification Number (MSIN) a mobilszolgáltató adatbázisában. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`msc`	string(12)	A Mobile Switching Center (MSC), amely jelenleg kezeli az előfizető kommunikációját. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`original_network_name`	string	A telefonszámhoz társított eredeti (natív) hálózati szolgáltató neve.	true
`original_country_name`	string	Annak az országnak a teljes neve, ahol a mobiltelefon-szám eredetileg regisztrálva lett, angol nyelven megadva.	true
`original_country_code`	string(2)	A kétkarakteres ISO országkód, amely azt az országot jelöli, ahol a telefonszám eredetileg kiosztásra került.	true
`original_country_prefix`	string	A nemzetközi hívószám (országos hívókód), amely a mobiltelefon-szám eredeti országához tartozik.	true
`is_ported`	boolean	Jelzi, hogy a mobilszám át lett-e portolva az eredeti hálózatról egy másik szolgáltatóhoz.	true
`ported_network_name`	string	Annak a hálózati szolgáltatónak a neve, amelyhez a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_name`	string	Annak az országnak a neve, ahová a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_code`	string(2)	A kétkarakteres ISO országkód, amely azt az országot jelöli, ahová a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_prefix`	string	A nemzetközi hívószám (országos hívókód) ahhoz az országhoz, ahová a mobilszám át lett portolva, ha van ilyen.	true
`is_roaming`	boolean	Jelzi, hogy a mobilszám jelenleg külföldi hálózaton barangol-e. A barangolási állapot elérhetősége a mobilhálózat-szolgáltatótól függ.	true
`roaming_network_name`	string	Annak a hálózatnak a neve, amelyen a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_name`	string	Annak az országnak a neve, ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_code`	string(2)	Annak az országnak a kétkarakteres ISO országkódja, ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_prefix`	string	Annak az országnak a nemzetközi hívószáma (országos hívókód), ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`cost`	string	Karakterláncként megadott decimális érték, amely a lekérdezés költségét jelzi euróban.	true
`timestamp`	string	W3C formátumú időbélyeg időzóna megadással, amely meghatározza a lekérdezés befejezésének időpontját.	true
`storage`	string	Annak a tárhelynek a neve, ahol a lekérdezési eredmények mentésre kerültek. Ez megfelel a webes felületen elérhető jelentésneveknek és CSV letöltéseknek.	true
`route`	string(3)	Háromkarakteres azonosító, amely jelzi a lekérdezési kérelemhez használt útvonalválasztási módszert.	true
`processing_status`	string	A lekérdezés feldolgozási eredménye. Lehetséges értékek: `COMPLETED` (sikeres), `REJECTED` (hálózat nem elérhető, díj nem került felszámításra) vagy `FAILED` (hiba történt a feldolgozás során).	false
`error_code`	integer	Opcionális belső hibakód, amely további diagnosztikai információt nyújt az ügyfélszolgálat számára.	true
`error_description`	string	A megadott hibakód (ha van ilyen) rövid magyarázata angol nyelvű egyszerű szövegben.	true
`data_source`	string	A kérelemhez használt adatforrás. Lehetséges értékek: `LIVE_HLR` (valós idejű HLR lekérdezés) vagy `MNP_DB` (statikus mobilszám-hordozhatósági adatbázis). További részletekért lásd az útvonalválasztási lehetőségeket.	false
`routing_instruction`	string	Kettősponttal elválasztott karakterlánc, amely a kérelemben használt útvonalválasztási utasítást írja le. Az első komponens `STATIC`, ha megadott egy útvonalat, vagy `AUTO` automatikus útvonalválasztás esetén; a második komponens az útvonal azonosítója, és automatikus útvonalválasztási kérelmek esetén egy harmadik komponens mutatja azt az eredetet, amelyen az útvonalválasztási döntés alapul (azaz `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."
    ]
}

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Állapot	Leírás
CONNECTED	A szám érvényes, és a célkészülék jelenleg csatlakozik a mobilhálózathoz. A hívások, SMS-ek és egyéb szolgáltatások sikeresen elérhetik a címzettet.
ABSENT	A szám érvényes, de a célkészülék ki van kapcsolva vagy átmenetileg nincs hálózati lefedettségben. Az üzenetek vagy hívások nem kerülnek kézbesítésre, amíg a készülék újra nem csatlakozik a hálózathoz.
INVALID_MSISDN	A szám érvénytelen vagy jelenleg nincs hozzárendelve egyetlen előfizetőhöz sem a mobilhálózaton. Az erre a számra irányuló hívások és üzenetek sikertelenek lesznek.
UNDETERMINED	A szám csatlakozási állapota nem határozható meg. Ennek oka lehet érvénytelen szám, SS7 hibaválasz vagy a célhálózat-üzemeltetővel való kapcsolat hiánya. További diagnosztikai információkért tekintse meg a hibakódot és annak leírását.

Görgetés felfelé

POST/hlr-lookupsvédett

Aszinkron HLR lekérdezések kötegelt indítása, amely valós idejű mobiltelefon-kapcsolódási és hordozhatósági adatokat kér le a hálózati szolgáltatóktól. Az eredmények webhook-okon keresztül kerülnek kézbesítésre az Ön szerverére. Ez a módszer nagy mennyiségű telefonszám feldolgozására optimalizált, amelyek nem igényelnek azonnali választ, mint például adatbázis-tisztítás és ellenőrzés. Valós idejű alkalmazásokhoz, mint például hívásirányítás vagy SMS kézbesítés, fontolja meg a POST /hlr-lookup végpont használatát.

Ez a végpont ideális tömeges feldolgozáshoz, amikor a cél az aktuálisan elérhető (csatlakoztatott) vagy nem elérhető (kikapcsolt telefon) telefonszámok azonosítása, miközben kiszűri az érvénytelen, nem kiosztott vagy hamis számokat. Emellett valós idejű hordozhatósági státuszt (MCCMNC) is biztosít a kapcsolódási adatok mellett.

A végpont használata előtt győződjön meg arról, hogy webhook URL van beállítva a lekérdezési eredmények aszinkron fogadásához. Ezt az API beállításokban konfigurálhatja.

Kérés Sikeres válasz Hibaválasz Webhookok Státusz referencia

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdns`	array	Mobiltelefonszámok (MSISDN-ek) tömbje nemzetközi formátumban (pl. +14156226819 vagy 0014156226819). Kérésenként legfeljebb 1000 szám adható meg.	null	kötelező
`route`	string(3)	Opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre vagy hagyja ki ezt a paramétert az egyéni útválasztási térképe alkalmazásához, vagy hagyja, hogy rendszerünk automatikusan meghatározza a legjobb útvonalat ehhez a lekérdezéshez.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`accepted`	array	Egyedi azonosítókat és MSISDN-eket tartalmazó objektumok listája, amelyek feldolgozásra elfogadásra kerültek.	false
`accepted_count`	integer	A feldolgozásra sikeresen elfogadott MSISDN-ek teljes száma.	false
`rejected`	array	Egyedi azonosítókat és MSISDN-eket tartalmazó objektumok listája, amelyek feldolgozásra elutasításra kerültek, jellemzően érvénytelen számok miatt. Az elutasított tételekre nem vonatkozik díjfizetési kötelezettség.	false
`rejected_count`	integer	Az érvényesítési hibák miatt elutasított MSISDN-ek teljes száma.	false
`total_count`	integer	A feldolgozásra beküldött elfogadott és elutasított MSISDN-ek összesített száma.	false
`cost`	string	Karakterláncként megadott decimális érték, amely az elfogadott lekérdezések teljes költségét jelzi euróban.	false
`storage`	string	A tárhely neve, ahová a lekérdezési eredmények kerülnek, és amely a webes felületen keresztüli jelentésekhez és CSV letöltésekhez használatos.	false
`route`	string(3\|4)	Három vagy négy karakteres azonosító, amely meghatározza a lekérdezési kérelemhez használt útvonalat. AUTO értéket tartalmaz, ha számalapú automatikus útválasztás lett kérve.	false
`webhook_urls`	array	Az API beállításokban konfigurált webhook URL-ek. Az eredmények ide kerülnek visszaküldésre.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Webhookok feldolgozása

A beküldést követően platformunk megkezdi a megadott telefonszámok feldolgozását, és az eredményeket a korábban megadott webhook URL-re küldi a szerveren. Az eredmények HTTP POST kérésként kerülnek továbbításra, a kérés törzsében JSON objektummal.

Hitelesítés

A webhook hitelesítéséhez ellenőrizze a X-Signatures HTTP fejlécet.

A X-Signatures fejléc pontosvesszővel elválasztott aláírások listáját tartalmazza. A listában szereplő minden aláírás a fiókjában beállított API titkos kulcsok egyikével kerül generálásra. A webhook ellenőrzéséhez hozzon létre egy SHA-256 hash-t az API kulcsa, titkos kulcsa és a nyers HTTP törzs felhasználásával, majd hasonlítsa össze a listában szereplő aláírásokkal.

Az egyezés megerősíti, hogy a kérés hiteles és az Ön által kezelt titkos kulccsal van aláírva.

Kódpélda

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

A kérés érvényes, ha a fejlécben megadott aláírások bármelyike megegyezik az API kulcsból, titkos kulcsból és a HTTP törzsből összefűzött karakterlánc SHA256 hash-ével.

Átvétel visszaigazolása

A szerver várhatóan 200 OK HTTP státuszkóddal válaszol a sikeres átvétel megerősítéséhez. Ha bármilyen más válaszkód érkezik, időtúllépés történik (10 másodperc), vagy bármilyen más kézbesítési probléma merül fel, a rendszer automatikusan újrapróbálja a webhookot egy perc múlva. Ha a kérés továbbra is sikertelen, az újrapróbálkozások exponenciális visszalépési stratégiát követnek, a következő kísérletek 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 perc múlva történnek.

Ez az újrapróbálkozási mechanizmus maximális megbízhatóságot biztosít a lekérdezési eredmények infrastruktúrájába történő kézbesítésében. Minimalizálja az adatvesztés kockázatát az átmeneti hálózati problémák vagy szerver leállás miatt.

Webhook adattartalom

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

Webhook adatcsomag attribútumai

A JSON objektum tartalmaz egy type => HLR attribútumot, valamint egy results attribútumot, amely lekérdezési objektumok listáját tartalmazza az alábbiak szerint dokumentálva.

Név	Típus	Leírás	Nullable
`id`	string(12)	A lekérdezési kérelemhez rendelt egyedi azonosító.	false
`msisdn`	string	A lekérdezett mobiltelefon-szám nemzetközi formátumban (pl. +14156226819 vagy 0014156226819).	false
`connectivity_status`	string	Jelzi, hogy a szám kapcsolódási állapota sikeresen lekérdezésre került-e. Lehetséges értékek: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` vagy `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Öt- vagy hatjegyű Mobile Country Code (MCC) és Mobile Network Code (MNC), amely a telefonszámhoz jelenleg társított hálózatot azonosítja.	true
`mcc`	string(3)	Háromjegyű Mobile Country Code (MCC), amely azt az országot azonosítja, ahol a telefonszám regisztrálva van.	true
`mnc`	string(2\|3)	Két- vagy háromjegyű Mobile Network Code (MNC), amely a telefonszámhoz tartozó konkrét hálózatot azonosítja.	true
`imsi`	string	Az International Mobile Subscriber Identity (IMSI), a telefonszámhoz társított SIM-kártya egyedi azonosítója. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`msin`	string(10)	A Mobile Subscription Identification Number (MSIN) a mobilszolgáltató adatbázisában. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`msc`	string(12)	A Mobile Switching Center (MSC), amely jelenleg kezeli az előfizető kommunikációját. A rendelkezésre állás a hálózati konfigurációtól függ.	true
`original_network_name`	string	A telefonszámhoz társított eredeti (natív) hálózati szolgáltató neve.	true
`original_country_name`	string	Annak az országnak a teljes neve, ahol a mobiltelefon-szám eredetileg regisztrálva lett, angol nyelven megadva.	true
`original_country_code`	string(2)	A kétkarakteres ISO országkód, amely azt az országot jelöli, ahol a telefonszám eredetileg kiosztásra került.	true
`original_country_prefix`	string	A nemzetközi hívószám (országos hívókód), amely a mobiltelefon-szám eredeti országához tartozik.	true
`is_ported`	boolean	Jelzi, hogy a mobilszám át lett-e portolva az eredeti hálózatról egy másik szolgáltatóhoz.	true
`ported_network_name`	string	Annak a hálózati szolgáltatónak a neve, amelyhez a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_name`	string	Annak az országnak a neve, ahová a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_code`	string(2)	A kétkarakteres ISO országkód, amely azt az országot jelöli, ahová a mobilszám át lett portolva, ha van ilyen.	true
`ported_country_prefix`	string	A nemzetközi hívószám (országos hívókód) ahhoz az országhoz, ahová a mobilszám át lett portolva, ha van ilyen.	true
`is_roaming`	boolean	Jelzi, hogy a mobilszám jelenleg külföldi hálózaton barangol-e. A barangolási állapot elérhetősége a mobilhálózat-szolgáltatótól függ.	true
`roaming_network_name`	string	Annak a hálózatnak a neve, amelyen a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_name`	string	Annak az országnak a neve, ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_code`	string(2)	Annak az országnak a kétkarakteres ISO országkódja, ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`roaming_country_prefix`	string	Annak az országnak a nemzetközi hívószáma (országos hívókód), ahol a mobilszám jelenleg barangol, ha van ilyen.	true
`cost`	string	Karakterláncként megadott decimális érték, amely a lekérdezés költségét jelzi euróban.	true
`timestamp`	string	W3C formátumú időbélyeg időzóna megadással, amely meghatározza a lekérdezés befejezésének időpontját.	true
`storage`	string	Annak a tárhelynek a neve, ahol a lekérdezési eredmények mentésre kerültek. Ez megfelel a webes felületen elérhető jelentésneveknek és CSV letöltéseknek.	true
`route`	string(3)	Háromkarakteres azonosító, amely jelzi a lekérdezési kérelemhez használt útvonalválasztási módszert.	true
`processing_status`	string	A lekérdezés feldolgozási eredménye. Lehetséges értékek: `COMPLETED` (sikeres), `REJECTED` (hálózat nem elérhető, díj nem került felszámításra) vagy `FAILED` (hiba történt a feldolgozás során).	false
`error_code`	integer	Opcionális belső hibakód, amely további diagnosztikai információt nyújt az ügyfélszolgálat számára.	true
`error_description`	string	A megadott hibakód (ha van ilyen) rövid magyarázata angol nyelvű egyszerű szövegben.	true
`data_source`	string	A kérelemhez használt adatforrás. Lehetséges értékek: `LIVE_HLR` (valós idejű HLR lekérdezés) vagy `MNP_DB` (statikus mobilszám-hordozhatósági adatbázis). További részletekért lásd az útvonalválasztási lehetőségeket.	false
`routing_instruction`	string	Kettősponttal elválasztott karakterlánc, amely a kérelemben használt útvonalválasztási utasítást írja le. Az első komponens `STATIC`, ha megadott egy útvonalat, vagy `AUTO` automatikus útvonalválasztás esetén; a második komponens az útvonal azonosítója, és automatikus útvonalválasztási kérelmek esetén egy harmadik komponens mutatja azt az eredetet, amelyen az útvonalválasztási döntés alapul (azaz `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

Állapot	Leírás
CONNECTED	A szám érvényes, és a célkészülék jelenleg csatlakozik a mobilhálózathoz. A hívások, SMS-ek és egyéb szolgáltatások sikeresen elérhetik a címzettet.
ABSENT	A szám érvényes, de a célkészülék ki van kapcsolva vagy átmenetileg nincs hálózati lefedettségben. Az üzenetek vagy hívások nem kerülnek kézbesítésre, amíg a készülék újra nem csatlakozik a hálózathoz.
INVALID_MSISDN	A szám érvénytelen vagy jelenleg nincs hozzárendelve egyetlen előfizetőhöz sem a mobilhálózaton. Az erre a számra irányuló hívások és üzenetek sikertelenek lesznek.
UNDETERMINED	A szám csatlakozási állapota nem határozható meg. Ennek oka lehet érvénytelen szám, SS7 hibaválasz vagy a célhálózat-üzemeltetővel való kapcsolat hiánya. További diagnosztikai információkért tekintse meg a hibakódot és annak leírását.

Görgetés felfelé

POST/mnp-lookupvédett

Szinkron MNP lekérdezést hajt végre, és mobilszám-hordozhatósági valamint hálózati információkat szolgáltat. Ez a végpont akkor megfelelő, ha elsődleges célja egy adott mobilszám aktuális MCCMNC kódjának kinyerése, valamint az eredeti és jelenlegi hálózat valós idejű azonosítása.

Nagy adathalmazok tömeges feldolgozásához, amelyek nem igényelnek azonnali eredményt, fontolja meg az aszinkron POST /mnp-lookups használatát, amely nagy sebességű kötegelt feldolgozásra van optimalizálva.

Az MNP lekérdezések megbízhatóan meghatározzák a hordozhatósági és hálózati információkat, de nem jelzik, hogy a célmobiltelefon jelenleg csatlakozik-e a hálózathoz és elérhető-e. Valós idejű kapcsolódási információk kinyeréséhez kérjük, használja helyette a POST /hlr-lookup végpontot.

Kérés Sikeres válasz Hibaválasz

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdn`	string	A lekérdezendő mobiltelefon-szám (MSISDN) nemzetközi formátumban megadva (pl. +14156226819 vagy 0014156226819). Az országkódot kötelező megadni.	null	kötelező
`route`	string(3)	Opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre vagy hagyja ki ezt a paramétert az egyéni útválasztási térképe alkalmazásához, vagy hagyja, hogy rendszerünk automatikusan meghatározza a legjobb útvonalat ehhez a lekérdezéshez.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`id`	string(12)	Egyedi 12 karakteres azonosító ehhez a lekérdezéshez.	false
`msisdn`	string	A lekérdezési kérelemben ellenőrzött mobiltelefon-szám.	false
`query_status`	string	Jelzi, hogy a hordozhatósági és hálózati információk lekérése sikeres volt-e. Lehetséges értékek: `OK` vagy `FAILED`.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakteres MCCMNC (mobilország-kód és mobilhálózat-kód pár), amely azonosítja azt a hálózatot, amelyhez a mobiltelefon-szám jelenleg tartozik.	true
`mcc`	string(3)	Három karakteres MCC (mobilország-kód), amely a mobiltelefon-szám jelenlegi hálózatához tartozó országot jelöli.	true
`mnc`	string(2\|3)	Két vagy három karakteres MNC (mobilhálózat-kód), amely azonosítja a mobiltelefon-szám jelenlegi hálózati szolgáltatóját.	true
`is_ported`	boolean	Jelzi, hogy a telefonszám át lett-e hordozva az eredeti hálózatról egy új szolgáltatóhoz.	true
`original_network_name`	string	Tetszőleges karakterlánc (angol nyelven), amely megadja az ellenőrzött mobiltelefon-szám eredeti hálózati szolgáltatójának nevét.	true
`original_country_name`	string	Tetszőleges karakterlánc (angol nyelven), amely jelzi az ellenőrzött mobiltelefon-szám eredeti országát.	true
`original_country_code`	string(2)	Két karakteres ISO országkód, amely az ellenőrzött mobiltelefon-szám eredeti országát jelöli.	true
`original_country_prefix`	string	Az ellenőrzött mobiltelefon-számhoz tartozó eredeti ország hívószáma.	true
`ported_network_name`	string	Megadja azt a hálózati szolgáltatót, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_name`	string	Megadja azt az országot, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_code`	string(2)	Két karakteres ISO országkód, amely azt az országot jelöli, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_prefix`	string	Annak az országnak a hívószáma, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`extra`	string	Tetszőleges karakterlánc, amely opcionális kiegészítő részleteket tartalmaz a telefonszámról.	true
`cost`	string	Karakterláncként megadott decimális érték, amely a lekérdezés költségét jelzi euróban.	true
`timestamp`	string	W3C formátumú időbélyeg, időzóna-információval, amely jelzi a lekérdezés befejezésének időpontját.	true
`storage`	string	A tárolási név (vagy jelentésnév), amelyhez a lekérdezési eredmények hozzá lettek fűzve. Ez a CSV letöltésekhez és a webes felületen keresztüli jelentésekhez használatos.	true
`route`	string(3)	Három karakteres azonosító, amely megadja az ehhez a lekérdezési kérelemhez használt útvonalat.	true
`error_code`	integer	Opcionális belső hibakód, amely további kontextust biztosít az ügyfélszolgálati diagnosztikához.	true

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

POST/mnp-lookupsvédett

Aszinkron MNP (mobil szám hordozhatósági) lekérdezések kötegelt indítása, amely valós időben lekéri az aktuális MCCMNC-t és pontosan meghatározza az eredeti és jelenlegi hálózatokat. Az eredmények webhook-okon keresztül kerülnek kézbesítésre az Ön szerverére. Ez a módszer nagy mennyiségű telefonszám feldolgozására optimalizált, amelyek nem igényelnek azonnali választ, mint például adatbázis-tisztítás és ellenőrzés. Valós idejű alkalmazásokhoz, mint például hívásirányítás vagy SMS kézbesítés, fontolja meg a POST /mnp-lookup végpont használatát.

Az MNP lekérdezések megbízhatóan meghatározzák a hordozhatósági és hálózati információkat, de nem jelzik, hogy a célmobiltelefon jelenleg csatlakozik-e a hálózathoz és elérhető-e. Valós idejű kapcsolódási információk kinyeréséhez kérjük, használja helyette a POST /hlr-lookups végpontot.

A végpont használata előtt győződjön meg arról, hogy webhook URL van beállítva a lekérdezési eredmények aszinkron fogadásához. Ezt az API beállításokban konfigurálhatja.

Kérés Sikeres válasz Hibaválasz Webhookok

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdns`	array	Mobiltelefonszámok (MSISDN-ek) tömbje nemzetközi formátumban (pl. +14156226819 vagy 0014156226819). Kérésenként legfeljebb 1000 szám adható meg.	null	kötelező
`route`	string(3)	Egy opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre vagy hagyja ki ezt a paramétert az egyéni útvonaltérkép alkalmazásához, vagy hogy rendszerünk automatikusan meghatározza a kérés legjobb útvonalait.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`accepted`	array	Egyedi azonosítókat és MSISDN-eket tartalmazó objektumok listája, amelyek feldolgozásra elfogadásra kerültek.	false
`accepted_count`	integer	A feldolgozásra sikeresen elfogadott MSISDN-ek teljes száma.	false
`rejected`	array	Egyedi azonosítókat és MSISDN-eket tartalmazó objektumok listája, amelyek feldolgozásra elutasításra kerültek, jellemzően érvénytelen számok miatt. Az elutasított tételekre nem vonatkozik díjfizetési kötelezettség.	false
`rejected_count`	integer	Az érvényesítési hibák miatt elutasított MSISDN-ek teljes száma.	false
`total_count`	integer	A feldolgozásra beküldött elfogadott és elutasított MSISDN-ek összesített száma.	false
`cost`	string	Karakterláncként megadott decimális érték, amely az elfogadott lekérdezések teljes költségét jelzi euróban.	false
`storage`	string	A tárhely neve, ahová a lekérdezési eredmények kerülnek, és amely a webes felületen keresztüli jelentésekhez és CSV letöltésekhez használatos.	false
`route`	string(3)	Három karakteres azonosító, amely megadja az ehhez a lekérdezési kérelemhez használt útvonalat.	false
`webhook_urls`	array	Az API beállításokban konfigurált webhook URL-ek. Az eredmények ide kerülnek visszaküldésre.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Webhookok feldolgozása

A beküldést követően platformunk megkezdi a megadott telefonszámok feldolgozását, és az eredményeket a korábban megadott webhook URL-re küldi a szerveren. Az eredmények HTTP POST kérésként kerülnek továbbításra, a kérés törzsében JSON objektummal.

Hitelesítés

A webhook hitelesítéséhez ellenőrizze a X-Signatures HTTP fejlécet.

A X-Signatures fejléc pontosvesszővel elválasztott aláírások listáját tartalmazza. A listában szereplő minden aláírás a fiókjában beállított API titkos kulcsok egyikével kerül generálásra. A webhook ellenőrzéséhez hozzon létre egy SHA-256 hash-t az API kulcsa, titkos kulcsa és a nyers HTTP törzs felhasználásával, majd hasonlítsa össze a listában szereplő aláírásokkal.

Az egyezés megerősíti, hogy a kérés hiteles és az Ön által kezelt titkos kulccsal van aláírva.

Kódpélda

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

A kérés érvényes, ha a fejlécben megadott aláírások bármelyike megegyezik az API kulcsból, titkos kulcsból és a HTTP törzsből összefűzött karakterlánc SHA256 hash-ével.

Átvétel visszaigazolása

A szerver várhatóan 200 OK HTTP státuszkóddal válaszol a sikeres átvétel megerősítéséhez. Ha bármilyen más válaszkód érkezik, időtúllépés történik (10 másodperc), vagy bármilyen más kézbesítési probléma merül fel, a rendszer automatikusan újrapróbálja a webhookot egy perc múlva. Ha a kérés továbbra is sikertelen, az újrapróbálkozások exponenciális visszalépési stratégiát követnek, a következő kísérletek 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 perc múlva történnek.

Ez az újrapróbálkozási mechanizmus maximális megbízhatóságot biztosít a lekérdezési eredmények infrastruktúrájába történő kézbesítésében. Minimalizálja az adatvesztés kockázatát az átmeneti hálózati problémák vagy szerver leállás miatt.

Webhook adattartalom

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

Webhook adatcsomag attribútumai

A JSON objektum tartalmaz egy type => MNP attribútumot, valamint egy results attribútumot, amely lekérdezési objektumok listáját tartalmazza az alábbiak szerint dokumentálva.

Név	Típus	Leírás	Nullable
`id`	string(12)	Egyedi 12 karakteres azonosító ehhez a lekérdezéshez.	false
`msisdn`	string	A lekérdezési kérelemben ellenőrzött mobiltelefon-szám.	false
`query_status`	string	Jelzi, hogy a hordozhatósági és hálózati információk lekérése sikeres volt-e. Lehetséges értékek: `OK` vagy `FAILED`.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakteres MCCMNC (mobilország-kód és mobilhálózat-kód pár), amely azonosítja azt a hálózatot, amelyhez a mobiltelefon-szám jelenleg tartozik.	true
`mcc`	string(3)	Három karakteres MCC (mobilország-kód), amely a mobiltelefon-szám jelenlegi hálózatához tartozó országot jelöli.	true
`mnc`	string(2\|3)	Két vagy három karakteres MNC (mobilhálózat-kód), amely azonosítja a mobiltelefon-szám jelenlegi hálózati szolgáltatóját.	true
`is_ported`	boolean	Jelzi, hogy a telefonszám át lett-e hordozva az eredeti hálózatról egy új szolgáltatóhoz.	true
`original_network_name`	string	Tetszőleges karakterlánc (angol nyelven), amely megadja az ellenőrzött mobiltelefon-szám eredeti hálózati szolgáltatójának nevét.	true
`original_country_name`	string	Tetszőleges karakterlánc (angol nyelven), amely jelzi az ellenőrzött mobiltelefon-szám eredeti országát.	true
`original_country_code`	string(2)	Két karakteres ISO országkód, amely az ellenőrzött mobiltelefon-szám eredeti országát jelöli.	true
`original_country_prefix`	string	Az ellenőrzött mobiltelefon-számhoz tartozó eredeti ország hívószáma.	true
`ported_network_name`	string	Megadja azt a hálózati szolgáltatót, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_name`	string	Megadja azt az országot, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_code`	string(2)	Két karakteres ISO országkód, amely azt az országot jelöli, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`ported_country_prefix`	string	Annak az országnak a hívószáma, amelyhez az ellenőrzött mobiltelefon-szám át lett hordozva, ha alkalmazható.	true
`extra`	string	Tetszőleges karakterlánc, amely opcionális kiegészítő részleteket tartalmaz a telefonszámról.	true
`cost`	string	Karakterláncként megadott decimális érték, amely a lekérdezés költségét jelzi euróban.	true
`timestamp`	string	W3C formátumú időbélyeg, időzóna-információval, amely jelzi a lekérdezés befejezésének időpontját.	true
`storage`	string	A tárolási név (vagy jelentésnév), amelyhez a lekérdezési eredmények hozzá lettek fűzve. Ez a CSV letöltésekhez és a webes felületen keresztüli jelentésekhez használatos.	true
`route`	string(3)	Három karakteres azonosító, amely megadja az ehhez a lekérdezési kérelemhez használt útvonalat.	true
`error_code`	integer	Opcionális belső hibakód, amely további kontextust biztosít az ügyfélszolgálati diagnosztikához.	true

Görgetés felfelé

POST/nt-lookupvédett

Szinkron számtípus (NT) lekérdezést hajt végre. Ez a végpont ideális, ha elsődleges célja annak valós idejű meghatározása, hogy a megadott telefonszámok vezetékes, mobil, emelt díjas, VoIP, csipogó vagy egyéb számozási tartományokba tartoznak-e.

Az NT lekérdezések megbízhatóan észlelik a telefonszám típusát, azonban nem jelzik, hogy a célszám jelenleg csatlakoztatva van-e a hálózathoz és elérhető-e. Élő kapcsolati információk lekéréséhez kérjük, használja a POST /hlr-lookup végpontot.

Ha az Ön felhasználási esetéhez pontos hálózati és hordozhatósági információkra (MCCMNC) van szükség, de élő kapcsolati állapotra nem, kérjük, használja az POST /mnp-lookup végpontot mobilszám-hordozhatósági lekérdezésekhez.

Kérés Sikeres válasz Hibaválasz Típus referencia

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`number`	string	Telefonszám nemzetközi formátumban (pl. +4989702626 vagy 004989702626).	null	mandatory
`route`	string(3)	Opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre, vagy hagyja ki ezt a paramétert az egyéni útvonaltérkép alkalmazásához, vagy hagyja, hogy rendszerünk automatikusan meghatározza a kéréshez legmegfelelőbb útvonalakat.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`id`	string(12)	A lekérdezési kérelemhez rendelt egyedi azonosító.	false
`number`	string	A lekérdezés során vizsgált telefonszám.	false
`number_type`	string	Az észlelt számtípus. Lehetséges értékek: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Jelzi, hogy a számtípus információ sikeresen lekérdezésre került-e. `OK` értéket ad vissza sikeres lekérdezés esetén, vagy `FAILED` értéket, ha a lekérdezés sikertelen volt.	false
`is_valid`	boolean	Jelzi, hogy a telefonszám szintaktikailag érvényes-e.	true
`invalid_reason`	string	Egyszerű szöveges üzenet angol nyelven, amely megadja, miért tekinthető a telefonszám érvénytelennek (pl. "too short" vagy "invalid prefix"), vagy `null` érték, ha a szám érvényes.	true
`is_possibly_ported`	boolean	Jelzi, hogy a telefonszám átportolásra kerülhetett-e az eredeti szolgáltatótól egy másik szolgáltatóhoz. Pontos hordozhatósági információkért használjon MNP lekérdezéseket.	true
`is_vanity_number`	boolean	Jelzi, hogy a telefonszám vanityszám-e, azaz betűkaraktereket tartalmaz.	true
`qualifies_for_hlr_lookup`	boolean	Jelzi, hogy a telefonszám alkalmas-e további lekérdezésekre HLR lekérdezések segítségével.	true
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló karakterlánc, amely az MCCMNC párost (mobilország-kód és mobilhálózat-kód) reprezentálja, és azonosítja a mobilszám eredeti hálózatát.	true
`mcc`	string(3)	Három karakterből álló karakterlánc, amely az MCC-t (mobilország-kód) reprezentálja, és azonosítja a telefonszám eredeti mobilhálózatához tartozó országot.	true
`mnc`	string(2\|3)	Két vagy három karakterből álló karakterlánc, amely az MNC-t (mobilhálózat-kód) reprezentálja, és azonosítja a telefonszám eredeti mobilhálózati szolgáltatóját.	true
`original_network_name`	string	Tetszőleges angol nyelvű egyszerű szöveges karakterlánc, amely megadja a vizsgált mobilszám eredeti hálózati szolgáltatójának nevét.	true
`original_country_name`	string	Tetszőleges angol nyelvű egyszerű szöveges karakterlánc, amely megadja a vizsgált mobilszámhoz tartozó eredeti országot.	true
`original_country_code`	string(2)	Kétkarakteres ISO országkód, amely jelzi a vizsgált mobilszám eredeti országát.	true
`regions`	array	Ember által olvasható angol nyelvű karakterláncok listája, amely megadja a telefonszámhoz tartozó földrajzi régió(ka)t.	true
`timezones`	array	A telefonszámhoz tartozó időzónák (Olson formátumban) listája.	true
`info_text`	string	Tetszőleges karakterlánc, amely további információkat tartalmazhat a telefonszámról.	true
`cost`	string	Karakterláncként megadott decimális érték, amely jelzi a lekérdezés költségét (EUR-ban).	true
`timestamp`	string	W3C formátumú időbélyeg (időzónával együtt), amely jelzi, mikor fejeződött be a lekérdezés.	true
`storage`	string	Megadja a tároló nevét, ahová a lekérdezési eredmények hozzáfűzésre kerültek. Ez megfelel a CSV letöltésekhez és a webes felületen keresztüli elemzésekhez használt jelentés nevének.	true
`route`	string(3)	Három karakteres azonosító, amely megadja az ehhez a lekérdezési kérelemhez használt útvonalat.	true

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Típus	Leírás
LANDLINE	Vezetékes telefonszám.
MOBILE	Mobil telefonszám. Alkalmas HLR lekérdezésre a kapcsolat állapotával, hálózattal, hordozhatósággal és roaming információkkal kapcsolatos további adatok megszerzéséhez.
MOBILE_OR_LANDLINE	Vezetékes vagy mobil telefonszám. Esetlegesen alkalmas HLR lekérdezésre.
TOLL_FREE	Ingyenesen hívható telefonszám.
PREMIUM_RATE	Emelt díjas telefonszám további költségekkel.
SHARED_COST	Megosztott költségű telefonszám. Általában olcsóbb, mint az emelt díjas telefonszámok.
VOIP	Voice over IP telefonszám. Tartalmazza a TSoIP telefonszámokat is (Telephony Service over IP).
PAGER	Személyhívó telefonszám. Jellemzően nincs hangfunkció.
UAN	Univerzális hozzáférési szám (céges szám). Átirányítható különböző irodákhoz, de lehetővé teszi egyetlen szám használatát a vállalat számára.
VOICEMAIL	Hangposta telefonszám.
UNKNOWN	A számtípus nem határozható meg.

Görgetés felfelé

POST/nt-lookups védett

Ez a végpont aszinkron számtípus-lekérdezések sorozatát indítja el, amelyek eredményeit webhook segítségével küldjük vissza az Ön szerverére. Akkor megfelelő, ha elsődleges célja annak meghatározása, hogy az adott telefonszámok vezetékes, mobil, emelt díjas, VoIP, személyhívó vagy egyéb számozási tartományokhoz tartoznak-e. Nagy mennyiségű szám gyors feldolgozására optimalizálva ez a végpont ideális tömeges műveletek (pl. adatbázis-tisztítás) esetén. Élő forgalom és időkritikus felhasználási esetek esetén kérjük, használja helyette a POST /nt-lookup végpontot.

A végpont meghívásának előfeltételeként meg kell adnia egy webhook URL-t az API beállításokban.

Kérés Sikeres válasz Hibaválasz Webhookok Típus referencia

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

Adattartalom

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`numbers`	array	Nemzetközi formátumú telefonszámok tömbje (pl. +14156226819 vagy 004989702626). Kérésenként legfeljebb 1000 szám adható meg.	null	kötelező
`route`	string(3)	Opcionális háromkarakteres azonosító, amely meghatározza a lekérdezés útvonalát. Állítsa `null` értékre, vagy hagyja ki ezt a paramétert az egyéni útválasztási térkép alkalmazásához, vagy hagyja, hogy rendszerünk automatikusan határozza meg a kéréshez legmegfelelőbb útvonalat.	null	opcionális
`storage`	string	Opcionális tárolási azonosító, amely meghatározza azt a jelentést, ahol az eredmények tárolásra kerülnek manuális áttekintés, elemzés és jelentéskészítés céljából. A rendszer automatikusan hozzáfűzi az aktuális hónapot tartalmazó időbélyeget. Ha kihagyja vagy `null` értékre állítja, a rendszer automatikusan havonta csoportosítja az eredményeket jelentéskészítési célokra.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`accepted`	array	Objektumok tömbje, amelyek mindegyike egyedi azonosítót és feldolgozásra elfogadott telefonszámot tartalmaz.	false
`accepted_count`	integer	A feldolgozásra elfogadott telefonszámok összesített száma.	false
`rejected`	array	Objektumok tömbje, amelyek mindegyike egyedi azonosítót és feldolgozásra elutasított telefonszámot tartalmaz. Ezek a számok jellemzően érvénytelenek, és nem számítunk fel díjat értük.	false
`rejected_count`	integer	A feldolgozásra elutasított telefonszámok összesített száma.	false
`total_count`	integer	A feldolgozásra benyújtott elfogadott és elutasított telefonszámok összesített száma.	false
`cost`	string	Decimális értéket jelölő karakterlánc, amely a lekérdezések EUR-ban kifejezett költségét jelzi.	false
`storage`	string	A tároló (jelentés) neve, amelyhez a lekérdezési eredmények hozzá lettek fűzve. Ez a név CSV letöltésekhez és a webes felületen keresztüli elemzésekhez használatos.	false
`route`	string(3)	Háromkarakteres azonosító, amely meghatározza a lekérdezési kéréshez használt útvonalat.	false
`webhook_urls`	array	Az API beállításokban konfigurált webhook URL-ek. Az eredmények ide kerülnek visszaküldésre.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Webhookok feldolgozása

A beküldést követően platformunk megkezdi a megadott telefonszámok feldolgozását, és az eredményeket a korábban megadott webhook URL-re küldi a szerveren. Az eredmények HTTP POST kérésként kerülnek továbbításra, a kérés törzsében JSON objektummal.

Hitelesítés

A webhook hitelesítéséhez ellenőrizze a X-Signatures HTTP fejlécet.

A X-Signatures fejléc pontosvesszővel elválasztott aláírások listáját tartalmazza. A listában szereplő minden aláírás a fiókjában beállított API titkos kulcsok egyikével kerül generálásra. A webhook ellenőrzéséhez hozzon létre egy SHA-256 hash-t az API kulcsa, titkos kulcsa és a nyers HTTP törzs felhasználásával, majd hasonlítsa össze a listában szereplő aláírásokkal.

Az egyezés megerősíti, hogy a kérés hiteles és az Ön által kezelt titkos kulccsal van aláírva.

Kódpélda

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

A kérés érvényes, ha a fejlécben megadott aláírások bármelyike megegyezik az API kulcsból, titkos kulcsból és a HTTP törzsből összefűzött karakterlánc SHA256 hash-ével.

Átvétel visszaigazolása

A szerver várhatóan 200 OK HTTP státuszkóddal válaszol a sikeres átvétel megerősítéséhez. Ha bármilyen más válaszkód érkezik, időtúllépés történik (10 másodperc), vagy bármilyen más kézbesítési probléma merül fel, a rendszer automatikusan újrapróbálja a webhookot egy perc múlva. Ha a kérés továbbra is sikertelen, az újrapróbálkozások exponenciális visszalépési stratégiát követnek, a következő kísérletek 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 perc múlva történnek.

Ez az újrapróbálkozási mechanizmus maximális megbízhatóságot biztosít a lekérdezési eredmények infrastruktúrájába történő kézbesítésében. Minimalizálja az adatvesztés kockázatát az átmeneti hálózati problémák vagy szerver leállás miatt.

Webhook adattartalom

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

Webhook adatcsomag attribútumai

A JSON objektum tartalmaz egy type => NT attribútumot, valamint egy results attribútumot, amely lekérdezési objektumok listáját tartalmazza az alábbiak szerint dokumentálva.

Név	Típus	Leírás	Nullable
`id`	string(12)	A lekérdezési kérelemhez rendelt egyedi azonosító.	false
`number`	string	A lekérdezés során vizsgált telefonszám.	false
`number_type`	string	Az észlelt számtípus. Lehetséges értékek: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Jelzi, hogy a számtípus információ sikeresen lekérdezésre került-e. `OK` értéket ad vissza sikeres lekérdezés esetén, vagy `FAILED` értéket, ha a lekérdezés sikertelen volt.	false
`is_valid`	boolean	Jelzi, hogy a telefonszám szintaktikailag érvényes-e.	true
`invalid_reason`	string	Egyszerű szöveges üzenet angol nyelven, amely megadja, miért tekinthető a telefonszám érvénytelennek (pl. "too short" vagy "invalid prefix"), vagy `null` érték, ha a szám érvényes.	true
`is_possibly_ported`	boolean	Jelzi, hogy a telefonszám átportolásra kerülhetett-e az eredeti szolgáltatótól egy másik szolgáltatóhoz. Pontos hordozhatósági információkért használjon MNP lekérdezéseket.	true
`is_vanity_number`	boolean	Jelzi, hogy a telefonszám vanityszám-e, azaz betűkaraktereket tartalmaz.	true
`qualifies_for_hlr_lookup`	boolean	Jelzi, hogy a telefonszám alkalmas-e további lekérdezésekre HLR lekérdezések segítségével.	true
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló karakterlánc, amely az MCCMNC párost (mobilország-kód és mobilhálózat-kód) reprezentálja, és azonosítja a mobilszám eredeti hálózatát.	true
`mcc`	string(3)	Három karakterből álló karakterlánc, amely az MCC-t (mobilország-kód) reprezentálja, és azonosítja a telefonszám eredeti mobilhálózatához tartozó országot.	true
`mnc`	string(2\|3)	Két vagy három karakterből álló karakterlánc, amely az MNC-t (mobilhálózat-kód) reprezentálja, és azonosítja a telefonszám eredeti mobilhálózati szolgáltatóját.	true
`original_network_name`	string	Tetszőleges angol nyelvű egyszerű szöveges karakterlánc, amely megadja a vizsgált mobilszám eredeti hálózati szolgáltatójának nevét.	true
`original_country_name`	string	Tetszőleges angol nyelvű egyszerű szöveges karakterlánc, amely megadja a vizsgált mobilszámhoz tartozó eredeti országot.	true
`original_country_code`	string(2)	Kétkarakteres ISO országkód, amely jelzi a vizsgált mobilszám eredeti országát.	true
`regions`	array	Ember által olvasható angol nyelvű karakterláncok listája, amely megadja a telefonszámhoz tartozó földrajzi régió(ka)t.	true
`timezones`	array	A telefonszámhoz tartozó időzónák (Olson formátumban) listája.	true
`info_text`	string	Tetszőleges karakterlánc, amely további információkat tartalmazhat a telefonszámról.	true
`cost`	string	Karakterláncként megadott decimális érték, amely jelzi a lekérdezés költségét (EUR-ban).	true
`timestamp`	string	W3C formátumú időbélyeg (időzónával együtt), amely jelzi, mikor fejeződött be a lekérdezés.	true
`storage`	string	Megadja a tároló nevét, ahová a lekérdezési eredmények hozzáfűzésre kerültek. Ez megfelel a CSV letöltésekhez és a webes felületen keresztüli elemzésekhez használt jelentés nevének.	true
`route`	string(3)	Három karakteres azonosító, amely megadja az ehhez a lekérdezési kérelemhez használt útvonalat.	true

Típus	Leírás
LANDLINE	Vezetékes telefonszám.
MOBILE	Mobil telefonszám. Alkalmas HLR lekérdezésre a kapcsolat állapotával, hálózattal, hordozhatósággal és roaming információkkal kapcsolatos további adatok megszerzéséhez.
MOBILE_OR_LANDLINE	Vezetékes vagy mobil telefonszám. Esetlegesen alkalmas HLR lekérdezésre.
TOLL_FREE	Ingyenesen hívható telefonszám.
PREMIUM_RATE	Emelt díjas telefonszám további költségekkel.
SHARED_COST	Megosztott költségű telefonszám. Általában olcsóbb, mint az emelt díjas telefonszámok.
VOIP	Voice over IP telefonszám. Tartalmazza a TSoIP telefonszámokat is (Telephony Service over IP).
PAGER	Személyhívó telefonszám. Jellemzően nincs hangfunkció.
UAN	Univerzális hozzáférési szám (céges szám). Átirányítható különböző irodákhoz, de lehetővé teszi egyetlen szám használatát a vállalat számára.
VOICEMAIL	Hangposta telefonszám.
UNKNOWN	A számtípus nem határozható meg.

Görgetés felfelé

GET/routevédett

Lekéri azt az útvonalat, amely automatikusan kiválasztásra kerül, amikor HLR lekérdezést futtat a route paraméter megadása nélkül.

Az automatikus útvonal-kiválasztás a GET /hlr-coverage végponton lekérhető útválasztási térképen alapul, amely elsősorban a GET /routing-map adataiból származik. Testreszabhatja az útválasztási térképét és egyéni szabályokat definiálhat a fiókbeállításokban.

Kérés Sikeres válasz Hibaválasz

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdn`	string	Az MSISDN, amelyhez az automatikusan kiválasztott útválasztási információkat le kívánja kérni.	null	kötelező

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`route`	string	Az ajánlott útvonal.	false
`confidence_level`	string	Az útvonal kiválasztásának megbízhatósági szintje, azaz `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	A számozási terv alapú MCCMNC ehhez a számhoz.	false
`origin`	string	Az eredet, amelyen az útválasztási döntés alapul, azaz `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."
    ]
}

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/routesvédett

Ez a végpont visszaadja az elérhető HLR, MNP és NT útvonalak listáját. Minden útvonal, annak funkcióival és korlátozásaival együtt, az útvonal részletek oldalon található.

Kérés Sikeres válasz Hibaválasz

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

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`routes`	object	Egy objektum az útvonaltípusok szerint csoportosított útvonalakkal.	false
`HLR\|MNP\|NT`	string[]	Útvonalazonosítók listáját tartalmazza.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/routing-mapvédett

Lekéri a fiókjához jelenleg alkalmazott automatikus HLR Lookup útvonalválasztási konfigurációt. Ez az alapértelmezett konfiguráció akkor kerül alkalmazásra, amikor HLR lekérdezéseket küld be route paraméter megadása nélkül. Személyre szabhatja az útvonalválasztási térképet és egyéni szabályokat hozhat létre a fiókbeállításokban.

A konfigurációs hierarchia az országszintű szabályoktól az MCCMNC-szintű szabályokon keresztül végül az egyedi telefonszám-előtag leképezésekig terjed. A gyakorlatban ez azt jelenti, hogy az egyedi telefonszám-előtag leképezések elsőbbséget élveznek az ütköző MCCMNC-hozzárendelésekkel szemben, amelyek viszont felülírják az országszintű szabályokat. Kérjük, vegye figyelembe, hogy az MNP tartalék felülír minden ütköző egyéni szabályt, amíg engedélyezve van.

Kérés Sikeres válasz Hibaválasz

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`default_route`	string	Az alapértelmezett útvonal, amelyet akkor használ a rendszer, ha egy MSISDN-hez nem határozható meg preferált útvonalválasztási opció, és nem vonatkoznak rá egyéni útvonalválasztási szabályok.	false
`mnp_fallback`	boolean	Jelzi, hogy az MNP tartalék engedélyezve van-e. Ha engedélyezve van, és a HLR lekérdezéseket egy hálózat nem támogatja (kapcsolódási állapot nem elérhető), a rendszer ehelyett MNP lekérdezést hajt végre.	false
`mccmncs`	array	Az MCCMNC-kódok és az automatikusan kiválasztott útvonalaik leképezése. Egy adott MCCMNC-ben lévő szám HLR lekérdezésekor a megfelelő útvonal kerül felhasználásra.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló MCCMNC (mobilország-kód és mobilhálózat-kód kombinációja), amely azonosítja a mobilhálózat-üzemeltetőt.	false
`countrycode`	string(2)	Kétkarakteres ISO országkód, amely a hálózat országát azonosítja.	false
`route`	string(3)	A hálózathoz kiválasztott útvonal.	false
`mno`	string	A fogyasztók felé megjelenő márkanév, amely alatt ez a hálózat működik.	false
`confidence`	string	A kiválasztás megbízhatósági szintje. Lehetséges értékek: HIGH, NORMAL, LOW, MNP_REDIRECT. Utóbbi esetben a rendszer átirányítja a hálózat forgalmát MNP-re, ha ez a viselkedés engedélyezve van a fiókjában. Ellenkező esetben a fiók alapértelmezett útvonalát használja.	false
`origin`	string	A kiválasztás alapjául szolgáló forrás. Lehetséges értékek: `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	A fiókjában konfigurált egyéni előtag-alapú útvonalválasztási szabályok listája, ha vannak ilyenek.	false
`countrycode`	string(2)	Kétkarakteres ISO országkód, amely az előtag országát azonosítja.	false
`cns`	string	Az előtag, amelyre az útvonalválasztási szabály vonatkozik.	false
`route`	string(3)	Az előtaghoz kiválasztott útvonal.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló MCCMNC (mobilország-kód és mobilhálózat-kód kombinációja), amely azonosítja a mobilhálózat-üzemeltetőt.	true
`mno`	string	A fogyasztók felé megjelenő márkanév, amely alatt ez a hálózat működik.	true
`countries`	array	A fiókjában konfigurált egyéni ország-alapú szabályok listája, ha vannak ilyenek.	false
`countrycode`	string(2)	Kétkarakteres ISO országkód, amely az országot azonosítja.	false
`route`	string(3)	Az országhoz kiválasztott útvonal.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/hlr-coverage védett

HLR lefedettségi elemzéseket szolgáltat az adatvezérelt döntéshozatal támogatására. Ez a végpont segít valós idejű HLR útválasztási lehetőségek elemzésében a mobilhálózatokon keresztül, a célrégiók leghatékonyabb útvonalainak azonosításában és az automatikus útválasztás konfigurálásában.

A GET /route által javasolt útvonalak az itt lekért lefedettségi adatokon alapulnak. A lefedettségi adatok a hálózati lefedettség oldalon is elérhetők. Az útválasztási térképet tovább személyre szabhatja és szabályokat definiálhat a fiókbeállításokban.

Javasoljuk, hogy ismerkedjen meg ezzel az útmutatóval, amely segít az eredmények értelmezésében.

Kérés Sikeres válasz Hibaválasz Státusz referencia

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`countrycode`	string(2)	Kötelező kétbetűs ISO országkód az eredmények szűréséhez, amely csak a megadott országhoz tartozó rekordokat adja vissza.	null	kötelező
`sample_size`	string	Opcionális paraméter a mintaméret megadásához. Lehetséges értékek: `LARGE`, `MEDIUM`, `SMALL`. A nagyobb minták hosszabb időszakot fednek le, a kisebb minták egy nagyon közeli időszakot.	LARGE	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`name`	string	A kiválasztott ország neve angol nyelven, egyszerű szövegként.	false
`countrycode`	string(2)	A kiválasztott ország kétkarakteres ISO országkódja.	false
`prefix`	string	A kiválasztott ország nemzetközi hívási előtagja.	false
`mccs`	string[]	A kiválasztott országhoz tartozó MCC-k (mobil országkódok) listája.	false
`carriers`	object[]	Szolgáltatói objektumok listája útvonal-specifikus kapcsolódási metrikákkal.	false
`mno`	string	A mobilhálózat-üzemeltető neve angol nyelven, egyszerű szövegként.	false
`mccmnc`	string	A mobilhálózat-üzemeltető MCCMNC kódja.	false
`mcc`	string	A mobilhálózat-üzemeltető MCC kódja (mobil országkód).	false
`mnc`	string	A mobilhálózat-üzemeltető MNC kódja (mobil hálózati kód).	false
`routes`	object[]	Útvonal-specifikus kapcsolódási eredmények listája.	false
`route`	string	Az útvonal, amelyre a kapcsolódási információ vonatkozik.	false
`selected`	bool	Jelzi, hogy ez-e a kiválasztott útvonal az automatikus útválasztáshoz.	false
`selection_confidence`	string	Az útvonal kiválasztásának megbízhatósági szintje, azaz `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Null értéket tartalmaz, ha ez nem a kiválasztott útvonal.	true
`n`	int	A mintában szereplő lekérdezések teljes száma.	false
`CONNECTED`	int	A CONNECTED státuszt visszaadó HLR lekérdezések száma.	false
`CONNECTED_PCT`	float	A CONNECTED státuszt visszaadó HLR lekérdezések százalékos aránya.	false
`ABSENT`	int	Az ABSENT státuszt visszaadó HLR lekérdezések száma.	false
`ABSENT_PCT`	float	Az ABSENT státuszt visszaadó HLR lekérdezések százalékos aránya.	false
`INVALID_MSISDN`	int	Az INVALID_MSISDN státuszt visszaadó HLR lekérdezések száma.	false
`INVALID_MSISDN_PCT`	float	Az INVALID_MSISDN státuszt visszaadó HLR lekérdezések százalékos aránya.	false
`UNDETERMINED`	int	Az UNDETERMINED státuszt visszaadó HLR lekérdezések száma.	false
`UNDETERMINED_PCT`	float	Az UNDETERMINED státuszt visszaadó HLR lekérdezések százalékos aránya.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Állapot	Leírás
CONNECTED	A szám érvényes, és a célkészülék jelenleg csatlakozik a mobilhálózathoz. A hívások, SMS-ek és egyéb szolgáltatások sikeresen elérhetik a címzettet.
ABSENT	A szám érvényes, de a célkészülék ki van kapcsolva vagy átmenetileg nincs hálózati lefedettségben. Az üzenetek vagy hívások nem kerülnek kézbesítésre, amíg a készülék újra nem csatlakozik a hálózathoz.
INVALID_MSISDN	A szám érvénytelen vagy jelenleg nincs hozzárendelve egyetlen előfizetőhöz sem a mobilhálózaton. Az erre a számra irányuló hívások és üzenetek sikertelenek lesznek.
UNDETERMINED	A szám csatlakozási állapota nem határozható meg. Ennek oka lehet érvénytelen szám, SS7 hibaválasz vagy a célhálózat-üzemeltetővel való kapcsolat hiánya. További diagnosztikai információkért tekintse meg a hibakódot és annak leírását.

Görgetés felfelé

GET/mnp-coveragevédett

Ez a végpont visszaadja azon mobilhálózat-üzemeltetők listáját a hozzájuk tartozó MCCMNC azonosítókkal együtt, amelyek jelenleg támogatottak a hordozhatósági lekérdezésekhez.

Kérés Sikeres válasz Hibaválasz

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`countrycode`	string(2)	Opcionális kétbetűs ISO országkód az MCCMNC eredmények szűréséhez, amely csak a megadott országra vonatkozó adatokat adja vissza.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`items[]`	array	A mobilhálózat-üzemeltetők listája.	false
`country_name`	string	Az ország angol nyelvű neve.	false
`country_code`	string(2)	Kétbetűs ISO országkód.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló MCCMNC (mobilország-kód és mobilhálózat-kód kombinációja), amely azonosítja a mobilhálózat-üzemeltetőt.	false
`mcc`	string(3)	Három karakterből álló MCC (mobilország-kód), amely a hálózat országát jelöli.	false
`mnc`	string(2\|3)	Két vagy három karakterből álló MNC (mobilhálózat-kód), amely az adott mobilhálózat-üzemeltetőt jelöli.	false
`brand`	string	A fogyasztók felé megjelenő márkanév, amely alatt ez a hálózat működik.	true
`operator`	string	A mobilhálózat-üzemeltető jogi neve.	true

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/price-listvédett

Ez a végpont azon országok listáját adja vissza, ahol csak MNP lekérdezések támogatottak, és HLR lekérdezések nem érhetők el ezekre a célállomásokra.

Kérés Sikeres válasz Hibaválasz

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

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`countries`	string[]	Kétkarakteres ISO országkódok listája.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/mccmncsvédett

Ez a végpont a mobilhálózat-üzemeltetők átfogó listáját adja vissza a hozzájuk tartozó MCCMNC azonosítókkal és további kontextuális információkkal együtt.

Kérés Sikeres válasz Hibaválasz

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`countrycode`	string(2)	Opcionális kétbetűs ISO országkód az MCCMNC eredmények szűréséhez, amely csak a megadott országhoz tartozó rekordokat adja vissza.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`items`	object[]	A mobilhálózat-üzemeltetők listája.	false
`country_name`	string	Az ország teljes neve angolul.	false
`country_code`	string(2)	Kétbetűs ISO országkód, amely a mobilszolgáltató országát jelöli.	false
`mccmnc`	string(5\|6)	Öt vagy hat karakterből álló karakterlánc, amely az MCCMNC-t jelöli és egyedileg azonosítja a mobilhálózat-üzemeltetőt.	false
`mcc`	string(3)	Háromkarakteres Mobile Country Code (MCC), amely azonosítja azt az országot, ahol a mobilhálózat működik.	false
`mnc`	string(2\|3)	Két vagy három karakterből álló Mobile Network Code (MNC), amely meghatározza a mobilhálózatot az adott MCC-n belül.	false
`brand`	string	A kereskedelmi márkanév, amely alatt a hálózat működik és amelyen a fogyasztók ismerik.	true
`operator`	string	A mobilhálózat-üzemeltető hivatalos neve, jellemzően a hálózatot kezelő jogi személy.	true
`parent_mccmnc`	string(5\|6)	Öt vagy hat karakterből álló karakterlánc, amely a szülő mobilhálózat-üzemeltető MCCMNC-jét jelöli, ha van ilyen.	true

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/pricevédett

Ez a végpont visszaadja az HLR, MNP vagy NT lekérdezés árát.

Kérés Sikeres válasz Hibaválasz

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

Kérés paraméterei

Kulcs	Típus	Leírás	Alapértelmezett	Kötelező
`msisdn`	string	A telefonszám, amelyhez az árat le kell kérdezni. Nemzetközi formátumban.	null	kötelező
`route_type`	string	Az útvonal típusa, azaz `HLR`, `MNP`, `NT`.	null	kötelező
`route`	string(3)	Az útvonal, amelyhez az árat számítani kell. Alapértelmezés szerint az automatikus útválasztás által meghatározott útvonal.	null	opcionális

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`price`	object	Egy objektum az árazási részletekkel.	false
`amount`	string	Az összeg euróban.	false
`msisdn`	string	Az MSISDN, amelyre ez az ár vonatkozik.	false
`route_type`	string(2\|3)	Az útvonal típusa, amelyre ez az ár vonatkozik.	false
`route`	string(3)	Az útvonal, amelyre ez az ár vonatkozik.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/price-listvédett

Ez a végpont a fiókjában érvényes díjszabást adja vissza.

Kérés Sikeres válasz Hibaválasz

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

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`pricing`	object[]	Díjszabási információkat tartalmazó objektumok listája.	false
`route`	string	Az útvonal, amelyre ez a díjszabás vonatkozik.	false
`countrycode`	string	A kétkarakteres ISO országkód, amelyre ez a díjszabás vonatkozik a megfelelő útvonalnál, ha van ilyen.	true
`countryname`	string	Az országkódhoz tartozó angol országnév, ha van ilyen.	true
`mccmnc`	string	Az MCCMNC, amelyre ez a díjszabás vonatkozik a megfelelő útvonalnál, ha van ilyen. Felülírja az országszintű díjszabást.	true
`cns`	string	A hívásirányító előtag, amelyre ez a díjszabás vonatkozik a megfelelő útvonalnál, ha van ilyen. Felülírja az országszintű és az MCCMNC-szintű díjszabást.	true
`route_type`	string	A megfelelő útvonal típusa, azaz `HLR`, `MNP`, `NT`.	false
`route_type`	string	A megfelelő ár euróban.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/balancevédett

Ez a végpont lekéri az aktuális egyenlegét, lehetővé téve a folyamatok automatizálását a kreditstátusz alapján. Zökkenőmentesen működik az alacsony kreditegyenleg értesítő e-mailekkel, amelyeket a fizetések oldalon konfigurálhat.

Kérés Sikeres válasz Hibaválasz

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

{
    "balance":"1002.90"
}

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`balance`	string	Az aktuális számlaegyenlege euróban. Tizedes érték string típusként.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/pingnyilvános

Ez a végpont ping kérést küld az API-nak, egyszerű módszert biztosítva a HLR Lookups API-hoz való kapcsolat tesztelésére.

Kérés Sikeres válasz Hibaválasz

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

{
    "success":true
}

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`success`	boolean	Jelzi, hogy a kérés sikeresen feldolgozásra került.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/timenyilvános

Ez az endpoint egy Unix időbélyeget ad vissza, amely a HLR Lookups szerver aktuális idejét jelöli. Használja a szervere órájának szinkronizálásához a Digest-Auth aláírás hitelesítéshez történő generálásakor, így biztosítva, hogy a szervere és a HLR Lookups szerver ideje közötti eltérések kijavításra kerüljenek.

Kérés Sikeres válasz Hibaválasz

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

{
    "time":1525898643
}

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`time`	integer	Unix időbélyeg, amely a HLR Lookups szerver aktuális idejét jelöli.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

GET/auth-testvédett

Ez a végpont a Basic-Auth vagy előnyösebben a Digest-Auth implementációjának kezdeti tesztelésére szolgál.

Egyszerű hitelesítési kérés Digest Auth kérés Sikeres válasz Hibaválasz

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

Kérés fejlécek

Kulcs	Típus	Leírás
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` SHA256 hash-e. A kettőspont szimbólumot (:) is vegye figyelembe a hash-ben.

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"

Kérés fejlécek

Kulcs	Típus	Leírás
`X-Digest-Key`	string	Az Ön HLR Lookups API kulcsa
`X-Digest-Signature`	string	Egyedi Digest-Auth aláírás (lásd hitelesítés)
`X-Digest-Timestamp`	integer	Aktuális Unix időbélyeg (lásd még `GET /time`)

{
    "success":true
}

Sikeres válasz attribútumai

Név	Típus	Leírás	Nullable
`success`	boolean	Jelzi, hogy a kérés sikeresen feldolgozásra került.	false

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

Hibaválasz paraméterek

Név	Típus	Leírás	Nullable
`errors[]`	string[]	A hibát magyarázó szöveges lista.	false

Görgetés felfelé

Régi API dokumentáció

Felhívjuk figyelmét, hogy a régi API elavult és a jövőben megszüntetésre kerül. Határozottan javasoljuk, hogy mielőbb frissítsen a legújabb verzióra.

Ha 2013 és 2020 eleje között implementálta HLR Lookups API-nkat, akkor a régi API-t használja. Ebben az esetben kérjük, tekintse meg a régi API dokumentációnkat.

Régi API dokumentáció

API Dokumentáció

Kezdő lépések

HLR lekérdezések

MNP lekérdezések

NT lekérdezések

Útválasztás

Árazás

Eszközök

Kezdő lépések

Az HLR Lookups API használata

Példa kérés

Példa adatcsomag

Sikeres válasz application/json

További lekérdezési szolgáltatások

Mobilszám-hordozhatósági (MNP) lekérdezések

Számtípus-észlelési (NT) lekérdezések

Szoftverfejlesztői készletek (SDK-k)

Eszközök

Nem fejlesztő?

Hitelesítés

API kulcs és API titok

HTTP egyszerű hitelesítés

Ajánlott: X-Basic fejléc SHA256-tal

Egyszerű hitelesítési kérés

Egyszerű hitelesítési fejlécek

Kódpélda

Kérés példa

Kérés fejlécek

Az aláírás létrehozása

Digest aláírás komponensei

Kódpéldák

Alapfogalmak

Szinkron HLR lekérdezési API

Aszinkron HLR Lookup API

SDK-k (szoftverfejlesztői készletek)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupvédett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek

POST/hlr-lookupsvédett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek

Webhookok feldolgozása

Hitelesítés

Kódpélda

Átvétel visszaigazolása

Webhook adattartalom

Webhook adatcsomag attribútumai

POST/mnp-lookupvédett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek

POST/mnp-lookupsvédett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek

Webhookok feldolgozása

Hitelesítés

Kódpélda

Átvétel visszaigazolása

Webhook adattartalom

Webhook adatcsomag attribútumai

POST/nt-lookupvédett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek

POST/nt-lookups védett

Adattartalom

Kérés paraméterei

Sikeres válasz attribútumai

Hibaválasz paraméterek