Object definitions

Object definitions

CM.Platform.Campaigns.Models.ApiChannelInfo

NameDescriptionSchema
disabled
optional
Example : trueboolean
name
optional
Example : "string"string
options
optional
Example : "[cm-platform-messages-models-apichanneloptions](#cm-platform-messages-models-apichanneloptions)"CM.Platform.Campaigns.Models.ApiChannelOptions
type
optional
Example : "string"string

CM.Platform.Campaigns.Models.ApiChannelOptions

NameDescriptionSchema
allowImages
optional
Example : trueboolean
allowTemplates
optional
Example : trueboolean
appKey
optional
Example : "00000000-0000-0000-0000-000000000000"string (uuid)
requestId
optional
Example : "00000000-0000-0000-0000-000000000000"string (uuid)

CM.Platform.Campaigns.Models.ApiCountryCost

Container for the message cost per country

NameDescriptionSchema
cost
optional
Gets or sets the cost of the messages for country.
Example : 0.0
number (double)
countryCode
optional
Gets or sets the country code.
Example : "string"
string
isMultipart
optional
Gets or sets if there are Multipart messages
Example : true
boolean
messageCount
optional
Gets or sets the count of the messages for country.
Example : 0
integer (int32)
recipientCount
optional
Gets or sets the count of the recipient for country.
Example : 0
integer (int32)

CM.Platform.Campaigns.Models.ApiCountryErrorStats

NameDescriptionSchema
count
optional
Gets or sets the count.
Example : 0
integer (int32)
country
optional
Gets or sets the country.
Example : "string"
string
errorCode
optional
Gets or sets the errorCode.
Example : 0
integer (int32)

CM.Platform.Campaigns.Models.ApiCountryStats

NameDescriptionSchema
accepted
optional
Gets or sets the accepted.
Example : 0
integer (int32)
converted
optional
Gets or sets the converted.
Example : 0
integer (int32)
country
optional
Gets or sets the country.
Example : "string"
string
delivered
optional
Gets or sets the delivered.
Example : 0
integer (int32)
deliveryTime
optional
Gets or sets the deliveryTime.
Example : 0.0
number (double)
dispatched
optional
Gets or sets the dispatched.
Example : 0
integer (int32)
failed
optional
Gets or sets the failed.
Example : 0
integer (int32)
messages
optional
Gets or sets the messages.
Example : 0
integer (int32)
optOutReceived
optional
Gets or sets the optOutReceived.
Example : 0
integer (int32)
optedOut
optional
Gets or sets the optedOut.
Example : 0
integer (int32)
recipients
optional
Gets or sets the recipients.
Example : 0
integer (int32)

CM.Platform.Campaigns.Models.ApiCampaignAnalytics

The message analytics model.

NameDescriptionSchema
accepted
optional
Gets or sets the accepted.
Example : 0
integer (int32)
converted
optional
Gets or sets the converted.
Example : 0
integer (int32)
countryErrorStats
optional
Gets or sets the countryErrorStats.
Example : [ "[cm-platform-messages-models-apicountryerrorstats](#cm-platform-messages-models-apicountryerrorstats)" ]
< CM.Platform.Campaigns.Models.ApiCountryErrorStats > array
countryStats
optional
Gets or sets the countryStats.
Example : [ "[cm-platform-messages-models-apicountrystats](#cm-platform-messages-models-apicountrystats)" ]
< CM.Platform.Campaigns.Models.ApiCountryStats > array
deduplicated
optional
Gets or sets the deduplicated.
Example : 0
integer (int32)
delivered
optional
Gets or sets the delivered.
Example : 0
integer (int32)
deliveryTime
optional
Gets or sets the deliveryTime.
Example : 0.0
number (double)
dispatched
optional
Gets or sets the dispatched.
Example : 0
integer (int32)
euroPrice
optional
Gets or sets the euroPrice.
Example : 0.0
number (double)
failed
optional
Gets or sets the failed.
Example : 0
integer (int32)
localCurrency
optional
Gets or sets the localCurrency.
Example : "string"
string
localPrice
optional
Gets or sets the localPrice.
Example : 0.0
number (double)
messages
optional
Gets or sets the messages.
Example : 0
integer (int32)
optOutReceived
optional
Gets or sets the optOutReceived.
Example : 0
integer (int32)
optedOut
optional
Gets or sets the optedOut.
Example : 0
integer (int32)
recipients
optional
Gets or sets the recipients.
Example : 0
integer (int32)
test
optional
Gets or sets test message count.
Example : 0
integer (int32)
updatedAtUtc
optional
Gets or sets updated timestamp.
Example : "string"
string (date-time)

