Ξεκινώντας

Η παγκόσμια υποδομή κινητής τηλεφωνίας λειτουργεί με ένα σύστημα γνωστό ως δίκτυο σηματοδότησης SS7. Αυτό το δίκτυο διευκολύνει την ανταλλαγή δεδομένων συνδρομητών, τη δρομολόγηση κλήσεων, τη μετάδοση SMS και τις ενημερώσεις κατάστασης κινητής συνδεσιμότητας σε πραγματικό χρόνο μεταξύ των παρόχων. Κάθε δίκτυο κινητής τηλεφωνίας διατηρεί ένα Home Location Register (HLR) - μια κεντρική βάση δεδομένων που αποθηκεύει βασικές πληροφορίες για τους συνδρομητές του.

Η τεχνολογία HLR Lookup επιτρέπει στις επιχειρήσεις να υποβάλλουν ερωτήματα σε αυτά τα μητρώα και να ανακτούν ζωντανά δεδομένα συνδεσιμότητας και δικτύου για οποιονδήποτε αριθμό κινητού τηλεφώνου. Αυτό περιλαμβάνει εάν το τηλέφωνο είναι ενεργοποιημένο, σε ποιο δίκτυο είναι εγγεγραμμένο, εάν έχει μεταφερθεί, εάν ο αριθμός είναι έγκυρος ή απενεργοποιημένος και εάν βρίσκεται σε περιαγωγή.

Το HLR Lookups API παρέχει απρόσκοπτη πρόσβαση σε πραγματικό χρόνο σε αυτά τα δεδομένα, επιτρέποντας στις επιχειρήσεις να επαληθεύουν αριθμούς κινητών, να βελτιστοποιούν τη δρομολόγηση και να ενισχύουν την επικοινωνία με τους πελάτες. Αυτή η τεκμηρίωση θα σας καθοδηγήσει στην ενσωμάτωση του HLR Lookups στο λογισμικό σας, επιτρέποντας την αυτοματοποιημένη ανάκτηση πληροφοριών κινητής τηλεφωνίας σε πραγματικό χρόνο.

Χρήση του HLR Lookups API

Η εκτέλεση ερωτημάτων HLR Lookup είναι γρήγορη, ασφαλής και απλή. Αφού εγγραφείτε και αποκτήσετε το API Key σας, μπορείτε να πιστοποιηθείτε και να ξεκινήσετε άμεσα lookups με απλά αιτήματα 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 headers και το payload.json πρέπει (τουλάχιστον) να περιέχει το ακόλουθο JSON αντικείμενο:

Παράδειγμα Payload

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

Πρόσθετες Υπηρεσίες Lookup

Αναζητήσεις Φορητότητας Αριθμού Κινητού (MNP)

Χρησιμοποιήστε τις αναζητήσεις MNP για να προσδιορίσετε την κυριότητα δικτύου και τις λεπτομέρειες φορητότητας χωρίς να υποβάλετε ερώτημα για συνδεσιμότητα σε πραγματικό χρόνο. Εάν χρειάζεστε μόνο το MCCMNC ενός αριθμού, ανατρέξτε στο POST /mnp-lookup.

Αναζητήσεις Ανίχνευσης Τύπου Αριθμού (NT)

Προσδιορίστε εάν ένας αριθμός τηλεφώνου ανήκει σε σταθερό, κινητό, premium, VoIP, pager ή άλλες κατηγορίες αριθμοδότησης με το POST /nt-lookup.

Εργαλεία Ανάπτυξης Λογισμικού (SDKs)

Το HLR Lookups API λειτουργεί με οποιονδήποτε REST client σε οποιαδήποτε γλώσσα προγραμματισμού και έχουμε δημοσιεύσει SDKs για PHP, Ruby και NodeJS στο GitHub μας για να σας βοηθήσουμε να ξεκινήσετε γρήγορα.

Εργαλεία

Για να διασφαλίσουμε μια απρόσκοπτη εμπειρία ανάπτυξης, προσφέρουμε μια ολοκληρωμένη σειρά εργαλείων, συμπεριλαμβανομένης της παρακολούθησης αιτημάτων API και webhook μέσω browser, της λίστας εγκεκριμένων διευθύνσεων IP, ισχυρών επιλογών πιστοποίησης και ενός test endpoint πιστοποίησης.

Δεν είστε Προγραμματιστής;

Τα HLR Lookups και τα ερωτήματα Φορητότητας Αριθμού μπορούν να εκτελεστούν χωρίς προγραμματισμό. Μάθετε περισσότερα για τον επιχειρηματικό web client μας και τις λειτουργίες αναφορών μέσω browser.

Πιστοποίηση

Για να διασφαλιστεί η ασφάλεια και ο κατάλληλος έλεγχος πρόσβασης, οι περισσότερες αιτήσεις προς το HLR Lookups API απαιτούν πιστοποίηση. Τα endpoints κατηγοριοποιούνται ως δημόσια ή προστατευμένα. Κατά την πρόσβαση σε προστατευμένο endpoint, η αίτησή σας πρέπει να πιστοποιηθεί χρησιμοποιώντας το API key και το secret σας μέσω της μεθόδου Digest-Auth ή Basic-Auth. Η μέθοδος Digest-Auth είναι πιο ασφαλής και συνιστάται ιδιαίτερα. Χρησιμοποιήστε το endpoint GET /auth-test για να επαληθεύσετε τη ρύθμιση πιστοποίησής σας.

API Key και API Secret

Λάβετε το API key και το secret σας από τη σελίδα Ρυθμίσεις API. Μπορείτε επίσης να ρυθμίσετε την προτιμώμενη μέθοδο πιστοποίησής σας και να ενεργοποιήσετε τη λίστα επιτρεπόμενων διευθύνσεων IP για ενισχυμένη ασφάλεια. Εάν υποψιάζεστε ότι το API secret σας έχει παραβιαστεί, μπορείτε να δημιουργήσετε ένα νέο ανά πάσα στιγμή.

