Sending a Device Notification

Description Notify users on device operation failures and other information using this REST API. For more information, see how the notifications function via the console.

Resource Path /notifications

URL /mdm-admin/notifications

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/notifications

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to send a notification to adevice as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'notification.json' -k -v https://localhost:9443/mdm-admin/notifications

Sample output

> POST /mdm-admin/notifications/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 8e6ecc18eeec1c4f161e442aa2033146
> Content-Length: 203
< HTTP/1.1 200 OK
< Date: Fri, 11 Mar 2016 10:19:15 GMT
< Content-Type: application/json
< Content-Length: 77
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"Notification has added successfully."}

Sample JSON Definition

{
  "notificationId": 4,
  "deviceIdentifier": {
    "id": "359298055243973",
    "type": "android"
  },
  "description": "Alarm operation failed.",
  "operationId": 5,
  "status": "NEW"
}

Property	Definition	Type
`notificationID`	Define the notification ID.	Integer
`deviceIdentifier`	Define the device identification properties.	String
`id`	Define the device ID.	String
`type`	Define the device type, such as android, ios or windows.	String
`description`	Provide the message you want to send to the user.	String
`operationID`	Provide the operationID.	Integer
`status`	Provide the status of the message. The following values can be assigned for the status. `NEW`: Will keep the message in the unread state. `CHECKED`: Will keep the message in the read state.	String