Alustamine

Globaalne mobiilsidevõrgu infrastruktuur töötab süsteemil, mida tuntakse SS7 signalisatsioonivõrguna. See võrk võimaldab operaatorite vahel vahetada abonentide andmeid, kõnede marsruutimist, SMS-sõnumite edastamist ja mobiilsideühenduse reaalajas olekuvärskendusi. Iga mobiilsidevõrk haldab koduasukoha registrit (HLR) - keskset andmebaasi, mis salvestab olulised andmed oma abonentide kohta.

HLR Lookup tehnoloogia võimaldab ettevõtetel neid registreid päringute abil pärida ja saada reaalajas ühenduvuse ning võrguandmeid mis tahes mobiilinumbri kohta. See hõlmab teavet selle kohta, kas telefon on sisse lülitatud, millisele võrgule see hetkel kuulub, kas number on üle kantud, kas number on kehtiv või deaktiveeritud ning kas see on rändluses.

HLR Lookups API pakub sujuvat reaalajas juurdepääsu nendele andmetele, võimaldades ettevõtetel kontrollida mobiilinumbreid, optimeerida marsruutimist ja täiustada kliendikommunikatsiooni. See dokumentatsioon juhendab teid HLR Lookups teenuse integreerimisel oma tarkvaraga, võimaldades automaatset reaalajas mobiilsidevõrgu andmete hankimist.

HLR Lookups API kasutamine

HLR Lookup päringute teostamine on kiire, turvaline ja lihtne. Kui olete registreerunud ja saanud oma API võtme, saate autentida ja alustada koheseid päringuid lihtsate HTTP POST päringutega, kasutades POST /hlr-lookup. Teise võimalusena saate töödelda suuri andmekogumeid, valides kiired asünkroonsed API päringud, mille tulemused saadetakse teie serverisse tagasi webhook kaudu, nagu selgitatud kontseptsioonide jaotises.

Näidispäring

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"

Autentimine toimub HTTP päiste kaudu ja payload.json peaks (vähemalt) sisaldama järgmist JSON objekti:

Näidisandmed

{
   "msisdn": "+14156226819"
}

Eduka täitmise korral saate vastuse, mis sisaldab määratud mobiilinumbri reaalajas ühenduvuse andmeid.

Edukas vastus 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"
}

Päringu ja vastuse atribuutide ning ühenduvuse olekute täieliku ülevaate saamiseks vaadake POST /hlr-lookup.

Täiendavad päringteenused

Numbri ülekantavuse (MNP) päringud

Kasutage MNP päringuid võrgu omandiõiguse ja ülekantavuse andmete määramiseks ilma reaalajas ühenduvust pärides. Kui vajate ainult numbri MCCMNC koodi, vaadake POST /mnp-lookup.

Numbri tüübi tuvastamise (NT) päringud

Määrake, kas telefoninumber kuulub lauatelefonile, mobiilile, lisatasulisel numbril, VoIP-ile, peilerile või muudele numbriplaani vahemikele kasutades POST /nt-lookup.

Tarkvaraarenduse komplektid (SDK-d)

HLR Lookups API töötab mis tahes REST kliendiga igas programmeerimiskeeles ja oleme avaldanud SDK-d PHP, Ruby ja NodeJS jaoks meie GitHub lehel, et aidata teil kiiresti alustada.

Tööriistad

Sujuva arenduskogemuse tagamiseks pakume põhjalikku tööriistade komplekti, sealhulgas brauseripõhist API päringute ja webhook jälgimist, IP-aadresside valgete nimekirjade haldust, tugevaid autentimise võimalusi ja autentimise testlõpp-punkti.

Pole arendaja?

HLR Lookups ja numbri ülekantavuse päringuid saab teostada ilma programmeerimiseta. Lugege lähemalt meie ettevõtte veebikliendist ja brauseripõhistest aruandlusfunktsioonidest.

Autentimine

Turvalisuse ja nõuetekohase juurdepääsukontrolli tagamiseks nõuavad enamik HLR Lookups API päringuid autentimist. Lõpp-punktid on liigitatud avalikeks või kaitstavateks. Kaitstud lõpp-punktile juurdepääsul peab teie päring olema autenditud, kasutades API võtit ja saladust kas Digest-Auth või Basic-Auth meetodiga. Digest-Auth on turvalisem valik ja on tungivalt soovitatav. Kasutage GET /auth-test lõpp-punkti oma autentimise seadistuse kontrollimiseks.

API võti ja API saladus

Hankige oma API võti ja saladus API seadete lehelt. Samuti saate seadistada oma eelistatud autentimismeetodit ja lubada IP-aadresside valgete nimekirjade kasutamise täiendava turvalisuse tagamiseks. Kui kahtlustate, et teie API saladus on ohustatud, saate igal ajal genereerida uue.

Basic Auth Digest Auth IP Lubade Nimekiri

Standardne Basic Authentication on lihtne rakendada ja laialdaselt toetatud. Saate autentida, edastades oma API võtme ja saladuse user:pass paarina HTTP päringus.

HTTP Basic Auth

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

See saadab Authorization päise:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Soovitatav: X-Basic päis koos SHA256-ga

Parema turvalisuse tagamiseks saate saata oma mandaatide SHA256 räsi, selle asemel et edastada neid otse base64 kujul. Selle meetodi kasutamiseks arvutage oma YOUR_API_KEY:YOUR_API_SECRET paari räsi ja saatke see X-Basic päise kaudu:

Basic Auth päring

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

Basic Authentication päised

