SMS
General Parameters
| Parameter | Description | Example |
| Token and Signature | Used to authenticate your request. They are proxies for your username and password | Use GetParameters to generate token and signature from your username and password. |
| TrackingId | Id of the message previously sent by your application. The ID is returned to your application after API accepted the sending request. |
The following operations are supported. For a formal definition, please review the Service Description.
-
DeleteMessage
Used to delete a message by Id. -
GetBottomMessage
Used to get the earliest new SMS message in inbox. After the completion of this request, the status of the message is automatically set to IsRead=TRUE. -
GetBottomMessage2
Used to get the earliest new SMS message in inbox. After the completion of this request, the status of the message is automatically set to IsRead2=TRUE. -
GetBottomMessageNoReset
Used to get the earliest new SMS message in inbox. The function returns messageId of the message that was collected. The status of the message does not change (IsRead remains FALSE). To set flag to TRUE, your application must call function SetMessageReadFlag. -
GetBottomMessageNoReset2
Used to get the earliest new SMS message in inbox. The function returns messageId of the message that was collected. The status of the message does not change (IsRead2 remains FALSE). To set flag to TRUE, your application must call function SetMessageReadFlag2. -
GetDLR
Used to get message delivery status by tracking Id. -
GetNewInboxCount
Used to get count of new SMS message (IsRead is FALSE) in inbox. -
GetNewInboxCount2
Used to get count of new SMS message (IsRead2 is FALSE) in inbox. -
GetNewInboxMessages
Used to get list of new SMS messages in inbox (maximum 300). After the completion of this request, the status of the messages is automatically set to IsRead=TRUE. -
GetNewInboxMessages2
Used to get list of new SMS messages in inbox (maximum 300). After the completion of this request, the status of the messages is automatically set to IsRead2=TRUE. -
GetTopMessage
Used to get the latest new SMS message in inbox. After the completion of this request, the status of the message is automatically set to IsRead=TRUE. -
GetTopMessage2
Used to get the latest new SMS message in inbox. After the completion of this request, the status of the message is automatically set to IsRead2=TRUE. -
GetTopMessageNoReset
Used to get the latest new SMS message in inbox. The function returns messageId of the message that was collected. The status of the message does not change (IsRead remains FALSE). To set flag to TRUE, your application must call function SetMessageReadFlag. -
GetTopMessageNoReset2
Used to get the latest new SMS message in inbox. The function returns messageId of the message that was collected. The status of the message does not change (IsRead2 remains FALSE). To set flag to TRUE, your application must call function SetMessageReadFlag2. -
SetMessageReadFlag
Set IsRead of the message identified by messageId to the value specified by flag. -
SetMessageReadFlag2
Set IsRead2 of the message identified by messageId to the value specified by flag.