SMS API
SMSResponse
This response is returned by the SimpleSMSSend, SimpleSMSSendWithPostback, AdvancedSMSSend, GetMessageStatus, and GetMessageStatusByReferenceID methods.
Type Properties
| Property Name | Description | Data Type | Sample |
|---|---|---|---|
| Cancelled | Whether the SMS message has been cancelled. | Boolean | False |
| MessageID | Unique ID for every SMS message sent. | Guid | 1627aea5-8e0a-4371-9022-9b504344e724 |
| Queued | Whether the SMS message has been queued by the aggregator. | Boolean | True |
| ReferenceID | Unique ID that can be set using the AdvancedSMSSend method. | String | 123 |
| SMSError | Indicates whether there was an error sending the SMS message. 0 – NoErrorThe request was successful. 1 – STOPfromPhoneNumber 2 – LicenseKeyInvalid 3 – PhoneNumberInvalid 4 – MessageInvalid 5 – ScheduledDateTimeIsNotUTC 6 – InvalidAssignedDID 7 – NotFoundThe message ID is invalid. 8 – InternalError9 – ContactEsendexAccountSuspended 10 – AssignedDIDRequired | Enum | 0 – NoError |
| SMSIncomingMessages | Returns null when part of a Send response. | Null | Null |
| Sent | Whether the SMS message has been sent to the carrier. | Boolean | False |
| SentDateTime | UTC date/time when the message was sent. | DateTime | /Date(928164000000-0400)/ |
Let’s start sending, together.