Võti	Tüüp	Kirjeldus
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` SHA256 räsi. Kaasake räsisse kooloni sümbol (:).	kohustuslik

Koodinäide

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

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

Digest-Auth on soovitatav meetod kaitstud HLR Lookup API lõpp-punktidele juurdepääsu turvamiseks. Iga päring peab sisaldama järgmisi päiseid: X-Digest-Key, X-Digest-Signature ja X-Digest-Timestamp, mida selgitatakse allpool.

Päringu näide

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"

Päringu päised

Võti	Tüüp	Kirjeldus
`X-Digest-Key`	string	Teie unikaalne HLR Lookups API võti.	kohustuslik
`X-Digest-Signature`	string	Unikaalne autentimise allkiri (vt allpool).	kohustuslik
`X-Digest-Timestamp`	integer	Praegune Unix ajatempel (vt ka `GET /time`).	kohustuslik

Allkirja koostamine

X-Digest-Signature luuakse SHA256 HMAC räsi abil, kasutades jagatud võtmena teie API saladust.

Räsitav string on struktureeritud järgmiselt:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. sümbol tähistab stringide ühendamist.

Digest allkirja komponendid

Komponent	Tüüp	Kirjeldus
`ENDPOINT_PATH`	string	Soovitud API lõpp-punkt, nt `/auth-test` väiketähtedega.
`UNIX_TIMESTAMP`	integer	Praegune Unix ajatempel (peab olema 30 sekundi piires). Vt `GET /time`.
`REQUEST_METHOD`	string	Kasutatav HTTP meetod, nt `POST` või `GET`.
`REQUEST_BODY`	string	Päringu keha andmed. Määrake `null` `GET` päringute puhul.

Koodinäited

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)

Keri üles

Mõisted

HLR päringute rakendamine mis tahes programmeerimiskeeles või süsteemis meie HTTP REST API kaudu on lihtne ja tõhus. Lihtsa integreerimisprotsessiga saate alustada mobiilsidevõrkude reaalajas päringuid, et saada koheseid andmeid telefoninumbrite kehtivuse, ühenduvuse oleku ja marsruutimise kohta.

Sobiva API valimine sõltub teie konkreetsest kasutusjuhust. Kui vajate reaalajas päringute tulemusi rakendustes nagu VoIP telefonia, pettuste tuvastamine või SMS marsruutimine, on parim valik sünkroonne API. Kui teie kasutusjuhtum hõlmab aga suure mahuga töötlemist, masspäringuid või ulatuslikku andmete kontrollimist, pakub asünkroonne API optimeeritud jõudlust koos ribalaiuse tõhususe ja pakktöötluse võimalustega.

Konfigureerige API kasutama ühte meie kohandatud marsruutimise valikutest, et optimeerida kiirust, täpsust ja kulusäästlikkust. Samuti saate salvestada päringute tulemused salvestusruumidesse, et hõlpsasti alla laadida CSV ja JSON aruandeid ning kasutada täpsemaid analüütikaandmeid veebiliidese kaudu.

Sünkroonne HLR päringu API

POST /hlr-lookup lõpp-punkt töötleb ühe mobiiltelefoni numbri (MSISDN) päringu kohta ja tagastab tulemused koheselt HTTP vastuse kehas. Tulemused on vormindatud JSON-ina ja sobivad ideaalselt reaalaja rakendustele, sealhulgas mobiilinumbrite valideerimiseks, kõnede marsruutimiseks ja SMS sõnumite edastamiseks.

Sünkroonne API päring koosneb otsesest HTTP päringust ja vastusest. Teie süsteem esitab ühe MSISDN-i (mobiilinumbri) päringu kohta ja saab kohese vastuse, mis sisaldab reaalajas HLR päringu tulemusi JSON formaadis. See API on optimeeritud kasutusjuhtudeks, mis nõuavad kohest kontrollimist ja ühenduvuse kontrolli, nagu pettuste tuvastamine, VoIP kõnede marsruutimine ja SMS lüüsi optimeerimine.

Asünkroonne HLR päringute API

POST /hlr-lookups lõpp-punkt on loodud massi ja suure mahuga töötlemiseks, võimaldades esitada kuni 1,000 MSISDN-i päringu kohta. Tulemuste kohese tagastamise asemel kasutab see API automaatseid webhookе, et saata tulemused järk-järgult teie serverisse. Päringute tulemused tagastatakse JSON objektidena HTTP POST tagasiside kaudu.

Asünkroonne API on optimeeritud kiiruse, tõhususe ja skaleeritavuse jaoks. See kõrvaldab sünkroonsete päringutega seotud võrgu latentsuse probleemid, muutes selle ideaalseks ettevõtetele, kes vajavad suure läbilaskevõimega päringuid. Teie süsteem esitab kuni 1,000 MSISDN-i päringu kohta ja meie platvorm töötleb neid paralleelselt, edastades tulemused tagasi teie serverisse HTTP webhookide kaudu partiidena kuni 1,000 tulemust tagasiside kohta.

SDK-d (tarkvaraarenduse komplektid)

Meie tarkvaraarenduse komplektid (SDK-d) PHP, NodeJS ja Ruby jaoks muudavad integreerimisprotsessi sujuvamaks, võimaldades teil ühenduda HLR Lookups API-ga tõhusalt ja minimaalse vaevaga.

Need SDK-d pakuvad valmisfunktsioone, autentimise haldust ja struktureeritud API päringute malle, vähendades arendusaega ning tagades parimad tavad.

Tutvuge meie kõigi saadaolevate SDK-dega GitHubis ja alustage integreerimist juba täna.

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

Vaata GitHubis 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   }

Vaata GitHubis 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)

Vaata GitHubis README.md

Keri üles

POST/hlr-lookupkaitstud

Teostab sünkroonse HLR päringu, edastades reaalajas mobiiltelefoni ühenduvuse ja teisaldatavuse andmed otse võrguoperaatoritelt. See lõpp-punkt sobib ideaalselt reaalajas liikluse stsenaariumidele, kus ajakriitilised rakendused vajavad kohest kinnitust, kas telefoninumber on hetkel kättesaadav (ühendatud) või kättesaamatu (välja lülitatud). Lisaks aitab see eristada aktiivseid numbreid kehtetutest, tundmatutest või võltsitud numbritest.

Suurte andmekogumite pakktöötlemiseks, mis ei vaja koheseid tulemusi, kaaluge asünkroonse POST /hlr-lookups kasutamist, mis on optimeeritud kiireks pakktöötluseks.

Kui teie peamine eesmärk on mobiilnumbri teisaldatavuse andmete (MCCMNC) hankimine ja te ei vaja reaalajas ühenduvuse staatust, pakub POST /mnp-lookup kulutõhusat alternatiivi mobiilnumbri teisaldatavuse päringuteks.

Päring Edukas vastus Veavastus Olekute viide

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdn`	string	Päritav mobiiltelefoni number (MSISDN), esitatud rahvusvahelises formaadis (nt +14156226819 või 0014156226819). Riigikoodid peavad olema lisatud.	null	kohustuslik
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Määrake väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisvaadet või lasta meie süsteemil automaatselt määrata parim marsruut selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Sellele päringule määratud unikaalne identifikaator.	false
`msisdn`	string	Päritav mobiilinumber rahvusvahelises formaadis (nt +14156226819 või 0014156226819).	false
`connectivity_status`	string	Näitab, kas numbri ühenduvuse olek edukalt tuvastati. Võimalikud väärtused: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` või `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Viie- või kuuekohaline Mobile Country Code (MCC) ja Mobile Network Code (MNC), mis identifitseerib mobiilinumbriga praegu seotud võrku.	true
`mcc`	string(3)	Kolmekohaline Mobile Country Code (MCC), mis identifitseerib riiki, kus mobiilinumber on registreeritud.	true
`mnc`	string(2\|3)	Kahe- või kolmekohaline Mobile Network Code (MNC), mis identifitseerib konkreetse võrgu, millesse mobiilinumber kuulub.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), selle numbriga seotud SIM-kaardi unikaalne identifikaator. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) mobiilioperaatori andmebaasis. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`msc`	string(12)	Mobile Switching Center (MSC), mis praegu haldab selle abonendi side. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`original_network_name`	string	Selle numbriga seotud algne (kodumaine) võrguoperaatori nimi.	true
`original_country_name`	string	Riigi täisnimi, kus mobiilinumber algselt registreeriti, inglise keeles.	true
`original_country_code`	string(2)	Kahetäheline ISO riigikood, mis esindab riiki, kus mobiilinumber esmakordselt määrati.	true
`original_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood), mis vastab mobiilinumbri algsele riigile.	true
`is_ported`	boolean	Näitab, kas mobiilinumber on üle kantud algsest võrgust teisele operaatorile.	true
`ported_network_name`	string	Võrguoperaatori nimi, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_name`	string	Riigi nimi, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_code`	string(2)	Kahetäheline ISO riigikood, mis esindab riiki, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood) riigile, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`is_roaming`	boolean	Näitab, kas mobiilinumber on praegu rändluses välismaal. Rändluse oleku kättesaadavus sõltub mobiilsidevõrgu operaatorist.	true
`roaming_network_name`	string	Võrgu nimi, milles mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_name`	string	Riigi nimi, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_code`	string(2)	Kahetäheline ISO riigikood riigile, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood) riigile, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`cost`	string	Kümnendväärtus stringina, mis näitab päringu hinda eurodes.	true
`timestamp`	string	W3C-formaadis ajatempel koos ajavööndiga, mis määrab päringu lõpetamise aja.	true
`storage`	string	Salvestuskoha nimi, kuhu päringu tulemused salvestati. See vastab veebiliidese kaudu kättesaadavatele aruannete nimedele ja CSV-allalaadimistele.	true
`route`	string(3)	Kolmetäheline identifikaator, mis näitab selle päringu jaoks kasutatud marsruutimismeetodit.	true
`processing_status`	string	Päringu töötlemise tulemus. Võimalikud väärtused: `COMPLETED` (edukas), `REJECTED` (võrk kättesaamatu, tasu ei rakendata) või `FAILED` (töötlemisel tekkis viga).	false
`error_code`	integer	Valikuline sisemine veakood, mis pakub lisadiagnostilist teavet klienditoe jaoks.	true
`error_description`	string	Antud veakoodi lühike selgitus (kui see on olemas) inglise keeles lihttekstina.	true
`data_source`	string	Selle päringu jaoks kasutatud andmeallikas. Võimalikud väärtused: `LIVE_HLR` (reaalajas HLR-päring) või `MNP_DB` (staatiline numbri ülekande andmebaas). Täpsema teabe saamiseks vaadake marsruutimisvalikuid.	false
`routing_instruction`	string	Kooloniga eraldatud string, mis kirjeldab päringus kasutatud marsruutimisjuhendit. Esimene komponent on `STATIC`, kui määrasite marsruudi, või `AUTO` automaatse marsruutimise korral; teine komponent on marsruudi identifikaator ja automaatse marsruutimise päringute puhul näitab kolmas komponent allikat, millel marsruutimise otsus põhineb (st `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."
    ]
}

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Staatus	Kirjeldus
CONNECTED	Number on kehtiv ja sihtseade on praegu mobiilsidevõrguga ühendatud. Kõned, SMS-id ja muud teenused peaksid adressaadini edukalt jõudma.
ABSENT	Number on kehtiv, kuid sihtseade on kas välja lülitatud või ajutiselt võrgulevialast väljas. Sõnumid või kõned ei pruugi kohale jõuda enne, kui seade võrguga uuesti ühendub.
INVALID_MSISDN	Number on kehtetu või pole praegu mobiilsidevõrgus ühelegi tellijale määratud. Kõned ja sõnumid sellele numbrile ebaõnnestuvad.
UNDETERMINED	Numbri ühendusseisundit ei õnnestunud tuvastada. Põhjuseks võib olla kehtetu number, SS7 veateade või ühenduse puudumine sihtoperaatori võrguga. Täiendavaks diagnostikaks vaadake veakoodi ja selle kirjelduse välja.

Keri üles

POST/hlr-lookupskaitstud

Käivitab asünkroonsete HLR päringute partii, hankides võrguoperaatoritelt reaalajas mobiiltelefoni ühenduvuse ja teisaldatavuse andmeid. Tulemused edastatakse teie serverile webhookide kaudu. See meetod on optimeeritud suurte numbrimahtude töötlemiseks, mis ei vaja koheseid vastuseid, nagu andmebaaside puhastamine ja verifitseerimine. Reaalajas rakenduste jaoks, nagu kõnede marsruutimine või SMS-i edastamine, kaaluge selle asemel POST /hlr-lookup lõpp-punkti kasutamist.

See lõpp-punkt sobib ideaalselt hulgi töötlemiseks, kui eesmärk on tuvastada praegu kättesaadavad (ühendatud) või kättesaamatud (telefon välja lülitatud) telefoninumbrid, filtreerides välja kehtetud, määramata või võltsitud numbrid. Lisaks pakub see reaalajas teisaldatavuse staatust (MCCMNC) koos ühenduvuse üksikasjadega.

