Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
SMS Campaigns

Get an SMS campaign

get/smsCampaigns/{campaignId}

Path parameters

campaignIdinteger required

id of the SMS campaign

Response

SMS campaign informations

idinteger required

ID of the SMS Campaign

namestring required

Name of the SMS Campaign

status'draft' | 'sent' | 'archive' | 'queued' | 'suspended' | 'inProcess' required

Status of the SMS Campaign

contentstring required

Content of the SMS Campaign

scheduledAtstring

UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format

senderstring required

Sender of the SMS Campaign

createdAtstring required

Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

modifiedAtstring required

UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

Example response

{
  "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
  }
}