Başlarken

Küresel mobil ağ altyapısı, SS7 sinyal ağı olarak bilinen bir sistem üzerinde çalışır. Bu ağ, operatörler arasında abone verilerinin değişimi, çağrı yönlendirme, SMS iletimi ve gerçek zamanlı mobil bağlantı durumu güncellemelerini kolaylaştırır. Her mobil ağ, aboneleri hakkında temel bilgileri depolayan bir çekirdek veritabanı olan Home Location Register (HLR) tutar.

HLR Lookup teknolojisi, işletmelerin bu kayıtları sorgulamasını ve herhangi bir cep telefonu numarası için canlı bağlantı ve ağ bilgilerini almasını sağlar. Bu bilgiler telefonun açık olup olmadığını, şu anda hangi ağa atandığını, taşınıp taşınmadığını, numaranın geçerli veya devre dışı olup olmadığını ve dolaşımda olup olmadığını içerir.

HLR Lookups API, bu verilere kesintisiz ve gerçek zamanlı erişim sağlayarak işletmelerin mobil numaraları doğrulamasına, yönlendirmeyi optimize etmesine ve müşteri iletişimini geliştirmesine olanak tanır. Bu dokümantasyon, HLR Lookups'ı yazılımınıza entegre etme ve gerçek zamanlı mobil istihbaratın otomatik olarak alınmasını sağlama konusunda size rehberlik edecektir.

HLR Lookups API Kullanımı

HLR Lookup sorgularını yürütmek hızlı, güvenli ve basittir. Kayıt olduktan ve API Anahtarınızı aldıktan sonra, kimlik doğrulama yapabilir ve POST /hlr-lookup ile basit HTTP POST istekleri aracılığıyla anında sorgular başlatabilirsiniz. Alternatif olarak, kavramlar bölümünde açıklandığı gibi, sonuçların webhook aracılığıyla sunucunuza geri gönderildiği hızlı asenkron API isteklerini tercih ederek büyük veri setlerini işleyebilirsiniz.

Örnek İstek

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"

Kimlik doğrulama HTTP başlıkları aracılığıyla sağlanır ve payload.json (en azından) aşağıdaki JSON nesnesini içermelidir:

Örnek Payload

{
   "msisdn": "+14156226819"
}

Başarılı bir şekilde yürütüldükten sonra, belirtilen mobil numara için gerçek zamanlı bağlantı bilgilerini içeren bir yanıt alacaksınız.

Başarılı Yanıt 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"
}

İstek ve yanıt özniteliklerinin ve bağlantı durumlarının tam dökümü için POST /hlr-lookup bölümüne bakın.

Ek Sorgulama Hizmetleri

Mobil Numara Taşınabilirliği (MNP) Sorgulamaları

Gerçek zamanlı bağlantıyı sorgulamadan ağ sahipliği ve taşınabilirlik bilgilerini belirlemek için MNP sorgularını kullanın. Yalnızca bir numaranın MCCMNC bilgisine ihtiyacınız varsa, POST /mnp-lookup bölümüne bakın.

Numara Türü Tespiti (NT) Sorgulamaları

Bir telefon numarasının sabit hat, mobil, ücretli arama, VoIP, çağrı cihazı veya diğer numaralama planı aralıklarından birine ait olup olmadığını POST /nt-lookup ile belirleyin.

Yazılım Geliştirme Kitleri (SDK'lar)

HLR Lookups API, herhangi bir programlama dilindeki herhangi bir REST istemcisi ile çalışır ve hızlı başlamanıza yardımcı olmak için GitHub üzerinde PHP, Ruby ve NodeJS için SDK'lar yayınladık.

Araçlar

Sorunsuz bir geliştirme deneyimi sağlamak için tarayıcı içi API isteği ve webhook izleme, IP adresi beyaz listesi, güçlü kimlik doğrulama seçenekleri ve bir kimlik doğrulama test endpoint'i dahil olmak üzere kapsamlı bir araç paketi sunuyoruz.

Geliştirici Değil misiniz?

HLR Sorgulamaları ve Numara Taşınabilirliği Sorguları herhangi bir kodlama yapmadan gerçekleştirilebilir. Kurumsal web istemcimiz ve tarayıcı tabanlı raporlama özelliklerimiz hakkında daha fazla bilgi edinin.

Kimlik Doğrulama

Güvenliği ve uygun erişim kontrolünü sağlamak için HLR Lookups API'ye yapılan çoğu istek kimlik doğrulama gerektirir. Uç noktalar genel veya korumalı olarak kategorize edilir. Korumalı bir uç noktaya erişirken, isteğinizin API anahtarınız ve gizli anahtarınız kullanılarak Digest-Auth veya Basic-Auth yöntemiyle doğrulanması gerekir. Digest-Auth daha güvenli seçenektir ve şiddetle önerilir. Kimlik doğrulama kurulumunuzu doğrulamak için GET /auth-test uç noktasını kullanın.

API Anahtarı ve API Gizli Anahtarı

API anahtarınızı ve gizli anahtarınızı API ayarları sayfasından alın. Tercih ettiğiniz kimlik doğrulama yöntemini yapılandırabilir ve gelişmiş güvenlik için IP adresi beyaz listesini etkinleştirebilirsiniz. API gizli anahtarınızın ele geçirildiğinden şüpheleniyorsanız, istediğiniz zaman yeni bir tane oluşturabilirsiniz.

API Anahtarını Alın
Basic Auth Digest Auth IP Beyaz Listesi

Standart Basic Authentication uygulaması kolaydır ve yaygın olarak desteklenir. API anahtarınızı ve gizli anahtarınızı HTTP isteğinde user:pass çifti olarak ileterek kimlik doğrulama yapabilirsiniz.

HTTP Basic Auth

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

Bu, bir Authorization başlığı gönderir:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Önerilen: SHA256 ile X-Basic Başlığı

Gelişmiş güvenlik için, kimlik bilgilerinizi doğrudan base64 olarak iletmek yerine SHA256 hash'ini gönderebilirsiniz. Bu yöntemi kullanmak için YOUR_API_KEY:YOUR_API_SECRET çiftinizin hash'ini hesaplayın ve X-Basic başlığı aracılığıyla gönderin:

Basic Auth İsteği

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

Basic Authentication Başlıkları

Anahtar Tür Açıklama
X-Basic string YOUR_API_KEY:YOUR_API_SECRET değerinin SHA256 hash'i. Hash'e iki nokta üst üste (:) sembolünü dahil edin. zorunlu

PHP Kod Örneği

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

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

Digest-Auth, korumalı HLR Lookup API uç noktalarına erişimi güvence altına almak için önerilen yöntemdir. Her istek şu başlıkları içermelidir: X-Digest-Key, X-Digest-Signature ve X-Digest-Timestamp. Bunlar aşağıda açıklanmıştır.

İstek Örneği

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"

İstek Başlıkları

Anahtar Tür Açıklama
X-Digest-Key string Benzersiz HLR Lookups API Anahtarınız. zorunlu
X-Digest-Signature string Benzersiz bir kimlik doğrulama imzası (aşağıya bakın). zorunlu
X-Digest-Timestamp integer Geçerli Unix zaman damgası (ayrıca GET /time bölümüne bakın). zorunlu

İmzanın Oluşturulması

X-Digest-Signature, API gizli anahtarınız paylaşılan anahtar olarak kullanılarak bir SHA256 HMAC hash'i ile oluşturulur.

Hash'lenecek dize aşağıdaki gibi yapılandırılır:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. sembolü dize birleştirmeyi temsil eder.

Digest İmza Bileşenleri

Bileşen Tür Açıklama
ENDPOINT_PATH string İstenen API uç noktası, örneğin küçük harflerle /auth-test.
UNIX_TIMESTAMP integer Geçerli Unix zaman damgası (30 saniye içinde olmalıdır). GET /time bölümüne bakın.
REQUEST_METHOD string Kullanılan HTTP yöntemi, örneğin POST veya GET.
REQUEST_BODY string İstek gövdesi verileri. GET istekleri için null olarak ayarlayın.

Kod Örnekleri

PHP PHP NodeJS NodeJS Ruby 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)

Gelişmiş güvenlik için erişimi belirli IP adreslerine kısıtlamak üzere API Ayarları bölümünü kullanın. Bu, özellikle üretim ortamlarında önerilir.

Yukarı Kaydır

Kavramlar

HTTP REST API'miz aracılığıyla HLR Sorgularını herhangi bir programlama dilinde veya sistemde uygulamak basit ve verimlidir. Kolay entegrasyon süreci sayesinde, telefon numarası geçerliliği, bağlantı durumu ve yönlendirme detayları hakkında anlık bilgiler elde etmek için mobil ağları gerçek zamanlı olarak sorgulamaya hemen başlayabilirsiniz.

Uygun API'yi seçmek, özel kullanım senaryonuza bağlıdır. VoIP telefon, dolandırıcılık tespiti veya SMS yönlendirme gibi uygulamalar için gerçek zamanlı sorgulama sonuçlarına ihtiyacınız varsa, senkron API en iyi seçenektir. Ancak, kullanım senaryonuz yüksek hacimli işleme, toplu sorgulama veya büyük ölçekli veri doğrulamayı içeriyorsa, asenkron API bant genişliği verimliliği ve toplu sorgulama yetenekleriyle optimize edilmiş performans sunar.

Hız, doğruluk ve maliyet etkinliğini optimize etmek için API'yi özel yönlendirme seçeneklerimizden birini kullanacak şekilde yapılandırın. Ayrıca, kolay CSV ve JSON rapor indirmeleri ile web arayüzü üzerinden gelişmiş analizler için sorgulama sonuçlarını depolama alanlarında saklayabilirsiniz.

Senkron HLR Sorgulama API'si

POST /hlr-lookup uç noktası, istek başına bir mobil telefon numarasını (MSISDN) işler ve sonuçları HTTP yanıt gövdesinde anında döndürür. Sonuçlar JSON formatında biçimlendirilir ve mobil numara doğrulama, çağrı yönlendirme ve SMS mesaj iletimi dahil olmak üzere gerçek zamanlı uygulamalar için idealdir.

