POST GET sms/search
Search SMS by various criteria
* required
Parameters
| Name | Type | Description |
|---|---|---|
| deliveryType | array[string] |
How SMS is sent
Manual, Automated
|
| deliveryStatus | array[string] |
Status of delivery. Manual SMS statuses are: Not Sent, Scheduled, In Progress, Sent. Automated SMS statuses are: Inactive, Paused, Active
Not Sent, Scheduled, In Progress, Sent, Inactive, Paused, Active
|
| dateSentStart | datetime | SMS sent since this date. Applies only to Manual SMS. |
| dateSentEnd | datetime | SMS sent before this date. Applies only to Manual SMS. |
| campaignID | integer | SMS assigned to a specific campaign |
| page | integer |
Number of page in results to return
1
1
|
| rpp | integer |
Number of records to return per page
20
1
250
|
| sortField | string |
The field to sort results by
dateModified
smsID, dateAdded, dateModified, dateSent
|
| sortDirection | string |
The direction to sort results
desc
asc, desc
|
Response Data
| Name | Type | Description |
|---|---|---|
| smsID | integer | Unique ID of an SMS |
| title | string | Used for display purposes only |
| messagingServiceID | string | Unique ID of messaging service used to send the SMS |
| message | string | Content of SMS |
| deliveryType | string | How SMS is sent |
| deliveryStatus | string | Status of delivery |
| dateSent | datetime | Date SMS was sent. Applies only to Manual SMS. |
| userID | integer | ID of system user the record belongs to |
| dateAdded | datetime | Date record was added |
| dateModified | datetime | Date record was modified |
Permissions
Method requires the SMS Viewer permission
Example Calls
Sent in past 30 days
GET
/sms/search?dateSentStart=2024-04-04&dateSentEnd=2024-05-04
cURL
Copy
Response Data
API Console
The console uses production data, so BE CAREFUL!
GET
sms/search