Aan die Gang Kom

Die globale mobiele netwerk-infrastruktuur werk op 'n stelsel bekend as die SS7-seinnetwerk. Hierdie netwerk fasiliteer die uitruil van intekenaardata, oproep-roetering, SMS-oordrag, en intydse mobiele konnektiwiteit statusopdaterings tussen diensverskaffers. Elke mobiele netwerk onderhou 'n Home Location Register (HLR) - 'n kerndatabasis wat noodsaaklike besonderhede oor sy intekenaars stoor.

HLR Lookup-tegnologie stel besighede in staat om hierdie registers te ondervra en lewendige konnektiwiteit en netwerkbesonderhede vir enige mobiele telefoonnommer op te haal. Dit sluit in of die foon aangeskakel is, aan watter netwerk dit tans toegewys is, of dit geporteer is, of die nommer geldig of gedeaktiveer is, en of dit swerwend is.

Die HLR Lookups API bied naatlose, intydse toegang tot hierdie data, wat besighede toelaat om mobiele nommers te verifieer, roetering te optimeer, en kliëntekommunikasie te verbeter. Hierdie dokumentasie sal u lei deur die integrasie van HLR Lookups in u sagteware, wat outomatiese ophaling van intydse mobiele intelligensie moontlik maak.

Gebruik van die HLR Lookups API

Die uitvoering van HLR Lookup-navrae is vinnig, veilig en eenvoudig. Sodra u aangemeld het en u API-sleutel verkry het, kan u verifieer en onmiddellike opsoekings inisieer met eenvoudige HTTP POST-versoeke, via POST /hlr-lookup. Alternatiewelik kan u groot datastelle verwerk deur te kies vir vinnige asinkrone API-versoeke met resultate wat teruggepos word na u bediener via webhook, soos verduidelik in die konsepte-afdeling.

Voorbeeldversoek

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"

Verifikasie word verskaf via HTTP-opskrifte, en payload.json moet (ten minste) die volgende JSON-objek bevat:

Voorbeeldlading

{
   "msisdn": "+14156226819"
}

By suksesvolle uitvoering sal u 'n respons ontvang wat intydse konnektiwiteitsbesonderhede vir die gespesifiseerde mobiele nommer bevat.

Suksesvolle Respons 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"
}

Vir 'n volledige uiteensetting van versoek- en responsattribute en konnektiwiteitsstatuste, sien POST /hlr-lookup.

Bykomende Opsoeking Dienste

Mobiele Nommer Oordraagbaarheid (MNP) Opsoekings

Gebruik MNP-opsoekings om netwerkeienaarskap en oordraagbaarheidsbesonderhede te bepaal sonder om intydse konnektiwiteit te ondervra. As u slegs die MCCMNC van 'n nommer benodig, verwys na POST /mnp-lookup.

Nommertipe-opsporing (NT) Opsoekings

Bepaal of 'n telefoonnommer aan 'n vaste lyn, mobiel, premiumtarief, VoIP, roeper, of ander nommerplanreekse behoort met POST /nt-lookup.

Sagteware-ontwikkelingstelle (SDK's)

Die HLR Lookups API werk met enige REST-kliënt in enige programmeertaal en ons het SDK's vir PHP, Ruby, en NodeJS op ons GitHub gepubliseer om u te help om vinnig aan die gang te kom.

Gereedskap

Om 'n naatlose ontwikkelingservaring te verseker, bied ons 'n omvattende stel gereedskap, insluitend in-blaaier API-versoek en webhook-monitering, IP-adres witlysing, robuuste verifikasie-opsies, en 'n verifikasie-toets-eindpunt.

Nie 'n Ontwikkelaar nie?

HLR Lookups en Nommer Oordraagbaarheid Navrae kan uitgevoer word sonder enige kodering. Leer meer oor ons ondernemings-webkliënt en blaaier-gebaseerde verslagdoeningsfunksies.

Verifikasie

Om sekuriteit en behoorlike toegangsbeheer te verseker, vereis die meeste versoeke aan die HLR Lookups API verifikasie. Eindpunte word gekategoriseer as óf openbaar óf beskerm. Wanneer u toegang tot 'n beskermde eindpunt verkry, moet u versoek geverifieer word deur u API-sleutel en geheim te gebruik via óf die Digest-Auth of Basic-Auth metode. Digest-Auth is die veiliger opsie en word sterk aanbeveel. Gebruik die GET /auth-test eindpunt om u verifikasie-opstelling te verifieer.

API-sleutel en API-geheim

Verkry u API-sleutel en geheim vanaf die API-instellings bladsy. U kan ook u voorkeur-verifikasie metode konfigureer en IP-adres witlysing aktiveer vir verbeterde sekuriteit. As u vermoed dat u API-geheim gekompromitteer is, kan u enige tyd 'n nuwe een genereer.

Basiese Verifikasie Digest Verifikasie IP Witlys

Standaard Basiese Verifikasie is maklik om te implementeer en word wyd ondersteun. U kan verifieer deur u API-sleutel en geheim as 'n user:pass paar in die HTTP-versoek deur te gee.

HTTP Basiese Verifikasie

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

Dit stuur 'n Authorization opskrif:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Aanbeveel: X-Basic Opskrif met SHA256

Vir verbeterde sekuriteit kan u 'n SHA256-hash van u geloofsbriewe stuur in plaas daarvan om dit direk as base64 te versend. Om hierdie metode te gebruik, bereken die hash van u YOUR_API_KEY:YOUR_API_SECRET paar en stuur dit via die X-Basic opskrif:

Basiese Verifikasie Versoek

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

Basiese Verifikasie Opskrifte

Sleutel	Tipe	Beskrywing
`X-Basic`	string	SHA256-hash van `YOUR_API_KEY:YOUR_API_SECRET`. Sluit die dubbelpunt-simbool (:) in die hash in.	verpligtend

Kode Voorbeeld

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

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

Digest-Auth is die aanbevole metode om toegang tot beskermde HLR Lookup API eindpunte te beveilig. Elke versoek moet die volgende opskrifte insluit: X-Digest-Key, X-Digest-Signature, en X-Digest-Timestamp, wat hieronder verduidelik word.

Versoek Voorbeeld

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"

Versoek Opskrifte

Sleutel	Tipe	Beskrywing
`X-Digest-Key`	string	U unieke HLR Lookups API-sleutel.	verpligtend
`X-Digest-Signature`	string	'n Unieke verifikasie-handtekening (sien hieronder).	verpligtend
`X-Digest-Timestamp`	integer	Huidige Unix-tydstempel (sien ook `GET /time`).	verpligtend

Konstruksie van die Handtekening

Die X-Digest-Signature word geskep deur 'n SHA256 HMAC-hash te gebruik, met u API-geheim as die gedeelde sleutel.

Die string wat gehash moet word, is soos volg gestruktureer:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Die . simbool verteenwoordig string-aaneenskakeling.

Digest Handtekening Komponente

Komponent	Tipe	Beskrywing
`ENDPOINT_PATH`	string	Die aangevraagde API-eindpunt, bv. `/auth-test` in kleinletters.
`UNIX_TIMESTAMP`	integer	Huidige Unix-tydstempel (moet binne 30 sekondes wees). Sien `GET /time`.
`REQUEST_METHOD`	string	Die HTTP-metode wat gebruik word, bv. `POST` of `GET`.
`REQUEST_BODY`	string	Versoek-liggaam data. Stel op `null` vir `GET` versoeke.

Kode Voorbeelde

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)

Rol Op

Konsepte

Die implementering van HLR-opsoekings in enige programmeertaal of stelsel via ons HTTP REST API is eenvoudig en doeltreffend. Met 'n eenvoudige integrasieproses kan u intydse navrae begin doen by mobiele netwerke vir onmiddellike insigte oor telefoonnommergeldigheid, konnektiwiteitstatus en roeteringbesonderhede.

Die keuse van die toepaslike API hang af van u spesifieke gebruiksgeval. Indien u intydse opsoekresultate benodig vir toepassings soos VoIP-telefonie, bedrogopsporing of SMS-roetering, is die sinchroniese API die beste keuse. Indien u gebruiksgeval egter hoëvolume-verwerking, grootmaat-opsoekings of grootskaalse dataverifikasie behels, bied die asinchroniese API geoptimaliseerde prestasie met bandwydte-doeltreffendheid en bondel-opsoekingsvermoëns.

Konfigureer die API om een van ons pasgemaakte roeteringsopsies te gebruik om spoed, akkuraatheid en kostedoeltreffendheid te optimaliseer. U kan ook opsoekresultate in bergings stoor vir maklike CSV- en JSON-verslagnederlaaie, sowel as gevorderde analise via die webkoppelvlak.

Sinchroniese HLR-opsoekings-API

Die POST /hlr-lookup-eindpunt verwerk een mobiele telefoonnommer (MSISDN) per versoek en lewer resultate onmiddellik in die HTTP-responsliggaam. Die resultate word as JSON geformateer en is ideaal vir intydse toepassings, insluitend mobiele nommervalidering, oproep-roetering en SMS-boodskapaflewering.

'n Sinchroniese API-oproep bestaan uit 'n direkte HTTP-versoek en -respons. U stelsel dien 'n enkele MSISDN (mobiele nommer) per versoek in en ontvang 'n onmiddellike respons wat intydse HLR-opsoekresultate in JSON-formaat bevat. Hierdie API is geoptimaliseer vir gebruiksgevalle wat onmiddellike verifikasie en konnektiwiteitsnakykings vereis, soos bedrogopsporing, VoIP-oproep-roetering en SMS-gateway-optimalisering.

Asinkrone HLR Opsoek API

