Returns the information for all your created SMS campaigns
GET {{baseUrl}}/smsCampaigns?status=archive&startDate=&endDate=&limit=500&offset=0&sort=desc
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
status | string | Status of campaign. | |
startDate | null | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | |
endDate | null | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | |
limit | number | Number limitation for the result returned | |
offset | number | Beginning point in the list to retrieve from. | |
sort | string | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"campaigns":[{"id":2,"name":"PROMO CODE","status":"sent","content":"Visit our Store and get some discount !","scheduledAt":"2017-06-01T12:30:00.000Z","testSent":true,"sender":"MyCompany","createdAt":"2017-06-01T12:30:00.000Z","modifiedAt":"2017-05-01T12:30:00.000Z","sentDate":"2017-06-01T12:30:00.000Z","recipients":{"lists":[21],"exclusionLists":[13]},"statistics":{"delivered":2987,"sent":3000,"processing":0,"softBounces":3,"hardBounces":1,"unsubscriptions":3,"answered":2}},{"id":10,"name":"SUMMER SALE","status":"draft","content":"Summer Sale is starting tomorrow. Get extra 10% with this code:SUM17","scheduledAt":"2017-08-04T12:30:00.000Z","testSent":false,"sender":"MyCompany","createdAt":"2017-06-01T12:30:00.000Z","modifiedAt":"2017-05-01T12:30:00.000Z","sentDate":"2017-06-01T12:30:00.000Z","recipients":{"lists":[21],"exclusionLists":[13]},"statistics":{"delivered":2987,"sent":3000,"processing":0,"softBounces":3,"hardBounces":1,"unsubscriptions":3,"answered":2}}],"count":12}