×
GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns

To get the details of bulk campaign details in your account, make an HTTP GET request.

This API allows you to fetch bulk campaign details with sorting and searching capabilities. 
 

Parameter
Name
Value
Description
* offset
query

offset (optional)-  By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20 maximum=50

* name
query

name (optional)-Search by campaign name. Min 3 letters. (like %xxx%)

* sort_by
query

sort_by (optional)- This indicates in what order the campaign records are sorted in the API response. By default records are sorted by ScheduledTime in ascending order. However, you can override the same in following way for ascending order: Eg: schedule.start_time:asc, schedule.start_time:desc, name:asc (alphabetical order A-z, Z-A)

 

* status
query

status (Optional)- Filter on status. Possible values- “scheduled”, “in-progress”,”completed”,”archived”,”paused” 

Response Content Type
GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns

To get the details of bulk campaign details in your account, make an HTTP GET request.

This API allows you to fetch bulk campaign details with sorting and searching capabilities. 
 

Parameter
Name
Value
Description
* offset
query

offset (optional)-  By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20 maximum=50

* name
query

name (optional)-Search by campaign name. Min 3 letters. (like %xxx%)

* sort_by
query

sort_by (optional)- This indicates in what order the campaign records are sorted in the API response. By default records are sorted by ScheduledTime in ascending order. However, you can override the same in following way for ascending order: Eg: schedule.start_time:asc, schedule.start_time:desc, name:asc (alphabetical order A-z, Z-A)

 

* status
query

status (Optional)- Filter on status. Possible values- “scheduled”, “in-progress”,”completed”,”archived”,”paused” 

Response Content Type
2
Share