HLR Lookup API Server

HLR

doHlrLookup

Get Info about the MSISDN from SS7 Network

Perform HLR Lookup for provided MSISDN, the Output depend on the avaiable Info at SS7 Network


/hlr/lookup/{msisdn}

Usage and SDK Samples

curl -X GET -H "API-ID: [[apiKey]]" -H "API-KEY: [[apiKey]]" "https://hlr.telcovillage.com/hlr/lookup/{msisdn}?appId=[[apiKey]]&appKey=[[apiKey]]"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HLRApi;

import java.io.File;
import java.util.*;

public class HLRApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiIdAuth
        ApiKeyAuth ApiIdAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiIdAuth");
        ApiIdAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiIdAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        HLRApi apiInstance = new HLRApi();
        String msisdn = msisdn_example; // String | MSISDN that want to get more info about it
        try {
            HLRLookupResponse result = apiInstance.doHlrLookup(msisdn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HLRApi#doHlrLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HLRApi;

public class HLRApiExample {

    public static void main(String[] args) {
        HLRApi apiInstance = new HLRApi();
        String msisdn = msisdn_example; // String | MSISDN that want to get more info about it
        try {
            HLRLookupResponse result = apiInstance.doHlrLookup(msisdn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HLRApi#doHlrLookup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-ID"];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-KEY"];

String *msisdn = msisdn_example; // MSISDN that want to get more info about it

HLRApi *apiInstance = [[HLRApi alloc] init];

// Get Info about the MSISDN from SS7 Network
[apiInstance doHlrLookupWith:msisdn
              completionHandler: ^(HLRLookupResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HlrLookupApiServer = require('hlr_lookup_api_server');
var defaultClient = HlrLookupApiServer.ApiClient.instance;

// Configure API key authorization: ApiIdAuth
var ApiIdAuth = defaultClient.authentications['ApiIdAuth'];
ApiIdAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiIdAuth.apiKeyPrefix['API-ID'] = "Token"

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['API-KEY'] = "Token"

var api = new HlrLookupApiServer.HLRApi()

var msisdn = msisdn_example; // {String} MSISDN that want to get more info about it


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doHlrLookup(msisdn, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doHlrLookupExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiIdAuth
            Configuration.Default.ApiKey.Add("API-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-ID", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-KEY", "Bearer");

            var apiInstance = new HLRApi();
            var msisdn = msisdn_example;  // String | MSISDN that want to get more info about it

            try
            {
                // Get Info about the MSISDN from SS7 Network
                HLRLookupResponse result = apiInstance.doHlrLookup(msisdn);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HLRApi.doHlrLookup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiIdAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('API-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-ID', 'Bearer');
// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-KEY', 'Bearer');

$api_instance = new Swagger\Client\Api\HLRApi();
$msisdn = msisdn_example; // String | MSISDN that want to get more info about it

try {
    $result = $api_instance->doHlrLookup($msisdn);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HLRApi->doHlrLookup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HLRApi;

# Configure API key authorization: ApiIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'API-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'API-ID'} = "Bearer";
# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HLRApi->new();
my $msisdn = msisdn_example; # String | MSISDN that want to get more info about it

eval { 
    my $result = $api_instance->doHlrLookup(msisdn => $msisdn);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HLRApi->doHlrLookup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiIdAuth
swagger_client.configuration.api_key['API-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['API-ID'] = 'Bearer'
# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HLRApi()
msisdn = msisdn_example # String | MSISDN that want to get more info about it

try: 
    # Get Info about the MSISDN from SS7 Network
    api_response = api_instance.do_hlr_lookup(msisdn)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HLRApi->doHlrLookup: %s\n" % e)

Parameters

Path parameters
Name Description
msisdn*
String
MSISDN that want to get more info about it
Required

Responses

Status: 200 - OK

Status: 404 - MSISDN not found

Status: 405 - Validation exception

Status: 500 - Internal Error