Model#
This schema describes Messages in the responses. Payload for creations and updates is significantly different and can be referenced in docs of their respective API endpoints.
Multiple channels#
It is possible to provide multiple channels per Message. During sending execution, one of them will be chosen, based on:channels which are available for recipient
order (priority) of channels in payload specified during Message creation
Channel attributes#
There are channel attributes specific for given type.| Key | Channel type | Type |
|---|
| message.sender.type | sms | enum: ['alphanumeric', 'international'] |
| message.sender.value | sms | string |
| message.from_email | email | string |
| message.from_name | email | string |
When not provided explicitly, values of those the following attributes are taken from Loyalty Club configuration.The sender describes how SMS sender will be displayed to the receiver of SMS.Depending on selected sender.type, a sender.value can be provided according to the following table:| Type | Value |
|---|
alphanumeric | String consisting of 2-11 characters |
international | Any MSISDN |
Aggregated Sendings status#
If all Message's Sendings are draft or Message has no Sendings, then the sendings_status is draft.If all Message's Sendings are transmitted, cancelled, failed or skipped, then the sendings_status is finished.If none of the above conditions is true, then sendings_status is scheduled.