Darba sākšana

Globālā mobilo tīklu infrastruktūra darbojas uz sistēmas, kas pazīstama kā SS7 signalizācijas tīkls. Šis tīkls nodrošina abonentu datu apmaiņu, zvanu maršrutēšanu, SMS pārsūtīšanu un reāllaika mobilās savienojamības statusa atjauninājumus starp operatoriem. Katrs mobilais tīkls uztur mājas atrašanās vietas reģistru (HLR) - pamata datubāzi, kurā glabājas būtiska informācija par tā abonentiem.

HLR Lookup tehnoloģija ļauj uzņēmumiem vaicāt šos reģistrus un iegūt reāllaika savienojamības un tīkla informāciju par jebkuru mobilo tālruņa numuru. Tas ietver informāciju par to, vai tālrunis ir ieslēgts, kuram tīklam tas pašlaik ir piešķirts, vai tas ir pārportēts, vai numurs ir derīgs vai deaktivēts, kā arī vai tas atrodas viesabonēšanā.

HLR Lookups API nodrošina netraucētu reāllaika piekļuvi šiem datiem, ļaujot uzņēmumiem verificēt mobilos numurus, optimizēt maršrutēšanu un uzlabot klientu komunikāciju. Šī dokumentācija palīdzēs jums integrēt HLR Lookups savā programmā, nodrošinot automātisku reāllaika mobilās informācijas iegūšanu.

HLR Lookups API izmantošana

HLR Lookup vaicājumu izpilde ir ātra, droša un vienkārša. Pēc reģistrācijas un API atslēgas saņemšanas varat veikt autentifikāciju un uzsākt tūlītējus vaicājumus ar vienkāršiem HTTP POST pieprasījumiem, izmantojot POST /hlr-lookup. Alternatīvi varat apstrādāt lielas datu kopas, izvēloties ātrus asinhronu API pieprasījumus ar rezultātiem, kas tiek nosūtīti atpakaļ uz jūsu serveri caur webhook, kā izskaidrots koncepciju sadaļā.

Pieprasījuma piemērs

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"

Autentifikācija tiek nodrošināta caur HTTP galvenēm, un payload.json failā (minimāli) jābūt šādam JSON objektam:

Datu slodzes piemērs

{
   "msisdn": "+14156226819"
}

Pēc veiksmīgas izpildes saņemsiet atbildi ar reāllaika savienojamības informāciju par norādīto mobilo numuru.

Veiksmīga atbilde 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"
}

Pilnīgam pieprasījuma un atbildes atribūtu un savienojamības statusu pārskatam skatiet POST /hlr-lookup.

Papildu vaicājumu pakalpojumi

Numuru pārnesamības (MNP) vaicājumi

Izmantojiet MNP vaicājumus, lai noteiktu tīkla īpašumtiesības un pārnesamības informāciju bez reāllaika savienojamības vaicāšanas. Ja jums nepieciešams tikai numura MCCMNC, skatiet POST /mnp-lookup.

Numura tipa noteikšanas (NT) vaicājumi

Nosakiet, vai tālruņa numurs pieder fiksētajam tālrunim, mobilajam, maksas, VoIP, peidžerim vai citiem numerācijas plāna diapazoniem ar POST /nt-lookup.

Programmatūras izstrādes komplekti (SDK)

HLR Lookups API darbojas ar jebkuru REST klientu jebkurā programmēšanas valodā, un mēs esam publicējuši SDK PHP, Ruby un NodeJS valodām savā GitHub profilā, lai palīdzētu jums ātri sākt darbu.

Rīki

Lai nodrošinātu netraucētu izstrādes pieredzi, mēs piedāvājam visaptverošu rīku komplektu, ieskaitot pārlūkā pieejamu API pieprasījumu un webhook uzraudzību, IP adrešu baltā sarakstu, drošas autentifikācijas opcijas un autentifikācijas testa galapunktu.

Neesat izstrādātājs?

HLR Lookup un numuru pārnesamības vaicājumus var veikt bez programmēšanas. Uzziniet vairāk par mūsu uzņēmumu tīmekļa klientu un pārlūkā pieejamām pārskatu funkcijām.

Autentifikācija

Lai nodrošinātu drošību un pareizu piekļuves kontroli, lielākajai daļai pieprasījumu uz HLR Lookups API ir nepieciešama autentifikācija. Galapunkti ir kategorizēti kā publiski vai aizsargāti. Piekļūstot aizsargātam galapunktam, jūsu pieprasījumam ir jābūt autentificētam, izmantojot jūsu API atslēgu un noslēpumu, izmantojot vai nu Digest-Auth, vai Basic-Auth metodi. Digest-Auth ir drošākā opcija un tiek stingri ieteikta. Izmantojiet GET /auth-test galapunktu, lai pārbaudītu savu autentifikācijas iestatījumu.

API atslēga un API noslēpums

Iegūstiet savu API atslēgu un noslēpumu no API iestatījumu lapas. Varat arī konfigurēt savu vēlamo autentifikācijas metodi un iespējot IP adrešu baltā saraksta funkciju papildu drošībai. Ja aizdomas, ka jūsu API noslēpums ir ticis apdraudēts, jūs jebkurā laikā varat izveidot jaunu.

Pamata autentifikācija Digest autentifikācija IP Baltais saraksts

Standarta pamata autentifikācija ir viegli ieviešama un plaši atbalstīta. Varat autentificēties, nododot savu API atslēgu un noslēpumu kā user:pass pāri HTTP pieprasījumā.

HTTP pamata autentifikācija

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

Tas nosūta Authorization galveni:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Ieteicams: X-Basic galvene ar SHA256

Uzlabotai drošībai varat nosūtīt SHA256 jaukšanas vērtību no saviem akreditācijas datiem, nevis pārsūtīt tos tieši kā base64. Lai izmantotu šo metodi, aprēķiniet sava YOUR_API_KEY:YOUR_API_SECRET pāra jaukšanas vērtību un nosūtiet to, izmantojot X-Basic galveni:

Pamata autentifikācijas pieprasījums

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

Pamata autentifikācijas galvenes

Atslēga	Tips	Apraksts
`X-Basic`	string	SHA256 jaukšanas vērtība no `YOUR_API_KEY:YOUR_API_SECRET`. Iekļaujiet kolu simbolu (:) jaukšanas vērtībā.	obligāts

Koda piemērs

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

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

Digest-Auth ir ieteicamā metode piekļuves nodrošināšanai aizsargātiem HLR Lookup API galapunktiem. Katrā pieprasījumā ir jāiekļauj šādas galvenes: X-Digest-Key, X-Digest-Signature un X-Digest-Timestamp, kas ir paskaidrotas zemāk.

Pieprasījuma piemērs

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"

Pieprasījuma galvenes

Atslēga	Tips	Apraksts
`X-Digest-Key`	string	Jūsu unikālā HLR Lookups API atslēga.	obligāts
`X-Digest-Signature`	string	Unikāls autentifikācijas paraksts (skatīt zemāk).	obligāts
`X-Digest-Timestamp`	integer	Pašreizējais Unix laika zīmogs (skatīt arī `GET /time`).	obligāts

Paraksta veidošana

X-Digest-Signature tiek izveidots, izmantojot SHA256 HMAC jaukšanas vērtību, kur jūsu API noslēpums ir kopīgā atslēga.

Jaukšanas vērtības virkne ir strukturēta šādi:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. simbols apzīmē virkņu savienošanu.

Digest paraksta komponenti

Komponents	Tips	Apraksts
`ENDPOINT_PATH`	string	Pieprasītais API galapunkts, piemēram, `/auth-test` ar mazajiem burtiem.
`UNIX_TIMESTAMP`	integer	Pašreizējais Unix laika zīmogs (jābūt 30 sekunžu ietvaros). Skatīt `GET /time`.
`REQUEST_METHOD`	string	Izmantotā HTTP metode, piemēram, `POST` vai `GET`.
`REQUEST_BODY`	string	Pieprasījuma pamatteksta dati. Iestatīt uz `null` `GET` pieprasījumiem.

Koda piemēri

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)

Ritināt uz augšu

Koncepcijas

HLR vaicājumu ieviešana jebkurā programmēšanas valodā vai sistēmā, izmantojot mūsu HTTP REST API, ir vienkārša un efektīva. Ar vienkāršu integrācijas procesu varat sākt vaicāt mobilos tīklus reāllaikā, lai iegūtu tūlītēju informāciju par tālruņa numura derīgumu, savienojamības statusu un maršrutēšanas detaļām.

Piemērotā API izvēle ir atkarīga no jūsu konkrētā lietošanas gadījuma. Ja jums nepieciešami reāllaika vaicājumu rezultāti lietojumprogrammām, piemēram, VoIP telefonija, krāpšanas atklāšana vai SMS maršrutēšana, sinhronais API ir labākā izvēle. Tomēr, ja jūsu lietošanas gadījums ietver liela apjoma apstrādi, masveida vaicājumus vai plaša mēroga datu pārbaudi, asinhronais API piedāvā optimizētu veiktspēju ar joslas platuma efektivitāti un partijas vaicājumu iespējām.

Konfigurējiet API, lai izmantotu vienu no mūsu pielāgotajām maršrutēšanas opcijām, optimizējot ātrumu, precizitāti un izmaksu efektivitāti. Varat arī saglabāt vaicājumu rezultātus krātuvēs, lai ērti lejupielādētu CSV un JSON pārskatus, kā arī veiktu detalizētu analītiku, izmantojot tīmekļa saskarni.

Sinhronais HLR vaicājumu API

POST /hlr-lookup galapunkts apstrādā vienu mobilā tālruņa numuru (MSISDN) vienā pieprasījumā un atgriež rezultātus tūlītēji HTTP atbildes tekstā. Rezultāti ir formatēti kā JSON un ir ideāli piemēroti reāllaika lietojumprogrammām, tostarp mobilā numura validācijai, zvanu maršrutēšanai un SMS ziņojumu piegādei.

