Pushing Device Event Notifications

Typical Scenario

After an NA subscribes to device event notifications (the notification type is deviceEvent) on the IoT platform, the IoT platform sends a notification message to the NA when the IoT platform receives the event message reported by the device.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device event notifications.

Note

When Subscribing to Service Data of the IoT Platform, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA server.
An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
If the callback address is not the address of the NA, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL	https://server:port/v1.0.0/messageReceiver
Callback API	def handleDeviceEvent(self)
Class	PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter	Mandatory or Optional	Type	Location	Description
ndeDTO	Mandatory	NotifyDeviceEventDTO	body	For details, see NotifyDeviceEventDTO structure.

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 message body of the response command.

DeviceEventHeader structure

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. Request initiated by a device: /devices/{deviceId} Request initiated by a device service: /devices/{deviceId}/services/{serviceId}
timestamp	Mandatory	String (1-32)	body	Indicates the timestamp. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 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', for example, 20151212T121212Z.
deviceId	Mandatory	String	body	Uniquely 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
    }
}