Λήψη API Key
Basic Auth Digest Auth Λίστα IP

Η τυπική Basic Authentication είναι εύκολη στην υλοποίηση και ευρέως υποστηριζόμενη. Μπορείτε να πιστοποιηθείτε περνώντας το API key και το secret σας ως ζεύγος user:pass στο HTTP request.

HTTP Basic Auth

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

Αυτό στέλνει ένα header Authorization:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Συνιστάται: X-Basic Header με SHA256

Για βελτιωμένη ασφάλεια, μπορείτε να στείλετε ένα SHA256 hash των διαπιστευτηρίων σας αντί να τα μεταδώσετε απευθείας ως base64. Για να χρησιμοποιήσετε αυτή τη μέθοδο, υπολογίστε το hash του ζεύγους YOUR_API_KEY:YOUR_API_SECRET και στείλτε το μέσω του header X-Basic:

Αίτηση Basic Auth

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

Headers Basic Authentication

Κλειδί Τύπος Περιγραφή
X-Basic string SHA256 hash του YOUR_API_KEY:YOUR_API_SECRET. Συμπεριλάβετε το σύμβολο άνω και κάτω τελείας (:) στο hash. υποχρεωτικό

PHP Παράδειγμα Κώδικα

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

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

Η μέθοδος Digest-Auth είναι η συνιστώμενη για την ασφάλιση της πρόσβασης σε προστατευμένα HLR Lookup API endpoints. Κάθε αίτηση πρέπει να περιλαμβάνει τα ακόλουθα headers: 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"

Headers Αίτησης

Κλειδί Τύπος Περιγραφή
X-Digest-Key string Το μοναδικό σας HLR Lookups API Key. υποχρεωτικό
X-Digest-Signature string Μια μοναδική υπογραφή πιστοποίησης (δείτε παρακάτω). υποχρεωτικό
X-Digest-Timestamp integer Τρέχουσα χρονική σήμανση Unix (δείτε επίσης GET /time). υποχρεωτικό

Δημιουργία της Υπογραφής

Η X-Digest-Signature δημιουργείται χρησιμοποιώντας ένα SHA256 HMAC hash, με το API secret σας ως κοινό κλειδί.

Το string προς hash έχει τη δομή:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

Το σύμβολο . αντιπροσωπεύει συνένωση strings.

Στοιχεία Digest Signature

Στοιχείο Τύπος Περιγραφή
ENDPOINT_PATH string Το ζητούμενο API endpoint, π.χ. /auth-test με πεζούς χαρακτήρες.
UNIX_TIMESTAMP integer Τρέχουσα χρονική σήμανση Unix (πρέπει να είναι εντός 30 δευτερολέπτων). Δείτε GET /time.
REQUEST_METHOD string Η μέθοδος HTTP που χρησιμοποιείται, π.χ. POST ή GET.
REQUEST_BODY string Δεδομένα σώματος αίτησης. Ορίστε σε null για αιτήσεις GET.

Παραδείγματα Κώδικα

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)

Χρησιμοποιήστε τις Ρυθμίσεις API για να περιορίσετε την πρόσβαση σε συγκεκριμένες διευθύνσεις IP για ενισχυμένη ασφάλεια. Αυτό συνιστάται ιδιαίτερα σε περιβάλλοντα παραγωγής.

Μετακίνηση Επάνω

Έννοιες

Η υλοποίηση HLR Lookups σε οποιαδήποτε γλώσσα προγραμματισμού ή σύστημα μέσω του HTTP REST API μας είναι απλή και αποδοτική. Με μια απλή διαδικασία ενσωμάτωσης, μπορείτε να ξεκινήσετε να υποβάλλετε ερωτήματα σε δίκτυα κινητής τηλεφωνίας σε πραγματικό χρόνο για άμεσες πληροφορίες σχετικά με την εγκυρότητα αριθμών τηλεφώνου, την κατάσταση συνδεσιμότητας και τις λεπτομέρειες δρομολόγησης.

Η επιλογή του κατάλληλου API εξαρτάται από τη συγκεκριμένη περίπτωση χρήσης σας. Εάν χρειάζεστε αποτελέσματα αναζήτησης σε πραγματικό χρόνο για εφαρμογές όπως VoIP τηλεφωνία, ανίχνευση απάτης ή δρομολόγηση SMS, το σύγχρονο API είναι η καλύτερη επιλογή. Ωστόσο, εάν η περίπτωση χρήσης σας περιλαμβάνει επεξεργασία μεγάλου όγκου, μαζικές αναζητήσεις ή επαλήθευση δεδομένων μεγάλης κλίμακας, το ασύγχρονο API προσφέρει βελτιστοποιημένη απόδοση με αποδοτικότητα εύρους ζώνης και δυνατότητες μαζικής αναζήτησης.

Διαμορφώστε το API ώστε να χρησιμοποιεί μία από τις προσαρμοσμένες επιλογές δρομολόγησης μας για να βελτιστοποιήσετε την ταχύτητα, την ακρίβεια και την οικονομική αποδοτικότητα. Μπορείτε επίσης να αποθηκεύσετε τα αποτελέσματα αναζήτησης σε αποθηκευτικούς χώρους για εύκολη λήψη αναφορών CSV και JSON, καθώς και προηγμένη ανάλυση μέσω της διεπαφής ιστού.

Σύγχρονο HLR Lookup API

