Pagsisimula

Ang pandaigdigang imprastraktura ng mobile network ay gumagana sa isang sistema na kilala bilang SS7 signaling network. Ang network na ito ay nagpapadali sa palitan ng subscriber data, call routing, SMS transmission, at real-time na mga update sa mobile connectivity status sa pagitan ng mga carrier. Ang bawat mobile network ay may Home Location Register (HLR) - isang pangunahing database na nag-iimbak ng mahahalagang detalye tungkol sa mga subscriber nito.

Ang HLR Lookup technology ay nagbibigay-daan sa mga negosyo na mag-query sa mga register na ito at makuha ang live connectivity at network details para sa anumang mobile phone number. Kasama dito kung nakabukas ang telepono, sa aling network ito kasalukuyang nakatakda, kung na-port na ito, kung valid o deactivated ang numero, at kung nag-roaming ito.

Ang HLR Lookups API ay nagbibigay ng seamless, real-time na access sa data na ito, na nagbibigay-daan sa mga negosyo na mag-verify ng mobile numbers, mag-optimize ng routing, at mapahusay ang customer communications. Ang dokumentasyong ito ay gagabay sa inyo sa pag-integrate ng HLR Lookups sa inyong software, na nagbibigay-daan sa automated retrieval ng real-time mobile intelligence.

Paggamit ng HLR Lookups API

Ang pagsasagawa ng HLR Lookup queries ay mabilis, secure, at simple. Kapag nag-sign up na kayo at nakuha ang inyong API Key, maaari nang mag-authenticate at magsimula ng instant lookups gamit ang simpleng HTTP POST requests, sa pamamagitan ng POST /hlr-lookup. Alternatibo, maaari kayong mag-proseso ng malalaking data sets sa pamamagitan ng pagpili ng mabilis na asynchronous API requests na may mga resulta na ipinapadala pabalik sa inyong server via webhook, gaya ng ipinaliwanag sa seksyon ng concepts.

Halimbawa ng Request

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"

Ang Authentication ay ibinibigay sa pamamagitan ng HTTP headers, at ang payload.json ay dapat (sa minimum) ay maglaman ng sumusunod na JSON object:

Halimbawa ng Payload

{
   "msisdn": "+14156226819"
}

Sa matagumpay na pagsasagawa, makakatanggap kayo ng response na naglalaman ng real-time connectivity details para sa tinukoy na mobile number.

Matagumpay na Tugon 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"
}

Para sa kumpletong detalye ng request at response attributes at connectivity statuses, tingnan ang POST /hlr-lookup.

Karagdagang Lookup Services

Mobile Number Portability (MNP) Lookups

Gamitin ang MNP lookups upang malaman ang network ownership at portability details nang hindi nag-query ng real-time connectivity. Kung kailangan lamang ninyo ang MCCMNC ng isang numero, sumangguni sa POST /mnp-lookup.

Number Type Detection (NT) Lookups

Alamin kung ang isang phone number ay pag-aari ng landline, mobile, premium-rate, VoIP, pager, o iba pang numbering plan ranges gamit ang POST /nt-lookup.

Software Development Kits (SDKs)

Ang HLR Lookups API ay gumagana sa anumang REST client sa anumang programming language at nag-publish kami ng mga SDK para sa PHP, Ruby, at NodeJS sa aming GitHub upang matulungan kayong magsimula nang mabilis.

Mga Tool

Upang masiguro ang seamless na development experience, nag-aalok kami ng komprehensibong hanay ng mga tool, kabilang ang in-browser API request at webhook monitoring, IP address whitelisting, matatag na authentication options, at authentication test endpoint.

Hindi Developer?

Ang HLR Lookups at Number Portability Queries ay maaaring isagawa nang walang coding. Alamin pa ang tungkol sa aming enterprise web client at browser-based reporting features.

Pagpapatunay

Upang masiguro ang seguridad at tamang kontrol sa pag-access, karamihan ng mga kahilingan sa HLR Lookups API ay nangangailangan ng pagpapatunay. Ang mga endpoint ay nakakategorya bilang public o protected. Kapag nag-access ng protected endpoint, ang iyong kahilingan ay dapat na mapatunayan gamit ang iyong API key at secret sa pamamagitan ng Digest-Auth o Basic-Auth na paraan. Ang Digest-Auth ay mas secure na opsyon at lubos na inirerekomenda. Gamitin ang GET /auth-test endpoint upang i-verify ang iyong setup ng pagpapatunay.

API Key at API Secret

Kunin ang iyong API key at secret mula sa pahina ng API settings. Maaari mo ring i-configure ang iyong ginustong paraan ng pagpapatunay at paganahin ang IP address whitelisting para sa mas mataas na seguridad. Kung pinaghihinalaang nakompromiso ang iyong API secret, maaari kang bumuo ng bago anumang oras.

Basic Auth Digest Auth IP Whitelisting

Ang Standard Basic Authentication ay madaling ipatupad at malawakang suportado. Maaari kang magpatunay sa pamamagitan ng pagpasa ng iyong API key at secret bilang user:pass pair sa HTTP request.

HTTP Basic Auth

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

Nagpapadala ito ng Authorization header:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Inirerekomenda: X-Basic Header na may SHA256

Para sa mas mataas na seguridad, maaari kang magpadala ng SHA256 hash ng iyong mga kredensyal sa halip na direktang ipadala ang mga ito bilang base64. Upang gamitin ang paraang ito, kalkulahin ang hash ng iyong YOUR_API_KEY:YOUR_API_SECRET pair at ipadala ito sa pamamagitan ng X-Basic header:

Basic Auth Request

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

Basic Authentication Headers

Key	Uri	Paglalarawan
`X-Basic`	string	SHA256 hash ng `YOUR_API_KEY:YOUR_API_SECRET`. Isama ang colon symbol (:) sa hash.	kinakailangan

Halimbawa ng Code

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

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

Ang Digest-Auth ay ang inirerekomendang paraan para sa pag-secure ng access sa mga protected na HLR Lookup API endpoint. Ang bawat kahilingan ay dapat maglaman ng sumusunod na mga header: X-Digest-Key, X-Digest-Signature, at X-Digest-Timestamp, na ipinaliwanag sa ibaba.

Halimbawa ng Request

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"

Request Headers

Key	Uri	Paglalarawan
`X-Digest-Key`	string	Ang iyong natatanging HLR Lookups API Key.	kinakailangan
`X-Digest-Signature`	string	Natatanging authentication signature (tingnan sa ibaba).	kinakailangan
`X-Digest-Timestamp`	integer	Kasalukuyang Unix timestamp (tingnan din ang `GET /time`).	kinakailangan

Pagbuo ng Signature

Ang X-Digest-Signature ay ginawa gamit ang SHA256 HMAC hash, na may iyong API secret bilang shared key.

Ang string na i-hash ay nakabalangkas sa sumusunod:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Ang . symbol ay kumakatawan sa string concatenation.

Mga Bahagi ng Digest Signature

Bahagi	Uri	Paglalarawan
`ENDPOINT_PATH`	string	Ang hiniling na API endpoint, hal., `/auth-test` sa lowercase.
`UNIX_TIMESTAMP`	integer	Kasalukuyang Unix timestamp (dapat nasa loob ng 30 segundo). Tingnan ang `GET /time`.
`REQUEST_METHOD`	string	Ang HTTP method na ginamit, hal., `POST` o `GET`.
`REQUEST_BODY`	string	Data ng request body. Itakda sa `null` para sa mga `GET` request.

Mga Halimbawa ng Code

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)

Mag-scroll Pataas

Mga Konsepto

Ang pagpapatupad ng HLR Lookups sa anumang programming language o sistema sa pamamagitan ng aming HTTP REST API ay simple at mabisa. Sa pamamagitan ng simpleng proseso ng integration, maaari kang magsimulang mag-query sa mga mobile network nang real-time para sa agarang impormasyon tungkol sa validity ng phone number, connectivity status, at routing details.

Ang pagpili ng naaangkop na API ay nakadepende sa iyong partikular na use case. Kung kailangan mo ng real-time na resulta ng lookup para sa mga aplikasyon tulad ng VoIP telephony, fraud detection, o SMS routing, ang synchronous API ang pinakamahusay na pagpipilian. Gayunpaman, kung ang iyong use case ay nagsasangkot ng high-volume processing, bulk lookups, o large-scale data verification, ang asynchronous API ay nag-aalok ng optimized performance na may bandwidth efficiency at batch lookup capabilities.

I-configure ang API upang gumamit ng isa sa aming custom routing options para ma-optimize ang bilis, katumpakan, at cost-effectiveness. Maaari mo ring i-store ang mga resulta ng lookup sa storages para sa madaling pag-download ng CSV at JSON reports, pati na rin ang advanced analytics sa pamamagitan ng web interface.

Synchronous HLR Lookup API

Ang POST /hlr-lookup endpoint ay nagpoproseso ng isang mobile phone number (MSISDN) bawat request at nagbabalik ng mga resulta kaagad sa HTTP response body. Ang mga resulta ay naka-format bilang JSON at perpekto para sa real-time applications, kabilang ang mobile number validation, call routing, at SMS message delivery.

Ang synchronous API call ay binubuo ng direktang HTTP request at response. Ang iyong sistema ay nagsusumite ng isang MSISDN (mobile number) bawat request at tumatanggap ng agarang response na naglalaman ng real-time HLR lookup results sa JSON format. Ang API na ito ay na-optimize para sa mga use case na nangangailangan ng instant verification at connectivity checks, tulad ng fraud detection, VoIP call routing, at SMS gateway optimization.

Asynchronous HLR Lookup API

Ang POST /hlr-lookups endpoint ay dinisenyo para sa bulk at high-volume processing, na nagpapahintulot sa iyo na magsumite ng hanggang 1,000 MSISDNs bawat request. Sa halip na magbalik ng mga resulta kaagad, ang API na ito ay gumagamit ng automated webhooks upang ipadala ang mga resulta nang progresibo sa iyong server. Ang mga resulta ng lookup ay ibinalik bilang JSON objects sa pamamagitan ng HTTP POST callbacks.

