Message model

Message stores business-level information and configuration.

It has Templates through Templates (currently only one is supported).

It may be sent, more than once, by scheduling Sendings to specific recipients.

Example

{
  "id": 758131,
  "name": "DD3",
  "shorten_urls": true,
  "track_in_shortener": false,
  "service": "generic",
  "campaign_id": null,
  "created_at": "2020-09-15T10:01:09.467Z",
  "updated_at": "2020-09-15T10:01:09.467Z",
  "channels": [
    {
      "id": 55781,
      "type": "sms",
      "sender": { "type": "alphanumeric", "value": "Infinity" },
      "template": {
        "id": 609193,
        "wrapper_id": 3491,
        "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"
    }
  ],
  "sendings_status": "scheduled",
  "sendings_count": 3,
  "latest_sending": {
    "id": 3920,
    "status": "scheduled",
    "audience_id": 107103,
    "recipients_count": 0,
    "dispatches_count": 9513,
    "members_count": 9000,
    "scheduled_at": "2020-10-15T15:27:02.853Z",
    "transmitted_at": "2020-10-15T12:45:08.625Z",
    "created_at": "2020-09-15T12:27:02.853Z",
    "updated_at": "2020-09-15T12:45:08.625Z"
  }
}

Definition

Key	Type	Description
id	integer
name	string
shorten_urls	boolean	Should sendings for this message have URLs shortened with MPC Shortener?
track_in_shortener	boolean	Should MPC Shortener track users?
service	enum	MPC Service the Message is bound to
campaign_id	integer	MPC's campaign ID (applicable to `campaigns` service)
channels	Channel[]	Channels the message is sent with
sendings_status	enum	Aggregated Sendings status
sendings_count	integer	Number of Sendings of Message
latest_sending	MessageSending	Most recent Sending of Message
created_at	datetime	Time of creation
updated_at	datetime	Time of last update

Service

Messages are scoped by service which is used to distinguish types of Messages that may be bound to specific MPC features.
A "generic" service exists for any non-specific Messages. For others, a permit is required.

Service	Permit	Description
generic	n/a	Generic API message
tenants	Messages:Api:Messages:UseService:Tenants	For MPC TEM tenant messages
tenants_testing	Messages:Api:Messages:UseService:TenantsTesting	For MPC TEM tenant test messages

Aggregated Sendings status

If all Message's Sendings are transmitted, cancelled, failed or skipped, then sendings_status is finished.

If all Message's Sendings are draft, then sendings_status is draft.

If both above conditions are not true, then sendings_status is scheduled.

MessageSending model

Simplified version of Sending's with limited set of attributes:

Key	Description
id	Sending
audience_id	Sending
status	Sending
scheduled_at	Sending
created_at	Sending
transmitted_at	Sending
updated_at	Sending
recipients_count	Number of recipients
dispatches_count	Number of dispatches, when sending has not been executed yet it's `null`
members_count	Number of distinct members to whom messages has been sent

Example#

Definition#

Service#

Aggregated Sendings status#

MessageSending model#

Example

Definition

Service

Aggregated Sendings status

MessageSending model