Kuanza

Miundombinu ya mtandao wa simu za mkononi duniani inafanya kazi kwa mfumo unaoitwa mtandao wa ishara wa SS7. Mtandao huu huwezesha kubadilishana data ya wanunuzi, upangaji wa simu, utumaji wa SMS, na usasishaji wa hali ya muunganisho wa simu za mkononi kati ya watoaji huduma. Kila mtandao wa simu za mkononi unaweka Rejista ya Eneo la Nyumbani (HLR) - hifadhidata kuu inayohifadhi maelezo muhimu kuhusu wanunuzi wake.

Teknolojia ya Utafutaji wa HLR inawezesha biashara kuuliza rejista hizi na kupata maelezo ya muunganisho na mtandao kwa wakati halisi kwa nambari yoyote ya simu ya mkononi. Hii inajumuisha ikiwa simu imewashwa, ni mtandao upi iliopangiwa sasa hivi, ikiwa imenakiliwa, ikiwa nambari ni halali au imezimwa, na ikiwa iko kwenye roaming.

API ya Utafutaji wa HLR inatoa ufikiaji wa moja kwa moja na wa wakati halisi kwa data hii, ikiruhusu biashara kuthibitisha nambari za simu za mkononi, kuboresha upangaji, na kuimarisha mawasiliano ya wateja. Nyaraka hii itakuongoza katika kuunganisha Utafutaji wa HLR kwenye programu yako, ikiwezesha upatikanaji wa kiotomatiki wa ufahamu wa simu za mkononi kwa wakati halisi.

Kutumia API ya Utafutaji wa HLR

Kutekeleza hoja za Utafutaji wa HLR ni haraka, salama, na rahisi. Mara tu umejiandikisha na kupata Funguo yako ya API, unaweza kuthibitisha utambulisho na kuanza utafutaji wa papo hapo kwa maombi rahisi ya HTTP POST, kupitia POST /hlr-lookup. Vinginevyo, unaweza kusindika seti kubwa za data kwa kuchagua maombi ya haraka ya API ya asynchronous na matokeo yanaporudishwa kwenye seva yako kupitia webhook, kama ilivyoelezwa katika sehemu ya dhana.

Mfano wa Ombi

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"

Uthibitishaji unatolewa kupitia vichwa vya HTTP, na payload.json inapaswa (kwa kiwango cha chini) kuwa na kitu cha JSON kifuatacho:

Mfano wa Payload

{
   "msisdn": "+14156226819"
}

Baada ya utekelezaji uliofaulu, utapokea jibu lenye maelezo ya muunganisho wa wakati halisi kwa nambari ya simu ya mkononi iliyobainishwa.

Jibu la Mafanikio 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"
}

Kwa maelezo kamili ya sifa za ombi na jibu na hali za muunganisho, tazama POST /hlr-lookup.

Huduma za Utafutaji Zaidi

Utafutaji wa Uhamishaji wa Nambari za Simu (MNP)

Tumia utafutaji wa MNP ili kubainisha umiliki wa mtandao na maelezo ya uhamishaji bila kuuliza muunganisho wa wakati halisi. Ikiwa unahitaji tu MCCMNC ya nambari, rejelea POST /mnp-lookup.

Utafutaji wa Utambuzi wa Aina ya Nambari (NT)

Bainisha ikiwa nambari ya simu ni ya simu ya mezani, simu ya mkononi, ya kiwango cha juu, VoIP, pager, au masafa mengine ya mpango wa nambari kwa POST /nt-lookup.

Vifaa vya Utengenezaji wa Programu (SDK)

API ya Utafutaji wa HLR inafanya kazi na mteja yeyote wa REST katika lugha yoyote ya programu na tumechapisha SDK kwa PHP, Ruby, na NodeJS kwenye GitHub yetu ili kukusaidia kuanza haraka.

Zana

Ili kuhakikisha uzoefu wa maendeleo usio na kikwazo, tunatoa mkusanyiko kamili wa zana, ikijumuisha ufuatiliaji wa maombi ya API na webhook kwenye kivinjari, orodha nyeupe ya anwani za IP, chaguo madhubuti za uthibitishaji options, na kipengele cha majaribio cha uthibitishaji.

Si Msanidi Programu?

Utafutaji wa HLR na Hoja za Uhamishaji wa Nambari zinaweza kufanywa bila kuandika msimbo wowote. Jifunze zaidi kuhusu mteja wetu wa wavuti wa biashara na vipengele vya ripoti vinavyotegemea kivinjari.

Uthibitishaji

Ili kuhakikisha usalama na udhibiti sahihi wa ufikiaji, maombi mengi kwa API ya HLR Lookups yanahitaji uthibitishaji. Vituo vya mwisho vimegawanywa kama vya umma au vilivyolindwa. Unapofikia kituo cha mwisho kilicholindwa, ombi lako lazima lithibitishwe kwa kutumia funguo yako ya API na siri kupitia njia ya Digest-Auth au Basic-Auth. Digest-Auth ni chaguo salama zaidi na inashauriwa sana. Tumia kituo cha mwisho cha GET /auth-test ili kuthibitisha mipangilio yako ya uthibitishaji.

Funguo ya API na Siri ya API

Pata funguo yako ya API na siri kutoka ukurasa wa mipangilio ya API. Unaweza pia kusanidi njia yako unayopendelea ya uthibitishaji na kuwezesha orodha nyeupe ya anwani za IP kwa usalama ulioboreshwa. Ikiwa unadhani kwamba siri yako ya API imevunjwa, unaweza kutengeneza mpya wakati wowote.

Uthibitishaji wa Msingi Uthibitishaji wa Digest Orodha Nyeupe ya IP

Uthibitishaji wa Msingi wa kawaida ni rahisi kutekeleza na unasaidiwa sana. Unaweza kuthibitisha kwa kupitisha funguo yako ya API na siri kama jozi ya user:pass katika ombi la HTTP.

Uthibitishaji wa Msingi wa HTTP

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

Hii hutuma kichwa cha Authorization:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Inashauriwa: Kichwa cha X-Basic na SHA256

Kwa usalama ulioboreshwa, unaweza kutuma hash ya SHA256 ya vitambulisho vyako badala ya kuvituma moja kwa moja kama base64. Ili kutumia njia hii, kokotoa hash ya jozi yako ya YOUR_API_KEY:YOUR_API_SECRET na uitume kupitia kichwa cha X-Basic:

Ombi la Uthibitishaji wa Msingi

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

Vichwa vya Uthibitishaji wa Msingi

Funguo	Aina	Maelezo
`X-Basic`	string	Hash ya SHA256 ya `YOUR_API_KEY:YOUR_API_SECRET`. Jumuisha alama ya koloni (:) katika hash.	lazima

Mfano wa Msimbo

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

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

Digest-Auth ni njia inayopendekezwa kwa kulinda ufikiaji wa vituo vya mwisho vilivyolindwa vya API ya HLR Lookup. Kila ombi lazima lijumuishe vichwa vifuatavyo: X-Digest-Key, X-Digest-Signature, na X-Digest-Timestamp, ambavyo vimeelezwa hapa chini.

Mfano wa Ombi

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"

Vichwa vya Ombi

Funguo	Aina	Maelezo
`X-Digest-Key`	string	Funguo yako ya kipekee ya API ya HLR Lookups.	lazima
`X-Digest-Signature`	string	Saini ya kipekee ya uthibitishaji (angalia hapa chini).	lazima
`X-Digest-Timestamp`	integer	Muhula wa sasa wa Unix (pia angalia `GET /time`).	lazima

Kujenga Saini

X-Digest-Signature inatengenezwa kwa kutumia hash ya SHA256 HMAC, na siri yako ya API kama funguo inayoshirikiwa.

Mfuatano wa kuhash umeundwa kama ifuatavyo:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Alama ya . inawakilisha kuunganisha mifuatano.

Vipengele vya Saini ya Digest

Kipengele	Aina	Maelezo
`ENDPOINT_PATH`	string	Kituo cha mwisho cha API kilichoombwa, mfano, `/auth-test` kwa herufi ndogo.
`UNIX_TIMESTAMP`	integer	Muhula wa sasa wa Unix (lazima uwe ndani ya sekunde 30). Angalia `GET /time`.
`REQUEST_METHOD`	string	Njia ya HTTP iliyotumika, mfano, `POST` au `GET`.
`REQUEST_BODY`	string	Data ya mwili wa ombi. Weka kuwa `null` kwa maombi ya `GET`.

Mifano ya Msimbo

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)

Sogeza Juu

Dhana

Kutekeleza Utafutaji wa HLR katika lugha yoyote ya programu au mfumo kupitia REST API yetu ya HTTP ni rahisi na yenye ufanisi. Kwa mchakato rahisi wa uunganishaji, unaweza kuanza kuhoji mitandao ya simu za mkononi kwa wakati halisi ili kupata maarifa ya papo hapo kuhusu uhalali wa nambari za simu, hali ya muunganisho, na maelezo ya upelekaji.

Kuchagua API inayofaa inategemea matumizi mahususi yako. Ikiwa unahitaji matokeo ya utafutaji wa wakati halisi kwa programu kama simu ya VoIP, ugunduzi wa ulaghai, au upelekaji wa SMS, API ya usawazishaji ndiyo chaguo bora. Hata hivyo, ikiwa matumizi yako yanahusisha usindikaji wa kiasi kikubwa, utafutaji wa wingi, au uthibitishaji wa data kwa kiwango kikubwa, API isiyo ya usawazishaji inatoa utendaji uliobobeishwa na ufanisi wa bandwidth pamoja na uwezo wa utafutaji wa kundi.

Sanidi API kutumia moja ya chaguo zetu maalum za upelekaji ili kuongeza kasi, usahihi, na ufanisi wa gharama. Unaweza pia kuhifadhi matokeo ya utafutaji katika hifadhi kwa upakuliaji rahisi wa ripoti za CSV na JSON, pamoja na uchanganuzi wa hali ya juu kupitia kiolesura cha wavuti.

API ya Utafutaji wa HLR wa Usawazishaji

Kituo cha POST /hlr-lookup kinachakata nambari moja ya simu ya mkononi (MSISDN) kwa kila ombi na kurudisha matokeo mara moja katika mwili wa jibu la HTTP. Matokeo yameundwa kwa muundo wa JSON na ni bora kwa programu za wakati halisi, ikiwa ni pamoja na uthibitishaji wa nambari za simu za mkononi, upelekaji wa simu, na utoaji wa ujumbe wa SMS.