Enne selle lõpp-punkti kasutamist veenduge, et webhook URL oleks konfigureeritud päringute tulemuste asünkroonseks vastuvõtmiseks. Saate seda seadistada oma API sätetes.

Päring Edukas vastus Veavastus Webhooks Olekute viide

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdns`	array	Mobiiltelefoni numbrite (MSISDN-id) massiiv rahvusvahelises formaadis (nt +14156226819 või 0014156226819). Päringu kohta saate lisada kuni 1000 numbrit.	null	kohustuslik
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Määrake väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisvaadet või lasta meie süsteemil automaatselt määrata parim marsruut selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`accepted`	array	Objektide loend, mis sisaldab unikaalseid identifikaatoreid ja MSISDN-e, mis on töötlemiseks vastu võetud.	false
`accepted_count`	integer	MSISDN-ide koguarv, mis on edukalt töötlemiseks vastu võetud.	false
`rejected`	array	Objektide loend, mis sisaldab unikaalseid identifikaatoreid ja MSISDN-e, mis on töötlemiseks tagasi lükatud, tavaliselt kehtetute numbrite tõttu. Tagasi lükatud kirjete eest tasu ei võeta.	false
`rejected_count`	integer	MSISDN-ide koguarv, mis on valideerimisveate tõttu tagasi lükatud.	false
`total_count`	integer	Vastu võetud ja tagasi lükatud MSISDN-ide koguarv, mis esitati töötlemiseks.	false
`cost`	string	Stringina esitatud kümnendväärtus, mis näitab vastu võetud päringute kogumaksumust eurodes.	false
`storage`	string	Salvestuskoha nimi, kuhu päringute tulemused lisatakse, kasutatakse aruandluse ja CSV allalaadimiste jaoks veebiliideses.	false
`route`	string(3\|4)	Kolme- või neljakohaline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti. Sisaldab AUTO, kui taotleti numbripõhist automaatset marsruutimist.	false
`webhook_urls`	array	Teie API sätetes konfigureeritud webhook URL-id. Tulemused saadetakse siia tagasi.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Webhookide töötlemine

Pärast esitamist alustab meie platvorm esitatud telefoninumbrite töötlemist ja saadab tulemused teie serveris eelnevalt määratud webhook URL-ile. Tulemused edastatakse HTTP POST päringuna, mille kehas on JSON objekt.

Autentimine

Autentimiseks kontrollige X-Signatures HTTP päist.

X-Signatures päis sisaldab semikooloniga eraldatud allkirjade loendit. Iga loendis olev allkiri genereeritakse kasutades ühte teie kontol seadistatud API saladustest. Webhooki kontrollimiseks genereerige SHA-256 räsi kasutades oma API võtit, saladust ja HTTP keha - seejärel võrrelge seda loendis olevate allkirjadega.

Vaste kinnitab, et päring on autentne ja allkirjastatud teie kontrolli all oleva saladusega.

Koodinäide

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

Päring on kehtiv, kui mõni päises antud allkirjadest võrdub SHA256 räsiga, mis on arvutatud teie API võtme, saladuse ja HTTP keha ühendatud stringist.

Kättesaamise kinnitamine

Teie server peab vastama HTTP olekukoodiga 200 OK, et kinnitada edukat kättesaamist. Kui tagastatakse mõni muu vastusekood, tekib ajalõpp (10 sekundit) või esineb mõni muu tarneprobleem, proovib süsteem webhookki automaatselt ühe minuti pärast uuesti. Kui päring jätkuvalt ebaõnnestub, järgivad korduskatsed eksponentsiaalset taganemisstrateegiat, järgnevate katsetega 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuti pärast.

See korduskatsete mehhanism tagab maksimaalse usaldusväärsuse päringtulemuste edastamisel teie infrastruktuurile. See vähendab andmekao riski ajutiste võrguprobleemide või serveri seisakute tõttu.

Webhooki andmemaht

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

Webhooki andmete atribuudid

JSON objekt sisaldab atribuuti type => HLR koos atribuudiga results, mis hõlmab päringute objektide loendit, nagu allpool dokumenteeritud.

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Sellele päringule määratud unikaalne identifikaator.	false
`msisdn`	string	Päritav mobiilinumber rahvusvahelises formaadis (nt +14156226819 või 0014156226819).	false
`connectivity_status`	string	Näitab, kas numbri ühenduvuse olek edukalt tuvastati. Võimalikud väärtused: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` või `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Viie- või kuuekohaline Mobile Country Code (MCC) ja Mobile Network Code (MNC), mis identifitseerib mobiilinumbriga praegu seotud võrku.	true
`mcc`	string(3)	Kolmekohaline Mobile Country Code (MCC), mis identifitseerib riiki, kus mobiilinumber on registreeritud.	true
`mnc`	string(2\|3)	Kahe- või kolmekohaline Mobile Network Code (MNC), mis identifitseerib konkreetse võrgu, millesse mobiilinumber kuulub.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), selle numbriga seotud SIM-kaardi unikaalne identifikaator. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) mobiilioperaatori andmebaasis. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`msc`	string(12)	Mobile Switching Center (MSC), mis praegu haldab selle abonendi side. Kättesaadavus sõltub võrgu konfiguratsioonist.	true
`original_network_name`	string	Selle numbriga seotud algne (kodumaine) võrguoperaatori nimi.	true
`original_country_name`	string	Riigi täisnimi, kus mobiilinumber algselt registreeriti, inglise keeles.	true
`original_country_code`	string(2)	Kahetäheline ISO riigikood, mis esindab riiki, kus mobiilinumber esmakordselt määrati.	true
`original_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood), mis vastab mobiilinumbri algsele riigile.	true
`is_ported`	boolean	Näitab, kas mobiilinumber on üle kantud algsest võrgust teisele operaatorile.	true
`ported_network_name`	string	Võrguoperaatori nimi, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_name`	string	Riigi nimi, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_code`	string(2)	Kahetäheline ISO riigikood, mis esindab riiki, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`ported_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood) riigile, kuhu mobiilinumber on üle kantud, kui see on asjakohane.	true
`is_roaming`	boolean	Näitab, kas mobiilinumber on praegu rändluses välismaal. Rändluse oleku kättesaadavus sõltub mobiilsidevõrgu operaatorist.	true
`roaming_network_name`	string	Võrgu nimi, milles mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_name`	string	Riigi nimi, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_code`	string(2)	Kahetäheline ISO riigikood riigile, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`roaming_country_prefix`	string	Rahvusvaheline suunakood (riigi helistamiskood) riigile, kus mobiilinumber praegu rändluses viibib, kui see on asjakohane.	true
`cost`	string	Kümnendväärtus stringina, mis näitab päringu hinda eurodes.	true
`timestamp`	string	W3C-formaadis ajatempel koos ajavööndiga, mis määrab päringu lõpetamise aja.	true
`storage`	string	Salvestuskoha nimi, kuhu päringu tulemused salvestati. See vastab veebiliidese kaudu kättesaadavatele aruannete nimedele ja CSV-allalaadimistele.	true
`route`	string(3)	Kolmetäheline identifikaator, mis näitab selle päringu jaoks kasutatud marsruutimismeetodit.	true
`processing_status`	string	Päringu töötlemise tulemus. Võimalikud väärtused: `COMPLETED` (edukas), `REJECTED` (võrk kättesaamatu, tasu ei rakendata) või `FAILED` (töötlemisel tekkis viga).	false
`error_code`	integer	Valikuline sisemine veakood, mis pakub lisadiagnostilist teavet klienditoe jaoks.	true
`error_description`	string	Antud veakoodi lühike selgitus (kui see on olemas) inglise keeles lihttekstina.	true
`data_source`	string	Selle päringu jaoks kasutatud andmeallikas. Võimalikud väärtused: `LIVE_HLR` (reaalajas HLR-päring) või `MNP_DB` (staatiline numbri ülekande andmebaas). Täpsema teabe saamiseks vaadake marsruutimisvalikuid.	false
`routing_instruction`	string	Kooloniga eraldatud string, mis kirjeldab päringus kasutatud marsruutimisjuhendit. Esimene komponent on `STATIC`, kui määrasite marsruudi, või `AUTO` automaatse marsruutimise korral; teine komponent on marsruudi identifikaator ja automaatse marsruutimise päringute puhul näitab kolmas komponent allikat, millel marsruutimise otsus põhineb (st `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

Staatus	Kirjeldus
CONNECTED	Number on kehtiv ja sihtseade on praegu mobiilsidevõrguga ühendatud. Kõned, SMS-id ja muud teenused peaksid adressaadini edukalt jõudma.
ABSENT	Number on kehtiv, kuid sihtseade on kas välja lülitatud või ajutiselt võrgulevialast väljas. Sõnumid või kõned ei pruugi kohale jõuda enne, kui seade võrguga uuesti ühendub.
INVALID_MSISDN	Number on kehtetu või pole praegu mobiilsidevõrgus ühelegi tellijale määratud. Kõned ja sõnumid sellele numbrile ebaõnnestuvad.
UNDETERMINED	Numbri ühendusseisundit ei õnnestunud tuvastada. Põhjuseks võib olla kehtetu number, SS7 veateade või ühenduse puudumine sihtoperaatori võrguga. Täiendavaks diagnostikaks vaadake veakoodi ja selle kirjelduse välja.

Keri üles

POST/mnp-lookupkaitstud