Senkron API çağrısı, doğrudan bir HTTP isteği ve yanıtından oluşur. Sisteminiz istek başına tek bir MSISDN (mobil numara) gönderir ve JSON formatında gerçek zamanlı HLR sorgulama sonuçlarını içeren anında bir yanıt alır. Bu API, dolandırıcılık tespiti, VoIP çağrı yönlendirme ve SMS ağ geçidi optimizasyonu gibi anında doğrulama ve bağlantı kontrolleri gerektiren kullanım senaryoları için optimize edilmiştir.

Asenkron HLR Sorgulama API

POST /hlr-lookups uç noktası, toplu ve yüksek hacimli işleme için tasarlanmıştır ve istek başına 1,000 adede kadar MSISDN göndermenize olanak tanır. Bu API, sonuçları anında döndürmek yerine, otomatik webhook'lar kullanarak sonuçları sunucunuza aşamalı olarak gönderir. Sorgulama sonuçları, HTTP POST geri çağrıları aracılığıyla JSON nesneleri olarak döndürülür.

Asenkron API, hız, verimlilik ve ölçeklenebilirlik için optimize edilmiştir. Senkron çağrılarla ilişkili ağ gecikmesi sorunlarını ortadan kaldırarak, yüksek verimli sorgulamalara ihtiyaç duyan işletmeler için ideal hale gelir. Sisteminiz istek başına 1,000 adede kadar MSISDN gönderir ve platformumuz bunları paralel olarak işleyerek, geri çağrı başına 1,000 adede kadar sonuç içeren gruplar halinde HTTP webhook'lar aracılığıyla sunucunuza geri iletir.

SDK'lar (Yazılım Geliştirme Kitleri)

PHP, NodeJS ve Ruby için Yazılım Geliştirme Kitlerimiz (SDK'lar), entegrasyon sürecini kolaylaştırarak HLR Lookups API'sine verimli ve minimum çabayla bağlanmanızı sağlar.

Bu SDK'lar, önceden hazırlanmış fonksiyonlar, kimlik doğrulama yönetimi ve yapılandırılmış API istek şablonları sunarak geliştirme süresini kısaltır ve en iyi uygulamaları garanti eder.

Mevcut SDK'ların tam listesini GitHub üzerinden keşfedin ve hemen entegre etmeye başlayın.

PHP PHP NodeJS NodeJS Ruby Ruby
PHP Logosu

PHP SDK

PHP için Anında API Entegrasyonu
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);
NodeJS Logosu

NodeJS SDK

NodeJS için Anında API Entegrasyonu
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   }
Ruby Logosu

Ruby SDK

Ruby için Anında API Entegrasyonu
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)
Yukarı Kaydır

POST/hlr-lookupkorumalı

Senkron HLR Sorgulama gerçekleştirerek, mobil telefon bağlantı ve taşınabilirlik verilerini doğrudan ağ operatörlerinden gerçek zamanlı olarak sunar. Bu endpoint, bir telefon numarasının şu anda ulaşılabilir (bağlı) veya ulaşılamaz (kapalı) durumda olup olmadığının anında doğrulanmasını gerektiren zamana duyarlı uygulamalar için canlı trafik senaryolarında idealdir. Ayrıca, aktif numaraları geçersiz, bilinmeyen veya sahte numaralardan ayırt etmeye yardımcı olur.

Anında sonuç gerektirmeyen büyük veri setlerinin toplu işlenmesi için, yüksek hızlı toplu işleme için optimize edilmiş asenkron POST /hlr-lookups kullanımını değerlendirebilirsiniz.

Birincil odak noktanız mobil numara taşınabilirlik verilerini (MCCMNC) almaksa ve canlı bağlantı durumuna ihtiyacınız yoksa, POST /mnp-lookup mobil numara taşınabilirlik sorguları için uygun maliyetli bir alternatif sunar.

İstek Başarılı Yanıt Hata Yanıtı Durum Referansı
curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookup' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdn string Sorgulanacak mobil telefon numarası (MSISDN), uluslararası formatta sağlanmalıdır (örn. +14156226819 veya 0014156226819). Ülke kodları dahil edilmelidir. null zorunlu
route string(3) Bu sorgulama için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu sorgulama için en iyi rotayı otomatik olarak belirlemesine izin vermek için null olarak ayarlayın veya bu parametreyi atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
   "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"
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgulama isteğine atanan benzersiz tanımlayıcı. false
msisdn string Sorgulanan cep telefonu numarası, uluslararası formatta (örn. +14156226819 veya 0014156226819). false
connectivity_status string Numaranın bağlantı durumunun başarıyla alınıp alınmadığını gösterir. Olası değerler: CONNECTED , ABSENT , INVALID_MSISDN veya UNDETERMINED . false
mccmnc string(5|6) Telefon numarasıyla ilişkili mevcut ağı tanımlayan beş veya altı haneli Mobil Ülke Kodu (MCC) ve Mobil Şebeke Kodu (MNC). true
mcc string(3) Telefon numarasının kayıtlı olduğu ülkeyi tanımlayan üç haneli Mobil Ülke Kodu (MCC). true
mnc string(2|3) Telefon numarasının ait olduğu belirli ağı tanımlayan iki veya üç haneli Mobil Şebeke Kodu (MNC). true
imsi string Bu numarayla ilişkili SIM kart için benzersiz tanımlayıcı olan Uluslararası Mobil Abone Kimliği (IMSI). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
msin string(10) Mobil operatörün veritabanındaki Mobil Abonelik Tanımlama Numarası (MSIN). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
msc string(12) Bu abonenin iletişimini şu anda yöneten Mobil Santral (MSC). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
original_network_name string Bu numarayla ilişkili orijinal (yerel) ağ operatörü adı. true
original_country_name string Cep telefonu numarasının ilk kayıt edildiği ülkenin tam adı, İngilizce olarak sağlanır. true
original_country_code string(2) Telefon numarasının ilk atandığı ülkeyi temsil eden iki karakterli ISO ülke kodu. true
original_country_prefix string Cep telefonu numarasının orijinal ülkesine karşılık gelen uluslararası arama kodu (ülke çağrı kodu). true
is_ported boolean Mobil numaranın orijinal ağından farklı bir operatöre taşınıp taşınmadığını gösterir. true
ported_network_name string Mobil numaranın taşındığı ağ operatörünün adı (varsa). true
ported_country_name string Mobil numaranın taşındığı ülkenin adı (varsa). true
ported_country_code string(2) Mobil numaranın taşındığı ülkeyi temsil eden iki karakterli ISO ülke kodu (varsa). true
ported_country_prefix string Mobil numaranın taşındığı ülke için uluslararası arama kodu (ülke çağrı kodu) (varsa). true
is_roaming boolean Mobil numaranın şu anda yabancı bir ağda dolaşımda olup olmadığını gösterir. Dolaşım durumu kullanılabilirliği, mobil ağ operatörüne bağlıdır. true
roaming_network_name string Mobil numaranın şu anda dolaşımda olduğu ağın adı (varsa). true
roaming_country_name string Mobil numaranın şu anda dolaşımda olduğu ülkenin adı (varsa). true
roaming_country_code string(2) Mobil numaranın şu anda dolaşımda olduğu ülkenin iki karakterli ISO ülke kodu (varsa). true
roaming_country_prefix string Mobil numaranın şu anda dolaşımda olduğu ülkenin uluslararası arama kodu (ülke çağrı kodu) (varsa). true
cost string Sorgulama maliyetini EUR cinsinden gösteren, dize olarak temsil edilen ondalık değer. true
timestamp string Sorgulamanın tamamlandığı zamanı belirten, saat dilimi içeren W3C formatında zaman damgası. true
storage string Sorgulama sonuçlarının kaydedildiği depolama alanının adı. Bu, web arayüzü üzerinden erişilebilen rapor adlarına ve CSV indirmelerine karşılık gelir. true
route string(3) Bu sorgulama isteği için kullanılan yönlendirme yöntemini gösteren üç karakterli tanımlayıcı. true
processing_status string Sorgulamanın işlem sonucu. Olası değerler: COMPLETED (başarılı), REJECTED (ağa ulaşılamıyor, ücret alınmadı) veya FAILED (işlem sırasında hata oluştu). false
error_code integer Müşteri desteği için ek tanı bilgisi sağlayan isteğe bağlı dahili hata kodu. true
error_description string Verilen hata kodunun (varsa) İngilizce düz metin olarak kısa açıklaması. true
data_source string Bu istek için kullanılan veri kaynağı. Olası değerler: LIVE_HLR (gerçek zamanlı HLR sorgusu) veya MNP_DB (statik mobil numara taşınabilirliği veritabanı). Ayrıntılar için yönlendirme seçeneklerine bakın. false
routing_instruction string İstekte kullanılan yönlendirme talimatını açıklayan iki nokta üst üste ile ayrılmış dize. İlk bileşen, bir rota belirttiğinizde STATIC veya otomatik yönlendirme için AUTO'dur; ikinci bileşen rota tanımlayıcısıdır ve otomatik yönlendirme istekleri için üçüncü bileşen, yönlendirme kararının dayandığı kaynağı gösterir (yani 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."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Durum Açıklama
CONNECTED Numara geçerlidir ve hedef cihaz şu anda mobil ağa bağlıdır. Aramalar, SMS ve diğer hizmetler alıcıya başarıyla ulaşmalıdır.
ABSENT Numara geçerlidir ancak hedef cihaz kapalı veya geçici olarak kapsama alanı dışındadır. Mesajlar veya aramalar, cihaz ağa yeniden bağlanana kadar iletilemeyebilir.
INVALID_MSISDN Numara geçersizdir veya şu anda mobil ağda herhangi bir aboneye atanmamıştır. Bu numaraya yapılan aramalar ve mesajlar başarısız olacaktır.
UNDETERMINED Numaranın bağlantı durumu belirlenemedi. Bu durum geçersiz bir numara, SS7 hata yanıtı veya hedef ağ operatörü ile bağlantı eksikliğinden kaynaklanabilir. Ek tanı bilgileri için hata kodunu ve açıklama alanını inceleyin.
Yukarı Kaydır

POST/hlr-lookupskorumalı