Wito wa API ya usawazishaji unajumuisha ombi la moja kwa moja la HTTP na jibu. Mfumo wako unawasilisha MSISDN moja (nambari ya simu ya mkononi) kwa kila ombi na kupokea jibu la papo hapo lenye matokeo ya utafutaji wa HLR wa wakati halisi katika muundo wa JSON. API hii imeboreshwa kwa matumizi yanayohitaji uthibitishaji wa papo hapo na ukaguzi wa muunganisho, kama vile ugunduzi wa ulaghai, upelekaji wa simu za VoIP, na uboreshaji wa lango la SMS.

API ya Utafutaji wa HLR Usiozuiaji

Kituo cha POST /hlr-lookups kimeundwa kwa usindikaji wa wingi na kiasi kikubwa, kukuruhusu kuwasilisha hadi MSISDN 1,000 kwa kila ombi. Badala ya kurudisha matokeo mara moja, API hii hutumia webhooks za kiotomatiki kupeleka matokeo hatua kwa hatua kwenye seva yako. Matokeo ya utafutaji yanarudishwa kama vitu vya JSON kupitia HTTP POST callbacks.

API isiyo ya usawazishaji imeboreshwa kwa kasi, ufanisi, na uwezo wa kupanua. Inaondoa matatizo ya ucheleweshaji wa mtandao yanayohusiana na simu za usawazishaji, na kuifanya kuwa bora kwa biashara zinazohitaji utafutaji wa kasi ya juu. Mfumo wako unawasilisha hadi MSISDN 1,000 kwa kila ombi, na jukwaa letu linazisindika kwa sambamba, likipeleka matokeo kwenye seva yako kupitia HTTP webhooks katika makundi ya hadi matokeo 1,000 kwa kila callback.

SDK (Vifaa vya Uendelezaji wa Programu)

Vifaa vyetu vya Uendelezaji wa Programu (SDK) vya PHP, NodeJS, na Ruby vinarahisisha mchakato wa uunganishaji, kukuruhusu kuunganisha na HLR Lookups API kwa ufanisi na kwa juhudi ndogo.

SDK hizi zinatoa kazi zilizojengwa tayari, usimamizi wa uthibitishaji, na violezo vilivyopangwa vya maombi ya API, kupunguza muda wa uendelezaji na kuhakikisha mazoea bora.

Chunguza orodha yetu kamili ya SDK zinazopatikana kwenye GitHub na uanze kuunganisha leo.

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

Tazama kwenye 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   }

Tazama kwenye 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)

Tazama kwenye GitHub README.md

Sogeza Juu

POST/hlr-lookupilindwa

Inafanya Utafutaji wa HLR wa moja kwa moja, ikitoa data ya moja kwa moja ya uunganisho wa simu ya mkononi na uhamishaji kutoka kwa waendeshaji wa mitandao. Njia hii ni bora kwa hali za trafiki ya moja kwa moja ambapo programu zinazohitaji muda zinahitaji uthibitisho wa papo hapo wa kama nambari ya simu inapatikana kwa sasa (imeunganishwa) au haipo (imezimwa). Aidha, inasaidia kutofautisha nambari zinazotumika na zile zisizo halali, zisizojulikana, au za bandia.

Kwa usindikaji wa wingi wa seti kubwa za data ambazo hazihitaji matokeo ya papo hapo, fikiria kutumia POST /hlr-lookups isiyo ya moja kwa moja, ambayo imeboreshwa kwa usindikaji wa kasi ya wingi.

Ikiwa lengo lako kuu ni kupata data ya uhamishaji wa nambari za simu za mkononi (MCCMNC) na huhitaji hali ya uunganisho wa moja kwa moja, POST /mnp-lookup inatoa njia mbadala ya gharama nafuu kwa maswali ya uhamishaji wa nambari za simu za mkononi.

Ombi Jibu la Mafanikio Jibu la Hitilafu Marejeo ya Hali

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdn`	string	Nambari ya simu ya mkononi (MSISDN) itakayoulizwa, inayotolewa katika muundo wa kimataifa (mfano, +14156226819 au 0014156226819). Nambari za nchi lazima zijumuishwe.	null	lazima
`route`	string(3)	Kitambulisho cha hiari cha herufi tatu kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au acha mfumo wetu uamue kiotomatiki njia bora kwa utafutaji huu.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee kilichotolewa kwa ombi hili la utafutaji.	false
`msisdn`	string	Nambari ya simu ya mkononi inayoulizwa, iliyoandikwa kwa muundo wa kimataifa (mfano, +14156226819 au 0014156226819).	false
`connectivity_status`	string	Inaonyesha kama hali ya muunganisho wa nambari ilipatikana kwa mafanikio. Thamani zinazowezekana: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , au `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Msimbo wa tarakimu tano au sita wa Mobile Country Code (MCC) na Mobile Network Code (MNC) unaotambulisha mtandao unaohusishwa kwa sasa na nambari ya simu.	true
`mcc`	string(3)	Msimbo wa tarakimu tatu wa Mobile Country Code (MCC) unaotambulisha nchi ambayo nambari ya simu imesajiliwa.	true
`mnc`	string(2\|3)	Msimbo wa tarakimu mbili au tatu wa Mobile Network Code (MNC) unaotambulisha mtandao mahususi ambao nambari ya simu inamilikiwa.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), kitambulisho cha kipekee cha kadi ya SIM inayohusishwa na nambari hii. Upatikanaji unategemea usanidi wa mtandao.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) ndani ya hifadhidata ya opereta wa simu. Upatikanaji unategemea usanidi wa mtandao.	true
`msc`	string(12)	Mobile Switching Center (MSC) inayoshughulikia kwa sasa mawasiliano ya mteja huyu. Upatikanaji unategemea usanidi wa mtandao.	true
`original_network_name`	string	Jina la asili (la mwanzo) la opereta wa mtandao linalohusishwa na nambari hii.	true
`original_country_name`	string	Jina kamili la nchi ambayo nambari ya simu ya mkononi ilisajiliwa awali, limetolewa kwa Kiingereza.	true
`original_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaowakilisha nchi ambayo nambari ya simu ilipewa awali.	true
`original_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) unaolingana na nchi ya asili ya nambari ya simu ya mkononi.	true
`is_ported`	boolean	Inaonyesha kama nambari ya simu imehamishwa kutoka mtandao wake wa asili kwenda kwa opereta mwingine.	true
`ported_network_name`	string	Jina la opereta wa mtandao ambayo nambari ya simu imehamishiwa, ikiwa inatumika.	true
`ported_country_name`	string	Jina la nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`ported_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaowakilisha nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`ported_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) wa nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`is_roaming`	boolean	Inaonyesha kama nambari ya simu kwa sasa iko kwenye roaming katika mtandao wa kigeni. Upatikanaji wa hali ya roaming unategemea opereta wa mtandao wa simu.	true
`roaming_network_name`	string	Jina la mtandao ambao nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_name`	string	Jina la nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO wa nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) wa nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`cost`	string	Thamani ya desimali iliyowakilishwa kama mfuatano wa herufi, inayoonyesha gharama ya utafutaji kwa EUR.	true
`timestamp`	string	Alama ya muda iliyoandikwa kwa muundo wa W3C ikijumuisha eneo la muda, inayobainisha wakati utafutaji ulikamilika.	true
`storage`	string	Jina la hifadhi ambapo matokeo ya utafutaji yalihifadhiwa. Hii inalingana na majina ya ripoti na upakuaji wa CSV unapatikana kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachoonyesha njia ya upelekaji iliyotumika kwa ombi hili la utafutaji.	true
`processing_status`	string	Matokeo ya usindikaji wa utafutaji. Thamani zinazowezekana: `COMPLETED` (umefanikiwa), `REJECTED` (mtandao haupatikani, hakuna malipo yaliyotumika), au `FAILED` (kosa lilitokea wakati wa usindikaji).	false
`error_code`	integer	Msimbo wa kosa la ndani wa hiari unaotoa maelezo ya ziada ya uchunguzi kwa huduma kwa wateja.	true
`error_description`	string	Maelezo mafupi ya msimbo wa kosa uliotolewa (ikiwa upo) kwa maandishi ya kawaida ya Kiingereza.	true
`data_source`	string	Chanzo cha data kilichotumika kwa ombi hili. Thamani zinazowezekana: `LIVE_HLR` (ulizo wa HLR wa wakati halisi) au `MNP_DB` (hifadhidata thabiti ya uhamishaji wa nambari za simu). Rejelea chaguo za upelekaji kwa maelezo.	false
`routing_instruction`	string	Mfuatano wa herufi uliotenganishwa na koloni unaoelezea maelekezo ya upelekaji yaliyotumika katika ombi. Sehemu ya kwanza ni `STATIC` unapobainisha njia au `AUTO` kwa upelekaji wa kiotomatiki; sehemu ya pili ni kitambulisho cha njia, na kwa maombi ya upelekaji wa kiotomatiki sehemu ya tatu inaonyesha asili ambayo uamuzi wa upelekaji unategemea (yaani `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."
    ]
}

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Hali	Maelezo
CONNECTED	Nambari ni halali, na simu lengwa imeunganishwa kwa mtandao wa simu kwa sasa. Simu, SMS, na huduma zingine zinapaswa kumfikia mpokeaji bila tatizo.
ABSENT	Nambari ni halali, lakini simu lengwa imezimwa au iko nje ya eneo la mtandao kwa muda. Ujumbe au simu zinaweza kutofika hadi kifaa kitakapounganishwa tena na mtandao.
INVALID_MSISDN	Nambari si halali au haijapewa mtumiaji yeyote kwenye mtandao wa simu kwa sasa. Simu na ujumbe kwa nambari hii vitashindwa.
UNDETERMINED	Hali ya muunganisho wa nambari haikuweza kubainiwa. Hii inaweza kutokana na nambari batili, jibu la hitilafu ya SS7, au ukosefu wa muunganisho na mtoa huduma wa mtandao lengwa. Angalia msimbo wa hitilafu na sehemu yake ya maelezo kwa uchunguzi zaidi.

Sogeza Juu

POST/hlr-lookupsilindwa

Inaanzisha kundi la utafutaji wa HLR wa asynchronous, inayopata data ya mawasiliano ya simu ya mkononi na usafirishaji kutoka kwa waendeshaji wa mtandao. Matokeo yanatumwa kupitia webhooks kwenye seva yako. Njia hii imeboreshwa kwa ajili ya kusindika idadi kubwa ya nambari ambazo hazihitaji majibu ya papo hapo, kama vile kusafisha na kuthibitisha hifadhidata. Kwa matumizi ya wakati halisi kama vile upelekaji wa simu au utumaji wa SMS, fikiria kutumia endpoint ya POST /hlr-lookup badala yake.