Die POST /hlr-lookups-eindpunt is ontwerp vir grootmaat- en hoëvolume-verwerking, wat u toelaat om tot 1,000 MSISDN's per versoek in te dien. In plaas daarvan om resultate onmiddellik te lewer, gebruik hierdie API outomatiese webhooks om resultate progressief na u bediener te stuur. Opsoekresultate word as JSON-objekte via HTTP POST-terugoproepe gelewer.

Die asinchroniese API is geoptimaliseer vir spoed, doeltreffendheid en skaalbaarheid. Dit skakel netwerklatensie-probleme wat met sinchroniese oproepe geassosieer word uit, wat dit ideaal maak vir besighede wat hoë-deurset-opsoekings benodig. U stelsel dien tot 1,000 MSISDN's per versoek in, en ons platform verwerk hulle parallel en lewer resultate terug na u bediener via HTTP-webhooks in bondels van tot 1,000 resultate per terugoproep.

SDK's (Sagteware-ontwikkelingstelle)

Ons Sagteware-ontwikkelingstelle (SDK's) vir PHP, NodeJS en Ruby stroomlyn die integrasieproses, wat u toelaat om doeltreffend en met minimale moeite met die HLR Lookups API te koppel.

Hierdie SDK's bied voorafgeboude funksies, verifikasiehantering en gestruktureerde API-versoeksjablone, wat ontwikkelingstyd verminder en beste praktyke verseker.

Verken ons volledige lys van beskikbare SDK's op GitHub en begin vandag integreer.

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

Bekyk op 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   }

Bekyk op 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)

Bekyk op GitHub README.md

Rol Op

POST/hlr-lookupbeskerm

Voer 'n sinchrone HLR-opsoek uit wat intydse mobiele telefoon-konnektiwiteit en draagbaarheidsdata direk van netwerkoperateurs lewer. Hierdie eindpunt is ideaal vir lewendige verkeerscenario's waar tydsensitiewe toepassings onmiddellike verifikasie benodig of 'n telefoonnommer tans bereikbaar (gekoppel) of onbeskikbaar (afgeskakel) is. Daarbenewens help dit om aktiewe nommers van ongeldige, onbekende of vals nommers te onderskei.

Vir grootmaat-verwerking van groot datastelle wat nie onmiddellike resultate benodig nie, oorweeg die gebruik van die asinchrone POST /hlr-lookups, wat geoptimaliseer is vir hoëspoed-bondel-verwerking.

Indien u primêre fokus die verkryging van mobiele nommer-draagbaarheidsdata (MCCMNC) is en u nie lewendige konnektiwiteitstatus benodig nie, bied die POST /mnp-lookup 'n koste-effektiewe alternatief vir mobiele nommer-draagbaarheidsnavrae.

Versoek Suksesvolle Respons Fout Respons Statusverwysing

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdn`	string	Die mobiele telefoonnommer (MSISDN) wat nagevra word, verskaf in internasionale formaat (bv. +14156226819 of 0014156226819). Landkodes moet ingesluit word.	null	verpligtend
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel dit op `null` of laat hierdie parameter weg om u aangepaste roetekaart toe te pas of laat ons stelsel die beste roete vir hierdie opsoek outomaties bepaal.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke identifiseerder wat aan hierdie opsoekversoek toegeken is.	false
`msisdn`	string	Die selfoonmommer wat nagegaan word, geformateer in internasionale formaat (bv. +14156226819 of 0014156226819).	false
`connectivity_status`	string	Dui aan of die konnektiwiteitstatus van die nommer suksesvol verkry is. Moontlike waardes: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , of `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	'n Vyf- of sessyfer Mobile Country Code (MCC) en Mobile Network Code (MNC) wat die netwerk identifiseer wat tans met die foonnommer geassosieer word.	true
`mcc`	string(3)	'n Driesyfer Mobile Country Code (MCC) wat die land identifiseer waar die foonnommer geregistreer is.	true
`mnc`	string(2\|3)	'n Twee- of driesyfer Mobile Network Code (MNC) wat die spesifieke netwerk identifiseer waaraan die foonnommer behoort.	true
`imsi`	string	Die International Mobile Subscriber Identity (IMSI), 'n unieke identifiseerder vir die SIM-kaart wat met hierdie nommer geassosieer word. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`msin`	string(10)	Die Mobile Subscription Identification Number (MSIN) binne die mobiele operateur se databasis. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`msc`	string(12)	Die Mobile Switching Center (MSC) wat tans hierdie intekenaar se kommunikasie hanteer. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`original_network_name`	string	Die oorspronklike (inheemse) netwerkoperateur se naam wat met hierdie nommer geassosieer word.	true
`original_country_name`	string	Die volledige naam van die land waar die selfoonmommer oorspronklik geregistreer is, verskaf in Engels.	true
`original_country_code`	string(2)	Die twee-karakter ISO-landkode wat die land verteenwoordig waar die foonnommer aanvanklik toegeken is.	true
`original_country_prefix`	string	Die internasionale belkode (land belkode) wat ooreenstem met die oorspronklike land van die selfoonmommer.	true
`is_ported`	boolean	Dui aan of die mobiele nommer van sy oorspronklike netwerk na 'n ander operateur oorgedra is.	true
`ported_network_name`	string	Die naam van die netwerkoperateur waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_name`	string	Die naam van die land waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_code`	string(2)	Die twee-karakter ISO-landkode wat die land verteenwoordig waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_prefix`	string	Die internasionale belkode (land belkode) vir die land waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`is_roaming`	boolean	Dui aan of die mobiele nommer tans op 'n buitelandse netwerk swerwend is. Swerwende status beskikbaarheid hang af van die mobiele netwerkoperateur.	true
`roaming_network_name`	string	Die naam van die netwerk waarop die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_name`	string	Die naam van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_code`	string(2)	Die twee-karakter ISO-landkode van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_prefix`	string	Die internasionale belkode (land belkode) van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die opsoekkoste in EUR aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel wat tydsone insluit, wat spesifiseer wanneer die opsoek voltooi is.	true
`storage`	string	Die naam van die berging waar die opsoekresultate gestoor is. Dit stem ooreen met verslag name en CSV-aflaaie beskikbaar via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roetemetode aandui wat vir hierdie opsoekversoek gebruik is.	true
`processing_status`	string	Die verwerkingsuitkoms van die opsoek. Moontlike waardes: `COMPLETED` (suksesvol), `REJECTED` (netwerk onbereikbaar, geen koste toegepas nie), of `FAILED` (fout het tydens verwerking plaasgevind).	false
`error_code`	integer	'n Opsionele interne foutkode wat addisionele diagnostiese inligting vir kliëntediens verskaf.	true
`error_description`	string	'n Kort verduideliking van die gegewe foutkode (indien enige) in Engels gewone teks.	true
`data_source`	string	Die databron wat vir hierdie versoek gebruik is. Moontlike waardes: `LIVE_HLR` (intydse HLR-navraag) of `MNP_DB` (statiese mobiele nommer oordraagbaarheid databasis). Verwys na roete-opsies vir besonderhede.	false
`routing_instruction`	string	'n Dubbelpunt-afgebakende string wat die roete-instruksie beskryf wat in die versoek gebruik is. Die eerste komponent is `STATIC` wanneer u 'n roete gespesifiseer het of `AUTO` vir outomatiese roete; die tweede komponent is die roete-identifiseerder, en vir outomatiese roete-versoeke wys 'n derde komponent die oorsprong waarop die roetebesluit gebaseer is (d.w.s. `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."
    ]
}

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Status	Beskrywing
CONNECTED	Die nommer is geldig, en die teikentoestel is tans aan die mobiele netwerk gekoppel. Oproepe, SMS'e en ander dienste behoort die ontvanger suksesvol te bereik.
ABSENT	Die nommer is geldig, maar die teikentoestel is óf afgeskakel óf tydelik buite netwerkdekking. Boodskappe of oproepe sal moontlik nie afgelewer word totdat die toestel weer aan die netwerk koppel nie.
INVALID_MSISDN	Die nommer is ongeldig of word tans nie aan enige intekenaar op die mobiele netwerk toegeken nie. Oproepe en boodskappe na hierdie nommer sal misluk.
UNDETERMINED	Die konnektiwiteitstatus van die nommer kon nie bepaal word nie. Dit kan te wyte wees aan 'n ongeldige nommer, SS7-foutrespons, of 'n gebrek aan konnektiwiteit met die teiken-netwerkoperateur. Ondersoek die foutkode en sy beskrywingsveld vir addisionele diagnostiek.

Rol Op

POST/hlr-lookupsbeskerm

Inisieer 'n groep asinkrone HLR-opsoekings wat lewendige mobiele telefoonverbinding en draagbaarheidsdata van netwerkoperateurs verkry. Resultate word via webhooks aan u bediener gelewer. Hierdie metode is geoptimaliseer vir die verwerking van groot volumes nommers wat nie onmiddellike antwoorde vereis nie, soos databasiskoonmaak en verifikasie. Vir intydse toepassings soos oproepbaan of SMS-aflewering, oorweeg dit om eerder die POST /hlr-lookup-eindpunt te gebruik.

Hierdie eindpunt is ideaal vir grootmaatverwerking wanneer die doel is om telefoonnommers te identifiseer wat tans bereikbaar is (gekoppel) of onbeskikbaar (foon afgeskakel) terwyl ongeldige, ontoegekende of vals nommers uitgefilter word. Dit verskaf ook lewendige draagbaarheidstatus (MCCMNC) saam met verbindingsbesonderhede.

Voordat u hierdie eindpunt gebruik, verseker dat 'n webhook-URL gekonfigureer is om opsoekingsresultate asinkronies te ontvang. U kan dit opstel in u API-instellings.