Ağ operatörlerinden canlı mobil telefon bağlantısı ve taşınabilirlik verilerini alarak, toplu asenkron HLR sorgularını başlatır. Sonuçlar webhook'lar aracılığıyla sunucunuza iletilir. Bu yöntem, veritabanı temizleme ve doğrulama gibi anında yanıt gerektirmeyen büyük hacimli numara işlemleri için optimize edilmiştir. Çağrı yönlendirme veya SMS iletimi gibi gerçek zamanlı uygulamalar için bunun yerine POST /hlr-lookup endpoint'ini kullanmayı değerlendirebilirsiniz.

Bu endpoint, geçersiz, atanmamış veya sahte numaraları filtrelerken şu anda ulaşılabilir (bağlı) veya ulaşılamaz (telefon kapalı) telefon numaralarını belirleme amacı taşıyan toplu işlemler için idealdir. Ayrıca, bağlantı detaylarının yanı sıra canlı taşınabilirlik durumunu (MCCMNC) da sağlar.

Bu endpoint'i kullanmadan önce, sorgulama sonuçlarını asenkron olarak almak için bir webhook URL'sinin yapılandırıldığından emin olun. API ayarlarınızdan bu yapılandırmayı gerçekleştirebilirsiniz.

İstek Başarılı Yanıt Hata Yanıtı Webhook'lar Durum Referansı
curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookups' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdns array Uluslararası formatta (örn. +14156226819 veya 0014156226819) mobil telefon numaralarından (MSISDN) oluşan bir dizi. Her istek için en fazla 1000 numara ekleyebilirsiniz. null zorunlu
route string(3) Bu sorgulama için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu sorgulama için en iyi rotayı otomatik olarak belirlemesine izin vermek için null olarak ayarlayın veya bu parametreyi atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
   "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"
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
accepted array İşleme kabul edilen benzersiz tanımlayıcılar ve MSISDN'leri içeren nesnelerin listesi. false
accepted_count integer İşleme başarıyla kabul edilen toplam MSISDN sayısı. false
rejected array Genellikle geçersiz numaralar nedeniyle işleme reddedilen benzersiz tanımlayıcılar ve MSISDN'leri içeren nesnelerin listesi. Reddedilen kayıtlar için ücret alınmaz. false
rejected_count integer Doğrulama hataları nedeniyle reddedilen toplam MSISDN sayısı. false
total_count integer İşleme gönderilen kabul edilen ve reddedilen MSISDN'lerin toplam sayısı. false
cost string Kabul edilen sorgular için EUR cinsinden toplam maliyeti gösteren, dize olarak temsil edilen ondalık değer. false
storage string Sorgulama sonuçlarının eklendiği depolama alanının adı, web arayüzü üzerinden raporlama ve CSV indirmeleri için kullanılır. false
route string(3|4) Bu sorgulama isteği için kullanılan rotayı belirten üç veya dört karakterli tanımlayıcı. Numara tabanlı otomatik yönlendirme talep edildiyse AUTO içerir. false
webhook_urls array API ayarlarınızda yapılandırılan webhook URL'leri. Sonuçlar buraya geri gönderilir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false

Webhook İşleme

Gönderildikten sonra platformumuz sağlanan telefon numaralarını işlemeye başlar ve sonuçları sunucunuzda önceden belirtilen webhook URL'sine gönderir. Sonuçlar, istek gövdesinde JSON nesnesi içeren bir HTTP POST isteği olarak iletilir.

Kimlik Doğrulama

X-Signatures HTTP başlığını inceleyerek webhook'u doğrulayın.

X-Signatures başlığı, noktalı virgülle ayrılmış bir imza listesi içerir. Listedeki her imza, hesabınızda yapılandırılmış API gizli anahtarlarından biri kullanılarak oluşturulur. Webhook'u doğrulamak için API anahtarınızı, gizli anahtarınızı ve ham HTTP gövdesini kullanarak bir SHA-256 hash oluşturun, ardından bunu listedeki imzalarla karşılaştırın.

Eşleşme, isteğin özgün olduğunu ve kontrolünüz altındaki bir gizli anahtarla imzalandığını doğrular.

PHP Kod Örneği

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

Başlıkta verilen imzalardan herhangi biri, API anahtarınız, gizli anahtarınız ve HTTP gövdesinin birleştirilmiş dizesi üzerinden hesaplanan SHA256 hash ile eşleşiyorsa istek geçerlidir.

Alındı Onayı

Sunucunuzun başarılı alımı onaylamak için 200 OK HTTP durum koduyla yanıt vermesi beklenir. Başka bir yanıt kodu döndürülürse, zaman aşımı meydana gelirse (10 saniye) veya başka bir teslimat sorunu ortaya çıkarsa, sistem bir dakika sonra webhook'u otomatik olarak yeniden deneyecektir. İstek başarısız olmaya devam ederse, yeniden denemeler üstel geri çekilme stratejisi izleyecek ve sonraki denemeler 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 dakika sonra yapılacaktır.

Bu yeniden deneme mekanizması, sorgulama sonuçlarının altyapınıza teslim edilmesinde maksimum güvenilirlik sağlar. Geçici ağ sorunları veya sunucu kesintileri nedeniyle veri kaybı riskini en aza indirir.

Webhook Yükü

{
   "type":"HLR",
   "results":[
      {
         "id":"3b4ac4b6ed1b",
         "msisdn":"+905536939460",
         "connectivity_status":"CONNECTED",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "imsi":"28603XXXXXXXXXX",
         "msin":"XXXXXXXXXX",
         "msc":"XXXXXXXXXX",
         "original_network_name":"Turk Telekom (AVEA)",
         "original_country_name":"Turkey",
         "original_country_code":"TR",
         "original_country_prefix":"+90",
         "is_ported":false,
         "ported_network_name":null,
         "ported_country_name":null,
         "ported_country_code":null,
         "ported_country_prefix":null,
         "is_roaming":false,
         "roaming_network_name":null,
         "roaming_country_name":null,
         "roaming_country_code":null,
         "roaming_country_prefix":null,
         "cost":"0.0100",
         "timestamp":"2020-08-13 00:04:38.261+0300",
         "storage":"ASYNC-API-2020-08",
         "route":"IP1",
         "processing_status":"COMPLETED",
         "error_code":null,
         "error_description":null,
         "data_source":"LIVE_HLR",
         "routing_instruction":"STATIC:IP1"
      }
   ]
}

Webhook Yük Özellikleri

JSON nesnesi, aşağıda belgelenen sorgulama nesnelerinin listesini içeren results özelliğinin yanı sıra type => HLR özelliğini içerir.

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgulama isteğine atanan benzersiz tanımlayıcı. false
msisdn string Sorgulanan cep telefonu numarası, uluslararası formatta (örn. +14156226819 veya 0014156226819). false
connectivity_status string Numaranın bağlantı durumunun başarıyla alınıp alınmadığını gösterir. Olası değerler: CONNECTED , ABSENT , INVALID_MSISDN veya UNDETERMINED . false
mccmnc string(5|6) Telefon numarasıyla ilişkili mevcut ağı tanımlayan beş veya altı haneli Mobil Ülke Kodu (MCC) ve Mobil Şebeke Kodu (MNC). true
mcc string(3) Telefon numarasının kayıtlı olduğu ülkeyi tanımlayan üç haneli Mobil Ülke Kodu (MCC). true
mnc string(2|3) Telefon numarasının ait olduğu belirli ağı tanımlayan iki veya üç haneli Mobil Şebeke Kodu (MNC). true
imsi string Bu numarayla ilişkili SIM kart için benzersiz tanımlayıcı olan Uluslararası Mobil Abone Kimliği (IMSI). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
msin string(10) Mobil operatörün veritabanındaki Mobil Abonelik Tanımlama Numarası (MSIN). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
msc string(12) Bu abonenin iletişimini şu anda yöneten Mobil Santral (MSC). Kullanılabilirlik, ağ yapılandırmasına bağlıdır. true
original_network_name string Bu numarayla ilişkili orijinal (yerel) ağ operatörü adı. true
original_country_name string Cep telefonu numarasının ilk kayıt edildiği ülkenin tam adı, İngilizce olarak sağlanır. true
original_country_code string(2) Telefon numarasının ilk atandığı ülkeyi temsil eden iki karakterli ISO ülke kodu. true
original_country_prefix string Cep telefonu numarasının orijinal ülkesine karşılık gelen uluslararası arama kodu (ülke çağrı kodu). true
is_ported boolean Mobil numaranın orijinal ağından farklı bir operatöre taşınıp taşınmadığını gösterir. true
ported_network_name string Mobil numaranın taşındığı ağ operatörünün adı (varsa). true
ported_country_name string Mobil numaranın taşındığı ülkenin adı (varsa). true
ported_country_code string(2) Mobil numaranın taşındığı ülkeyi temsil eden iki karakterli ISO ülke kodu (varsa). true
ported_country_prefix string Mobil numaranın taşındığı ülke için uluslararası arama kodu (ülke çağrı kodu) (varsa). true
is_roaming boolean Mobil numaranın şu anda yabancı bir ağda dolaşımda olup olmadığını gösterir. Dolaşım durumu kullanılabilirliği, mobil ağ operatörüne bağlıdır. true
roaming_network_name string Mobil numaranın şu anda dolaşımda olduğu ağın adı (varsa). true
roaming_country_name string Mobil numaranın şu anda dolaşımda olduğu ülkenin adı (varsa). true
roaming_country_code string(2) Mobil numaranın şu anda dolaşımda olduğu ülkenin iki karakterli ISO ülke kodu (varsa). true
roaming_country_prefix string Mobil numaranın şu anda dolaşımda olduğu ülkenin uluslararası arama kodu (ülke çağrı kodu) (varsa). true
cost string Sorgulama maliyetini EUR cinsinden gösteren, dize olarak temsil edilen ondalık değer. true
timestamp string Sorgulamanın tamamlandığı zamanı belirten, saat dilimi içeren W3C formatında zaman damgası. true
storage string Sorgulama sonuçlarının kaydedildiği depolama alanının adı. Bu, web arayüzü üzerinden erişilebilen rapor adlarına ve CSV indirmelerine karşılık gelir. true
route string(3) Bu sorgulama isteği için kullanılan yönlendirme yöntemini gösteren üç karakterli tanımlayıcı. true
processing_status string Sorgulamanın işlem sonucu. Olası değerler: COMPLETED (başarılı), REJECTED (ağa ulaşılamıyor, ücret alınmadı) veya FAILED (işlem sırasında hata oluştu). false
error_code integer Müşteri desteği için ek tanı bilgisi sağlayan isteğe bağlı dahili hata kodu. true
error_description string Verilen hata kodunun (varsa) İngilizce düz metin olarak kısa açıklaması. true
data_source string Bu istek için kullanılan veri kaynağı. Olası değerler: LIVE_HLR (gerçek zamanlı HLR sorgusu) veya MNP_DB (statik mobil numara taşınabilirliği veritabanı). Ayrıntılar için yönlendirme seçeneklerine bakın. false
routing_instruction string İstekte kullanılan yönlendirme talimatını açıklayan iki nokta üst üste ile ayrılmış dize. İlk bileşen, bir rota belirttiğinizde STATIC veya otomatik yönlendirme için AUTO'dur; ikinci bileşen rota tanımlayıcısıdır ve otomatik yönlendirme istekleri için üçüncü bileşen, yönlendirme kararının dayandığı kaynağı gösterir (yani 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
Durum Açıklama
CONNECTED Numara geçerlidir ve hedef cihaz şu anda mobil ağa bağlıdır. Aramalar, SMS ve diğer hizmetler alıcıya başarıyla ulaşmalıdır.
ABSENT Numara geçerlidir ancak hedef cihaz kapalı veya geçici olarak kapsama alanı dışındadır. Mesajlar veya aramalar, cihaz ağa yeniden bağlanana kadar iletilemeyebilir.
INVALID_MSISDN Numara geçersizdir veya şu anda mobil ağda herhangi bir aboneye atanmamıştır. Bu numaraya yapılan aramalar ve mesajlar başarısız olacaktır.
UNDETERMINED Numaranın bağlantı durumu belirlenemedi. Bu durum geçersiz bir numara, SS7 hata yanıtı veya hedef ağ operatörü ile bağlantı eksikliğinden kaynaklanabilir. Ek tanı bilgileri için hata kodunu ve açıklama alanını inceleyin.
Yukarı Kaydır