Endpoint hii ni bora kwa usindikaji wa wingi wakati lengo ni kutambua nambari za simu ambazo zinapatikana kwa sasa (zimeunganishwa) au hazipatikani (simu imezimwa) huku ikichuja nambari zisizo halali, ambazo hazijapewa, au za bandia. Zaidi ya hayo, inatoa hali ya usafirishaji wa moja kwa moja (MCCMNC) pamoja na maelezo ya muunganisho.

Kabla ya kutumia endpoint hii, hakikisha kwamba URL ya webhook imesanidiwa ili kupokea matokeo ya utafutaji kwa njia ya asynchronous. Unaweza kusanidi hii katika mipangilio ya API yako.

Ombi Jibu la Mafanikio Jibu la Hitilafu Webhooks Marejeo ya Hali

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdns`	array	Safu ya nambari za simu za mkononi (MSISDNs) katika muundo wa kimataifa (mfano +14156226819 au 0014156226819). Unaweza kujumuisha hadi nambari 1000 kwa kila ombi.	null	lazima
`route`	string(3)	Kitambulisho cha hiari cha herufi tatu kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au acha mfumo wetu uamue kiotomatiki njia bora kwa utafutaji huu.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`accepted`	array	Orodha ya vitu vinavyojumuisha vitambulisho vya kipekee na MSISDNs ambazo zimekubaliwa kwa ajili ya usindikaji.	false
`accepted_count`	integer	Jumla ya idadi ya MSISDNs zilizokubaliwa kwa mafanikio kwa ajili ya usindikaji.	false
`rejected`	array	Orodha ya vitu vinavyojumuisha vitambulisho vya kipekee na MSISDNs ambazo zimekataliwa kwa ajili ya usindikaji, kwa kawaida kwa sababu ya nambari zisizo halali. Hakuna malipo yanayotumika kwa maingizo yaliyokataliwa.	false
`rejected_count`	integer	Jumla ya idadi ya MSISDNs zilizokataliwa kwa sababu ya makosa ya uthibitishaji.	false
`total_count`	integer	Jumla ya hesabu ya MSISDNs zilizokubaliwa na kukataliwa ambazo ziliwasilishwa kwa ajili ya usindikaji.	false
`cost`	string	Thamani ya desimali inayowakilishwa kama mfuatano wa herufi, inayoonyesha gharama ya jumla kwa EUR kwa utafutaji uliokubaliwa.	false
`storage`	string	Jina la hifadhi ambapo matokeo ya utafutaji yanaongezwa, yanayotumiwa kwa ajili ya ripoti na upakuaji wa CSV kupitia kiolesura cha wavuti.	false
`route`	string(3\|4)	Kitambulisho cha herufi tatu au nne kinachoainisha njia iliyotumika kwa ombi hili la utafutaji. Ina AUTO ikiwa upelekaji wa kiotomatiki kulingana na nambari uliombwa.	false
`webhook_urls`	array	URL za webhook zilizosanidiwa katika mipangilio ya API yako. Matokeo yanachapiswa hapa.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Uchakataji wa Webhooks

Baada ya kuwasilisha, jukwaa letu huanza kuchakata nambari za simu zilizotolewa na kutuma matokeo kwenye URL ya webhook iliyobainishwa awali kwenye seva yako. Matokeo yanatumwa kama ombi la HTTP POST lenye kitu cha JSON katika mwili wa ombi.

Uthibitishaji

Thibitisha webhook kwa kuchunguza kichwa cha HTTP cha X-Signatures.

Kichwa cha X-Signatures kina orodha ya saini zilizotengwa kwa nukta-mkato. Kila saini kwenye orodha inazalishwa kwa kutumia moja ya siri za API zilizosanidiwa kwenye akaunti yako. Ili kuthibitisha webhook, tengeneza hash ya SHA-256 kwa kutumia ufunguo wako wa API, siri, na mwili wa HTTP ghafi - kisha ulinganishe na saini zilizo kwenye orodha.

Kulingana kunathibitisha kuwa ombi ni halali na limesainiwa kwa siri unayoidhibiti.

Mfano wa Msimbo

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

Ombi ni halali ikiwa saini yoyote iliyotolewa kwenye kichwa inalingana na hash ya SHA256 iliyokokotolewa juu ya mfuatano wa ufunguo wako wa API, siri, na mwili wa HTTP.

Kuthibitisha Kupokea

Seva yako inatarajiwa kujibu na msimbo wa hali ya HTTP 200 OK ili kuthibitisha kupokea kwa mafanikio. Ikiwa msimbo mwingine wa majibu utarudishwa, muda ukiisha (sekunde 10), au tatizo lingine la utoaji likitokea, mfumo utajaribu tena webhook baada ya dakika moja kiotomatiki. Ikiwa ombi litaendelea kushindwa, majaribio yatafuata mkakati wa exponential backoff, na majaribio yanayofuata baada ya dakika 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024.

Utaratibu huu wa kujaribu tena unahakikisha kuaminika kwa juu katika kutoa matokeo ya utafutaji kwa miundombinu yako. Inapunguza hatari ya kupoteza data kutokana na matatizo ya muda ya mtandao au seva kuwa nje ya mkono.

Mzigo wa Webhook

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

Sifa za Webhook Payload

Kitu cha JSON kina sifa ya type => HLR pamoja na sifa ya results inayojumuisha orodha ya vitu vya utafutaji, kama ilivyoandikwa hapa chini.

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee kilichotolewa kwa ombi hili la utafutaji.	false
`msisdn`	string	Nambari ya simu ya mkononi inayoulizwa, iliyoandikwa kwa muundo wa kimataifa (mfano, +14156226819 au 0014156226819).	false
`connectivity_status`	string	Inaonyesha kama hali ya muunganisho wa nambari ilipatikana kwa mafanikio. Thamani zinazowezekana: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , au `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Msimbo wa tarakimu tano au sita wa Mobile Country Code (MCC) na Mobile Network Code (MNC) unaotambulisha mtandao unaohusishwa kwa sasa na nambari ya simu.	true
`mcc`	string(3)	Msimbo wa tarakimu tatu wa Mobile Country Code (MCC) unaotambulisha nchi ambayo nambari ya simu imesajiliwa.	true
`mnc`	string(2\|3)	Msimbo wa tarakimu mbili au tatu wa Mobile Network Code (MNC) unaotambulisha mtandao mahususi ambao nambari ya simu inamilikiwa.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), kitambulisho cha kipekee cha kadi ya SIM inayohusishwa na nambari hii. Upatikanaji unategemea usanidi wa mtandao.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) ndani ya hifadhidata ya opereta wa simu. Upatikanaji unategemea usanidi wa mtandao.	true
`msc`	string(12)	Mobile Switching Center (MSC) inayoshughulikia kwa sasa mawasiliano ya mteja huyu. Upatikanaji unategemea usanidi wa mtandao.	true
`original_network_name`	string	Jina la asili (la mwanzo) la opereta wa mtandao linalohusishwa na nambari hii.	true
`original_country_name`	string	Jina kamili la nchi ambayo nambari ya simu ya mkononi ilisajiliwa awali, limetolewa kwa Kiingereza.	true
`original_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaowakilisha nchi ambayo nambari ya simu ilipewa awali.	true
`original_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) unaolingana na nchi ya asili ya nambari ya simu ya mkononi.	true
`is_ported`	boolean	Inaonyesha kama nambari ya simu imehamishwa kutoka mtandao wake wa asili kwenda kwa opereta mwingine.	true
`ported_network_name`	string	Jina la opereta wa mtandao ambayo nambari ya simu imehamishiwa, ikiwa inatumika.	true
`ported_country_name`	string	Jina la nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`ported_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaowakilisha nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`ported_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) wa nchi ambayo nambari ya simu ilihamishiwa, ikiwa inatumika.	true
`is_roaming`	boolean	Inaonyesha kama nambari ya simu kwa sasa iko kwenye roaming katika mtandao wa kigeni. Upatikanaji wa hali ya roaming unategemea opereta wa mtandao wa simu.	true
`roaming_network_name`	string	Jina la mtandao ambao nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_name`	string	Jina la nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO wa nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`roaming_country_prefix`	string	Msimbo wa kupiga simu kimataifa (msimbo wa kupiga nchi) wa nchi ambayo nambari ya simu iko kwenye roaming kwa sasa, ikiwa inatumika.	true
`cost`	string	Thamani ya desimali iliyowakilishwa kama mfuatano wa herufi, inayoonyesha gharama ya utafutaji kwa EUR.	true
`timestamp`	string	Alama ya muda iliyoandikwa kwa muundo wa W3C ikijumuisha eneo la muda, inayobainisha wakati utafutaji ulikamilika.	true
`storage`	string	Jina la hifadhi ambapo matokeo ya utafutaji yalihifadhiwa. Hii inalingana na majina ya ripoti na upakuaji wa CSV unapatikana kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachoonyesha njia ya upelekaji iliyotumika kwa ombi hili la utafutaji.	true
`processing_status`	string	Matokeo ya usindikaji wa utafutaji. Thamani zinazowezekana: `COMPLETED` (umefanikiwa), `REJECTED` (mtandao haupatikani, hakuna malipo yaliyotumika), au `FAILED` (kosa lilitokea wakati wa usindikaji).	false
`error_code`	integer	Msimbo wa kosa la ndani wa hiari unaotoa maelezo ya ziada ya uchunguzi kwa huduma kwa wateja.	true
`error_description`	string	Maelezo mafupi ya msimbo wa kosa uliotolewa (ikiwa upo) kwa maandishi ya kawaida ya Kiingereza.	true
`data_source`	string	Chanzo cha data kilichotumika kwa ombi hili. Thamani zinazowezekana: `LIVE_HLR` (ulizo wa HLR wa wakati halisi) au `MNP_DB` (hifadhidata thabiti ya uhamishaji wa nambari za simu). Rejelea chaguo za upelekaji kwa maelezo.	false
`routing_instruction`	string	Mfuatano wa herufi uliotenganishwa na koloni unaoelezea maelekezo ya upelekaji yaliyotumika katika ombi. Sehemu ya kwanza ni `STATIC` unapobainisha njia au `AUTO` kwa upelekaji wa kiotomatiki; sehemu ya pili ni kitambulisho cha njia, na kwa maombi ya upelekaji wa kiotomatiki sehemu ya tatu inaonyesha asili ambayo uamuzi wa upelekaji unategemea (yaani `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

