शुरुआत करें

वैश्विक मोबाइल नेटवर्क इंफ्रास्ट्रक्चर SS7 सिग्नलिंग नेटवर्क के रूप में जानी जाने वाली प्रणाली पर संचालित होता है। यह नेटवर्क कैरियर्स के बीच सब्सक्राइबर डेटा के आदान-प्रदान, कॉल रूटिंग, SMS ट्रांसमिशन और रियल-टाइम मोबाइल कनेक्टिविटी स्टेटस अपडेट की सुविधा प्रदान करता है। प्रत्येक मोबाइल नेटवर्क एक होम लोकेशन रजिस्टर (HLR) बनाए रखता है - एक मुख्य डेटाबेस जो अपने सब्सक्राइबर्स के बारे में आवश्यक विवरण संग्रहीत करता है।

HLR लुकअप तकनीक व्यवसायों को इन रजिस्टरों को क्वेरी करने और किसी भी मोबाइल फोन नंबर के लिए लाइव कनेक्टिविटी और नेटवर्क विवरण प्राप्त करने में सक्षम बनाती है। इसमें यह शामिल है कि फोन चालू है या नहीं, यह वर्तमान में किस नेटवर्क को असाइन किया गया है, क्या इसे पोर्ट किया गया है, क्या नंबर वैध या निष्क्रिय है, और क्या यह रोमिंग में है।

HLR लुकअप्स API इस डेटा तक निर्बाध, रियल-टाइम एक्सेस प्रदान करता है, जिससे व्यवसाय मोबाइल नंबरों को सत्यापित कर सकते हैं, रूटिंग को अनुकूलित कर सकते हैं और ग्राहक संचार को बेहतर बना सकते हैं। यह डॉक्यूमेंटेशन आपको HLR लुकअप्स को अपने सॉफ्टवेयर में एकीकृत करने के माध्यम से मार्गदर्शन करेगा, जिससे रियल-टाइम मोबाइल इंटेलिजेंस की स्वचालित पुनर्प्राप्ति सक्षम होगी।

HLR लुकअप्स API का उपयोग

HLR लुकअप क्वेरी निष्पादित करना तेज़, सुरक्षित और सरल है। एक बार जब आप साइन अप कर लेते हैं और अपनी API Key प्राप्त कर लेते हैं, तो आप प्रमाणित कर सकते हैं और सरल HTTP POST अनुरोधों के माध्यम से POST /hlr-lookup के जरिए तत्काल लुकअप शुरू कर सकते हैं। वैकल्पिक रूप से, आप तेज़ एसिंक्रोनस API अनुरोधों का विकल्प चुनकर बड़े डेटा सेट को प्रोसेस कर सकते हैं, जिसके परिणाम webhook के माध्यम से आपके सर्वर पर वापस पोस्ट किए जाते हैं, जैसा कि अवधारणाएं अनुभाग में बताया गया है।

उदाहरण अनुरोध

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"

प्रमाणीकरण HTTP हेडर के माध्यम से प्रदान किया जाता है, और payload.json में (न्यूनतम रूप से) निम्नलिखित JSON ऑब्जेक्ट होना चाहिए:

उदाहरण पेलोड

{
   "msisdn": "+14156226819"
}

सफल निष्पादन पर, आपको निर्दिष्ट मोबाइल नंबर के लिए रियल-टाइम कनेक्टिविटी विवरण युक्त प्रतिक्रिया प्राप्त होगी।

सफलता प्रतिक्रिया 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"
}

अनुरोध और प्रतिक्रिया विशेषताओं और कनेक्टिविटी स्टेटस के पूर्ण विवरण के लिए, POST /hlr-lookup देखें।

अतिरिक्त लुकअप सेवाएं

मोबाइल नंबर पोर्टेबिलिटी (MNP) लुकअप

रियल-टाइम कनेक्टिविटी की क्वेरी किए बिना नेटवर्क स्वामित्व और पोर्टेबिलिटी विवरण निर्धारित करने के लिए MNP लुकअप का उपयोग करें। यदि आपको केवल किसी नंबर के MCCMNC की आवश्यकता है, तो POST /mnp-lookup देखें।

नंबर प्रकार पहचान (NT) लुकअप

POST /nt-lookup के साथ निर्धारित करें कि फोन नंबर लैंडलाइन, मोबाइल, प्रीमियम-रेट, VoIP, पेजर या अन्य नंबरिंग प्लान रेंज से संबंधित है या नहीं।

सॉफ्टवेयर डेवलपमेंट किट (SDK)

HLR लुकअप्स API किसी भी प्रोग्रामिंग भाषा में किसी भी REST क्लाइंट के साथ काम करता है और हमने आपको जल्दी शुरू करने में मदद के लिए अपने GitHub पर PHP, Ruby, और NodeJS के लिए SDK प्रकाशित किए हैं।

टूल्स

निर्बाध विकास अनुभव सुनिश्चित करने के लिए, हम टूल्स का एक व्यापक सूट प्रदान करते हैं, जिसमें इन-ब्राउज़र API अनुरोध और webhook मॉनिटरिंग, IP एड्रेस व्हाइटलिस्टिंग, मजबूत प्रमाणीकरण विकल्प, और एक प्रमाणीकरण टेस्ट एंडपॉइंट शामिल हैं।

डेवलपर नहीं हैं?

HLR लुकअप और नंबर पोर्टेबिलिटी क्वेरी बिना किसी कोडिंग के की जा सकती हैं। हमारे एंटरप्राइज़ वेब क्लाइंट और ब्राउज़र-आधारित रिपोर्टिंग सुविधाओं के बारे में अधिक जानें।

प्रमाणीकरण

सुरक्षा और उचित एक्सेस नियंत्रण सुनिश्चित करने के लिए, HLR Lookups API के अधिकांश अनुरोधों में प्रमाणीकरण आवश्यक है। एंडपॉइंट्स को सार्वजनिक या सुरक्षित के रूप में वर्गीकृत किया गया है। सुरक्षित एंडपॉइंट तक पहुंचने के लिए, आपके अनुरोध को Digest-Auth या Basic-Auth विधि के माध्यम से अपनी API key और secret का उपयोग करके प्रमाणित किया जाना चाहिए। Digest-Auth अधिक सुरक्षित विकल्प है और इसकी दृढ़ता से अनुशंसा की जाती है। अपने प्रमाणीकरण सेटअप को सत्यापित करने के लिए GET /auth-test एंडपॉइंट का उपयोग करें।

API Key और API Secret

API सेटिंग्स पेज से अपनी API key और secret प्राप्त करें। आप अपनी पसंदीदा प्रमाणीकरण विधि को कॉन्फ़िगर कर सकते हैं और बेहतर सुरक्षा के लिए IP address whitelisting सक्षम कर सकते हैं। यदि आपको संदेह है कि आपकी API secret से छेड़छाड़ की गई है, तो आप किसी भी समय एक नई secret जनरेट कर सकते हैं।

Basic Auth Digest Auth IP व्हाइटलिस्टिंग

Standard Basic Authentication लागू करना आसान है और व्यापक रूप से समर्थित है। आप HTTP अनुरोध में अपनी API key और secret को user:pass जोड़ी के रूप में पास करके प्रमाणित कर सकते हैं।

HTTP Basic Auth

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

यह एक Authorization हेडर भेजता है:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

अनुशंसित: SHA256 के साथ X-Basic हेडर

बेहतर सुरक्षा के लिए, आप अपने क्रेडेंशियल्स को सीधे base64 के रूप में प्रसारित करने के बजाय उनका SHA256 hash भेज सकते हैं। इस विधि का उपयोग करने के लिए, अपनी YOUR_API_KEY:YOUR_API_SECRET जोड़ी का hash कंप्यूट करें और इसे X-Basic हेडर के माध्यम से भेजें:

Basic Auth अनुरोध

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

Basic Authentication हेडर्स