POST/mnp-lookupkorumalı

Senkron bir MNP sorgulaması gerçekleştirir ve mobil numara taşınabilirliği ile ağ bilgilerini sağlar. Bu endpoint, belirli bir cep telefonu numarasının mevcut MCCMNC değerini çıkarmak ve orijinal ile güncel ağları gerçek zamanlı olarak tespit etmek birincil hedefinizse uygundur.

Anında sonuç gerektirmeyen büyük veri setlerinin toplu işlenmesi için, yüksek hızlı toplu işleme için optimize edilmiş asenkron POST /mnp-lookups kullanımını değerlendirebilirsiniz.

MNP sorgulamaları taşınabilirlik ve ağ bilgilerini güvenilir şekilde belirler ancak hedef cep telefonunun şu anda bir ağa bağlı ve erişilebilir olup olmadığını göstermez. Canlı bağlantı bilgilerini elde etmek için lütfen bunun yerine POST /hlr-lookup endpoint'ini kullanın.

İstek Başarılı Yanıt Hata Yanıtı
curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookup' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdn string Sorgulanacak mobil telefon numarası (MSISDN), uluslararası formatta sağlanmalıdır (örn. +14156226819 veya 0014156226819). Ülke kodları dahil edilmelidir. null zorunlu
route string(3) Bu sorgulama için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu sorgulama için en iyi rotayı otomatik olarak belirlemesine izin vermek için null olarak ayarlayın veya bu parametreyi atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
   "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
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgu için benzersiz 12 karakterlik tanımlayıcı. false
msisdn string Bu sorgu talebinde değerlendirilen mobil telefon numarası. false
query_status string Taşınabilirlik ve ağ bilgilerinin başarıyla alınıp alınmadığını gösterir. Olası değerler OK veya FAILED şeklindedir. false
mccmnc string(5|6) Mobil telefon numarasının şu anda ait olduğu ağı tanımlayan beş veya altı karakterli MCCMNC (mobil ülke kodu ve mobil ağ kodu çifti). true
mcc string(3) Mobil telefon numarasının mevcut ağıyla ilişkili ülkeyi temsil eden üç karakterli MCC (mobil ülke kodu). true
mnc string(2|3) Mobil telefon numarası için mevcut ağ operatörünü tanımlayan iki veya üç karakterli MNC (mobil ağ kodu). true
is_ported boolean Telefon numarasının orijinal ağından yeni bir operatöre taşınıp taşınmadığını gösterir. true
original_network_name string İncelenen mobil telefon numarasının orijinal ağ operatörü adını belirten rastgele bir metin (İngilizce). true
original_country_name string İncelenen mobil telefon numarasının orijinal ülkesini belirten rastgele bir metin (İngilizce). true
original_country_code string(2) İncelenen mobil telefon numarasının orijinal ülkesini temsil eden iki karakterli ISO ülke kodu. true
original_country_prefix string İncelenen mobil telefon numarasıyla ilişkili orijinal ülkenin çağrı kodu. true
ported_network_name string İncelenen mobil telefon numarasının taşındığı ağ operatörünü belirtir (varsa). true
ported_country_name string İncelenen mobil telefon numarasının taşındığı ülkeyi belirtir (varsa). true
ported_country_code string(2) İncelenen mobil telefon numarasının taşındığı ülkeyi temsil eden iki karakterli ISO ülke kodu (varsa). true
ported_country_prefix string İncelenen mobil telefon numarasının taşındığı ülkenin çağrı kodu (varsa). true
extra string Telefon numarası hakkında isteğe bağlı ek ayrıntılar sağlayan rastgele bir metin. true
cost string Bu sorgunun EUR cinsinden maliyetini gösteren, metin olarak temsil edilen ondalık değer. true
timestamp string Sorgunun tamamlandığı zamanı gösteren, saat dilimi bilgisini içeren W3C formatında zaman damgası. true
storage string Sorgu sonuçlarının eklendiği depolama adı (veya rapor adı). Bu, web arayüzü üzerinden CSV indirmeleri ve raporlama için kullanılır. true
route string(3) Bu sorgu talebi için kullanılan rotayı belirten üç karakterli tanımlayıcı. true
error_code integer Müşteri destek tanılamaları için ek bağlam sağlayan isteğe bağlı dahili hata kodu. true
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

POST/mnp-lookupskorumalı

Asenkron MNP (mobil numara taşınabilirliği) sorgularından oluşan bir toplu işlem başlatır, güncel MCCMNC'yi alır ve orijinal ile mevcut ağları gerçek zamanlı olarak belirler. Sonuçlar webhook'lar aracılığıyla sunucunuza iletilir. Bu yöntem, veritabanı temizleme ve doğrulama gibi anında yanıt gerektirmeyen büyük hacimli numara işlemleri için optimize edilmiştir. Çağrı yönlendirme veya SMS iletimi gibi gerçek zamanlı uygulamalar için bunun yerine POST /mnp-lookup endpoint'ini kullanmayı değerlendirebilirsiniz.

MNP sorgulamaları taşınabilirlik ve ağ bilgilerini güvenilir şekilde belirler ancak hedef cep telefonunun şu anda bir ağa bağlı ve erişilebilir olup olmadığını göstermez. Canlı bağlantı bilgilerini elde etmek için lütfen bunun yerine POST /hlr-lookups endpoint'ini kullanın.

Bu endpoint'i kullanmadan önce, sorgulama sonuçlarını asenkron olarak almak için bir webhook URL'sinin yapılandırıldığından emin olun. API ayarlarınızdan bu yapılandırmayı gerçekleştirebilirsiniz.

İstek Başarılı Yanıt Hata Yanıtı Webhook'lar
curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookups' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdns array Uluslararası formatta (örn. +14156226819 veya 0014156226819) mobil telefon numaralarından (MSISDN) oluşan bir dizi. Her istek için en fazla 1000 numara ekleyebilirsiniz. null zorunlu
route string(3) Bu sorgu için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu istek için en iyi rotaları otomatik olarak belirlemesine izin vermek için bu parametreyi null olarak ayarlayın veya atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
   "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"
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
accepted array İşleme kabul edilen benzersiz tanımlayıcılar ve MSISDN'leri içeren nesnelerin listesi. false
accepted_count integer İşleme başarıyla kabul edilen toplam MSISDN sayısı. false
rejected array Genellikle geçersiz numaralar nedeniyle işleme reddedilen benzersiz tanımlayıcılar ve MSISDN'leri içeren nesnelerin listesi. Reddedilen kayıtlar için ücret alınmaz. false
rejected_count integer Doğrulama hataları nedeniyle reddedilen toplam MSISDN sayısı. false
total_count integer İşleme gönderilen kabul edilen ve reddedilen MSISDN'lerin toplam sayısı. false
cost string Kabul edilen sorgular için EUR cinsinden toplam maliyeti gösteren, dize olarak temsil edilen ondalık değer. false
storage string Sorgulama sonuçlarının eklendiği depolama alanının adı, web arayüzü üzerinden raporlama ve CSV indirmeleri için kullanılır. false
route string(3) Bu sorgu talebi için kullanılan rotayı belirten üç karakterli tanımlayıcı. false
webhook_urls array API ayarlarınızda yapılandırılan webhook URL'leri. Sonuçlar buraya geri gönderilir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false

Webhook İşleme

Gönderildikten sonra platformumuz sağlanan telefon numaralarını işlemeye başlar ve sonuçları sunucunuzda önceden belirtilen webhook URL'sine gönderir. Sonuçlar, istek gövdesinde JSON nesnesi içeren bir HTTP POST isteği olarak iletilir.

Kimlik Doğrulama

X-Signatures HTTP başlığını inceleyerek webhook'u doğrulayın.

X-Signatures başlığı, noktalı virgülle ayrılmış bir imza listesi içerir. Listedeki her imza, hesabınızda yapılandırılmış API gizli anahtarlarından biri kullanılarak oluşturulur. Webhook'u doğrulamak için API anahtarınızı, gizli anahtarınızı ve ham HTTP gövdesini kullanarak bir SHA-256 hash oluşturun, ardından bunu listedeki imzalarla karşılaştırın.