Hali	Maelezo
CONNECTED	Nambari ni halali, na simu lengwa imeunganishwa kwa mtandao wa simu kwa sasa. Simu, SMS, na huduma zingine zinapaswa kumfikia mpokeaji bila tatizo.
ABSENT	Nambari ni halali, lakini simu lengwa imezimwa au iko nje ya eneo la mtandao kwa muda. Ujumbe au simu zinaweza kutofika hadi kifaa kitakapounganishwa tena na mtandao.
INVALID_MSISDN	Nambari si halali au haijapewa mtumiaji yeyote kwenye mtandao wa simu kwa sasa. Simu na ujumbe kwa nambari hii vitashindwa.
UNDETERMINED	Hali ya muunganisho wa nambari haikuweza kubainiwa. Hii inaweza kutokana na nambari batili, jibu la hitilafu ya SS7, au ukosefu wa muunganisho na mtoa huduma wa mtandao lengwa. Angalia msimbo wa hitilafu na sehemu yake ya maelezo kwa uchunguzi zaidi.

Sogeza Juu

POST/mnp-lookupilindwa

Inafanya utafutaji wa MNP wa moja kwa moja na kutoa taarifa za uhamishaji wa nambari za simu na mtandao. Njia hii inafaa ikiwa lengo lako kuu ni kupata MCCMNC ya sasa ya nambari ya simu mahususi na kutambua mtandao wa asili na wa sasa kwa wakati halisi.

Kwa usindikaji wa wingi wa seti kubwa za data ambazo hazihitaji matokeo ya papo hapo, fikiria kutumia POST /mnp-lookups isiyo ya moja kwa moja, ambayo imeboreshwa kwa usindikaji wa kasi ya wingi.

Hojaji za MNP zinabainisha kwa kuaminika taarifa za uhamishaji na mtandao lakini hazionyeshi kama simu lengwa imeunganishwa kwenye mtandao na inaweza kufikiwa. Ili kupata taarifa za muunganisho wa moja kwa moja, tafadhali tumia njia ya POST /hlr-lookup badala yake.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdn`	string	Nambari ya simu ya mkononi (MSISDN) itakayoulizwa, inayotolewa katika muundo wa kimataifa (mfano, +14156226819 au 0014156226819). Nambari za nchi lazima zijumuishwe.	null	lazima
`route`	string(3)	Kitambulisho cha hiari cha herufi tatu kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au acha mfumo wetu uamue kiotomatiki njia bora kwa utafutaji huu.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee cha herufi 12 cha utaftaji huu.	false
`msisdn`	string	Nambari ya simu ya mkononi iliyotathminiwa katika ombi hili la utaftaji.	false
`query_status`	string	Inaonyesha kama urejesho wa taarifa za usafirishaji na mtandao ulifanikiwa. Thamani zinazowezekana ni `OK` au `FAILED`.	false
`mccmnc`	string(5\|6)	MCCMNC ya herufi tano au sita (msimbo wa nchi ya simu ya mkononi na msimbo wa mtandao wa simu ya mkononi) inayotambulisha mtandao ambao nambari ya simu ya mkononi ipo sasa hivi.	true
`mcc`	string(3)	MCC ya herufi tatu (msimbo wa nchi ya simu ya mkononi) inayowakilisha nchi inayohusiana na mtandao wa sasa wa nambari ya simu ya mkononi.	true
`mnc`	string(2\|3)	MNC ya herufi mbili au tatu (msimbo wa mtandao wa simu ya mkononi) inayotambulisha mfanyabiashara wa mtandao wa sasa wa nambari ya simu ya mkononi.	true
`is_ported`	boolean	Inaonyesha kama nambari ya simu imesafirishwa kutoka mtandao wake wa asili kwenda kwa mfanyabiashara mpya.	true
`original_network_name`	string	Mfuatano wa herufi wa hiari (kwa Kiingereza) unaobainisha jina la mfanyabiashara wa mtandao wa asili wa nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_name`	string	Mfuatano wa herufi wa hiari (kwa Kiingereza) unaobainisha nchi ya asili ya nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_code`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili unaowakilisha nchi ya asili ya nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_prefix`	string	Msimbo wa kupiga simu wa nchi ya asili inayohusiana na nambari ya simu ya mkononi iliyochunguzwa.	true
`ported_network_name`	string	Inabainisha mfanyabiashara wa mtandao ambaye nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_name`	string	Inabainisha nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_code`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili unaowakilisha nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_prefix`	string	Msimbo wa kupiga simu wa nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`extra`	string	Mfuatano wa herufi wa hiari unaotoa maelezo ya ziada kuhusu nambari ya simu.	true
`cost`	string	Thamani ya desimali, inayowakilishwa kama mfuatano wa herufi, inayoonyesha gharama kwa EUR ya utaftaji huu.	true
`timestamp`	string	Alama ya muda ya muundo wa W3C, ikijumuisha taarifa za saa za eneo, inayoonyesha wakati utaftaji ulipomaliza.	true
`storage`	string	Jina la uhifadhi (au jina la ripoti) ambalo matokeo ya utaftaji yaliongezwa. Hii inatumika kwa upakuaji wa CSV na uripotiaji kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utaftaji.	true
`error_code`	integer	Msimbo wa kosa la ndani wa hiari unaotoa muktadha wa ziada kwa uchunguzi wa usaidizi wa wateja.	true

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

POST/mnp-lookupsilindwa

Inaanzisha kundi la utafutaji wa MNP (uhamishaji wa nambari za simu) wa asynchronous, ikipata MCCMNC ya sasa na kuainisha mitandao ya asili na ya sasa kwa wakati halisi. Matokeo yanatumwa kupitia webhooks kwenye seva yako. Njia hii imeboreshwa kwa ajili ya kusindika idadi kubwa ya nambari ambazo hazihitaji majibu ya papo hapo, kama vile kusafisha na kuthibitisha hifadhidata. Kwa matumizi ya wakati halisi kama vile upelekaji wa simu au utumaji wa SMS, fikiria kutumia endpoint ya POST /mnp-lookup badala yake.

Hojaji za MNP zinabainisha kwa kuaminika taarifa za uhamishaji na mtandao lakini hazionyeshi kama simu lengwa imeunganishwa kwenye mtandao na inaweza kufikiwa. Ili kupata taarifa za muunganisho wa moja kwa moja, tafadhali tumia njia ya POST /hlr-lookups badala yake.

Kabla ya kutumia endpoint hii, hakikisha kwamba URL ya webhook imesanidiwa ili kupokea matokeo ya utafutaji kwa njia ya asynchronous. Unaweza kusanidi hii katika mipangilio ya API yako.

Ombi Jibu la Mafanikio Jibu la Hitilafu Webhooks

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdns`	array	Safu ya nambari za simu za mkononi (MSISDNs) katika muundo wa kimataifa (mfano +14156226819 au 0014156226819). Unaweza kujumuisha hadi nambari 1000 kwa kila ombi.	null	lazima
`route`	string(3)	Kitambulisho cha hiari cha herufi tatu kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au kuruhusu mfumo wetu kuamua kiotomatiki njia bora za ombi hili.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`accepted`	array	Orodha ya vitu vinavyojumuisha vitambulisho vya kipekee na MSISDNs ambazo zimekubaliwa kwa ajili ya usindikaji.	false
`accepted_count`	integer	Jumla ya idadi ya MSISDNs zilizokubaliwa kwa mafanikio kwa ajili ya usindikaji.	false
`rejected`	array	Orodha ya vitu vinavyojumuisha vitambulisho vya kipekee na MSISDNs ambazo zimekataliwa kwa ajili ya usindikaji, kwa kawaida kwa sababu ya nambari zisizo halali. Hakuna malipo yanayotumika kwa maingizo yaliyokataliwa.	false
`rejected_count`	integer	Jumla ya idadi ya MSISDNs zilizokataliwa kwa sababu ya makosa ya uthibitishaji.	false
`total_count`	integer	Jumla ya hesabu ya MSISDNs zilizokubaliwa na kukataliwa ambazo ziliwasilishwa kwa ajili ya usindikaji.	false
`cost`	string	Thamani ya desimali inayowakilishwa kama mfuatano wa herufi, inayoonyesha gharama ya jumla kwa EUR kwa utafutaji uliokubaliwa.	false
`storage`	string	Jina la hifadhi ambapo matokeo ya utafutaji yanaongezwa, yanayotumiwa kwa ajili ya ripoti na upakuaji wa CSV kupitia kiolesura cha wavuti.	false
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utaftaji.	false
`webhook_urls`	array	URL za webhook zilizosanidiwa katika mipangilio ya API yako. Matokeo yanachapiswa hapa.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Uchakataji wa Webhooks

Baada ya kuwasilisha, jukwaa letu huanza kuchakata nambari za simu zilizotolewa na kutuma matokeo kwenye URL ya webhook iliyobainishwa awali kwenye seva yako. Matokeo yanatumwa kama ombi la HTTP POST lenye kitu cha JSON katika mwili wa ombi.

Uthibitishaji

Thibitisha webhook kwa kuchunguza kichwa cha HTTP cha X-Signatures.

Kichwa cha X-Signatures kina orodha ya saini zilizotengwa kwa nukta-mkato. Kila saini kwenye orodha inazalishwa kwa kutumia moja ya siri za API zilizosanidiwa kwenye akaunti yako. Ili kuthibitisha webhook, tengeneza hash ya SHA-256 kwa kutumia ufunguo wako wa API, siri, na mwili wa HTTP ghafi - kisha ulinganishe na saini zilizo kwenye orodha.

Kulingana kunathibitisha kuwa ombi ni halali na limesainiwa kwa siri unayoidhibiti.

Mfano wa Msimbo

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

Ombi ni halali ikiwa saini yoyote iliyotolewa kwenye kichwa inalingana na hash ya SHA256 iliyokokotolewa juu ya mfuatano wa ufunguo wako wa API, siri, na mwili wa HTTP.

Kuthibitisha Kupokea

Seva yako inatarajiwa kujibu na msimbo wa hali ya HTTP 200 OK ili kuthibitisha kupokea kwa mafanikio. Ikiwa msimbo mwingine wa majibu utarudishwa, muda ukiisha (sekunde 10), au tatizo lingine la utoaji likitokea, mfumo utajaribu tena webhook baada ya dakika moja kiotomatiki. Ikiwa ombi litaendelea kushindwa, majaribio yatafuata mkakati wa exponential backoff, na majaribio yanayofuata baada ya dakika 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024.

Utaratibu huu wa kujaribu tena unahakikisha kuaminika kwa juu katika kutoa matokeo ya utafutaji kwa miundombinu yako. Inapunguza hatari ya kupoteza data kutokana na matatizo ya muda ya mtandao au seva kuwa nje ya mkono.

Mzigo wa Webhook

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

Sifa za Webhook Payload