Sinhronais API izsaukums sastāv no tiešā HTTP pieprasījuma un atbildes. Jūsu sistēma iesniedz vienu MSISDN (mobilo numuru) vienā pieprasījumā un saņem tūlītēju atbildi, kas satur reāllaika HLR vaicājumu rezultātus JSON formātā. Šis API ir optimizēts lietošanas gadījumiem, kuriem nepieciešama tūlītēja pārbaude un savienojamības kontrole, piemēram, krāpšanas atklāšana, VoIP zvanu maršrutēšana un SMS vārtejas optimizācija.

Asinhrona HLR Lookup API

POST /hlr-lookups galapunkts ir izstrādāts masveida un liela apjoma apstrādei, ļaujot iesniegt līdz 1,000 MSISDN vienā pieprasījumā. Tā vietā, lai atgrieztu rezultātus tūlītēji, šis API izmanto automatizētus webhook, lai pakāpeniski nosūtītu rezultātus uz jūsu serveri. Vaicājumu rezultāti tiek atgriezti kā JSON objekti, izmantojot HTTP POST atzvanīšanu.

Asinhronais API ir optimizēts ātrumam, efektivitātei un mērogojamībai. Tas novērš tīkla latentuma problēmas, kas saistītas ar sinhronajiem izsaukumiem, padarot to ideālu uzņēmumiem, kuriem nepieciešami augstas caurlaidspējas vaicājumi. Jūsu sistēma iesniedz līdz 1,000 MSISDN vienā pieprasījumā, un mūsu platforma tos apstrādā paralēli, piegādājot rezultātus atpakaļ uz jūsu serveri, izmantojot HTTP webhook partijās līdz 1,000 rezultātiem vienā atzvanīšanā.

SDK (programmatūras izstrādes komplekti)

Mūsu programmatūras izstrādes komplekti (SDK) PHP, NodeJS un Ruby valodām vienkāršo integrācijas procesu, ļaujot efektīvi un ar minimālām pūlēm izveidot savienojumu ar HLR Lookups API.

Šie SDK nodrošina gatavās funkcijas, autentifikācijas apstrādi un strukturētus API pieprasījumu veidnes, samazinot izstrādes laiku un nodrošinot labāko praksi.

Iepazīstieties ar pilnu pieejamo SDK sarakstu GitHub vietnē un sāciet integrāciju jau šodien.

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

Skatīt GitHub README.md

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

Skatīt GitHub README.md

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

Skatīt GitHub README.md

Ritināt uz augšu

POST/hlr-lookupaizsargāts

Veic sinhronu HLR vaicājumu, nodrošinot reāllaika mobilā tālruņa savienojamības un pārnesamības datus tieši no tīkla operatoriem. Šis galapunkts ir ideāli piemērots reāllaika datplūsmas scenārijiem, kad laika kritiskām lietotnēm nepieciešama tūlītēja pārbaude, vai tālruņa numurs pašlaik ir sasniedzams (pieslēgts) vai nepieejams (izslēgts). Turklāt tas palīdz atšķirt aktīvos numurus no nederīgiem, nezināmiem vai viltotiem.

Lielu datu kopu apstrādei, kam nav nepieciešami tūlītēji rezultāti, apsveriet asinhrono POST /hlr-lookups, kas ir optimizēts augstas veiktspējas pakešu apstrādei.

Ja jūsu galvenais mērķis ir iegūt mobilā numura pārnesamības datus (MCCMNC) un jums nav nepieciešams reāllaika savienojamības statuss, POST /mnp-lookup nodrošina rentablu alternatīvu mobilā numura pārnesamības vaicājumiem.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Statusa atsauce

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdn`	string	Mobilā tālruņa numurs (MSISDN), kas jāvaicā, norādīts starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819). Valsts kodi ir obligāti.	null	obligāts
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda maršrutu šim vaicājumam. Iestatiet uz `null` vai izlaidiet šo parametru, lai lietotu savu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labāko maršrutu šim vaicājumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls identifikators, kas piešķirts šim vaicājuma pieprasījumam.	false
`msisdn`	string	Mobilā tālruņa numurs, kas tiek vaicāts, formatēts starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819).	false
`connectivity_status`	string	Norāda, vai numura savienojamības statuss tika veiksmīgi iegūts. Iespējamās vērtības: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` vai `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Piecu vai sešu ciparu mobilās valsts kods (MCC) un mobilā tīkla kods (MNC), kas identificē tīklu, kurš pašlaik saistīts ar tālruņa numuru.	true
`mcc`	string(3)	Trīs ciparu mobilās valsts kods (MCC), kas identificē valsti, kurā tālruņa numurs ir reģistrēts.	true
`mnc`	string(2\|3)	Divu vai trīs ciparu mobilā tīkla kods (MNC), kas identificē konkrēto tīklu, kuram pieder tālruņa numurs.	true
`imsi`	string	Starptautiskā mobilā abonenta identitāte (IMSI), unikāls identifikators SIM kartei, kas saistīta ar šo numuru. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`msin`	string(10)	Mobilā abonementa identifikācijas numurs (MSIN) mobilā operatora datu bāzē. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`msc`	string(12)	Mobilā komutācijas centrs (MSC), kas pašlaik apkalpo šī abonenta sakarus. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`original_network_name`	string	Sākotnējā (vietējā) tīkla operatora nosaukums, kas saistīts ar šo numuru.	true
`original_country_name`	string	Pilns valsts nosaukums, kurā mobilais tālruņa numurs tika sākotnēji reģistrēts, norādīts angļu valodā.	true
`original_country_code`	string(2)	Divu simbolu ISO valsts kods, kas apzīmē valsti, kurā tālruņa numurs tika pirmo reizi piešķirts.	true
`original_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods), kas atbilst mobilā tālruņa numura sākotnējai valstij.	true
`is_ported`	boolean	Norāda, vai mobilais numurs ir pārcelts no sākotnējā tīkla uz citu operatoru.	true
`ported_network_name`	string	Tīkla operatora nosaukums, uz kuru mobilais numurs ir pārcelts, ja piemērojams.	true
`ported_country_name`	string	Valsts nosaukums, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`ported_country_code`	string(2)	Divu simbolu ISO valsts kods, kas apzīmē valsti, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`ported_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods) valstij, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`is_roaming`	boolean	Norāda, vai mobilais numurs pašlaik viesroamingā ārvalstu tīklā. Viesabonēšanas statusa pieejamība ir atkarīga no mobilā tīkla operatora.	true
`roaming_network_name`	string	Tīkla nosaukums, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_name`	string	Valsts nosaukums, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_code`	string(2)	Divu simbolu ISO valsts kods valstij, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods) valstij, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`cost`	string	Decimālā vērtība, kas attēlota kā virkne, norādot vaicājuma izmaksas EUR.	true
`timestamp`	string	W3C formātā norādīts laika zīmogs, ieskaitot laika joslu, kas precizē, kad vaicājums tika pabeigts.	true
`storage`	string	Glabātuves nosaukums, kurā tika saglabāti vaicājuma rezultāti. Tas atbilst pārskatu nosaukumiem un CSV lejupielādēm, kas pieejamas tīmekļa saskarnē.	true
`route`	string(3)	Trīs simbolu identifikators, kas norāda maršrutēšanas metodi, kas izmantota šim vaicājuma pieprasījumam.	true
`processing_status`	string	Vaicājuma apstrādes rezultāts. Iespējamās vērtības: `COMPLETED` (veiksmīgs), `REJECTED` (tīkls nesasniedzams, maksa nav piemērota) vai `FAILED` (apstrādes laikā radās kļūda).	false
`error_code`	integer	Izvēles iekšējais kļūdas kods, kas sniedz papildu diagnostikas informāciju klientu atbalstam.	true
`error_description`	string	Īss dotā kļūdas koda (ja tāds ir) skaidrojums angļu valodā vienkāršā tekstā.	true
`data_source`	string	Datu avots, kas izmantots šim pieprasījumam. Iespējamās vērtības: `LIVE_HLR` (reāllaika HLR vaicājums) vai `MNP_DB` (statiska mobilā numura pārnesamības datu bāze). Skatiet maršrutēšanas opcijas papildu informācijai.	false
`routing_instruction`	string	Ar kolu atdalīta virkne, kas apraksta pieprasījumā izmantoto maršrutēšanas instrukciju. Pirmā komponente ir `STATIC`, kad norādījāt maršrutu, vai `AUTO` automātiskai maršrutēšanai; otrā komponente ir maršruta identifikators, un automātiskās maršrutēšanas pieprasījumiem trešā komponente parāda izcelsmi, uz kuras pamata tiek pieņemts maršrutēšanas lēmums (t.i., `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."
    ]
}

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Statuss	Apraksts
CONNECTED	Numurs ir derīgs, un mērķa ierīce pašlaik ir savienota ar mobilo tīklu. Zvani, SMS un citi pakalpojumi vajadzētu veiksmīgi sasniegt saņēmēju.
ABSENT	Numurs ir derīgs, taču mērķa ierīce ir vai nu izslēgta, vai īslaicīgi atrodas ārpus tīkla pārklājuma zonas. Ziņojumi vai zvani var netikt piegādāti, līdz ierīce atkal izveidos savienojumu ar tīklu.
INVALID_MSISDN	Numurs ir nederīgs vai pašlaik nav piešķirts nevienam mobilā tīkla abonentam. Zvani un ziņojumi uz šo numuru neizdosies.
UNDETERMINED	Numura savienojamības statusu neizdevās noteikt. Tas var būt saistīts ar nederīgu numuru, SS7 kļūdas atbildi vai savienojuma trūkumu ar mērķa tīkla operatoru. Papildu diagnostikai pārbaudiet kļūdas kodu un tā apraksta lauku.

Ritināt uz augšu

POST/hlr-lookupsaizsargāts

