v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

SMS Campaigns

Returns the information for all your created SMS campaigns

get/smsCampaigns

Query parameters

Status of campaign.

startDatestring

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' )

endDatestring

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' )

limitinteger

Number limitation for the result returned

offsetinteger

Beginning point in the list to retrieve from.

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Response

SMS campaigns informations

countinteger

Number of SMS campaigns retrieved

Example response

{
  "campaigns": [
    {
      "id": 2,
      "name": "PROMO CODE",
      "status": "draft",
      "content": "Visit our Store and get some discount !",
      "scheduledAt": "2017-06-01T12:30:00Z",
      "sender": "MyCompany",
      "createdAt": "2017-06-01T12:30:00Z",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "recipients": {
        "lists": [
          21
        ],
        "exclusionLists": [
          13
        ]
      },
      "statistics": {
        "delivered": 2987,
        "sent": 3000,
        "softBounces": 3,
        "hardBounces": 1,
        "unsubscriptions": 3,
        "answered": 2
      }
    }
  ],
  "count": 12
}