Kitu cha JSON kina sifa ya type => MNP pamoja na sifa ya results inayojumuisha orodha ya vitu vya utafutaji, kama ilivyoandikwa hapa chini.

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee cha herufi 12 cha utaftaji huu.	false
`msisdn`	string	Nambari ya simu ya mkononi iliyotathminiwa katika ombi hili la utaftaji.	false
`query_status`	string	Inaonyesha kama urejesho wa taarifa za usafirishaji na mtandao ulifanikiwa. Thamani zinazowezekana ni `OK` au `FAILED`.	false
`mccmnc`	string(5\|6)	MCCMNC ya herufi tano au sita (msimbo wa nchi ya simu ya mkononi na msimbo wa mtandao wa simu ya mkononi) inayotambulisha mtandao ambao nambari ya simu ya mkononi ipo sasa hivi.	true
`mcc`	string(3)	MCC ya herufi tatu (msimbo wa nchi ya simu ya mkononi) inayowakilisha nchi inayohusiana na mtandao wa sasa wa nambari ya simu ya mkononi.	true
`mnc`	string(2\|3)	MNC ya herufi mbili au tatu (msimbo wa mtandao wa simu ya mkononi) inayotambulisha mfanyabiashara wa mtandao wa sasa wa nambari ya simu ya mkononi.	true
`is_ported`	boolean	Inaonyesha kama nambari ya simu imesafirishwa kutoka mtandao wake wa asili kwenda kwa mfanyabiashara mpya.	true
`original_network_name`	string	Mfuatano wa herufi wa hiari (kwa Kiingereza) unaobainisha jina la mfanyabiashara wa mtandao wa asili wa nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_name`	string	Mfuatano wa herufi wa hiari (kwa Kiingereza) unaobainisha nchi ya asili ya nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_code`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili unaowakilisha nchi ya asili ya nambari ya simu ya mkononi iliyochunguzwa.	true
`original_country_prefix`	string	Msimbo wa kupiga simu wa nchi ya asili inayohusiana na nambari ya simu ya mkononi iliyochunguzwa.	true
`ported_network_name`	string	Inabainisha mfanyabiashara wa mtandao ambaye nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_name`	string	Inabainisha nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_code`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili unaowakilisha nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`ported_country_prefix`	string	Msimbo wa kupiga simu wa nchi ambayo nambari ya simu ya mkononi iliyochunguzwa imesafirishiwa, ikiwa inatumika.	true
`extra`	string	Mfuatano wa herufi wa hiari unaotoa maelezo ya ziada kuhusu nambari ya simu.	true
`cost`	string	Thamani ya desimali, inayowakilishwa kama mfuatano wa herufi, inayoonyesha gharama kwa EUR ya utaftaji huu.	true
`timestamp`	string	Alama ya muda ya muundo wa W3C, ikijumuisha taarifa za saa za eneo, inayoonyesha wakati utaftaji ulipomaliza.	true
`storage`	string	Jina la uhifadhi (au jina la ripoti) ambalo matokeo ya utaftaji yaliongezwa. Hii inatumika kwa upakuaji wa CSV na uripotiaji kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utaftaji.	true
`error_code`	integer	Msimbo wa kosa la ndani wa hiari unaotoa muktadha wa ziada kwa uchunguzi wa usaidizi wa wateja.	true

Sogeza Juu

POST/nt-lookupilindwa

Inaanzisha utafutaji wa aina ya nambari (NT) wa moja kwa moja. Njia hii ni bora ikiwa lengo lako kuu ni kubaini ikiwa nambari za simu zilizotolewa ni za simu za mezani, za mkononi, za kiwango cha juu, VoIP, peja, au aina nyingine za masafa ya mpango wa nambari kwa wakati halisi.

Hoja za NT zinagundua kwa kuaminika aina ya nambari ya simu; hata hivyo, hazionyeshi ikiwa nambari lengwa imeunganishwa kwa mtandao na inaweza kufikiwa kwa sasa. Ili kupata taarifa za muunganisho wa moja kwa moja, tafadhali tumia njia ya POST /hlr-lookup.

Ikiwa matumizi yako yanahitaji taarifa sahihi za mtandao na uhamishaji (MCCMNC) lakini si hali ya muunganisho wa moja kwa moja, tafadhali tumia njia ya POST /mnp-lookup kwa hoja za uhamishaji wa nambari za simu za mkononi.

Ombi Jibu la Mafanikio Jibu la Hitilafu Marejeleo ya Aina

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`number`	string	Nambari ya simu katika muundo wa kimataifa (mfano +4989702626 au 004989702626).	null	mandatory
`route`	string(3)	Kitambulisho cha hiari cha herufi tatu kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au uruhusu mfumo wetu kuamua kiotomatiki njia bora za ombi hili.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee kilichotolewa kwa ombi hili la utafutaji.	false
`number`	string	Nambari ya simu iliyotathminiwa wakati wa ombi hili la ukaguzi.	false
`number_type`	string	Aina ya nambari iliyogunduliwa. Thamani zinazowezekana ni pamoja na: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Inaonyesha ikiwa taarifa za aina ya nambari zilipatikana. Inarudisha `OK` ikiwa imefanikiwa, au `FAILED` ikiwa ukaguzi umeshindikana.	false
`is_valid`	boolean	Inaonyesha ikiwa nambari ya simu ni halali kimuundo.	true
`invalid_reason`	string	Ujumbe wa maandishi ya kawaida kwa Kiingereza unaoeleza kwa nini nambari ya simu inachukuliwa kuwa si halali (mfano "too short" au "invalid prefix"), au `null` ikiwa nambari ni halali.	true
`is_possibly_ported`	boolean	Inaonyesha ikiwa nambari ya simu inaweza kuwa imehamishiwa kutoka kwa opereta wa asili kwenda kwa mtoa huduma mwingine. Kwa taarifa za uhakika za uhamishaji, tumia ukaguzi wa MNP.	true
`is_vanity_number`	boolean	Inaonyesha ikiwa nambari ya simu ni nambari ya vanity, yaani inajumuisha herufi za alfabeti.	true
`qualifies_for_hlr_lookup`	boolean	Inaonyesha ikiwa nambari ya simu inastahili hojaji za ziada kupitia ukaguzi wa HLR.	true
`mccmnc`	string(5\|6)	Mfuatano wa herufi tano au sita unawakilisha tuple ya MCCMNC (mobile country code na mobile network code) ambayo inatambua mtandao wa asili wa nambari ya simu ya mkononi.	true
`mcc`	string(3)	Mfuatano wa herufi tatu unawakilisha MCC (mobile country code) ambayo inatambua nchi inayohusishwa na mtandao wa asili wa simu ya mkononi.	true
`mnc`	string(2\|3)	Mfuatano wa herufi mbili au tatu unawakilisha MNC (mobile network code) ambayo inatambua opereta wa asili wa mtandao wa simu ya mkononi.	true
`original_network_name`	string	Mfuatano wa maandishi ya kawaida ya Kiingereza unaoeleza jina la opereta wa mtandao wa asili wa nambari ya simu ya mkononi iliyokaguliwa.	true
`original_country_name`	string	Mfuatano wa maandishi ya kawaida ya Kiingereza unaoeleza nchi ya asili inayohusishwa na nambari ya simu ya mkononi iliyokaguliwa.	true
`original_country_code`	string(2)	Msimbo wa nchi wa ISO wenye herufi mbili unaoonyesha nchi ya asili ya nambari ya simu ya mkononi iliyokaguliwa.	true
`regions`	array	Orodha ya mifuatano inayosomeka kwa Kiingereza inayoeleza eneo la kijiografia linalohusishwa na nambari hii ya simu.	true
`timezones`	array	Orodha ya majira ya saa (katika muundo wa Olson) yanayohusishwa na nambari hii ya simu.	true
`info_text`	string	Mfuatano wa hiari ambao unaweza kuwa na taarifa za ziada kuhusu nambari ya simu.	true
`cost`	string	Thamani ya desimali iliyowakilishwa kama mfuatano, inayoonyesha gharama (kwa EUR) ya ukaguzi huu.	true
`timestamp`	string	Alama ya muda ya muundo wa W3C (ikijumuisha eneo la saa) inayoonyesha wakati ukaguzi ulikamilika.	true
`storage`	string	Inaeleza jina la hifadhi ambapo matokeo ya ukaguzi yameongezwa. Hii inaendana na jina la ripoti linalotumika kwa upakuaji wa CSV na uchanganuzi kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utaftaji.	true

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Aina	Maelezo
LANDLINE	Nambari ya simu ya ardhi.
MOBILE	Nambari ya simu ya mkononi. Inastahili utafutaji wa HLR kupata taarifa za ziada za hali ya muunganisho, mtandao, uhamishaji na ujumbe wa kutangatanga.
MOBILE_OR_LANDLINE	Nambari ya simu ya ardhi au ya mkononi. Inaweza kustahili utafutaji wa HLR.
TOLL_FREE	Nambari ya simu ya bure.
PREMIUM_RATE	Nambari ya simu ya kiwango cha juu yenye malipo ya ziada.
SHARED_COST	Nambari ya simu ya gharama iliyogawanywa. Kwa kawaida ni nafuu zaidi kuliko nambari za simu za kiwango cha juu.
VOIP	Nambari ya simu ya Voice over IP. Inajumuisha nambari za simu za TSoIP (Huduma ya Simu kupitia IP).
PAGER	Nambari ya simu ya pager. Kwa kawaida haina utendaji wa sauti.
UAN	Nambari ya Ufikiaji wa Ulimwengu (Nambari ya Kampuni). Inaweza kuelekeza kwa ofisi maalum lakini inaruhusu nambari moja kutumika kwa kampuni.
VOICEMAIL	Nambari ya simu ya barua sauti.
UNKNOWN	Aina ya nambari haikuweza kubainiwa.

Sogeza Juu

POST/nt-lookups ilindwa

Njia hii ya API inaamsha mfululizo wa utafutaji wa aina za nambari kwa njia isiyo ya moja kwa moja, ambapo matokeo yanapelekwa kwenye seva yako kupitia webhook. Inafaa ikiwa lengo lako kuu ni kutambua kama nambari za simu zilizotolewa ni za simu za mezani, simu za mkononi, viwango vya bei ya juu, VoIP, peja, au maeneo mengine ya mpango wa nambari. Imeboreshwa kwa uchakataji wa haraka wa kiasi kikubwa cha nambari, njia hii ya API ni bora kwa shughuli za wingi (mfano usafishaji wa hifadhidata). Kwa trafiki ya moja kwa moja na matumizi muhimu ya muda, tafadhali tumia njia ya POST /nt-lookup badala yake.

Unahitaji kubainisha URL ya webhook katika mipangilio ya API yako kama sharti la awali kabla ya kuita kipengele hiki.

Ombi Jibu la Mafanikio Jibu la Hitilafu Webhooks Marejeleo ya Aina

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