CM.Platform.Campaigns.Models.ApiCampaignChannel

NameDescriptionSchema
allowImages
optional
Example : trueboolean
id
optional
Example : "string"string
name
optional
Example : "string"string
type
optional
Example : "string"string
whatsAppRequestId
optional
Example : "00000000-0000-0000-0000-000000000000"string (uuid)

CM.Platform.Campaigns.Models.ApiCampaignCost

Container for the Campaign cost.

NameDescriptionSchema
charsLeft
optional
Gets or sets the min chars left for 1 more part
Example : 0
integer (int32)
charsToRemove
optional
Gets or sets the min chars to remove for 1 less part
Example : 0
integer (int32)
countryCosts
optional
Gets or sets the count and cost of the messages per country.
Example : [ "[cm-platform-messages-models-apicountrycost](#cm-platform-messages-models-apicountrycost)" ]
< CM.Platform.Campaigns.Models.ApiCountryCost > array
currency
optional
Gets or sets the currency.
Example : "string"
string
isMultipart
optional
Gets or sets if there are Multipart messages
Example : true
boolean
messageCount
optional
Gets or sets the count of the messages
Example : 0
integer (int32)
minDeliveryTime
optional
Gets or sets the min delivery time in minutes
Example : 0
integer (int32)
recipientCount
optional
Gets or sets the count of the recipients
Example : 0
integer (int32)
totalCost
optional
Gets or sets the total cost of the message.
Example : 0.0
number (double)

CM.Platform.Campaigns.Models.ApiCampaignCount

Container for the Campaign count.

NameDescriptionSchema
archived
optional
Number of archived messages
Example : 0
integer (int32)
draft
optional
Number of draft messages
Example : 0
integer (int32)
scheduled
optional
Number of draft scheduled messages
Example : 0
integer (int32)
sent
optional
Number of sent messages
Example : 0
integer (int32)
template
optional
Number of message template
Example : 0
integer (int32)

CM.Platform.Campaigns.Models.ApiCampaignPreview

Container for the Campaign cost.

NameDescriptionSchema
languages
optional
Gets or sets the preview languages.
Example : [ "string" ]
< string > array
previewCode
optional
Gets or sets the country or the language the current previews are based on.
Example : "string"
string
previews
optional
Gets or sets the count and cost of the messages per country.
Example : [ "string" ]
< string > array
recipientsPerCountry
optional
Gets or sets the currency.
Example : [ "[cm-platform-messages-models-apirecipientspercountry](#cm-platform-messages-models-apirecipientspercountry)" ]
< CM.Platform.Campaigns.Models.ApiRecipientsPerCountry > array
sender
optional
Gets or sets the sender the current previews are based on.
Example : "string"
string

CM.Platform.Campaigns.Models.ApiCampaignRequest

Data model for message requests

NameDescriptionSchema
body
optional
Gets or sets the body.
Example : "string"
string
channels
optional
Gets or sets the channels.
Example : [ "string" ]
< string > array
content
optional
Gets or sets the recurring interval.
Example : [ "[cm-platform-messages-models-conversation](#cm-platform-messages-models-conversation)" ]
< CM.Platform.Campaigns.Models.Conversation > array
countrySpecificSenders
optional
Gets or sets the senders.
Example : {<br> "string" : "string"<br>}
< string, string > map
grouping
optional
Gets or sets the grouping.
Example : "string"
string
ignoreUnsubscribes
optional
Gets or sets the ignore unsubscribes setting.
Example : true
boolean
isArchived
optional
Indicates if message is archived.
Example : true
boolean
name
optional
Gets or sets the name.
Example : "string"
string
recipients
optional
Gets or sets the recipients.
Example : [ "[cm-platform-messages-models-apirecipient](#cm-platform-messages-models-apirecipient)" ]
< CM.Platform.Campaigns.Models.ApiRecipient > array
recurrence
optional
Gets or sets the recurring interval.
Example : "string"
string
scheduledAtUtc
optional
Gets or sets the process at utc.
Example : "string"
string (date-time)
senderPreset
optional
Gets or sets the sender preset id.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
senders
optional
Gets or sets the sender.
Example : [ "string" ]
< string > array
spread
optional
Gets or sets the spread settings.
Example : "[cm-platform-messages-models-apispreadsettings](#cm-platform-messages-models-apispreadsettings)"
CM.Platform.Campaigns.Models.ApiSpreadSettings
status
optional
Gets or sets the status.
Example : "string"
string
updatedAtUtc
optional
Gets or sets the updated at utc.
Example : "string"
string

CM.Platform.Campaigns.Models.ApiCampaignResponse