Versoek Suksesvolle Respons Fout Respons Webhooks Statusverwysing

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdns`	array	'n Skikking van mobiele telefoonnommers (MSISDN's) in internasionale formaat (bv. +14156226819 of 0014156226819). U kan tot 1000 nommers per versoek insluit.	null	verpligtend
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel dit op `null` of laat hierdie parameter weg om u aangepaste roetekaart toe te pas of laat ons stelsel die beste roete vir hierdie opsoek outomaties bepaal.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`accepted`	array	'n Lys van objekte wat unieke identifiseerders en MSISDN's bevat wat vir verwerking aanvaar is.	false
`accepted_count`	integer	Die totale aantal MSISDN's wat suksesvol vir verwerking aanvaar is.	false
`rejected`	array	'n Lys van objekte wat unieke identifiseerders en MSISDN's bevat wat vir verwerking verwerp is, tipies weens ongeldige nommers. Geen koste geld vir verwerpte inskrywings nie.	false
`rejected_count`	integer	Die totale aantal MSISDN's wat weens validasiefoute verwerp is.	false
`total_count`	integer	Die totale telling van aanvaarde en verwerpte MSISDN's wat vir verwerking voorgelê is.	false
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die totale koste in EUR vir die aanvaarde opsoekings aandui.	false
`storage`	string	Die naam van die berging waar die opsoekingsresultate bygevoeg word, gebruik vir verslagdoening en CSV-aflaaie via die webkoppelvlak.	false
`route`	string(3\|4)	'n Drie- of vierkarakter-identifiseerder wat die roete spesifiseer wat vir hierdie opsoekingsversoek gebruik is. Bevat AUTO indien nommer-gebaseerde outomatiese roetebepaling versoek is.	false
`webhook_urls`	array	Die webhook-URL's wat in u API-instellings gekonfigureer is. Resultate word hierheen teruggepos.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Verwerking van Webhooks

Sodra dit ingedien is, begin ons platform die verskafde telefoonnommers verwerk en stuur die resultate na die voorheen gespesifiseerde webhook-URL op u bediener. Die resultate word oorgedra as 'n HTTP POST-versoek met 'n JSON-objek in die versoekliggaam.

Verifikasie

Verifieer die webhook deur die X-Signatures HTTP-opskrif te inspekteer.

Die X-Signatures-opskrif bevat 'n kommapunt-geskei lys van handtekeninge. Elke handtekening in die lys word gegenereer deur gebruik te maak van een van die API-geheime wat in u rekening gekonfigureer is. Om die webhook te verifieer, genereer 'n SHA-256-hash deur gebruik te maak van u API-sleutel, geheim en die rou HTTP-liggaam - vergelyk dit dan met die handtekeninge in die lys.

'n Ooreenkoms bevestig dat die versoek eg is en onderteken is met 'n geheim wat u beheer.

Kode Voorbeeld

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

Die versoek is geldig indien enige van die handtekeninge in die opskrif gelyk is aan 'n SHA256-hash wat bereken is oor die saamgevoegde string van u API-sleutel, geheim en die HTTP-liggaam.

Bevestiging van Ontvangs

Daar word verwag dat u bediener met 'n HTTP-statuskode 200 OK reageer om suksesvolle ontvangs te bevestig. Indien enige ander responskode teruggestuur word, 'n tydlimiettermyn plaasvind (10 sekondes), of enige ander afleweringsprobleem ontstaan, sal die stelsel die webhook outomaties na een minuut herprobeer. Indien die versoek voortdurend misluk, sal herpogings 'n eksponensiële terugval-strategie volg, met daaropvolgende pogings na 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minute.

Hierdie herpoging-meganisme verseker maksimum betroubaarheid in die aflewering van opsoekresultate na u infrastruktuur. Dit verminder die risiko van dataverlies as gevolg van tydelike netwerkprobleme of bediener-stilstand.

Webhook-Vrag

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

Die JSON-objek bevat 'n attribuut type => HLR saam met 'n attribuut results wat 'n lys van opsoekingsobjekte insluit, soos hieronder gedokumenteer.

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke identifiseerder wat aan hierdie opsoekversoek toegeken is.	false
`msisdn`	string	Die selfoonmommer wat nagegaan word, geformateer in internasionale formaat (bv. +14156226819 of 0014156226819).	false
`connectivity_status`	string	Dui aan of die konnektiwiteitstatus van die nommer suksesvol verkry is. Moontlike waardes: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , of `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	'n Vyf- of sessyfer Mobile Country Code (MCC) en Mobile Network Code (MNC) wat die netwerk identifiseer wat tans met die foonnommer geassosieer word.	true
`mcc`	string(3)	'n Driesyfer Mobile Country Code (MCC) wat die land identifiseer waar die foonnommer geregistreer is.	true
`mnc`	string(2\|3)	'n Twee- of driesyfer Mobile Network Code (MNC) wat die spesifieke netwerk identifiseer waaraan die foonnommer behoort.	true
`imsi`	string	Die International Mobile Subscriber Identity (IMSI), 'n unieke identifiseerder vir die SIM-kaart wat met hierdie nommer geassosieer word. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`msin`	string(10)	Die Mobile Subscription Identification Number (MSIN) binne die mobiele operateur se databasis. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`msc`	string(12)	Die Mobile Switching Center (MSC) wat tans hierdie intekenaar se kommunikasie hanteer. Beskikbaarheid hang af van netwerkkonfigurasie.	true
`original_network_name`	string	Die oorspronklike (inheemse) netwerkoperateur se naam wat met hierdie nommer geassosieer word.	true
`original_country_name`	string	Die volledige naam van die land waar die selfoonmommer oorspronklik geregistreer is, verskaf in Engels.	true
`original_country_code`	string(2)	Die twee-karakter ISO-landkode wat die land verteenwoordig waar die foonnommer aanvanklik toegeken is.	true
`original_country_prefix`	string	Die internasionale belkode (land belkode) wat ooreenstem met die oorspronklike land van die selfoonmommer.	true
`is_ported`	boolean	Dui aan of die mobiele nommer van sy oorspronklike netwerk na 'n ander operateur oorgedra is.	true
`ported_network_name`	string	Die naam van die netwerkoperateur waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_name`	string	Die naam van die land waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_code`	string(2)	Die twee-karakter ISO-landkode wat die land verteenwoordig waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`ported_country_prefix`	string	Die internasionale belkode (land belkode) vir die land waarheen die mobiele nommer oorgedra is, indien van toepassing.	true
`is_roaming`	boolean	Dui aan of die mobiele nommer tans op 'n buitelandse netwerk swerwend is. Swerwende status beskikbaarheid hang af van die mobiele netwerkoperateur.	true
`roaming_network_name`	string	Die naam van die netwerk waarop die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_name`	string	Die naam van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_code`	string(2)	Die twee-karakter ISO-landkode van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`roaming_country_prefix`	string	Die internasionale belkode (land belkode) van die land waar die mobiele nommer tans swerwend is, indien van toepassing.	true
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die opsoekkoste in EUR aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel wat tydsone insluit, wat spesifiseer wanneer die opsoek voltooi is.	true
`storage`	string	Die naam van die berging waar die opsoekresultate gestoor is. Dit stem ooreen met verslag name en CSV-aflaaie beskikbaar via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roetemetode aandui wat vir hierdie opsoekversoek gebruik is.	true
`processing_status`	string	Die verwerkingsuitkoms van die opsoek. Moontlike waardes: `COMPLETED` (suksesvol), `REJECTED` (netwerk onbereikbaar, geen koste toegepas nie), of `FAILED` (fout het tydens verwerking plaasgevind).	false
`error_code`	integer	'n Opsionele interne foutkode wat addisionele diagnostiese inligting vir kliëntediens verskaf.	true
`error_description`	string	'n Kort verduideliking van die gegewe foutkode (indien enige) in Engels gewone teks.	true
`data_source`	string	Die databron wat vir hierdie versoek gebruik is. Moontlike waardes: `LIVE_HLR` (intydse HLR-navraag) of `MNP_DB` (statiese mobiele nommer oordraagbaarheid databasis). Verwys na roete-opsies vir besonderhede.	false
`routing_instruction`	string	'n Dubbelpunt-afgebakende string wat die roete-instruksie beskryf wat in die versoek gebruik is. Die eerste komponent is `STATIC` wanneer u 'n roete gespesifiseer het of `AUTO` vir outomatiese roete; die tweede komponent is die roete-identifiseerder, en vir outomatiese roete-versoeke wys 'n derde komponent die oorsprong waarop die roetebesluit gebaseer is (d.w.s. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`).	false

Status	Beskrywing
CONNECTED	Die nommer is geldig, en die teikentoestel is tans aan die mobiele netwerk gekoppel. Oproepe, SMS'e en ander dienste behoort die ontvanger suksesvol te bereik.
ABSENT	Die nommer is geldig, maar die teikentoestel is óf afgeskakel óf tydelik buite netwerkdekking. Boodskappe of oproepe sal moontlik nie afgelewer word totdat die toestel weer aan die netwerk koppel nie.
INVALID_MSISDN	Die nommer is ongeldig of word tans nie aan enige intekenaar op die mobiele netwerk toegeken nie. Oproepe en boodskappe na hierdie nommer sal misluk.
UNDETERMINED	Die konnektiwiteitstatus van die nommer kon nie bepaal word nie. Dit kan te wyte wees aan 'n ongeldige nommer, SS7-foutrespons, of 'n gebrek aan konnektiwiteit met die teiken-netwerkoperateur. Ondersoek die foutkode en sy beskrywingsveld vir addisionele diagnostiek.

Rol Op

POST/mnp-lookupbeskerm