Uzsāk asinhronu HLR vaicājumu partiju, iegūstot aktuālus mobilo tālruņu savienojamības un pārnesamības datus no tīkla operatoriem. Rezultāti tiek piegādāti caur webhook uz jūsu serveri. Šī metode ir optimizēta lielu numuru apjomu apstrādei, kuriem nav nepieciešama tūlītēja atbilde, piemēram, datubāzu tīrīšanai un verifikācijai. Reāllaika lietojumiem, piemēram, zvanu maršrutēšanai vai SMS piegādei, apsveriet POST /hlr-lookup galapunkta izmantošanu.

Šis galapunkts ir ideāls lielapjoma apstrādei, kad mērķis ir identificēt tālruņu numurus, kas pašlaik ir sasniedzami (savienoti) vai nepieejami (tālrunis izslēgts), vienlaikus izfiltrējot nederīgus, nepiešķirtus vai viltotus numurus. Papildus tas sniedz aktuālu pārnesamības statusu (MCCMNC) kopā ar savienojamības detaļām.

Pirms šī galapunkta izmantošanas pārliecinieties, ka ir konfigurēts webhook URL, lai asinhroni saņemtu vaicājumu rezultātus. Varat to iestatīt savos API iestatījumos.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Webhooks Statusa atsauce

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdns`	array	Mobilo tālruņu numuru (MSISDN) masīvs starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819). Vienā pieprasījumā varat iekļaut līdz 1000 numuriem.	null	obligāts
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda maršrutu šim vaicājumam. Iestatiet uz `null` vai izlaidiet šo parametru, lai lietotu savu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labāko maršrutu šim vaicājumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`accepted`	array	Objektu saraksts, kas satur unikālus identifikatorus un MSISDN, kuri ir pieņemti apstrādei.	false
`accepted_count`	integer	Kopējais MSISDN skaits, kas veiksmīgi pieņemti apstrādei.	false
`rejected`	array	Objektu saraksts, kas satur unikālus identifikatorus un MSISDN, kuri ir noraidīti apstrādei, parasti nederīgu numuru dēļ. Par noraidītajiem ierakstiem maksa netiek piemērota.	false
`rejected_count`	integer	Kopējais MSISDN skaits, kas noraidīti validācijas kļūdu dēļ.	false
`total_count`	integer	Kopējais pieņemto un noraidīto MSISDN skaits, kas tika iesniegti apstrādei.	false
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot kopējās izmaksas EUR par pieņemtajiem vaicājumiem.	false
`storage`	string	Krātuves nosaukums, kurā tiek pievienoti vaicājumu rezultāti, izmantots pārskatiem un CSV lejupielādēm caur tīmekļa saskarni.	false
`route`	string(3\|4)	Trīs vai četru rakstzīmju identifikators, kas norāda maršrutu, kurš izmantots šim vaicājuma pieprasījumam. Satur AUTO, ja tika pieprasīta uz numuru balstīta automātiskā maršrutēšana.	false
`webhook_urls`	array	Webhook URL, kas konfigurēti jūsu API iestatījumos. Rezultāti tiek nosūtīti atpakaļ šeit.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Tīmekļa āķu apstrāde

Pēc iesniegšanas mūsu platforma sāk apstrādāt norādītos tālruņa numurus un nosūta rezultātus uz iepriekš norādīto tīmekļa āķa URL jūsu serverī. Rezultāti tiek pārsūtīti kā HTTP POST pieprasījums ar JSON objektu pieprasījuma pamattekstā.

Autentifikācija

Autentificējiet tīmekļa āķi, pārbaudot X-Signatures HTTP galveni.

X-Signatures galvene satur ar semikolu atdalītu parakstu sarakstu. Katrs paraksts sarakstā tiek ģenerēts, izmantojot vienu no jūsu kontā konfigurētajiem API noslēpumiem. Lai verificētu tīmekļa āķi, ģenerējiet SHA-256 jaucējkodu, izmantojot savu API atslēgu, noslēpumu un neapstrādāto HTTP pamattekstu, un pēc tam salīdziniet to ar parakstiem sarakstā.

Sakritība apstiprina, ka pieprasījums ir autentisks un parakstīts ar jūsu kontrolētu noslēpumu.

Koda piemērs

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

Pieprasījums ir derīgs, ja jebkurš no galvenē norādītajiem parakstiem ir vienāds ar SHA256 jaucējkodu, kas aprēķināts no jūsu API atslēgas, noslēpuma un HTTP pamatteksta savienotās virknes.

Saņemšanas apstiprinājums

Jūsu serverim ir jāatbild ar HTTP statusa kodu 200 OK, lai apstiprinātu veiksmīgu saņemšanu. Ja tiek atgriezts jebkurš cits atbildes kods, notiek taimauts (10 sekundes) vai rodas jebkāda cita piegādes problēma, sistēma automātiski atkārtos tīmekļa āķa izsaukumu pēc vienas minūtes. Ja pieprasījums turpina neizdoties,atkārtotie mēģinājumi sekos eksponenciālās atpakaļatkāpes stratēģijai ar nākamajiem mēģinājumiem pēc 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minūtēm.

Šis atkārtoto mēģinājumu mehānisms nodrošina maksimālu uzticamību, piegādājot vaicājumu rezultātus jūsu infrastruktūrai. Tas samazina datu zuduma risku pagaidu tīkla problēmu vai servera dīkstāves dēļ.

Tīmekļa āķa saturs

{
   "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 slodzes atribūti

JSON objekts satur atribūtu type => HLR kopā ar atribūtu results, kas iekļauj vaicājumu objektu sarakstu, kā dokumentēts zemāk.

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls identifikators, kas piešķirts šim vaicājuma pieprasījumam.	false
`msisdn`	string	Mobilā tālruņa numurs, kas tiek vaicāts, formatēts starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819).	false
`connectivity_status`	string	Norāda, vai numura savienojamības statuss tika veiksmīgi iegūts. Iespējamās vērtības: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` vai `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Piecu vai sešu ciparu mobilās valsts kods (MCC) un mobilā tīkla kods (MNC), kas identificē tīklu, kurš pašlaik saistīts ar tālruņa numuru.	true
`mcc`	string(3)	Trīs ciparu mobilās valsts kods (MCC), kas identificē valsti, kurā tālruņa numurs ir reģistrēts.	true
`mnc`	string(2\|3)	Divu vai trīs ciparu mobilā tīkla kods (MNC), kas identificē konkrēto tīklu, kuram pieder tālruņa numurs.	true
`imsi`	string	Starptautiskā mobilā abonenta identitāte (IMSI), unikāls identifikators SIM kartei, kas saistīta ar šo numuru. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`msin`	string(10)	Mobilā abonementa identifikācijas numurs (MSIN) mobilā operatora datu bāzē. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`msc`	string(12)	Mobilā komutācijas centrs (MSC), kas pašlaik apkalpo šī abonenta sakarus. Pieejamība ir atkarīga no tīkla konfigurācijas.	true
`original_network_name`	string	Sākotnējā (vietējā) tīkla operatora nosaukums, kas saistīts ar šo numuru.	true
`original_country_name`	string	Pilns valsts nosaukums, kurā mobilais tālruņa numurs tika sākotnēji reģistrēts, norādīts angļu valodā.	true
`original_country_code`	string(2)	Divu simbolu ISO valsts kods, kas apzīmē valsti, kurā tālruņa numurs tika pirmo reizi piešķirts.	true
`original_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods), kas atbilst mobilā tālruņa numura sākotnējai valstij.	true
`is_ported`	boolean	Norāda, vai mobilais numurs ir pārcelts no sākotnējā tīkla uz citu operatoru.	true
`ported_network_name`	string	Tīkla operatora nosaukums, uz kuru mobilais numurs ir pārcelts, ja piemērojams.	true
`ported_country_name`	string	Valsts nosaukums, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`ported_country_code`	string(2)	Divu simbolu ISO valsts kods, kas apzīmē valsti, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`ported_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods) valstij, uz kuru mobilais numurs tika pārcelts, ja piemērojams.	true
`is_roaming`	boolean	Norāda, vai mobilais numurs pašlaik viesroamingā ārvalstu tīklā. Viesabonēšanas statusa pieejamība ir atkarīga no mobilā tīkla operatora.	true
`roaming_network_name`	string	Tīkla nosaukums, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_name`	string	Valsts nosaukums, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_code`	string(2)	Divu simbolu ISO valsts kods valstij, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`roaming_country_prefix`	string	Starptautiskais zvanu kods (valsts izsaukuma kods) valstij, kurā mobilais numurs pašlaik atrodas viesroamingā, ja piemērojams.	true
`cost`	string	Decimālā vērtība, kas attēlota kā virkne, norādot vaicājuma izmaksas EUR.	true
`timestamp`	string	W3C formātā norādīts laika zīmogs, ieskaitot laika joslu, kas precizē, kad vaicājums tika pabeigts.	true
`storage`	string	Glabātuves nosaukums, kurā tika saglabāti vaicājuma rezultāti. Tas atbilst pārskatu nosaukumiem un CSV lejupielādēm, kas pieejamas tīmekļa saskarnē.	true
`route`	string(3)	Trīs simbolu identifikators, kas norāda maršrutēšanas metodi, kas izmantota šim vaicājuma pieprasījumam.	true
`processing_status`	string	Vaicājuma apstrādes rezultāts. Iespējamās vērtības: `COMPLETED` (veiksmīgs), `REJECTED` (tīkls nesasniedzams, maksa nav piemērota) vai `FAILED` (apstrādes laikā radās kļūda).	false
`error_code`	integer	Izvēles iekšējais kļūdas kods, kas sniedz papildu diagnostikas informāciju klientu atbalstam.	true
`error_description`	string	Īss dotā kļūdas koda (ja tāds ir) skaidrojums angļu valodā vienkāršā tekstā.	true
`data_source`	string	Datu avots, kas izmantots šim pieprasījumam. Iespējamās vērtības: `LIVE_HLR` (reāllaika HLR vaicājums) vai `MNP_DB` (statiska mobilā numura pārnesamības datu bāze). Skatiet maršrutēšanas opcijas papildu informācijai.	false
`routing_instruction`	string	Ar kolu atdalīta virkne, kas apraksta pieprasījumā izmantoto maršrutēšanas instrukciju. Pirmā komponente ir `STATIC`, kad norādījāt maršrutu, vai `AUTO` automātiskai maršrutēšanai; otrā komponente ir maršruta identifikators, un automātiskās maršrutēšanas pieprasījumiem trešā komponente parāda izcelsmi, uz kuras pamata tiek pieņemts maršrutēšanas lēmums (t.i., `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