Teostab sünkroonse MNP päringu ja tagastab mobiilside numbri ülekantavuse ning võrguinfo. See lõpp-punkt sobib juhul, kui teie peamine eesmärk on tuvastada antud mobiilinumbri praegune MCCMNC ning kindlaks teha algne ja praegune võrk reaalajas.

Suurte andmekogumite pakktöötlemiseks, mis ei vaja koheseid tulemusi, kaaluge asünkroonse POST /mnp-lookups kasutamist, mis on optimeeritud kiireks pakktöötluseks.

MNP päringud määravad usaldusväärselt numbri ülekantavuse ja võrguinfo, kuid ei näita, kas sihtmobiiltelefon on hetkel võrguga ühendatud ja kättesaadav. Reaalajas ühenduvusinfo saamiseks kasutage palun POST /hlr-lookup lõpp-punkti.

Päring Edukas vastus Veavastus

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdn`	string	Päritav mobiiltelefoni number (MSISDN), esitatud rahvusvahelises formaadis (nt +14156226819 või 0014156226819). Riigikoodid peavad olema lisatud.	null	kohustuslik
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Määrake väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisvaadet või lasta meie süsteemil automaatselt määrata parim marsruut selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Unikaalne 12-tähemärgiline identifikaator selle päringu jaoks.	false
`msisdn`	string	Selles päringus kontrollitud mobiiltelefoni number.	false
`query_status`	string	Näitab, kas teisaldatavuse ja võrguteabe päring õnnestus. Võimalikud väärtused on `OK` või `FAILED`.	false
`mccmnc`	string(5\|6)	Viie- või kuuetähemärgiline MCCMNC (mobiilse riigikood ja mobiilse võrgukoodi paar), mis identifitseerib võrgu, millesse mobiiltelefoni number praegu kuulub.	true
`mcc`	string(3)	Kolmetähemärgiline MCC (mobiilse riigikood), mis tähistab mobiiltelefoni numbri praeguse võrguga seotud riiki.	true
`mnc`	string(2\|3)	Kahe- või kolmetähemärgiline MNC (mobiilse võrgukood), mis identifitseerib mobiiltelefoni numbri praeguse võrguoperaatori.	true
`is_ported`	boolean	Näitab, kas telefoninumber on teisaldatud algsest võrgust uue operaatori juurde.	true
`original_network_name`	string	Suvaline tekst (inglise keeles), mis täpsustab kontrollitud mobiiltelefoni numbri algse võrguoperaatori nime.	true
`original_country_name`	string	Suvaline tekst (inglise keeles), mis näitab kontrollitud mobiiltelefoni numbri algset riiki.	true
`original_country_code`	string(2)	Kahetähemärgiline ISO riigikood, mis tähistab kontrollitud mobiiltelefoni numbri algset riiki.	true
`original_country_prefix`	string	Kontrollitud mobiiltelefoni numbriga seotud algse riigi suunakood.	true
`ported_network_name`	string	Täpsustab võrguoperaatori, kelle juurde kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_name`	string	Täpsustab riigi, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_code`	string(2)	Kahetähemärgiline ISO riigikood, mis tähistab riiki, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_prefix`	string	Riigi suunakood, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`extra`	string	Suvaline tekst, mis sisaldab valikulist lisateavet telefoninumbri kohta.	true
`cost`	string	Kümnendväärtus stringina, mis näitab selle päringu maksumust eurodes.	true
`timestamp`	string	W3C-vormingus ajatempel koos ajavööndi teabega, mis näitab, millal päring lõpetati.	true
`storage`	string	Salvestusnimi (või aruande nimi), millesse päringu tulemused lisati. Seda kasutatakse CSV-failide allalaadimiseks ja aruandluseks veebiliidese kaudu.	true
`route`	string(3)	Kolmetähemärgiline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti.	true
`error_code`	integer	Valikuline sisetõrkekood, mis annab lisateavet klienditeeninduse diagnostika jaoks.	true

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

POST/mnp-lookupskaitstud

Käivitab asünkroonsete MNP (mobiilside numbri ülekantavus) päringute partii, hankides reaalajas kehtiva MCCMNC ning tuvastades algse ja praeguse võrgu. Tulemused edastatakse teie serverile webhookide kaudu. See meetod on optimeeritud suurte numbrimahtude töötlemiseks, mis ei vaja koheseid vastuseid, nagu andmebaaside puhastamine ja verifitseerimine. Reaalajas rakenduste jaoks, nagu kõnede marsruutimine või SMS-i edastamine, kaaluge selle asemel POST /mnp-lookup lõpp-punkti kasutamist.

MNP päringud määravad usaldusväärselt numbri ülekantavuse ja võrguinfo, kuid ei näita, kas sihtmobiiltelefon on hetkel võrguga ühendatud ja kättesaadav. Reaalajas ühenduvusinfo saamiseks kasutage palun POST /hlr-lookups lõpp-punkti.

Enne selle lõpp-punkti kasutamist veenduge, et webhook URL oleks konfigureeritud päringute tulemuste asünkroonseks vastuvõtmiseks. Saate seda seadistada oma API sätetes.

