POST GET sms/lookup
Get full details of an SMS record
* required
Parameters
| Name | Type | Description |
|---|---|---|
| smsID * | integer | Unique ID of an SMS |
Response Data
Returns a fully populated SMS object
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| contactFrequency | string | Defines how often a contact can receive the SMS. Applies only to Automated SMS. If set to "once", contacts can be queued to receive the SMS only once. If set to "no limit", contacts can be queued to receive the SMS multiple times without a minimum delay in-between. If set to a user-defined value in the format of {value}{datepart}, contacts can be queued to receive the SMS multiple times, but with a minimum delay in-between. {datepart} values are defined as: d=day, ww=week, m=month, yyyy=year. Example values: "1d" = 1 day, "2ww" = 2 weeks, "3m" = 3 months, "1yyyy" = 1 year. Maximum allowed timeframe is 2 years. | |||||||||
| dateAdded | datetime | Date record was added | |||||||||
| dateModified | datetime | Date record was modified | |||||||||
| dateScheduled | datetime | Date/time of scheduled delivery. Applies only to Manual SMS. | |||||||||
| dateSent | datetime | Date SMS was sent. Applies only to Manual SMS. | |||||||||
| deliveryStatus | string | Status of delivery | |||||||||
| deliveryType | string | How SMS is sent | |||||||||
| includeOptOutInstructions | boolean | Appends generic opt out instructions to the message | |||||||||
| message | string | Content of SMS | |||||||||
| messagingServiceID | string | Unique ID of messaging service used to send the SMS | |||||||||
| recipients | object |
Applies only to Manual SMS.
|
|||||||||
| smsID | integer | Unique ID of an SMS | |||||||||
| title | string | Used for display purposes only | |||||||||
| userID | integer | ID of system user the record belongs to |
Permissions
Method requires the SMS Viewer permission
API Console
The console uses production data, so BE CAREFUL!
GET
sms/lookup