Ang asynchronous API ay na-optimize para sa bilis, kahusayan, at scalability. Nag-aalis ito ng mga isyu sa network latency na nauugnay sa synchronous calls, na ginagawang perpekto para sa mga negosyong nangangailangan ng high-throughput lookups. Ang iyong sistema ay nagsusumite ng hanggang 1,000 MSISDNs bawat request, at ang aming platform ay nagpoproseso ng mga ito nang parallel, na naghahatid ng mga resulta pabalik sa iyong server sa pamamagitan ng HTTP webhooks sa batches na hanggang 1,000 results bawat callback.

Mga SDK (Software Development Kit)

Ang aming mga Software Development Kit (SDK) para sa PHP, NodeJS, at Ruby ay nagpapasimple ng proseso ng integrasyon, na nagbibigay-daan sa inyo na kumonekta sa HLR Lookups API nang mahusay at may pinakamababang pagsisikap.

Ang mga SDK na ito ay nagbibigay ng mga pre-built na function, authentication handling, at structured na mga API request template, na nagpapababa ng oras ng development at nagsisiguro ng best practices.

Tingnan ang aming kumpletong listahan ng available na mga SDK sa GitHub at magsimulang mag-integrate ngayon.

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

Tingnan sa 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   }

Tingnan sa 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)

Tingnan sa GitHub README.md

Mag-scroll Pataas

POST/hlr-lookupprotektado

Nagsasagawa ng synchronous HLR Lookup, na naghahatid ng real-time na datos ng koneksyon at portability ng mobile phone direkta mula sa mga network operator. Ang endpoint na ito ay perpekto para sa live traffic scenarios kung saan ang mga time-sensitive na aplikasyon ay nangangailangan ng agarang verification kung ang isang phone number ay kasalukuyang maaabot (connected) o hindi available (switched off). Bukod pa rito, tumutulong ito na makilala ang mga aktibong numero mula sa mga invalid, unknown, o pekeng numero.

Para sa bulk processing ng malalaking dataset na hindi nangangailangan ng instant na resulta, isaalang-alang ang paggamit ng asynchronous POST /hlr-lookups, na optimized para sa high-speed batch processing.

Kung ang pangunahing layunin mo ay kunin ang mobile number portability data (MCCMNC) at hindi mo kailangan ang live connectivity status, ang POST /mnp-lookup ay nag-aalok ng cost-effective na alternatibo para sa mobile number portability queries.