Voer 'n sinchroniese MNP-opsoek uit en verskaf mobiele nommer draagbaarheid en netwerkinligting. Hierdie eindpunt is geskik indien u primêre doel is om die huidige MCCMNC van 'n gegewe mobiele telefoonnommer te onttrek en die oorspronklike en huidige netwerke in reële tyd te identifiseer.

Vir grootmaat-verwerking van groot datastelle wat nie onmiddellike resultate benodig nie, oorweeg die gebruik van die asinchrone POST /mnp-lookups, wat geoptimaliseer is vir hoëspoed-bondel-verwerking.

MNP-navrae bepaal betroubaar draagbaarheid en netwerkinligting, maar dui nie aan of die teiken mobiele foon tans aan 'n netwerk gekoppel en bereikbaar is nie. Om lewendige konnektiwiteit inligting te onttrek, gebruik asseblief die POST /hlr-lookup eindpunt.

Versoek Suksesvolle Respons Fout Respons

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdn`	string	Die mobiele telefoonnommer (MSISDN) wat nagevra word, verskaf in internasionale formaat (bv. +14156226819 of 0014156226819). Landkodes moet ingesluit word.	null	verpligtend
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel dit op `null` of laat hierdie parameter weg om u aangepaste roetekaart toe te pas of laat ons stelsel die beste roete vir hierdie opsoek outomaties bepaal.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke 12-karakter identifiseerder vir hierdie opsoek.	false
`msisdn`	string	Die selfoonmommer wat in hierdie opsoekversoek geëvalueer is.	false
`query_status`	string	Dui aan of die verkryging van oordraagbaarheid- en netwerkinligting suksesvol was. Moontlike waardes is `OK` of `FAILED`.	false
`mccmnc`	string(5\|6)	'n Vyf- of ses-karakter MCCMNC (mobiele landkode en mobiele netwerkkode-paar) wat die netwerk identifiseer waaraan die selfoonmommer tans behoort.	true
`mcc`	string(3)	'n Drie-karakter MCC (mobiele landkode) wat die land verteenwoordig wat met die selfoonmommer se huidige netwerk geassosieer is.	true
`mnc`	string(2\|3)	'n Twee- of drie-karakter MNC (mobiele netwerkkode) wat die huidige netwerkoperateur vir die selfoonmommer identifiseer.	true
`is_ported`	boolean	Dui aan of die foonnommer van sy oorspronklike netwerk na 'n nuwe operateur oorgedra is.	true
`original_network_name`	string	'n Arbitrêre string (in Engels) wat die oorspronklike netwerkoperateur se naam van die geïnspekteerde selfoonmommer spesifiseer.	true
`original_country_name`	string	'n Arbitrêre string (in Engels) wat die oorspronklike land van die geïnspekteerde selfoonmommer aandui.	true
`original_country_code`	string(2)	'n Twee-karakter ISO landkode wat die oorspronklike land van die geïnspekteerde selfoonmommer verteenwoordig.	true
`original_country_prefix`	string	Die belkode van die oorspronklike land wat met die geïnspekteerde selfoonmommer geassosieer is.	true
`ported_network_name`	string	Spesifiseer die netwerkoperateur waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_name`	string	Spesifiseer die land waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_code`	string(2)	'n Twee-karakter ISO landkode wat die land verteenwoordig waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_prefix`	string	Die belkode vir die land waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`extra`	string	'n Arbitrêre string wat opsionele bykomende besonderhede oor die foonnommer verskaf.	true
`cost`	string	'n Desimale waarde, voorgestel as 'n string, wat die koste in EUR vir hierdie opsoek aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel, insluitend tydsone-inligting, wat aandui wanneer die opsoek voltooi is.	true
`storage`	string	Die bergingsnaam (of verslagnaam) waarby die opsoekresultate gevoeg is. Dit word gebruik vir CSV-aflaaie en verslagdoening via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoekversoek gebruik is.	true
`error_code`	integer	'n Opsionele interne foutkode wat bykomende konteks vir kliëntediens-diagnostiek verskaf.	true

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

POST/mnp-lookupsbeskerm

Inisieer 'n bondel asinkrone MNP (mobiele nommer oordraagbaarheid) opsoekings, wat die huidige MCCMNC herwin en die oorspronklike en huidige netwerke in reële tyd uitwys. Resultate word via webhooks aan u bediener gelewer. Hierdie metode is geoptimaliseer vir die verwerking van groot volumes nommers wat nie onmiddellike antwoorde vereis nie, soos databasiskoonmaak en verifikasie. Vir intydse toepassings soos oproepbaan of SMS-aflewering, oorweeg dit om eerder die POST /mnp-lookup-eindpunt te gebruik.

MNP-navrae bepaal betroubaar draagbaarheid en netwerkinligting, maar dui nie aan of die teiken mobiele foon tans aan 'n netwerk gekoppel en bereikbaar is nie. Om lewendige konnektiwiteit inligting te onttrek, gebruik asseblief die POST /hlr-lookups eindpunt.

Voordat u hierdie eindpunt gebruik, verseker dat 'n webhook-URL gekonfigureer is om opsoekingsresultate asinkronies te ontvang. U kan dit opstel in u API-instellings.