Mzigo

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`numbers`	array	Safu ya nambari za simu katika muundo wa kimataifa (mfano +14156226819 au 004989702626). Idadi ya juu ya nambari 1000 inaweza kujumuishwa kwa kila ombi.	null	lazima
`route`	string(3)	Kitambulisho cha herufi tatu cha hiari kinachoainisha njia ya utafutaji huu. Weka kuwa `null` au acha kigezo hiki ili kutumia ramani yako maalum ya njia au kuruhusu mfumo wetu kuamua kiotomatiki njia bora kwa ombi hili.	null	si lazima
`storage`	string	Kitambulisho cha hifadhi cha hiari kinachoainisha ripoti ambapo matokeo yatahifadhiwa kwa mapitio ya mkono, uchanganuzi, na ripoti. Mfumo huongeza kiotomatiki muhuri wa muda wa mwezi wa sasa. Ikiwa kimeachwa au kimewekwa kuwa `null`, mfumo utapanga matokeo kiotomatiki kwa mwezi kwa madhumuni ya ripoti.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`accepted`	array	Safu ya vitu, kila kimoja kikiwa na kitambulisho cha kipekee na nambari ya simu ambayo imekubaliwa kwa uchakataji.	false
`accepted_count`	integer	Jumla ya hesabu ya nambari za simu zilizokubaliwa kwa uchakataji.	false
`rejected`	array	Safu ya vitu, kila kimoja kikiwa na kitambulisho cha kipekee na nambari ya simu ambayo ilikataliwa kwa uchakataji. Kwa kawaida, nambari hizi ni batili, na hakuna malipo yanayotumika.	false
`rejected_count`	integer	Jumla ya hesabu ya nambari za simu ambazo zilikataliwa kwa uchakataji.	false
`total_count`	integer	Jumla ya hesabu ya nambari za simu zilizokubaliwa na kukataliwa ambazo ziliwasilishwa kwa uchakataji.	false
`cost`	string	Mfuatano wa herufi unaowakilisha thamani ya desimali inayoonyesha gharama kwa EUR ya utafutaji huu.	false
`storage`	string	Jina la hifadhi (ripoti) ambapo matokeo ya utafutaji yameongezwa. Jina hili linatumika kwa upakuaji wa CSV na uchanganuzi kupitia kiolesura cha wavuti.	false
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utafutaji.	false
`webhook_urls`	array	URL za webhook zilizosanidiwa katika mipangilio ya API yako. Matokeo yanachapiswa hapa.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Uchakataji wa Webhooks

Baada ya kuwasilisha, jukwaa letu huanza kuchakata nambari za simu zilizotolewa na kutuma matokeo kwenye URL ya webhook iliyobainishwa awali kwenye seva yako. Matokeo yanatumwa kama ombi la HTTP POST lenye kitu cha JSON katika mwili wa ombi.

Uthibitishaji

Thibitisha webhook kwa kuchunguza kichwa cha HTTP cha X-Signatures.

Kichwa cha X-Signatures kina orodha ya saini zilizotengwa kwa nukta-mkato. Kila saini kwenye orodha inazalishwa kwa kutumia moja ya siri za API zilizosanidiwa kwenye akaunti yako. Ili kuthibitisha webhook, tengeneza hash ya SHA-256 kwa kutumia ufunguo wako wa API, siri, na mwili wa HTTP ghafi - kisha ulinganishe na saini zilizo kwenye orodha.

Kulingana kunathibitisha kuwa ombi ni halali na limesainiwa kwa siri unayoidhibiti.

Mfano wa Msimbo

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

Ombi ni halali ikiwa saini yoyote iliyotolewa kwenye kichwa inalingana na hash ya SHA256 iliyokokotolewa juu ya mfuatano wa ufunguo wako wa API, siri, na mwili wa HTTP.

Kuthibitisha Kupokea

Seva yako inatarajiwa kujibu na msimbo wa hali ya HTTP 200 OK ili kuthibitisha kupokea kwa mafanikio. Ikiwa msimbo mwingine wa majibu utarudishwa, muda ukiisha (sekunde 10), au tatizo lingine la utoaji likitokea, mfumo utajaribu tena webhook baada ya dakika moja kiotomatiki. Ikiwa ombi litaendelea kushindwa, majaribio yatafuata mkakati wa exponential backoff, na majaribio yanayofuata baada ya dakika 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024.

Utaratibu huu wa kujaribu tena unahakikisha kuaminika kwa juu katika kutoa matokeo ya utafutaji kwa miundombinu yako. Inapunguza hatari ya kupoteza data kutokana na matatizo ya muda ya mtandao au seva kuwa nje ya mkono.

Mzigo wa Webhook

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

Sifa za Webhook Payload

Kitu cha JSON kina sifa ya type => NT pamoja na sifa ya results inayojumuisha orodha ya vitu vya utafutaji, kama ilivyoandikwa hapa chini.

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`id`	string(12)	Kitambulisho cha kipekee kilichotolewa kwa ombi hili la utafutaji.	false
`number`	string	Nambari ya simu iliyotathminiwa wakati wa ombi hili la ukaguzi.	false
`number_type`	string	Aina ya nambari iliyogunduliwa. Thamani zinazowezekana ni pamoja na: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Inaonyesha ikiwa taarifa za aina ya nambari zilipatikana. Inarudisha `OK` ikiwa imefanikiwa, au `FAILED` ikiwa ukaguzi umeshindikana.	false
`is_valid`	boolean	Inaonyesha ikiwa nambari ya simu ni halali kimuundo.	true
`invalid_reason`	string	Ujumbe wa maandishi ya kawaida kwa Kiingereza unaoeleza kwa nini nambari ya simu inachukuliwa kuwa si halali (mfano "too short" au "invalid prefix"), au `null` ikiwa nambari ni halali.	true
`is_possibly_ported`	boolean	Inaonyesha ikiwa nambari ya simu inaweza kuwa imehamishiwa kutoka kwa opereta wa asili kwenda kwa mtoa huduma mwingine. Kwa taarifa za uhakika za uhamishaji, tumia ukaguzi wa MNP.	true
`is_vanity_number`	boolean	Inaonyesha ikiwa nambari ya simu ni nambari ya vanity, yaani inajumuisha herufi za alfabeti.	true
`qualifies_for_hlr_lookup`	boolean	Inaonyesha ikiwa nambari ya simu inastahili hojaji za ziada kupitia ukaguzi wa HLR.	true
`mccmnc`	string(5\|6)	Mfuatano wa herufi tano au sita unawakilisha tuple ya MCCMNC (mobile country code na mobile network code) ambayo inatambua mtandao wa asili wa nambari ya simu ya mkononi.	true
`mcc`	string(3)	Mfuatano wa herufi tatu unawakilisha MCC (mobile country code) ambayo inatambua nchi inayohusishwa na mtandao wa asili wa simu ya mkononi.	true
`mnc`	string(2\|3)	Mfuatano wa herufi mbili au tatu unawakilisha MNC (mobile network code) ambayo inatambua opereta wa asili wa mtandao wa simu ya mkononi.	true
`original_network_name`	string	Mfuatano wa maandishi ya kawaida ya Kiingereza unaoeleza jina la opereta wa mtandao wa asili wa nambari ya simu ya mkononi iliyokaguliwa.	true
`original_country_name`	string	Mfuatano wa maandishi ya kawaida ya Kiingereza unaoeleza nchi ya asili inayohusishwa na nambari ya simu ya mkononi iliyokaguliwa.	true
`original_country_code`	string(2)	Msimbo wa nchi wa ISO wenye herufi mbili unaoonyesha nchi ya asili ya nambari ya simu ya mkononi iliyokaguliwa.	true
`regions`	array	Orodha ya mifuatano inayosomeka kwa Kiingereza inayoeleza eneo la kijiografia linalohusishwa na nambari hii ya simu.	true
`timezones`	array	Orodha ya majira ya saa (katika muundo wa Olson) yanayohusishwa na nambari hii ya simu.	true
`info_text`	string	Mfuatano wa hiari ambao unaweza kuwa na taarifa za ziada kuhusu nambari ya simu.	true
`cost`	string	Thamani ya desimali iliyowakilishwa kama mfuatano, inayoonyesha gharama (kwa EUR) ya ukaguzi huu.	true
`timestamp`	string	Alama ya muda ya muundo wa W3C (ikijumuisha eneo la saa) inayoonyesha wakati ukaguzi ulikamilika.	true
`storage`	string	Inaeleza jina la hifadhi ambapo matokeo ya ukaguzi yameongezwa. Hii inaendana na jina la ripoti linalotumika kwa upakuaji wa CSV na uchanganuzi kupitia kiolesura cha wavuti.	true
`route`	string(3)	Kitambulisho cha herufi tatu kinachobainisha njia iliyotumika kwa ombi hili la utaftaji.	true

Aina	Maelezo
LANDLINE	Nambari ya simu ya ardhi.
MOBILE	Nambari ya simu ya mkononi. Inastahili utafutaji wa HLR kupata taarifa za ziada za hali ya muunganisho, mtandao, uhamishaji na ujumbe wa kutangatanga.
MOBILE_OR_LANDLINE	Nambari ya simu ya ardhi au ya mkononi. Inaweza kustahili utafutaji wa HLR.
TOLL_FREE	Nambari ya simu ya bure.
PREMIUM_RATE	Nambari ya simu ya kiwango cha juu yenye malipo ya ziada.
SHARED_COST	Nambari ya simu ya gharama iliyogawanywa. Kwa kawaida ni nafuu zaidi kuliko nambari za simu za kiwango cha juu.
VOIP	Nambari ya simu ya Voice over IP. Inajumuisha nambari za simu za TSoIP (Huduma ya Simu kupitia IP).
PAGER	Nambari ya simu ya pager. Kwa kawaida haina utendaji wa sauti.
UAN	Nambari ya Ufikiaji wa Ulimwengu (Nambari ya Kampuni). Inaweza kuelekeza kwa ofisi maalum lakini inaruhusu nambari moja kutumika kwa kampuni.
VOICEMAIL	Nambari ya simu ya barua sauti.
UNKNOWN	Aina ya nambari haikuweza kubainiwa.

Sogeza Juu

GET/routeilindwa

Inapata njia itakayochaguliwa kiotomatiki unapofanya utafutaji wa HLR bila kubainisha kigezo cha route.

