SMS MT Inbound vHLR API

1. Introduction

The HORISEN SMS MT Inbound vHLR API is designed to manage and configure vHLR settings on SS7 Platform.

This API belongs to the SS7 domain. The subject domain of an endpoint URL is:

{address}:{port}/smsmtinbound/v1

2. Methods Overview

Endpoints for working with SMS MT Inbound vHLR.

3. Methods Details

Endpoints for working with SMS MT Inbound vHLR.

Method Overview

The method retrieves a list of vHLR settings.

Parameters

Name	Type	Description
X‑API‑Key (required)	string (header)	API key for authentication. Default value: 1111.

Responses

Code	Description	Links
200	List of vHLR settings successfully retrieved.	No links.
404	Resource is not found.	No links.

Success Response 200: List of vHLR settings successfully retrieved

[
  {
    "id": 0,
    "gt": "string",
    "cache_ttl": 0,
    "check_data_missing_error_code": 0,
    "check_sccp_data_wrong_error_code": 0,
    "check_unknown_sub_error_code": 0,
    "check_imsi_not_in_db_error_code": 0,
    "check_imsi_not_in_cache_error_code": 0,
    "check_imsi_was_processed_error_code": 0
  }
]

Error Response 404: Resource not found

Method Overview

The method updates a vHLR settings by a given ID.

Parameters

Name	Type	Description
X‑API‑Key (required)	string (header)	API key for authentication. Default value: 1111.
id (required)	integer($int64) (path)	ID of a vHLR.
data (required)	object (body)	Updated vHLR object. Find below VirtualHLR data model description.

Data Parameters

Put data object example

{
  "id": 0,
  "gt": "string",
  "cache_ttl": 0,
  "check_data_missing_error_code": 0,
  "check_sccp_data_wrong_error_code": 0,
  "check_unknown_sub_error_code": 0,
  "check_imsi_not_in_db_error_code": 0,
  "check_imsi_not_in_cache_error_code": 0,
  "check_imsi_was_processed_error_code": 0
}

Responses

Code	Description	Links
200	vHLR updated successfully.	No links.
400	Invalid request data.	No links.
404	vHLR not found.	No links.

Success Response 200: vHLR updated successfully

{
  "id": 0,
  "gt": "string",
  "cache_ttl": 0,
  "check_data_missing_error_code": 0,
  "check_sccp_data_wrong_error_code": 0,
  "check_unknown_sub_error_code": 0,
  "check_imsi_not_in_db_error_code": 0,
  "check_imsi_not_in_cache_error_code": 0,
  "check_imsi_was_processed_error_code": 0
}

Error Response 400: Invalid request data

Error Response 404: Resource not found

4. Data Models

Data Models define the structure of a JSON document and describe the data related to the SMS MT Inbound vHLR API.

4.1 VirtualHLR

VirtualHLR object properties:

Name	Type	Description
id	integer($int64)	ID of VirtualHLR.
gt	string	GT of VirtualHLR.
cache_ttl	integer	Cache TTL value. Time when IMSI will be expired in the cache DB.
check_data_missing_error_code	integer	Check Data Missing Error Code. If at least one of the mandatory field is missed or incorrect.
check_sccp_data_wrong_error_code	integer	Check SCCP Data Wrong Error Code. If SCCP_CldPA_GT in FSM_MT_Req doesn’t belong to SS7 Proxy vMSC GT.
check_unknown_sub_error_code	integer	Check Unknown Subscriber Error Code. Check if recipient MSISDN is not found in NP DB.
check_imsi_not_in_db_error_code	integer	Check IMSI Not in Database Error Code. If FSM_MT_Req contains incorrect IMSI.
check_imsi_not_in_cache_error_code	integer	Check IMSI Not in Cache Error Code. If IMSI is not found in the cache.
check_imsi_was_processed_error_code	integer	Check IMSI Was Processed Error Code. More than 2 FSM_SM_Req received with the same IMSI.

JSON Example

{
  "id": 0,
  "gt": "string",
  "cache_ttl": 0,
  "check_data_missing_error_code": 0,
  "check_sccp_data_wrong_error_code": 0,
  "check_unknown_sub_error_code": 0,
  "check_imsi_not_in_db_error_code": 0,
  "check_imsi_not_in_cache_error_code": 0,
  "check_imsi_was_processed_error_code": 0
}

4.2 Error

Error object properties:

Name	Type	Description
code (required)	string	Error code.
message (required)	string	Error message.

JSON Example

{
  "Code": "string",
  "Message": "string"
}

5. API Call Examples

This section presents a set of sample cURL API calls that shows some of use cases for the API.

1. An example of how to get a list of vHLR settings is given below:

curl -H "X-API-Key: 1111" -X GET http://{address}:{port}/smsmtinbound/v1/vhlr

2. An example of how to get a vHLR settings with a given ID:

curl -H "X-API-Key: 1111" -X GET http://{address}:{port}/smsmtinbound/v1/vhlr/1