Το endpoint POST /hlr-lookup επεξεργάζεται έναν αριθμό κινητού τηλεφώνου (MSISDN) ανά αίτημα και επιστρέφει αποτελέσματα άμεσα στο σώμα της HTTP απόκρισης. Τα αποτελέσματα μορφοποιούνται ως JSON και είναι ιδανικά για εφαρμογές πραγματικού χρόνου, συμπεριλαμβανομένης της επικύρωσης αριθμών κινητής τηλεφωνίας, της δρομολόγησης κλήσεων και της παράδοσης μηνυμάτων SMS.

Μια σύγχρονη κλήση API αποτελείται από ένα άμεσο αίτημα και απόκριση HTTP. Το σύστημά σας υποβάλλει ένα μεμονωμένο MSISDN (αριθμό κινητού) ανά αίτημα και λαμβάνει μια άμεση απόκριση που περιέχει αποτελέσματα HLR lookup σε πραγματικό χρόνο σε μορφή JSON. Αυτό το API είναι βελτιστοποιημένο για περιπτώσεις χρήσης που απαιτούν άμεση επαλήθευση και ελέγχους συνδεσιμότητας, όπως ανίχνευση απάτης, δρομολόγηση κλήσεων VoIP και βελτιστοποίηση πύλης SMS.

Ασύγχρονο API Αναζήτησης HLR

Το endpoint POST /hlr-lookups έχει σχεδιαστεί για μαζική επεξεργασία μεγάλου όγκου, επιτρέποντάς σας να υποβάλετε έως και 1,000 MSISDN ανά αίτημα. Αντί να επιστρέφει αποτελέσματα άμεσα, αυτό το API χρησιμοποιεί αυτοματοποιημένα webhooks για να στέλνει αποτελέσματα σταδιακά στον διακομιστή σας. Τα αποτελέσματα αναζήτησης επιστρέφονται ως JSON αντικείμενα μέσω HTTP POST callbacks.

Το ασύγχρονο API είναι βελτιστοποιημένο για ταχύτητα, αποδοτικότητα και επεκτασιμότητα. Εξαλείφει τα προβλήματα καθυστέρησης δικτύου που σχετίζονται με σύγχρονες κλήσεις, καθιστώντας το ιδανικό για επιχειρήσεις που χρειάζονται αναζητήσεις υψηλής απόδοσης. Το σύστημά σας υποβάλλει έως και 1,000 MSISDN ανά αίτημα, και η πλατφόρμα μας τα επεξεργάζεται παράλληλα, παραδίδοντας αποτελέσματα πίσω στον διακομιστή σας μέσω HTTP webhooks σε παρτίδες έως και 1,000 αποτελεσμάτων ανά callback.

SDKs (Κιτ Ανάπτυξης Λογισμικού)

Τα Κιτ Ανάπτυξης Λογισμικού (SDKs) μας για PHP, NodeJS και Ruby απλοποιούν τη διαδικασία ενσωμάτωσης, επιτρέποντάς σας να συνδεθείτε με το HLR Lookups API αποτελεσματικά και με ελάχιστη προσπάθεια.

Αυτά τα SDKs παρέχουν προκατασκευασμένες λειτουργίες, διαχείριση πιστοποίησης και δομημένα πρότυπα αιτημάτων API, μειώνοντας τον χρόνο ανάπτυξης και διασφαλίζοντας τις βέλτιστες πρακτικές.

Εξερευνήστε την πλήρη λίστα των διαθέσιμων SDKs μας στο GitHub και ξεκινήστε την ενσωμάτωση σήμερα.

PHP PHP NodeJS NodeJS Ruby Ruby
Λογότυπο PHP

SDK PHP

Άμεση Ενσωμάτωση API για PHP
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

SDK NodeJS

Άμεση Ενσωμάτωση API για NodeJS
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

SDK Ruby

Άμεση Ενσωμάτωση API για Ruby
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)
Μετακίνηση Επάνω

POST/hlr-lookupπροστατευμένο

Εκτελεί σύγχρονη αναζήτηση HLR, παρέχοντας δεδομένα συνδεσιμότητας και φορητότητας κινητών τηλεφώνων σε πραγματικό χρόνο απευθείας από τους φορείς δικτύου. Αυτό το endpoint είναι ιδανικό για σενάρια ζωντανής κίνησης όπου εφαρμογές ευαίσθητες στο χρόνο απαιτούν άμεση επαλήθευση του κατά πόσο ένας αριθμός τηλεφώνου είναι προς το παρόν προσβάσιμος (συνδεδεμένος) ή μη διαθέσιμος (απενεργοποιημένος). Επιπλέον, βοηθά στη διάκριση ενεργών αριθμών από άκυρους, άγνωστους ή πλαστούς.