Eşleşme, isteğin özgün olduğunu ve kontrolünüz altındaki bir gizli anahtarla imzalandığını doğrular.

PHP Kod Örneği

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

Başlıkta verilen imzalardan herhangi biri, API anahtarınız, gizli anahtarınız ve HTTP gövdesinin birleştirilmiş dizesi üzerinden hesaplanan SHA256 hash ile eşleşiyorsa istek geçerlidir.

Alındı Onayı

Sunucunuzun başarılı alımı onaylamak için 200 OK HTTP durum koduyla yanıt vermesi beklenir. Başka bir yanıt kodu döndürülürse, zaman aşımı meydana gelirse (10 saniye) veya başka bir teslimat sorunu ortaya çıkarsa, sistem bir dakika sonra webhook'u otomatik olarak yeniden deneyecektir. İstek başarısız olmaya devam ederse, yeniden denemeler üstel geri çekilme stratejisi izleyecek ve sonraki denemeler 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 dakika sonra yapılacaktır.

Bu yeniden deneme mekanizması, sorgulama sonuçlarının altyapınıza teslim edilmesinde maksimum güvenilirlik sağlar. Geçici ağ sorunları veya sunucu kesintileri nedeniyle veri kaybı riskini en aza indirir.

Webhook Yükü

{
    "type":"MNP",
    "results":[
        {
           "id":"e428acb1c0ae",
           "msisdn":"+14156226819",
           "query_status":"OK",
           "mccmnc":"310260",
           "mcc":"310",
           "mnc":"260",
           "is_ported":true,
           "original_network_name":"Verizon Wireless:6006 - SVR/2",
           "original_country_name":"United States",
           "original_country_code":"US",
           "original_country_prefix":"+1415",
           "ported_network_name":"T-Mobile US:6529 - SVR/2",
           "ported_country_name":"United States",
           "ported_country_code":"US",
           "ported_country_prefix":"+1",
           "extra":"LRN:4154250000",
           "cost":"0.0050",
           "timestamp":"2020-08-05 21:21:33.490+0300",
           "storage":"WEB-CLIENT-SOLO-MNP-2020-08",
           "route":"PTX",
           "error_code":null
        }
    ]
}

Webhook Yük Özellikleri

JSON nesnesi, aşağıda belgelenen sorgulama nesnelerinin listesini içeren results özelliğinin yanı sıra type => MNP özelliğini içerir.

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgu için benzersiz 12 karakterlik tanımlayıcı. false
msisdn string Bu sorgu talebinde değerlendirilen mobil telefon numarası. false
query_status string Taşınabilirlik ve ağ bilgilerinin başarıyla alınıp alınmadığını gösterir. Olası değerler OK veya FAILED şeklindedir. false
mccmnc string(5|6) Mobil telefon numarasının şu anda ait olduğu ağı tanımlayan beş veya altı karakterli MCCMNC (mobil ülke kodu ve mobil ağ kodu çifti). true
mcc string(3) Mobil telefon numarasının mevcut ağıyla ilişkili ülkeyi temsil eden üç karakterli MCC (mobil ülke kodu). true
mnc string(2|3) Mobil telefon numarası için mevcut ağ operatörünü tanımlayan iki veya üç karakterli MNC (mobil ağ kodu). true
is_ported boolean Telefon numarasının orijinal ağından yeni bir operatöre taşınıp taşınmadığını gösterir. true
original_network_name string İncelenen mobil telefon numarasının orijinal ağ operatörü adını belirten rastgele bir metin (İngilizce). true
original_country_name string İncelenen mobil telefon numarasının orijinal ülkesini belirten rastgele bir metin (İngilizce). true
original_country_code string(2) İncelenen mobil telefon numarasının orijinal ülkesini temsil eden iki karakterli ISO ülke kodu. true
original_country_prefix string İncelenen mobil telefon numarasıyla ilişkili orijinal ülkenin çağrı kodu. true
ported_network_name string İncelenen mobil telefon numarasının taşındığı ağ operatörünü belirtir (varsa). true
ported_country_name string İncelenen mobil telefon numarasının taşındığı ülkeyi belirtir (varsa). true
ported_country_code string(2) İncelenen mobil telefon numarasının taşındığı ülkeyi temsil eden iki karakterli ISO ülke kodu (varsa). true
ported_country_prefix string İncelenen mobil telefon numarasının taşındığı ülkenin çağrı kodu (varsa). true
extra string Telefon numarası hakkında isteğe bağlı ek ayrıntılar sağlayan rastgele bir metin. true
cost string Bu sorgunun EUR cinsinden maliyetini gösteren, metin olarak temsil edilen ondalık değer. true
timestamp string Sorgunun tamamlandığı zamanı gösteren, saat dilimi bilgisini içeren W3C formatında zaman damgası. true
storage string Sorgu sonuçlarının eklendiği depolama adı (veya rapor adı). Bu, web arayüzü üzerinden CSV indirmeleri ve raporlama için kullanılır. true
route string(3) Bu sorgu talebi için kullanılan rotayı belirten üç karakterli tanımlayıcı. true
error_code integer Müşteri destek tanılamaları için ek bağlam sağlayan isteğe bağlı dahili hata kodu. true
Yukarı Kaydır

POST/nt-lookupkorumalı

Senkron numara türü (NT) sorgusu başlatır. Bu endpoint, sağlanan telefon numaralarının sabit hat, mobil, premium ücretli, VoIP, çağrı cihazı veya diğer numaralandırma planı aralıklarına ait olup olmadığını gerçek zamanlı olarak belirlemeniz gerektiğinde idealdir.

NT sorguları telefon numarası türünü güvenilir şekilde tespit eder; ancak hedef numaranın şu anda bir ağa bağlı ve erişilebilir olup olmadığını göstermez. Canlı bağlantı bilgilerini almak için lütfen POST /hlr-lookup endpoint'ini kullanın.

Kullanım senaryonuz doğru ağ ve taşınabilirlik bilgisi (MCCMNC) gerektiriyorsa ancak canlı bağlantı durumu gerekmiyorsa, mobil numara taşınabilirliği sorguları için lütfen POST /mnp-lookup endpoint'ini kullanın.

İstek Başarılı Yanıt Hata Yanıtı Tür Referansı
curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookup' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
number string Uluslararası formatta bir telefon numarası (örn. +4989702626 veya 004989702626). null mandatory
route string(3) Bu sorgu için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu istek için en iyi rotaları otomatik olarak belirlemesine izin vermek için null olarak ayarlayın veya bu parametreyi atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
     "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"
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgulama isteğine atanan benzersiz tanımlayıcı. false
number string Bu sorgulama isteği sırasında değerlendirilen telefon numarası. false
number_type string Tespit edilen numara türü. Olası değerler: LANDLINE , MOBILE , MOBILE_OR_LANDLINE , TOLL_FREE , PREMIUM_RATE , SHARED_COST , VOIP , PAGER , UAN , VOICEMAIL , UNKNOWN . false
query_status string Numara türü bilgisinin başarıyla alınıp alınmadığını gösterir. Başarılı olması durumunda OK, sorgulama başarısız olması durumunda FAILED değerini döndürür. false
is_valid boolean Telefon numarasının sözdizimsel olarak geçerli olup olmadığını gösterir. true
invalid_reason string Telefon numarasının neden geçersiz kabul edildiğini belirten İngilizce düz metin mesajı (örn. "too short" veya "invalid prefix"), numara geçerliyse null. true
is_possibly_ported boolean Telefon numarasının orijinal operatöründen farklı bir taşıyıcıya taşınmış olabileceğini gösterir. Kesin taşınabilirlik bilgisi için MNP sorgulamalarını kullanın. true
is_vanity_number boolean Telefon numarasının alfabetik karakterler içeren özel bir numara olup olmadığını gösterir. true
qualifies_for_hlr_lookup boolean Telefon numarasının HLR sorgulamaları aracılığıyla ek sorgular için uygun olup olmadığını gösterir. true
mccmnc string(5|6) Mobil telefon numarasının orijinal ağını tanımlayan MCCMNC çiftini (mobil ülke kodu ve mobil ağ kodu) temsil eden beş veya altı karakterli dize. true
mcc string(3) Telefon numarasının orijinal mobil ağıyla ilişkili ülkeyi tanımlayan MCC'yi (mobil ülke kodu) temsil eden üç karakterli dize. true
mnc string(2|3) Telefon numarasının orijinal mobil ağ operatörünü tanımlayan MNC'yi (mobil ağ kodu) temsil eden iki veya üç karakterli dize. true
original_network_name string İncelenen mobil telefon numarasının orijinal ağ operatörü adını belirten İngilizce düz metin dizesi. true
original_country_name string İncelenen mobil telefon numarasıyla ilişkili orijinal ülkeyi belirten İngilizce düz metin dizesi. true
original_country_code string(2) İncelenen mobil telefon numarasının orijinal ülkesini gösteren iki karakterli ISO ülke kodu. true
regions array Bu telefon numarasıyla ilişkili coğrafi bölge(ler)i belirten İngilizce okunabilir dizeler listesi. true
timezones array Bu telefon numarasıyla ilişkili saat dilimleri listesi (Olson formatında). true
info_text string Telefon numarası hakkında ek bilgiler içerebilen rastgele dize. true
cost string Bu sorgulamanın maliyetini (EUR cinsinden) gösteren dize olarak temsil edilen ondalık değer. true
timestamp string Sorgulamanın tamamlandığı zamanı gösteren W3C formatında zaman damgası (saat dilimi dahil). true
storage string Sorgulama sonuçlarının eklendiği depolama adını belirtir. Bu, web arayüzü üzerinden CSV indirmeleri ve analizler için kullanılan rapor adına karşılık gelir. true
route string(3) Bu sorgu talebi için kullanılan rotayı belirten üç karakterli tanımlayıcı. true
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Tür Açıklama
LANDLINE Sabit hat telefon numarası.
MOBILE Mobil telefon numarası. Bağlantı durumu, ağ, taşınabilirlik ve roaming bilgilerini almak için HLR sorgulaması yapılabilir.
MOBILE_OR_LANDLINE Sabit hat veya mobil telefon numarası. HLR sorgulaması yapılabilir.
TOLL_FREE Ücretsiz telefon numarası.
PREMIUM_RATE Ek ücretli premium telefon numarası.
SHARED_COST Paylaşımlı ücretli telefon numarası. Genellikle premium telefon numaralarından daha ekonomiktir.
VOIP IP üzerinden ses telefon numarası. TSoIP telefon numaralarını içerir (IP Üzerinden Telefon Hizmeti).
PAGER Çağrı cihazı telefon numarası. Genellikle sesli arama işlevi yoktur.
UAN Evrensel Erişim Numarası (Şirket Numarası). Belirli ofislere yönlendirilebilir ancak şirket için tek bir numaranın kullanılmasına olanak tanır.
VOICEMAIL Sesli mesaj telefon numarası.
UNKNOWN Numara türü belirlenemedi.
Yukarı Kaydır