Päring Edukas vastus Veavastus Webhooks

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdns`	array	Mobiiltelefoni numbrite (MSISDN-id) massiiv rahvusvahelises formaadis (nt +14156226819 või 0014156226819). Päringu kohta saate lisada kuni 1000 numbrit.	null	kohustuslik
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Seadke väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisskeem või lasta meie süsteemil automaatselt määrata parimad marsruudid selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`accepted`	array	Objektide loend, mis sisaldab unikaalseid identifikaatoreid ja MSISDN-e, mis on töötlemiseks vastu võetud.	false
`accepted_count`	integer	MSISDN-ide koguarv, mis on edukalt töötlemiseks vastu võetud.	false
`rejected`	array	Objektide loend, mis sisaldab unikaalseid identifikaatoreid ja MSISDN-e, mis on töötlemiseks tagasi lükatud, tavaliselt kehtetute numbrite tõttu. Tagasi lükatud kirjete eest tasu ei võeta.	false
`rejected_count`	integer	MSISDN-ide koguarv, mis on valideerimisveate tõttu tagasi lükatud.	false
`total_count`	integer	Vastu võetud ja tagasi lükatud MSISDN-ide koguarv, mis esitati töötlemiseks.	false
`cost`	string	Stringina esitatud kümnendväärtus, mis näitab vastu võetud päringute kogumaksumust eurodes.	false
`storage`	string	Salvestuskoha nimi, kuhu päringute tulemused lisatakse, kasutatakse aruandluse ja CSV allalaadimiste jaoks veebiliideses.	false
`route`	string(3)	Kolmetähemärgiline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti.	false
`webhook_urls`	array	Teie API sätetes konfigureeritud webhook URL-id. Tulemused saadetakse siia tagasi.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Webhookide töötlemine

Pärast esitamist alustab meie platvorm esitatud telefoninumbrite töötlemist ja saadab tulemused teie serveris eelnevalt määratud webhook URL-ile. Tulemused edastatakse HTTP POST päringuna, mille kehas on JSON objekt.

Autentimine

Autentimiseks kontrollige X-Signatures HTTP päist.

X-Signatures päis sisaldab semikooloniga eraldatud allkirjade loendit. Iga loendis olev allkiri genereeritakse kasutades ühte teie kontol seadistatud API saladustest. Webhooki kontrollimiseks genereerige SHA-256 räsi kasutades oma API võtit, saladust ja HTTP keha - seejärel võrrelge seda loendis olevate allkirjadega.

Vaste kinnitab, et päring on autentne ja allkirjastatud teie kontrolli all oleva saladusega.

Koodinäide

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

Päring on kehtiv, kui mõni päises antud allkirjadest võrdub SHA256 räsiga, mis on arvutatud teie API võtme, saladuse ja HTTP keha ühendatud stringist.

Kättesaamise kinnitamine

Teie server peab vastama HTTP olekukoodiga 200 OK, et kinnitada edukat kättesaamist. Kui tagastatakse mõni muu vastusekood, tekib ajalõpp (10 sekundit) või esineb mõni muu tarneprobleem, proovib süsteem webhookki automaatselt ühe minuti pärast uuesti. Kui päring jätkuvalt ebaõnnestub, järgivad korduskatsed eksponentsiaalset taganemisstrateegiat, järgnevate katsetega 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuti pärast.

See korduskatsete mehhanism tagab maksimaalse usaldusväärsuse päringtulemuste edastamisel teie infrastruktuurile. See vähendab andmekao riski ajutiste võrguprobleemide või serveri seisakute tõttu.

Webhooki andmemaht

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

Webhooki andmete atribuudid

JSON objekt sisaldab atribuuti type => MNP koos atribuudiga results, mis hõlmab päringute objektide loendit, nagu allpool dokumenteeritud.

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Unikaalne 12-tähemärgiline identifikaator selle päringu jaoks.	false
`msisdn`	string	Selles päringus kontrollitud mobiiltelefoni number.	false
`query_status`	string	Näitab, kas teisaldatavuse ja võrguteabe päring õnnestus. Võimalikud väärtused on `OK` või `FAILED`.	false
`mccmnc`	string(5\|6)	Viie- või kuuetähemärgiline MCCMNC (mobiilse riigikood ja mobiilse võrgukoodi paar), mis identifitseerib võrgu, millesse mobiiltelefoni number praegu kuulub.	true
`mcc`	string(3)	Kolmetähemärgiline MCC (mobiilse riigikood), mis tähistab mobiiltelefoni numbri praeguse võrguga seotud riiki.	true
`mnc`	string(2\|3)	Kahe- või kolmetähemärgiline MNC (mobiilse võrgukood), mis identifitseerib mobiiltelefoni numbri praeguse võrguoperaatori.	true
`is_ported`	boolean	Näitab, kas telefoninumber on teisaldatud algsest võrgust uue operaatori juurde.	true
`original_network_name`	string	Suvaline tekst (inglise keeles), mis täpsustab kontrollitud mobiiltelefoni numbri algse võrguoperaatori nime.	true
`original_country_name`	string	Suvaline tekst (inglise keeles), mis näitab kontrollitud mobiiltelefoni numbri algset riiki.	true
`original_country_code`	string(2)	Kahetähemärgiline ISO riigikood, mis tähistab kontrollitud mobiiltelefoni numbri algset riiki.	true
`original_country_prefix`	string	Kontrollitud mobiiltelefoni numbriga seotud algse riigi suunakood.	true
`ported_network_name`	string	Täpsustab võrguoperaatori, kelle juurde kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_name`	string	Täpsustab riigi, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_code`	string(2)	Kahetähemärgiline ISO riigikood, mis tähistab riiki, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`ported_country_prefix`	string	Riigi suunakood, kuhu kontrollitud mobiiltelefoni number on teisaldatud, kui see on asjakohane.	true
`extra`	string	Suvaline tekst, mis sisaldab valikulist lisateavet telefoninumbri kohta.	true
`cost`	string	Kümnendväärtus stringina, mis näitab selle päringu maksumust eurodes.	true
`timestamp`	string	W3C-vormingus ajatempel koos ajavööndi teabega, mis näitab, millal päring lõpetati.	true
`storage`	string	Salvestusnimi (või aruande nimi), millesse päringu tulemused lisati. Seda kasutatakse CSV-failide allalaadimiseks ja aruandluseks veebiliidese kaudu.	true
`route`	string(3)	Kolmetähemärgiline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti.	true
`error_code`	integer	Valikuline sisetõrkekood, mis annab lisateavet klienditeeninduse diagnostika jaoks.	true

Keri üles

POST/nt-lookupkaitstud

Käivitab sünkroonse numbri tüübi (NT) päringu. See lõpp-punkt sobib ideaalselt juhul, kui teie peamine eesmärk on reaalajas tuvastada, kas esitatud telefoninumbrid kuuluvad püsiühenduse, mobiilside, lisatasu, VoIP, piiparside või muude numbriplaani vahemike alla.

NT päringud tuvastavad usaldusväärselt telefoninumbri tüübi, kuid ei näita, kas sihtmärk on praegu võrguga ühendatud ja kättesaadav. Reaalajas ühenduvuse teabe saamiseks kasutage palun POST /hlr-lookup lõpp-punkti.

Kui teie kasutusjuht nõuab täpset võrgu- ja teisaldatavuse teavet (MCCMNC), kuid mitte reaalajas ühenduvuse staatust, kasutage palun POST /mnp-lookup lõpp-punkti mobiilside numbri teisaldatavuse päringuteks.

Päring Edukas vastus Veavastus Tüübi viide

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`number`	string	Telefoninumber rahvusvahelises formaadis (nt +4989702626 või 004989702626).	null	mandatory
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Määrake väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisskeem või lasta meie süsteemil automaatselt määrata parimad marsruudid selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Sellele päringule määratud unikaalne identifikaator.	false
`number`	string	Telefoninumber, mida selle päringu käigus hinnati.	false
`number_type`	string	Tuvastatud numbri tüüp. Võimalikud väärtused: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Näitab, kas numbri tüübi teave saadi edukalt. Tagastab `OK` edukal päringul või `FAILED` ebaõnnestunud päringul.	false
`is_valid`	boolean	Näitab, kas telefoninumber on süntaktiliselt korrektne.	true
`invalid_reason`	string	Ingliskeelne tekstisõnum, mis täpsustab, miks telefoninumbrit peetakse kehtetuks (nt "too short" või "invalid prefix"), või `null`, kui number on kehtiv.	true
`is_possibly_ported`	boolean	Näitab, kas telefoninumber võib olla üle kantud algselt operaatorilt teisele operaatorile. Täpse teisaldatavuse info saamiseks kasutage MNP päringuid.	true
`is_vanity_number`	boolean	Näitab, kas telefoninumber on vanity number, st sisaldab tähemärke.	true
`qualifies_for_hlr_lookup`	boolean	Näitab, kas telefoninumber sobib täiendavateks päringuteks HLR päringute kaudu.	true
`mccmnc`	string(5\|6)	Viie või kuue märgist koosnev string, mis tähistab MCCMNC tuuplit (riigi mobiilikood ja võrgu kood), mis identifitseerib mobiiltelefoni numbri algset võrku.	true
`mcc`	string(3)	Kolme märgist koosnev string, mis tähistab MCC-d (riigi mobiilikood), mis identifitseerib telefoninumbri algse mobiilivõrguga seotud riigi.	true
`mnc`	string(2\|3)	Kahe või kolme märgist koosnev string, mis tähistab MNC-d (võrgu kood), mis identifitseerib telefoninumbri algse mobiilivõrgu operaatori.	true
`original_network_name`	string	Ingliskeelne tekstistring, mis täpsustab kontrollitud mobiiltelefoni numbri algse võrguoperaatori nime.	true
`original_country_name`	string	Ingliskeelne tekstistring, mis täpsustab kontrollitud mobiiltelefoni numbriga seotud algse riigi.	true
`original_country_code`	string(2)	Kahetäheline ISO riigikood, mis näitab kontrollitud mobiiltelefoni numbri algset riiki.	true
`regions`	array	Loetelu ingliskeelsetest loetavatest stringidest, mis täpsustavad selle telefoninumbriga seotud geograafilise(d) piirkonna(d).	true
`timezones`	array	Loetelu ajavöönditest (Olsoni formaadis), mis on seotud selle telefoninumbriga.	true
`info_text`	string	String, mis võib sisaldada lisateavet telefoninumbri kohta.	true
`cost`	string	Stringina esitatud kümnendväärtus, mis näitab selle päringu maksumust (eurodes).	true
`timestamp`	string	W3C-formaadis ajatempel (koos ajavööndiga), mis näitab, millal päring lõpetati.	true
`storage`	string	Määrab salvestuskoha nime, kuhu päringu tulemused on lisatud. See vastab aruande nimele, mida kasutatakse CSV allalaadimiseks ja analüütikaks veebiliidese kaudu.	true
`route`	string(3)	Kolmetähemärgiline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti.	true

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Tüüp	Kirjeldus
LANDLINE	Lauatelefoninumber.
MOBILE	Mobiiltelefoninumber. Sobib HLR päringuteks, et saada lisateavet ühenduse oleku, võrgu, teisaldatavuse ja rändluse kohta.
MOBILE_OR_LANDLINE	Laua- või mobiiltelefoninumber. Võib sobida HLR päringuteks.
TOLL_FREE	Tasuta telefoninumber.
PREMIUM_RATE	Lisatasulise kõrge hinnaga telefoninumber.
SHARED_COST	Jagatud kuludega telefoninumber. Tavaliselt odavam kui kõrge hinnaga telefoninumbrid.
VOIP	Voice over IP telefoninumber. Sisaldab TSoIP telefoninumbreid (Telephony Service over IP).
PAGER	Piiparinumber. Tavaliselt puudub häälkõne funktsioon.
UAN	Universaalne juurdepääsunumber (ettevõtte number). Võib olla suunatud konkreetsetesse kontoritesse, kuid võimaldab kasutada ettevõtte jaoks ühte numbrit.
VOICEMAIL	Kõnepostinumber.
UNKNOWN	Numbri tüüpi ei õnnestunud määrata.

Keri üles

POST/nt-lookups kaitstud

See lõpp-punkt käivitab asünkroonsete numbri tüübi päringute seeria, mille tulemused saadetakse teie serverisse tagasi webhookide kaudu. Sobib juhul, kui teie peamine eesmärk on kindlaks teha, kas antud telefoninumbrid kuuluvad lauatelefoni, mobiiltelefoni, lisatasu, VoIP, piiparite või muude numeratsiooniplaani vahemike alla. Suurte numbrimahtude kiireks töötlemiseks optimeeritud lõpp-punkt sobib ideaalselt hulgioperatsioonideks (nt andmebaasi puhastamine). Reaalajas liikluse ja ajatundlike kasutusjuhtude jaoks kasutage palun hoopis lõpp-punkti POST /nt-lookup.

Selle lõpp-punkti kasutamiseks peate eelnevalt määrama webhooki URL-i oma API seadetes.

Päring Edukas vastus Veavastus Webhooks Tüübi viide

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

Andmekoormus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`numbers`	array	Rahvusvahelises formaadis telefoninumbrite massiiv (nt +14156226819 või 004989702626). Ühe päringu kohta saab lisada maksimaalselt 1000 numbrit.	null	kohustuslik
`route`	string(3)	Valikuline kolmetäheline identifikaator, mis määrab selle päringu marsruudi. Määrake väärtuseks `null` või jätke see parameeter välja, et rakendada oma kohandatud marsruutimisskeem või lasta meie süsteemil automaatselt määrata parim marsruut selle päringu jaoks.	null	valikuline
`storage`	string	Valikuline salvestusidentifikaator, mis määrab raporti, kuhu tulemused salvestatakse käsitsi ülevaatamiseks, analüüsiks ja aruandluseks. Süsteem lisab automaatselt ajatempli praeguse kuuga. Kui välja jäetud või määratud väärtuseks `null`, grupeerib süsteem tulemused automaatselt kuude kaupa aruandluse eesmärgil.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`accepted`	array	Objektide massiiv, millest igaüks sisaldab unikaalset identifikaatorit ja töötlemiseks vastu võetud telefoninumbrit.	false
`accepted_count`	integer	Töötlemiseks vastu võetud telefoninumbrite koguarv.	false
`rejected`	array	Objektide massiiv, millest igaüks sisaldab unikaalset identifikaatorit ja töötlemisest tagasi lükatud telefoninumbrit. Tavaliselt on need numbrid vigased ja nende eest ei võeta tasu.	false
`rejected_count`	integer	Töötlemisest tagasi lükatud telefoninumbrite koguarv.	false
`total_count`	integer	Töötlemiseks esitatud vastu võetud ja tagasi lükatud telefoninumbrite koguarv.	false
`cost`	string	Kümnendväärtust tähistav string, mis näitab nende päringute maksumust eurodes.	false
`storage`	string	Salvestuskoha (aruande) nimi, kuhu päringutulemused on lisatud. Seda nime kasutatakse CSV-failide allalaadimiseks ja analüütikaks veebiliideses.	false
`route`	string(3)	Kolmetäheline identifikaator, mis määrab selle päringu jaoks kasutatud marsruudi.	false
`webhook_urls`	array	Teie API sätetes konfigureeritud webhook URL-id. Tulemused saadetakse siia tagasi.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Webhookide töötlemine

Pärast esitamist alustab meie platvorm esitatud telefoninumbrite töötlemist ja saadab tulemused teie serveris eelnevalt määratud webhook URL-ile. Tulemused edastatakse HTTP POST päringuna, mille kehas on JSON objekt.

Autentimine

Autentimiseks kontrollige X-Signatures HTTP päist.

X-Signatures päis sisaldab semikooloniga eraldatud allkirjade loendit. Iga loendis olev allkiri genereeritakse kasutades ühte teie kontol seadistatud API saladustest. Webhooki kontrollimiseks genereerige SHA-256 räsi kasutades oma API võtit, saladust ja HTTP keha - seejärel võrrelge seda loendis olevate allkirjadega.

Vaste kinnitab, et päring on autentne ja allkirjastatud teie kontrolli all oleva saladusega.

Koodinäide

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

Päring on kehtiv, kui mõni päises antud allkirjadest võrdub SHA256 räsiga, mis on arvutatud teie API võtme, saladuse ja HTTP keha ühendatud stringist.

Kättesaamise kinnitamine

Teie server peab vastama HTTP olekukoodiga 200 OK, et kinnitada edukat kättesaamist. Kui tagastatakse mõni muu vastusekood, tekib ajalõpp (10 sekundit) või esineb mõni muu tarneprobleem, proovib süsteem webhookki automaatselt ühe minuti pärast uuesti. Kui päring jätkuvalt ebaõnnestub, järgivad korduskatsed eksponentsiaalset taganemisstrateegiat, järgnevate katsetega 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuti pärast.

See korduskatsete mehhanism tagab maksimaalse usaldusväärsuse päringtulemuste edastamisel teie infrastruktuurile. See vähendab andmekao riski ajutiste võrguprobleemide või serveri seisakute tõttu.

Webhooki andmemaht

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

Webhooki andmete atribuudid

JSON objekt sisaldab atribuuti type => NT koos atribuudiga results, mis hõlmab päringute objektide loendit, nagu allpool dokumenteeritud.

Nimi	Tüüp	Kirjeldus	Nullitav
`id`	string(12)	Sellele päringule määratud unikaalne identifikaator.	false
`number`	string	Telefoninumber, mida selle päringu käigus hinnati.	false
`number_type`	string	Tuvastatud numbri tüüp. Võimalikud väärtused: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Näitab, kas numbri tüübi teave saadi edukalt. Tagastab `OK` edukal päringul või `FAILED` ebaõnnestunud päringul.	false
`is_valid`	boolean	Näitab, kas telefoninumber on süntaktiliselt korrektne.	true
`invalid_reason`	string	Ingliskeelne tekstisõnum, mis täpsustab, miks telefoninumbrit peetakse kehtetuks (nt "too short" või "invalid prefix"), või `null`, kui number on kehtiv.	true
`is_possibly_ported`	boolean	Näitab, kas telefoninumber võib olla üle kantud algselt operaatorilt teisele operaatorile. Täpse teisaldatavuse info saamiseks kasutage MNP päringuid.	true
`is_vanity_number`	boolean	Näitab, kas telefoninumber on vanity number, st sisaldab tähemärke.	true
`qualifies_for_hlr_lookup`	boolean	Näitab, kas telefoninumber sobib täiendavateks päringuteks HLR päringute kaudu.	true
`mccmnc`	string(5\|6)	Viie või kuue märgist koosnev string, mis tähistab MCCMNC tuuplit (riigi mobiilikood ja võrgu kood), mis identifitseerib mobiiltelefoni numbri algset võrku.	true
`mcc`	string(3)	Kolme märgist koosnev string, mis tähistab MCC-d (riigi mobiilikood), mis identifitseerib telefoninumbri algse mobiilivõrguga seotud riigi.	true
`mnc`	string(2\|3)	Kahe või kolme märgist koosnev string, mis tähistab MNC-d (võrgu kood), mis identifitseerib telefoninumbri algse mobiilivõrgu operaatori.	true
`original_network_name`	string	Ingliskeelne tekstistring, mis täpsustab kontrollitud mobiiltelefoni numbri algse võrguoperaatori nime.	true
`original_country_name`	string	Ingliskeelne tekstistring, mis täpsustab kontrollitud mobiiltelefoni numbriga seotud algse riigi.	true
`original_country_code`	string(2)	Kahetäheline ISO riigikood, mis näitab kontrollitud mobiiltelefoni numbri algset riiki.	true
`regions`	array	Loetelu ingliskeelsetest loetavatest stringidest, mis täpsustavad selle telefoninumbriga seotud geograafilise(d) piirkonna(d).	true
`timezones`	array	Loetelu ajavöönditest (Olsoni formaadis), mis on seotud selle telefoninumbriga.	true
`info_text`	string	String, mis võib sisaldada lisateavet telefoninumbri kohta.	true
`cost`	string	Stringina esitatud kümnendväärtus, mis näitab selle päringu maksumust (eurodes).	true
`timestamp`	string	W3C-formaadis ajatempel (koos ajavööndiga), mis näitab, millal päring lõpetati.	true
`storage`	string	Määrab salvestuskoha nime, kuhu päringu tulemused on lisatud. See vastab aruande nimele, mida kasutatakse CSV allalaadimiseks ja analüütikaks veebiliidese kaudu.	true
`route`	string(3)	Kolmetähemärgiline identifikaator, mis täpsustab selle päringu jaoks kasutatud marsruuti.	true

Tüüp	Kirjeldus
LANDLINE	Lauatelefoninumber.
MOBILE	Mobiiltelefoninumber. Sobib HLR päringuteks, et saada lisateavet ühenduse oleku, võrgu, teisaldatavuse ja rändluse kohta.
MOBILE_OR_LANDLINE	Laua- või mobiiltelefoninumber. Võib sobida HLR päringuteks.
TOLL_FREE	Tasuta telefoninumber.
PREMIUM_RATE	Lisatasulise kõrge hinnaga telefoninumber.
SHARED_COST	Jagatud kuludega telefoninumber. Tavaliselt odavam kui kõrge hinnaga telefoninumbrid.
VOIP	Voice over IP telefoninumber. Sisaldab TSoIP telefoninumbreid (Telephony Service over IP).
PAGER	Piiparinumber. Tavaliselt puudub häälkõne funktsioon.
UAN	Universaalne juurdepääsunumber (ettevõtte number). Võib olla suunatud konkreetsetesse kontoritesse, kuid võimaldab kasutada ettevõtte jaoks ühte numbrit.
VOICEMAIL	Kõnepostinumber.
UNKNOWN	Numbri tüüpi ei õnnestunud määrata.

Keri üles

GET/routekaitstud

Tagastab marsruudi, mis valitakse automaatselt HLR-päringu käivitamisel ilma route parameetrit määramata.

Automaatne marsruudi valik põhineb marsruudikaardil, mille saab kätte GET /hlr-coverage otspunkti kaudu ja mis tuleneb peamiselt GET /routing-map andmetest. Saate kohandada oma marsruudikaarti ja määratleda kohandatud reegleid oma konto seadetes.

Päring Edukas vastus Veavastus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdn`	string	MSISDN, mille jaoks soovitakse automaatselt valitud marsruudiinfot.	null	kohustuslik

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`route`	string	Soovitatud marsruut.	false
`confidence_level`	string	Usaldusväärsuse tase, millega see marsruut valiti, st `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Selle numbri numbriplaanil põhinev MCCMNC.	false
`origin`	string	Allikas, millel marsruudivalik põhineb, st `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."
    ]
}

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/routeskaitstud

