Sending a notification to a specific device

Request

To send a notification to a specific device, send a POST request to:

http://<host>:<port>/messaging/v1/clients/{client_id}/inbox

The device must already be registered with DMM.

Headers

• Content-Type: application/json

Mandatory fields

• client_id (in URL) – the ID of the device

• envelope object containing at least:

  • from – who the notification is from

• message – the message – a string or JSON converted to a string (that is, with line breaks removed and special characters escaped).
  See Message format – general notifications for a detailed explanation of the expected message format.
  Within message:

  • Include a notification block if the notification is meant to be presented immediately to the user.

  • Omit the notification block if the client should store the notification so that the user can view it when they choose to (for example, in an inbox).

Example

A request with this payload sends a message to the device specified in the URL:

{
  "envelope": {
    "from": "Operator"
  },
  "message":"{
    "notification": {
      "body": "20% off all TVOD until Sunday",
      "title": "Discount Movies"
    },
    "data": {
      "body": "20% off all TVOD until Sunday",
      "title": "Discount Movies",
      "referenceType": "NOTIFICATION_UPDATE" 
    }
  }"
}

Note that "message" in the JSON above is shown with line breaks and is unescaped for clarity. In reality, you must remove all line breaks and escape all relevant characters within "message".

The JSON that you would actually use as the body of the request is:

JSON

{
  "envelope": {
    "from": "Operator"
  },
  "message":"{\"notification\":{\"body\":\"20% off all TVOD until Sunday\",\"title\":\"Discount Movies\"},\"data\":{\"body\":\"20% off all TVOD until Sunday\",\"title\":\"Discount Movies\",\"referenceType\":\"NOTIFICATION_UPDATE\"}}"
}

Response

The request returns an HTTP 200 status if the message was sent successfully.
An unsuccessful request returns an HTTP 404 status if the client ID is not recognised.

See also

For full details of this API, see the Device Messaging Manager (DMM) API documentation v1.