Data model for message response

NameDescriptionSchema
analytics
optional
Gets or sets the message analytics.
Example : "[cm-platform-messages-models-apimessageanalytics](#cm-platform-messages-models-apimessageanalytics)"
CM.Platform.Campaigns.Models.ApiCampaignAnalytics
body
optional
Gets or sets the body.
Example : "string"
string
channels
optional
Gets or sets the channels.
Example : [ "string" ]
< string > array
content
optional
Gets or sets the recurring interval.
Example : [ "[cm-platform-messages-models-conversation](#cm-platform-messages-models-conversation)" ]
< CM.Platform.Campaigns.Models.Conversation > array
countrySpecificSenders
optional
Gets or sets the senders.
Example : {<br> "string" : "string"<br>}
< string, string > map
createdAtUtc
optional
Gets or sets the created at utc.
Example : "string"
string (date-time)
createdBy
optional
Gets or sets the created by.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
grouping
optional
Gets or sets the grouping.
Example : "string"
string
id
optional
Gets the id.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
ignoreUnsubscribes
optional
Gets or sets the ignore unsubscribes setting.
Example : true
boolean
isArchived
optional
Indicates if message is archived.
Example : true
boolean
isStatsComplete
optional
Indicates if statistics are complete.
Example : true
boolean
name
optional
Gets or sets the name.
Example : "string"
string
preview
optional
Gets the preview.
Example : "[cm-platform-messages-models-apimessagepreview](#cm-platform-messages-models-apimessagepreview)"
CM.Platform.Campaigns.Models.ApiCampaignPreview
recipients
optional
Gets or sets the recipients.
Example : [ "[cm-platform-messages-models-apirecipient](#cm-platform-messages-models-apirecipient)" ]
< CM.Platform.Campaigns.Models.ApiRecipient > array
recurrence
optional
Gets or sets the recurring interval.
Example : "string"
string
scheduledAtUtc
optional
Gets or sets the process at utc.
Example : "string"
string (date-time)
senderPreset
optional
Gets or sets the sender preset id.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
senders
optional
Gets or sets the sender.
Example : [ "string" ]
< string > array
spread
optional
Gets or sets the spread settings.
Example : "[cm-platform-messages-models-apispreadsettings](#cm-platform-messages-models-apispreadsettings)"
CM.Platform.Campaigns.Models.ApiSpreadSettings
status
optional
Gets or sets the status.
Example : "string"
string
updatedAtUtc
optional
Gets or sets the updated at utc.
Example : "string"
string

CM.Platform.Campaigns.Models.ApiRecipient

Basic model for message recipients

NameDescriptionSchema
contact
optional
Gets or sets the contactId.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
data
optional
Gets or sets the json data for recipient.
Example : {<br> "string" : "string"<br>}
< string, string > map
group
optional
Gets or sets the groupId.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
msisdn
optional
Gets or sets the msisdn.
Example : "string"
string

CM.Platform.Campaigns.Models.ApiRecipientsPerCountry

Container for the message cost per country

NameDescriptionSchema
count
optional
Gets or sets the cost of the messages for country.
Example : 0
integer (int32)
countryCode
optional
Gets or sets the country code.
Example : "string"
string

CM.Platform.Campaigns.Models.ApiSenderPresetRequest

Data model for Senders Preset Requests

NameDescriptionSchema
isFavorite
optional
Gets or sets the isFavorite.
Example : true
boolean
name
optional
Gets or sets the name.
Example : "string"
string
senders
optional
Gets or sets the senders.
Example : {<br> "string" : "string"<br>}
< string, string > map

CM.Platform.Campaigns.Models.ApiSenderPresetResponse

Data model for Senders Preset Responses

NameDescriptionSchema
id
optional
Gets or sets the id.
Example : "00000000-0000-0000-0000-000000000000"
string (uuid)
isFavorite
optional
Gets or sets the isFavorite.
Example : true
boolean
name
optional
Gets or sets the name.
Example : "string"
string
senders
optional
Gets or sets the senders.
Example : {<br> "string" : "string"<br>}
< string, string > map

CM.Platform.Campaigns.Models.ApiSpreadSettings

Model for Spread settings

NameDescriptionSchema
durationMinutes
optional
Gets or sets the spread duration in minutes.
Example : 0
integer (int32)
timeFrames
optional
Gets or sets the spread amount.
Example : [ "[cm-platform-messages-models-apitimeframe](#cm-platform-messages-models-apitimeframe)" ]
< CM.Platform.Campaigns.Models.ApiTimeFrame > array
until
optional
Gets or sets the time messages will be spread until.
Example : "string"
string (date-time)

