Channel model

Channel defines how Message may be sent along with the content (defined by Message) that
should be sent through this channel.

Example

{
  "id": 55781,
  "type": "sms",
  "sender": { "type": "alphanumeric", "value": "Infinity" },
  "template": {
     "id": 609193,
     "type": "plain",
     "content": { "body": "Hei {{name}}" },
     "created_at": "2020-09-15T12:45:08.618Z",
     "updated_at": "2020-09-15T12:45:08.618Z"
  },
  "created_at": "2020-09-15T12:45:08.625Z",
  "updated_at": "2020-09-15T12:45:08.625Z"
}

Definition

Key	Type
id	integer
type	enum: `['sms', 'email', 'push']`
created_at	datetime
updated_at	datetime
template	Template
(channel-specific attributes)

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

optional preference set on Sending

Channel-specific attributes

When not provided explicitly, values of all the following attributes are taken from Loyalty Club configuration.

Key	Channel type	Type
sender.type	`sms`	enum: `['alphanumeric', 'international']`
sender.value	`sms`	string
from_email	`email`	string
from_name	`email`	string

The sender describes how SMS sender will be displayed to the receiver of SMS.
By default, a value from Loyalty Club configuration is used (see Messaging > Settings).

Depending on selected sender.type, sender.value can be provided according to the following table:

Type	Value
`alphanumeric`	String consisting of 2-11 characters
`international`	Any MSISDN

Example#

Definition#

Multiple channels#

Channel-specific attributes#

Example

Definition

Multiple channels

Channel-specific attributes