Versoek Suksesvolle Respons Fout Respons Webhooks

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdns`	array	'n Skikking van mobiele telefoonnommers (MSISDN's) in internasionale formaat (bv. +14156226819 of 0014156226819). U kan tot 1000 nommers per versoek insluit.	null	verpligtend
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel op `null` of laat hierdie parameter weg om jou pasgemaakte roetekaart toe te pas of laat ons stelsel outomaties die beste roetes vir hierdie versoek outomaties bepaal.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`accepted`	array	'n Lys van objekte wat unieke identifiseerders en MSISDN's bevat wat vir verwerking aanvaar is.	false
`accepted_count`	integer	Die totale aantal MSISDN's wat suksesvol vir verwerking aanvaar is.	false
`rejected`	array	'n Lys van objekte wat unieke identifiseerders en MSISDN's bevat wat vir verwerking verwerp is, tipies weens ongeldige nommers. Geen koste geld vir verwerpte inskrywings nie.	false
`rejected_count`	integer	Die totale aantal MSISDN's wat weens validasiefoute verwerp is.	false
`total_count`	integer	Die totale telling van aanvaarde en verwerpte MSISDN's wat vir verwerking voorgelê is.	false
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die totale koste in EUR vir die aanvaarde opsoekings aandui.	false
`storage`	string	Die naam van die berging waar die opsoekingsresultate bygevoeg word, gebruik vir verslagdoening en CSV-aflaaie via die webkoppelvlak.	false
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoekversoek gebruik is.	false
`webhook_urls`	array	Die webhook-URL's wat in u API-instellings gekonfigureer is. Resultate word hierheen teruggepos.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Verwerking van Webhooks

Sodra dit ingedien is, begin ons platform die verskafde telefoonnommers verwerk en stuur die resultate na die voorheen gespesifiseerde webhook-URL op u bediener. Die resultate word oorgedra as 'n HTTP POST-versoek met 'n JSON-objek in die versoekliggaam.

Verifikasie

Verifieer die webhook deur die X-Signatures HTTP-opskrif te inspekteer.

Die X-Signatures-opskrif bevat 'n kommapunt-geskei lys van handtekeninge. Elke handtekening in die lys word gegenereer deur gebruik te maak van een van die API-geheime wat in u rekening gekonfigureer is. Om die webhook te verifieer, genereer 'n SHA-256-hash deur gebruik te maak van u API-sleutel, geheim en die rou HTTP-liggaam - vergelyk dit dan met die handtekeninge in die lys.

'n Ooreenkoms bevestig dat die versoek eg is en onderteken is met 'n geheim wat u beheer.

Kode Voorbeeld

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

Die versoek is geldig indien enige van die handtekeninge in die opskrif gelyk is aan 'n SHA256-hash wat bereken is oor die saamgevoegde string van u API-sleutel, geheim en die HTTP-liggaam.

Bevestiging van Ontvangs

Daar word verwag dat u bediener met 'n HTTP-statuskode 200 OK reageer om suksesvolle ontvangs te bevestig. Indien enige ander responskode teruggestuur word, 'n tydlimiettermyn plaasvind (10 sekondes), of enige ander afleweringsprobleem ontstaan, sal die stelsel die webhook outomaties na een minuut herprobeer. Indien die versoek voortdurend misluk, sal herpogings 'n eksponensiële terugval-strategie volg, met daaropvolgende pogings na 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minute.

Hierdie herpoging-meganisme verseker maksimum betroubaarheid in die aflewering van opsoekresultate na u infrastruktuur. Dit verminder die risiko van dataverlies as gevolg van tydelike netwerkprobleme of bediener-stilstand.

Webhook-Vrag

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

Die JSON-objek bevat 'n attribuut type => MNP saam met 'n attribuut results wat 'n lys van opsoekingsobjekte insluit, soos hieronder gedokumenteer.

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke 12-karakter identifiseerder vir hierdie opsoek.	false
`msisdn`	string	Die selfoonmommer wat in hierdie opsoekversoek geëvalueer is.	false
`query_status`	string	Dui aan of die verkryging van oordraagbaarheid- en netwerkinligting suksesvol was. Moontlike waardes is `OK` of `FAILED`.	false
`mccmnc`	string(5\|6)	'n Vyf- of ses-karakter MCCMNC (mobiele landkode en mobiele netwerkkode-paar) wat die netwerk identifiseer waaraan die selfoonmommer tans behoort.	true
`mcc`	string(3)	'n Drie-karakter MCC (mobiele landkode) wat die land verteenwoordig wat met die selfoonmommer se huidige netwerk geassosieer is.	true
`mnc`	string(2\|3)	'n Twee- of drie-karakter MNC (mobiele netwerkkode) wat die huidige netwerkoperateur vir die selfoonmommer identifiseer.	true
`is_ported`	boolean	Dui aan of die foonnommer van sy oorspronklike netwerk na 'n nuwe operateur oorgedra is.	true
`original_network_name`	string	'n Arbitrêre string (in Engels) wat die oorspronklike netwerkoperateur se naam van die geïnspekteerde selfoonmommer spesifiseer.	true
`original_country_name`	string	'n Arbitrêre string (in Engels) wat die oorspronklike land van die geïnspekteerde selfoonmommer aandui.	true
`original_country_code`	string(2)	'n Twee-karakter ISO landkode wat die oorspronklike land van die geïnspekteerde selfoonmommer verteenwoordig.	true
`original_country_prefix`	string	Die belkode van die oorspronklike land wat met die geïnspekteerde selfoonmommer geassosieer is.	true
`ported_network_name`	string	Spesifiseer die netwerkoperateur waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_name`	string	Spesifiseer die land waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_code`	string(2)	'n Twee-karakter ISO landkode wat die land verteenwoordig waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`ported_country_prefix`	string	Die belkode vir die land waarheen die geïnspekteerde selfoonmommer oorgedra is, indien van toepassing.	true
`extra`	string	'n Arbitrêre string wat opsionele bykomende besonderhede oor die foonnommer verskaf.	true
`cost`	string	'n Desimale waarde, voorgestel as 'n string, wat die koste in EUR vir hierdie opsoek aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel, insluitend tydsone-inligting, wat aandui wanneer die opsoek voltooi is.	true
`storage`	string	Die bergingsnaam (of verslagnaam) waarby die opsoekresultate gevoeg is. Dit word gebruik vir CSV-aflaaie en verslagdoening via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoekversoek gebruik is.	true
`error_code`	integer	'n Opsionele interne foutkode wat bykomende konteks vir kliëntediens-diagnostiek verskaf.	true

Rol Op

POST/nt-lookupbeskerm

Voer 'n sinchrone nommertipe (NT) opsoek uit. Hierdie eindpunt is ideaal as u primêre doel is om in reële tyd te bepaal of die verskafde telefoonnommers aan vaslyntelefone, mobiele toestelle, premium-koers, VoIP, roepers of ander nommerplanreekse behoort.

NT-navrae identifiseer die telefoonnommertipe betroubaar, maar dui nie aan of die teikennommer tans aan 'n netwerk gekoppel en bereikbaar is nie. Om lewendige konnektiwiteit-inligting te verkry, gebruik asseblief die POST /hlr-lookup eindpunt.

Indien u gebruiksgeval akkurate netwerk- en draagbaarheidsinligting (MCCMNC) vereis, maar nie lewendige konnektiwiteit-status nie, gebruik asseblief die POST /mnp-lookup eindpunt vir mobiele nommerdraagbaarheidsnavrae.

Versoek Suksesvolle Respons Fout Respons Tipe Verwysing

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`number`	string	'n Telefoonnommer in internasionale formaat (bv. +4989702626 of 004989702626).	null	mandatory
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel op `null` of laat hierdie parameter weg om u pasgemaakte roetekaart toe te pas of laat ons stelsel outomaties die beste roetes bepaal vir hierdie versoek.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke identifiseerder wat aan hierdie opsoekversoek toegeken is.	false
`number`	string	Die telefoonnommer wat tydens hierdie opsoekversoek geëvalueer is.	false
`number_type`	string	Die opgespeurde nommertipe. Moontlike waardes sluit in: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Dui aan of die nommertipe-inligting suksesvol verkry is. Gee `OK` terug indien suksesvol, of `FAILED` indien die opsoek misluk het.	false
`is_valid`	boolean	Dui aan of die telefoonnommer sintakties geldig is.	true
`invalid_reason`	string	'n Gewone teks boodskap in Engels wat spesifiseer waarom die telefoonnommer as ongeldig beskou word (bv. "too short" of "invalid prefix"), of `null` indien die nommer geldig is.	true
`is_possibly_ported`	boolean	Dui aan of die telefoonnommer moontlik van sy oorspronklike operateur na 'n ander draer oorgedra is. Vir definitiewe oordraagbaarheidsinligting, gebruik MNP-opsoekings.	true
`is_vanity_number`	boolean	Dui aan of die telefoonnommer 'n ydelheidsommer is, wat beteken dit sluit alfabetiese karakters in.	true
`qualifies_for_hlr_lookup`	boolean	Dui aan of die telefoonnommer geskik is vir addisionele navrae deur middel van HLR-opsoekings.	true
`mccmnc`	string(5\|6)	'n Vyf of ses karakter string wat die MCCMNC-tupel (mobiele landkode en mobiele netwerkkode) verteenwoordig wat die oorspronklike netwerk van die mobiele telefoonnommer identifiseer.	true
`mcc`	string(3)	'n Drie karakter string wat die MCC (mobiele landkode) verteenwoordig wat die land geassosieer met die oorspronklike mobiele netwerk van die telefoonnommer identifiseer.	true
`mnc`	string(2\|3)	'n Twee of drie karakter string wat die MNC (mobiele netwerkkode) verteenwoordig wat die oorspronklike mobiele netwerkoperateur van die telefoonnommer identifiseer.	true
`original_network_name`	string	'n Arbitrêre Engelse gewone teks string wat die oorspronklike netwerkoperateurnaam van die geïnspekteerde mobiele telefoonnommer spesifiseer.	true
`original_country_name`	string	'n Arbitrêre Engelse gewone teks string wat die oorspronklike land geassosieer met die geïnspekteerde mobiele telefoonnommer spesifiseer.	true
`original_country_code`	string(2)	'n Twee-karakter ISO-landkode wat die oorspronklike land van die geïnspekteerde mobiele telefoonnommer aandui.	true
`regions`	array	'n Lys van mensleesbare strings in Engels wat die geografiese streek/streke geassosieer met hierdie telefoonnommer spesifiseer.	true
`timezones`	array	'n Lys van tydsones (in Olson-formaat) geassosieer met hierdie telefoonnommer.	true
`info_text`	string	'n Arbitrêre string wat addisionele inligting oor die telefoonnommer kan bevat.	true
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die koste (in EUR) van hierdie opsoek aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel (insluitend tydsone) wat aandui wanneer die opsoek voltooi is.	true
`storage`	string	Spesifiseer die bergingsnaam waar die opsoekresultate bygevoeg is. Dit stem ooreen met die verslagnaam wat gebruik word vir CSV-aflaaie en analise via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoekversoek gebruik is.	true

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Tipe	Beskrywing
LANDLINE	Vaste lyn telefoonnommer.
MOBILE	Mobiele telefoonnommer. Kwalifiseer vir HLR-opsoekings om addisionele verbindingstatus, netwerk, oordraagbaarheid en swerwende inligting te verkry.
MOBILE_OR_LANDLINE	Vaste lyn of mobiele telefoonnommer. Mag kwalifiseer vir HLR-opsoek.
TOLL_FREE	Tolvrye telefoonnommer.
PREMIUM_RATE	Premium koers telefoonnommer met addisionele kostes.
SHARED_COST	Gedeelde koste telefoonnommer. Tipies goedkoper as premium koers telefoonnommers.
VOIP	Voice over IP telefoonnommer. Sluit TSoIP telefoonnommers in (Telephony Service over IP).
PAGER	Roeper telefoonnommer. Tipies geen stemfunksionaliteit.
UAN	Universele Toegangsnommer (Maatskappynommer). Mag na spesifieke kantore gerouteer word, maar laat toe dat een nommer vir die maatskappy gebruik word.
VOICEMAIL	Stemboodskap telefoonnommer.
UNKNOWN	Nommertipe kon nie bepaal word nie.

Rol Op

POST/nt-lookups beskerm

Hierdie eindpunt aktiveer 'n reeks asinkrone nommertipe-opsoekings met resultate wat via webhook na jou bediener teruggestuur word. Dit is geskik indien jou primêre doel is om te bepaal of gegewe telefoonnommers aan vaslyn-, mobiele-, premiumkoers-, VoIP-, roeper-, of ander nommereringsplanreekse behoort. Geoptimaliseer vir vinnige verwerking van groot volumes nommers, is hierdie eindpunt ideaal vir grootmaat-operasies (bv. databasis-suiwering). Vir lewendige verkeer en tydkritiese gebruiksgevalle, gebruik asseblief die POST /nt-lookup-eindpunt.

Jy moet 'n webhook-URL in jou API-instellings spesifiseer as 'n voorvereiste om hierdie eindpunt te aktiveer.

Versoek Suksesvolle Respons Fout Respons Webhooks Tipe Verwysing

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

Vragdata

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`numbers`	array	'n Skikking van telefoonnommers in internasionale formaat (bv. +14156226819 of 004989702626). 'n Maksimum van 1000 nommers kan per versoek ingesluit word.	null	verpligtend
`route`	string(3)	'n Opsionele drie-karakter identifiseerder wat die roete vir hierdie opsoek spesifiseer. Stel op `null` of laat hierdie parameter weg om jou pasgemaakte roetekaart toe te pas of laat ons stelsel outomaties die beste roete vir hierdie versoek bepaal.	null	opsioneel
`storage`	string	'n Opsionele bergingsidentifiseerder wat die verslag spesifiseer waar resultate gestoor sal word vir handmatige hersiening, analise en verslagdoening. Die stelsel voeg outomaties 'n tydstempel met die huidige maand by. Indien weggelaat of op `null` gestel, sal die stelsel outomaties resultate per maand groepeer vir verslagdoeningsdoeleindes.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`accepted`	array	'n Skikking van objekte, elk met 'n unieke identifiseerder en 'n telefoonnommer wat vir verwerking aanvaar is.	false
`accepted_count`	integer	Die totale aantal telefoonnommers wat vir verwerking aanvaar is.	false
`rejected`	array	'n Skikking van objekte, elk met 'n unieke identifiseerder en 'n telefoonnommer wat vir verwerking verwerp is. Tipies is hierdie nommers ongeldig, en geen koste word toegepas nie.	false
`rejected_count`	integer	Die totale aantal telefoonnommers wat vir verwerking verwerp is.	false
`total_count`	integer	Die totale aantal aanvaarde en verwerpte telefoonnommers wat vir verwerking ingedien is.	false
`cost`	string	'n String wat 'n desimale waarde verteenwoordig wat die koste in EUR vir hierdie opsoekings aandui.	false
`storage`	string	Die naam van die berging (verslag) waar die opsoeking-resultate bygevoeg is. Hierdie naam word gebruik vir CSV-aflaaie en analise via die webkoppelvlak.	false
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoeking-versoek gebruik is.	false
`webhook_urls`	array	Die webhook-URL's wat in u API-instellings gekonfigureer is. Resultate word hierheen teruggepos.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Verwerking van Webhooks

Sodra dit ingedien is, begin ons platform die verskafde telefoonnommers verwerk en stuur die resultate na die voorheen gespesifiseerde webhook-URL op u bediener. Die resultate word oorgedra as 'n HTTP POST-versoek met 'n JSON-objek in die versoekliggaam.

Verifikasie

Verifieer die webhook deur die X-Signatures HTTP-opskrif te inspekteer.

Die X-Signatures-opskrif bevat 'n kommapunt-geskei lys van handtekeninge. Elke handtekening in die lys word gegenereer deur gebruik te maak van een van die API-geheime wat in u rekening gekonfigureer is. Om die webhook te verifieer, genereer 'n SHA-256-hash deur gebruik te maak van u API-sleutel, geheim en die rou HTTP-liggaam - vergelyk dit dan met die handtekeninge in die lys.

'n Ooreenkoms bevestig dat die versoek eg is en onderteken is met 'n geheim wat u beheer.

Kode Voorbeeld

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

Die versoek is geldig indien enige van die handtekeninge in die opskrif gelyk is aan 'n SHA256-hash wat bereken is oor die saamgevoegde string van u API-sleutel, geheim en die HTTP-liggaam.

Bevestiging van Ontvangs

Daar word verwag dat u bediener met 'n HTTP-statuskode 200 OK reageer om suksesvolle ontvangs te bevestig. Indien enige ander responskode teruggestuur word, 'n tydlimiettermyn plaasvind (10 sekondes), of enige ander afleweringsprobleem ontstaan, sal die stelsel die webhook outomaties na een minuut herprobeer. Indien die versoek voortdurend misluk, sal herpogings 'n eksponensiële terugval-strategie volg, met daaropvolgende pogings na 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minute.

Hierdie herpoging-meganisme verseker maksimum betroubaarheid in die aflewering van opsoekresultate na u infrastruktuur. Dit verminder die risiko van dataverlies as gevolg van tydelike netwerkprobleme of bediener-stilstand.

Webhook-Vrag

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

Die JSON-objek bevat 'n attribuut type => NT saam met 'n attribuut results wat 'n lys van opsoekingsobjekte insluit, soos hieronder gedokumenteer.

Naam	Tipe	Beskrywing	Nietig
`id`	string(12)	'n Unieke identifiseerder wat aan hierdie opsoekversoek toegeken is.	false
`number`	string	Die telefoonnommer wat tydens hierdie opsoekversoek geëvalueer is.	false
`number_type`	string	Die opgespeurde nommertipe. Moontlike waardes sluit in: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Dui aan of die nommertipe-inligting suksesvol verkry is. Gee `OK` terug indien suksesvol, of `FAILED` indien die opsoek misluk het.	false
`is_valid`	boolean	Dui aan of die telefoonnommer sintakties geldig is.	true
`invalid_reason`	string	'n Gewone teks boodskap in Engels wat spesifiseer waarom die telefoonnommer as ongeldig beskou word (bv. "too short" of "invalid prefix"), of `null` indien die nommer geldig is.	true
`is_possibly_ported`	boolean	Dui aan of die telefoonnommer moontlik van sy oorspronklike operateur na 'n ander draer oorgedra is. Vir definitiewe oordraagbaarheidsinligting, gebruik MNP-opsoekings.	true
`is_vanity_number`	boolean	Dui aan of die telefoonnommer 'n ydelheidsommer is, wat beteken dit sluit alfabetiese karakters in.	true
`qualifies_for_hlr_lookup`	boolean	Dui aan of die telefoonnommer geskik is vir addisionele navrae deur middel van HLR-opsoekings.	true
`mccmnc`	string(5\|6)	'n Vyf of ses karakter string wat die MCCMNC-tupel (mobiele landkode en mobiele netwerkkode) verteenwoordig wat die oorspronklike netwerk van die mobiele telefoonnommer identifiseer.	true
`mcc`	string(3)	'n Drie karakter string wat die MCC (mobiele landkode) verteenwoordig wat die land geassosieer met die oorspronklike mobiele netwerk van die telefoonnommer identifiseer.	true
`mnc`	string(2\|3)	'n Twee of drie karakter string wat die MNC (mobiele netwerkkode) verteenwoordig wat die oorspronklike mobiele netwerkoperateur van die telefoonnommer identifiseer.	true
`original_network_name`	string	'n Arbitrêre Engelse gewone teks string wat die oorspronklike netwerkoperateurnaam van die geïnspekteerde mobiele telefoonnommer spesifiseer.	true
`original_country_name`	string	'n Arbitrêre Engelse gewone teks string wat die oorspronklike land geassosieer met die geïnspekteerde mobiele telefoonnommer spesifiseer.	true
`original_country_code`	string(2)	'n Twee-karakter ISO-landkode wat die oorspronklike land van die geïnspekteerde mobiele telefoonnommer aandui.	true
`regions`	array	'n Lys van mensleesbare strings in Engels wat die geografiese streek/streke geassosieer met hierdie telefoonnommer spesifiseer.	true
`timezones`	array	'n Lys van tydsones (in Olson-formaat) geassosieer met hierdie telefoonnommer.	true
`info_text`	string	'n Arbitrêre string wat addisionele inligting oor die telefoonnommer kan bevat.	true
`cost`	string	'n Desimale waarde voorgestel as 'n string, wat die koste (in EUR) van hierdie opsoek aandui.	true
`timestamp`	string	'n W3C-geformateerde tydstempel (insluitend tydsone) wat aandui wanneer die opsoek voltooi is.	true
`storage`	string	Spesifiseer die bergingsnaam waar die opsoekresultate bygevoeg is. Dit stem ooreen met die verslagnaam wat gebruik word vir CSV-aflaaie en analise via die webkoppelvlak.	true
`route`	string(3)	'n Drie-karakter identifiseerder wat die roete spesifiseer wat vir hierdie opsoekversoek gebruik is.	true

Tipe	Beskrywing
LANDLINE	Vaste lyn telefoonnommer.
MOBILE	Mobiele telefoonnommer. Kwalifiseer vir HLR-opsoekings om addisionele verbindingstatus, netwerk, oordraagbaarheid en swerwende inligting te verkry.
MOBILE_OR_LANDLINE	Vaste lyn of mobiele telefoonnommer. Mag kwalifiseer vir HLR-opsoek.
TOLL_FREE	Tolvrye telefoonnommer.
PREMIUM_RATE	Premium koers telefoonnommer met addisionele kostes.
SHARED_COST	Gedeelde koste telefoonnommer. Tipies goedkoper as premium koers telefoonnommers.
VOIP	Voice over IP telefoonnommer. Sluit TSoIP telefoonnommers in (Telephony Service over IP).
PAGER	Roeper telefoonnommer. Tipies geen stemfunksionaliteit.
UAN	Universele Toegangsnommer (Maatskappynommer). Mag na spesifieke kantore gerouteer word, maar laat toe dat een nommer vir die maatskappy gebruik word.
VOICEMAIL	Stemboodskap telefoonnommer.
UNKNOWN	Nommertipe kon nie bepaal word nie.

Rol Op

GET/routebeskerm

Haal die roete op wat outomaties gekies sal word wanneer jy 'n HLR-opsoek uitvoer sonder om die route-parameter te spesifiseer.

Outomatiese roete-keuse is gebaseer op die roetekaart wat verkrygbaar is met die GET /hlr-coverage-eindpunt, wat hoofsaaklik afgelei word van GET /routing-map. U kan u roeteringskaart aanpas en pasgemaakte reëls definieer in u rekeninginstellings.

Versoek Suksesvolle Respons Fout Respons

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdn`	string	Die MSISDN waarvoor die outomaties gekose roeteringsinligting opgehaal moet word.	null	verpligtend

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`route`	string	Die aanbevole roete.	false
`confidence_level`	string	Die vertrouensvlak waarmee hierdie roete gekies is, d.w.s. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Die nommerstelsel-gebaseerde MCCMNC vir hierdie nommer.	false
`origin`	string	Die oorsprong waarop die roetering-besluit gebaseer is, d.w.s. `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."
    ]
}

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/routesbeskerm

Hierdie eindpunt gee 'n lys van beskikbare HLR-, MNP- en NT-roetes terug. Elke roete, tesame met sy kenmerke en beperkings, word op die roetebesonderhede-bladsy verduidelik.

Versoek Suksesvolle Respons Fout Respons

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

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`routes`	object	'n Objek met roetes gegroepeer volgens roetetipe.	false
`HLR\|MNP\|NT`	string[]	Bevat 'n lys van roete-identifiseerders.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/routing-mapbeskerm

Haal die outomatiese roeteringskonfigurasie op wat tans op HLR-opsoekings vir jou rekening toegepas word. Hierdie verstekonfigurasie word gebruik wanneer jy HLR-opsoekings indien sonder om 'n route-parameter te spesifiseer. Jy kan jou roeteringskaart aanpas en pasgemaakte reëls skep in jou rekeninginstellings.

Die konfigurasie-hiërargie kaskadeer van land-vlak reëls na MCCMNC-vlak reëls, en uiteindelik na individuele telefoonnommer voorvoegsel-afbeeldings. In praktyk beteken dit dat individuele telefoonnommer voorvoegsel-afbeeldings voorrang kry bo konflikterende MCCMNC-toewysings, wat op hul beurt land-vlak reëls oorheers. Let asseblief daarop dat MNP-terugval enige konflikterende pasgemaakte reëls oorheers terwyl dit geaktiveer is.

Versoek Suksesvolle Respons Fout Respons

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`default_route`	string	Die verstekoete wat gebruik word wanneer geen voorkeur-roeteringsopsie vir 'n MSISDN bepaal kan word nie en geen pasgemaakte roeteringsreëls van toepassing is nie.	false
`mnp_fallback`	boolean	Dui aan of MNP-terugval geaktiveer is. Wanneer geaktiveer en HLR-navrae nie deur 'n netwerk ondersteun word nie (konnektiwiteitstatus onbeskikbaar), sal die stelsel eerder 'n MNP-opsoek uitvoer.	false
`mccmncs`	array	'n Afbeelding van MCCMNC-kodes na hul outomaties geselekteerde roetes. Wanneer 'n HLR-opsoek vir 'n nommer in 'n gegewe MCCMNC uitgevoer word, word die ooreenstemmende roete gebruik.	false
`mccmnc`	string(5\|6)	'n Vyf- of seskarakter MCCMNC (mobiele landkode en mobiele netwerkkode kombinasie) wat die mobiele netwerkoperateur identifiseer.	false
`countrycode`	string(2)	'n Twee-karakter ISO-landkode wat die netwerk se land identifiseer.	false
`route`	string(3)	Die geselekteerde roete vir die netwerk.	false
`mno`	string	Die verbruikersgeoriënteerde handelsmerk waaronder hierdie netwerk bedryf word.	false
`confidence`	string	Die vertrouensvlak waarmee die seleksie gemaak is. Moontlike waardes is: HIGH, NORMAL, LOW, MNP_REDIRECT. In die geval van laasgenoemde, herlei die stelsel verkeer na hierdie netwerk na MNP, indien hierdie gedrag in jou rekening geaktiveer is. Andersins gebruik dit die verstekoete in die rekening.	false
`origin`	string	Die oorsprong waarop die seleksie gebaseer is. Moontlike waardes is: `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	'n Lys van pasgemaakte voorvoegsel-gebaseerde roeteringsreëls wat in jou rekening gekonfigureer is, indien enige.	false
`countrycode`	string(2)	'n Twee-karakter ISO-landkode wat die voorvoegsel se land identifiseer.	false
`cns`	string	Die voorvoegsel waarop die roeteringsreël van toepassing is.	false
`route`	string(3)	Die geselekteerde roete vir die voorvoegsel.	false
`mccmnc`	string(5\|6)	'n Vyf- of seskarakter MCCMNC (mobiele landkode en mobiele netwerkkode kombinasie) wat die mobiele netwerkoperateur identifiseer.	true
`mno`	string	Die verbruikersgeoriënteerde handelsmerk waaronder hierdie netwerk bedryf word.	true
`countries`	array	'n Lys van pasgemaakte land-gebaseerde reëls wat in jou rekening gekonfigureer is, indien enige.	false
`countrycode`	string(2)	'n Twee-karakter ISO-landkode wat die land identifiseer.	false
`route`	string(3)	Die geselekteerde roete vir die land.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/hlr-coverage beskerm

