SMS MT Inbound Routing API

1. Introduction

The HORISEN SMS MT Inbound Routing API is designed to provision SMS MT inbound routing 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 Routing.

3. Methods Details

Endpoints for working with SMS MT Inbound Routing.

Method Overview

The method creates an SMS MT Inbound Routing Connection.

Parameters

Name	Type	Description
X‑API‑Key (required)	string (header)	API key for authentication. Default value: 1111.
data (required)	object (body)	SMS MT Inbound Routing object. Find below SMSMTINRouting data model description.

Data Parameters

Post data object example

{
  "id": 0,
  "sigtran_connect_id": "string",
  "smpp_connect_id": "string",
  "esme_connect_id": "string"
}

Responses

Code	Description	Links
200	SMS MT Inbound Routing created successfully.	No links.
default	Unexpected Error.	No links.

Success Response 200: SMS MT Inbound Routing created successfully

{
  "id": 0,
  "sigtran_connect_id": "string",
  "smpp_connect_id": "string",
  "esme_connect_id": "string"
}

Error Response Unexpected Error: Default

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

Method Overview

The method retrieves a list of SMS MT Inbound Routing.

Parameters

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

Responses

Code	Description	Links
200	List of SMS MT Inbound Routing successfully retrieved.	No links.

Success Response 200: List of SMS MT Inbound Routing successfully retrieved

[
  {
    "id": 0,
    "sigtran_connect_id": "string",
    "smpp_connect_id": "string",
    "esme_connect_id": "string"
  }
]

Error Response 404: Resource not found

Method Overview

The method retrieves an SMS MT Inbound Routing 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 an SMS MT Inbound Routing.

Responses

Code	Description	Links
200	SMS MT Inbound Routing successfully retrieved.	No links.
404	SMS MT Inbound Routing not found.	No links.

Success Response 200: SMS MT Inbound Routing successfully retrieved

{
  "id": 0,
  "sigtran_connect_id": "string",
  "smpp_connect_id": "string",
  "esme_connect_id": "string"
}

Error Response 404: SMS MT Inbound Routing not found

Method Overview

The method updates an SMS MT Inbound Routing details 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 an SMS MT Inbound Routing.
data (required)	object (body)	Updated SMS MT Inbound Routing object.

Data Parameters

Put data object example

{
  "id": 0,
  "sigtran_connect_id": "string",
  "smpp_connect_id": "string",
  "esme_connect_id": "string"
}

Responses

Code	Description	Links
200	SMS MT Inbound Routing updated successfully.	No links.
400	Invalid request data.	No links.
404	SMS MT Inbound Routing not found.	No links.

Success Response 200: SMS MT Inbound Routing updated successfully

Error Response 400: Invalid request

Error Response 404: Resource not found

Method Overview

The method deletes an SMS MT Inbound Routing 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 an SMS MT Inbound Routing to be deleted.

Responses

Code	Description	Links
200	SMS MT Inbound Routing deleted successfully.	No links.
404	SMS MT Inbound Routing not found.	No links.

Success Response 200: SMS MT Inbound Routing deleted successfully

Error Response 404: SMS MT Inbound Routing not found

4. Data Models

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

4.1 SMSMTINRouting

SMSMTINRouting object properties:

Name	Type	Description
id	integer($int64)	ID of an SMS MT Inbound Route.
sigtran_connect_id	string	ID of the SIGTRAN connection.
smpp_connect_id	string	ID of an SMPP connection. This can be set either to smsc_connect_id or esme_connect_id. If one of them is not used, set the default to 0. Simultaneous use of smsc_connect_id and esme_connect_id will lead to incorrect traffic operation.
esme_connect_id	string	ID of an ESME. This can be set either to smsc_connect_id or esme_connect_id. If one of them is not used, set the default to 0. Simultaneous use of smsc_connect_id and esme_connect_id will lead to incorrect traffic operation.

JSON Example

{
  "id": 0,
  "sigtran_connect_id": "string",
  "smpp_connect_id": "string",
  "esme_connect_id": "string"
}

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 SMS MT Inbound Routing:

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

2. An example of how to get a Routing Connection with the given ID:

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

3. An example of how to create an SMS MT Inbound Routing Connection:

curl -H "X-API-Key: 1111" -X POST -H "Content-Type: application/json" -d 
'{
  "sigtran_connect_id": 1,
  "smpp_connect_id": 1,
  "esme_connect_id": 0
  }' http://{address}:{port}/smsmtinbound/v1/smsmtin-routes

4. An example of how to update an SMS MT Inbound Routing details by the given ID:

curl -H "X-API-Key: 1111" -X PUT -H "Content-Type: application/json" -d 
'{
  "sigtran_connect_id": 1,
  "smpp_connect_id": 1,
  "esme_connect_id": 1
  }' http://{address}:{port}/smsmtinbound/v1/smsmtin-routes/1

5. An example of how to delete an SMS MT Inbound Routing with the given ID:

curl -H "X-API-Key: 1111" -X DELETE http://{address}:{port}/smsmtinbound/v1/smsmtin-routes/1