Send SMS

This API is used to send plain text messages or other data, such as small files or OTA commands, to a subscriber.

HTTP URL
POST	/api/v3/subscriber/{type}/{value}/send-sms

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

N/A

API Request

Request Structure

Parameter	Type	M/O/CM	Description
message	String	M	Message body.
isText	Boolean	O	Specify if the SMS should be sent as a text message or a binary message. True = Send a text message False = Send a binary message Default (if not provided) = True – Send text message.
expiration	Numeric	O	Set Store&Forward requested time in seconds when the device is not reachable. Minimum allowed value: 120 seconds Maximum allowed value: 2678400 seconds Default (if not populated): 7200 seconds.
advancedSettings	Object	O	SMS advanced settings object. Note: The user must be careful if trying to configure the SMS by himself.

advancedSettings object

Parameter	Type	M/O/CM	Description
dataCoding	Numeric	O	Data coding valid values as defined in 3GPP TS 23.038. If not populated for text SMS, the system will use GSM 7-bit. If not populated for binary SMS, the system will use 8-bit data.
protocolId	Numeric	O	TP-Protocol Identifier. Valid values as defined in 3GPP TS 23.040. Ignored if populated for text SMS. Developer Notes: If not populated for a binary SMS, send to SMSC the value “127” or hexa equivalent (“0x7F”).

Parameter

Type

M/O/CM

Description

dataCoding

Numeric

Data coding valid values as defined in 3GPP TS 23.038.

If not populated for text SMS, the system will use GSM 7-bit.

If not populated for binary SMS, the system will use 8-bit data.

protocolId

Numeric

TP-Protocol Identifier. Valid values as defined in 3GPP TS 23.040.

Ignored if populated for text SMS.

Developer Notes: If not populated for a binary SMS, send to SMSC the value “127” or hexa equivalent (“0x7F”).

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code. See list below, under ‘Error Codes’ section.
errorMessage	String	O	Failure detailed description. See list below, under ‘Error Codes’ section.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed.

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress

Successful

Failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
GLOBAL_1006	Invalid SMSC
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1012	Failed to send SMS

Examples

Request Body

Copy

{
  "message": "hello",
  "dataCoding": 0,
  "esmClass": 0,
  "protocolId": 0,
  "priorityFlag": 0,
  "expiration": 3000
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1012",
  "errorMessage": "Failed to send SMS",
  "content": "",
  "pageable": ""
}