Statuss	Apraksts
CONNECTED	Numurs ir derīgs, un mērķa ierīce pašlaik ir savienota ar mobilo tīklu. Zvani, SMS un citi pakalpojumi vajadzētu veiksmīgi sasniegt saņēmēju.
ABSENT	Numurs ir derīgs, taču mērķa ierīce ir vai nu izslēgta, vai īslaicīgi atrodas ārpus tīkla pārklājuma zonas. Ziņojumi vai zvani var netikt piegādāti, līdz ierīce atkal izveidos savienojumu ar tīklu.
INVALID_MSISDN	Numurs ir nederīgs vai pašlaik nav piešķirts nevienam mobilā tīkla abonentam. Zvani un ziņojumi uz šo numuru neizdosies.
UNDETERMINED	Numura savienojamības statusu neizdevās noteikt. Tas var būt saistīts ar nederīgu numuru, SS7 kļūdas atbildi vai savienojuma trūkumu ar mērķa tīkla operatoru. Papildu diagnostikai pārbaudiet kļūdas kodu un tā apraksta lauku.

Ritināt uz augšu

POST/mnp-lookupaizsargāts

Veic sinhronu MNP vaicājumu un sniedz mobilo numuru pārnesamības un tīkla informāciju. Šis galapunkts ir piemērots, ja jūsu galvenais mērķis ir reāllaikā iegūt konkrēta mobilā tālruņa numura pašreizējo MCCMNC un noteikt sākotnējo un pašreizējo tīklu.

Lielu datu kopu apstrādei, kam nav nepieciešami tūlītēji rezultāti, apsveriet asinhrono POST /mnp-lookups, kas ir optimizēts augstas veiktspējas pakešu apstrādei.

MNP vaicājumi ticami nosaka pārnesamības un tīkla informāciju, bet nenorāda, vai mērķa mobilais tālrunis pašlaik ir savienots ar tīklu un sasniedzams. Lai iegūtu reāllaika savienojamības informāciju, lūdzu, izmantojiet POST /hlr-lookup galapunktu.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdn`	string	Mobilā tālruņa numurs (MSISDN), kas jāvaicā, norādīts starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819). Valsts kodi ir obligāti.	null	obligāts
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda maršrutu šim vaicājumam. Iestatiet uz `null` vai izlaidiet šo parametru, lai lietotu savu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labāko maršrutu šim vaicājumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls 12 rakstzīmju identifikators šai vaicājumam.	false
`msisdn`	string	Mobilā tālruņa numurs, kas tika izvērtēts šajā vaicājumā.	false
`query_status`	string	Norāda, vai pārnesamības un tīkla informācijas iegūšana bija veiksmīga. Iespējamās vērtības ir `OK` vai `FAILED`.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju MCCMNC (mobilās valsts kods un mobilā tīkla koda pāris), kas identificē tīklu, kuram pašlaik pieder mobilā tālruņa numurs.	true
`mcc`	string(3)	Trīs rakstzīmju MCC (mobilās valsts kods), kas apzīmē valsti, kura saistīta ar mobilā tālruņa numura pašreizējo tīklu.	true
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju MNC (mobilā tīkla kods), kas identificē pašreizējo tīkla operatoru mobilajam tālruņa numuram.	true
`is_ported`	boolean	Norāda, vai tālruņa numurs ir pārcelts no sākotnējā tīkla uz jaunu operatoru.	true
`original_network_name`	string	Patvaļīga virkne (angļu valodā), kas norāda pārbaudītā mobilā tālruņa numura sākotnējā tīkla operatora nosaukumu.	true
`original_country_name`	string	Patvaļīga virkne (angļu valodā), kas norāda pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`original_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas apzīmē pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`original_country_prefix`	string	Sākotnējās valsts starptautiskais zvanīšanas kods, kas saistīts ar pārbaudīto mobilo tālruņa numuru.	true
`ported_network_name`	string	Norāda tīkla operatoru, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_name`	string	Norāda valsti, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas apzīmē valsti, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_prefix`	string	Starptautiskais zvanīšanas kods valstij, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`extra`	string	Patvaļīga virkne, kas sniedz papildu detaļas par tālruņa numuru, ja nepieciešams.	true
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot izmaksas EUR par šo vaicājumu.	true
`timestamp`	string	W3C formāta laika zīmogs ar laika joslas informāciju, kas norāda, kad vaicājums tika pabeigts.	true
`storage`	string	Glabāšanas nosaukums (vai atskaites nosaukums), kuram tika pievienoti vaicājuma rezultāti. Tas tiek izmantots CSV lejupielādēm un atskaitēm tīmekļa saskarnē.	true
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš tika izmantots šim vaicājumam.	true
`error_code`	integer	Neobligāts iekšējais kļūdas kods, kas sniedz papildu kontekstu klientu atbalsta diagnostikai.	true

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

POST/mnp-lookupsaizsargāts

Uzsāk asinhronu MNP (mobilo numuru pārnesamības) meklējumu partiju, izgūstot pašreizējo MCCMNC un reāllaikā nosakot sākotnējo un pašreizējo tīklu. Rezultāti tiek piegādāti caur webhook uz jūsu serveri. Šī metode ir optimizēta lielu numuru apjomu apstrādei, kuriem nav nepieciešama tūlītēja atbilde, piemēram, datubāzu tīrīšanai un verifikācijai. Reāllaika lietojumiem, piemēram, zvanu maršrutēšanai vai SMS piegādei, apsveriet POST /mnp-lookup galapunkta izmantošanu.

MNP vaicājumi ticami nosaka pārnesamības un tīkla informāciju, bet nenorāda, vai mērķa mobilais tālrunis pašlaik ir savienots ar tīklu un sasniedzams. Lai iegūtu reāllaika savienojamības informāciju, lūdzu, izmantojiet POST /hlr-lookups galapunktu.