See päringupunkt tagastab loetelu saadaolevatest HLR, MNP ja NT marsruutidest. Iga marsruut koos selle funktsioonide ja piiranguteega on selgitatud lehel marsruutimise üksikasjad.

Päring Edukas vastus Veavastus

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

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`routes`	object	Objekt, milles marsruudid on rühmitatud marsruudi tüübi järgi.	false
`HLR\|MNP\|NT`	string[]	Sisaldab marsruudi identifikaatorite loendit.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/routing-mapkaitstud

Tagastab teie kontole praegu rakendatud automaatse marsruutimise konfiguratsiooni HLR päringute jaoks. Seda vaikekonfiguratsiooni kasutatakse alati, kui esitate HLR päringuid ilma route parameetrit määramata. Saate oma marsruutimisskaarti kohandada ja luua kohandatud reegleid oma konto seadetes.

Konfiguratsiooni hierarhia kulgeb riigipõhistest reeglitest MCCMNC-põhiste reegliteni ja lõpuks üksikute telefoninumbrite eesliidete vastendamiseni. Praktikas tähendab see, et üksikute telefoninumbrite eesliidete vastendused on prioriteetsemad kui vastuolulised MCCMNC määrangud, mis omakorda alistavad riigipõhised reeglid. Palun pange tähele, et MNP varundus alistab kõik vastuolulised kohandatud reeglid, kui see on lubatud.