POST/nt-lookups korumalı

Bu uç nokta, sonuçların webhook aracılığıyla sunucunuza geri gönderildiği bir dizi asenkron numara türü sorgulaması başlatır. Verilen telefon numaralarının sabit hat, mobil, özel ücretli, VoIP, çağrı cihazı veya diğer numaralandırma planı aralıklarına ait olup olmadığını belirlemeniz gerekiyorsa uygundur. Büyük hacimli numaraların hızlı işlenmesi için optimize edilmiş bu uç nokta, toplu işlemler (örn. veritabanı temizleme) için idealdir. Canlı trafik ve zaman kritik kullanım senaryoları için lütfen bunun yerine POST /nt-lookup uç noktasını kullanın.

Bu uç noktayı çağırmak için ön koşul olarak API ayarlarınızda bir webhook URL'si belirtmeniz gerekir.

İstek Başarılı Yanıt Hata Yanıtı Webhook'lar Tür Referansı
curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookups' \
          -d "@payload.json"

Payload

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

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
numbers array Uluslararası formatta telefon numaraları dizisi (örn. +14156226819 veya 004989702626). İstek başına en fazla 1000 numara eklenebilir. null zorunlu
route string(3) Bu sorgulama için rotayı belirten isteğe bağlı üç karakterli tanımlayıcı. Özel yönlendirme haritanızı uygulamak veya sistemimizin bu istek için en iyi rotayı otomatik olarak belirlemesine izin vermek için null olarak ayarlayın veya bu parametreyi atlayın. null isteğe bağlı
storage string Sonuçların manuel inceleme, analitik ve raporlama için saklanacağı raporu belirten isteğe bağlı depolama tanımlayıcısı. Sistem otomatik olarak geçerli ay ile bir zaman damgası ekler. Atlanırsa veya null olarak ayarlanırsa, sistem raporlama amacıyla sonuçları otomatik olarak aylara göre gruplandırır. null isteğe bağlı
{
   "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"
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
accepted array Her biri benzersiz bir tanımlayıcı ve işleme kabul edilmiş bir telefon numarası içeren nesneler dizisi. false
accepted_count integer İşleme kabul edilen telefon numaralarının toplam sayısı. false
rejected array Her biri benzersiz bir tanımlayıcı ve işleme reddedilmiş bir telefon numarası içeren nesneler dizisi. Genellikle bu numaralar geçersizdir ve ücretlendirme yapılmaz. false
rejected_count integer İşleme reddedilen telefon numaralarının toplam sayısı. false
total_count integer İşleme gönderilen kabul edilen ve reddedilen telefon numaralarının toplam sayısı. false
cost string Bu sorgulamaların EUR cinsinden maliyetini gösteren ondalık değeri temsil eden dize. false
storage string Sorgulama sonuçlarının eklendiği depolama (rapor) adı. Bu ad, web arayüzü üzerinden CSV indirmeleri ve analizler için kullanılır. false
route string(3) Bu sorgulama isteği için kullanılan rotayı belirten üç karakterli tanımlayıcı. false
webhook_urls array API ayarlarınızda yapılandırılan webhook URL'leri. Sonuçlar buraya geri gönderilir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false

Webhook İşleme

Gönderildikten sonra platformumuz sağlanan telefon numaralarını işlemeye başlar ve sonuçları sunucunuzda önceden belirtilen webhook URL'sine gönderir. Sonuçlar, istek gövdesinde JSON nesnesi içeren bir HTTP POST isteği olarak iletilir.

Kimlik Doğrulama

X-Signatures HTTP başlığını inceleyerek webhook'u doğrulayın.

X-Signatures başlığı, noktalı virgülle ayrılmış bir imza listesi içerir. Listedeki her imza, hesabınızda yapılandırılmış API gizli anahtarlarından biri kullanılarak oluşturulur. Webhook'u doğrulamak için API anahtarınızı, gizli anahtarınızı ve ham HTTP gövdesini kullanarak bir SHA-256 hash oluşturun, ardından bunu listedeki imzalarla karşılaştırın.

Eşleşme, isteğin özgün olduğunu ve kontrolünüz altındaki bir gizli anahtarla imzalandığını doğrular.

PHP Kod Örneği

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

Başlıkta verilen imzalardan herhangi biri, API anahtarınız, gizli anahtarınız ve HTTP gövdesinin birleştirilmiş dizesi üzerinden hesaplanan SHA256 hash ile eşleşiyorsa istek geçerlidir.

Alındı Onayı

Sunucunuzun başarılı alımı onaylamak için 200 OK HTTP durum koduyla yanıt vermesi beklenir. Başka bir yanıt kodu döndürülürse, zaman aşımı meydana gelirse (10 saniye) veya başka bir teslimat sorunu ortaya çıkarsa, sistem bir dakika sonra webhook'u otomatik olarak yeniden deneyecektir. İstek başarısız olmaya devam ederse, yeniden denemeler üstel geri çekilme stratejisi izleyecek ve sonraki denemeler 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 dakika sonra yapılacaktır.

Bu yeniden deneme mekanizması, sorgulama sonuçlarının altyapınıza teslim edilmesinde maksimum güvenilirlik sağlar. Geçici ağ sorunları veya sunucu kesintileri nedeniyle veri kaybı riskini en aza indirir.

Webhook Yükü

{
   "type":"NT",
   "results":[
      {
         "id":"9f8a52cfa7d2",
         "number":"+905536939460",
         "numbertype":"MOBILE",
         "state":"COMPLETED",
         "isvalid":"Yes",
         "invalidreason":null,
         "ispossiblyported":"Yes",
         "isvanitynumber":"No",
         "qualifiesforhlrlookup":"Yes",
         "originalcarrier":"Turk Telekom (AVEA)",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "countrycode":"TR",
         "regions":[
            "Turkey"
         ],
         "timezones":[
            "Europe\/Istanbul"
         ],
         "infotext":"This number qualifies for HLR lookups. Determine if this subscriber number is connected, absent or invalid by running an HLR lookup. This is a mobile number and might be in roaming state. Run an HLR lookup to obtain roaming information (if available). This number is possibly ported and the carrier information might be inaccurate. To obtain portability information run an HLR lookup.",
         "usercharge":"0.0050",
         "inserttime":"2020-08-13 01:57:15.897+0300",
         "storage":"ASYNC-API-NT-2020-08",
         "route":"LC1",
         "interface":"Async API"
      }
   ]
}

Webhook Yük Özellikleri

JSON nesnesi, aşağıda belgelenen sorgulama nesnelerinin listesini içeren results özelliğinin yanı sıra type => NT özelliğini içerir.

Ad Tür Açıklama Boş Olabilir
id string(12) Bu sorgulama isteğine atanan benzersiz tanımlayıcı. false
number string Bu sorgulama isteği sırasında değerlendirilen telefon numarası. false
number_type string Tespit edilen numara türü. Olası değerler: LANDLINE , MOBILE , MOBILE_OR_LANDLINE , TOLL_FREE , PREMIUM_RATE , SHARED_COST , VOIP , PAGER , UAN , VOICEMAIL , UNKNOWN . false
query_status string Numara türü bilgisinin başarıyla alınıp alınmadığını gösterir. Başarılı olması durumunda OK, sorgulama başarısız olması durumunda FAILED değerini döndürür. false
is_valid boolean Telefon numarasının sözdizimsel olarak geçerli olup olmadığını gösterir. true
invalid_reason string Telefon numarasının neden geçersiz kabul edildiğini belirten İngilizce düz metin mesajı (örn. "too short" veya "invalid prefix"), numara geçerliyse null. true
is_possibly_ported boolean Telefon numarasının orijinal operatöründen farklı bir taşıyıcıya taşınmış olabileceğini gösterir. Kesin taşınabilirlik bilgisi için MNP sorgulamalarını kullanın. true
is_vanity_number boolean Telefon numarasının alfabetik karakterler içeren özel bir numara olup olmadığını gösterir. true
qualifies_for_hlr_lookup boolean Telefon numarasının HLR sorgulamaları aracılığıyla ek sorgular için uygun olup olmadığını gösterir. true
mccmnc string(5|6) Mobil telefon numarasının orijinal ağını tanımlayan MCCMNC çiftini (mobil ülke kodu ve mobil ağ kodu) temsil eden beş veya altı karakterli dize. true
mcc string(3) Telefon numarasının orijinal mobil ağıyla ilişkili ülkeyi tanımlayan MCC'yi (mobil ülke kodu) temsil eden üç karakterli dize. true
mnc string(2|3) Telefon numarasının orijinal mobil ağ operatörünü tanımlayan MNC'yi (mobil ağ kodu) temsil eden iki veya üç karakterli dize. true
original_network_name string İncelenen mobil telefon numarasının orijinal ağ operatörü adını belirten İngilizce düz metin dizesi. true
original_country_name string İncelenen mobil telefon numarasıyla ilişkili orijinal ülkeyi belirten İngilizce düz metin dizesi. true
original_country_code string(2) İncelenen mobil telefon numarasının orijinal ülkesini gösteren iki karakterli ISO ülke kodu. true
regions array Bu telefon numarasıyla ilişkili coğrafi bölge(ler)i belirten İngilizce okunabilir dizeler listesi. true
timezones array Bu telefon numarasıyla ilişkili saat dilimleri listesi (Olson formatında). true
info_text string Telefon numarası hakkında ek bilgiler içerebilen rastgele dize. true
cost string Bu sorgulamanın maliyetini (EUR cinsinden) gösteren dize olarak temsil edilen ondalık değer. true
timestamp string Sorgulamanın tamamlandığı zamanı gösteren W3C formatında zaman damgası (saat dilimi dahil). true
storage string Sorgulama sonuçlarının eklendiği depolama adını belirtir. Bu, web arayüzü üzerinden CSV indirmeleri ve analizler için kullanılan rapor adına karşılık gelir. true
route string(3) Bu sorgu talebi için kullanılan rotayı belirten üç karakterli tanımlayıcı. true
Tür Açıklama
LANDLINE Sabit hat telefon numarası.
MOBILE Mobil telefon numarası. Bağlantı durumu, ağ, taşınabilirlik ve roaming bilgilerini almak için HLR sorgulaması yapılabilir.
MOBILE_OR_LANDLINE Sabit hat veya mobil telefon numarası. HLR sorgulaması yapılabilir.
TOLL_FREE Ücretsiz telefon numarası.
PREMIUM_RATE Ek ücretli premium telefon numarası.
SHARED_COST Paylaşımlı ücretli telefon numarası. Genellikle premium telefon numaralarından daha ekonomiktir.
VOIP IP üzerinden ses telefon numarası. TSoIP telefon numaralarını içerir (IP Üzerinden Telefon Hizmeti).
PAGER Çağrı cihazı telefon numarası. Genellikle sesli arama işlevi yoktur.
UAN Evrensel Erişim Numarası (Şirket Numarası). Belirli ofislere yönlendirilebilir ancak şirket için tek bir numaranın kullanılmasına olanak tanır.
VOICEMAIL Sesli mesaj telefon numarası.
UNKNOWN Numara türü belirlenemedi.
Yukarı Kaydır

GET/routekorumalı

route parametresini belirtmeden bir HLR sorgusu çalıştırdığınızda otomatik olarak seçilecek rotayı getirir.

Otomatik rota seçimi, öncelikli olarak GET /routing-map temelinde oluşturulan ve GET /hlr-coverage endpoint'i ile getirilebilen yönlendirme haritasına dayanır. Yönlendirme haritanızı özelleştirebilir ve hesap ayarlarınızda özel kurallar tanımlayabilirsiniz.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/route?msisdn=+491788735000'

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdn string Otomatik olarak seçilen yönlendirme bilgisinin getirileceği MSISDN. null zorunlu
{
   "route":"V11",
   "confidence_level":"HIGH",
   "mccmnc":"26203",
   "origin":"SCORE"
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
route string Önerilen rota. false
confidence_level string Bu rotanın seçildiği güven seviyesi, örneğin LOW, NORMAL, HIGH, MNP_FALLBACK. false
mccmnc string Bu numara için numaralandırma planına dayalı MCCMNC. false
origin string Yönlendirme kararının dayandığı kaynak, örn. 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."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/routeskorumalı

Bu endpoint, mevcut HLR, MNP ve NT rotalarının listesini döndürür. Her rota, özellikleri ve kısıtlamaları ile birlikte rota detayları sayfasında açıklanmaktadır.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/routes'
{
   "routes":{
      "HLR":[
         "V11",
         "E10",
         "MS9",
         "DV8",
         "SV3",
         "IP1"
      ],
      "MNP":[
         "PTX",
         "IP4"
      ],
      "NT":[
         "LC1"
      ]
   }
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
routes object Rota türüne göre gruplandırılmış rotaları içeren bir nesne. false
HLR|MNP|NT string[] Rota tanımlayıcılarının listesini içerir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/routing-mapkorumalı

Hesabınız için HLR Sorgularına uygulanan otomatik yönlendirme yapılandırmasını getirir. Bu varsayılan yapılandırma, route parametresi belirtmeden HLR sorguları gönderdiğinizde kullanılır. Yönlendirme haritanızı özelleştirebilir ve hesap ayarlarınızda özel kurallar oluşturabilirsiniz.

Yapılandırma hiyerarşisi, ülke düzeyindeki kurallardan MCCMNC düzeyindeki kurallara ve son olarak bireysel telefon numarası önek eşlemelerine doğru kademeli olarak uygulanır. Uygulamada bu, bireysel telefon numarası önek eşlemelerinin çakışan MCCMNC atamalarına göre öncelikli olduğu ve bunların da ülke düzeyindeki kuralları geçersiz kıldığı anlamına gelir. Lütfen MNP yedekleme özelliğinin etkinleştirildiğinde çakışan tüm özel kuralları geçersiz kıldığını unutmayın.

İstek Başarılı Yanıt Hata Yanıtı
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"
            }
         ]
      }
   }
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
default_route string Bir MSISDN için tercih edilen yönlendirme seçeneği belirlenemediğinde ve özel yönlendirme kuralları uygulanmadığında kullanılan varsayılan rota. false
mnp_fallback boolean MNP yedeklemenin etkin olup olmadığını gösterir. Etkinleştirildiğinde ve HLR sorguları bir ağ tarafından desteklenmediğinde (bağlantı durumu kullanılamıyor), sistem bunun yerine bir MNP sorgusu gerçekleştirir. false
mccmncs array MCCMNC kodlarının otomatik olarak seçilen rotalara eşlemesi. Belirli bir MCCMNC'deki bir numara için HLR sorgusu gerçekleştirilirken, ilgili rota kullanılır. false
mccmnc string(5|6) Mobil ağ operatörünü tanımlayan beş veya altı karakterli MCCMNC (mobil ülke kodu ve mobil ağ kodu kombinasyonu). false
countrycode string(2) Ağın ülkesini tanımlayan iki karakterli ISO ülke kodu. false
route string(3) Ağ için seçilen rota. false
mno string Bu ağın faaliyet gösterdiği tüketiciye yönelik marka. false
confidence string Seçimin yapıldığı güven düzeyi. Olası değerler: HIGH, NORMAL, LOW, MNP_REDIRECT. Sonuncusu durumunda, sistem bu ağa giden trafiği MNP'ye yönlendirir (bu davranış hesabınızda etkinse). Aksi takdirde hesaptaki varsayılan rotayı kullanır. false
origin string Seçimin dayandığı kaynak. Olası değerler: 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 Hesabınızda yapılandırılmış özel önek tabanlı yönlendirme kurallarının listesi (varsa). false
countrycode string(2) Önekin ülkesini tanımlayan iki karakterli ISO ülke kodu. false
cns string Yönlendirme kuralının uygulandığı önek. false
route string(3) Önek için seçilen rota. false
mccmnc string(5|6) Mobil ağ operatörünü tanımlayan beş veya altı karakterli MCCMNC (mobil ülke kodu ve mobil ağ kodu kombinasyonu). true
mno string Bu ağın faaliyet gösterdiği tüketiciye yönelik marka. true
countries array Hesabınızda yapılandırılmış özel ülke tabanlı kuralların listesi (varsa). false
countrycode string(2) Ülkeyi tanımlayan iki karakterli ISO ülke kodu. false
route string(3) Ülke için seçilen rota. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/hlr-coverage korumalı