Pirms šī galapunkta izmantošanas pārliecinieties, ka ir konfigurēts webhook URL, lai asinhroni saņemtu vaicājumu rezultātus. Varat to iestatīt savos API iestatījumos.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Webhooks

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdns`	array	Mobilo tālruņu numuru (MSISDN) masīvs starptautiskajā formātā (piemēram, +14156226819 vai 0014156226819). Vienā pieprasījumā varat iekļaut līdz 1000 numuriem.	null	obligāts
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda šī meklējuma maršrutu. Iestatiet uz `null` vai izlaidiet šo parametru, lai piemērotu savu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labākos maršrutus šim pieprasījumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`accepted`	array	Objektu saraksts, kas satur unikālus identifikatorus un MSISDN, kuri ir pieņemti apstrādei.	false
`accepted_count`	integer	Kopējais MSISDN skaits, kas veiksmīgi pieņemti apstrādei.	false
`rejected`	array	Objektu saraksts, kas satur unikālus identifikatorus un MSISDN, kuri ir noraidīti apstrādei, parasti nederīgu numuru dēļ. Par noraidītajiem ierakstiem maksa netiek piemērota.	false
`rejected_count`	integer	Kopējais MSISDN skaits, kas noraidīti validācijas kļūdu dēļ.	false
`total_count`	integer	Kopējais pieņemto un noraidīto MSISDN skaits, kas tika iesniegti apstrādei.	false
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot kopējās izmaksas EUR par pieņemtajiem vaicājumiem.	false
`storage`	string	Krātuves nosaukums, kurā tiek pievienoti vaicājumu rezultāti, izmantots pārskatiem un CSV lejupielādēm caur tīmekļa saskarni.	false
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš tika izmantots šim vaicājumam.	false
`webhook_urls`	array	Webhook URL, kas konfigurēti jūsu API iestatījumos. Rezultāti tiek nosūtīti atpakaļ šeit.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Tīmekļa āķu apstrāde

Pēc iesniegšanas mūsu platforma sāk apstrādāt norādītos tālruņa numurus un nosūta rezultātus uz iepriekš norādīto tīmekļa āķa URL jūsu serverī. Rezultāti tiek pārsūtīti kā HTTP POST pieprasījums ar JSON objektu pieprasījuma pamattekstā.

Autentifikācija

Autentificējiet tīmekļa āķi, pārbaudot X-Signatures HTTP galveni.

X-Signatures galvene satur ar semikolu atdalītu parakstu sarakstu. Katrs paraksts sarakstā tiek ģenerēts, izmantojot vienu no jūsu kontā konfigurētajiem API noslēpumiem. Lai verificētu tīmekļa āķi, ģenerējiet SHA-256 jaucējkodu, izmantojot savu API atslēgu, noslēpumu un neapstrādāto HTTP pamattekstu, un pēc tam salīdziniet to ar parakstiem sarakstā.

Sakritība apstiprina, ka pieprasījums ir autentisks un parakstīts ar jūsu kontrolētu noslēpumu.

Koda piemērs

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

Pieprasījums ir derīgs, ja jebkurš no galvenē norādītajiem parakstiem ir vienāds ar SHA256 jaucējkodu, kas aprēķināts no jūsu API atslēgas, noslēpuma un HTTP pamatteksta savienotās virknes.

Saņemšanas apstiprinājums

Jūsu serverim ir jāatbild ar HTTP statusa kodu 200 OK, lai apstiprinātu veiksmīgu saņemšanu. Ja tiek atgriezts jebkurš cits atbildes kods, notiek taimauts (10 sekundes) vai rodas jebkāda cita piegādes problēma, sistēma automātiski atkārtos tīmekļa āķa izsaukumu pēc vienas minūtes. Ja pieprasījums turpina neizdoties,atkārtotie mēģinājumi sekos eksponenciālās atpakaļatkāpes stratēģijai ar nākamajiem mēģinājumiem pēc 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minūtēm.

Šis atkārtoto mēģinājumu mehānisms nodrošina maksimālu uzticamību, piegādājot vaicājumu rezultātus jūsu infrastruktūrai. Tas samazina datu zuduma risku pagaidu tīkla problēmu vai servera dīkstāves dēļ.

Tīmekļa āķa saturs

{
    "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 slodzes atribūti

JSON objekts satur atribūtu type => MNP kopā ar atribūtu results, kas iekļauj vaicājumu objektu sarakstu, kā dokumentēts zemāk.

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls 12 rakstzīmju identifikators šai vaicājumam.	false
`msisdn`	string	Mobilā tālruņa numurs, kas tika izvērtēts šajā vaicājumā.	false
`query_status`	string	Norāda, vai pārnesamības un tīkla informācijas iegūšana bija veiksmīga. Iespējamās vērtības ir `OK` vai `FAILED`.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju MCCMNC (mobilās valsts kods un mobilā tīkla koda pāris), kas identificē tīklu, kuram pašlaik pieder mobilā tālruņa numurs.	true
`mcc`	string(3)	Trīs rakstzīmju MCC (mobilās valsts kods), kas apzīmē valsti, kura saistīta ar mobilā tālruņa numura pašreizējo tīklu.	true
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju MNC (mobilā tīkla kods), kas identificē pašreizējo tīkla operatoru mobilajam tālruņa numuram.	true
`is_ported`	boolean	Norāda, vai tālruņa numurs ir pārcelts no sākotnējā tīkla uz jaunu operatoru.	true
`original_network_name`	string	Patvaļīga virkne (angļu valodā), kas norāda pārbaudītā mobilā tālruņa numura sākotnējā tīkla operatora nosaukumu.	true
`original_country_name`	string	Patvaļīga virkne (angļu valodā), kas norāda pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`original_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas apzīmē pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`original_country_prefix`	string	Sākotnējās valsts starptautiskais zvanīšanas kods, kas saistīts ar pārbaudīto mobilo tālruņa numuru.	true
`ported_network_name`	string	Norāda tīkla operatoru, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_name`	string	Norāda valsti, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas apzīmē valsti, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`ported_country_prefix`	string	Starptautiskais zvanīšanas kods valstij, uz kuru pārbaudītais mobilais tālruņa numurs ir pārcelts, ja piemērojams.	true
`extra`	string	Patvaļīga virkne, kas sniedz papildu detaļas par tālruņa numuru, ja nepieciešams.	true
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot izmaksas EUR par šo vaicājumu.	true
`timestamp`	string	W3C formāta laika zīmogs ar laika joslas informāciju, kas norāda, kad vaicājums tika pabeigts.	true
`storage`	string	Glabāšanas nosaukums (vai atskaites nosaukums), kuram tika pievienoti vaicājuma rezultāti. Tas tiek izmantots CSV lejupielādēm un atskaitēm tīmekļa saskarnē.	true
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš tika izmantots šim vaicājumam.	true
`error_code`	integer	Neobligāts iekšējais kļūdas kods, kas sniedz papildu kontekstu klientu atbalsta diagnostikai.	true

Ritināt uz augšu

POST/nt-lookupaizsargāts

Veic sinhronu numura tipa (NT) pārbaudi. Šis galapunkts ir ideāls, ja jūsu galvenais mērķis ir reāllaikā noteikt, vai norādītie tālruņa numuri pieder fiksētās telefonijas, mobilās telefonijas, premium tarifu, VoIP, peidžeru vai citiem numerācijas plāna diapazoniem.

NT vaicājumi ticami nosaka tālruņa numura tipu, taču tie nenorāda, vai mērķa numurs pašlaik ir pieslēgts tīklam un sasniedzams. Lai iegūtu reāllaika savienojamības informāciju, lūdzu, izmantojiet POST /hlr-lookup galapunktu.

Ja jūsu lietošanas gadījumam nepieciešama precīza tīkla un pārnesamības informācija (MCCMNC), bet nav nepieciešams reāllaika savienojamības statuss, lūdzu, izmantojiet POST /mnp-lookup galapunktu mobilo numuru pārnesamības vaicājumiem.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Tipu atsauce

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`number`	string	Tālruņa numurs starptautiskajā formātā (piemēram, +4989702626 vai 004989702626).	null	mandatory
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda maršrutu šai pārbaudei. Iestatiet uz `null` vai izlaidiet šo parametru, lai piemērotu savu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labākos maršrutus šim pieprasījumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls identifikators, kas piešķirts šim vaicājuma pieprasījumam.	false
`number`	string	Tālruņa numurs, kas tika izvērtēts šī vaicājuma laikā.	false
`number_type`	string	Noteiktais numura tips. Iespējamās vērtības: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Norāda, vai numura tipa informācija tika veiksmīgi iegūta. Atgriež `OK`, ja veiksmīgi, vai `FAILED`, ja vaicājums neizdevās.	false
`is_valid`	boolean	Norāda, vai tālruņa numurs ir sintaktiski derīgs.	true
`invalid_reason`	string	Vienkāršs teksta ziņojums angļu valodā, kas norāda, kāpēc tālruņa numurs tiek uzskatīts par nederīgu (piemēram, "too short" vai "invalid prefix"), vai `null`, ja numurs ir derīgs.	true
`is_possibly_ported`	boolean	Norāda, vai tālruņa numurs, iespējams, ir pārcelts no sākotnējā operatora uz citu sakaru operatoru. Precīzai pārcelšanas informācijai izmantojiet MNP vaicājumus.	true
`is_vanity_number`	boolean	Norāda, vai tālruņa numurs ir vanity numurs, kas nozīmē, ka tajā ir alfabētiskie rakstzīmes.	true
`qualifies_for_hlr_lookup`	boolean	Norāda, vai tālruņa numurs ir piemērots papildu vaicājumiem, izmantojot HLR vaicājumus.	true
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju virkne, kas apzīmē MCCMNC pāri (mobilā valsts kods un mobilā tīkla kods), kas identificē mobilā tālruņa numura sākotnējo tīklu.	true
`mcc`	string(3)	Trīs rakstzīmju virkne, kas apzīmē MCC (mobilā valsts kods), kas identificē valsti, kura saistīta ar tālruņa numura sākotnējo mobilo tīklu.	true
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju virkne, kas apzīmē MNC (mobilā tīkla kods), kas identificē tālruņa numura sākotnējo mobilā tīkla operatoru.	true
`original_network_name`	string	Patvaļīga vienkārša teksta virkne angļu valodā, kas norāda pārbaudītā mobilā tālruņa numura sākotnējā tīkla operatora nosaukumu.	true
`original_country_name`	string	Patvaļīga vienkārša teksta virkne angļu valodā, kas norāda sākotnējo valsti, kura saistīta ar pārbaudīto mobilo tālruņa numuru.	true
`original_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas norāda pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`regions`	array	Saraksts ar cilvēkiem lasāmām virknēm angļu valodā, kas norāda ģeogrāfisko reģionu(-us), kas saistīts(-i) ar šo tālruņa numuru.	true
`timezones`	array	Saraksts ar laika joslām (Olson formātā), kas saistītas ar šo tālruņa numuru.	true
`info_text`	string	Patvaļīga virkne, kas var saturēt papildu informāciju par tālruņa numuru.	true
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot šī vaicājuma izmaksas (EUR).	true
`timestamp`	string	W3C formāta laika zīmogs (ieskaitot laika joslu), kas norāda, kad vaicājums tika pabeigts.	true
`storage`	string	Norāda krātuves nosaukumu, kur vaicājuma rezultāti ir pievienoti. Tas atbilst atskaites nosaukumam, kas tiek izmantots CSV lejupielādēm un analītikai tīmekļa saskarnē.	true
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš tika izmantots šim vaicājumam.	true

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Tips	Apraksts
LANDLINE	Stacionārā tālruņa numurs.
MOBILE	Mobilā tālruņa numurs. Der HLR vaicājumiem, lai iegūtu papildu informāciju par savienojuma statusu, tīklu, pārnesamību un viesabonēšanu.
MOBILE_OR_LANDLINE	Stacionārā vai mobilā tālruņa numurs. Iespējams, der HLR vaicājumam.
TOLL_FREE	Bezmaksas tālruņa numurs.
PREMIUM_RATE	Maksas tālruņa numurs ar papildu tarifiem.
SHARED_COST	Dalītās izmaksas tālruņa numurs. Parasti lētāks nekā maksas tālruņa numuri.
VOIP	Balss pār IP tālruņa numurs. Ietver TSoIP tālruņa numurus (telefonijas pakalpojums pār IP).
PAGER	Peidžera tālruņa numurs. Parasti bez balss funkcionalitātes.
UAN	Universālās piekļuves numurs (uzņēmuma numurs). Var tikt novirzīts uz konkrētām birojiem, bet ļauj uzņēmumam izmantot vienu numuru.
VOICEMAIL	Balss pasta tālruņa numurs.
UNKNOWN	Numura tipu neizdevās noteikt.

Ritināt uz augšu

POST/nt-lookups aizsargāts

Šis galapunkts veic vairākas asinhronas numura tipa pārbaudes, kuru rezultāti tiek nosūtīti uz jūsu serveri caur webhook. Tas ir piemērots, ja jūsu galvenais mērķis ir noteikt, vai norādītie tālruņa numuri pieder fiksēto tālruņu, mobilo sakaru, maksas, VoIP, peidžeru vai citu numerācijas plānu diapazoniem. Optimizēts lielu numuru apjomu ātrai apstrādei, šis galapunkts ir ideāls lielapjoma operācijām (piemēram, datubāzu attīrīšanai). Reāllaika datplūsmai un laika kritisku lietojumu gadījumos, lūdzu, izmantojiet POST /nt-lookup galapunktu.

Lai izmantotu šo galapunktu, jums ir jānorāda webhook URL jūsu API iestatījumos.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Webhooks Tipu atsauce

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