CM.Platform.Campaigns.Models.ApiStatusReport

Model for Status Reports

NameDescriptionSchema
Account
optional
Example : 0integer (int32)
AdditionalInfo
optional
Example : "string"string
Converted
optional
Example : "string"string (date-time)
CustomGrouping
optional
Example : "string"string
CustomGrouping2
optional
Example : "string"string
CustomGrouping3
optional
Example : "string"string
Customer
optional
Example : 0integer (int32)
Description
optional
Example : "string"string
ExternalReference
optional
Example : "string"string
LastRetry
optional
Example : "string"string (date-time)
LastUpdated
optional
Example : "string"string (date-time)
OptedOut
optional
Example : "string"string (date-time)
Parts
optional
Example : 0integer (int32)
Priority
optional
Example : 0integer (int32)
ReadByRecipient
optional
Example : "string"string (date-time)
Recipient
optional
Example : "string"string
Reference
optional
Example : 0integer (int32)
RetryCost
optional
Example : 0.0number (double)
SentToOperator
optional
Example : "string"string (date-time)
StandardError
optional
Example : 0integer (int32)
Status
optional
Example : "string"enum (Accepted, Rejected, Delivered, Failed, Overdue, AcceptedByGateWay, RejectedByGateWay)
Ticket
optional
Example : "string"string

CM.Platform.Campaigns.Models.ApiTestCampaignRequest

Data model for test message

NameDescriptionSchema
message
optional
Gets or sets the message object
Example : "[cm-platform-messages-models-apimessagerequest](#cm-platform-messages-models-apimessagerequest)"
CM.Platform.Campaigns.Models.ApiCampaignRequest
testRecipients
optional
Gets or sets the test recipients.
Example : [ "[cm-platform-messages-models-apirecipient](#cm-platform-messages-models-apirecipient)" ]
< CM.Platform.Campaigns.Models.ApiRecipient > array

CM.Platform.Campaigns.Models.ApiTimeFrame

Model for Spread TimeFrame setting

NameDescriptionSchema
days
optional
Gets or sets the allowed days.
Example : [ "string" ]
< string > array
endTime
optional
Gets or sets the time send window ends.
Example : "string"
string
startTime
optional
Gets or sets the time send window starts.
Example : "string"
string

CM.Platform.Campaigns.Models.Conversation

Container for conversation

NameDescriptionSchema
media
optional
Gets or sets the media.
Example : "[cm-platform-messages-models-media](#cm-platform-messages-models-media)"
CM.Platform.Campaigns.Models.Media
text
optional
Gets or sets the text.
Example : "string"
string
whatsAppTemplate
optional
Gets or sets the template.
Example : "[cm-platform-messages-models-whatsapptemplate](#cm-platform-messages-models-whatsapptemplate)"
CM.Platform.Campaigns.Models.WhatsAppTemplate

CM.Platform.Campaigns.Models.Media

Data model for media object

NameDescriptionSchema
mediaName
optional
Example : "string"string
mediaUri
optional
Example : "string"string
mimeType
optional
Example : "string"string

CM.Platform.Campaigns.Models.WhatsAppTemplate

Data model for WhatsApp Templates

NameDescriptionSchema
languageCode
optional
Example : "string"string
languageFixed
optional
Example : trueboolean
parameters
optional
Example : [ "[cm-platform-messages-models-whatsappparam](#cm-platform-messages-models-whatsappparam)" ]< CM.Platform.Campaigns.Models.whatsAppParam > array
templateId
optional
Example : "00000000-0000-0000-0000-000000000000"string (uuid)

CM.Platform.Campaigns.Models.whatsAppDateParamOptions

Data options for WhatsApp Template Date Parameters

NameDescriptionSchema
showDayOfMonth
optional
Example : trueboolean
showDayOfWeek
optional
Example : trueboolean
showHour
optional
Example : trueboolean
showMinute
optional
Example : trueboolean
showMonth
optional
Example : trueboolean
showYear
optional
Example : trueboolean

CM.Platform.Campaigns.Models.whatsAppParam

Data model for WhatsApp Template Parameters

NameDescriptionSchema
currency
optional
Example : "string"string
currencyAmount
optional
Example : "string"string
currencyCode
optional
Example : "string"string
currencyDecimalSeparator
optional
Example : "string"string
dateOptions
optional
Example : "[cm-platform-messages-models-whatsappdateparamoptions](#cm-platform-messages-models-whatsappdateparamoptions)"CM.Platform.Campaigns.Models.whatsAppDateParamOptions
dateTime
optional
Example : "string"string
text
optional
Example : "string"string

Did this page help you?