Veri odaklı karar vermeyi desteklemek için HLR kapsama alanı bilgileri sunar. Bu uç nokta, mobil ağlar genelinde gerçek zamanlı HLR yönlendirme seçeneklerini analiz etmenize, hedef bölgeleriniz için en etkili yolları belirlemenize ve otomatik yönlendirmenizi yapılandırmanıza yardımcı olur.

GET /route uç noktasından önerilen rotalar, burada alınan kapsama alanı verilerine dayanmaktadır. Kapsama alanı verileri ayrıca ağ kapsama alanı sayfasında da mevcuttur. Yönlendirme haritanızı daha da özelleştirebilir ve hesap ayarlarınızda kurallar tanımlayabilirsiniz.

Sonuçları yorumlamaya yardımcı olmak için bu kılavuzu incelemenizi öneririz.

İstek Başarılı Yanıt Hata Yanıtı Durum Referansı
curl 'https://www.hlr-lookups.com/api/v2/hlr-coverage?countrycode=XX'

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
countrycode string(2) Sonuçları filtrelemek için kullanılan zorunlu iki harfli ISO ülke kodu, yalnızca belirtilen ülkeyle ilişkili kayıtları döndürür. null zorunlu
sample_size string Örnek boyutunu belirten isteğe bağlı bir parametre. Olası değerler LARGE, MEDIUM, SMALL şeklindedir. Daha büyük örnekler daha uzun bir zaman dilimini, daha küçük örnekler ise çok yakın zamanlı bir zaman dilimini kapsar. LARGE isteğe bağlı
{
   "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
            }
         ]
      }
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
name string Seçilen ülke adı İngilizce düz metin olarak. false
countrycode string(2) Seçilen ülkenin iki karakterli ISO ülke kodu. false
prefix string Seçilen ülkenin uluslararası arama ön eki. false
mccs string[] Seçilen ülkeyle ilişkili MCC'lerin (mobil ülke kodları) listesi. false
carriers object[] Rotaya özel bağlantı metriklerine sahip operatör nesnelerinin listesi. false
mno string Mobil ağ operatörünün adı İngilizce düz metin olarak. false
mccmnc string Mobil ağ operatörünün MCCMNC kodu. false
mcc string Mobil ağ operatörünün MCC'si (mobil ülke kodu). false
mnc string Mobil ağ operatörünün MNC'si (mobil ağ kodu). false
routes object[] Rotaya özel bağlantı sonuçlarının listesi. false
route string Bağlantı bilgilerinin uygulandığı rota. false
selected bool Bunun otomatik yönlendirme için seçilen rota olup olmadığını gösterir. false
selection_confidence string Bu rotanın seçildiği güven seviyesi, örneğin LOW, NORMAL, HIGH, MNP_FALLBACK. Bu seçilen rota değilse null içerir. true
n int Bu örnekteki toplam sorgulama sayısı. false
CONNECTED int CONNECTED durumu döndüren HLR sorgulama sayısı. false
CONNECTED_PCT float CONNECTED durumu döndüren HLR sorgulamalarının yüzdesi. false
ABSENT int ABSENT durumu döndüren HLR sorgulama sayısı. false
ABSENT_PCT float ABSENT durumu döndüren HLR sorgulamalarının yüzdesi. false
INVALID_MSISDN int INVALID_MSISDN durumu döndüren HLR sorgulama sayısı. false
INVALID_MSISDN_PCT float INVALID_MSISDN durumu döndüren HLR sorgulamalarının yüzdesi. false
UNDETERMINED int UNDETERMINED durumu döndüren HLR sorgulama sayısı. false
UNDETERMINED_PCT float UNDETERMINED durumu döndüren HLR sorgulamalarının yüzdesi. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Durum Açıklama
CONNECTED Numara geçerlidir ve hedef cihaz şu anda mobil ağa bağlıdır. Aramalar, SMS ve diğer hizmetler alıcıya başarıyla ulaşmalıdır.
ABSENT Numara geçerlidir ancak hedef cihaz kapalı veya geçici olarak kapsama alanı dışındadır. Mesajlar veya aramalar, cihaz ağa yeniden bağlanana kadar iletilemeyebilir.
INVALID_MSISDN Numara geçersizdir veya şu anda mobil ağda herhangi bir aboneye atanmamıştır. Bu numaraya yapılan aramalar ve mesajlar başarısız olacaktır.
UNDETERMINED Numaranın bağlantı durumu belirlenemedi. Bu durum geçersiz bir numara, SS7 hata yanıtı veya hedef ağ operatörü ile bağlantı eksikliğinden kaynaklanabilir. Ek tanı bilgileri için hata kodunu ve açıklama alanını inceleyin.
Yukarı Kaydır

