v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Analyze Bulk Messages - Campaigns

Analyzing a bulk sendout is useful when the user needs information about the send out before actually sending it.

post/sms/analyze/campaign

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

contactsstring[]

The contact ids that the message will be sent to. At least one of "contacts", "groups" or "to" is required.

groupsstring[]

The groups of contacts in the account selected as recipients.

tostring[]

The phone numbers the message is about to be sent to. Format with a '+' and country code e.g., +306948530920 (E.164 format).

fromstring required

The sender of the message. This can be a telephone number (numeric string with maximum length 16 characters) or an alphanumeric string (maximum length 11 characters). When you want to use a number, you have to enter it without the '+' before the country code (eg 447123123456).

bodystring required

The message you want to send.

Response

200

numberOfRecipientsinteger

contactsobject

totalInGroupsinteger

Example response

{
  "numberOfRecipients": 7,
  "recipientsPerCountry": {
    "GR": 3,
    "DE": 1,
    "FR": 2,
    "RU": 1
  },
  "recipientCountries": {
    "+30697xxxxxxx": "GR",
    "+30693xxxxxxx": "GR",
    "+30694xxxxxxx": "GR"
  },
  "recipientsPerGroup": {
    "customers": 4
  },
  "totalInGroups": 4,
  "bodyAnalysis": {
    "characters": 76,
    "parts": 1
  }
}