Για μαζική επεξεργασία μεγάλων συνόλων δεδομένων που δεν απαιτούν άμεσα αποτελέσματα, εξετάστε το ενδεχόμενο χρήσης του ασύγχρονου 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
}

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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) Ένας πενταψήφιος ή εξαψήφιος κωδικός Mobile Country Code (MCC) και Mobile Network Code (MNC) που προσδιορίζει το δίκτυο που σχετίζεται τρέχοντα με τον αριθμό τηλεφώνου. true
mcc string(3) Ένας τριψήφιος κωδικός Mobile Country Code (MCC) που προσδιορίζει τη χώρα όπου είναι εγγεγραμμένος ο αριθμός τηλεφώνου. true
mnc string(2|3) Ένας διψήφιος ή τριψήφιος κωδικός Mobile Network Code (MNC) που προσδιορίζει το συγκεκριμένο δίκτυο στο οποίο ανήκει ο αριθμός τηλεφώνου. true
imsi string Το International Mobile Subscriber Identity (IMSI), ένα μοναδικό αναγνωριστικό για την κάρτα SIM που σχετίζεται με αυτόν τον αριθμό. Η διαθεσιμότητα εξαρτάται από τη διαμόρφωση του δικτύου. true
msin string(10) Ο αριθμός Mobile Subscription Identification Number (MSIN) εντός της βάσης δεδομένων του παρόχου κινητής τηλεφωνίας. Η διαθεσιμότητα εξαρτάται από τη διαμόρφωση του δικτύου. true
msc string(12) Το Mobile Switching Center (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, ανακτώντας ζωντανά δεδομένα συνδεσιμότητας και φορητότητας κινητών τηλεφώνων από τους παρόχους δικτύου. Τα αποτελέσματα παραδίδονται μέσω webhooks στον διακομιστή σας. Αυτή η μέθοδος είναι βελτιστοποιημένη για την επεξεργασία μεγάλου όγκου αριθμών που δεν απαιτούν άμεσες απαντήσεις, όπως ο καθαρισμός και η επαλήθευση βάσεων δεδομένων. Για εφαρμογές πραγματικού χρόνου όπως η δρομολόγηση κλήσεων ή η παράδοση SMS, εξετάστε τη χρήση του endpoint POST /hlr-lookup.

Αυτό το endpoint είναι ιδανικό για μαζική επεξεργασία όταν ο στόχος είναι να εντοπιστούν αριθμοί τηλεφώνου που είναι προς το παρόν προσβάσιμοι (συνδεδεμένοι) ή μη διαθέσιμοι (τηλέφωνο κλειστό), φιλτράροντας ταυτόχρονα μη έγκυρους, μη εκχωρημένους ή ψευδείς αριθμούς. Επιπλέον, παρέχει ζωντανή κατάσταση φορητότητας (MCCMNC) μαζί με λεπτομέρειες συνδεσιμότητας.

Πριν χρησιμοποιήσετε αυτό το endpoint, βεβαιωθείτε ότι έχει ρυθμιστεί ένα URL webhook για την ασύγχρονη λήψη των αποτελεσμάτων αναζήτησης. Μπορείτε να το ρυθμίσετε στις ρυθμίσεις API σας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος Webhooks Αναφορά Κατάστασης
curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookups' \
          -d "@payload.json"

Δεδομένα

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

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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 Τα URLs webhook που έχουν ρυθμιστεί στις ρυθμίσεις API σας. Τα αποτελέσματα αποστέλλονται εδώ. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false

Επεξεργασία Webhooks

Μετά την υποβολή, η πλατφόρμα μας ξεκινά την επεξεργασία των παρεχόμενων αριθμών τηλεφώνου και αποστέλλει τα αποτελέσματα στο URL webhook που έχετε καθορίσει προηγουμένως στον διακομιστή σας. Τα αποτελέσματα μεταδίδονται ως αίτημα HTTP POST με ένα αντικείμενο JSON στο σώμα του αιτήματος.

Πιστοποίηση

Επαληθεύστε το webhook ελέγχοντας την κεφαλίδα HTTP X-Signatures.

Η κεφαλίδα X-Signatures περιέχει μια λίστα υπογραφών διαχωρισμένων με ερωτηματικό. Κάθε υπογραφή στη λίστα δημιουργείται χρησιμοποιώντας ένα από τα μυστικά API που έχουν ρυθμιστεί στον λογαριασμό σας. Για να επαληθεύσετε το webhook, δημιουργήστε ένα hash SHA-256 χρησιμοποιώντας το κλειδί API, το μυστικό και το ακατέργαστο σώμα HTTP - στη συνέχεια συγκρίνετέ το με τις υπογραφές στη λίστα.

Μια αντιστοιχία επιβεβαιώνει ότι το αίτημα είναι αυθεντικό και υπογεγραμμένο με ένα μυστικό που ελέγχετε.

PHP Παράδειγμα Κώδικα

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

Το αίτημα είναι έγκυρο εάν οποιαδήποτε από τις υπογραφές που δίνονται στην κεφαλίδα ισούται με ένα hash SHA256 που υπολογίζεται από τη συνένωση του κλειδιού API, του μυστικού και του σώματος HTTP.

Επιβεβαίωση Παραλαβής

Αναμένεται ο διακομιστής σας να απαντήσει με κωδικό κατάστασης HTTP 200 OK για να επιβεβαιώσει την επιτυχή παραλαβή. Εάν επιστραφεί οποιοσδήποτε άλλος κωδικός απόκρισης, προκύψει λήξη χρονικού ορίου (10 δευτερόλεπτα) ή οποιοδήποτε άλλο πρόβλημα παράδοσης, το σύστημα θα επαναλάβει αυτόματα το webhook μετά από ένα λεπτό. Εάν το αίτημα συνεχίσει να αποτυγχάνει, οι επαναλήψεις θα ακολουθήσουν στρατηγική εκθετικής υποχώρησης, με επόμενες προσπάθειες μετά από 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 λεπτά.

Αυτός ο μηχανισμός επανάληψης διασφαλίζει τη μέγιστη αξιοπιστία στην παράδοση των αποτελεσμάτων αναζήτησης στην υποδομή σας. Ελαχιστοποιεί τον κίνδυνο απώλειας δεδομένων λόγω προσωρινών προβλημάτων δικτύου ή διακοπής λειτουργίας διακομιστή.

Δεδομένα Webhook

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

Χαρακτηριστικά Δεδομένων Webhook

Το αντικείμενο 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) Ένας πενταψήφιος ή εξαψήφιος κωδικός Mobile Country Code (MCC) και Mobile Network Code (MNC) που προσδιορίζει το δίκτυο που σχετίζεται τρέχοντα με τον αριθμό τηλεφώνου. true
mcc string(3) Ένας τριψήφιος κωδικός Mobile Country Code (MCC) που προσδιορίζει τη χώρα όπου είναι εγγεγραμμένος ο αριθμός τηλεφώνου. true
mnc string(2|3) Ένας διψήφιος ή τριψήφιος κωδικός Mobile Network Code (MNC) που προσδιορίζει το συγκεκριμένο δίκτυο στο οποίο ανήκει ο αριθμός τηλεφώνου. true
imsi string Το International Mobile Subscriber Identity (IMSI), ένα μοναδικό αναγνωριστικό για την κάρτα SIM που σχετίζεται με αυτόν τον αριθμό. Η διαθεσιμότητα εξαρτάται από τη διαμόρφωση του δικτύου. true
msin string(10) Ο αριθμός Mobile Subscription Identification Number (MSIN) εντός της βάσης δεδομένων του παρόχου κινητής τηλεφωνίας. Η διαθεσιμότητα εξαρτάται από τη διαμόρφωση του δικτύου. true
msc string(12) Το Mobile Switching Center (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 και παρέχει πληροφορίες φορητότητας αριθμού κινητής τηλεφωνίας και δικτύου. Αυτό το endpoint είναι κατάλληλο εάν ο κύριος στόχος σας είναι η εξαγωγή του τρέχοντος MCCMNC ενός συγκεκριμένου αριθμού κινητής τηλεφωνίας και ο εντοπισμός των αρχικών και τρεχόντων δικτύων σε πραγματικό χρόνο.

Για μαζική επεξεργασία μεγάλων συνόλων δεδομένων που δεν απαιτούν άμεσα αποτελέσματα, εξετάστε το ενδεχόμενο χρήσης του ασύγχρονου POST /mnp-lookups, το οποίο είναι βελτιστοποιημένο για επεξεργασία δέσμης υψηλής ταχύτητας.

Τα ερωτήματα MNP προσδιορίζουν αξιόπιστα τη φορητότητα και τις πληροφορίες δικτύου, αλλά δεν υποδεικνύουν εάν το κινητό τηλέφωνο-στόχος είναι συνδεδεμένο σε δίκτυο και προσβάσιμο αυτή τη στιγμή. Για την εξαγωγή πληροφοριών συνδεσιμότητας σε πραγματικό χρόνο, παρακαλούμε χρησιμοποιήστε το endpoint POST /hlr-lookup.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookup' \
          -d "@payload.json"

Δεδομένα

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

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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 και εντοπίζοντας τα αρχικά και τρέχοντα δίκτυα σε πραγματικό χρόνο. Τα αποτελέσματα παραδίδονται μέσω webhooks στον διακομιστή σας. Αυτή η μέθοδος είναι βελτιστοποιημένη για την επεξεργασία μεγάλου όγκου αριθμών που δεν απαιτούν άμεσες απαντήσεις, όπως ο καθαρισμός και η επαλήθευση βάσεων δεδομένων. Για εφαρμογές πραγματικού χρόνου όπως η δρομολόγηση κλήσεων ή η παράδοση SMS, εξετάστε τη χρήση του endpoint POST /mnp-lookup.

Τα ερωτήματα MNP προσδιορίζουν αξιόπιστα τη φορητότητα και τις πληροφορίες δικτύου, αλλά δεν υποδεικνύουν εάν το κινητό τηλέφωνο-στόχος είναι συνδεδεμένο σε δίκτυο και προσβάσιμο αυτή τη στιγμή. Για την εξαγωγή πληροφοριών συνδεσιμότητας σε πραγματικό χρόνο, παρακαλούμε χρησιμοποιήστε το endpoint POST /hlr-lookups.

Πριν χρησιμοποιήσετε αυτό το endpoint, βεβαιωθείτε ότι έχει ρυθμιστεί ένα URL webhook για την ασύγχρονη λήψη των αποτελεσμάτων αναζήτησης. Μπορείτε να το ρυθμίσετε στις ρυθμίσεις API σας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος Webhooks
curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookups' \
          -d "@payload.json"

Δεδομένα

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

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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 Τα URLs webhook που έχουν ρυθμιστεί στις ρυθμίσεις API σας. Τα αποτελέσματα αποστέλλονται εδώ. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false

Επεξεργασία Webhooks

Μετά την υποβολή, η πλατφόρμα μας ξεκινά την επεξεργασία των παρεχόμενων αριθμών τηλεφώνου και αποστέλλει τα αποτελέσματα στο URL webhook που έχετε καθορίσει προηγουμένως στον διακομιστή σας. Τα αποτελέσματα μεταδίδονται ως αίτημα HTTP POST με ένα αντικείμενο JSON στο σώμα του αιτήματος.

Πιστοποίηση

Επαληθεύστε το webhook ελέγχοντας την κεφαλίδα HTTP X-Signatures.

Η κεφαλίδα X-Signatures περιέχει μια λίστα υπογραφών διαχωρισμένων με ερωτηματικό. Κάθε υπογραφή στη λίστα δημιουργείται χρησιμοποιώντας ένα από τα μυστικά API που έχουν ρυθμιστεί στον λογαριασμό σας. Για να επαληθεύσετε το webhook, δημιουργήστε ένα hash SHA-256 χρησιμοποιώντας το κλειδί API, το μυστικό και το ακατέργαστο σώμα HTTP - στη συνέχεια συγκρίνετέ το με τις υπογραφές στη λίστα.

Μια αντιστοιχία επιβεβαιώνει ότι το αίτημα είναι αυθεντικό και υπογεγραμμένο με ένα μυστικό που ελέγχετε.

PHP Παράδειγμα Κώδικα

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

Το αίτημα είναι έγκυρο εάν οποιαδήποτε από τις υπογραφές που δίνονται στην κεφαλίδα ισούται με ένα hash SHA256 που υπολογίζεται από τη συνένωση του κλειδιού API, του μυστικού και του σώματος HTTP.

Επιβεβαίωση Παραλαβής

Αναμένεται ο διακομιστής σας να απαντήσει με κωδικό κατάστασης HTTP 200 OK για να επιβεβαιώσει την επιτυχή παραλαβή. Εάν επιστραφεί οποιοσδήποτε άλλος κωδικός απόκρισης, προκύψει λήξη χρονικού ορίου (10 δευτερόλεπτα) ή οποιοδήποτε άλλο πρόβλημα παράδοσης, το σύστημα θα επαναλάβει αυτόματα το webhook μετά από ένα λεπτό. Εάν το αίτημα συνεχίσει να αποτυγχάνει, οι επαναλήψεις θα ακολουθήσουν στρατηγική εκθετικής υποχώρησης, με επόμενες προσπάθειες μετά από 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 λεπτά.

Αυτός ο μηχανισμός επανάληψης διασφαλίζει τη μέγιστη αξιοπιστία στην παράδοση των αποτελεσμάτων αναζήτησης στην υποδομή σας. Ελαχιστοποιεί τον κίνδυνο απώλειας δεδομένων λόγω προσωρινών προβλημάτων δικτύου ή διακοπής λειτουργίας διακομιστή.

Δεδομένα Webhook

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

Χαρακτηριστικά Δεδομένων Webhook

Το αντικείμενο 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). Αυτό το endpoint είναι ιδανικό εάν ο κύριος στόχος σας είναι να προσδιορίσετε εάν οι παρεχόμενοι τηλεφωνικοί αριθμοί ανήκουν σε εύρη σταθερής τηλεφωνίας, κινητής τηλεφωνίας, υψηλής χρέωσης, VoIP, τηλεειδοποίησης ή άλλων σχεδίων αρίθμησης σε πραγματικό χρόνο.