Päring Edukas vastus Veavastus

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`default_route`	string	Vaikemarsruut, mida kasutatakse siis, kui MSISDN-i jaoks ei saa määrata eelistatud marsruutimisvalikut ja kohandatud marsruutimisreeglid ei kehti.	false
`mnp_fallback`	boolean	Näitab, kas MNP varundus on lubatud. Kui see on lubatud ja HLR päringuid ei toeta võrk (ühenduvuse olek pole saadaval), teostab süsteem selle asemel MNP päringu.	false
`mccmncs`	array	MCCMNC koodide vastendamine nende automaatselt valitud marsruutidega. HLR päringu teostamisel antud MCCMNC numbri jaoks kasutatakse vastavat marsruuti.	false
`mccmnc`	string(5\|6)	Viie- või kuuekohaline MCCMNC (mobiilse riigi koodi ja mobiilsidevõrgu koodi kombinatsioon), mis identifitseerib mobiilsidevõrgu operaatori.	false
`countrycode`	string(2)	Kahetäheline ISO riigikood, mis identifitseerib võrgu riigi.	false
`route`	string(3)	Võrgu jaoks valitud marsruut.	false
`mno`	string	Tarbijale suunatud kaubamärk, mille all see võrk tegutseb.	false
`confidence`	string	Valiku tegemise usaldusväärsuse tase. Võimalikud väärtused on: HIGH, NORMAL, LOW, MNP_REDIRECT. Viimase puhul suunab süsteem selle võrgu liikluse MNP-le, kui see käitumine on teie kontol lubatud. Vastasel juhul kasutab see konto vaikemarsruuti.	false
`origin`	string	Allikas, millel valik põhineb. Võimalikud väärtused on: `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	Teie kontol konfigureeritud kohandatud eesliidepõhiste marsruutimisreeglite loend, kui neid on.	false
`countrycode`	string(2)	Kahetäheline ISO riigikood, mis identifitseerib eesliite riigi.	false
`cns`	string	Eesliide, millele marsruutimisreegel kehtib.	false
`route`	string(3)	Eesliite jaoks valitud marsruut.	false
`mccmnc`	string(5\|6)	Viie- või kuuekohaline MCCMNC (mobiilse riigi koodi ja mobiilsidevõrgu koodi kombinatsioon), mis identifitseerib mobiilsidevõrgu operaatori.	true
`mno`	string	Tarbijale suunatud kaubamärk, mille all see võrk tegutseb.	true
`countries`	array	Teie kontol konfigureeritud kohandatud riigipõhiste reeglite loend, kui neid on.	false
`countrycode`	string(2)	Kahetäheline ISO riigikood, mis identifitseerib riigi.	false
`route`	string(3)	Riigi jaoks valitud marsruut.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/hlr-coverage kaitstud

Tagastab HLR katvuse ülevaate andmepõhiste otsuste toetamiseks. See lõpp-punkt aitab analüüsida reaalajas HLR marsruutimise võimalusi mobiilsidevõrkudes, tuvastada kõige tõhusamaid teid teie sihtpiirkondade jaoks ning seadistada automaatset marsruutimist.

Soovitatud marsruudid lõpp-punktist GET /route põhinevad siin kogutud katvuse andmetel. Katvuse andmed on saadaval ka lehel võrgukatvus. Saate oma marsruutimiskaarti täiendavalt kohandada ja määrata reegleid oma konto seadetes.

Soovitame tutvuda selle juhendiga, mis aitab tulemusi tõlgendada.

Päring Edukas vastus Veavastus Olekute viide

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`countrycode`	string(2)	Kohustuslik kahetäheline ISO riigikood, mida kasutatakse tulemuste filtreerimiseks, tagastades ainult määratud riigiga seotud kirjed.	null	kohustuslik
`sample_size`	string	Valikuline parameeter, mis määrab valimi suuruse. Võimalikud väärtused on `LARGE`, `MEDIUM`, `SMALL`. Suuremad valimid hõlmavad pikemat ajavahemikku, väiksemad valimid hõlmavad väga hiljutist ajavahemikku.	LARGE	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`name`	string	Valitud riigi nimi inglise keeles lihttekstina.	false
`countrycode`	string(2)	Valitud riigi kahetäheline ISO riigikood.	false
`prefix`	string	Valitud riigi rahvusvaheline suunakood.	false
`mccs`	string[]	Valitud riigiga seotud MCC-de (mobiilse riigi koodide) loend.	false
`carriers`	object[]	Operaatorite objektide loend marsruudipõhiste ühenduvuse näitajatega.	false
`mno`	string	Mobiilsidevõrgu operaatori nimi inglise keeles lihttekstina.	false
`mccmnc`	string	Mobiilsidevõrgu operaatori MCCMNC.	false
`mcc`	string	Mobiilsidevõrgu operaatori MCC (mobiilse riigi kood).	false
`mnc`	string	Mobiilsidevõrgu operaatori MNC (mobiilsidevõrgu kood).	false
`routes`	object[]	Marsruudipõhiste ühenduvuse tulemuste loend.	false
`route`	string	Marsruut, mille kohta ühenduvuse teave kehtib.	false
`selected`	bool	Näitab, kas see on automaatse marsruutimise jaoks valitud marsruut.	false
`selection_confidence`	string	Usaldusväärsuse tase, millega see marsruut valiti, st `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Sisaldab null, kui see ei ole valitud marsruut.	true
`n`	int	Päringute koguarv selles valimis.	false
`CONNECTED`	int	HLR päringute arv, mis tagastasid oleku CONNECTED.	false
`CONNECTED_PCT`	float	HLR päringute protsent, mis tagastasid oleku CONNECTED.	false
`ABSENT`	int	HLR päringute arv, mis tagastasid oleku ABSENT.	false
`ABSENT_PCT`	float	HLR päringute protsent, mis tagastasid oleku ABSENT.	false
`INVALID_MSISDN`	int	HLR päringute arv, mis tagastasid oleku INVALID_MSISDN.	false
`INVALID_MSISDN_PCT`	float	HLR päringute protsent, mis tagastasid oleku INVALID_MSISDN.	false
`UNDETERMINED`	int	HLR päringute arv, mis tagastasid oleku UNDETERMINED.	false
`UNDETERMINED_PCT`	float	HLR päringute protsent, mis tagastasid oleku UNDETERMINED.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Staatus	Kirjeldus
CONNECTED	Number on kehtiv ja sihtseade on praegu mobiilsidevõrguga ühendatud. Kõned, SMS-id ja muud teenused peaksid adressaadini edukalt jõudma.
ABSENT	Number on kehtiv, kuid sihtseade on kas välja lülitatud või ajutiselt võrgulevialast väljas. Sõnumid või kõned ei pruugi kohale jõuda enne, kui seade võrguga uuesti ühendub.
INVALID_MSISDN	Number on kehtetu või pole praegu mobiilsidevõrgus ühelegi tellijale määratud. Kõned ja sõnumid sellele numbrile ebaõnnestuvad.
UNDETERMINED	Numbri ühendusseisundit ei õnnestunud tuvastada. Põhjuseks võib olla kehtetu number, SS7 veateade või ühenduse puudumine sihtoperaatori võrguga. Täiendavaks diagnostikaks vaadake veakoodi ja selle kirjelduse välja.

Keri üles

GET/mnp-coveragekaitstud

See päring tagastab mobiilsidevõrgu operaatorite loendi koos nende MCCMNC identifikaatoritega, mida praegu toetatakse numbri ülekantavuse päringutes.