GET/mnp-coveragekorumalı

Bu endpoint, mobil numara taşınabilirliği sorgulamaları için şu anda desteklenen mobil ağ operatörlerinin listesini ve bunlara karşılık gelen MCCMNC tanımlayıcılarını döndürür.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/mnp-coverage?countrycode=XX'

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
countrycode string(2) MCCMNC sonuçlarını filtrelemek için kullanılan, yalnızca belirtilen ülkeyle ilgili verileri döndüren isteğe bağlı iki harfli ISO ülke kodu. null isteğe bağlı
{
   "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"
      }
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
items[] array Mobil ağ operatörlerinin listesi. false
country_name string İngilizce ülke adı. false
country_code string(2) İki harfli ISO ülke kodu. false
mccmnc string(5|6) Mobil ağ operatörünü tanımlayan beş veya altı karakterli MCCMNC (mobil ülke kodu ve mobil ağ kodu kombinasyonu). false
mcc string(3) Ağın ülkesini temsil eden üç karakterli MCC (mobil ülke kodu). false
mnc string(2|3) Belirli mobil ağ operatörünü temsil eden iki veya üç karakterli MNC (mobil ağ kodu). false
brand string Bu ağın faaliyet gösterdiği tüketiciye yönelik marka. true
operator string Mobil ağ operatörünün yasal adı. true
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/price-listkorumalı

Bu endpoint, yalnızca MNP sorgularının desteklendiği ve HLR sorgularının bu destinasyonlar için kullanılamadığı ülkelerin listesini döndürür.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/mnp-countries'
{
   "countries":[
      "AG",
      "AI",
      "AR",
      "AS",
      "AW",
      "BB",
      "BM",
      ...
      "US",
      "UY",
      "VC",
      "VE",
      "VG",
      "VN"
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
countries string[] İki karakterli ISO ülke kodlarının listesi. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/mccmncskorumalı

Bu endpoint, mobil ağ operatörlerinin kapsamlı bir listesini, ilgili MCCMNC tanımlayıcılarını ve ek bağlamsal bilgileri döndürür.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/mccmncs?countrycode=XX'

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
countrycode string(2) MCCMNC sonuçlarını filtrelemek için kullanılan isteğe bağlı iki harfli ISO ülke kodu, yalnızca belirtilen ülkeyle ilişkili kayıtları döndürür. null isteğe bağlı
{
   "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"
      }
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
items object[] Mobil ağ operatörlerinin listesi. false
country_name string İngilizce tam ülke adı. false
country_code string(2) Mobil operatörün ülkesini temsil eden iki harfli ISO ülke kodu. false
mccmnc string(5|6) Mobil ağ operatörünü benzersiz şekilde tanımlayan beş veya altı karakterli MCCMNC dizesi. false
mcc string(3) Mobil ağın faaliyet gösterdiği ülkeyi tanımlayan üç karakterli Mobil Ülke Kodu (MCC). false
mnc string(2|3) Belirli bir MCC içindeki mobil ağı tanımlayan iki veya üç karakterli Mobil Ağ Kodu (MNC). false
brand string Ağın faaliyet gösterdiği ve tüketiciler tarafından tanındığı ticari marka adı. true
operator string Mobil ağ operatörünün resmi adı, genellikle ağı yöneten tüzel kişilik. true
parent_mccmnc string(5|6) Varsa, ana mobil ağ operatörünün MCCMNC'sini temsil eden beş veya altı karakterli dize. true
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/pricekorumalı

Bu endpoint, HLR, MNP veya NT sorgulaması için fiyat bilgisini döndürür.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/price?msisdn=+491788735000&route_type=HLR'

İstek Parametreleri

Anahtar Tür Açıklama Varsayılan Zorunlu
msisdn string Fiyat bilgisi alınacak telefon numarası. Uluslararası formatta olmalıdır. null zorunlu
route_type string Rota tipi: HLR, MNP, NT. null zorunlu
route string(3) Fiyatın hesaplanacağı rota. Varsayılan olarak otomatik yönlendirme tarafından belirlenen rota kullanılır. null isteğe bağlı
{
   "price":{
      "amount":"0.01000",
      "msisdn":"+491788735000",
      "route_type":"HLR",
      "route":"DV8"
   }
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
price object Fiyatlandırma detaylarını içeren nesne. false
amount string EUR cinsinden tutar. false
msisdn string Bu fiyatın geçerli olduğu MSISDN. false
route_type string(2|3) Bu fiyatın geçerli olduğu rota tipi. false
route string(3) Bu fiyatın geçerli olduğu rota. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/price-listkorumalı

Bu endpoint hesabınızdaki fiyatlandırmayı döndürür.

İstek Başarılı Yanıt Hata Yanıtı
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"
      }
   ]
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
pricing object[] Fiyatlandırma bilgilerini içeren nesnelerin listesi. false
route string Bu fiyatlandırmanın uygulandığı rota. false
countrycode string Varsa, ilgili rota için bu fiyatlandırmanın uygulandığı iki karakterli ISO ülke kodu. true
countryname string Varsa, ülke koduna karşılık gelen İngilizce ülke adı. true
mccmnc string Varsa, ilgili rota için bu fiyatlandırmanın uygulandığı MCCMNC. Ülke düzeyindeki fiyatlandırmayı geçersiz kılar. true
cns string Varsa, ilgili rota için bu fiyatlandırmanın uygulandığı arama öneki. Ülke düzeyindeki ve MCCMNC düzeyindeki fiyatlandırmayı geçersiz kılar. true
route_type string İlgili rota türü, örneğin HLR, MNP, NT. false
route_type string EUR cinsinden ilgili fiyat. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/balancekorumalı

Bu endpoint mevcut hesap bakiyenizi getirir ve kredi durumunuza göre süreçleri otomatikleştirmenize olanak tanır. Ödeme sayfanızda yapılandırabileceğiniz düşük kredi bildirim e-postaları ile sorunsuz çalışır.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/balance'
{
    "balance":"1002.90"
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
balance string EUR cinsinden mevcut hesap bakiyeniz. String türünde ondalık değer. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/pinggenel

Bu uç nokta, API'ye bir ping isteği göndererek HLR Lookups API'sine bağlantınızı test etmek için basit bir yöntem sağlar.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/ping'
{
    "success":true
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
success boolean İsteğin başarıyla işlendiğini gösterir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/timegenel

Bu endpoint, HLR Lookups sunucusundaki geçerli zamanı temsil eden bir Unix zaman damgası döndürür. Kimlik doğrulama için Digest-Auth imzasını oluştururken sunucunuzun saatini senkronize etmek amacıyla kullanın, böylece sunucu saatiniz ile HLR Lookups sunucu saati arasındaki olası farklılıklar düzeltilir.

İstek Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/time'
{
    "time":1525898643
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
time integer Geçerli HLR Lookups sunucu zamanını temsil eden Unix zaman damgası. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

GET/auth-testkorumalı

Bu endpoint, Basic-Auth veya tercihen Digest-Auth uygulamanız için başlangıç testi olarak hizmet eder.

Basic Auth İsteği Digest Auth İsteği Başarılı Yanıt Hata Yanıtı
curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: YOUR_API_KEY" 

İstek Başlıkları

Anahtar Tür Açıklama
X-Basic string YOUR_API_KEY:YOUR_API_SECRET değerinin SHA256 hash'i. Hash'e iki nokta üst üste (:) sembolünü dahil edin.
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" 

İstek Başlıkları

Anahtar Tür Açıklama
X-Digest-Key string HLR Lookups API Anahtarınız
X-Digest-Signature string Benzersiz Digest-Auth imzası (bkz. kimlik doğrulama)
X-Digest-Timestamp integer Geçerli Unix zaman damgası (ayrıca bkz. GET /time)
{
    "success":true
}

Başarılı Yanıt Nitelikleri

Ad Tür Açıklama Boş Olabilir
success boolean İsteğin başarıyla işlendiğini gösterir. false
{
    "errors":[
        "Service unavailable."
    ]
}

Hata Yanıt Parametreleri

Ad Tür Açıklama Boş Olabilir
errors[] string[] Hatayı açıklayan dizeler listesi. false
Yukarı Kaydır

Eski API Belgeleri

Lütfen eski API'nin kullanımdan kaldırıldığını ve gelecekte hizmet dışı bırakılacağını unutmayın. En kısa sürede en son sürüme geçmenizi şiddetle tavsiye ederiz.

HLR Lookups API'mizi 2013 ile 2020 başları arasında uyguladıysanız, eski API'mizi kullanıyorsunuz demektir. Bu durumda lütfen eski API belgelerimize başvurun.

Eski API Belgeleri
Dönen Yükleyici Şeffaf Gif