Slodze

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`numbers`	array	Tālruņa numuru masīvs starptautiskajā formātā (piemēram, +14156226819 vai 004989702626). Vienā pieprasījumā var iekļaut maksimums 1000 numurus.	null	obligāts
`route`	string(3)	Neobligāts trīs rakstzīmju identifikators, kas norāda maršrutu šai pārbaudei. Iestatiet uz `null` vai izlaidiet šo parametru, lai piemērotu jūsu pielāgoto maršrutēšanas karti vai ļautu mūsu sistēmai automātiski noteikt labāko maršrutu šim pieprasījumam.	null	neobligāti
`storage`	string	Neobligāts glabāšanas identifikators, kas norāda pārskatu, kurā rezultāti tiks saglabāti manuālai pārskatīšanai, analītikai un ziņošanai. Sistēma automātiski pievieno laika zīmogu ar pašreizējo mēnesi. Ja izlaists vai iestatīts uz `null`, sistēma automātiski grupēs rezultātus pa mēnešiem ziņošanas nolūkos.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`accepted`	array	Objektu masīvs, no kuriem katrs satur unikālu identifikatoru un tālruņa numuru, kas pieņemts apstrādei.	false
`accepted_count`	integer	Kopējais apstrādei pieņemto tālruņa numuru skaits.	false
`rejected`	array	Objektu masīvs, no kuriem katrs satur unikālu identifikatoru un tālruņa numuru, kas noraidīts apstrādei. Parasti šie numuri ir nederīgi, un maksa netiek piemērota.	false
`rejected_count`	integer	Kopējais apstrādei noraidīto tālruņa numuru skaits.	false
`total_count`	integer	Kopējais apstrādei iesniegto pieņemto un noraidīto tālruņa numuru skaits.	false
`cost`	string	Virkne, kas apzīmē decimālvērtību, kura norāda šo pārbaužu izmaksas EUR.	false
`storage`	string	Krātuves (atskaites) nosaukums, kur pārbaudes rezultāti ir pievienoti. Šis nosaukums tiek izmantots CSV lejupielādēm un analītikai tīmekļa saskarnē.	false
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš izmantots šim pārbaudes pieprasījumam.	false
`webhook_urls`	array	Webhook URL, kas konfigurēti jūsu API iestatījumos. Rezultāti tiek nosūtīti atpakaļ šeit.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Tīmekļa āķu apstrāde

Pēc iesniegšanas mūsu platforma sāk apstrādāt norādītos tālruņa numurus un nosūta rezultātus uz iepriekš norādīto tīmekļa āķa URL jūsu serverī. Rezultāti tiek pārsūtīti kā HTTP POST pieprasījums ar JSON objektu pieprasījuma pamattekstā.

Autentifikācija

Autentificējiet tīmekļa āķi, pārbaudot X-Signatures HTTP galveni.

X-Signatures galvene satur ar semikolu atdalītu parakstu sarakstu. Katrs paraksts sarakstā tiek ģenerēts, izmantojot vienu no jūsu kontā konfigurētajiem API noslēpumiem. Lai verificētu tīmekļa āķi, ģenerējiet SHA-256 jaucējkodu, izmantojot savu API atslēgu, noslēpumu un neapstrādāto HTTP pamattekstu, un pēc tam salīdziniet to ar parakstiem sarakstā.

Sakritība apstiprina, ka pieprasījums ir autentisks un parakstīts ar jūsu kontrolētu noslēpumu.

Koda piemērs

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

Pieprasījums ir derīgs, ja jebkurš no galvenē norādītajiem parakstiem ir vienāds ar SHA256 jaucējkodu, kas aprēķināts no jūsu API atslēgas, noslēpuma un HTTP pamatteksta savienotās virknes.

Saņemšanas apstiprinājums

Jūsu serverim ir jāatbild ar HTTP statusa kodu 200 OK, lai apstiprinātu veiksmīgu saņemšanu. Ja tiek atgriezts jebkurš cits atbildes kods, notiek taimauts (10 sekundes) vai rodas jebkāda cita piegādes problēma, sistēma automātiski atkārtos tīmekļa āķa izsaukumu pēc vienas minūtes. Ja pieprasījums turpina neizdoties,atkārtotie mēģinājumi sekos eksponenciālās atpakaļatkāpes stratēģijai ar nākamajiem mēģinājumiem pēc 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minūtēm.

Šis atkārtoto mēģinājumu mehānisms nodrošina maksimālu uzticamību, piegādājot vaicājumu rezultātus jūsu infrastruktūrai. Tas samazina datu zuduma risku pagaidu tīkla problēmu vai servera dīkstāves dēļ.

Tīmekļa āķa saturs

{
   "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 slodzes atribūti

JSON objekts satur atribūtu type => NT kopā ar atribūtu results, kas iekļauj vaicājumu objektu sarakstu, kā dokumentēts zemāk.

Vārds	Tips	Apraksts	Var būt tukšs
`id`	string(12)	Unikāls identifikators, kas piešķirts šim vaicājuma pieprasījumam.	false
`number`	string	Tālruņa numurs, kas tika izvērtēts šī vaicājuma laikā.	false
`number_type`	string	Noteiktais numura tips. Iespējamās vērtības: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Norāda, vai numura tipa informācija tika veiksmīgi iegūta. Atgriež `OK`, ja veiksmīgi, vai `FAILED`, ja vaicājums neizdevās.	false
`is_valid`	boolean	Norāda, vai tālruņa numurs ir sintaktiski derīgs.	true
`invalid_reason`	string	Vienkāršs teksta ziņojums angļu valodā, kas norāda, kāpēc tālruņa numurs tiek uzskatīts par nederīgu (piemēram, "too short" vai "invalid prefix"), vai `null`, ja numurs ir derīgs.	true
`is_possibly_ported`	boolean	Norāda, vai tālruņa numurs, iespējams, ir pārcelts no sākotnējā operatora uz citu sakaru operatoru. Precīzai pārcelšanas informācijai izmantojiet MNP vaicājumus.	true
`is_vanity_number`	boolean	Norāda, vai tālruņa numurs ir vanity numurs, kas nozīmē, ka tajā ir alfabētiskie rakstzīmes.	true
`qualifies_for_hlr_lookup`	boolean	Norāda, vai tālruņa numurs ir piemērots papildu vaicājumiem, izmantojot HLR vaicājumus.	true
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju virkne, kas apzīmē MCCMNC pāri (mobilā valsts kods un mobilā tīkla kods), kas identificē mobilā tālruņa numura sākotnējo tīklu.	true
`mcc`	string(3)	Trīs rakstzīmju virkne, kas apzīmē MCC (mobilā valsts kods), kas identificē valsti, kura saistīta ar tālruņa numura sākotnējo mobilo tīklu.	true
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju virkne, kas apzīmē MNC (mobilā tīkla kods), kas identificē tālruņa numura sākotnējo mobilā tīkla operatoru.	true
`original_network_name`	string	Patvaļīga vienkārša teksta virkne angļu valodā, kas norāda pārbaudītā mobilā tālruņa numura sākotnējā tīkla operatora nosaukumu.	true
`original_country_name`	string	Patvaļīga vienkārša teksta virkne angļu valodā, kas norāda sākotnējo valsti, kura saistīta ar pārbaudīto mobilo tālruņa numuru.	true
`original_country_code`	string(2)	Divu rakstzīmju ISO valsts kods, kas norāda pārbaudītā mobilā tālruņa numura sākotnējo valsti.	true
`regions`	array	Saraksts ar cilvēkiem lasāmām virknēm angļu valodā, kas norāda ģeogrāfisko reģionu(-us), kas saistīts(-i) ar šo tālruņa numuru.	true
`timezones`	array	Saraksts ar laika joslām (Olson formātā), kas saistītas ar šo tālruņa numuru.	true
`info_text`	string	Patvaļīga virkne, kas var saturēt papildu informāciju par tālruņa numuru.	true
`cost`	string	Decimālvērtība, kas attēlota kā virkne, norādot šī vaicājuma izmaksas (EUR).	true
`timestamp`	string	W3C formāta laika zīmogs (ieskaitot laika joslu), kas norāda, kad vaicājums tika pabeigts.	true
`storage`	string	Norāda krātuves nosaukumu, kur vaicājuma rezultāti ir pievienoti. Tas atbilst atskaites nosaukumam, kas tiek izmantots CSV lejupielādēm un analītikai tīmekļa saskarnē.	true
`route`	string(3)	Trīs rakstzīmju identifikators, kas norāda maršrutu, kurš tika izmantots šim vaicājumam.	true

Tips	Apraksts
LANDLINE	Stacionārā tālruņa numurs.
MOBILE	Mobilā tālruņa numurs. Der HLR vaicājumiem, lai iegūtu papildu informāciju par savienojuma statusu, tīklu, pārnesamību un viesabonēšanu.
MOBILE_OR_LANDLINE	Stacionārā vai mobilā tālruņa numurs. Iespējams, der HLR vaicājumam.
TOLL_FREE	Bezmaksas tālruņa numurs.
PREMIUM_RATE	Maksas tālruņa numurs ar papildu tarifiem.
SHARED_COST	Dalītās izmaksas tālruņa numurs. Parasti lētāks nekā maksas tālruņa numuri.
VOIP	Balss pār IP tālruņa numurs. Ietver TSoIP tālruņa numurus (telefonijas pakalpojums pār IP).
PAGER	Peidžera tālruņa numurs. Parasti bez balss funkcionalitātes.
UAN	Universālās piekļuves numurs (uzņēmuma numurs). Var tikt novirzīts uz konkrētām birojiem, bet ļauj uzņēmumam izmantot vienu numuru.
VOICEMAIL	Balss pasta tālruņa numurs.
UNKNOWN	Numura tipu neizdevās noteikt.

Ritināt uz augšu

GET/routeaizsargāts

Atgriež maršrutu, kas tiks automātiski izvēlēts, veicot HLR vaicājumu bez route parametra norādīšanas.

Automātiskā maršruta izvēle balstās uz maršrutēšanas karti, ko var iegūt ar GET /hlr-coverage galapunktu, kas galvenokārt ir atvasināta no GET /routing-map. Jūs varat pielāgot savu maršrutēšanas karti un definēt pielāgotus noteikumus savos konta iestatījumos.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdn`	string	MSISDN, kuram jāiegūst automātiski izvēlētā maršrutēšanas informācija.	null	obligāts

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`route`	string	Ieteicamais maršruts.	false
`confidence_level`	string	Pārliecības līmenis, ar kādu šis maršruts tika izvēlēts, t.i. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Uz numerācijas plānu balstītais MCCMNC šim numuram.	false
`origin`	string	Avots, uz kura balstās maršrutēšanas lēmums, t.i. `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."
    ]
}

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/routesaizsargāts