Key	प्रकार	विवरण
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` का SHA256 hash। hash में कोलन चिह्न (:) शामिल करें।	अनिवार्य

कोड उदाहरण

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

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

Digest-Auth सुरक्षित HLR Lookup API एंडपॉइंट्स तक पहुंच सुरक्षित करने के लिए अनुशंसित विधि है। प्रत्येक अनुरोध में निम्नलिखित हेडर्स शामिल होने चाहिए: X-Digest-Key, X-Digest-Signature, और X-Digest-Timestamp, जिनकी व्याख्या नीचे की गई है।

अनुरोध उदाहरण

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"

अनुरोध हेडर्स

Key	प्रकार	विवरण
`X-Digest-Key`	string	आपकी विशिष्ट HLR Lookups API Key।	अनिवार्य
`X-Digest-Signature`	string	एक विशिष्ट प्रमाणीकरण signature (नीचे देखें)।	अनिवार्य
`X-Digest-Timestamp`	integer	वर्तमान Unix timestamp (`GET /time` भी देखें)।	अनिवार्य

Signature का निर्माण

X-Digest-Signature को SHA256 HMAC hash का उपयोग करके बनाया जाता है, जिसमें आपकी API secret को shared key के रूप में उपयोग किया जाता है।

hash के लिए string इस प्रकार संरचित है:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. चिह्न string concatenation को दर्शाता है।

Digest Signature घटक

घटक	प्रकार	विवरण
`ENDPOINT_PATH`	string	अनुरोधित API एंडपॉइंट, उदाहरण के लिए, `/auth-test` lowercase में।
`UNIX_TIMESTAMP`	integer	वर्तमान Unix timestamp (30 सेकंड के भीतर होना चाहिए)। `GET /time` देखें।
`REQUEST_METHOD`	string	उपयोग की गई HTTP विधि, उदाहरण के लिए, `POST` या `GET`।
`REQUEST_BODY`	string	अनुरोध body डेटा। `GET` अनुरोधों के लिए `null` पर सेट करें।

कोड उदाहरण

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)

ऊपर स्क्रॉल करें

अवधारणाएं

हमारे HTTP REST API के माध्यम से किसी भी प्रोग्रामिंग भाषा या सिस्टम में HLR लुकअप को लागू करना सरल और कुशल है। एक सरल एकीकरण प्रक्रिया के साथ, आप फ़ोन नंबर की वैधता, कनेक्टिविटी स्थिति और रूटिंग विवरण की तत्काल जानकारी के लिए रीयल-टाइम में मोबाइल नेटवर्क से क्वेरी करना शुरू कर सकते हैं।

उपयुक्त API का चयन आपके विशिष्ट उपयोग के मामले पर निर्भर करता है। यदि आपको VoIP टेलीफोनी, धोखाधड़ी का पता लगाना या SMS रूटिंग जैसे एप्लिकेशन के लिए रीयल-टाइम लुकअप परिणामों की आवश्यकता है, तो सिंक्रोनस API सबसे अच्छा विकल्प है। हालांकि, यदि आपके उपयोग के मामले में उच्च-वॉल्यूम प्रोसेसिंग, बल्क लुकअप या बड़े पैमाने पर डेटा सत्यापन शामिल है, तो एसिंक्रोनस API बैंडविड्थ दक्षता और बैच लुकअप क्षमताओं के साथ अनुकूलित प्रदर्शन प्रदान करता है।

गति, सटीकता और लागत-प्रभावशीलता को अनुकूलित करने के लिए API को हमारे कस्टम रूटिंग विकल्पों में से एक का उपयोग करने के लिए कॉन्फ़िगर करें। आप आसान CSV और JSON रिपोर्ट डाउनलोड के साथ-साथ वेब इंटरफ़ेस के माध्यम से उन्नत विश्लेषण के लिए लुकअप परिणामों को स्टोरेज में भी संग्रहीत कर सकते हैं।

सिंक्रोनस HLR लुकअप API

POST /hlr-lookup एंडपॉइंट प्रति अनुरोध एक मोबाइल फ़ोन नंबर (MSISDN) को प्रोसेस करता है और HTTP रिस्पांस बॉडी में तुरंत परिणाम लौटाता है। परिणाम JSON के रूप में फ़ॉर्मेट किए जाते हैं और मोबाइल नंबर सत्यापन, कॉल रूटिंग और SMS संदेश वितरण सहित रीयल-टाइम एप्लिकेशन के लिए आदर्श हैं।

एक सिंक्रोनस API कॉल में एक सीधा HTTP अनुरोध और प्रतिक्रिया शामिल होती है। आपका सिस्टम प्रति अनुरोध एक MSISDN (मोबाइल नंबर) सबमिट करता है और JSON फ़ॉर्मेट में रीयल-टाइम HLR लुकअप परिणाम युक्त तत्काल प्रतिक्रिया प्राप्त करता है। यह API उन उपयोग के मामलों के लिए अनुकूलित है जिनमें तत्काल सत्यापन और कनेक्टिविटी जांच की आवश्यकता होती है, जैसे धोखाधड़ी का पता लगाना, VoIP कॉल रूटिंग और SMS गेटवे अनुकूलन।

एसिंक्रोनस HLR लुकअप API

POST /hlr-lookups एंडपॉइंट बल्क और उच्च-वॉल्यूम प्रोसेसिंग के लिए डिज़ाइन किया गया है, जो आपको प्रति अनुरोध 1,000 तक MSISDN सबमिट करने की अनुमति देता है। तुरंत परिणाम लौटाने के बजाय, यह API आपके सर्वर पर क्रमिक रूप से परिणाम भेजने के लिए स्वचालित वेबहुक का उपयोग करता है। लुकअप परिणाम HTTP POST कॉलबैक के माध्यम से JSON ऑब्जेक्ट के रूप में लौटाए जाते हैं।

एसिंक्रोनस API गति, दक्षता और स्केलेबिलिटी के लिए अनुकूलित है। यह सिंक्रोनस कॉल से जुड़ी नेटवर्क लेटेंसी समस्याओं को समाप्त करता है, जिससे यह उच्च-थ्रूपुट लुकअप की आवश्यकता वाले व्यवसायों के लिए आदर्श बन जाता है। आपका सिस्टम प्रति अनुरोध 1,000 तक MSISDN सबमिट करता है, और हमारा प्लेटफ़ॉर्म उन्हें समानांतर में प्रोसेस करता है, प्रति कॉलबैक 1,000 तक परिणामों के बैच में HTTP वेबहुक के माध्यम से आपके सर्वर पर परिणाम वापस भेजता है।

SDK (सॉफ्टवेयर डेवलपमेंट किट)

PHP, NodeJS और Ruby के लिए हमारे सॉफ्टवेयर डेवलपमेंट किट (SDK) एकीकरण प्रक्रिया को सरल बनाते हैं, जिससे आप HLR Lookups API के साथ कुशलतापूर्वक और न्यूनतम प्रयास से कनेक्ट कर सकते हैं।

ये SDK पूर्व-निर्मित फ़ंक्शन, प्रमाणीकरण प्रबंधन और संरचित API अनुरोध टेम्पलेट प्रदान करते हैं, जो विकास समय को कम करते हैं और सर्वोत्तम प्रथाओं को सुनिश्चित करते हैं।

GitHub पर उपलब्ध SDK की हमारी पूरी सूची देखें और आज ही एकीकरण शुरू करें।

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

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   }

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)

GitHub पर देखें README.md

ऊपर स्क्रॉल करें

POST/hlr-lookupसुरक्षित

एक सिंक्रोनस HLR लुकअप करता है, जो नेटवर्क ऑपरेटरों से सीधे रियल-टाइम मोबाइल फोन कनेक्टिविटी और पोर्टेबिलिटी डेटा प्रदान करता है। यह एंडपॉइंट लाइव ट्रैफिक परिदृश्यों के लिए आदर्श है जहां समय-संवेदनशील एप्लिकेशनों को तत्काल सत्यापन की आवश्यकता होती है कि कोई फोन नंबर वर्तमान में पहुंच योग्य (कनेक्टेड) है या अनुपलब्ध (बंद) है। इसके अतिरिक्त, यह सक्रिय नंबरों को अमान्य, अज्ञात या नकली नंबरों से अलग करने में मदद करता है।

बड़े डेटासेट की बल्क प्रोसेसिंग के लिए जिन्हें तत्काल परिणामों की आवश्यकता नहीं है, एसिंक्रोनस POST /hlr-lookups का उपयोग करने पर विचार करें, जो हाई-स्पीड बैच प्रोसेसिंग के लिए अनुकूलित है।

यदि आपका प्राथमिक फोकस मोबाइल नंबर पोर्टेबिलिटी डेटा (MCCMNC) प्राप्त करना है और आपको लाइव कनेक्टिविटी स्टेटस की आवश्यकता नहीं है, तो POST /mnp-lookup मोबाइल नंबर पोर्टेबिलिटी क्वेरी के लिए एक लागत-प्रभावी विकल्प प्रदान करता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया स्टेटस संदर्भ

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdn`	string	क्वेरी किए जाने वाला मोबाइल फोन नंबर (MSISDN), अंतर्राष्ट्रीय प्रारूप में प्रदान किया गया (जैसे, +14156226819 या 0014156226819)। देश कोड शामिल होना आवश्यक है।	null	अनिवार्य
`route`	string(3)	एक वैकल्पिक तीन-वर्ण पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें या हमारे सिस्टम को इस लुकअप के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप अनुरोध को सौंपा गया एक विशिष्ट पहचानकर्ता।	false
`msisdn`	string	जिस मोबाइल फोन नंबर की जांच की जा रही है, वह अंतर्राष्ट्रीय प्रारूप में स्वरूपित है (जैसे, +14156226819 या 0014156226819)।	false
`connectivity_status`	string	यह दर्शाता है कि नंबर की कनेक्टिविटी स्थिति सफलतापूर्वक प्राप्त हुई या नहीं। संभावित मान: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , या `UNDETERMINED` ।	false
`mccmnc`	string(5\|6)	पांच या छह अंकों का मोबाइल कंट्री कोड (MCC) और मोबाइल नेटवर्क कोड (MNC) जो वर्तमान में फोन नंबर से जुड़े नेटवर्क की पहचान करता है।	true
`mcc`	string(3)	तीन अंकों का मोबाइल कंट्री कोड (MCC) जो उस देश की पहचान करता है जहां फोन नंबर पंजीकृत है।	true
`mnc`	string(2\|3)	दो या तीन अंकों का मोबाइल नेटवर्क कोड (MNC) जो उस विशिष्ट नेटवर्क की पहचान करता है जिससे फोन नंबर संबंधित है।	true
`imsi`	string	इंटरनेशनल मोबाइल सब्सक्राइबर आइडेंटिटी (IMSI), इस नंबर से जुड़े SIM कार्ड के लिए एक विशिष्ट पहचानकर्ता। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`msin`	string(10)	मोबाइल ऑपरेटर के डेटाबेस में मोबाइल सब्सक्रिप्शन आइडेंटिफिकेशन नंबर (MSIN)। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`msc`	string(12)	मोबाइल स्विचिंग सेंटर (MSC) जो वर्तमान में इस ग्राहक के संचार को संभाल रहा है। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`original_network_name`	string	इस नंबर से जुड़े मूल (नेटिव) नेटवर्क ऑपरेटर का नाम।	true
`original_country_name`	string	उस देश का पूरा नाम जहां मोबाइल फोन नंबर मूल रूप से पंजीकृत था, अंग्रेजी में प्रदान किया गया।	true
`original_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो उस देश का प्रतिनिधित्व करता है जहां फोन नंबर पहली बार आवंटित किया गया था।	true
`original_country_prefix`	string	अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जो मोबाइल फोन नंबर के मूल देश से संबंधित है।	true
`is_ported`	boolean	यह दर्शाता है कि मोबाइल नंबर को उसके मूल नेटवर्क से किसी अन्य ऑपरेटर में पोर्ट किया गया है या नहीं।	true
`ported_network_name`	string	नेटवर्क ऑपरेटर का नाम जिसमें मोबाइल नंबर को पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_name`	string	उस देश का नाम जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`ported_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो उस देश का प्रतिनिधित्व करता है जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`ported_country_prefix`	string	उस देश के लिए अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`is_roaming`	boolean	यह दर्शाता है कि मोबाइल नंबर वर्तमान में किसी विदेशी नेटवर्क पर रोमिंग कर रहा है या नहीं। रोमिंग स्थिति की उपलब्धता मोबाइल नेटवर्क ऑपरेटर पर निर्भर करती है।	true
`roaming_network_name`	string	उस नेटवर्क का नाम जिस पर मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_name`	string	उस देश का नाम जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_code`	string(2)	उस देश का दो-अक्षर का ISO देश कोड जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_prefix`	string	उस देश का अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`cost`	string	एक स्ट्रिंग के रूप में प्रस्तुत दशमलव मान, जो EUR में लुकअप लागत को दर्शाता है।	true
`timestamp`	string	टाइम ज़ोन सहित W3C-स्वरूपित टाइमस्टैम्प, जो यह निर्दिष्ट करता है कि लुकअप कब पूरा हुआ।	true
`storage`	string	स्टोरेज का नाम जहां लुकअप परिणाम सहेजे गए थे। यह वेब इंटरफेस के माध्यम से उपलब्ध रिपोर्ट नामों और CSV डाउनलोड से मेल खाता है।	true
`route`	string(3)	तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग की गई रूटिंग विधि को दर्शाता है।	true
`processing_status`	string	लुकअप का प्रोसेसिंग परिणाम। संभावित मान: `COMPLETED` (सफल), `REJECTED` (नेटवर्क अप्राप्य, कोई शुल्क लागू नहीं), या `FAILED` (प्रोसेसिंग के दौरान त्रुटि हुई)।	false
`error_code`	integer	ग्राहक सहायता के लिए अतिरिक्त डायग्नोस्टिक जानकारी प्रदान करने वाला एक वैकल्पिक आंतरिक त्रुटि कोड।	true
`error_description`	string	दिए गए त्रुटि कोड (यदि कोई हो) की अंग्रेजी सादे पाठ में संक्षिप्त व्याख्या।	true
`data_source`	string	इस अनुरोध के लिए उपयोग किया गया डेटा स्रोत। संभावित मान: `LIVE_HLR` (रियल-टाइम HLR क्वेरी) या `MNP_DB` (स्थिर मोबाइल नंबर पोर्टेबिलिटी डेटाबेस)। विवरण के लिए रूटिंग विकल्प देखें।	false
`routing_instruction`	string	अनुरोध में उपयोग किए गए रूटिंग निर्देश का वर्णन करने वाली कोलन-सीमांकित स्ट्रिंग। पहला घटक `STATIC` है जब आपने एक रूट निर्दिष्ट किया हो या स्वचालित रूटिंग के लिए `AUTO`; दूसरा घटक रूट पहचानकर्ता है, और स्वचालित रूटिंग अनुरोधों के लिए तीसरा घटक वह मूल दिखाता है जिस पर रूटिंग निर्णय आधारित है (अर्थात `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."
    ]
}

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

स्थिति	विवरण
CONNECTED	नंबर मान्य है, और लक्ष्य हैंडसेट वर्तमान में मोबाइल नेटवर्क से जुड़ा हुआ है। कॉल, SMS और अन्य सेवाएं प्राप्तकर्ता तक सफलतापूर्वक पहुंचनी चाहिए।
ABSENT	नंबर मान्य है, लेकिन लक्ष्य हैंडसेट या तो बंद है या अस्थायी रूप से नेटवर्क कवरेज से बाहर है। संदेश या कॉल तब तक नहीं पहुंच सकते जब तक डिवाइस नेटवर्क से पुनः कनेक्ट नहीं हो जाता।
INVALID_MSISDN	नंबर अमान्य है या वर्तमान में मोबाइल नेटवर्क पर किसी ग्राहक को आवंटित नहीं है। इस नंबर पर कॉल और संदेश विफल हो जाएंगे।
UNDETERMINED	नंबर की कनेक्टिविटी स्थिति निर्धारित नहीं की जा सकी। यह अमान्य नंबर, SS7 त्रुटि प्रतिक्रिया, या लक्ष्य नेटवर्क ऑपरेटर के साथ कनेक्टिविटी की कमी के कारण हो सकता है। अतिरिक्त निदान के लिए त्रुटि कोड और इसके विवरण फ़ील्ड की जांच करें।

ऊपर स्क्रॉल करें

POST/hlr-lookupsसुरक्षित

असिंक्रोनस HLR लुकअप का एक बैच शुरू करता है, जो नेटवर्क ऑपरेटरों से लाइव मोबाइल फोन कनेक्टिविटी और पोर्टेबिलिटी डेटा प्राप्त करता है। परिणाम वेबहुक के माध्यम से आपके सर्वर पर डिलीवर किए जाते हैं। यह विधि बड़ी संख्या में नंबरों को प्रोसेस करने के लिए अनुकूलित है जिन्हें तत्काल प्रतिक्रिया की आवश्यकता नहीं होती, जैसे डेटाबेस क्लीनिंग और सत्यापन। कॉल रूटिंग या SMS डिलीवरी जैसे रियल-टाइम एप्लिकेशन के लिए, इसके बजाय POST /hlr-lookup एंडपॉइंट का उपयोग करने पर विचार करें।

यह एंडपॉइंट बल्क प्रोसेसिंग के लिए आदर्श है जब लक्ष्य उन फोन नंबरों की पहचान करना है जो वर्तमान में पहुंच योग्य (कनेक्टेड) हैं या अनुपलब्ध हैं (फोन बंद है) जबकि अमान्य, असाइन न किए गए या नकली नंबरों को फ़िल्टर किया जाता है। इसके अतिरिक्त, यह कनेक्टिविटी विवरण के साथ लाइव पोर्टेबिलिटी स्टेटस (MCCMNC) प्रदान करता है।

इस एंडपॉइंट का उपयोग करने से पहले, सुनिश्चित करें कि असिंक्रोनस रूप से लुकअप परिणाम प्राप्त करने के लिए एक वेबहुक URL कॉन्फ़िगर किया गया है। आप इसे अपनी API सेटिंग्स में सेट कर सकते हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया वेबहुक्स स्टेटस संदर्भ

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdns`	array	अंतर्राष्ट्रीय प्रारूप में मोबाइल फोन नंबरों (MSISDNs) की एक सरणी (जैसे +14156226819 या 0014156226819)। आप प्रति अनुरोध 1000 नंबर तक शामिल कर सकते हैं।	null	अनिवार्य
`route`	string(3)	एक वैकल्पिक तीन-वर्ण पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें या हमारे सिस्टम को इस लुकअप के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`accepted`	array	प्रोसेसिंग के लिए स्वीकृत विशिष्ट पहचानकर्ताओं और MSISDNs वाली ऑब्जेक्ट्स की एक सूची।	false
`accepted_count`	integer	प्रोसेसिंग के लिए सफलतापूर्वक स्वीकृत MSISDNs की कुल संख्या।	false
`rejected`	array	प्रोसेसिंग के लिए अस्वीकृत विशिष्ट पहचानकर्ताओं और MSISDNs वाली ऑब्जेक्ट्स की एक सूची, आमतौर पर अमान्य नंबरों के कारण। अस्वीकृत प्रविष्टियों के लिए कोई शुल्क लागू नहीं होता।	false
`rejected_count`	integer	सत्यापन त्रुटियों के कारण अस्वीकृत MSISDNs की कुल संख्या।	false
`total_count`	integer	प्रोसेसिंग के लिए सबमिट किए गए स्वीकृत और अस्वीकृत MSISDNs की कुल गणना।	false
`cost`	string	एक स्ट्रिंग के रूप में दर्शाया गया दशमलव मान, जो स्वीकृत लुकअप के लिए EUR में कुल लागत को दर्शाता है।	false
`storage`	string	स्टोरेज का नाम जहां लुकअप परिणाम जोड़े जाते हैं, वेब इंटरफ़ेस के माध्यम से रिपोर्टिंग और CSV डाउनलोड के लिए उपयोग किया जाता है।	false
`route`	string(3\|4)	तीन या चार वर्ण का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है। यदि नंबर-आधारित स्वचालित रूटिंग का अनुरोध किया गया था तो AUTO शामिल होता है।	false
`webhook_urls`	array	आपकी API सेटिंग्स में कॉन्फ़िगर किए गए वेबहुक URLs। परिणाम यहां वापस पोस्ट किए जाते हैं।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

वेबहुक प्रोसेसिंग

सबमिट करने के बाद, हमारा प्लेटफ़ॉर्म प्रदान किए गए फ़ोन नंबरों को प्रोसेस करना शुरू करता है और परिणामों को आपके सर्वर पर पहले से निर्दिष्ट वेबहुक URL पर भेजता है। परिणाम HTTP POST अनुरोध के रूप में रिक्वेस्ट बॉडी में JSON ऑब्जेक्ट के साथ ट्रांसमिट किए जाते हैं।

प्रमाणीकरण

X-Signatures HTTP हेडर की जांच करके वेबहुक को प्रमाणित करें।

X-Signatures हेडर में सेमीकोलन से अलग किए गए सिग्नेचर की सूची होती है। सूची में प्रत्येक सिग्नेचर आपके अकाउंट में कॉन्फ़िगर किए गए API सीक्रेट में से एक का उपयोग करके जेनरेट किया जाता है। वेबहुक को वेरिफ़ाई करने के लिए, अपनी API की, सीक्रेट और रॉ HTTP बॉडी का उपयोग करके SHA-256 हैश जेनरेट करें - फिर इसे सूची में दिए गए सिग्नेचर से तुलना करें।

मिलान की पुष्टि करता है कि अनुरोध प्रामाणिक है और आपके नियंत्रण वाले सीक्रेट से साइन किया गया है।

कोड उदाहरण

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

अनुरोध वैध है यदि हेडर में दिए गए किसी भी सिग्नेचर का मिलान आपकी API की, सीक्रेट और HTTP बॉडी की संयुक्त स्ट्रिंग पर कंप्यूट किए गए SHA256 हैश से होता है।

प्राप्ति की पुष्टि

आपके सर्वर से सफल प्राप्ति की पुष्टि के लिए HTTP स्टेटस कोड 200 OK के साथ रिस्पॉन्ड करने की अपेक्षा की जाती है। यदि कोई अन्य रिस्पॉन्स कोड रिटर्न किया जाता है, टाइमआउट होता है (10 सेकंड), या कोई अन्य डिलीवरी समस्या उत्पन्न होती है, तो सिस्टम एक मिनट के बाद स्वचालित रूप से वेबहुक को पुनः प्रयास करेगा। यदि अनुरोध विफल होता रहता है, तो पुनः प्रयास एक्सपोनेंशियल बैकऑफ़ रणनीति का पालन करेंगे, जिसमें बाद के प्रयास 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 मिनट के बाद होंगे।

यह पुनः प्रयास तंत्र आपके इंफ्रास्ट्रक्चर को लुकअप परिणाम डिलीवर करने में अधिकतम विश्वसनीयता सुनिश्चित करता है। यह अस्थायी नेटवर्क समस्याओं या सर्वर डाउनटाइम के कारण डेटा हानि के जोखिम को कम करता है।

वेबहुक पेलोड

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

वेबहुक पेलोड विशेषताएं

JSON ऑब्जेक्ट में type => HLR विशेषता के साथ results विशेषता शामिल है जिसमें लुकअप ऑब्जेक्ट्स की एक सूची होती है, जैसा कि नीचे दस्तावेजीकृत है।

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप अनुरोध को सौंपा गया एक विशिष्ट पहचानकर्ता।	false
`msisdn`	string	जिस मोबाइल फोन नंबर की जांच की जा रही है, वह अंतर्राष्ट्रीय प्रारूप में स्वरूपित है (जैसे, +14156226819 या 0014156226819)।	false
`connectivity_status`	string	यह दर्शाता है कि नंबर की कनेक्टिविटी स्थिति सफलतापूर्वक प्राप्त हुई या नहीं। संभावित मान: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` , या `UNDETERMINED` ।	false
`mccmnc`	string(5\|6)	पांच या छह अंकों का मोबाइल कंट्री कोड (MCC) और मोबाइल नेटवर्क कोड (MNC) जो वर्तमान में फोन नंबर से जुड़े नेटवर्क की पहचान करता है।	true
`mcc`	string(3)	तीन अंकों का मोबाइल कंट्री कोड (MCC) जो उस देश की पहचान करता है जहां फोन नंबर पंजीकृत है।	true
`mnc`	string(2\|3)	दो या तीन अंकों का मोबाइल नेटवर्क कोड (MNC) जो उस विशिष्ट नेटवर्क की पहचान करता है जिससे फोन नंबर संबंधित है।	true
`imsi`	string	इंटरनेशनल मोबाइल सब्सक्राइबर आइडेंटिटी (IMSI), इस नंबर से जुड़े SIM कार्ड के लिए एक विशिष्ट पहचानकर्ता। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`msin`	string(10)	मोबाइल ऑपरेटर के डेटाबेस में मोबाइल सब्सक्रिप्शन आइडेंटिफिकेशन नंबर (MSIN)। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`msc`	string(12)	मोबाइल स्विचिंग सेंटर (MSC) जो वर्तमान में इस ग्राहक के संचार को संभाल रहा है। उपलब्धता नेटवर्क कॉन्फ़िगरेशन पर निर्भर करती है।	true
`original_network_name`	string	इस नंबर से जुड़े मूल (नेटिव) नेटवर्क ऑपरेटर का नाम।	true
`original_country_name`	string	उस देश का पूरा नाम जहां मोबाइल फोन नंबर मूल रूप से पंजीकृत था, अंग्रेजी में प्रदान किया गया।	true
`original_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो उस देश का प्रतिनिधित्व करता है जहां फोन नंबर पहली बार आवंटित किया गया था।	true
`original_country_prefix`	string	अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जो मोबाइल फोन नंबर के मूल देश से संबंधित है।	true
`is_ported`	boolean	यह दर्शाता है कि मोबाइल नंबर को उसके मूल नेटवर्क से किसी अन्य ऑपरेटर में पोर्ट किया गया है या नहीं।	true
`ported_network_name`	string	नेटवर्क ऑपरेटर का नाम जिसमें मोबाइल नंबर को पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_name`	string	उस देश का नाम जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`ported_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो उस देश का प्रतिनिधित्व करता है जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`ported_country_prefix`	string	उस देश के लिए अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जहां मोबाइल नंबर को पोर्ट किया गया था, यदि लागू हो।	true
`is_roaming`	boolean	यह दर्शाता है कि मोबाइल नंबर वर्तमान में किसी विदेशी नेटवर्क पर रोमिंग कर रहा है या नहीं। रोमिंग स्थिति की उपलब्धता मोबाइल नेटवर्क ऑपरेटर पर निर्भर करती है।	true
`roaming_network_name`	string	उस नेटवर्क का नाम जिस पर मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_name`	string	उस देश का नाम जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_code`	string(2)	उस देश का दो-अक्षर का ISO देश कोड जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`roaming_country_prefix`	string	उस देश का अंतर्राष्ट्रीय डायलिंग कोड (देश कॉलिंग कोड) जहां मोबाइल नंबर वर्तमान में रोमिंग कर रहा है, यदि लागू हो।	true
`cost`	string	एक स्ट्रिंग के रूप में प्रस्तुत दशमलव मान, जो EUR में लुकअप लागत को दर्शाता है।	true
`timestamp`	string	टाइम ज़ोन सहित W3C-स्वरूपित टाइमस्टैम्प, जो यह निर्दिष्ट करता है कि लुकअप कब पूरा हुआ।	true
`storage`	string	स्टोरेज का नाम जहां लुकअप परिणाम सहेजे गए थे। यह वेब इंटरफेस के माध्यम से उपलब्ध रिपोर्ट नामों और CSV डाउनलोड से मेल खाता है।	true
`route`	string(3)	तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग की गई रूटिंग विधि को दर्शाता है।	true
`processing_status`	string	लुकअप का प्रोसेसिंग परिणाम। संभावित मान: `COMPLETED` (सफल), `REJECTED` (नेटवर्क अप्राप्य, कोई शुल्क लागू नहीं), या `FAILED` (प्रोसेसिंग के दौरान त्रुटि हुई)।	false
`error_code`	integer	ग्राहक सहायता के लिए अतिरिक्त डायग्नोस्टिक जानकारी प्रदान करने वाला एक वैकल्पिक आंतरिक त्रुटि कोड।	true
`error_description`	string	दिए गए त्रुटि कोड (यदि कोई हो) की अंग्रेजी सादे पाठ में संक्षिप्त व्याख्या।	true
`data_source`	string	इस अनुरोध के लिए उपयोग किया गया डेटा स्रोत। संभावित मान: `LIVE_HLR` (रियल-टाइम HLR क्वेरी) या `MNP_DB` (स्थिर मोबाइल नंबर पोर्टेबिलिटी डेटाबेस)। विवरण के लिए रूटिंग विकल्प देखें।	false
`routing_instruction`	string	अनुरोध में उपयोग किए गए रूटिंग निर्देश का वर्णन करने वाली कोलन-सीमांकित स्ट्रिंग। पहला घटक `STATIC` है जब आपने एक रूट निर्दिष्ट किया हो या स्वचालित रूटिंग के लिए `AUTO`; दूसरा घटक रूट पहचानकर्ता है, और स्वचालित रूटिंग अनुरोधों के लिए तीसरा घटक वह मूल दिखाता है जिस पर रूटिंग निर्णय आधारित है (अर्थात `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

स्थिति	विवरण
CONNECTED	नंबर मान्य है, और लक्ष्य हैंडसेट वर्तमान में मोबाइल नेटवर्क से जुड़ा हुआ है। कॉल, SMS और अन्य सेवाएं प्राप्तकर्ता तक सफलतापूर्वक पहुंचनी चाहिए।
ABSENT	नंबर मान्य है, लेकिन लक्ष्य हैंडसेट या तो बंद है या अस्थायी रूप से नेटवर्क कवरेज से बाहर है। संदेश या कॉल तब तक नहीं पहुंच सकते जब तक डिवाइस नेटवर्क से पुनः कनेक्ट नहीं हो जाता।
INVALID_MSISDN	नंबर अमान्य है या वर्तमान में मोबाइल नेटवर्क पर किसी ग्राहक को आवंटित नहीं है। इस नंबर पर कॉल और संदेश विफल हो जाएंगे।
UNDETERMINED	नंबर की कनेक्टिविटी स्थिति निर्धारित नहीं की जा सकी। यह अमान्य नंबर, SS7 त्रुटि प्रतिक्रिया, या लक्ष्य नेटवर्क ऑपरेटर के साथ कनेक्टिविटी की कमी के कारण हो सकता है। अतिरिक्त निदान के लिए त्रुटि कोड और इसके विवरण फ़ील्ड की जांच करें।

ऊपर स्क्रॉल करें

POST/mnp-lookupसुरक्षित

एक समकालिक MNP लुकअप को आमंत्रित करता है और मोबाइल नंबर पोर्टेबिलिटी तथा नेटवर्क जानकारी प्रदान करता है। यह एंडपॉइंट उपयुक्त है यदि आपका प्राथमिक लक्ष्य किसी दिए गए मोबाइल फोन नंबर का वर्तमान MCCMNC निकालना और मूल तथा वर्तमान नेटवर्क को रीयल-टाइम में पहचानना है।

बड़े डेटासेट की बल्क प्रोसेसिंग के लिए जिन्हें तत्काल परिणामों की आवश्यकता नहीं है, एसिंक्रोनस POST /mnp-lookups का उपयोग करने पर विचार करें, जो हाई-स्पीड बैच प्रोसेसिंग के लिए अनुकूलित है।

MNP क्वेरी विश्वसनीय रूप से पोर्टेबिलिटी और नेटवर्क जानकारी निर्धारित करती हैं लेकिन यह संकेत नहीं देती हैं कि लक्षित मोबाइल फोन वर्तमान में किसी नेटवर्क से जुड़ा है और पहुंच योग्य है या नहीं। लाइव कनेक्टिविटी जानकारी निकालने के लिए, कृपया POST /hlr-lookup एंडपॉइंट का उपयोग करें।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdn`	string	क्वेरी किए जाने वाला मोबाइल फोन नंबर (MSISDN), अंतर्राष्ट्रीय प्रारूप में प्रदान किया गया (जैसे, +14156226819 या 0014156226819)। देश कोड शामिल होना आवश्यक है।	null	अनिवार्य
`route`	string(3)	एक वैकल्पिक तीन-वर्ण पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें या हमारे सिस्टम को इस लुकअप के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप के लिए एक विशिष्ट 12-अक्षर का पहचानकर्ता।	false
`msisdn`	string	इस लुकअप अनुरोध में मूल्यांकित मोबाइल फोन नंबर।	false
`query_status`	string	यह दर्शाता है कि पोर्टेबिलिटी और नेटवर्क जानकारी की प्राप्ति सफल रही या नहीं। संभावित मान `OK` या `FAILED` हैं।	false
`mccmnc`	string(5\|6)	एक पांच या छह-अक्षर का MCCMNC (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड युग्म) जो उस नेटवर्क की पहचान करता है जिससे मोबाइल फोन नंबर वर्तमान में संबंधित है।	true
`mcc`	string(3)	एक तीन-अक्षर का MCC (मोबाइल कंट्री कोड) जो मोबाइल फोन नंबर के वर्तमान नेटवर्क से संबंधित देश को दर्शाता है।	true
`mnc`	string(2\|3)	एक दो या तीन-अक्षर का MNC (मोबाइल नेटवर्क कोड) जो मोबाइल फोन नंबर के लिए वर्तमान नेटवर्क ऑपरेटर की पहचान करता है।	true
`is_ported`	boolean	यह दर्शाता है कि फोन नंबर को उसके मूल नेटवर्क से किसी नए ऑपरेटर में पोर्ट किया गया है या नहीं।	true
`original_network_name`	string	एक स्वैच्छिक स्ट्रिंग (अंग्रेजी में) जो जांचे गए मोबाइल फोन नंबर के मूल नेटवर्क ऑपरेटर का नाम निर्दिष्ट करती है।	true
`original_country_name`	string	एक स्वैच्छिक स्ट्रिंग (अंग्रेजी में) जो जांचे गए मोबाइल फोन नंबर के मूल देश को दर्शाती है।	true
`original_country_code`	string(2)	एक दो-अक्षर का ISO देश कोड जो जांचे गए मोबाइल फोन नंबर के मूल देश को दर्शाता है।	true
`original_country_prefix`	string	जांचे गए मोबाइल फोन नंबर से संबंधित मूल देश का डायलिंग कोड।	true
`ported_network_name`	string	उस नेटवर्क ऑपरेटर को निर्दिष्ट करता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_name`	string	उस देश को निर्दिष्ट करता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_code`	string(2)	एक दो-अक्षर का ISO देश कोड जो उस देश को दर्शाता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_prefix`	string	उस देश का डायलिंग कोड जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`extra`	string	एक स्वैच्छिक स्ट्रिंग जो फोन नंबर के बारे में वैकल्पिक अतिरिक्त विवरण प्रदान करती है।	true
`cost`	string	एक दशमलव मान, स्ट्रिंग के रूप में प्रस्तुत, जो इस लुकअप के लिए EUR में लागत को दर्शाता है।	true
`timestamp`	string	एक W3C-स्वरूपित टाइमस्टैम्प, समय क्षेत्र जानकारी सहित, जो दर्शाता है कि लुकअप कब पूर्ण हुआ।	true
`storage`	string	स्टोरेज नाम (या रिपोर्ट नाम) जिसमें लुकअप परिणाम जोड़े गए थे। इसका उपयोग CSV डाउनलोड और वेब इंटरफेस के माध्यम से रिपोर्टिंग के लिए किया जाता है।	true
`route`	string(3)	एक तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	true
`error_code`	integer	एक वैकल्पिक आंतरिक त्रुटि कोड जो ग्राहक सहायता निदान के लिए अतिरिक्त संदर्भ प्रदान करता है।	true

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

POST/mnp-lookupsसुरक्षित

असिंक्रोनस MNP (मोबाइल नंबर पोर्टेबिलिटी) लुकअप का एक बैच शुरू करता है, जो वर्तमान MCCMNC प्राप्त करता है और रियल-टाइम में मूल और वर्तमान नेटवर्क को सटीक रूप से निर्धारित करता है। परिणाम वेबहुक के माध्यम से आपके सर्वर पर डिलीवर किए जाते हैं। यह विधि बड़ी संख्या में नंबरों को प्रोसेस करने के लिए अनुकूलित है जिन्हें तत्काल प्रतिक्रिया की आवश्यकता नहीं होती, जैसे डेटाबेस क्लीनिंग और सत्यापन। कॉल रूटिंग या SMS डिलीवरी जैसे रियल-टाइम एप्लिकेशन के लिए, इसके बजाय POST /mnp-lookup एंडपॉइंट का उपयोग करने पर विचार करें।

MNP क्वेरी विश्वसनीय रूप से पोर्टेबिलिटी और नेटवर्क जानकारी निर्धारित करती हैं लेकिन यह संकेत नहीं देती हैं कि लक्षित मोबाइल फोन वर्तमान में किसी नेटवर्क से जुड़ा है और पहुंच योग्य है या नहीं। लाइव कनेक्टिविटी जानकारी निकालने के लिए, कृपया POST /hlr-lookups एंडपॉइंट का उपयोग करें।

इस एंडपॉइंट का उपयोग करने से पहले, सुनिश्चित करें कि असिंक्रोनस रूप से लुकअप परिणाम प्राप्त करने के लिए एक वेबहुक URL कॉन्फ़िगर किया गया है। आप इसे अपनी API सेटिंग्स में सेट कर सकते हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया वेबहुक्स

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdns`	array	अंतर्राष्ट्रीय प्रारूप में मोबाइल फोन नंबरों (MSISDNs) की एक सरणी (जैसे +14156226819 या 0014156226819)। आप प्रति अनुरोध 1000 नंबर तक शामिल कर सकते हैं।	null	अनिवार्य
`route`	string(3)	एक वैकल्पिक तीन-अक्षर का पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें, या हमारे सिस्टम को इस अनुरोध के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`accepted`	array	प्रोसेसिंग के लिए स्वीकृत विशिष्ट पहचानकर्ताओं और MSISDNs वाली ऑब्जेक्ट्स की एक सूची।	false
`accepted_count`	integer	प्रोसेसिंग के लिए सफलतापूर्वक स्वीकृत MSISDNs की कुल संख्या।	false
`rejected`	array	प्रोसेसिंग के लिए अस्वीकृत विशिष्ट पहचानकर्ताओं और MSISDNs वाली ऑब्जेक्ट्स की एक सूची, आमतौर पर अमान्य नंबरों के कारण। अस्वीकृत प्रविष्टियों के लिए कोई शुल्क लागू नहीं होता।	false
`rejected_count`	integer	सत्यापन त्रुटियों के कारण अस्वीकृत MSISDNs की कुल संख्या।	false
`total_count`	integer	प्रोसेसिंग के लिए सबमिट किए गए स्वीकृत और अस्वीकृत MSISDNs की कुल गणना।	false
`cost`	string	एक स्ट्रिंग के रूप में दर्शाया गया दशमलव मान, जो स्वीकृत लुकअप के लिए EUR में कुल लागत को दर्शाता है।	false
`storage`	string	स्टोरेज का नाम जहां लुकअप परिणाम जोड़े जाते हैं, वेब इंटरफ़ेस के माध्यम से रिपोर्टिंग और CSV डाउनलोड के लिए उपयोग किया जाता है।	false
`route`	string(3)	एक तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	false
`webhook_urls`	array	आपकी API सेटिंग्स में कॉन्फ़िगर किए गए वेबहुक URLs। परिणाम यहां वापस पोस्ट किए जाते हैं।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

वेबहुक प्रोसेसिंग

सबमिट करने के बाद, हमारा प्लेटफ़ॉर्म प्रदान किए गए फ़ोन नंबरों को प्रोसेस करना शुरू करता है और परिणामों को आपके सर्वर पर पहले से निर्दिष्ट वेबहुक URL पर भेजता है। परिणाम HTTP POST अनुरोध के रूप में रिक्वेस्ट बॉडी में JSON ऑब्जेक्ट के साथ ट्रांसमिट किए जाते हैं।

प्रमाणीकरण

X-Signatures HTTP हेडर की जांच करके वेबहुक को प्रमाणित करें।

X-Signatures हेडर में सेमीकोलन से अलग किए गए सिग्नेचर की सूची होती है। सूची में प्रत्येक सिग्नेचर आपके अकाउंट में कॉन्फ़िगर किए गए API सीक्रेट में से एक का उपयोग करके जेनरेट किया जाता है। वेबहुक को वेरिफ़ाई करने के लिए, अपनी API की, सीक्रेट और रॉ HTTP बॉडी का उपयोग करके SHA-256 हैश जेनरेट करें - फिर इसे सूची में दिए गए सिग्नेचर से तुलना करें।

मिलान की पुष्टि करता है कि अनुरोध प्रामाणिक है और आपके नियंत्रण वाले सीक्रेट से साइन किया गया है।

कोड उदाहरण

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

अनुरोध वैध है यदि हेडर में दिए गए किसी भी सिग्नेचर का मिलान आपकी API की, सीक्रेट और HTTP बॉडी की संयुक्त स्ट्रिंग पर कंप्यूट किए गए SHA256 हैश से होता है।

प्राप्ति की पुष्टि

आपके सर्वर से सफल प्राप्ति की पुष्टि के लिए HTTP स्टेटस कोड 200 OK के साथ रिस्पॉन्ड करने की अपेक्षा की जाती है। यदि कोई अन्य रिस्पॉन्स कोड रिटर्न किया जाता है, टाइमआउट होता है (10 सेकंड), या कोई अन्य डिलीवरी समस्या उत्पन्न होती है, तो सिस्टम एक मिनट के बाद स्वचालित रूप से वेबहुक को पुनः प्रयास करेगा। यदि अनुरोध विफल होता रहता है, तो पुनः प्रयास एक्सपोनेंशियल बैकऑफ़ रणनीति का पालन करेंगे, जिसमें बाद के प्रयास 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 मिनट के बाद होंगे।

यह पुनः प्रयास तंत्र आपके इंफ्रास्ट्रक्चर को लुकअप परिणाम डिलीवर करने में अधिकतम विश्वसनीयता सुनिश्चित करता है। यह अस्थायी नेटवर्क समस्याओं या सर्वर डाउनटाइम के कारण डेटा हानि के जोखिम को कम करता है।

वेबहुक पेलोड

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

वेबहुक पेलोड विशेषताएं

JSON ऑब्जेक्ट में type => MNP विशेषता के साथ results विशेषता शामिल है जिसमें लुकअप ऑब्जेक्ट्स की एक सूची होती है, जैसा कि नीचे दस्तावेजीकृत है।

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप के लिए एक विशिष्ट 12-अक्षर का पहचानकर्ता।	false
`msisdn`	string	इस लुकअप अनुरोध में मूल्यांकित मोबाइल फोन नंबर।	false
`query_status`	string	यह दर्शाता है कि पोर्टेबिलिटी और नेटवर्क जानकारी की प्राप्ति सफल रही या नहीं। संभावित मान `OK` या `FAILED` हैं।	false
`mccmnc`	string(5\|6)	एक पांच या छह-अक्षर का MCCMNC (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड युग्म) जो उस नेटवर्क की पहचान करता है जिससे मोबाइल फोन नंबर वर्तमान में संबंधित है।	true
`mcc`	string(3)	एक तीन-अक्षर का MCC (मोबाइल कंट्री कोड) जो मोबाइल फोन नंबर के वर्तमान नेटवर्क से संबंधित देश को दर्शाता है।	true
`mnc`	string(2\|3)	एक दो या तीन-अक्षर का MNC (मोबाइल नेटवर्क कोड) जो मोबाइल फोन नंबर के लिए वर्तमान नेटवर्क ऑपरेटर की पहचान करता है।	true
`is_ported`	boolean	यह दर्शाता है कि फोन नंबर को उसके मूल नेटवर्क से किसी नए ऑपरेटर में पोर्ट किया गया है या नहीं।	true
`original_network_name`	string	एक स्वैच्छिक स्ट्रिंग (अंग्रेजी में) जो जांचे गए मोबाइल फोन नंबर के मूल नेटवर्क ऑपरेटर का नाम निर्दिष्ट करती है।	true
`original_country_name`	string	एक स्वैच्छिक स्ट्रिंग (अंग्रेजी में) जो जांचे गए मोबाइल फोन नंबर के मूल देश को दर्शाती है।	true
`original_country_code`	string(2)	एक दो-अक्षर का ISO देश कोड जो जांचे गए मोबाइल फोन नंबर के मूल देश को दर्शाता है।	true
`original_country_prefix`	string	जांचे गए मोबाइल फोन नंबर से संबंधित मूल देश का डायलिंग कोड।	true
`ported_network_name`	string	उस नेटवर्क ऑपरेटर को निर्दिष्ट करता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_name`	string	उस देश को निर्दिष्ट करता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_code`	string(2)	एक दो-अक्षर का ISO देश कोड जो उस देश को दर्शाता है जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`ported_country_prefix`	string	उस देश का डायलिंग कोड जिसमें जांचा गया मोबाइल फोन नंबर पोर्ट किया गया है, यदि लागू हो।	true
`extra`	string	एक स्वैच्छिक स्ट्रिंग जो फोन नंबर के बारे में वैकल्पिक अतिरिक्त विवरण प्रदान करती है।	true
`cost`	string	एक दशमलव मान, स्ट्रिंग के रूप में प्रस्तुत, जो इस लुकअप के लिए EUR में लागत को दर्शाता है।	true
`timestamp`	string	एक W3C-स्वरूपित टाइमस्टैम्प, समय क्षेत्र जानकारी सहित, जो दर्शाता है कि लुकअप कब पूर्ण हुआ।	true
`storage`	string	स्टोरेज नाम (या रिपोर्ट नाम) जिसमें लुकअप परिणाम जोड़े गए थे। इसका उपयोग CSV डाउनलोड और वेब इंटरफेस के माध्यम से रिपोर्टिंग के लिए किया जाता है।	true
`route`	string(3)	एक तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	true
`error_code`	integer	एक वैकल्पिक आंतरिक त्रुटि कोड जो ग्राहक सहायता निदान के लिए अतिरिक्त संदर्भ प्रदान करता है।	true

ऊपर स्क्रॉल करें

POST/nt-lookupसुरक्षित

एक समकालिक नंबर प्रकार (NT) लुकअप को आह्वान करता है। यह एंडपॉइंट आदर्श है यदि आपका प्राथमिक लक्ष्य यह निर्धारित करना है कि प्रदान किए गए फोन नंबर लैंडलाइन, मोबाइल, प्रीमियम रेट, VoIP, पेजर, या अन्य नंबरिंग प्लान रेंज में वास्तविक समय में हैं या नहीं।

NT क्वेरी विश्वसनीय रूप से फोन नंबर प्रकार का पता लगाती हैं; हालांकि, वे यह संकेत नहीं देती हैं कि लक्षित नंबर वर्तमान में किसी नेटवर्क से जुड़ा है और पहुंच योग्य है। लाइव कनेक्टिविटी जानकारी प्राप्त करने के लिए, कृपया POST /hlr-lookup एंडपॉइंट का उपयोग करें।

यदि आपके उपयोग के मामले में सटीक नेटवर्क और पोर्टेबिलिटी जानकारी (MCCMNC) की आवश्यकता है लेकिन लाइव कनेक्टिविटी स्थिति की नहीं, तो कृपया मोबाइल नंबर पोर्टेबिलिटी क्वेरी के लिए POST /mnp-lookup एंडपॉइंट का उपयोग करें।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया प्रकार संदर्भ

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`number`	string	अंतर्राष्ट्रीय प्रारूप में एक फोन नंबर (जैसे +4989702626 या 004989702626)।	null	mandatory
`route`	string(3)	एक वैकल्पिक तीन-वर्ण पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें या हमारे सिस्टम को इस अनुरोध के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप अनुरोध को सौंपा गया एक विशिष्ट पहचानकर्ता।	false
`number`	string	इस लुकअप अनुरोध के दौरान मूल्यांकन किया गया फ़ोन नंबर।	false
`number_type`	string	पहचाना गया नंबर प्रकार। संभावित मान शामिल हैं: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` ।	false
`query_status`	string	यह इंगित करता है कि नंबर प्रकार की जानकारी सफलतापूर्वक प्राप्त हुई या नहीं। सफल होने पर `OK` रिटर्न करता है, या लुकअप विफल होने पर `FAILED` रिटर्न करता है।	false
`is_valid`	boolean	यह इंगित करता है कि फ़ोन नंबर सिंटैक्टिक रूप से मान्य है या नहीं।	true
`invalid_reason`	string	अंग्रेजी में एक सादा टेक्स्ट संदेश जो यह निर्दिष्ट करता है कि फ़ोन नंबर को अमान्य क्यों माना गया है (जैसे "too short" या "invalid prefix"), या यदि नंबर मान्य है तो `null`।	true
`is_possibly_ported`	boolean	यह इंगित करता है कि फ़ोन नंबर को उसके मूल ऑपरेटर से किसी अन्य कैरियर में पोर्ट किया गया हो सकता है। निश्चित पोर्टेबिलिटी जानकारी के लिए, MNP लुकअप का उपयोग करें।	true
`is_vanity_number`	boolean	यह इंगित करता है कि फ़ोन नंबर एक वैनिटी नंबर है, अर्थात इसमें वर्णमाला के अक्षर शामिल हैं।	true
`qualifies_for_hlr_lookup`	boolean	यह इंगित करता है कि फ़ोन नंबर HLR लुकअप के माध्यम से अतिरिक्त क्वेरी के लिए योग्य है या नहीं।	true
`mccmnc`	string(5\|6)	पांच या छह अक्षरों की एक स्ट्रिंग जो MCCMNC ट्यूपल (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड) को दर्शाती है जो मोबाइल फ़ोन नंबर के मूल नेटवर्क की पहचान करती है।	true
`mcc`	string(3)	तीन अक्षरों की एक स्ट्रिंग जो MCC (मोबाइल कंट्री कोड) को दर्शाती है जो फ़ोन नंबर के मूल मोबाइल नेटवर्क से संबंधित देश की पहचान करती है।	true
`mnc`	string(2\|3)	दो या तीन अक्षरों की एक स्ट्रिंग जो MNC (मोबाइल नेटवर्क कोड) को दर्शाती है जो फ़ोन नंबर के मूल मोबाइल नेटवर्क ऑपरेटर की पहचान करती है।	true
`original_network_name`	string	अंग्रेजी में एक सादा टेक्स्ट स्ट्रिंग जो निरीक्षित मोबाइल फ़ोन नंबर के मूल नेटवर्क ऑपरेटर का नाम निर्दिष्ट करती है।	true
`original_country_name`	string	अंग्रेजी में एक सादा टेक्स्ट स्ट्रिंग जो निरीक्षित मोबाइल फ़ोन नंबर से संबंधित मूल देश को निर्दिष्ट करती है।	true
`original_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो निरीक्षित मोबाइल फ़ोन नंबर के मूल देश को इंगित करता है।	true
`regions`	array	अंग्रेजी में मानव-पठनीय स्ट्रिंग की एक सूची जो इस फ़ोन नंबर से संबंधित भौगोलिक क्षेत्र(क्षेत्रों) को निर्दिष्ट करती है।	true
`timezones`	array	इस फ़ोन नंबर से संबंधित टाइमज़ोन की एक सूची (Olson प्रारूप में)।	true
`info_text`	string	एक स्ट्रिंग जिसमें फ़ोन नंबर के बारे में अतिरिक्त जानकारी हो सकती है।	true
`cost`	string	एक दशमलव मान जो स्ट्रिंग के रूप में दर्शाया गया है, जो इस लुकअप की लागत (EUR में) को इंगित करता है।	true
`timestamp`	string	W3C-प्रारूपित टाइमस्टैम्प (टाइम ज़ोन सहित) जो यह इंगित करता है कि लुकअप कब पूर्ण हुआ।	true
`storage`	string	स्टोरेज नाम निर्दिष्ट करता है जहां लुकअप परिणाम जोड़े गए हैं। यह वेब इंटरफ़ेस के माध्यम से CSV डाउनलोड और एनालिटिक्स के लिए उपयोग किए गए रिपोर्ट नाम से मेल खाता है।	true
`route`	string(3)	एक तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	true

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

प्रकार	विवरण
LANDLINE	लैंडलाइन फ़ोन नंबर।
MOBILE	मोबाइल फ़ोन नंबर। अतिरिक्त कनेक्शन स्थिति, नेटवर्क, पोर्टेबिलिटी और रोमिंग जानकारी प्राप्त करने के लिए HLR लुकअप के लिए योग्य।
MOBILE_OR_LANDLINE	लैंडलाइन या मोबाइल फ़ोन नंबर। HLR लुकअप के लिए योग्य हो सकता है।
TOLL_FREE	टोल फ्री फ़ोन नंबर।
PREMIUM_RATE	अतिरिक्त शुल्क के साथ प्रीमियम रेट फ़ोन नंबर।
SHARED_COST	साझा लागत फ़ोन नंबर। आमतौर पर प्रीमियम रेट फ़ोन नंबर की तुलना में कम खर्चीला।
VOIP	वॉइस ओवर IP फ़ोन नंबर। TSoIP फ़ोन नंबर (टेलीफोनी सर्विस ओवर IP) शामिल हैं।
PAGER	पेजर फ़ोन नंबर। आमतौर पर वॉइस कार्यक्षमता नहीं होती।
UAN	यूनिवर्सल एक्सेस नंबर (कंपनी नंबर)। विशिष्ट कार्यालयों पर रूट किया जा सकता है लेकिन कंपनी के लिए एक नंबर का उपयोग करने की अनुमति देता है।
VOICEMAIL	वॉइसमेल फ़ोन नंबर।
UNKNOWN	नंबर प्रकार निर्धारित नहीं किया जा सका।

ऊपर स्क्रॉल करें

POST/nt-lookups सुरक्षित

यह एंडपॉइंट वेबहुक के माध्यम से आपके सर्वर पर परिणाम भेजने के साथ असिंक्रोनस नंबर टाइप लुकअप की एक श्रृंखला शुरू करता है। यह उपयुक्त है यदि आपका प्राथमिक लक्ष्य यह निर्धारित करना है कि दिए गए फोन नंबर लैंडलाइन, मोबाइल, प्रीमियम रेट, VoIP, पेजर, या अन्य नंबरिंग प्लान रेंज से संबंधित हैं या नहीं। बड़ी संख्या में नंबरों की तेज प्रोसेसिंग के लिए अनुकूलित, यह एंडपॉइंट बल्क ऑपरेशन (जैसे डेटाबेस सैनिटाइजेशन) के लिए आदर्श है। लाइव ट्रैफिक और समय-संवेदनशील उपयोग के मामलों के लिए, कृपया इसके बजाय POST /nt-lookup एंडपॉइंट का उपयोग करें।

इस एंडपॉइंट को शुरू करने के लिए आपको अपनी API सेटिंग्स में एक वेबहुक URL निर्दिष्ट करना होगा।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया वेबहुक्स प्रकार संदर्भ

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

पेलोड

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`numbers`	array	अंतर्राष्ट्रीय प्रारूप में फोन नंबरों की एक सूची (जैसे +14156226819 या 004989702626)। प्रति अनुरोध अधिकतम 1000 नंबर शामिल किए जा सकते हैं।	null	अनिवार्य
`route`	string(3)	एक वैकल्पिक तीन-वर्ण पहचानकर्ता जो इस लुकअप के लिए रूट निर्दिष्ट करता है। अपने कस्टम रूटिंग मैप को लागू करने के लिए `null` पर सेट करें या इस पैरामीटर को छोड़ दें, या हमारे सिस्टम को इस अनुरोध के लिए सर्वोत्तम रूट स्वचालित रूप से निर्धारित करने दें।	null	वैकल्पिक
`storage`	string	एक वैकल्पिक स्टोरेज पहचानकर्ता जो उस रिपोर्ट को निर्दिष्ट करता है जहां मैन्युअल समीक्षा, एनालिटिक्स और रिपोर्टिंग के लिए परिणाम संग्रहीत किए जाएंगे। सिस्टम स्वचालित रूप से वर्तमान महीने के साथ एक टाइमस्टैम्प जोड़ता है। यदि छोड़ दिया जाता है या `null` पर सेट किया जाता है, तो सिस्टम स्वचालित रूप से रिपोर्टिंग उद्देश्यों के लिए महीने के अनुसार परिणामों को समूहित करेगा।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`accepted`	array	ऑब्जेक्ट्स की एक सूची, जिसमें प्रत्येक में एक अद्वितीय पहचानकर्ता और एक फोन नंबर होता है जिसे प्रोसेसिंग के लिए स्वीकार किया गया है।	false
`accepted_count`	integer	प्रोसेसिंग के लिए स्वीकार किए गए फोन नंबरों की कुल संख्या।	false
`rejected`	array	ऑब्जेक्ट्स की एक सूची, जिसमें प्रत्येक में एक अद्वितीय पहचानकर्ता और एक फोन नंबर होता है जिसे प्रोसेसिंग के लिए अस्वीकार कर दिया गया था। आमतौर पर, ये नंबर अमान्य होते हैं, और कोई शुल्क लागू नहीं होता है।	false
`rejected_count`	integer	प्रोसेसिंग के लिए अस्वीकार किए गए फोन नंबरों की कुल संख्या।	false
`total_count`	integer	प्रोसेसिंग के लिए सबमिट किए गए स्वीकृत और अस्वीकृत फोन नंबरों की कुल संख्या।	false
`cost`	string	एक स्ट्रिंग जो दशमलव मान को दर्शाती है जो इन लुकअप के लिए EUR में लागत को इंगित करती है।	false
`storage`	string	स्टोरेज (रिपोर्ट) का नाम जहां लुकअप परिणाम जोड़े गए हैं। इस नाम का उपयोग वेब इंटरफेस के माध्यम से CSV डाउनलोड और एनालिटिक्स के लिए किया जाता है।	false
`route`	string(3)	एक तीन-वर्ण पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	false
`webhook_urls`	array	आपकी API सेटिंग्स में कॉन्फ़िगर किए गए वेबहुक URLs। परिणाम यहां वापस पोस्ट किए जाते हैं।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

वेबहुक प्रोसेसिंग

सबमिट करने के बाद, हमारा प्लेटफ़ॉर्म प्रदान किए गए फ़ोन नंबरों को प्रोसेस करना शुरू करता है और परिणामों को आपके सर्वर पर पहले से निर्दिष्ट वेबहुक URL पर भेजता है। परिणाम HTTP POST अनुरोध के रूप में रिक्वेस्ट बॉडी में JSON ऑब्जेक्ट के साथ ट्रांसमिट किए जाते हैं।

प्रमाणीकरण

X-Signatures HTTP हेडर की जांच करके वेबहुक को प्रमाणित करें।

X-Signatures हेडर में सेमीकोलन से अलग किए गए सिग्नेचर की सूची होती है। सूची में प्रत्येक सिग्नेचर आपके अकाउंट में कॉन्फ़िगर किए गए API सीक्रेट में से एक का उपयोग करके जेनरेट किया जाता है। वेबहुक को वेरिफ़ाई करने के लिए, अपनी API की, सीक्रेट और रॉ HTTP बॉडी का उपयोग करके SHA-256 हैश जेनरेट करें - फिर इसे सूची में दिए गए सिग्नेचर से तुलना करें।

मिलान की पुष्टि करता है कि अनुरोध प्रामाणिक है और आपके नियंत्रण वाले सीक्रेट से साइन किया गया है।

कोड उदाहरण

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

अनुरोध वैध है यदि हेडर में दिए गए किसी भी सिग्नेचर का मिलान आपकी API की, सीक्रेट और HTTP बॉडी की संयुक्त स्ट्रिंग पर कंप्यूट किए गए SHA256 हैश से होता है।

प्राप्ति की पुष्टि

आपके सर्वर से सफल प्राप्ति की पुष्टि के लिए HTTP स्टेटस कोड 200 OK के साथ रिस्पॉन्ड करने की अपेक्षा की जाती है। यदि कोई अन्य रिस्पॉन्स कोड रिटर्न किया जाता है, टाइमआउट होता है (10 सेकंड), या कोई अन्य डिलीवरी समस्या उत्पन्न होती है, तो सिस्टम एक मिनट के बाद स्वचालित रूप से वेबहुक को पुनः प्रयास करेगा। यदि अनुरोध विफल होता रहता है, तो पुनः प्रयास एक्सपोनेंशियल बैकऑफ़ रणनीति का पालन करेंगे, जिसमें बाद के प्रयास 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 मिनट के बाद होंगे।

यह पुनः प्रयास तंत्र आपके इंफ्रास्ट्रक्चर को लुकअप परिणाम डिलीवर करने में अधिकतम विश्वसनीयता सुनिश्चित करता है। यह अस्थायी नेटवर्क समस्याओं या सर्वर डाउनटाइम के कारण डेटा हानि के जोखिम को कम करता है।

वेबहुक पेलोड

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

वेबहुक पेलोड विशेषताएं

JSON ऑब्जेक्ट में type => NT विशेषता के साथ results विशेषता शामिल है जिसमें लुकअप ऑब्जेक्ट्स की एक सूची होती है, जैसा कि नीचे दस्तावेजीकृत है।

नाम	प्रकार	विवरण	शून्य योग्य
`id`	string(12)	इस लुकअप अनुरोध को सौंपा गया एक विशिष्ट पहचानकर्ता।	false
`number`	string	इस लुकअप अनुरोध के दौरान मूल्यांकन किया गया फ़ोन नंबर।	false
`number_type`	string	पहचाना गया नंबर प्रकार। संभावित मान शामिल हैं: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` ।	false
`query_status`	string	यह इंगित करता है कि नंबर प्रकार की जानकारी सफलतापूर्वक प्राप्त हुई या नहीं। सफल होने पर `OK` रिटर्न करता है, या लुकअप विफल होने पर `FAILED` रिटर्न करता है।	false
`is_valid`	boolean	यह इंगित करता है कि फ़ोन नंबर सिंटैक्टिक रूप से मान्य है या नहीं।	true
`invalid_reason`	string	अंग्रेजी में एक सादा टेक्स्ट संदेश जो यह निर्दिष्ट करता है कि फ़ोन नंबर को अमान्य क्यों माना गया है (जैसे "too short" या "invalid prefix"), या यदि नंबर मान्य है तो `null`।	true
`is_possibly_ported`	boolean	यह इंगित करता है कि फ़ोन नंबर को उसके मूल ऑपरेटर से किसी अन्य कैरियर में पोर्ट किया गया हो सकता है। निश्चित पोर्टेबिलिटी जानकारी के लिए, MNP लुकअप का उपयोग करें।	true
`is_vanity_number`	boolean	यह इंगित करता है कि फ़ोन नंबर एक वैनिटी नंबर है, अर्थात इसमें वर्णमाला के अक्षर शामिल हैं।	true
`qualifies_for_hlr_lookup`	boolean	यह इंगित करता है कि फ़ोन नंबर HLR लुकअप के माध्यम से अतिरिक्त क्वेरी के लिए योग्य है या नहीं।	true
`mccmnc`	string(5\|6)	पांच या छह अक्षरों की एक स्ट्रिंग जो MCCMNC ट्यूपल (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड) को दर्शाती है जो मोबाइल फ़ोन नंबर के मूल नेटवर्क की पहचान करती है।	true
`mcc`	string(3)	तीन अक्षरों की एक स्ट्रिंग जो MCC (मोबाइल कंट्री कोड) को दर्शाती है जो फ़ोन नंबर के मूल मोबाइल नेटवर्क से संबंधित देश की पहचान करती है।	true
`mnc`	string(2\|3)	दो या तीन अक्षरों की एक स्ट्रिंग जो MNC (मोबाइल नेटवर्क कोड) को दर्शाती है जो फ़ोन नंबर के मूल मोबाइल नेटवर्क ऑपरेटर की पहचान करती है।	true
`original_network_name`	string	अंग्रेजी में एक सादा टेक्स्ट स्ट्रिंग जो निरीक्षित मोबाइल फ़ोन नंबर के मूल नेटवर्क ऑपरेटर का नाम निर्दिष्ट करती है।	true
`original_country_name`	string	अंग्रेजी में एक सादा टेक्स्ट स्ट्रिंग जो निरीक्षित मोबाइल फ़ोन नंबर से संबंधित मूल देश को निर्दिष्ट करती है।	true
`original_country_code`	string(2)	दो-अक्षर का ISO देश कोड जो निरीक्षित मोबाइल फ़ोन नंबर के मूल देश को इंगित करता है।	true
`regions`	array	अंग्रेजी में मानव-पठनीय स्ट्रिंग की एक सूची जो इस फ़ोन नंबर से संबंधित भौगोलिक क्षेत्र(क्षेत्रों) को निर्दिष्ट करती है।	true
`timezones`	array	इस फ़ोन नंबर से संबंधित टाइमज़ोन की एक सूची (Olson प्रारूप में)।	true
`info_text`	string	एक स्ट्रिंग जिसमें फ़ोन नंबर के बारे में अतिरिक्त जानकारी हो सकती है।	true
`cost`	string	एक दशमलव मान जो स्ट्रिंग के रूप में दर्शाया गया है, जो इस लुकअप की लागत (EUR में) को इंगित करता है।	true
`timestamp`	string	W3C-प्रारूपित टाइमस्टैम्प (टाइम ज़ोन सहित) जो यह इंगित करता है कि लुकअप कब पूर्ण हुआ।	true
`storage`	string	स्टोरेज नाम निर्दिष्ट करता है जहां लुकअप परिणाम जोड़े गए हैं। यह वेब इंटरफ़ेस के माध्यम से CSV डाउनलोड और एनालिटिक्स के लिए उपयोग किए गए रिपोर्ट नाम से मेल खाता है।	true
`route`	string(3)	एक तीन-अक्षर का पहचानकर्ता जो इस लुकअप अनुरोध के लिए उपयोग किए गए रूट को निर्दिष्ट करता है।	true

प्रकार	विवरण
LANDLINE	लैंडलाइन फ़ोन नंबर।
MOBILE	मोबाइल फ़ोन नंबर। अतिरिक्त कनेक्शन स्थिति, नेटवर्क, पोर्टेबिलिटी और रोमिंग जानकारी प्राप्त करने के लिए HLR लुकअप के लिए योग्य।
MOBILE_OR_LANDLINE	लैंडलाइन या मोबाइल फ़ोन नंबर। HLR लुकअप के लिए योग्य हो सकता है।
TOLL_FREE	टोल फ्री फ़ोन नंबर।
PREMIUM_RATE	अतिरिक्त शुल्क के साथ प्रीमियम रेट फ़ोन नंबर।
SHARED_COST	साझा लागत फ़ोन नंबर। आमतौर पर प्रीमियम रेट फ़ोन नंबर की तुलना में कम खर्चीला।
VOIP	वॉइस ओवर IP फ़ोन नंबर। TSoIP फ़ोन नंबर (टेलीफोनी सर्विस ओवर IP) शामिल हैं।
PAGER	पेजर फ़ोन नंबर। आमतौर पर वॉइस कार्यक्षमता नहीं होती।
UAN	यूनिवर्सल एक्सेस नंबर (कंपनी नंबर)। विशिष्ट कार्यालयों पर रूट किया जा सकता है लेकिन कंपनी के लिए एक नंबर का उपयोग करने की अनुमति देता है।
VOICEMAIL	वॉइसमेल फ़ोन नंबर।
UNKNOWN	नंबर प्रकार निर्धारित नहीं किया जा सका।

ऊपर स्क्रॉल करें

GET/routeसुरक्षित

वह रूट प्राप्त करता है जो स्वचालित रूप से चुना जाएगा जब आप route पैरामीटर निर्दिष्ट किए बिना HLR लुकअप चलाते हैं।

स्वचालित रूट चयन GET /hlr-coverage एंडपॉइंट के साथ प्राप्त रूटिंग मैप पर आधारित है, जो मुख्य रूप से GET /routing-map से प्राप्त होता है। आप अपने खाता सेटिंग्स में अपना रूटिंग मैप अनुकूलित कर सकते हैं और कस्टम नियम परिभाषित कर सकते हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdn`	string	वह MSISDN जिसके लिए स्वचालित रूप से चयनित रूटिंग जानकारी प्राप्त करनी है।	null	अनिवार्य

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`route`	string	अनुशंसित रूट।	false
`confidence_level`	string	वह विश्वास स्तर जिसके साथ यह रूट चयनित किया गया था, अर्थात `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`।	false
`mccmnc`	string	इस नंबर के लिए नंबरिंग प्लान आधारित MCCMNC।	false
`origin`	string	वह स्रोत जिस पर रूटिंग निर्णय आधारित है, अर्थात `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."
    ]
}

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/routesसुरक्षित

यह एंडपॉइंट उपलब्ध HLR, MNP, और NT रूट्स की सूची प्रदान करता है। प्रत्येक रूट, इसकी विशेषताओं और सीमाओं के साथ, रूटिंग विवरण पेज पर समझाया गया है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`routes`	object	रूट प्रकार के अनुसार समूहीकृत रूट्स वाला ऑब्जेक्ट।	false
`HLR\|MNP\|NT`	string[]	रूट आइडेंटिफायर्स की सूची शामिल है।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/routing-mapसुरक्षित

आपके खाते के लिए HLR लुकअप्स पर वर्तमान में लागू स्वचालित रूटिंग कॉन्फ़िगरेशन को पुनर्प्राप्त करता है। यह डिफ़ॉल्ट कॉन्फ़िगरेशन तब उपयोग की जाती है जब आप route पैरामीटर निर्दिष्ट किए बिना HLR लुकअप सबमिट करते हैं। आप अपने खाता सेटिंग्स में अपना रूटिंग मैप कस्टमाइज़ कर सकते हैं और कस्टम नियम बना सकते हैं।

कॉन्फ़िगरेशन पदानुक्रम देश-स्तरीय नियमों से MCCMNC-स्तरीय नियमों तक, और अंत में व्यक्तिगत फ़ोन नंबर प्रीफ़िक्स मैपिंग तक कैस्केड होता है। व्यवहार में, इसका मतलब है कि व्यक्तिगत फ़ोन नंबर प्रीफ़िक्स मैपिंग परस्पर विरोधी MCCMNC असाइनमेंट पर प्राथमिकता लेती हैं, जो बदले में देश-स्तरीय नियमों को ओवरराइड करती हैं। कृपया ध्यान दें कि MNP फ़ॉलबैक सक्षम होने पर किसी भी परस्पर विरोधी कस्टम नियमों को ओवरराइड करता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`default_route`	string	डिफ़ॉल्ट रूट जो तब उपयोग किया जाता है जब MSISDN के लिए कोई पसंदीदा रूटिंग विकल्प निर्धारित नहीं किया जा सकता है और कोई कस्टम रूटिंग नियम लागू नहीं होते हैं।	false
`mnp_fallback`	boolean	इंगित करता है कि MNP फ़ॉलबैक सक्षम है या नहीं। सक्षम होने पर और जब HLR क्वेरी किसी नेटवर्क द्वारा असमर्थित हों (कनेक्टिविटी स्थिति अनुपलब्ध), तो सिस्टम इसके बजाय MNP लुकअप करेगा।	false
`mccmncs`	array	MCCMNC कोड की उनके स्वचालित रूप से चयनित रूट्स के साथ मैपिंग। किसी दिए गए MCCMNC में नंबर के लिए HLR लुकअप करते समय, संबंधित रूट का उपयोग किया जाता है।	false
`mccmnc`	string(5\|6)	पांच या छह-वर्ण का MCCMNC (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड का संयोजन) जो मोबाइल नेटवर्क ऑपरेटर की पहचान करता है।	false
`countrycode`	string(2)	दो अक्षर का ISO देश कोड, जो नेटवर्क के देश की पहचान करता है।	false
`route`	string(3)	नेटवर्क के लिए चयनित रूट।	false
`mno`	string	उपभोक्ता-उन्मुख ब्रांड जिसके तहत यह नेटवर्क संचालित होता है।	false
`confidence`	string	विश्वास स्तर जिसके साथ चयन किया गया था। संभावित मान हैं: HIGH, NORMAL, LOW, MNP_REDIRECT। बाद के मामले में, सिस्टम इस नेटवर्क के लिए ट्रैफ़िक को MNP पर रीडायरेक्ट करता है, यदि यह व्यवहार आपके खाते में सक्षम है। अन्यथा यह खाते में डिफ़ॉल्ट रूट का उपयोग करता है।	false
`origin`	string	मूल स्रोत जिस पर चयन आधारित है। संभावित मान हैं: `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	आपके खाते में कॉन्फ़िगर किए गए कस्टम प्रीफ़िक्स-आधारित रूटिंग नियमों की सूची, यदि कोई हो।	false
`countrycode`	string(2)	दो अक्षर का ISO देश कोड, जो प्रीफ़िक्स के देश की पहचान करता है।	false
`cns`	string	प्रीफ़िक्स जिस पर रूटिंग नियम लागू होता है।	false
`route`	string(3)	प्रीफ़िक्स के लिए चयनित रूट।	false
`mccmnc`	string(5\|6)	पांच या छह-वर्ण का MCCMNC (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड का संयोजन) जो मोबाइल नेटवर्क ऑपरेटर की पहचान करता है।	true
`mno`	string	उपभोक्ता-उन्मुख ब्रांड जिसके तहत यह नेटवर्क संचालित होता है।	true
`countries`	array	आपके खाते में कॉन्फ़िगर किए गए कस्टम देश-आधारित नियमों की सूची, यदि कोई हो।	false
`countrycode`	string(2)	दो अक्षर का ISO देश कोड, जो देश की पहचान करता है।	false
`route`	string(3)	देश के लिए चयनित रूट।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/hlr-coverage सुरक्षित

डेटा-संचालित निर्णय लेने में सहायता के लिए HLR कवरेज इनसाइट्स प्रदान करता है। यह एंडपॉइंट आपको मोबाइल नेटवर्क में रियल-टाइम HLR रूटिंग विकल्पों का विश्लेषण करने, अपने लक्षित क्षेत्रों के लिए सबसे प्रभावी मार्गों की पहचान करने और अपनी स्वचालित रूटिंग को कॉन्फ़िगर करने में मदद करता है।

GET /route से अनुशंसित मार्ग यहां प्राप्त कवरेज डेटा पर आधारित हैं। कवरेज डेटा नेटवर्क कवरेज पेज पर भी उपलब्ध है। आप अपने अकाउंट सेटिंग्स में अपने रूटिंग मैप को और अधिक अनुकूलित कर सकते हैं और नियम परिभाषित कर सकते हैं।

हम अनुशंसा करते हैं कि परिणामों की व्याख्या करने में मदद के लिए इस गाइड से परिचित हो जाएं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया स्टेटस संदर्भ

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`countrycode`	string(2)	एक अनिवार्य दो-अक्षर का ISO देश कोड जो परिणामों को फ़िल्टर करने के लिए उपयोग किया जाता है, केवल निर्दिष्ट देश से संबंधित रिकॉर्ड लौटाता है।	null	अनिवार्य
`sample_size`	string	एक वैकल्पिक पैरामीटर जो सैंपल साइज़ निर्दिष्ट करता है। संभावित मान `LARGE`, `MEDIUM`, `SMALL` हैं। बड़े सैंपल लंबी समयावधि को कवर करते हैं, छोटे सैंपल बहुत हाल की समयावधि को कवर करते हैं।	LARGE	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`name`	string	चयनित देश का नाम अंग्रेजी में सादे टेक्स्ट में।	false
`countrycode`	string(2)	चयनित देश का दो-अक्षर का ISO देश कोड।	false
`prefix`	string	चयनित देश का अंतर्राष्ट्रीय डायलिंग प्रीफ़िक्स।	false
`mccs`	string[]	चयनित देश से संबंधित MCCs (मोबाइल कंट्री कोड) की सूची।	false
`carriers`	object[]	रूट-विशिष्ट कनेक्टिविटी मेट्रिक्स के साथ कैरियर ऑब्जेक्ट्स की सूची।	false
`mno`	string	मोबाइल नेटवर्क ऑपरेटर का नाम अंग्रेजी में सादे टेक्स्ट में।	false
`mccmnc`	string	मोबाइल नेटवर्क ऑपरेटर का MCCMNC।	false
`mcc`	string	मोबाइल नेटवर्क ऑपरेटर का MCC (मोबाइल कंट्री कोड)।	false
`mnc`	string	मोबाइल नेटवर्क ऑपरेटर का MNC (मोबाइल नेटवर्क कोड)।	false
`routes`	object[]	रूट-विशिष्ट कनेक्टिविटी परिणामों की सूची।	false
`route`	string	वह रूट जिस पर कनेक्टिविटी जानकारी लागू होती है।	false
`selected`	bool	यह इंगित करता है कि क्या यह स्वचालित रूटिंग के लिए चयनित रूट है।	false
`selection_confidence`	string	वह विश्वास स्तर जिसके साथ यह रूट चयनित किया गया था, अर्थात `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`। यदि यह चयनित रूट नहीं है तो null होता है।	true
`n`	int	इस सैंपल में लुकअप्स की कुल संख्या।	false
`CONNECTED`	int	HLR लुकअप्स की संख्या जिन्होंने CONNECTED स्टेटस लौटाया।	false
`CONNECTED_PCT`	float	HLR लुकअप्स का प्रतिशत जिन्होंने CONNECTED स्टेटस लौटाया।	false
`ABSENT`	int	HLR लुकअप्स की संख्या जिन्होंने ABSENT स्टेटस लौटाया।	false
`ABSENT_PCT`	float	HLR लुकअप्स का प्रतिशत जिन्होंने ABSENT स्टेटस लौटाया।	false
`INVALID_MSISDN`	int	HLR लुकअप्स की संख्या जिन्होंने INVALID_MSISDN स्टेटस लौटाया।	false
`INVALID_MSISDN_PCT`	float	HLR लुकअप्स का प्रतिशत जिन्होंने INVALID_MSISDN स्टेटस लौटाया।	false
`UNDETERMINED`	int	HLR लुकअप्स की संख्या जिन्होंने UNDETERMINED स्टेटस लौटाया।	false
`UNDETERMINED_PCT`	float	HLR लुकअप्स का प्रतिशत जिन्होंने UNDETERMINED स्टेटस लौटाया।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

स्थिति	विवरण
CONNECTED	नंबर मान्य है, और लक्ष्य हैंडसेट वर्तमान में मोबाइल नेटवर्क से जुड़ा हुआ है। कॉल, SMS और अन्य सेवाएं प्राप्तकर्ता तक सफलतापूर्वक पहुंचनी चाहिए।
ABSENT	नंबर मान्य है, लेकिन लक्ष्य हैंडसेट या तो बंद है या अस्थायी रूप से नेटवर्क कवरेज से बाहर है। संदेश या कॉल तब तक नहीं पहुंच सकते जब तक डिवाइस नेटवर्क से पुनः कनेक्ट नहीं हो जाता।
INVALID_MSISDN	नंबर अमान्य है या वर्तमान में मोबाइल नेटवर्क पर किसी ग्राहक को आवंटित नहीं है। इस नंबर पर कॉल और संदेश विफल हो जाएंगे।
UNDETERMINED	नंबर की कनेक्टिविटी स्थिति निर्धारित नहीं की जा सकी। यह अमान्य नंबर, SS7 त्रुटि प्रतिक्रिया, या लक्ष्य नेटवर्क ऑपरेटर के साथ कनेक्टिविटी की कमी के कारण हो सकता है। अतिरिक्त निदान के लिए त्रुटि कोड और इसके विवरण फ़ील्ड की जांच करें।

ऊपर स्क्रॉल करें

GET/mnp-coverageसुरक्षित

यह एंडपॉइंट मोबाइल नेटवर्क ऑपरेटरों की सूची प्रदान करता है, जिसमें उनके संबंधित MCCMNC पहचानकर्ता शामिल हैं, जो वर्तमान में मोबाइल नंबर पोर्टेबिलिटी लुकअप के लिए समर्थित हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`countrycode`	string(2)	एक वैकल्पिक दो-अक्षर का ISO देश कोड जिसका उपयोग MCCMNC परिणामों को फ़िल्टर करने के लिए किया जाता है, केवल निर्दिष्ट देश से संबंधित डेटा प्रदान करता है।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`items[]`	array	मोबाइल नेटवर्क ऑपरेटरों की सूची।	false
`country_name`	string	अंग्रेजी में देश का नाम।	false
`country_code`	string(2)	दो-अक्षर का ISO देश कोड।	false
`mccmnc`	string(5\|6)	पांच या छह-वर्ण का MCCMNC (मोबाइल कंट्री कोड और मोबाइल नेटवर्क कोड का संयोजन) जो मोबाइल नेटवर्क ऑपरेटर की पहचान करता है।	false
`mcc`	string(3)	तीन-वर्ण का MCC (मोबाइल कंट्री कोड) जो नेटवर्क के देश को दर्शाता है।	false
`mnc`	string(2\|3)	दो या तीन-वर्ण का MNC (मोबाइल नेटवर्क कोड) जो विशिष्ट मोबाइल नेटवर्क ऑपरेटर को दर्शाता है।	false
`brand`	string	उपभोक्ता-उन्मुख ब्रांड जिसके तहत यह नेटवर्क संचालित होता है।	true
`operator`	string	मोबाइल नेटवर्क ऑपरेटर का कानूनी नाम।	true

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/price-listसुरक्षित

यह एंडपॉइंट उन देशों की सूची लौटाता है जहां केवल MNP लुकअप समर्थित हैं, और इन गंतव्यों के लिए HLR क्वेरी उपलब्ध नहीं हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`countries`	string[]	दो-अक्षर वाले ISO देश कोड की सूची।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/mccmncsसुरक्षित

यह एंडपॉइंट मोबाइल नेटवर्क ऑपरेटरों की एक व्यापक सूची उनके संबंधित MCCMNC पहचानकर्ताओं और अतिरिक्त संदर्भ जानकारी के साथ लौटाता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`countrycode`	string(2)	एक वैकल्पिक दो-अक्षर का ISO देश कोड जिसका उपयोग MCCMNC परिणामों को फ़िल्टर करने के लिए किया जाता है, केवल निर्दिष्ट देश से संबंधित रिकॉर्ड लौटाता है।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`items`	object[]	मोबाइल नेटवर्क ऑपरेटरों की सूची।	false
`country_name`	string	अंग्रेजी में पूर्ण देश का नाम।	false
`country_code`	string(2)	मोबाइल ऑपरेटर के देश का प्रतिनिधित्व करने वाला दो-अक्षर का ISO देश कोड।	false
`mccmnc`	string(5\|6)	MCCMNC का प्रतिनिधित्व करने वाली पांच या छह-अक्षर की स्ट्रिंग, जो मोबाइल नेटवर्क ऑपरेटर की विशिष्ट पहचान करती है।	false
`mcc`	string(3)	तीन-अक्षर का मोबाइल कंट्री कोड (MCC) जो उस देश की पहचान करता है जहां मोबाइल नेटवर्क संचालित होता है।	false
`mnc`	string(2\|3)	दो या तीन-अक्षर का मोबाइल नेटवर्क कोड (MNC) जो दिए गए MCC के भीतर मोबाइल नेटवर्क को निर्दिष्ट करता है।	false
`brand`	string	वाणिज्यिक ब्रांड नाम जिसके तहत नेटवर्क संचालित होता है और उपभोक्ताओं द्वारा पहचाना जाता है।	true
`operator`	string	मोबाइल नेटवर्क ऑपरेटर का आधिकारिक नाम, आमतौर पर नेटवर्क का प्रबंधन करने वाली कानूनी संस्था।	true
`parent_mccmnc`	string(5\|6)	पांच या छह-अक्षर की स्ट्रिंग जो मूल मोबाइल नेटवर्क ऑपरेटर के MCCMNC का प्रतिनिधित्व करती है, यदि कोई हो।	true

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/priceसुरक्षित

यह एंडपॉइंट HLR, MNP, या NT लुकअप के लिए मूल्य लौटाता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

रिक्वेस्ट पैरामीटर

Key	प्रकार	विवरण	डिफ़ॉल्ट	अनिवार्य
`msisdn`	string	वह फ़ोन नंबर जिसके लिए मूल्य प्राप्त करना है। अंतर्राष्ट्रीय प्रारूप में।	null	अनिवार्य
`route_type`	string	रूट प्रकार, अर्थात `HLR`, `MNP`, `NT`।	null	अनिवार्य
`route`	string(3)	वह रूट जिसके लिए मूल्य की गणना की जानी चाहिए। स्वचालित रूटिंग द्वारा निर्धारित रूट के लिए डिफ़ॉल्ट।	null	वैकल्पिक

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`price`	object	मूल्य निर्धारण विवरण के साथ एक ऑब्जेक्ट।	false
`amount`	string	EUR में राशि।	false
`msisdn`	string	वह MSISDN जिस पर यह मूल्य लागू होता है।	false
`route_type`	string(2\|3)	वह रूट प्रकार जिस पर यह मूल्य लागू होता है।	false
`route`	string(3)	वह रूट जिस पर यह मूल्य लागू होता है।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/price-listसुरक्षित

यह एंडपॉइंट आपके खाते में मूल्य निर्धारण जानकारी प्रदान करता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`pricing`	object[]	मूल्य निर्धारण जानकारी वाली ऑब्जेक्ट्स की सूची।	false
`route`	string	वह रूट जिस पर यह मूल्य निर्धारण लागू होता है।	false
`countrycode`	string	दो-अक्षर का ISO देश कोड जिस पर संबंधित रूट के लिए यह मूल्य निर्धारण लागू होता है, यदि कोई हो।	true
`countryname`	string	देश कोड के अनुरूप अंग्रेजी देश का नाम, यदि कोई हो।	true
`mccmnc`	string	MCCMNC जिस पर संबंधित रूट के लिए यह मूल्य निर्धारण लागू होता है, यदि कोई हो। देश-स्तरीय मूल्य निर्धारण को ओवरराइड करता है।	true
`cns`	string	डायलिंग प्रीफिक्स जिस पर संबंधित रूट के लिए यह मूल्य निर्धारण लागू होता है, यदि कोई हो। देश-स्तरीय मूल्य निर्धारण और MCCMNC-स्तरीय मूल्य निर्धारण को ओवरराइड करता है।	true
`route_type`	string	संबंधित रूट प्रकार, अर्थात `HLR`, `MNP`, `NT`।	false
`route_type`	string	EUR में संबंधित मूल्य।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/balanceसुरक्षित

यह एंडपॉइंट आपका वर्तमान खाता शेष प्राप्त करता है, जिससे आप अपनी क्रेडिट स्थिति के आधार पर प्रक्रियाओं को स्वचालित कर सकते हैं। यह कम क्रेडिट सूचना ईमेल के साथ निर्बाध रूप से काम करता है जिसे आप अपने भुगतान पृष्ठ पर कॉन्फ़िगर कर सकते हैं।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

{
    "balance":"1002.90"
}

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`balance`	string	EUR में आपका वर्तमान खाता शेष। स्ट्रिंग प्रकार का दशमलव मान।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/pingसार्वजनिक

यह एंडपॉइंट API को पिंग अनुरोध भेजता है, जो HLR Lookups API से आपके कनेक्शन का परीक्षण करने के लिए एक सरल तरीका प्रदान करता है।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

{
    "success":true
}

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`success`	boolean	यह दर्शाता है कि अनुरोध सफलतापूर्वक संसाधित किया गया।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/timeसार्वजनिक

यह एंडपॉइंट HLR Lookups सर्वर पर वर्तमान समय को दर्शाने वाला Unix टाइमस्टैम्प लौटाता है। प्रमाणीकरण के लिए Digest-Auth सिग्नेचर जनरेट करते समय अपने सर्वर की घड़ी को सिंक्रोनाइज़ करने के लिए इसका उपयोग करें, जिससे आपके सर्वर समय और HLR Lookups सर्वर समय के बीच किसी भी विसंगति को ठीक किया जा सके।

अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

{
    "time":1525898643
}

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`time`	integer	वर्तमान HLR Lookups सर्वर समय को दर्शाने वाला Unix टाइमस्टैम्प।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

GET/auth-testसुरक्षित

यह एंडपॉइंट आपके Basic-Auth या, बेहतर रूप से, Digest-Auth कार्यान्वयन के लिए प्रारंभिक परीक्षण के रूप में कार्य करता है।

Basic Auth अनुरोध Digest Auth अनुरोध सफलता प्रतिक्रिया त्रुटि प्रतिक्रिया

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

अनुरोध हेडर्स

Key	प्रकार	विवरण
`X-Basic`	string	`YOUR_API_KEY:YOUR_API_SECRET` का SHA256 hash। 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"

अनुरोध हेडर्स

Key	प्रकार	विवरण
`X-Digest-Key`	string	आपकी HLR Lookups API कुंजी
`X-Digest-Signature`	string	विशिष्ट Digest-Auth हस्ताक्षर (प्रमाणीकरण देखें)
`X-Digest-Timestamp`	integer	वर्तमान Unix टाइमस्टैम्प (`GET /time` भी देखें)

{
    "success":true
}

सफलता प्रतिक्रिया विशेषताएं

नाम	प्रकार	विवरण	शून्य योग्य
`success`	boolean	यह दर्शाता है कि अनुरोध सफलतापूर्वक संसाधित किया गया।	false

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

त्रुटि प्रतिक्रिया पैरामीटर

नाम	प्रकार	विवरण	शून्य योग्य
`errors[]`	string[]	त्रुटि की व्याख्या करने वाली स्ट्रिंग्स की सूची।	false

ऊपर स्क्रॉल करें

लीगेसी API दस्तावेज़

कृपया ध्यान दें कि लीगेसी API को बंद कर दिया गया है और भविष्य में इसे समाप्त करने की योजना है। हम आपसे अनुरोध करते हैं कि जल्द से जल्द नवीनतम संस्करण में अपग्रेड करें।

यदि आपने 2013 और 2020 की शुरुआत के बीच हमारे HLR Lookups API को लागू किया है, तो आप हमारे लीगेसी API का उपयोग कर रहे हैं। उस स्थिति में कृपया हमारे लीगेसी API दस्तावेज़ को देखें।

लीगेसी API दस्तावेज़

API दस्तावेज़ीकरण

शुरुआत करें

HLR लुकअप्स

MNP लुकअप्स

NT लुकअप्स

रूटिंग

मूल्य निर्धारण

टूल्स

शुरुआत करें

HLR लुकअप्स API का उपयोग

उदाहरण अनुरोध

उदाहरण पेलोड

सफलता प्रतिक्रिया application/json

अतिरिक्त लुकअप सेवाएं

मोबाइल नंबर पोर्टेबिलिटी (MNP) लुकअप

नंबर प्रकार पहचान (NT) लुकअप

सॉफ्टवेयर डेवलपमेंट किट (SDK)

टूल्स

डेवलपर नहीं हैं?

प्रमाणीकरण

API Key और API Secret

HTTP Basic Auth

अनुशंसित: SHA256 के साथ X-Basic हेडर

Basic Auth अनुरोध

Basic Authentication हेडर्स

कोड उदाहरण

अनुरोध उदाहरण

अनुरोध हेडर्स

Signature का निर्माण

Digest Signature घटक

कोड उदाहरण

अवधारणाएं

सिंक्रोनस HLR लुकअप API

एसिंक्रोनस HLR लुकअप API

SDK (सॉफ्टवेयर डेवलपमेंट किट)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupसुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर

POST/hlr-lookupsसुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर

वेबहुक प्रोसेसिंग

प्रमाणीकरण

कोड उदाहरण

प्राप्ति की पुष्टि

वेबहुक पेलोड

वेबहुक पेलोड विशेषताएं

POST/mnp-lookupसुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर

POST/mnp-lookupsसुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर

वेबहुक प्रोसेसिंग

प्रमाणीकरण

कोड उदाहरण

प्राप्ति की पुष्टि

वेबहुक पेलोड

वेबहुक पेलोड विशेषताएं

POST/nt-lookupसुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर

POST/nt-lookups सुरक्षित

पेलोड

रिक्वेस्ट पैरामीटर

सफलता प्रतिक्रिया विशेषताएं

त्रुटि प्रतिक्रिया पैरामीटर