Pushing a Device Event Notification
Typical Scenario
After an application subscribes to device event notifications (the notification type is deviceEvent) on the platform, the platform sends a notification to the application when the platform receives the event message reported by the device.
API Function
This API is used by the platform to push notifications to an application that has subscribed to device event notifications.
Note
1. When subscribing to platform service data, an application must subscribe to the specified callback URL in the API description. The server and port in the callback URL are the public IP address and specified port of the application.
2. An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.
3. If the callback URL is not the address of the application, the application must implement the original callback API. For details on the API content, see Message Push in the Northbound API Reference.
API Description
| Callback URL | https://server:port/v1.0.0/messageReceiver |
|---|---|
| Callback API | void handleDeviceEvent(NotifyDeviceEventDTO body) |
| Class | PushMessageReceiver |
Parameter Description
NotifyDeviceEventDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| notifyType | Mandatory | String | body | Indicates the notification type. The value is deviceEvent. |
| header | Mandatory | DeviceEventHeader | body | For details, see DeviceEventHeader structure. |
| body | Mandatory | ObjectNode | body | Indicates the content of the event message. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| eventType | Mandatory | String(1-32) | body | Indicates the event type. |
| from | Mandatory | String(1-128) | body | Indicates the address of the message sender.
|
| timestamp | Mandatory | String (1-32) | body | Indicates the timestamp. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z. |
| eventTime | Mandatory | String (1-32) | body | Indicates the time when an event is reported. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z. |
| deviceId | Mandatory | String | body | Identifies a device. |
| serviceType | Mandatory | String | body | Indicates the type of the service to which a command belongs. |
Response Parameters
Status Code: 200 OK
Request Example
Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
"notifyType":"deviceEvent",
"header":{
"eventType":"*******",
"from":"/devices/{deviceId}/services/{serviceId}",
"deviceId":"*******",
"serviceType":"*******",
"timestamp":"20151212T121212Z",
"eventTime":"20151212T121212Z"
},
"body":{
"usedPercent":80
}
} Normal Response Example
Response: Status Code: 200 OK
Last Article: Pushing a Device Command Response Notification
Next Article: Pushing a Device Model Addition Notification
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.