Šis galapunkts atgriež pieejamo HLR, MNP un NT maršrutu sarakstu. Katrs maršruts kopā ar tā funkcijām un ierobežojumiem ir paskaidrots maršrutēšanas detaļu lapā.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`routes`	object	Objekts ar maršrutiem, kas grupēti pēc maršruta veida.	false
`HLR\|MNP\|NT`	string[]	Satur maršrutu identifikatoru sarakstu.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/routing-mapaizsargāts

Izgūst automatizētās maršrutēšanas konfigurāciju, kas pašlaik tiek lietota HLR vaicājumiem jūsu kontā. Šī noklusējuma konfigurācija tiek izmantota ikreiz, kad iesniedzat HLR vaicājumus, nenorādot route parametru. Varat pielāgot savu maršrutēšanas karti un izveidot pielāgotus noteikumus savos konta iestatījumos.

Konfigurācijas hierarhija kaskādē no valsts līmeņa noteikumiem uz MCCMNC līmeņa noteikumiem un beidzot uz atsevišķu tālruņa numuru prefiksu kartējumiem. Praksē tas nozīmē, ka atsevišķu tālruņa numuru prefiksu kartējumiem ir prioritāte pār konfliktējošiem MCCMNC piešķīrumiem, kas savukārt ignorē valsts līmeņa noteikumus. Lūdzu, ņemiet vērā, ka MNP atkāpšanās ignorē jebkurus konfliktējošus pielāgotos noteikumus, kamēr ir iespējota.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`default_route`	string	Noklusējuma maršruts, kas tiek izmantots, ja MSISDN nav iespējams noteikt vēlamo maršrutēšanas opciju un nav piemērojami pielāgoti maršrutēšanas noteikumi.	false
`mnp_fallback`	boolean	Norāda, vai MNP atkāpšanās ir iespējota. Ja iespējota un tīkls neatbalsta HLR vaicājumus (savienojamības statuss nav pieejams), sistēma tā vietā veiks MNP vaicājumu.	false
`mccmncs`	array	MCCMNC kodu kartējums ar to automātiski atlasītajiem maršrutiem. Veicot HLR vaicājumu numuram noteiktā MCCMNC, tiek izmantots atbilstošais maršruts.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju MCCMNC (mobilās valsts koda un mobilā tīkla koda kombinācija), kas identificē mobilo tīklu operatoru.	false
`countrycode`	string(2)	Divu rakstzīmju ISO valsts kods, kas identificē tīkla valsti.	false
`route`	string(3)	Atlasītais maršruts tīklam.	false
`mno`	string	Patērētājiem paredzētais zīmols, ar kuru darbojas šis tīkls.	false
`confidence`	string	Pārliecības līmenis, ar kādu atlase tika veikta. Iespējamās vērtības ir: HIGH, NORMAL, LOW, MNP_REDIRECT. Pēdējā gadījumā sistēma novirza trafiku uz šo tīklu uz MNP, ja šī funkcionalitāte ir iespējota jūsu kontā. Pretējā gadījumā tiek izmantots konta noklusējuma maršruts.	false
`origin`	string	Izcelsme, uz kuras pamata atlase tika veikta. Iespējamās vērtības ir: `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	Jūsu kontā konfigurēto pielāgoto prefiksu maršrutēšanas noteikumu saraksts, ja tādi ir.	false
`countrycode`	string(2)	Divu rakstzīmju ISO valsts kods, kas identificē prefiksa valsti.	false
`cns`	string	Prefikss, uz kuru attiecas maršrutēšanas noteikums.	false
`route`	string(3)	Atlasītais maršruts prefiksam.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju MCCMNC (mobilās valsts koda un mobilā tīkla koda kombinācija), kas identificē mobilo tīklu operatoru.	true
`mno`	string	Patērētājiem paredzētais zīmols, ar kuru darbojas šis tīkls.	true
`countries`	array	Jūsu kontā konfigurēto pielāgoto valstu noteikumu saraksts, ja tādi ir.	false
`countrycode`	string(2)	Divu rakstzīmju ISO valsts kods, kas identificē valsti.	false
`route`	string(3)	Atlasītais maršruts valstij.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/hlr-coverage aizsargāts

Atgriež HLR pārklājuma analīzi, lai atbalstītu lēmumus, kas balstīti uz datiem. Šis galapunkts palīdz analizēt reāllaika HLR maršrutēšanas opcijas mobilajos tīklos, identificēt visefektīvākos ceļus jūsu mērķa reģioniem un konfigurēt automātisko maršrutēšanu.

Ieteiktie maršruti no GET /route ir balstīti uz šeit iegūtajiem pārklājuma datiem. Pārklājuma dati ir pieejami arī tīkla pārklājuma lapā. Varat papildus pielāgot savu maršrutēšanas karti un definēt noteikumus savos konta iestatījumos.

Iesakām iepazīties ar šo rokasgrāmatu, lai palīdzētu interpretēt rezultātus.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde Statusa atsauce

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`countrycode`	string(2)	Obligāts divu burtu ISO valsts kods, ko izmanto rezultātu filtrēšanai, atgriežot tikai ierakstus, kas saistīti ar norādīto valsti.	null	obligāts
`sample_size`	string	Neobligāts parametrs, kas norāda izlases lielumu. Iespējamās vērtības ir `LARGE`, `MEDIUM`, `SMALL`. Lielākas izlases aptver garāku laika periodu, mazākas izlases aptver ļoti nesenu laika periodu.	LARGE	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`name`	string	Izvēlētās valsts nosaukums angļu valodā.	false
`countrycode`	string(2)	Izvēlētās valsts divu simbolu ISO valsts kods.	false
`prefix`	string	Izvēlētās valsts starptautiskais zvanīšanas prefikss.	false
`mccs`	string[]	MCC (mobilās valsts kodu) saraksts, kas saistīts ar izvēlēto valsti.	false
`carriers`	object[]	Operatoru objektu saraksts ar maršrutam specifiskiem savienojamības rādītājiem.	false
`mno`	string	Mobilā tīkla operatora nosaukums angļu valodā.	false
`mccmnc`	string	Mobilā tīkla operatora MCCMNC.	false
`mcc`	string	Mobilā tīkla operatora MCC (mobilās valsts kods).	false
`mnc`	string	Mobilā tīkla operatora MNC (mobilā tīkla kods).	false
`routes`	object[]	Maršrutam specifisku savienojamības rezultātu saraksts.	false
`route`	string	Maršruts, uz kuru attiecas savienojamības informācija.	false
`selected`	bool	Norāda, vai šis ir izvēlētais maršruts automatizētai maršrutēšanai.	false
`selection_confidence`	string	Pārliecības līmenis, ar kādu šis maršruts tika izvēlēts, t.i. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Satur null, ja šis nav izvēlētais maršruts.	true
`n`	int	Kopējais vaicājumu skaits šajā izlasē.	false
`CONNECTED`	int	HLR vaicājumu skaits, kas atgrieza CONNECTED statusu.	false
`CONNECTED_PCT`	float	HLR vaicājumu procentuālā daļa, kas atgrieza CONNECTED statusu.	false
`ABSENT`	int	HLR vaicājumu skaits, kas atgrieza ABSENT statusu.	false
`ABSENT_PCT`	float	HLR vaicājumu procentuālā daļa, kas atgrieza ABSENT statusu.	false
`INVALID_MSISDN`	int	HLR vaicājumu skaits, kas atgrieza INVALID_MSISDN statusu.	false
`INVALID_MSISDN_PCT`	float	HLR vaicājumu procentuālā daļa, kas atgrieza INVALID_MSISDN statusu.	false
`UNDETERMINED`	int	HLR vaicājumu skaits, kas atgrieza UNDETERMINED statusu.	false
`UNDETERMINED_PCT`	float	HLR vaicājumu procentuālā daļa, kas atgrieza UNDETERMINED statusu.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Statuss	Apraksts
CONNECTED	Numurs ir derīgs, un mērķa ierīce pašlaik ir savienota ar mobilo tīklu. Zvani, SMS un citi pakalpojumi vajadzētu veiksmīgi sasniegt saņēmēju.
ABSENT	Numurs ir derīgs, taču mērķa ierīce ir vai nu izslēgta, vai īslaicīgi atrodas ārpus tīkla pārklājuma zonas. Ziņojumi vai zvani var netikt piegādāti, līdz ierīce atkal izveidos savienojumu ar tīklu.
INVALID_MSISDN	Numurs ir nederīgs vai pašlaik nav piešķirts nevienam mobilā tīkla abonentam. Zvani un ziņojumi uz šo numuru neizdosies.
UNDETERMINED	Numura savienojamības statusu neizdevās noteikt. Tas var būt saistīts ar nederīgu numuru, SS7 kļūdas atbildi vai savienojuma trūkumu ar mērķa tīkla operatoru. Papildu diagnostikai pārbaudiet kļūdas kodu un tā apraksta lauku.

Ritināt uz augšu

GET/mnp-coverageaizsargāts

Šis galapunkts atgriež mobilo tīklu operatoru sarakstu kopā ar atbilstošajiem MCCMNC identifikatoriem, kas pašlaik tiek atbalstīti mobilo numuru pārnesamības pārbaudēm.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`countrycode`	string(2)	Neobligāts divu burtu ISO valsts kods, kas tiek izmantots MCCMNC rezultātu filtrēšanai, atgriežot tikai norādītajai valstij atbilstošus datus.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`items[]`	array	Mobilo tīklu operatoru saraksts.	false
`country_name`	string	Valsts nosaukums angļu valodā.	false
`country_code`	string(2)	Divu burtu ISO valsts kods.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju MCCMNC (mobilās valsts koda un mobilā tīkla koda kombinācija), kas identificē mobilo tīklu operatoru.	false
`mcc`	string(3)	Trīs rakstzīmju MCC (mobilās valsts kods), kas norāda tīkla valsti.	false
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju MNC (mobilā tīkla kods), kas norāda konkrēto mobilo tīklu operatoru.	false
`brand`	string	Patērētājiem paredzētais zīmols, ar kuru darbojas šis tīkls.	true
`operator`	string	Mobilā tīkla operatora juridiskais nosaukums.	true

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/price-listaizsargāts

Šis galapunkts atgriež valstu sarakstu, kurās tiek atbalstīti tikai MNP vaicājumi, un HLR vaicājumi šiem galamērķiem nav pieejami.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`countries`	string[]	Divu rakstzīmju ISO valstu kodu saraksts.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/mccmncsaizsargāts

Šis galapunkts atgriež visaptverošu mobilo tīklu operatoru sarakstu kopā ar to atbilstošajiem MCCMNC identifikatoriem un papildu kontekstuālo informāciju.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`countrycode`	string(2)	Neobligāts divu burtu ISO valsts kods, kas tiek izmantots MCCMNC rezultātu filtrēšanai, atgriežot tikai ierakstus, kas saistīti ar norādīto valsti.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`items`	object[]	Mobilo tīklu operatoru saraksts.	false
`country_name`	string	Pilns valsts nosaukums angļu valodā.	false
`country_code`	string(2)	Divu burtu ISO valsts kods, kas apzīmē mobilā operatora valsti.	false
`mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju virkne, kas apzīmē MCCMNC un unikāli identificē mobilo tīklu operatoru.	false
`mcc`	string(3)	Trīs rakstzīmju mobilās valsts kods (MCC), kas identificē valsti, kurā darbojas mobilais tīkls.	false
`mnc`	string(2\|3)	Divu vai trīs rakstzīmju mobilā tīkla kods (MNC), kas norāda mobilo tīklu noteiktajā MCC ietvaros.	false
`brand`	string	Komerciālais zīmola nosaukums, ar kuru tīkls darbojas un ir pazīstams patērētājiem.	true
`operator`	string	Oficiālais mobilā tīkla operatora nosaukums, parasti juridiskā persona, kas pārvalda tīklu.	true
`parent_mccmnc`	string(5\|6)	Piecu vai sešu rakstzīmju virkne, kas apzīmē pamata mobilā tīkla operatora MCCMNC, ja tāds ir.	true

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/priceaizsargāts

