Get Campaigns

Gets Campaign paged.

GET https://api.cm.com/messages/v1/accounts/{accountId}/messages

Parameters

Type	Name	Description	Schema
Path	accountId required	The account id.	string (uuid)
Query	orderby optional	Column names (date, price, recipients, name) to order messages. add desc to order descending (ex: date desc)	< string > array(multi)
Query	skip optional	The skip.	integer (int32)
Query	status optional	Campaign status id.	string
Query	take optional	The take.	integer (int32)

Responses

HTTP Code	Description	Schema
200	OK	< CM.Platform.Campaigns.Models.ApiCampaignResponse > array

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages

Example HTTP response

Response 200

[ {
  "id" : "00000000-0000-0000-0000-000000000000",
  "analytics" : {
    "accepted" : 0,
    "converted" : 0,
    "delivered" : 0,
    "euroPrice" : 0.0,
    "failed" : 0,
    "localCurrency" : "string",
    "localPrice" : 0.0,
    "optedOut" : 0,
    "recipients" : 0,
    "test" : 0
  },
  "body" : "string",
  "channels" : ["SMS"] ,
  "countrySpecificSenders" : {
    "string" : "string"
  },
  "ignoreUnsubscribes" : true,
  "name" : "string",
  "recipients" : [ {
    "contact" : "00000000-0000-0000-0000-000000000000",
    "data" : {
      "string" : "string"
    },
    "group" : "00000000-0000-0000-0000-000000000000",
    "msisdn" : "string"
  } ],
  "recurrence" : "string",
  "scheduledAtUtc" : "string",
  "senderPreset" : "00000000-0000-0000-0000-000000000000",
  "senders" : [ "string" ],
  "spread" : {
    "timeFrames" : [ {
      "days" : [ "string" ],
      "startTime" : "string",
      "endTime" : "string"
    } ],
    "until" : "string"
  },
  "status" : "string",
  "options": {
    "urlShortenerDomainId": "00000000-0000-0000-0000-000000000000"
  },
  "tariff" : 0,
  "createdAtUtc" : "string",
  "createdBy" : "00000000-0000-0000-0000-000000000000"
} ]