Request Matagumpay na Tugon Tugon sa Error Sanggunian ng Status

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdn`	string	Ang mobile phone number (MSISDN) na iku-query, na ibinigay sa international format (hal., +14156226819 o 0014156226819). Dapat isama ang mga country code.	null	kinakailangan
`route`	string(3)	Isang opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang iyong custom routing map o hayaang ang aming system ay awtomatikong tumukoy ng pinakamahusay na route para sa lookup na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Natatanging identifier na itinalaga sa kahilingang lookup na ito.	false
`msisdn`	string	Ang mobile phone number na tinatanong, na naka-format sa international format (hal., +14156226819 o 0014156226819).	false
`connectivity_status`	string	Nagsasaad kung matagumpay na nakuha ang connectivity status ng numero. Mga posibleng halaga: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , o `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Limang o anim na digit na Mobile Country Code (MCC) at Mobile Network Code (MNC) na tumutukoy sa network na kasalukuyang nauugnay sa phone number.	true
`mcc`	string(3)	Tatlong digit na Mobile Country Code (MCC) na tumutukoy sa bansang pinagrejistro ng phone number.	true
`mnc`	string(2\|3)	Dalawa o tatlong digit na Mobile Network Code (MNC) na tumutukoy sa partikular na network kung saan nabibilang ang phone number.	true
`imsi`	string	Ang International Mobile Subscriber Identity (IMSI), isang natatanging identifier para sa SIM card na nauugnay sa numerong ito. Ang availability ay nakadepende sa network configuration.	true
`msin`	string(10)	Ang Mobile Subscription Identification Number (MSIN) sa loob ng database ng mobile operator. Ang availability ay nakadepende sa network configuration.	true
`msc`	string(12)	Ang Mobile Switching Center (MSC) na kasalukuyang humahawak ng mga komunikasyon ng subscriber na ito. Ang availability ay nakadepende sa network configuration.	true
`original_network_name`	string	Ang orihinal (native) na pangalan ng network operator na nauugnay sa numerong ito.	true
`original_country_name`	string	Ang buong pangalan ng bansang pinagrejistro ng mobile phone number, na ibinigay sa Ingles.	true
`original_country_code`	string(2)	Ang dalawang character na ISO country code na kumakatawan sa bansang unang itinalaga ang phone number.	true
`original_country_prefix`	string	Ang international dialing code (country calling code) na tumutugma sa orihinal na bansa ng mobile phone number.	true
`is_ported`	boolean	Nagsasaad kung ang mobile number ay na-port mula sa orihinal na network patungo sa ibang operator.	true
`ported_network_name`	string	Ang pangalan ng network operator kung saan na-port ang mobile number, kung naaangkop.	true
`ported_country_name`	string	Ang pangalan ng bansang pinag-port-an ng mobile number, kung naaangkop.	true
`ported_country_code`	string(2)	Ang dalawang character na ISO country code na kumakatawan sa bansang pinag-port-an ng mobile number, kung naaangkop.	true
`ported_country_prefix`	string	Ang international dialing code (country calling code) para sa bansang pinag-port-an ng mobile number, kung naaangkop.	true
`is_roaming`	boolean	Nagsasaad kung ang mobile number ay kasalukuyang nag-roaming sa foreign network. Ang availability ng roaming status ay nakadepende sa mobile network operator.	true
`roaming_network_name`	string	Ang pangalan ng network kung saan kasalukuyang nag-roaming ang mobile number, kung naaangkop.	true
`roaming_country_name`	string	Ang pangalan ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`roaming_country_code`	string(2)	Ang dalawang character na ISO country code ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`roaming_country_prefix`	string	Ang international dialing code (country calling code) ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`cost`	string	Decimal value na kinakatawan bilang string, na nagsasaad ng lookup cost sa EUR.	true
`timestamp`	string	W3C-formatted timestamp kasama ang time zone, na tumutukoy kung kailan natapos ang lookup.	true
`storage`	string	Ang pangalan ng storage kung saan nai-save ang mga resulta ng lookup. Ito ay tumutugma sa mga report names at CSV downloads na available sa web interface.	true
`route`	string(3)	Tatlong character na identifier na nagsasaad ng routing method na ginamit para sa kahilingang lookup na ito.	true
`processing_status`	string	Ang processing outcome ng lookup. Mga posibleng halaga: `COMPLETED` (matagumpay), `REJECTED` (hindi maabot ang network, walang singil), o `FAILED` (nagkaroon ng error sa processing).	false
`error_code`	integer	Opsyonal na internal error code na nagbibigay ng karagdagang diagnostic information para sa customer support.	true
`error_description`	string	Maikling paliwanag ng ibinigay na error code (kung mayroon) sa plain text na Ingles.	true
`data_source`	string	Ang data source na ginamit para sa kahilingang ito. Mga posibleng halaga: `LIVE_HLR` (real-time HLR query) o `MNP_DB` (static mobile number portability database). Tingnan ang routing options para sa mga detalye.	false
`routing_instruction`	string	Colon-delimited string na naglalarawan sa routing instruction na ginamit sa kahilingan. Ang unang bahagi ay `STATIC` kapag nagtukoy ka ng route o `AUTO` para sa automatic routing; ang ikalawang bahagi ay ang route identifier, at para sa automatic routing requests ang ikatlong bahagi ay nagpapakita ng origin kung saan nakabatay ang routing decision (i.e. `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."
    ]
}

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Katayuan	Paglalarawan
CONNECTED	Ang numero ay valid, at ang target na handset ay kasalukuyang nakakonekta sa mobile network. Ang mga tawag, SMS, at iba pang serbisyo ay dapat matagumpay na maabot ang tatanggap.
ABSENT	Ang numero ay valid, ngunit ang target na handset ay nakapatay o pansamantalang wala sa saklaw ng network. Ang mga mensahe o tawag ay maaaring hindi maideliver hanggang sa muling kumonekta ang device sa network.
INVALID_MSISDN	Ang numero ay invalid o hindi kasalukuyang nakatakda sa anumang subscriber sa mobile network. Ang mga tawag at mensahe sa numerong ito ay mabibigo.
UNDETERMINED	Hindi matukoy ang connectivity status ng numero. Maaaring dahil ito sa invalid na numero, SS7 error response, o kakulangan ng koneksyon sa target network operator. Suriin ang error code at ang description field nito para sa karagdagang diagnostics.

Mag-scroll Pataas

POST/hlr-lookupsprotektado

Nagsisimula ng batch ng asynchronous HLR lookups, na kumukuha ng live na datos ng koneksyon at portability ng mobile phone mula sa mga network operator. Ang mga resulta ay ipinapadala sa pamamagitan ng webhooks sa inyong server. Ang pamamaraang ito ay na-optimize para sa pagproseso ng malalaking dami ng mga numero na hindi nangangailangan ng agarang tugon, tulad ng paglilinis at pag-verify ng database. Para sa real-time na aplikasyon tulad ng call routing o SMS delivery, isaalang-alang ang paggamit ng POST /hlr-lookup endpoint.

Ang endpoint na ito ay perpekto para sa bulk processing kapag ang layunin ay tukuyin ang mga phone number na kasalukuyang maaabot (connected) o hindi available (nakapatay ang telepono) habang nag-filter ng mga invalid, unassigned, o pekeng numero. Bukod dito, nagbibigay ito ng live portability status (MCCMNC) kasama ng mga detalye ng koneksyon.

Bago gamitin ang endpoint na ito, tiyaking may naka-configure na webhook URL upang makatanggap ng mga resulta ng lookup nang asynchronous. Maaari ninyong i-setup ito sa inyong API settings.

Request Matagumpay na Tugon Tugon sa Error Webhooks Sanggunian ng Status

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdns`	array	Isang array ng mga mobile phone number (MSISDN) sa international format (hal. +14156226819 o 0014156226819). Maaari kayong magsama ng hanggang 1000 numero bawat request.	null	kinakailangan
`route`	string(3)	Isang opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang iyong custom routing map o hayaang ang aming system ay awtomatikong tumukoy ng pinakamahusay na route para sa lookup na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`accepted`	array	Isang listahan ng mga object na naglalaman ng unique identifier at MSISDN na tinanggap para sa pagproseso.	false
`accepted_count`	integer	Ang kabuuang bilang ng MSISDN na matagumpay na tinanggap para sa pagproseso.	false
`rejected`	array	Isang listahan ng mga object na naglalaman ng unique identifier at MSISDN na tinanggihan para sa pagproseso, karaniwang dahil sa invalid na numero. Walang singil para sa mga tinanggihang entry.	false
`rejected_count`	integer	Ang kabuuang bilang ng MSISDN na tinanggihan dahil sa mga validation error.	false
`total_count`	integer	Ang kabuuang bilang ng tinanggap at tinanggihang MSISDN na isinumite para sa pagproseso.	false
`cost`	string	Isang decimal value na kinakatawan bilang string, na nagsasaad ng kabuuang halaga sa EUR para sa mga tinanggap na lookup.	false
`storage`	string	Ang pangalan ng storage kung saan idinadagdag ang mga resulta ng lookup, ginagamit para sa reporting at CSV download sa pamamagitan ng web interface.	false
`route`	string(3\|4)	Isang tatlo o apat na character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito. Naglalaman ng AUTO kung hiniling ang number-based automatic routing.	false
`webhook_urls`	array	Ang mga webhook URL na naka-configure sa inyong API settings. Dito ipinapadala pabalik ang mga resulta.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Pagproseso ng mga Webhook

Kapag naisumite na, magsisimulang iproseso ng aming platform ang mga ibinigay na numero ng telepono at ipapadala ang mga resulta sa webhook URL na itinakda sa inyong server. Ang mga resulta ay ipinapadala bilang HTTP POST request na may JSON object sa request body.

Pagpapatunay

I-authenticate ang webhook sa pamamagitan ng pagsusuri sa X-Signatures HTTP header.

Ang X-Signatures header ay naglalaman ng listahan ng mga signature na pinaghihiwalay ng semicolon. Ang bawat signature sa listahan ay nabuo gamit ang isa sa mga API secret na naka-configure sa inyong account. Upang i-verify ang webhook, gumawa ng SHA-256 hash gamit ang inyong API key, secret, at raw HTTP body - pagkatapos ay ihambing ito sa mga signature sa listahan.

Ang pagtutugma ay nagpapatunay na ang request ay tunay at nilagdaan gamit ang secret na inyong kontrolado.

Halimbawa ng Code

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

Ang request ay valid kung alinman sa mga signature na ibinigay sa header ay katumbas ng SHA256 hash na kinalkula mula sa pinagsama-samang string ng inyong API key, secret, at HTTP body.

Pagkumpirma ng Pagtanggap

Inaasahang tumugon ang inyong server gamit ang HTTP status code 200 OK upang kumpirmahin ang matagumpay na pagtanggap. Kung ibang response code ang maibalik, magkaroon ng timeout (10 segundo), o lumitaw ang anumang isyu sa delivery, awtomatikong susubukan ulit ng system ang webhook pagkatapos ng isang minuto. Kung patuloy na mabigo ang request, ang mga retry ay susunod sa exponential backoff strategy, na may mga susunod pang pagtatangka pagkatapos ng 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuto.

Ang mekanismong ito ng retry ay nagsisiguro ng pinakamataas na reliability sa paghahatid ng mga resulta ng lookup sa inyong infrastructure. Binabawasan nito ang panganib ng pagkawala ng data dahil sa pansamantalang mga isyu sa network o server downtime.

Webhook Payload

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

Mga Attribute ng Webhook Payload

Ang JSON object ay naglalaman ng attribute na type => HLR kasama ng attribute na results na may kasamang listahan ng mga lookup object, gaya ng nakadokumento sa ibaba.

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Natatanging identifier na itinalaga sa kahilingang lookup na ito.	false
`msisdn`	string	Ang mobile phone number na tinatanong, na naka-format sa international format (hal., +14156226819 o 0014156226819).	false
`connectivity_status`	string	Nagsasaad kung matagumpay na nakuha ang connectivity status ng numero. Mga posibleng halaga: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , o `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	Limang o anim na digit na Mobile Country Code (MCC) at Mobile Network Code (MNC) na tumutukoy sa network na kasalukuyang nauugnay sa phone number.	true
`mcc`	string(3)	Tatlong digit na Mobile Country Code (MCC) na tumutukoy sa bansang pinagrejistro ng phone number.	true
`mnc`	string(2\|3)	Dalawa o tatlong digit na Mobile Network Code (MNC) na tumutukoy sa partikular na network kung saan nabibilang ang phone number.	true
`imsi`	string	Ang International Mobile Subscriber Identity (IMSI), isang natatanging identifier para sa SIM card na nauugnay sa numerong ito. Ang availability ay nakadepende sa network configuration.	true
`msin`	string(10)	Ang Mobile Subscription Identification Number (MSIN) sa loob ng database ng mobile operator. Ang availability ay nakadepende sa network configuration.	true
`msc`	string(12)	Ang Mobile Switching Center (MSC) na kasalukuyang humahawak ng mga komunikasyon ng subscriber na ito. Ang availability ay nakadepende sa network configuration.	true
`original_network_name`	string	Ang orihinal (native) na pangalan ng network operator na nauugnay sa numerong ito.	true
`original_country_name`	string	Ang buong pangalan ng bansang pinagrejistro ng mobile phone number, na ibinigay sa Ingles.	true
`original_country_code`	string(2)	Ang dalawang character na ISO country code na kumakatawan sa bansang unang itinalaga ang phone number.	true
`original_country_prefix`	string	Ang international dialing code (country calling code) na tumutugma sa orihinal na bansa ng mobile phone number.	true
`is_ported`	boolean	Nagsasaad kung ang mobile number ay na-port mula sa orihinal na network patungo sa ibang operator.	true
`ported_network_name`	string	Ang pangalan ng network operator kung saan na-port ang mobile number, kung naaangkop.	true
`ported_country_name`	string	Ang pangalan ng bansang pinag-port-an ng mobile number, kung naaangkop.	true
`ported_country_code`	string(2)	Ang dalawang character na ISO country code na kumakatawan sa bansang pinag-port-an ng mobile number, kung naaangkop.	true
`ported_country_prefix`	string	Ang international dialing code (country calling code) para sa bansang pinag-port-an ng mobile number, kung naaangkop.	true
`is_roaming`	boolean	Nagsasaad kung ang mobile number ay kasalukuyang nag-roaming sa foreign network. Ang availability ng roaming status ay nakadepende sa mobile network operator.	true
`roaming_network_name`	string	Ang pangalan ng network kung saan kasalukuyang nag-roaming ang mobile number, kung naaangkop.	true
`roaming_country_name`	string	Ang pangalan ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`roaming_country_code`	string(2)	Ang dalawang character na ISO country code ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`roaming_country_prefix`	string	Ang international dialing code (country calling code) ng bansang kasalukuyang kinaroroonan ng mobile number habang nag-roaming, kung naaangkop.	true
`cost`	string	Decimal value na kinakatawan bilang string, na nagsasaad ng lookup cost sa EUR.	true
`timestamp`	string	W3C-formatted timestamp kasama ang time zone, na tumutukoy kung kailan natapos ang lookup.	true
`storage`	string	Ang pangalan ng storage kung saan nai-save ang mga resulta ng lookup. Ito ay tumutugma sa mga report names at CSV downloads na available sa web interface.	true
`route`	string(3)	Tatlong character na identifier na nagsasaad ng routing method na ginamit para sa kahilingang lookup na ito.	true
`processing_status`	string	Ang processing outcome ng lookup. Mga posibleng halaga: `COMPLETED` (matagumpay), `REJECTED` (hindi maabot ang network, walang singil), o `FAILED` (nagkaroon ng error sa processing).	false
`error_code`	integer	Opsyonal na internal error code na nagbibigay ng karagdagang diagnostic information para sa customer support.	true
`error_description`	string	Maikling paliwanag ng ibinigay na error code (kung mayroon) sa plain text na Ingles.	true
`data_source`	string	Ang data source na ginamit para sa kahilingang ito. Mga posibleng halaga: `LIVE_HLR` (real-time HLR query) o `MNP_DB` (static mobile number portability database). Tingnan ang routing options para sa mga detalye.	false
`routing_instruction`	string	Colon-delimited string na naglalarawan sa routing instruction na ginamit sa kahilingan. Ang unang bahagi ay `STATIC` kapag nagtukoy ka ng route o `AUTO` para sa automatic routing; ang ikalawang bahagi ay ang route identifier, at para sa automatic routing requests ang ikatlong bahagi ay nagpapakita ng origin kung saan nakabatay ang routing decision (i.e. `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

Katayuan	Paglalarawan
CONNECTED	Ang numero ay valid, at ang target na handset ay kasalukuyang nakakonekta sa mobile network. Ang mga tawag, SMS, at iba pang serbisyo ay dapat matagumpay na maabot ang tatanggap.
ABSENT	Ang numero ay valid, ngunit ang target na handset ay nakapatay o pansamantalang wala sa saklaw ng network. Ang mga mensahe o tawag ay maaaring hindi maideliver hanggang sa muling kumonekta ang device sa network.
INVALID_MSISDN	Ang numero ay invalid o hindi kasalukuyang nakatakda sa anumang subscriber sa mobile network. Ang mga tawag at mensahe sa numerong ito ay mabibigo.
UNDETERMINED	Hindi matukoy ang connectivity status ng numero. Maaaring dahil ito sa invalid na numero, SS7 error response, o kakulangan ng koneksyon sa target network operator. Suriin ang error code at ang description field nito para sa karagdagang diagnostics.

Mag-scroll Pataas

POST/mnp-lookupprotektado

Nagsasagawa ng synchronous MNP lookup at nagbibigay ng mobile numbering portability at network information. Angkop ang endpoint na ito kung ang pangunahing layunin mo ay kunin ang kasalukuyang MCCMNC ng isang mobile phone number at tukuyin ang orihinal at kasalukuyang network nang real-time.

Para sa bulk processing ng malalaking dataset na hindi nangangailangan ng instant na resulta, isaalang-alang ang paggamit ng asynchronous POST /mnp-lookups, na optimized para sa high-speed batch processing.

Ang mga MNP query ay maaasahang tumutukoy ng portability at network information ngunit hindi nagsasaad kung ang target mobile phone ay kasalukuyang nakakonekta sa network at maaabot. Upang makuha ang live connectivity information, mangyaring gumamit ng POST /hlr-lookup endpoint.

Request Matagumpay na Tugon Tugon sa Error

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdn`	string	Ang mobile phone number (MSISDN) na iku-query, na ibinigay sa international format (hal., +14156226819 o 0014156226819). Dapat isama ang mga country code.	null	kinakailangan
`route`	string(3)	Isang opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang iyong custom routing map o hayaang ang aming system ay awtomatikong tumukoy ng pinakamahusay na route para sa lookup na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Isang natatanging 12-character na identifier para sa lookup na ito.	false
`msisdn`	string	Ang mobile phone number na sinuri sa lookup request na ito.	false
`query_status`	string	Nagsasaad kung matagumpay ang pagkuha ng portability at network information. Ang posibleng mga halaga ay `OK` o `FAILED`.	false
`mccmnc`	string(5\|6)	Isang lima- o anim na character na MCCMNC (mobile country code at mobile network code tuple) na tumutukoy sa network kung saan kasalukuyang kabilang ang mobile phone number.	true
`mcc`	string(3)	Isang tatlong character na MCC (mobile country code) na kumakatawan sa bansang nauugnay sa kasalukuyang network ng mobile phone number.	true
`mnc`	string(2\|3)	Isang dalawa- o tatlong character na MNC (mobile network code) na tumutukoy sa kasalukuyang network operator para sa mobile phone number.	true
`is_ported`	boolean	Nagsasaad kung ang phone number ay na-port mula sa orihinal na network tungo sa bagong operator.	true
`original_network_name`	string	Isang arbitrary string (sa Ingles) na tumutukoy sa pangalan ng orihinal na network operator ng sinuring mobile phone number.	true
`original_country_name`	string	Isang arbitrary string (sa Ingles) na nagsasaad ng orihinal na bansa ng sinuring mobile phone number.	true
`original_country_code`	string(2)	Isang dalawang character na ISO country code na kumakatawan sa orihinal na bansa ng sinuring mobile phone number.	true
`original_country_prefix`	string	Ang dialing code ng orihinal na bansang nauugnay sa sinuring mobile phone number.	true
`ported_network_name`	string	Tumutukoy sa network operator kung saan na-port ang sinuring mobile phone number, kung naaangkop.	true
`ported_country_name`	string	Tumutukoy sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`ported_country_code`	string(2)	Isang dalawang character na ISO country code na kumakatawan sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`ported_country_prefix`	string	Ang dialing code para sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`extra`	string	Isang arbitrary string na nagbibigay ng opsyonal na karagdagang detalye tungkol sa phone number.	true
`cost`	string	Isang decimal value, na kinakatawan bilang string, na nagsasaad ng gastos sa EUR para sa lookup na ito.	true
`timestamp`	string	Isang W3C-formatted na timestamp, kasama ang time zone information, na nagsasaad kung kailan natapos ang lookup.	true
`storage`	string	Ang storage name (o report name) kung saan idinagdag ang mga resulta ng lookup. Ginagamit ito para sa CSV downloads at reporting sa pamamagitan ng web interface.	true
`route`	string(3)	Isang tatlong character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	true
`error_code`	integer	Isang opsyonal na internal error code na nagbibigay ng karagdagang konteksto para sa customer support diagnostics.	true

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

POST/mnp-lookupsprotektado

Nagsisimula ng batch ng asynchronous MNP (mobile number portability) lookups, kinukuha ang kasalukuyang MCCMNC at tinutukoy ang orihinal at kasalukuyang networks sa real-time. Ang mga resulta ay ipinapadala sa pamamagitan ng webhooks sa inyong server. Ang pamamaraang ito ay na-optimize para sa pagproseso ng malalaking dami ng mga numero na hindi nangangailangan ng agarang tugon, tulad ng paglilinis at pag-verify ng database. Para sa real-time na aplikasyon tulad ng call routing o SMS delivery, isaalang-alang ang paggamit ng POST /mnp-lookup endpoint.

Ang mga MNP query ay maaasahang tumutukoy ng portability at network information ngunit hindi nagsasaad kung ang target mobile phone ay kasalukuyang nakakonekta sa network at maaabot. Upang makuha ang live connectivity information, mangyaring gumamit ng POST /hlr-lookups endpoint.

Bago gamitin ang endpoint na ito, tiyaking may naka-configure na webhook URL upang makatanggap ng mga resulta ng lookup nang asynchronous. Maaari ninyong i-setup ito sa inyong API settings.

Request Matagumpay na Tugon Tugon sa Error Webhooks

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdns`	array	Isang array ng mga mobile phone number (MSISDN) sa international format (hal. +14156226819 o 0014156226819). Maaari kayong magsama ng hanggang 1000 numero bawat request.	null	kinakailangan
`route`	string(3)	Opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang inyong custom routing map o awtomatikong hayaang tukuyin ng aming system ang pinakamahusay na routes para sa request na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`accepted`	array	Isang listahan ng mga object na naglalaman ng unique identifier at MSISDN na tinanggap para sa pagproseso.	false
`accepted_count`	integer	Ang kabuuang bilang ng MSISDN na matagumpay na tinanggap para sa pagproseso.	false
`rejected`	array	Isang listahan ng mga object na naglalaman ng unique identifier at MSISDN na tinanggihan para sa pagproseso, karaniwang dahil sa invalid na numero. Walang singil para sa mga tinanggihang entry.	false
`rejected_count`	integer	Ang kabuuang bilang ng MSISDN na tinanggihan dahil sa mga validation error.	false
`total_count`	integer	Ang kabuuang bilang ng tinanggap at tinanggihang MSISDN na isinumite para sa pagproseso.	false
`cost`	string	Isang decimal value na kinakatawan bilang string, na nagsasaad ng kabuuang halaga sa EUR para sa mga tinanggap na lookup.	false
`storage`	string	Ang pangalan ng storage kung saan idinadagdag ang mga resulta ng lookup, ginagamit para sa reporting at CSV download sa pamamagitan ng web interface.	false
`route`	string(3)	Isang tatlong character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	false
`webhook_urls`	array	Ang mga webhook URL na naka-configure sa inyong API settings. Dito ipinapadala pabalik ang mga resulta.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Pagproseso ng mga Webhook

Kapag naisumite na, magsisimulang iproseso ng aming platform ang mga ibinigay na numero ng telepono at ipapadala ang mga resulta sa webhook URL na itinakda sa inyong server. Ang mga resulta ay ipinapadala bilang HTTP POST request na may JSON object sa request body.

Pagpapatunay

I-authenticate ang webhook sa pamamagitan ng pagsusuri sa X-Signatures HTTP header.

Ang X-Signatures header ay naglalaman ng listahan ng mga signature na pinaghihiwalay ng semicolon. Ang bawat signature sa listahan ay nabuo gamit ang isa sa mga API secret na naka-configure sa inyong account. Upang i-verify ang webhook, gumawa ng SHA-256 hash gamit ang inyong API key, secret, at raw HTTP body - pagkatapos ay ihambing ito sa mga signature sa listahan.

Ang pagtutugma ay nagpapatunay na ang request ay tunay at nilagdaan gamit ang secret na inyong kontrolado.

Halimbawa ng Code

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

Ang request ay valid kung alinman sa mga signature na ibinigay sa header ay katumbas ng SHA256 hash na kinalkula mula sa pinagsama-samang string ng inyong API key, secret, at HTTP body.

Pagkumpirma ng Pagtanggap

Inaasahang tumugon ang inyong server gamit ang HTTP status code 200 OK upang kumpirmahin ang matagumpay na pagtanggap. Kung ibang response code ang maibalik, magkaroon ng timeout (10 segundo), o lumitaw ang anumang isyu sa delivery, awtomatikong susubukan ulit ng system ang webhook pagkatapos ng isang minuto. Kung patuloy na mabigo ang request, ang mga retry ay susunod sa exponential backoff strategy, na may mga susunod pang pagtatangka pagkatapos ng 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuto.

Ang mekanismong ito ng retry ay nagsisiguro ng pinakamataas na reliability sa paghahatid ng mga resulta ng lookup sa inyong infrastructure. Binabawasan nito ang panganib ng pagkawala ng data dahil sa pansamantalang mga isyu sa network o server downtime.

Webhook Payload

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

Mga Attribute ng Webhook Payload

Ang JSON object ay naglalaman ng attribute na type => MNP kasama ng attribute na results na may kasamang listahan ng mga lookup object, gaya ng nakadokumento sa ibaba.

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Isang natatanging 12-character na identifier para sa lookup na ito.	false
`msisdn`	string	Ang mobile phone number na sinuri sa lookup request na ito.	false
`query_status`	string	Nagsasaad kung matagumpay ang pagkuha ng portability at network information. Ang posibleng mga halaga ay `OK` o `FAILED`.	false
`mccmnc`	string(5\|6)	Isang lima- o anim na character na MCCMNC (mobile country code at mobile network code tuple) na tumutukoy sa network kung saan kasalukuyang kabilang ang mobile phone number.	true
`mcc`	string(3)	Isang tatlong character na MCC (mobile country code) na kumakatawan sa bansang nauugnay sa kasalukuyang network ng mobile phone number.	true
`mnc`	string(2\|3)	Isang dalawa- o tatlong character na MNC (mobile network code) na tumutukoy sa kasalukuyang network operator para sa mobile phone number.	true
`is_ported`	boolean	Nagsasaad kung ang phone number ay na-port mula sa orihinal na network tungo sa bagong operator.	true
`original_network_name`	string	Isang arbitrary string (sa Ingles) na tumutukoy sa pangalan ng orihinal na network operator ng sinuring mobile phone number.	true
`original_country_name`	string	Isang arbitrary string (sa Ingles) na nagsasaad ng orihinal na bansa ng sinuring mobile phone number.	true
`original_country_code`	string(2)	Isang dalawang character na ISO country code na kumakatawan sa orihinal na bansa ng sinuring mobile phone number.	true
`original_country_prefix`	string	Ang dialing code ng orihinal na bansang nauugnay sa sinuring mobile phone number.	true
`ported_network_name`	string	Tumutukoy sa network operator kung saan na-port ang sinuring mobile phone number, kung naaangkop.	true
`ported_country_name`	string	Tumutukoy sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`ported_country_code`	string(2)	Isang dalawang character na ISO country code na kumakatawan sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`ported_country_prefix`	string	Ang dialing code para sa bansang pinag-portan ng sinuring mobile phone number, kung naaangkop.	true
`extra`	string	Isang arbitrary string na nagbibigay ng opsyonal na karagdagang detalye tungkol sa phone number.	true
`cost`	string	Isang decimal value, na kinakatawan bilang string, na nagsasaad ng gastos sa EUR para sa lookup na ito.	true
`timestamp`	string	Isang W3C-formatted na timestamp, kasama ang time zone information, na nagsasaad kung kailan natapos ang lookup.	true
`storage`	string	Ang storage name (o report name) kung saan idinagdag ang mga resulta ng lookup. Ginagamit ito para sa CSV downloads at reporting sa pamamagitan ng web interface.	true
`route`	string(3)	Isang tatlong character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	true
`error_code`	integer	Isang opsyonal na internal error code na nagbibigay ng karagdagang konteksto para sa customer support diagnostics.	true

Mag-scroll Pataas

POST/nt-lookupprotektado

Nagsasagawa ng synchronous number type (NT) lookup. Ang endpoint na ito ay ideal kung ang pangunahing layunin mo ay tukuyin kung ang mga ibinigay na numero ng telepono ay kabilang sa landline, mobile, premium rate, VoIP, pager, o iba pang numbering plan ranges nang real-time.

Ang mga NT query ay maaasahang nakakadetekta ng uri ng numero ng telepono; gayunpaman, hindi nito isinasaad kung ang target number ay kasalukuyang nakakonekta sa network at maaabot. Upang makuha ang live connectivity information, mangyaring gamitin ang POST /hlr-lookup endpoint.

Kung ang iyong use case ay nangangailangan ng tumpak na network at portability information (MCCMNC) ngunit hindi live connectivity status, mangyaring gamitin ang POST /mnp-lookup endpoint para sa mga mobile number portability query.

Request Matagumpay na Tugon Tugon sa Error Sanggunian ng Uri

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`number`	string	Numero ng telepono sa international format (hal. +4989702626 o 004989702626).	null	mandatory
`route`	string(3)	Opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang iyong custom routing map o hayaan ang aming system na awtomatikong matukoy ang pinakamahusay na mga route para sa request na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Natatanging identifier na itinalaga sa kahilingang lookup na ito.	false
`number`	string	Ang numero ng telepono na sinuri sa panahon ng kahilingang ito sa paghahanap.	false
`number_type`	string	Ang natukoy na uri ng numero. Posibleng mga halaga ay kinabibilangan ng: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Nagpapahiwatig kung matagumpay na nakuha ang impormasyon ng uri ng numero. Nagbabalik ng `OK` kung matagumpay, o `FAILED` kung nabigo ang paghahanap.	false
`is_valid`	boolean	Nagpapahiwatig kung ang numero ng telepono ay wasto sa aspeto ng syntax.	true
`invalid_reason`	string	Isang plain text na mensahe sa Ingles na tumutukoy kung bakit ang numero ng telepono ay itinuturing na hindi wasto (hal. "too short" o "invalid prefix"), o `null` kung ang numero ay wasto.	true
`is_possibly_ported`	boolean	Nagpapahiwatig kung ang numero ng telepono ay maaaring inilipat mula sa orihinal na operator tungo sa ibang carrier. Para sa tumpak na impormasyon tungkol sa portability, gamitin ang MNP lookups.	true
`is_vanity_number`	boolean	Nagpapahiwatig kung ang numero ng telepono ay vanity number, ibig sabihin ay naglalaman ito ng mga alpabetikong karakter.	true
`qualifies_for_hlr_lookup`	boolean	Nagpapahiwatig kung ang numero ng telepono ay karapat-dapat para sa karagdagang mga query sa pamamagitan ng HLR lookups.	true
`mccmnc`	string(5\|6)	Isang limang o anim na karakter na string na kumakatawan sa MCCMNC tuple (mobile country code at mobile network code) na tumutukoy sa orihinal na network ng numero ng mobile phone.	true
`mcc`	string(3)	Isang tatlong karakter na string na kumakatawan sa MCC (mobile country code) na tumutukoy sa bansang nauugnay sa orihinal na mobile network ng numero ng telepono.	true
`mnc`	string(2\|3)	Isang dalawa o tatlong karakter na string na kumakatawan sa MNC (mobile network code) na tumutukoy sa orihinal na mobile network operator ng numero ng telepono.	true
`original_network_name`	string	Isang arbitraryong plain text string sa Ingles na tumutukoy sa pangalan ng orihinal na network operator ng sinuring numero ng mobile phone.	true
`original_country_name`	string	Isang arbitraryong plain text string sa Ingles na tumutukoy sa orihinal na bansang nauugnay sa sinuring numero ng mobile phone.	true
`original_country_code`	string(2)	Isang dalawang karakter na ISO country code na nagpapahiwatig ng orihinal na bansa ng sinuring numero ng mobile phone.	true
`regions`	array	Isang listahan ng mga string sa Ingles na madaling mabasa na tumutukoy sa heograpikal na rehiyon o mga rehiyon na nauugnay sa numerong ito ng telepono.	true
`timezones`	array	Isang listahan ng mga timezone (sa Olson format) na nauugnay sa numerong ito ng telepono.	true
`info_text`	string	Isang arbitraryong string na maaaring maglaman ng karagdagang impormasyon tungkol sa numero ng telepono.	true
`cost`	string	Isang decimal value na kinakatawan bilang string, na nagpapahiwatig ng gastos (sa EUR) ng paghahanap na ito.	true
`timestamp`	string	Isang W3C-formatted na timestamp (kasama ang time zone) na nagpapahiwatig kung kailan natapos ang paghahanap.	true
`storage`	string	Tumutukoy sa pangalan ng storage kung saan naidagdag ang mga resulta ng paghahanap. Ito ay tumutugma sa pangalan ng ulat na ginagamit para sa mga CSV download at analytics sa pamamagitan ng web interface.	true
`route`	string(3)	Isang tatlong character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	true

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Uri	Paglalarawan
LANDLINE	Numero ng landline phone.
MOBILE	Numero ng mobile phone. Kwalipikado para sa HLR lookups upang makakuha ng karagdagang impormasyon tungkol sa connection status, network, portability at roaming.
MOBILE_OR_LANDLINE	Numero ng landline o mobile phone. Maaaring kwalipikado para sa HLR lookup.
TOLL_FREE	Toll free phone number.
PREMIUM_RATE	Premium rate phone number na may karagdagang singil.
SHARED_COST	Shared cost phone number. Karaniwang mas mura kaysa sa premium rate phone numbers.
VOIP	Voice over IP phone number. Kasama ang TSoIP phone numbers (Telephony Service over IP).
PAGER	Pager phone number. Karaniwang walang voice functionality.
UAN	Universal Access Number (Company Number). Maaaring i-route sa mga partikular na opisina ngunit nagbibigay-daan sa isang numero na magamit para sa kumpanya.
VOICEMAIL	Voicemail phone number.
UNKNOWN	Hindi matukoy ang uri ng numero.

Mag-scroll Pataas

POST/nt-lookups protektado

Ang endpoint na ito ay nagsasagawa ng sunod-sunod na asynchronous number type lookups na ang mga resulta ay ipapadala pabalik sa iyong server sa pamamagitan ng webhook. Angkop ito kung ang pangunahing layunin mo ay matukoy kung ang mga ibinigay na numero ng telepono ay kabilang sa landline, mobile, premium rate, VoIP, pager, o iba pang numbering plan ranges. Na-optimize para sa mabilis na pagproseso ng malalaking dami ng mga numero, ang endpoint na ito ay perpekto para sa bulk operations (hal. database sanitization). Para sa live traffic at time-critical use cases, mangyaring gamitin ang POST /nt-lookup endpoint sa halip.

Kailangan mong tukuyin ang webhook URL sa iyong API settings bilang paunang kinakailangan upang magamit ang endpoint na ito.

Request Matagumpay na Tugon Tugon sa Error Webhooks Sanggunian ng Uri

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

Payload

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`numbers`	array	Isang array ng mga numero ng telepono sa international format (hal. +14156226819 o 004989702626). Maksimum na 1000 numero ang maaaring isama bawat request.	null	kinakailangan
`route`	string(3)	Isang opsyonal na three-character identifier na tumutukoy sa route para sa lookup na ito. Itakda sa `null` o alisin ang parameter na ito upang ilapat ang iyong custom routing map o hayaan ang aming system na awtomatikong matukoy ang pinakamahusay na route para sa request na ito.	null	opsyonal
`storage`	string	Isang opsyonal na storage identifier na tumutukoy sa report kung saan maiimbak ang mga resulta para sa manual review, analytics, at reporting. Awtomatikong idinadagdag ng system ang timestamp na may kasalukuyang buwan. Kung aalisin o itatakda sa `null`, awtomatikong paggrugrupohin ng system ang mga resulta ayon sa buwan para sa reporting purposes.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`accepted`	array	Isang array ng mga object, bawat isa ay naglalaman ng unique identifier at numero ng telepono na tinanggap para sa pagproseso.	false
`accepted_count`	integer	Ang kabuuang bilang ng mga numero ng telepono na tinanggap para sa pagproseso.	false
`rejected`	array	Isang array ng mga object, bawat isa ay naglalaman ng unique identifier at numero ng telepono na tinanggihan para sa pagproseso. Karaniwan, ang mga numerong ito ay invalid, at walang singil na inilalapat.	false
`rejected_count`	integer	Ang kabuuang bilang ng mga numero ng telepono na tinanggihan para sa pagproseso.	false
`total_count`	integer	Ang kabuuang bilang ng tinanggap at tinanggihang mga numero ng telepono na isinumite para sa pagproseso.	false
`cost`	string	Isang string na kumakatawan sa decimal value na nagsasaad ng gastos sa EUR para sa mga lookup na ito.	false
`storage`	string	Ang pangalan ng storage (report) kung saan naidagdag ang mga resulta ng lookup. Ang pangalang ito ay ginagamit para sa CSV downloads at analytics sa pamamagitan ng web interface.	false
`route`	string(3)	Isang three-character identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	false
`webhook_urls`	array	Ang mga webhook URL na naka-configure sa inyong API settings. Dito ipinapadala pabalik ang mga resulta.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Pagproseso ng mga Webhook

Kapag naisumite na, magsisimulang iproseso ng aming platform ang mga ibinigay na numero ng telepono at ipapadala ang mga resulta sa webhook URL na itinakda sa inyong server. Ang mga resulta ay ipinapadala bilang HTTP POST request na may JSON object sa request body.

Pagpapatunay

I-authenticate ang webhook sa pamamagitan ng pagsusuri sa X-Signatures HTTP header.

Ang X-Signatures header ay naglalaman ng listahan ng mga signature na pinaghihiwalay ng semicolon. Ang bawat signature sa listahan ay nabuo gamit ang isa sa mga API secret na naka-configure sa inyong account. Upang i-verify ang webhook, gumawa ng SHA-256 hash gamit ang inyong API key, secret, at raw HTTP body - pagkatapos ay ihambing ito sa mga signature sa listahan.

Ang pagtutugma ay nagpapatunay na ang request ay tunay at nilagdaan gamit ang secret na inyong kontrolado.

Halimbawa ng Code

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

Ang request ay valid kung alinman sa mga signature na ibinigay sa header ay katumbas ng SHA256 hash na kinalkula mula sa pinagsama-samang string ng inyong API key, secret, at HTTP body.

Pagkumpirma ng Pagtanggap

Inaasahang tumugon ang inyong server gamit ang HTTP status code 200 OK upang kumpirmahin ang matagumpay na pagtanggap. Kung ibang response code ang maibalik, magkaroon ng timeout (10 segundo), o lumitaw ang anumang isyu sa delivery, awtomatikong susubukan ulit ng system ang webhook pagkatapos ng isang minuto. Kung patuloy na mabigo ang request, ang mga retry ay susunod sa exponential backoff strategy, na may mga susunod pang pagtatangka pagkatapos ng 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minuto.

Ang mekanismong ito ng retry ay nagsisiguro ng pinakamataas na reliability sa paghahatid ng mga resulta ng lookup sa inyong infrastructure. Binabawasan nito ang panganib ng pagkawala ng data dahil sa pansamantalang mga isyu sa network o server downtime.

Webhook Payload

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

Mga Attribute ng Webhook Payload

Ang JSON object ay naglalaman ng attribute na type => NT kasama ng attribute na results na may kasamang listahan ng mga lookup object, gaya ng nakadokumento sa ibaba.

Pangalan	Uri	Paglalarawan	Nullable
`id`	string(12)	Natatanging identifier na itinalaga sa kahilingang lookup na ito.	false
`number`	string	Ang numero ng telepono na sinuri sa panahon ng kahilingang ito sa paghahanap.	false
`number_type`	string	Ang natukoy na uri ng numero. Posibleng mga halaga ay kinabibilangan ng: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Nagpapahiwatig kung matagumpay na nakuha ang impormasyon ng uri ng numero. Nagbabalik ng `OK` kung matagumpay, o `FAILED` kung nabigo ang paghahanap.	false
`is_valid`	boolean	Nagpapahiwatig kung ang numero ng telepono ay wasto sa aspeto ng syntax.	true
`invalid_reason`	string	Isang plain text na mensahe sa Ingles na tumutukoy kung bakit ang numero ng telepono ay itinuturing na hindi wasto (hal. "too short" o "invalid prefix"), o `null` kung ang numero ay wasto.	true
`is_possibly_ported`	boolean	Nagpapahiwatig kung ang numero ng telepono ay maaaring inilipat mula sa orihinal na operator tungo sa ibang carrier. Para sa tumpak na impormasyon tungkol sa portability, gamitin ang MNP lookups.	true
`is_vanity_number`	boolean	Nagpapahiwatig kung ang numero ng telepono ay vanity number, ibig sabihin ay naglalaman ito ng mga alpabetikong karakter.	true
`qualifies_for_hlr_lookup`	boolean	Nagpapahiwatig kung ang numero ng telepono ay karapat-dapat para sa karagdagang mga query sa pamamagitan ng HLR lookups.	true
`mccmnc`	string(5\|6)	Isang limang o anim na karakter na string na kumakatawan sa MCCMNC tuple (mobile country code at mobile network code) na tumutukoy sa orihinal na network ng numero ng mobile phone.	true
`mcc`	string(3)	Isang tatlong karakter na string na kumakatawan sa MCC (mobile country code) na tumutukoy sa bansang nauugnay sa orihinal na mobile network ng numero ng telepono.	true
`mnc`	string(2\|3)	Isang dalawa o tatlong karakter na string na kumakatawan sa MNC (mobile network code) na tumutukoy sa orihinal na mobile network operator ng numero ng telepono.	true
`original_network_name`	string	Isang arbitraryong plain text string sa Ingles na tumutukoy sa pangalan ng orihinal na network operator ng sinuring numero ng mobile phone.	true
`original_country_name`	string	Isang arbitraryong plain text string sa Ingles na tumutukoy sa orihinal na bansang nauugnay sa sinuring numero ng mobile phone.	true
`original_country_code`	string(2)	Isang dalawang karakter na ISO country code na nagpapahiwatig ng orihinal na bansa ng sinuring numero ng mobile phone.	true
`regions`	array	Isang listahan ng mga string sa Ingles na madaling mabasa na tumutukoy sa heograpikal na rehiyon o mga rehiyon na nauugnay sa numerong ito ng telepono.	true
`timezones`	array	Isang listahan ng mga timezone (sa Olson format) na nauugnay sa numerong ito ng telepono.	true
`info_text`	string	Isang arbitraryong string na maaaring maglaman ng karagdagang impormasyon tungkol sa numero ng telepono.	true
`cost`	string	Isang decimal value na kinakatawan bilang string, na nagpapahiwatig ng gastos (sa EUR) ng paghahanap na ito.	true
`timestamp`	string	Isang W3C-formatted na timestamp (kasama ang time zone) na nagpapahiwatig kung kailan natapos ang paghahanap.	true
`storage`	string	Tumutukoy sa pangalan ng storage kung saan naidagdag ang mga resulta ng paghahanap. Ito ay tumutugma sa pangalan ng ulat na ginagamit para sa mga CSV download at analytics sa pamamagitan ng web interface.	true
`route`	string(3)	Isang tatlong character na identifier na tumutukoy sa route na ginamit para sa lookup request na ito.	true

Uri	Paglalarawan
LANDLINE	Numero ng landline phone.
MOBILE	Numero ng mobile phone. Kwalipikado para sa HLR lookups upang makakuha ng karagdagang impormasyon tungkol sa connection status, network, portability at roaming.
MOBILE_OR_LANDLINE	Numero ng landline o mobile phone. Maaaring kwalipikado para sa HLR lookup.
TOLL_FREE	Toll free phone number.
PREMIUM_RATE	Premium rate phone number na may karagdagang singil.
SHARED_COST	Shared cost phone number. Karaniwang mas mura kaysa sa premium rate phone numbers.
VOIP	Voice over IP phone number. Kasama ang TSoIP phone numbers (Telephony Service over IP).
PAGER	Pager phone number. Karaniwang walang voice functionality.
UAN	Universal Access Number (Company Number). Maaaring i-route sa mga partikular na opisina ngunit nagbibigay-daan sa isang numero na magamit para sa kumpanya.
VOICEMAIL	Voicemail phone number.
UNKNOWN	Hindi matukoy ang uri ng numero.

Mag-scroll Pataas

GET/routeprotektado

Kinukuha ang route na awtomatikong mapipili kapag nagsagawa ka ng HLR lookup nang hindi tinutukoy ang route parameter.

Ang awtomatikong pagpili ng route ay batay sa routing map na makukuha gamit ang GET /hlr-coverage endpoint, na pangunahing nakuha mula sa GET /routing-map. Maaari mong i-customize ang iyong routing map at magtakda ng mga custom na patakaran sa iyong mga setting ng account.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdn`	string	Ang MSISDN kung saan kukuhanin ang awtomatikong napiling impormasyon sa routing.	null	kinakailangan

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`route`	string	Ang inirerekomendang route.	false
`confidence_level`	string	Ang antas ng kumpiyansa kung saan napili ang rutang ito, i.e. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Ang numbering plan based MCCMNC para sa numerong ito.	false
`origin`	string	Ang pinagmulan kung saan nakabatay ang desisyon sa routing, i.e. `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."
    ]
}

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/routesprotektado