Šis galapunkts atgriež cenu HLR, MNP vai NT vaicājumam.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Pieprasījuma parametri

Atslēga	Tips	Apraksts	Noklusējums	Obligāts
`msisdn`	string	Tālruņa numurs, kuram jāiegūst cena. Starptautiskajā formātā.	null	obligāts
`route_type`	string	Maršruta tips, t.i. `HLR`, `MNP`, `NT`.	null	obligāts
`route`	string(3)	Maršruts, kuram jāaprēķina cena. Pēc noklusējuma tiek izmantots automātiskās maršrutēšanas noteiktais maršruts.	null	neobligāti

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`price`	object	Objekts ar cenu informāciju.	false
`amount`	string	Summa EUR.	false
`msisdn`	string	MSISDN, kuram piemērojama šī cena.	false
`route_type`	string(2\|3)	Maršruta tips, kuram piemērojama šī cena.	false
`route`	string(3)	Maršruts, kuram piemērojama šī cena.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/price-listaizsargāts

Šis galapunkts atgriež jūsu konta cenu informāciju.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`pricing`	object[]	Objektu saraksts ar cenu informāciju.	false
`route`	string	Maršruts, uz kuru attiecas šī cena.	false
`countrycode`	string	Divu burtu ISO valsts kods, uz kuru attiecas šī cena attiecīgajam maršrutam, ja piemērojams.	true
`countryname`	string	Angļu valodas valsts nosaukums, kas atbilst valsts kodam, ja piemērojams.	true
`mccmnc`	string	MCCMNC, uz kuru attiecas šī cena attiecīgajam maršrutam, ja piemērojams. Ignorē valsts līmeņa cenu.	true
`cns`	string	Zvanu prefikss, uz kuru attiecas šī cena attiecīgajam maršrutam, ja piemērojams. Ignorē valsts līmeņa cenu un MCCMNC līmeņa cenu.	true
`route_type`	string	Atbilstošais maršruta tips, t.i. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Atbilstošā cena EUR.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/balanceaizsargāts

Šis galapunkts iegūst jūsu pašreizējo konta atlikumu, ļaujot automatizēt procesus, pamatojoties uz jūsu kredīta statusu. Tas darbojas nevainojami kopā ar zema kredīta paziņojumu e-pastiem, kurus varat konfigurēt savā maksājumu lapā.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

{
    "balance":"1002.90"
}

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`balance`	string	Jūsu pašreizējais konta atlikums EUR. Decimālvērtība ar virknes tipu.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/pingpublisks

Šis galapunkts nosūta ping pieprasījumu uz API, nodrošinot vienkāršu metodi savienojuma pārbaudei ar HLR Lookups API.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

{
    "success":true
}

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`success`	boolean	Norāda, ka pieprasījums tika veiksmīgi apstrādāts.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/timepublisks

Šis galapunkts atgriež Unix laika zīmogu, kas reprezentē pašreizējo laiku HLR Lookups serverī. Izmantojiet to, lai sinhronizētu sava servera pulksteni, ģenerējot Digest-Auth parakstu autentifikācijai, nodrošinot, ka jebkādas neatbilstības starp jūsu servera laiku un HLR Lookups servera laiku tiek koriģētas.

Pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

{
    "time":1525898643
}

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`time`	integer	Unix laika zīmogs, kas reprezentē pašreizējo HLR Lookups servera laiku.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

GET/auth-testaizsargāts

Šis galapunkts kalpo kā sākotnējais tests jūsu Basic-Auth vai, vēlams, Digest-Auth ieviešanai.

Pamata autentifikācijas pieprasījums Digest Auth pieprasījums Veiksmīga atbilde Kļūdas atbilde

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

Pieprasījuma galvenes

Atslēga	Tips	Apraksts
`X-Basic`	string	SHA256 jaukšanas vērtība no `YOUR_API_KEY:YOUR_API_SECRET`. Iekļaujiet kolu simbolu (:) jaukšanas vērtībā.

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"

Pieprasījuma galvenes

Atslēga	Tips	Apraksts
`X-Digest-Key`	string	Jūsu HLR Lookups API atslēga
`X-Digest-Signature`	string	Unikāls Digest-Auth paraksts (skatīt autentifikācija)
`X-Digest-Timestamp`	integer	Pašreizējais Unix laika zīmogs (skatīt arī `GET /time`)

{
    "success":true
}

Veiksmīgas atbildes atribūti

Vārds	Tips	Apraksts	Var būt tukšs
`success`	boolean	Norāda, ka pieprasījums tika veiksmīgi apstrādāts.	false

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

Kļūdas atbildes parametri

Vārds	Tips	Apraksts	Var būt tukšs
`errors[]`	string[]	Saraksts ar teksta virkņu skaidrojumiem par kļūdu.	false

Ritināt uz augšu

Mantotā API dokumentācija

Lūdzu, ņemiet vērā, ka mantotā API ir novecojusi un tuvākajā nākotnē tiks izslēgta. Mēs iesakām pēc iespējas ātrāk pāriet uz jaunāko versiju.

Ja ieviešat mūsu HLR Lookups API laikā no 2013. līdz 2020. gada sākumam, jūs izmantojat mūsu mantoto API. Šajā gadījumā, lūdzu, skatiet mūsu mantotās API dokumentāciju.

Mantotā API dokumentācija

API dokumentācija

Darba sākšana

HLR vaicājumi

MNP vaicājumi

NT vaicājumi

Maršrutēšana

Cenrādis

Rīki

Darba sākšana

HLR Lookups API izmantošana

Pieprasījuma piemērs

Datu slodzes piemērs

Veiksmīga atbilde application/json

Papildu vaicājumu pakalpojumi

Numuru pārnesamības (MNP) vaicājumi

Numura tipa noteikšanas (NT) vaicājumi

Programmatūras izstrādes komplekti (SDK)

Rīki

Neesat izstrādātājs?

Autentifikācija

API atslēga un API noslēpums

HTTP pamata autentifikācija

Ieteicams: X-Basic galvene ar SHA256

Pamata autentifikācijas pieprasījums

Pamata autentifikācijas galvenes

Koda piemērs

Pieprasījuma piemērs

Pieprasījuma galvenes

Paraksta veidošana

Digest paraksta komponenti

Koda piemēri

Koncepcijas

Sinhronais HLR vaicājumu API

Asinhrona HLR Lookup API

SDK (programmatūras izstrādes komplekti)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupaizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri

POST/hlr-lookupsaizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri

Tīmekļa āķu apstrāde

Autentifikācija

Koda piemērs

Saņemšanas apstiprinājums

Tīmekļa āķa saturs

Webhook slodzes atribūti

POST/mnp-lookupaizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri

POST/mnp-lookupsaizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri

Tīmekļa āķu apstrāde

Autentifikācija

Koda piemērs

Saņemšanas apstiprinājums

Tīmekļa āķa saturs

Webhook slodzes atribūti

POST/nt-lookupaizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri

POST/nt-lookups aizsargāts

Slodze

Pieprasījuma parametri

Veiksmīgas atbildes atribūti

Kļūdas atbildes parametri