Päring Edukas vastus Veavastus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`countrycode`	string(2)	Valikuline kahetäheline ISO riigikood, mida kasutatakse MCCMNC tulemuste filtreerimiseks, tagastades ainult määratud riigiga seotud andmed.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`items[]`	array	Mobiilsidevõrgu operaatorite loend.	false
`country_name`	string	Riigi nimi inglise keeles.	false
`country_code`	string(2)	Kahetäheline ISO riigikood.	false
`mccmnc`	string(5\|6)	Viie- või kuuekohaline MCCMNC (mobiilse riigi koodi ja mobiilsidevõrgu koodi kombinatsioon), mis identifitseerib mobiilsidevõrgu operaatori.	false
`mcc`	string(3)	Kolmekohaline MCC (mobiilse riigi kood), mis tähistab võrgu riiki.	false
`mnc`	string(2\|3)	Kahe- või kolmekohaline MNC (mobiilsidevõrgu kood), mis tähistab konkreetset mobiilsidevõrgu operaatorit.	false
`brand`	string	Tarbijale suunatud kaubamärk, mille all see võrk tegutseb.	true
`operator`	string	Mobiilsidevõrgu operaatori juriidiline nimi.	true

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/price-listkaitstud

See otspunkt tagastab riikide loendi, kus toetatakse ainult MNP päringuid ja HLR päringud nende sihtkohtade jaoks pole saadaval.

Päring Edukas vastus Veavastus

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

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`countries`	string[]	Kahetäheliste ISO riigikoodide loend.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/mccmncskaitstud

See päring tagastab põhjaliku loendi mobiilsidevõrgu operaatoritest koos nende vastavate MCCMNC identifikaatoritega ja täiendava kontekstuaalse teabega.

Päring Edukas vastus Veavastus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`countrycode`	string(2)	Valikuline kahetäheline ISO riigikood, mida kasutatakse MCCMNC tulemuste filtreerimiseks, tagastades ainult määratud riigiga seotud kirjed.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`items`	object[]	Mobiilsidevõrgu operaatorite loend.	false
`country_name`	string	Riigi täielik nimi inglise keeles.	false
`country_code`	string(2)	Kahetäheline ISO riigikood, mis tähistab mobiiloperaatori riiki.	false
`mccmnc`	string(5\|6)	Viie- või kuuemärgine string, mis tähistab MCCMNC-d ja identifitseerib unikaalselt mobiilsidevõrgu operaatori.	false
`mcc`	string(3)	Kolmemärgine mobiilriigi kood (MCC), mis identifitseerib riiki, kus mobiilsidevõrk tegutseb.	false
`mnc`	string(2\|3)	Kahe- või kolmemärgine mobiilsidevõrgu kood (MNC), mis täpsustab mobiilsidevõrku antud MCC piires.	false
`brand`	string	Kaubanduslik kaubamärgi nimi, mille all võrk tegutseb ja mida tarbijad tunnevad.	true
`operator`	string	Mobiilsidevõrgu operaatori ametlik nimi, tavaliselt võrku haldav juriidiline isik.	true
`parent_mccmnc`	string(5\|6)	Viie- või kuuemärgine string, mis tähistab emaettevõtte mobiilsidevõrgu operaatori MCCMNC-d, kui see on olemas.	true

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/pricekaitstud

See otspunkt tagastab HLR-, MNP- või NT-päringu hinna.

Päring Edukas vastus Veavastus

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

Päringu parameetrid

Võti	Tüüp	Kirjeldus	Vaikimisi	Kohustuslik
`msisdn`	string	Telefoninumber, mille hinna soovite päringuga saada. Rahvusvahelises formaadis.	null	kohustuslik
`route_type`	string	Marsruudi tüüp, st `HLR`, `MNP`, `NT`.	null	kohustuslik
`route`	string(3)	Marsruut, mille jaoks hind arvutatakse. Vaikimisi kasutatakse automaatse marsruutimise määratud marsruuti.	null	valikuline

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`price`	object	Objekt hinnakujunduse üksikasjadega.	false
`amount`	string	Summa eurodes.	false
`msisdn`	string	MSISDN, mille kohta see hind kehtib.	false
`route_type`	string(2\|3)	Marsruudi tüüp, mille kohta see hind kehtib.	false
`route`	string(3)	Marsruut, mille kohta see hind kehtib.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/price-listkaitstud

See päring tagastab teie konto hinnakirja.

Päring Edukas vastus Veavastus

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

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`pricing`	object[]	Hinnateabega objektide loend.	false
`route`	string	Marsruut, millele see hinnakiri kehtib.	false
`countrycode`	string	Kahetäheline ISO riigikood, millele see hinnakiri vastava marsruudi puhul kehtib, kui see on määratud.	true
`countryname`	string	Riigikoodile vastav ingliskeelne riigi nimi, kui see on määratud.	true
`mccmnc`	string	MCCMNC, millele see hinnakiri vastava marsruudi puhul kehtib, kui see on määratud. Tühistab riigipõhise hinnakirja.	true
`cns`	string	Valimisprefix, millele see hinnakiri vastava marsruudi puhul kehtib, kui see on määratud. Tühistab riigipõhise hinnakirja ja MCCMNC-põhise hinnakirja.	true
`route_type`	string	Vastav marsruudi tüüp, st `HLR`, `MNP`, `NT`.	false
`route_type`	string	Vastav hind eurodes.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/balancekaitstud

See päring võimaldab hankida teie praegust kontojääki, võimaldades automatiseerida protsesse vastavalt teie krediidistaatusele. See töötab sujuvalt koos madala krediidi teavituskirjadega, mida saate seadistada oma maksete lehel.

Päring Edukas vastus Veavastus

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

{
    "balance":"1002.90"
}

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`balance`	string	Teie praegune kontojääk eurodes. Kümnendväärtus stringi tüübina.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/pingavalik

See lõpp-punkt saadab API-le ping-päringu, pakkudes lihtsat meetodit ühenduse testimiseks HLR Lookups API-ga.

Päring Edukas vastus Veavastus

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

{
    "success":true
}

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`success`	boolean	Näitab, et päring töödeldud edukalt.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/timeavalik

See lõpp-punkt tagastab Unix-ajatempli, mis esindab HLR Lookups serveri praegust aega. Kasutage seda oma serveri kella sünkroniseerimiseks autentimise Digest-Auth allkirja genereerimisel, tagamaks et teie serveri aja ja HLR Lookups serveri aja vaheline erinevus korrigeeritakse.

Päring Edukas vastus Veavastus

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

{
    "time":1525898643
}

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`time`	integer	Unix-ajatempel, mis esindab HLR Lookups serveri praegust aega.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

GET/auth-testkaitstud

See lõpp-punkt toimib algse testina teie Basic-Auth või eelistatavalt Digest-Auth rakenduse jaoks.

Basic Auth päring Digest Auth päring Edukas vastus Veavastus

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

Päringu päised

Võti	Tüüp	Kirjeldus
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` SHA256 räsi. Kaasake räsisse kooloni sümbol (:).

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"

Päringu päised

Võti	Tüüp	Kirjeldus
`X-Digest-Key`	string	Teie HLR Lookups API võti
`X-Digest-Signature`	string	Unikaalne Digest-Auth allkiri (vt autentimine)
`X-Digest-Timestamp`	integer	Praegune Unix ajatempel (vt ka `GET /time`)

{
    "success":true
}

Eduka vastuse atribuudid

Nimi	Tüüp	Kirjeldus	Nullitav
`success`	boolean	Näitab, et päring töödeldud edukalt.	false

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

Veavastuse parameetrid

Nimi	Tüüp	Kirjeldus	Nullitav
`errors[]`	string[]	Nimekiri stringidest, mis selgitavad viga.	false

Keri üles

Vana API dokumentatsioon

Palun pange tähele, et vana API on aegunud ja selle kasutuselt kõrvaldamine on planeeritud tulevikus. Soovitame tungivalt võimalikult kiiresti üle minna uusimale versioonile.

Kui rakendasite meie HLR Lookups API vahemikus 2013 kuni 2020 algus, kasutate meie vana API-t. Sel juhul tutvuge palun meie vana API dokumentatsiooniga.

Vana API dokumentatsioon

API dokumentatsioon

Alustamine

HLR päringud

MNP päringud

NT päringud

Marsruutimine

Hinnad

Tööriistad

Alustamine

HLR Lookups API kasutamine

Näidispäring

Näidisandmed

Edukas vastus application/json

Täiendavad päringteenused

Numbri ülekantavuse (MNP) päringud

Numbri tüübi tuvastamise (NT) päringud

Tarkvaraarenduse komplektid (SDK-d)

Tööriistad

Pole arendaja?

Autentimine

API võti ja API saladus

HTTP Basic Auth

Soovitatav: X-Basic päis koos SHA256-ga

Basic Auth päring

Basic Authentication päised

Koodinäide

Päringu näide

Päringu päised

Allkirja koostamine

Digest allkirja komponendid

Koodinäited

Mõisted

Sünkroonne HLR päringu API

Asünkroonne HLR päringute API

SDK-d (tarkvaraarenduse komplektid)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupkaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid

POST/hlr-lookupskaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid

Webhookide töötlemine

Autentimine

Koodinäide

Kättesaamise kinnitamine

Webhooki andmemaht

Webhooki andmete atribuudid

POST/mnp-lookupkaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid

POST/mnp-lookupskaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid

Webhookide töötlemine

Autentimine

Koodinäide

Kättesaamise kinnitamine

Webhooki andmemaht

Webhooki andmete atribuudid

POST/nt-lookupkaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid

POST/nt-lookups kaitstud

Andmekoormus

Päringu parameetrid

Eduka vastuse atribuudid

Veavastuse parameetrid