Τα ερωτήματα NT εντοπίζουν αξιόπιστα τον τύπο τηλεφωνικού αριθμού, ωστόσο δεν υποδεικνύουν εάν ο αριθμός-στόχος είναι επί του παρόντος συνδεδεμένος σε δίκτυο και προσβάσιμος. Για να εξαγάγετε πληροφορίες ζωντανής συνδεσιμότητας, παρακαλούμε χρησιμοποιήστε το endpoint POST /hlr-lookup.

Εάν η περίπτωση χρήσης σας απαιτεί ακριβείς πληροφορίες δικτύου και φορητότητας (MCCMNC) αλλά όχι κατάσταση ζωντανής συνδεσιμότητας, παρακαλούμε χρησιμοποιήστε το endpoint POST /mnp-lookup για ερωτήματα φορητότητας κινητού αριθμού.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος Αναφορά Τύπων
curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookup' \
          -d "@payload.json"

Δεδομένα

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

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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 Υποδεικνύει εάν ο αριθμός τηλεφώνου είναι vanity number, δηλαδή περιλαμβάνει αλφαβητικούς χαρακτήres. 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 Αριθμός τηλεφώνου Voice over IP. Περιλαμβάνει αριθμούς TSoIP (Telephony Service over IP).
PAGER Αριθμός τηλεφώνου βομβητή. Συνήθως χωρίς λειτουργία φωνής.
UAN Αριθμός Καθολικής Πρόσβασης (Αριθμός Εταιρείας). Μπορεί να δρομολογείται σε συγκεκριμένα γραφεία αλλά επιτρέπει τη χρήση ενός αριθμού για ολόκληρη την εταιρεία.
VOICEMAIL Αριθμός τηλεφώνου φωνητικού ταχυδρομείου.
UNKNOWN Δεν ήταν δυνατός ο προσδιορισμός του τύπου αριθμού.
Μετακίνηση Επάνω