Uchaguzi wa kiotomatiki wa njia unategemea ramani ya uelekezaji inayopatikana kupitia kipengele cha GET /hlr-coverage, ambacho kinatokana hasa na GET /routing-map. Unaweza kubinafsisha ramani yako ya uelekezaji na kufafanua sheria maalum katika mipangilio ya akaunti yako.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdn`	string	MSISDN ambayo taarifa ya uelekezaji iliyochaguliwa kiotomatiki itapatikana.	null	lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`route`	string	Njia inayopendekezwa.	false
`confidence_level`	string	Kiwango cha kuaminika ambacho njia hii ilichaguliwa, yaani `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	MCCMNC inayotegemea mpango wa nambari kwa nambari hii.	false
`origin`	string	Chanzo ambacho uamuzi wa uelekezaji unategemea, yaani `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."
    ]
}

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/routesilindwa

Kituo hiki kinarudisha orodha ya njia za HLR, MNP, na NT zinazopatikana. Kila njia, pamoja na vipengele na vikwazo vyake, imeelezwa kwenye ukurasa wa maelezo ya uelekezaji.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`routes`	object	Kipengee chenye njia zilizopangwa kulingana na aina ya njia.	false
`HLR\|MNP\|NT`	string[]	Ina orodha ya vitambulisho vya njia.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/routing-mapilindwa

Inapata usanidi wa mzunguko wa kiotomatiki unaotumika kwa sasa kwa Utafutaji wa HLR wa akaunti yako. Usanidi huu wa chaguo-msingi unatumika wakati wowote unapowasilisha utafutaji wa HLR bila kubainisha kigezo cha route. Unaweza kubinafsisha ramani yako ya mzunguko na kuunda sheria maalum katika mipangilio ya akaunti yako.

Urithi wa usanidi unashuka kutoka kwa sheria za kiwango cha nchi hadi sheria za kiwango cha MCCMNC, na hatimaye hadi ramani za kiambishi awali cha nambari za simu binafsi. Kwa vitendo, hii inamaanisha kuwa ramani za kiambishi awali cha nambari za simu binafsi zina kipaumbele juu ya magawio ya MCCMNC yanayokinzana, ambayo kwa upande wake yanabatilisha sheria za kiwango cha nchi. Tafadhali kumbuka kuwa mbadala wa MNP unabatilisha sheria zozote maalum zinazogongana zinapokuwa zimewezeshwa.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`default_route`	string	Njia ya chaguo-msingi inayotumika wakati hakuna chaguo la mzunguko linaloweza kuamuliwa kwa MSISDN na hakuna sheria za mzunguko maalum zinazotumika.	false
`mnp_fallback`	boolean	Inaonyesha ikiwa mbadala wa MNP umewezeshwa. Wakati umewezeshwa na hoja za HLR hazitumiwi na mtandao (hali ya muunganisho haipo), mfumo utafanya utafutaji wa MNP badala yake.	false
`mccmncs`	array	Ramani ya nambari za MCCMNC kwa njia zao zilichaguliwa kiotomatiki. Wakati wa kufanya utafutaji wa HLR kwa nambari katika MCCMNC fulani, njia inayolingana inatumika.	false
`mccmnc`	string(5\|6)	MCCMNC ya herufi tano au sita (mchanganyiko wa msimbo wa nchi ya simu na msimbo wa mtandao wa simu) inayotambulisha muendeshaji wa mtandao wa simu za mkononi.	false
`countrycode`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili, unaotambulisha nchi ya mtandao.	false
`route`	string(3)	Njia iliyochaguliwa kwa mtandao.	false
`mno`	string	Chapa inayoelekea wateja ambayo mtandao huu unafanya kazi chini yake.	false
`confidence`	string	Kiwango cha kujiamini ambacho uchaguzi ulifanywa. Thamani zinazowezekana ni: HIGH, NORMAL, LOW, MNP_REDIRECT. Kwa suala la mwisho, mfumo unaelekeza trafiki kwa mtandao huu kwa MNP, ikiwa tabia hii imewezeshwa kwenye akaunti yako. Vinginevyo inatumia njia ya chaguo-msingi katika akaunti.	false
`origin`	string	Asili ambayo uchaguzi unategemea. Thamani zinazowezekana ni: `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	Orodha ya sheria za mzunguko zinazotegemea kiambishi awali zilizosanidiwa kwenye akaunti yako, ikiwa zipo.	false
`countrycode`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili, unaotambulisha nchi ya kiambishi awali.	false
`cns`	string	Kiambishi awali ambacho sheria ya mzunguko inatumika.	false
`route`	string(3)	Njia iliyochaguliwa kwa kiambishi awali.	false
`mccmnc`	string(5\|6)	MCCMNC ya herufi tano au sita (mchanganyiko wa msimbo wa nchi ya simu na msimbo wa mtandao wa simu) inayotambulisha muendeshaji wa mtandao wa simu za mkononi.	true
`mno`	string	Chapa inayoelekea wateja ambayo mtandao huu unafanya kazi chini yake.	true
`countries`	array	Orodha ya sheria maalum zinazotegemea nchi zilizosanidiwa kwenye akaunti yako, ikiwa zipo.	false
`countrycode`	string(2)	Msimbo wa nchi wa ISO wa herufi mbili, unaotambulisha nchi.	false
`route`	string(3)	Njia iliyochaguliwa kwa nchi.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/hlr-coverage ilindwa

Inarudisha maarifa ya upeo wa HLR kusaidia kufanya maamuzi yanayotegemea data. Mwisho huu unakusaidia kuchanganua chaguo za mzunguko wa HLR za wakati halisi katika mitandao ya simu za mkononi, kutambua njia bora zaidi kwa mikoa yako lengwa, na kusanidi mzunguko wako wa kiotomatiki.

Njia zilizopendekezwa kutoka GET /route zinategemea data ya upeo iliyopatikana hapa. Data ya upeo pia inapatikana kwenye ukurasa wa upeo wa mtandao. Unaweza kubinafsisha zaidi ramani yako ya mzunguko na kufafanua sheria katika mipangilio ya akaunti yako.

Tunapendekeza ujifahamishe na mwongozo huu ili kusaidia kufasiri matokeo.

Ombi Jibu la Mafanikio Jibu la Hitilafu Marejeo ya Hali

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`countrycode`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaohitajika unaotumika kuchuja matokeo, kurudisha rekodi tu zinazohusiana na nchi iliyobainishwa.	null	lazima
`sample_size`	string	Kigezo cha hiari kinachobainisha ukubwa wa sampuli. Thamani zinazowezekana ni `LARGE`, `MEDIUM`, `SMALL`. Sampuli kubwa zaidi zinashughulikia muda mrefu zaidi, sampuli ndogo zinashughulikia muda wa hivi karibuni sana.	LARGE	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`name`	string	Jina la nchi liliochaguliwa kwa Kiingereza kwa maandishi ya kawaida.	false
`countrycode`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO wa nchi iliyochaguliwa.	false
`prefix`	string	Kiambishi awali cha kupiga simu kimataifa cha nchi iliyochaguliwa.	false
`mccs`	string[]	Orodha ya MCC (misimbo ya nchi ya simu za mkononi) zinazohusiana na nchi iliyochaguliwa.	false
`carriers`	object[]	Orodha ya vipengele vya mtoa huduma zenye vipimo vya uunganisho mahususi kwa njia.	false
`mno`	string	Jina la mfanyabiashara wa mtandao wa simu za mkononi kwa Kiingereza kwa maandishi ya kawaida.	false
`mccmnc`	string	MCCMNC ya mfanyabiashara wa mtandao wa simu za mkononi.	false
`mcc`	string	MCC (msimbo wa nchi ya simu za mkononi) ya mfanyabiashara wa mtandao wa simu za mkononi.	false
`mnc`	string	MNC (msimbo wa mtandao wa simu za mkononi) ya mfanyabiashara wa mtandao wa simu za mkononi.	false
`routes`	object[]	Orodha ya matokeo ya uunganisho mahususi kwa njia.	false
`route`	string	Njia ambayo maelezo ya uunganisho yanatumika.	false
`selected`	bool	Inaonyesha kama hii ndiyo njia iliyochaguliwa kwa mzunguko wa kiotomatiki.	false
`selection_confidence`	string	Kiwango cha kuaminika ambacho njia hii ilichaguliwa, yaani `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Ina null ikiwa hii si njia iliyochaguliwa.	true
`n`	int	Jumla ya idadi ya utafutaji katika sampuli hii.	false
`CONNECTED`	int	Idadi ya utafutaji wa HLR ambao ulirudisha hali ya CONNECTED.	false
`CONNECTED_PCT`	float	Asilimia ya utafutaji wa HLR ambao ulirudisha hali ya CONNECTED.	false
`ABSENT`	int	Idadi ya utafutaji wa HLR ambao ulirudisha hali ya ABSENT.	false
`ABSENT_PCT`	float	Asilimia ya utafutaji wa HLR ambao ulirudisha hali ya ABSENT.	false
`INVALID_MSISDN`	int	Idadi ya utafutaji wa HLR ambao ulirudisha hali ya INVALID_MSISDN.	false
`INVALID_MSISDN_PCT`	float	Asilimia ya utafutaji wa HLR ambao ulirudisha hali ya INVALID_MSISDN.	false
`UNDETERMINED`	int	Idadi ya utafutaji wa HLR ambao ulirudisha hali ya UNDETERMINED.	false
`UNDETERMINED_PCT`	float	Asilimia ya utafutaji wa HLR ambao ulirudisha hali ya UNDETERMINED.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Hali	Maelezo
CONNECTED	Nambari ni halali, na simu lengwa imeunganishwa kwa mtandao wa simu kwa sasa. Simu, SMS, na huduma zingine zinapaswa kumfikia mpokeaji bila tatizo.
ABSENT	Nambari ni halali, lakini simu lengwa imezimwa au iko nje ya eneo la mtandao kwa muda. Ujumbe au simu zinaweza kutofika hadi kifaa kitakapounganishwa tena na mtandao.
INVALID_MSISDN	Nambari si halali au haijapewa mtumiaji yeyote kwenye mtandao wa simu kwa sasa. Simu na ujumbe kwa nambari hii vitashindwa.
UNDETERMINED	Hali ya muunganisho wa nambari haikuweza kubainiwa. Hii inaweza kutokana na nambari batili, jibu la hitilafu ya SS7, au ukosefu wa muunganisho na mtoa huduma wa mtandao lengwa. Angalia msimbo wa hitilafu na sehemu yake ya maelezo kwa uchunguzi zaidi.

Sogeza Juu

GET/mnp-coverageilindwa

Njia hii inarudisha orodha ya waendeshaji wa mitandao ya simu za mkononi, pamoja na vitambulisho vyao vya MCCMNC vinavyolingana, ambavyo kwa sasa vinasaidiwa kwa utafutaji wa uhamishaji wa nambari za simu.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`countrycode`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO ambao ni wa hiari unaotumika kuchuja matokeo ya MCCMNC, na kurudisha data inayohusiana na nchi iliyobainishwa tu.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`items[]`	array	Orodha ya waendeshaji wa mitandao ya simu.	false
`country_name`	string	Jina la nchi kwa Kiingereza.	false
`country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO.	false
`mccmnc`	string(5\|6)	MCCMNC ya herufi tano au sita (mchanganyiko wa msimbo wa nchi ya simu na msimbo wa mtandao wa simu) inayotambulisha muendeshaji wa mtandao wa simu za mkononi.	false
`mcc`	string(3)	MCC ya herufi tatu (msimbo wa nchi ya simu) inayowakilisha nchi ya mtandao.	false
`mnc`	string(2\|3)	MNC ya herufi mbili au tatu (msimbo wa mtandao wa simu) inayowakilisha muendeshaji mahususi wa mtandao wa simu za mkononi.	false
`brand`	string	Chapa inayoelekea wateja ambayo mtandao huu unafanya kazi chini yake.	true
`operator`	string	Jina halali la muendeshaji wa mtandao wa simu za mkononi.	true

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/price-listilindwa