Lewer HLR-dekkingsinsigte om data-gedrewe besluitneming te ondersteun. Hierdie eindpunt help jou om intydse HLR-roeteopsies oor mobiele netwerke te ontleed, die mees effektiewe paaie vir jou teikengebiede te identifiseer, en jou outomatiese roetering te konfigureer.

Aanbevole roetes van GET /route is gebaseer op die dekkingsdata wat hier verkry word. Dekkingsdata is ook beskikbaar op die netwerkdekking bladsy. Jy kan jou roetekaart verder aanpas en reëls definieer in jou rekeninginstellings.

Ons beveel aan dat jy jouself vertroud maak met hierdie gids om die resultate te help interpreteer.

Versoek Suksesvolle Respons Fout Respons Statusverwysing

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`countrycode`	string(2)	'n Verpligte twee-letter ISO-landkode wat gebruik word om resultate te filtreer en slegs rekords wat met die gespesifiseerde land geassosieer word, terug te gee.	null	verpligtend
`sample_size`	string	'n Opsionele parameter wat 'n steekproefgrootte spesifiseer. Moontlike waardes is `LARGE`, `MEDIUM`, `SMALL`. Groter steekproewe dek 'n langer tydraamwerk, kleiner steekproewe dek 'n baie onlangse tydraamwerk.	LARGE	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`name`	string	Die gekose landnaam in Engelse gewone teks.	false
`countrycode`	string(2)	Die twee-karakter ISO-landkode van die gekose land.	false
`prefix`	string	Die internasionale belvoorvoegsel van die gekose land.	false
`mccs`	string[]	'n Lys van MCC's (mobiele landkodes) wat met die gekose land geassosieer word.	false
`carriers`	object[]	'n Lys van diensverskaffer-objekte met roete-spesifieke konnektiwiteitsmetings.	false
`mno`	string	Die mobiele netwerkoperateur se naam in Engelse gewone teks.	false
`mccmnc`	string	Die mobiele netwerkoperateur se MCCMNC.	false
`mcc`	string	Die mobiele netwerkoperateur se MCC (mobiele landkode).	false
`mnc`	string	Die mobiele netwerkoperateur se MNC (mobiele netwerkkode).	false
`routes`	object[]	'n Lys van roete-spesifieke konnektiwiteitsresultate.	false
`route`	string	Die roete waarop die konnektiwiteitsinligting van toepassing is.	false
`selected`	bool	Dui aan of dit die gekose roete vir outomatiese roetering is.	false
`selection_confidence`	string	Die vertrouensvlak waarmee hierdie roete gekies is, d.w.s. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Bevat null indien dit nie die gekose roete is nie.	true
`n`	int	Die totale aantal opsoekings in hierdie steekproef.	false
`CONNECTED`	int	Die aantal HLR-opsoekings wat 'n CONNECTED-status teruggegee het.	false
`CONNECTED_PCT`	float	Die persentasie HLR-opsoekings wat 'n CONNECTED-status teruggegee het.	false
`ABSENT`	int	Die aantal HLR-opsoekings wat 'n ABSENT-status teruggegee het.	false
`ABSENT_PCT`	float	Die persentasie HLR-opsoekings wat 'n ABSENT-status teruggegee het.	false
`INVALID_MSISDN`	int	Die aantal HLR-opsoekings wat 'n INVALID_MSISDN-status teruggegee het.	false
`INVALID_MSISDN_PCT`	float	Die persentasie HLR-opsoekings wat 'n INVALID_MSISDN-status teruggegee het.	false
`UNDETERMINED`	int	Die aantal HLR-opsoekings wat 'n UNDETERMINED-status teruggegee het.	false
`UNDETERMINED_PCT`	float	Die persentasie HLR-opsoekings wat 'n UNDETERMINED-status teruggegee het.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Status	Beskrywing
CONNECTED	Die nommer is geldig, en die teikentoestel is tans aan die mobiele netwerk gekoppel. Oproepe, SMS'e en ander dienste behoort die ontvanger suksesvol te bereik.
ABSENT	Die nommer is geldig, maar die teikentoestel is óf afgeskakel óf tydelik buite netwerkdekking. Boodskappe of oproepe sal moontlik nie afgelewer word totdat die toestel weer aan die netwerk koppel nie.
INVALID_MSISDN	Die nommer is ongeldig of word tans nie aan enige intekenaar op die mobiele netwerk toegeken nie. Oproepe en boodskappe na hierdie nommer sal misluk.
UNDETERMINED	Die konnektiwiteitstatus van die nommer kon nie bepaal word nie. Dit kan te wyte wees aan 'n ongeldige nommer, SS7-foutrespons, of 'n gebrek aan konnektiwiteit met die teiken-netwerkoperateur. Ondersoek die foutkode en sy beskrywingsveld vir addisionele diagnostiek.