POST/nt-lookups προστατευμένο

Αυτό το endpoint εκτελεί μια σειρά από ασύγχρονες αναζητήσεις τύπου αριθμού με αποτελέσματα που αποστέλλονται πίσω στον διακομιστή σας μέσω webhook. Είναι κατάλληλο εάν ο κύριος στόχος σας είναι να προσδιορίσετε εάν οι δοσμένοι τηλεφωνικοί αριθμοί ανήκουν σε σταθερές γραμμές, κινητά, premium rate, VoIP, pager ή άλλες κατηγορίες του σχεδίου αρίθμησης. Βελτιστοποιημένο για ταχεία επεξεργασία μεγάλων όγκων αριθμών, αυτό το endpoint είναι ιδανικό για μαζικές λειτουργίες (π.χ. εξυγίανση βάσης δεδομένων). Για ζωντανή κίνηση και χρονικά κρίσιμες περιπτώσεις χρήσης, παρακαλούμε χρησιμοποιήστε το endpoint POST /nt-lookup.

Πρέπει να ορίσετε ένα webhook URL στις ρυθμίσεις API σας ως προαπαιτούμενο για την κλήση αυτού του endpoint.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος Webhooks Αναφορά Τύπων
curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookups' \
          -d "@payload.json"

Δεδομένα

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

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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 Τα URLs webhook που έχουν ρυθμιστεί στις ρυθμίσεις API σας. Τα αποτελέσματα αποστέλλονται εδώ. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false

Επεξεργασία Webhooks

Μετά την υποβολή, η πλατφόρμα μας ξεκινά την επεξεργασία των παρεχόμενων αριθμών τηλεφώνου και αποστέλλει τα αποτελέσματα στο URL webhook που έχετε καθορίσει προηγουμένως στον διακομιστή σας. Τα αποτελέσματα μεταδίδονται ως αίτημα HTTP POST με ένα αντικείμενο JSON στο σώμα του αιτήματος.

Πιστοποίηση

Επαληθεύστε το webhook ελέγχοντας την κεφαλίδα HTTP X-Signatures.