Ang endpoint na ito ay nagbabalik ng listahan ng mga available na HLR, MNP, at NT routes. Ang bawat route, kasama ang mga features at limitasyon nito, ay ipinaliwanag sa page ng routing details.

Request Matagumpay na Tugon Tugon sa Error

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

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`routes`	object	Isang object na may mga routes na nakagrupo ayon sa uri ng route.	false
`HLR\|MNP\|NT`	string[]	Naglalaman ng listahan ng mga route identifier.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/routing-mapprotektado

Kinukuha ang automated routing configuration na kasalukuyang inilalapat sa HLR Lookups para sa inyong account. Ang default configuration na ito ay ginagamit tuwing magsusumite kayo ng HLR lookups nang hindi tinutukoy ang route parameter. Maaari ninyong i-customize ang inyong routing map at lumikha ng custom rules sa inyong account settings.

Ang configuration hierarchy ay umaagos mula sa country-level rules tungo sa MCCMNC-level rules, at sa huli ay sa individual phone number prefix mappings. Sa praktika, nangangahulugan ito na ang individual phone number prefix mappings ay mas nangingibabaw kaysa sa magkasalungat na MCCMNC assignments, na naman ay nangingibabaw sa country-level rules. Pakitandaan na ang MNP fallback ay nangingibabaw sa anumang magkasalungat na custom rules habang naka-enable.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`default_route`	string	Ang default route na ginagamit kapag walang matukoy na preferred routing option para sa isang MSISDN at walang umiiral na custom routing rules.	false
`mnp_fallback`	boolean	Nagsasaad kung naka-enable ang MNP fallback. Kapag naka-enable at hindi sinusuportahan ng network ang HLR queries (connectivity status unavailable), magsasagawa ang system ng MNP lookup sa halip.	false
`mccmncs`	array	Isang mapping ng MCCMNC codes sa kanilang awtomatikong napiling routes. Kapag nagsasagawa ng HLR lookup para sa number sa isang partikular na MCCMNC, ginagamit ang kaukulang route.	false
`mccmnc`	string(5\|6)	Limang o anim na character na MCCMNC (kombinasyon ng mobile country code at mobile network code) na tumutukoy sa mobile network operator.	false
`countrycode`	string(2)	Dalawang character na ISO country code, na tumutukoy sa bansa ng network.	false
`route`	string(3)	Ang napiling route para sa network.	false
`mno`	string	Ang brand na nakikita ng consumer kung saan gumagana ang network na ito.	false
`confidence`	string	Ang confidence level kung saan ginawa ang pagpili. Ang posibleng values ay: HIGH, NORMAL, LOW, MNP_REDIRECT. Sa kaso ng huli, ire-redirect ng system ang traffic sa network na ito tungo sa MNP, kung naka-enable ang behavior na ito sa inyong account. Kung hindi, gagamitin ang default route sa account.	false
`origin`	string	Ang origin kung saan nakabatay ang pagpili. Ang posibleng values ay: `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	Isang listahan ng custom prefix-based routing rules na naka-configure sa inyong account, kung mayroon man.	false
`countrycode`	string(2)	Dalawang character na ISO country code, na tumutukoy sa bansa ng prefix.	false
`cns`	string	Ang prefix kung saan inilalapat ang routing rule.	false
`route`	string(3)	Ang napiling route para sa prefix.	false
`mccmnc`	string(5\|6)	Limang o anim na character na MCCMNC (kombinasyon ng mobile country code at mobile network code) na tumutukoy sa mobile network operator.	true
`mno`	string	Ang brand na nakikita ng consumer kung saan gumagana ang network na ito.	true
`countries`	array	Isang listahan ng custom country-based rules na naka-configure sa inyong account, kung mayroon man.	false
`countrycode`	string(2)	Dalawang character na ISO country code, na tumutukoy sa bansa.	false
`route`	string(3)	Ang napiling route para sa bansa.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/hlr-coverage protektado

Nagbabalik ng mga insight sa HLR coverage upang suportahan ang data-driven na pagdedesisyon. Tinutulungan ka ng endpoint na ito na pag-aralan ang real-time na mga opsyon sa HLR routing sa mga mobile network, tukuyin ang pinaka-epektibong mga landas para sa iyong target na mga rehiyon, at i-configure ang iyong automatic routing.

Ang mga inirerekomendang ruta mula sa GET /route ay batay sa coverage data na nakuha dito. Ang coverage data ay available din sa pahina ng network coverage. Maaari mong higit pang i-customize ang iyong routing map at magtakda ng mga patakaran sa iyong account settings.

Inirerekomenda naming maging pamilyar ka sa gabay na ito upang makatulong sa pag-interpret ng mga resulta.

Request Matagumpay na Tugon Tugon sa Error Sanggunian ng Status

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`countrycode`	string(2)	Isang kinakailangang dalawang-titik na ISO country code na ginagamit upang i-filter ang mga resulta, na nagbabalik lamang ng mga record na nauugnay sa tinukoy na bansa.	null	kinakailangan
`sample_size`	string	Isang optional na parameter na tumutukoy ng sample size. Ang mga posibleng halaga ay `LARGE`, `MEDIUM`, `SMALL`. Ang mas malalaking sample ay sumasaklaw ng mas mahabang timeframe, ang mas maliliit na sample ay sumasaklaw ng napakabagong timeframe.	LARGE	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`name`	string	Ang napiling pangalan ng bansa sa plain text na Ingles.	false
`countrycode`	string(2)	Ang dalawang-character na ISO country code ng napiling bansa.	false
`prefix`	string	Ang international dialing prefix ng napiling bansa.	false
`mccs`	string[]	Isang listahan ng mga MCC (mobile country code) na nauugnay sa napiling bansa.	false
`carriers`	object[]	Isang listahan ng mga carrier object na may route-specific na connectivity metrics.	false
`mno`	string	Ang pangalan ng mobile network operator sa plain text na Ingles.	false
`mccmnc`	string	Ang MCCMNC ng mobile network operator.	false
`mcc`	string	Ang MCC (mobile country code) ng mobile network operator.	false
`mnc`	string	Ang MNC (mobile network code) ng mobile network operator.	false
`routes`	object[]	Isang listahan ng route-specific na mga resulta ng connectivity.	false
`route`	string	Ang ruta kung saan naaangkop ang impormasyon ng connectivity.	false
`selected`	bool	Nagsasaad kung ito ang napiling ruta para sa automated routing.	false
`selection_confidence`	string	Ang antas ng kumpiyansa kung saan napili ang rutang ito, i.e. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Naglalaman ng null kung hindi ito ang napiling ruta.	true
`n`	int	Ang kabuuang bilang ng mga lookup sa sample na ito.	false
`CONNECTED`	int	Ang bilang ng mga HLR lookup na nagbalik ng CONNECTED status.	false
`CONNECTED_PCT`	float	Ang porsyento ng mga HLR lookup na nagbalik ng CONNECTED status.	false
`ABSENT`	int	Ang bilang ng mga HLR lookup na nagbalik ng ABSENT status.	false
`ABSENT_PCT`	float	Ang porsyento ng mga HLR lookup na nagbalik ng ABSENT status.	false
`INVALID_MSISDN`	int	Ang bilang ng mga HLR lookup na nagbalik ng INVALID_MSISDN status.	false
`INVALID_MSISDN_PCT`	float	Ang porsyento ng mga HLR lookup na nagbalik ng INVALID_MSISDN status.	false
`UNDETERMINED`	int	Ang bilang ng mga HLR lookup na nagbalik ng UNDETERMINED status.	false
`UNDETERMINED_PCT`	float	Ang porsyento ng mga HLR lookup na nagbalik ng UNDETERMINED status.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Katayuan	Paglalarawan
CONNECTED	Ang numero ay valid, at ang target na handset ay kasalukuyang nakakonekta sa mobile network. Ang mga tawag, SMS, at iba pang serbisyo ay dapat matagumpay na maabot ang tatanggap.
ABSENT	Ang numero ay valid, ngunit ang target na handset ay nakapatay o pansamantalang wala sa saklaw ng network. Ang mga mensahe o tawag ay maaaring hindi maideliver hanggang sa muling kumonekta ang device sa network.
INVALID_MSISDN	Ang numero ay invalid o hindi kasalukuyang nakatakda sa anumang subscriber sa mobile network. Ang mga tawag at mensahe sa numerong ito ay mabibigo.
UNDETERMINED	Hindi matukoy ang connectivity status ng numero. Maaaring dahil ito sa invalid na numero, SS7 error response, o kakulangan ng koneksyon sa target network operator. Suriin ang error code at ang description field nito para sa karagdagang diagnostics.

Mag-scroll Pataas

GET/mnp-coverageprotektado

Ang endpoint na ito ay nagbabalik ng listahan ng mga mobile network operator, kasama ang kanilang mga kaukulang MCCMNC identifier, na kasalukuyang sinusuportahan para sa mga mobile number portability lookup.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`countrycode`	string(2)	Opsyonal na dalawang-titik na ISO country code na ginagamit upang salain ang mga resulta ng MCCMNC, na nagbabalik lamang ng data na nauugnay sa tinukoy na bansa.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`items[]`	array	Listahan ng mga mobile network operator.	false
`country_name`	string	Ang pangalan ng bansa sa Ingles.	false
`country_code`	string(2)	Dalawang-titik na ISO country code.	false
`mccmnc`	string(5\|6)	Limang o anim na character na MCCMNC (kombinasyon ng mobile country code at mobile network code) na tumutukoy sa mobile network operator.	false
`mcc`	string(3)	Tatlong-character na MCC (mobile country code) na kumakatawan sa bansa ng network.	false
`mnc`	string(2\|3)	Dalawa o tatlong-character na MNC (mobile network code) na kumakatawan sa partikular na mobile network operator.	false
`brand`	string	Ang brand na nakikita ng consumer kung saan gumagana ang network na ito.	true
`operator`	string	Ang legal na pangalan ng mobile network operator.	true

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/price-listprotektado

Ang endpoint na ito ay nagbabalik ng listahan ng mga bansa kung saan suportado lamang ang MNP lookups, at hindi available ang HLR queries para sa mga destinasyong ito.

Request Matagumpay na Tugon Tugon sa Error

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

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`countries`	string[]	Listahan ng dalawang-character na ISO country codes.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/mccmncsprotektado

Ang endpoint na ito ay nagbabalik ng komprehensibong listahan ng mga mobile network operator kasama ang kanilang mga kaukulang MCCMNC identifier at karagdagang kontekstwal na impormasyon.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`countrycode`	string(2)	Isang opsyonal na dalawang-titik na ISO country code na ginagamit upang i-filter ang mga resulta ng MCCMNC, na nagbabalik lamang ng mga rekord na nauugnay sa tinukoy na bansa.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`items`	object[]	Listahan ng mga mobile network operator.	false
`country_name`	string	Ang buong pangalan ng bansa sa Ingles.	false
`country_code`	string(2)	Dalawang-titik na ISO country code na kumakatawan sa bansa ng mobile operator.	false
`mccmnc`	string(5\|6)	Limang- o anim-na-character na string na kumakatawan sa MCCMNC, na natatanging tumutukoy sa mobile network operator.	false
`mcc`	string(3)	Tatlong-character na Mobile Country Code (MCC) na tumutukoy sa bansang kung saan gumagana ang mobile network.	false
`mnc`	string(2\|3)	Dalawa- o tatlong-character na Mobile Network Code (MNC) na tumutukoy sa mobile network sa loob ng ibinigay na MCC.	false
`brand`	string	Ang komersyal na brand name kung saan gumagana ang network at kinikilala ng mga consumer.	true
`operator`	string	Ang opisyal na pangalan ng mobile network operator, karaniwang ang legal na entity na namamahala sa network.	true
`parent_mccmnc`	string(5\|6)	Limang- o anim-na-character na string na kumakatawan sa MCCMNC ng parent mobile network operator, kung mayroon man.	true

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/priceprotektado

Ang endpoint na ito ay nagbabalik ng presyo para sa HLR, MNP, o NT lookup.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Request Param

Key	Uri	Paglalarawan	Default	Kinakailangan
`msisdn`	string	Ang numero ng telepono kung saan kukunin ang presyo. Sa internasyonal na format.	null	kinakailangan
`route_type`	string	Ang uri ng route, i.e. `HLR`, `MNP`, `NT`.	null	kinakailangan
`route`	string(3)	Ang route kung saan kakalkulahin ang presyo. Default ay ang route na natukoy ng automated routing.	null	opsyonal

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`price`	object	Isang object na may mga detalye ng presyo.	false
`amount`	string	Ang halaga sa EUR.	false
`msisdn`	string	Ang MSISDN kung saan naaangkop ang presyong ito.	false
`route_type`	string(2\|3)	Ang uri ng route kung saan naaangkop ang presyong ito.	false
`route`	string(3)	Ang route kung saan naaangkop ang presyong ito.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/price-listprotektado

Ang endpoint na ito ay nagbabalik ng presyo sa inyong account.

Request Matagumpay na Tugon Tugon sa Error

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

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`pricing`	object[]	Listahan ng mga object na may impormasyon sa presyo.	false
`route`	string	Ang route kung saan naaangkop ang presyong ito.	false
`countrycode`	string	Ang dalawang-character na ISO countrycode kung saan naaangkop ang presyong ito para sa kaukulang route, kung mayroon.	true
`countryname`	string	Ang pangalan ng bansa sa Ingles na tumutugma sa country code, kung mayroon.	true
`mccmnc`	string	Ang MCCMNC kung saan naaangkop ang presyong ito para sa kaukulang route, kung mayroon. Pinapalitan nito ang presyo sa antas ng bansa.	true
`cns`	string	Ang dialing prefix kung saan naaangkop ang presyong ito para sa kaukulang route, kung mayroon. Pinapalitan nito ang presyo sa antas ng bansa at presyo sa antas ng MCCMNC.	true
`route_type`	string	Ang kaukulang uri ng route, i.e. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Ang kaukulang presyo sa EUR.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/balanceprotektado

Kinukuha ng endpoint na ito ang iyong kasalukuyang balanse ng account, na nagbibigay-daan sa iyo na i-automate ang mga proseso batay sa iyong credit status. Gumagana ito nang walang problema sa mga low credit notification email na maaari mong i-configure sa iyong payments page.

Request Matagumpay na Tugon Tugon sa Error

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

{
    "balance":"1002.90"
}

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`balance`	string	Ang iyong kasalukuyang balanse ng account sa EUR. Isang decimal value na may uri na string.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/pingpampubliko

Ang endpoint na ito ay nagpapadala ng ping request sa API, na nagbibigay ng simpleng paraan upang subukan ang inyong koneksyon sa HLR Lookups API.

Request Matagumpay na Tugon Tugon sa Error

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

{
    "success":true
}

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`success`	boolean	Nagpapahiwatig na ang kahilingan ay matagumpay na naproseso.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/timepampubliko

Ang endpoint na ito ay nagbabalik ng Unix timestamp na kumakatawan sa kasalukuyang oras sa HLR Lookups server. Gamitin ito upang i-synchronize ang orasan ng iyong server kapag bumubuo ng Digest-Auth signature para sa authentication, tinitiyak na anumang pagkakaiba sa pagitan ng oras ng iyong server at ng HLR Lookups server ay natutuwid.

Request Matagumpay na Tugon Tugon sa Error

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

{
    "time":1525898643
}

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`time`	integer	Unix timestamp na kumakatawan sa kasalukuyang oras ng HLR Lookups server.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

GET/auth-testprotektado

Ang endpoint na ito ay nagsisilbing paunang pagsubok para sa inyong Basic-Auth o, mas mainam, Digest-Auth na pagpapatupad.

Basic Auth Request Digest Auth Request Matagumpay na Tugon Tugon sa Error

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

Request Headers

Key	Uri	Paglalarawan
`X-Basic`	string	SHA256 hash ng `YOUR_API_KEY:YOUR_API_SECRET`. Isama ang colon symbol (:) sa 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"

Request Headers

Key	Uri	Paglalarawan
`X-Digest-Key`	string	Inyong HLR Lookups API Key
`X-Digest-Signature`	string	Natatanging Digest-Auth signature (tingnan ang authentication)
`X-Digest-Timestamp`	integer	Kasalukuyang Unix timestamp (tingnan din ang `GET /time`)

{
    "success":true
}

Mga Attribute ng Matagumpay na Tugon

Pangalan	Uri	Paglalarawan	Nullable
`success`	boolean	Nagpapahiwatig na ang kahilingan ay matagumpay na naproseso.	false

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

Mga Parameter ng Error Response

Pangalan	Uri	Paglalarawan	Nullable
`errors[]`	string[]	Listahan ng mga string na nagpapaliwanag sa error.	false

Mag-scroll Pataas

Legacy API Docs

Pakitandaan na ang legacy API ay deprecated na at nakatakdang alisin sa hinaharap. Lubos naming inirerekomenda na mag-upgrade sa pinakabagong bersyon sa lalong madaling panahon.

Kung nag-implement kayo ng aming HLR Lookups API sa pagitan ng 2013 at unang bahagi ng 2020, ginagamit ninyo ang aming legacy API. Mangyaring sumangguni sa aming legacy API documentation sa kasong ito.

Legacy API Docs

Dokumentasyon ng API

Pagsisimula

Mga HLR Lookup

Mga MNP Lookup

Mga NT Lookup

Routing

Presyo

Mga Tool

Pagsisimula

Paggamit ng HLR Lookups API

Halimbawa ng Request

Halimbawa ng Payload

Matagumpay na Tugon application/json

Karagdagang Lookup Services

Mobile Number Portability (MNP) Lookups

Number Type Detection (NT) Lookups

Software Development Kits (SDKs)

Mga Tool

Hindi Developer?

Pagpapatunay

API Key at API Secret

HTTP Basic Auth

Inirerekomenda: X-Basic Header na may SHA256

Basic Auth Request

Basic Authentication Headers

Halimbawa ng Code

Halimbawa ng Request

Request Headers

Pagbuo ng Signature

Mga Bahagi ng Digest Signature

Mga Halimbawa ng Code

Mga Konsepto

Synchronous HLR Lookup API

Asynchronous HLR Lookup API

Mga SDK (Software Development Kit)

SDK para sa PHP

SDK para sa NodeJS

SDK para sa Ruby

POST/hlr-lookupprotektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response

POST/hlr-lookupsprotektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response

Pagproseso ng mga Webhook

Pagpapatunay

Halimbawa ng Code

Pagkumpirma ng Pagtanggap

Webhook Payload

Mga Attribute ng Webhook Payload

POST/mnp-lookupprotektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response

POST/mnp-lookupsprotektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response

Pagproseso ng mga Webhook

Pagpapatunay

Halimbawa ng Code

Pagkumpirma ng Pagtanggap

Webhook Payload

Mga Attribute ng Webhook Payload

POST/nt-lookupprotektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response

POST/nt-lookups protektado

Payload

Mga Request Param

Mga Attribute ng Matagumpay na Tugon

Mga Parameter ng Error Response