Rol Op

GET/mnp-coveragebeskerm

Hierdie eindpunt lewer 'n lys van mobiele netwerkoperateurs, saam met hul ooreenstemmende MCCMNC-identifiseerders, wat tans ondersteun word vir mobiele nommer oordraagbaarheid opsoekings.

Versoek Suksesvolle Respons Fout Respons

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`countrycode`	string(2)	'n Opsionele tweeletter ISO-landkode wat gebruik word om die MCCMNC-resultate te filtreer, en slegs data relevant tot die gespesifiseerde land te lewer.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`items[]`	array	'n Lys van mobiele netwerkoperateurs.	false
`country_name`	string	Die landnaam in Engels.	false
`country_code`	string(2)	'n Tweeletter ISO-landkode.	false
`mccmnc`	string(5\|6)	'n Vyf- of seskarakter MCCMNC (mobiele landkode en mobiele netwerkkode kombinasie) wat die mobiele netwerkoperateur identifiseer.	false
`mcc`	string(3)	'n Driekarakter MCC (mobiele landkode) wat die land van die netwerk verteenwoordig.	false
`mnc`	string(2\|3)	'n Twee- of driekarakter MNC (mobiele netwerkkode) wat die spesifieke mobiele netwerkoperateur verteenwoordig.	false
`brand`	string	Die verbruikersgeoriënteerde handelsmerk waaronder hierdie netwerk bedryf word.	true
`operator`	string	Die wettige naam van die mobiele netwerkoperateur.	true

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/price-listbeskerm