Η κεφαλίδα X-Signatures περιέχει μια λίστα υπογραφών διαχωρισμένων με ερωτηματικό. Κάθε υπογραφή στη λίστα δημιουργείται χρησιμοποιώντας ένα από τα μυστικά API που έχουν ρυθμιστεί στον λογαριασμό σας. Για να επαληθεύσετε το webhook, δημιουργήστε ένα hash SHA-256 χρησιμοποιώντας το κλειδί API, το μυστικό και το ακατέργαστο σώμα HTTP - στη συνέχεια συγκρίνετέ το με τις υπογραφές στη λίστα.

Μια αντιστοιχία επιβεβαιώνει ότι το αίτημα είναι αυθεντικό και υπογεγραμμένο με ένα μυστικό που ελέγχετε.

PHP Παράδειγμα Κώδικα

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

Το αίτημα είναι έγκυρο εάν οποιαδήποτε από τις υπογραφές που δίνονται στην κεφαλίδα ισούται με ένα hash SHA256 που υπολογίζεται από τη συνένωση του κλειδιού API, του μυστικού και του σώματος HTTP.

Επιβεβαίωση Παραλαβής

Αναμένεται ο διακομιστής σας να απαντήσει με κωδικό κατάστασης HTTP 200 OK για να επιβεβαιώσει την επιτυχή παραλαβή. Εάν επιστραφεί οποιοσδήποτε άλλος κωδικός απόκρισης, προκύψει λήξη χρονικού ορίου (10 δευτερόλεπτα) ή οποιοδήποτε άλλο πρόβλημα παράδοσης, το σύστημα θα επαναλάβει αυτόματα το webhook μετά από ένα λεπτό. Εάν το αίτημα συνεχίσει να αποτυγχάνει, οι επαναλήψεις θα ακολουθήσουν στρατηγική εκθετικής υποχώρησης, με επόμενες προσπάθειες μετά από 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 λεπτά.

Αυτός ο μηχανισμός επανάληψης διασφαλίζει τη μέγιστη αξιοπιστία στην παράδοση των αποτελεσμάτων αναζήτησης στην υποδομή σας. Ελαχιστοποιεί τον κίνδυνο απώλειας δεδομένων λόγω προσωρινών προβλημάτων δικτύου ή διακοπής λειτουργίας διακομιστή.

Δεδομένα Webhook

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

Χαρακτηριστικά Δεδομένων Webhook

Το αντικείμενο 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 Υποδεικνύει εάν ο αριθμός τηλεφώνου είναι vanity number, δηλαδή περιλαμβάνει αλφαβητικούς χαρακτήres. 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 Αριθμός τηλεφώνου Voice over IP. Περιλαμβάνει αριθμούς TSoIP (Telephony Service over IP).
PAGER Αριθμός τηλεφώνου βομβητή. Συνήθως χωρίς λειτουργία φωνής.
UAN Αριθμός Καθολικής Πρόσβασης (Αριθμός Εταιρείας). Μπορεί να δρομολογείται σε συγκεκριμένα γραφεία αλλά επιτρέπει τη χρήση ενός αριθμού για ολόκληρη την εταιρεία.
VOICEMAIL Αριθμός τηλεφώνου φωνητικού ταχυδρομείου.
UNKNOWN Δεν ήταν δυνατός ο προσδιορισμός του τύπου αριθμού.
Μετακίνηση Επάνω

GET/routeπροστατευμένο

Ανακτά τη διαδρομή που θα επιλεγεί αυτόματα όταν εκτελείτε αναζήτηση HLR χωρίς να καθορίσετε την παράμετρο route.

Η αυτόματη επιλογή διαδρομής βασίζεται στον χάρτη δρομολόγησης που ανακτάται με το endpoint GET /hlr-coverage, το οποίο προέρχεται κυρίως από το GET /routing-map. Μπορείτε να προσαρμόσετε τον χάρτη δρομολόγησής σας και να ορίσετε προσαρμοσμένους κανόνες στις ρυθμίσεις λογαριασμού σας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/route?msisdn=+491788735000'

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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προστατευμένο

Αυτό το endpoint επιστρέφει μια λίστα με τις διαθέσιμες διαδρομές 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 για τον λογαριασμό σας. Αυτή η προεπιλεγμένη διαμόρφωση χρησιμοποιείται κάθε φορά που υποβάλλετε αναζητήσεις HLR χωρίς να καθορίζετε παράμετρο route. Μπορείτε να προσαρμόσετε τον χάρτη δρομολόγησής σας και να δημιουργήσετε προσαρμοσμένους κανόνες στις ρυθμίσεις λογαριασμού σας.

Η ιεραρχία διαμόρφωσης εφαρμόζεται διαδοχικά από κανόνες επιπέδου χώρας σε κανόνες επιπέδου 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 στις αυτόματα επιλεγμένες διαδρομές τους. Κατά την εκτέλεση αναζήτησης HLR για έναν αριθμό σε συγκεκριμένο MCCMNC, χρησιμοποιείται η αντίστοιχη διαδρομή. 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 για την υποστήριξη λήψης αποφάσεων βασισμένων σε δεδομένα. Αυτό το endpoint σας βοηθά να αναλύσετε τις επιλογές δρομολόγησης HLR σε πραγματικό χρόνο σε δίκτυα κινητής τηλεφωνίας, να εντοπίσετε τις πιο αποτελεσματικές διαδρομές για τις περιοχές-στόχους σας και να διαμορφώσετε την αυτόματη δρομολόγησή σας.

Οι προτεινόμενες διαδρομές από το GET /route βασίζονται στα δεδομένα κάλυψης που ανακτώνται εδώ. Τα δεδομένα κάλυψης είναι επίσης διαθέσιμα στη σελίδα κάλυψη δικτύου. Μπορείτε να προσαρμόσετε περαιτέρω τον χάρτη δρομολόγησής σας και να ορίσετε κανόνες στις ρυθμίσεις λογαριασμού σας.