Endpoint hii inarudisha orodha ya nchi ambapo utafutaji wa MNP pekee unasaidiwa, na hoja za HLR hazipatikani kwa maeneo haya.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`countries`	string[]	Orodha ya misimbo ya nchi ya ISO yenye herufi mbili.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/mccmncsilindwa

Njia hii inarudisha orodha kamili ya waendeshaji wa mitandao ya simu pamoja na vitambulisho vyao vya MCCMNC na taarifa za ziada za muktadha.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`countrycode`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaotumika kuchuja matokeo ya MCCMNC, kurudisha rekodi tu zinazohusiana na nchi iliyobainishwa.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`items`	object[]	Orodha ya waendeshaji wa mitandao ya simu.	false
`country_name`	string	Jina kamili la nchi kwa Kiingereza.	false
`country_code`	string(2)	Msimbo wa nchi wa herufi mbili wa ISO unaoyawakilisha nchi ya mwendeshaji wa simu.	false
`mccmnc`	string(5\|6)	Mfuatano wa herufi tano au sita unaoyawakilisha MCCMNC, ambao hutambulisha kipekee mwendeshaji wa mtandao wa simu.	false
`mcc`	string(3)	Msimbo wa Nchi ya Simu (MCC) wa herufi tatu unaotambulisha nchi ambayo mtandao wa simu unafanya kazi.	false
`mnc`	string(2\|3)	Msimbo wa Mtandao wa Simu (MNC) wa herufi mbili au tatu unaoainisha mtandao wa simu ndani ya MCC iliyotolewa.	false
`brand`	string	Jina la biashara la chapa ambalo mtandao unafanya kazi chini yake na unatambuliwa na watumiaji.	true
`operator`	string	Jina rasmi la mwendeshaji wa mtandao wa simu, kwa kawaida ni chombo cha kisheria kinachosimamia mtandao.	true
`parent_mccmnc`	string(5\|6)	Mfuatano wa herufi tano au sita unaoyawakilisha MCCMNC ya mwendeshaji mkuu wa mtandao wa simu, ikiwa ipo.	true

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/priceilindwa

Mwisho huu hurudisha bei ya utaftaji wa HLR, MNP, au NT.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Vigezo vya Ombi

Funguo	Aina	Maelezo	Chaguo-msingi	Lazima
`msisdn`	string	Nambari ya simu ambayo bei itapatikana. Katika muundo wa kimataifa.	null	lazima
`route_type`	string	Aina ya njia, yaani `HLR`, `MNP`, `NT`.	null	lazima
`route`	string(3)	Njia ambayo bei inapaswa kuhesabiwa. Chaguo-msingi ni njia iliyoamuliwa na mfumo wa kiotomatiki.	null	si lazima

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`price`	object	Kipengee chenye maelezo ya bei.	false
`amount`	string	Kiasi katika EUR.	false
`msisdn`	string	MSISDN ambayo bei hii inatumika.	false
`route_type`	string(2\|3)	Aina ya njia ambayo bei hii inatumika.	false
`route`	string(3)	Njia ambayo bei hii inatumika.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/price-listilindwa

Endpoint hii inarudisha bei katika akaunti yako.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`pricing`	object[]	Orodha ya vitu vyenye taarifa za bei.	false
`route`	string	Njia ambayo bei hii inatumika.	false
`countrycode`	string	Msimbo wa nchi wa herufi mbili wa ISO ambao bei hii inatumika kwa njia husika, ikiwepo.	true
`countryname`	string	Jina la nchi kwa Kiingereza linalingana na msimbo wa nchi, ikiwepo.	true
`mccmnc`	string	MCCMNC ambayo bei hii inatumika kwa njia husika, ikiwepo. Inabatilisha bei ya ngazi ya nchi.	true
`cns`	string	Kiambishi cha kupiga simu ambacho bei hii inatumika kwa njia husika, ikiwepo. Inabatilisha bei ya ngazi ya nchi na bei ya ngazi ya MCCMNC.	true
`route_type`	string	Aina ya njia husika, yaani `HLR`, `MNP`, `NT`.	false
`route_type`	string	Bei husika katika EUR.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/balanceilindwa

Njia hii inarudisha salio la sasa la akaunti yako, ikikuruhusu kuautomati michakato kulingana na hali yako ya mkopo. Inafanya kazi vizuri na barua pepe za arifa za mkopo mdogo ambazo unaweza kusanidi kwenye ukurasa wako wa malipo.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

{
    "balance":"1002.90"
}

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`balance`	string	Salio la sasa la akaunti yako katika EUR. Thamani ya desimali ya aina ya mfuatano wa herufi.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/pingumma

Mwisho huu hutuma ombi la ping kwa API, ikitoa njia rahisi ya kujaribu muunganisho wako na HLR Lookups API.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

{
    "success":true
}

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`success`	boolean	Inaonyesha kuwa ombi limeshughulikiwa kwa mafanikio.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/timeumma

Kituo hiki kinarudisha alama ya muda ya Unix inayowakilisha muda wa sasa kwenye seva ya HLR Lookups. Tumia ili kuoanisha saa ya seva yako wakati wa kutengeneza saini ya Digest-Auth kwa uthibitishaji, kuhakikisha kuwa tofauti yoyote kati ya muda wa seva yako na muda wa seva ya HLR Lookups inasahihishwa.

Ombi Jibu la Mafanikio Jibu la Hitilafu

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

{
    "time":1525898643
}

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`time`	integer	Alama ya muda ya Unix inayowakilisha muda wa sasa wa seva ya HLR Lookups.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

GET/auth-testilindwa

Kituo hiki kinatumika kama jaribio la awali la utekelezaji wako wa Basic-Auth au, ikipendwa zaidi, Digest-Auth.

Ombi la Uthibitishaji wa Msingi Ombi la Uthibitishaji wa Digest Jibu la Mafanikio Jibu la Hitilafu

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

Vichwa vya Ombi

Funguo	Aina	Maelezo
`X-Basic`	string	Hash ya SHA256 ya `YOUR_API_KEY:YOUR_API_SECRET`. Jumuisha alama ya koloni (:) katika hash.

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Digest-Key: YOUR_API_KEY" \
  -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
  -H "X-Digest-Timestamp: UNIX_TIMESTAMP"

Vichwa vya Ombi

Funguo	Aina	Maelezo
`X-Digest-Key`	string	Ufunguo wako wa API ya HLR Lookups
`X-Digest-Signature`	string	Saini ya kipekee ya Digest-Auth (tazama uthibitishaji)
`X-Digest-Timestamp`	integer	Muhula wa sasa wa Unix (pia tazama `GET /time`)

{
    "success":true
}

Sifa za Jibu la Mafanikio

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`success`	boolean	Inaonyesha kuwa ombi limeshughulikiwa kwa mafanikio.	false

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

Vigezo vya Majibu ya Hitilafu

Jina	Aina	Maelezo	Inaweza Kuwa Tupu
`errors[]`	string[]	Orodha ya tungo zinazofafanua hitilafu.	false

Sogeza Juu

Nyaraka za API ya Zamani

Tafadhali kumbuka kuwa API ya zamani imesitishwa na imepangwa kuondolewa katika siku zijazo. Tunapendekeza sana kuboresha hadi toleo jipya zaidi haraka iwezekanavyo.

Ikiwa ulitekeleza API yetu ya HLR Lookups kati ya 2013 na mwanzo wa 2020, unatumia API yetu ya zamani. Tafadhali rejelea nyaraka zetu za API ya zamani katika hali hiyo.

Nyaraka za API ya Zamani

Nyaraka za API

Kuanza

Utafutaji wa HLR

Utafutaji wa MNP

Utafutaji wa NT

Upelekaji

Bei

Zana

Kuanza

Kutumia API ya Utafutaji wa HLR

Mfano wa Ombi

Mfano wa Payload

Jibu la Mafanikio application/json

Huduma za Utafutaji Zaidi

Utafutaji wa Uhamishaji wa Nambari za Simu (MNP)

Utafutaji wa Utambuzi wa Aina ya Nambari (NT)

Vifaa vya Utengenezaji wa Programu (SDK)

Zana

Si Msanidi Programu?

Uthibitishaji

Funguo ya API na Siri ya API

Uthibitishaji wa Msingi wa HTTP

Inashauriwa: Kichwa cha X-Basic na SHA256

Ombi la Uthibitishaji wa Msingi

Vichwa vya Uthibitishaji wa Msingi

Mfano wa Msimbo

Mfano wa Ombi

Vichwa vya Ombi

Kujenga Saini

Vipengele vya Saini ya Digest

Mifano ya Msimbo

Dhana

API ya Utafutaji wa HLR wa Usawazishaji

API ya Utafutaji wa HLR Usiozuiaji

SDK (Vifaa vya Uendelezaji wa Programu)

SDK ya PHP

SDK ya NodeJS

SDK ya Ruby

POST/hlr-lookupilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu

POST/hlr-lookupsilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu

Uchakataji wa Webhooks

Uthibitishaji

Mfano wa Msimbo

Kuthibitisha Kupokea

Mzigo wa Webhook

Sifa za Webhook Payload

POST/mnp-lookupilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu

POST/mnp-lookupsilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu

Uchakataji wa Webhooks

Uthibitishaji

Mfano wa Msimbo

Kuthibitisha Kupokea

Mzigo wa Webhook

Sifa za Webhook Payload

POST/nt-lookupilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu

POST/nt-lookups ilindwa

Mzigo

Vigezo vya Ombi

Sifa za Jibu la Mafanikio

Vigezo vya Majibu ya Hitilafu