Message formats

The format of the message that is received by a client and how the client is expected to handle it depend on the type of message.

In general, all messages share the same top-level format:

{
  "notification": {
    "body": "<notification_body>",
    "title": "<notification_title>"
  },
  "data": { 
    "body": "<data_body>", 
    "title": "<data_title>",
    "referenceType": "{NOTIFICATION_UPDATE|ENTITLEMENT_UPDATE|EPG_UPDATE|EAS_UPDATE}" 
  }
}

The message is delivered as stringified JSON, and is shown here as regular JSON for readability.

The client should:

• Check the value of data.referenceType and act accordingly.
  See the following pages for each type:

  • NOTIFICATION_UPDATE – Message format – general notifications

  • EAS_UPDATE – Message format – Emergency Alert System (EAS)

  • ENTITLEMENT_UPDATE – Message format – entitlement changes

  • EPG_UPDATE – Message format – EPG update

• Check for the presence of a notification section:

  • If it is present, the client should immediately display the notification to the user, using the specified title and body.

  • If there is no notification section, the client should store the notification so that the user can view it when they choose to (for example, in an inbox).

See also

Managing messaging