Hierdie eindpunt lewer 'n lys van lande waar slegs MNP-opsoekings ondersteun word, en HLR-navrae nie beskikbaar is vir hierdie bestemmings nie.

Versoek Suksesvolle Respons Fout Respons

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

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`countries`	string[]	'n Lys van twee-karakter ISO-landkodes.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/mccmncsbeskerm

Hierdie eindpunt lewer 'n omvattende lys van mobiele netwerkoperateurs saam met hul ooreenstemmende MCCMNC-identifiseerders en bykomende kontekstuele inligting.

Versoek Suksesvolle Respons Fout Respons

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`countrycode`	string(2)	'n Opsionele tweeletter ISO-landkode wat gebruik word om MCCMNC-resultate te filtreer, wat slegs rekords wat met die gespesifiseerde land geassosieer word, terugstuur.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`items`	object[]	'n Lys van mobiele netwerkoperateurs.	false
`country_name`	string	Die volledige landnaam in Engels.	false
`country_code`	string(2)	'n Tweeletter ISO-landkode wat die land van die mobiele operateur verteenwoordig.	false
`mccmnc`	string(5\|6)	'n Vyf- of seskarakter-string wat die MCCMNC verteenwoordig, wat die mobiele netwerkoperateur uniek identifiseer.	false
`mcc`	string(3)	'n Driekarakter Mobiele Landkode (MCC) wat die land identifiseer waar die mobiele netwerk bedryf word.	false
`mnc`	string(2\|3)	'n Twee- of driekarakter Mobiele Netwerkkode (MNC) wat die mobiele netwerk binne die gegewe MCC spesifiseer.	false
`brand`	string	Die kommersiële handelsnaam waaronder die netwerk bedryf word en deur verbruikers herken word.	true
`operator`	string	Die amptelike naam van die mobiele netwerkoperateur, tipies die regsentiteit wat die netwerk bestuur.	true
`parent_mccmnc`	string(5\|6)	'n Vyf- of seskarakter-string wat die MCCMNC van die ouer mobiele netwerkoperateur verteenwoordig, indien van toepassing.	true

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/pricebeskerm

Hierdie eindpunt gee die prys vir 'n HLR-, MNP- of NT-opsoek terug.

Versoek Suksesvolle Respons Fout Respons

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

Versoekparameters

Sleutel	Tipe	Beskrywing	Verstek	Verplig
`msisdn`	string	Die telefoonnommer waarvoor die prys verkry moet word. In internasionale formaat.	null	verpligtend
`route_type`	string	Die roetetipe, d.w.s. `HLR`, `MNP`, `NT`.	null	verpligtend
`route`	string(3)	Die roete waarvoor die prys bereken moet word. Verstekwaarde is die roete wat deur outomatiese roetering bepaal word.	null	opsioneel

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`price`	object	'n Objek met prysinligting.	false
`amount`	string	Die bedrag in EUR.	false
`msisdn`	string	Die MSISDN waarop hierdie prys van toepassing is.	false
`route_type`	string(2\|3)	Die roetetipe waarop hierdie prys van toepassing is.	false
`route`	string(3)	Die roete waarop hierdie prys van toepassing is.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/price-listbeskerm

Hierdie eindpunt gee die pryse in u rekening terug.

Versoek Suksesvolle Respons Fout Respons

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

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`pricing`	object[]	'n Lys van objekte met prysinligting.	false
`route`	string	Die roete waarop hierdie prys van toepassing is.	false
`countrycode`	string	Die twee-karakter ISO landkode waarop hierdie prys van toepassing is vir die ooreenstemmende roete, indien van toepassing.	true
`countryname`	string	Die Engelse landnaam wat ooreenstem met die landkode, indien van toepassing.	true
`mccmnc`	string	Die MCCMNC waarop hierdie prys van toepassing is vir die ooreenstemmende roete, indien van toepassing. Vervang landvlak-pryse.	true
`cns`	string	Die belvoorvoegsel waarop hierdie prys van toepassing is vir die ooreenstemmende roete, indien van toepassing. Vervang landvlak-pryse en MCCMNC-vlak-pryse.	true
`route_type`	string	Die ooreenstemmende roetetipe, d.w.s. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Die ooreenstemmende prys in EUR.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/balancebeskerm

Hierdie eindpunt haal jou huidige rekeningsaldo op, wat jou toelaat om prosesse te outomatiseer gebaseer op jou kredietstatus. Dit werk naatloos saam met die lae krediet kennisgewings-e-posse wat jy kan konfigureer op jou betalingsblad.

Versoek Suksesvolle Respons Fout Respons

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

{
    "balance":"1002.90"
}

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`balance`	string	Jou huidige rekeningsaldo in EUR. 'n Desimale waarde van tipe string.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/pingopenbaar

Hierdie eindpunt stuur 'n ping-versoek na die API en bied 'n eenvoudige metode om jou verbinding met die HLR Lookups API te toets.

Versoek Suksesvolle Respons Fout Respons

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

{
    "success":true
}

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`success`	boolean	Dui aan dat die versoek suksesvol verwerk is.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/timeopenbaar

Hierdie eindpunt gee 'n Unix-tydstempel terug wat die huidige tyd op die HLR Lookups-bediener verteenwoordig. Gebruik dit om jou bediener se horlosie te sinchroniseer wanneer jy die Digest-Auth-handtekening vir outentisering genereer, om sodoende enige verskille tussen jou bedienertyd en die HLR Lookups-bedienertyd reg te stel.

Versoek Suksesvolle Respons Fout Respons

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

{
    "time":1525898643
}

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`time`	integer	Unix-tydstempel wat die huidige HLR Lookups-bedienertyd verteenwoordig.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

GET/auth-testbeskerm

Hierdie eindpunt dien as 'n aanvanklike toets vir jou Basic-Auth of, verkieslik, Digest-Auth implementering.

Basiese Verifikasie Versoek Digest Auth Versoek Suksesvolle Respons Fout Respons

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

Versoek Opskrifte

Sleutel	Tipe	Beskrywing
`X-Basic`	string	SHA256-hash van `YOUR_API_KEY:YOUR_API_SECRET`. Sluit die dubbelpunt-simbool (:) in die hash in.

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"

Versoek Opskrifte

Sleutel	Tipe	Beskrywing
`X-Digest-Key`	string	Jou HLR Lookups API Sleutel
`X-Digest-Signature`	string	Unieke Digest-Auth handtekening (sien verifikasie)
`X-Digest-Timestamp`	integer	Huidige Unix tydstempel (sien ook `GET /time`)

{
    "success":true
}

Suksesvolle Respons Eienskappe

Naam	Tipe	Beskrywing	Nietig
`success`	boolean	Dui aan dat die versoek suksesvol verwerk is.	false

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

Foutrespons Parameters

Naam	Tipe	Beskrywing	Nietig
`errors[]`	string[]	'n Lys van stringe wat die fout verduidelik.	false

Rol Op

Verouderde API Dokumentasie

Let asseblief daarop dat die verouderde API afgekeur is en in die toekoms verwyder sal word. Ons beveel sterk aan dat u so gou as moontlik na die nuutste weergawe opgradeer.

Indien u ons HLR Lookups API tussen 2013 en vroeë 2020 geïmplementeer het, gebruik u ons verouderde API. Verwys asseblief na ons verouderde API dokumentasie in daardie geval.

Verouderde API Dokumentasie

API Dokumentasie

Aan die Gang Kom

HLR-opsoeke

MNP-opsoeke

NT-opsoeke

Roetebepaling

Pryse

Gereedskap

Aan die Gang Kom

Gebruik van die HLR Lookups API

Voorbeeldversoek

Voorbeeldlading

Suksesvolle Respons application/json

Bykomende Opsoeking Dienste

Mobiele Nommer Oordraagbaarheid (MNP) Opsoekings

Nommertipe-opsporing (NT) Opsoekings

Sagteware-ontwikkelingstelle (SDK's)

Gereedskap

Nie 'n Ontwikkelaar nie?

Verifikasie

API-sleutel en API-geheim

HTTP Basiese Verifikasie

Aanbeveel: X-Basic Opskrif met SHA256

Basiese Verifikasie Versoek

Basiese Verifikasie Opskrifte

Kode Voorbeeld

Versoek Voorbeeld

Versoek Opskrifte

Konstruksie van die Handtekening

Digest Handtekening Komponente

Kode Voorbeelde

Konsepte

Sinchroniese HLR-opsoekings-API

Asinkrone HLR Opsoek API

SDK's (Sagteware-ontwikkelingstelle)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupbeskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters

POST/hlr-lookupsbeskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters

Verwerking van Webhooks

Verifikasie

Kode Voorbeeld

Bevestiging van Ontvangs

Webhook-Vrag

Webhook-Vragattribute

POST/mnp-lookupbeskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters

POST/mnp-lookupsbeskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters

Verwerking van Webhooks

Verifikasie

Kode Voorbeeld

Bevestiging van Ontvangs

Webhook-Vrag

Webhook-Vragattribute

POST/nt-lookupbeskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters

POST/nt-lookups beskerm

Vragdata

Versoekparameters

Suksesvolle Respons Eienskappe

Foutrespons Parameters