Get SMS Details
Description
Returns detailed information about a particular SMS message sent by Control Center to a device or sent by a device to Control Center. You cannot get information about messages exchanged between a device and a non-Control Center SMS client.
Users with Essential accounts must purchase the Essential SMS Service package in order to use this API.
Resource URL
GET rws/api/v{apiVersion}/smsMessages/{smsMsgId}
Request Parameters
Parameter | Description |
---|---|
apiVersion |
The version number for this API. The current version for all functions is 1. |
smsMsgId | A unique identifier for the SMS message you want to retrieve. |
messageEncoding | (Optional) The type of message encoding used. Valid values are: LITERAL (default) or BASE64. |
Response Parameters
Return Value | Description |
---|---|
smsMsgId | A unique identifier for the SMS message. |
status |
The message delivery status. Valid values depend on the message type.
|
messageText | The content of the SMS message. |
senderLogin |
Identifies the message sender. For mobile-originated messages, this value is Mobile Device. For mobile-terminated messages, the value is the Control Center user name. |
sentTo |
Identifies the recipient of the message. If the recipient is Control Center, the value is Server. Otherwise, the recipient device’s MSISDN, the equivalent of a phone number, appears. |
sentFrom |
Identifies the device or computer that sent the message. If the sender is Control Center, the value is Server. Otherwise, the sending device’s MSISDN, the equivalent of a phone number, appears. |
msgType | Message Type indicates whether the message was sent by the device (MO, mobile-originated) or received by the device (MT, mobile-terminated). |
dateSent | The date and time (including the time zone) when the message was sent. See Date Formats. |
dateReceived | The date and time (including the time zone) when Control Center received the message. See Date Formats. |
dateModified | The date and time (including the time zone) when the delivery status changed. See Date Formats. |
Request Example
Make sure to use your own user credentials. See Authentication for information about creating an authorization header.
Response Example
Code Samples
Make sure to use the Control Center sandbox URL and your own user credentials.
Errors
Error Code | HTTP Code | Error Message |
---|---|---|
10000001 | 401 |
Invalid credentials. Description: Control Center uses this error message when the API credentials are invalid or when the IP address is not within the allowed range. |
10000017 | 400 | Invalid messageEncoding. |
10000024 | 400 | Invalid apiVersion. |
20000002 | 404 | Resource not found - Invalid smsMsgId. |
30000001 | 500 | Unknown server error. |