Συνιστούμε να εξοικειωθείτε με αυτόν τον οδηγό για να σας βοηθήσει στην ερμηνεία των αποτελεσμάτων.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος Αναφορά Κατάστασης
curl 'https://www.hlr-lookups.com/api/v2/hlr-coverage?countrycode=XX'

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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[] Μια λίστα με MCC (κωδικούς χώρας κινητής τηλεφωνίας) που σχετίζονται με την επιλεγμένη χώρα. 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προστατευμένο

Αυτό το endpoint επιστρέφει μια λίστα με παρόχους κινητής τηλεφωνίας, μαζί με τους αντίστοιχους αναγνωριστικούς MCCMNC τους, που υποστηρίζονται επί του παρόντος για αναζητήσεις φορητότητας αριθμών κινητής τηλεφωνίας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/mnp-coverage?countrycode=XX'

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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προστατευμένο

Αυτό το endpoint επιστρέφει μια λίστα χωρών όπου υποστηρίζονται μόνο αναζητήσεις 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προστατευμένο

Αυτό το endpoint επιστρέφει μια ολοκληρωμένη λίστα παρόχων κινητής τηλεφωνίας μαζί με τους αντίστοιχους αναγνωριστικούς MCCMNC και πρόσθετες πληροφορίες πλαισίου.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/mccmncs?countrycode=XX'

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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προστατευμένο

Αυτό το endpoint επιστρέφει την τιμή για αναζήτηση HLR, MNP ή NT.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/price?msisdn=+491788735000&route_type=HLR'

Παράμετροι Αιτήματος

Κλειδί Τύπος Περιγραφή Προεπιλογή Υποχρεωτικό
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προστατευμένο

Αυτό το endpoint επιστρέφει την τιμολόγηση στον λογαριασμό σας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
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προστατευμένο

Αυτό το endpoint ανακτά το τρέχον υπόλοιπο του λογαριασμού σας, επιτρέποντάς σας να αυτοματοποιήσετε διαδικασίες με βάση την πιστωτική σας κατάσταση. Λειτουργεί απρόσκοπτα με τις ειδοποιήσεις χαμηλής πίστωσης μέσω email που μπορείτε να ρυθμίσετε στη σελίδα πληρωμών σας.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/balance'
{
    "balance":"1002.90"
}

Χαρακτηριστικά Απόκρισης Επιτυχίας

Όνομα Τύπος Περιγραφή Μηδενικό
balance string Το τρέχον υπόλοιπο του λογαριασμού σας σε EUR. Μια δεκαδική τιμή τύπου string. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false
Μετακίνηση Επάνω

GET/pingδημόσιο

Αυτό το endpoint στέλνει ένα αίτημα 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δημόσιο

Αυτό το endpoint επιστρέφει μια χρονική σήμανση Unix που αντιπροσωπεύει την τρέχουσα ώρα στον διακομιστή HLR Lookups. Χρησιμοποιήστε το για να συγχρονίσετε το ρολόι του διακομιστή σας κατά τη δημιουργία της υπογραφής Digest-Auth για έλεγχο ταυτότητας, διασφαλίζοντας ότι τυχόν αποκλίσεις μεταξύ της ώρας του διακομιστή σας και της ώρας του διακομιστή HLR Lookups διορθώνονται.

Αίτημα Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/time'
{
    "time":1525898643
}

Χαρακτηριστικά Απόκρισης Επιτυχίας

Όνομα Τύπος Περιγραφή Μηδενικό
time integer Χρονική σήμανση Unix που αντιπροσωπεύει την τρέχουσα ώρα του διακομιστή HLR Lookups. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false
Μετακίνηση Επάνω

GET/auth-testπροστατευμένο

Αυτό το endpoint χρησιμεύει ως αρχική δοκιμή για την υλοποίηση Basic-Auth ή, κατά προτίμηση, Digest-Auth.

Αίτηση Basic Auth Αίτημα Digest Auth Απόκριση Επιτυχίας Απόκριση Σφάλματος
curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: YOUR_API_KEY" 

Headers Αίτησης

Κλειδί Τύπος Περιγραφή
X-Basic string SHA256 hash του YOUR_API_KEY:YOUR_API_SECRET. Συμπεριλάβετε το σύμβολο άνω και κάτω τελείας (:) στο 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" 

Headers Αίτησης

Κλειδί Τύπος Περιγραφή
X-Digest-Key string Το API Key σας για HLR Lookups
X-Digest-Signature string Μοναδική υπογραφή Digest-Auth (δείτε πιστοποίηση)
X-Digest-Timestamp integer Τρέχουσα χρονική σήμανση Unix (δείτε επίσης GET /time)
{
    "success":true
}

Χαρακτηριστικά Απόκρισης Επιτυχίας

Όνομα Τύπος Περιγραφή Μηδενικό
success boolean Υποδεικνύει ότι το αίτημα επεξεργάστηκε επιτυχώς. false
{
    "errors":[
        "Service unavailable."
    ]
}

Παράμετροι Απόκρισης Σφάλματος

Όνομα Τύπος Περιγραφή Μηδενικό
errors[] string[] Μια λίστα συμβολοσειρών που επεξηγούν το σφάλμα. false
Μετακίνηση Επάνω

Τεκμηρίωση Legacy API

Σημειώστε ότι το legacy API έχει καταργηθεί και είναι προγραμματισμένο να αποσυρθεί στο μέλλον. Συνιστούμε ανεπιφύλακτα την αναβάθμιση στην τελευταία έκδοση το συντομότερο δυνατό.

Εάν ενσωματώσατε το HLR Lookups API μεταξύ 2013 και αρχών 2020, χρησιμοποιείτε το legacy API. Σε αυτή την περίπτωση, ανατρέξτε στην τεκμηρίωση του legacy API.

Τεκμηρίωση Legacy API
Περιστρεφόμενος Φορτωτής Διαφανές Gif