Pushing a Device Data Change Notification

Typical Scenario

After an application subscribes to device data change notifications (the notification type is deviceDataChanged) on the platform, the platform sends a notification to the application when the device reports data of a single service property.

API Function

This API is used by the platform to push notifications to an application that has subscribed to device data change notifications.

Note

  1. When Subscribing to Device 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 server.
  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 server, 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

def handleDeviceDataChanged(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

nddcDTO

Mandatory

NotifyDeviceDataChangedDTO

body

For details, see NotifyDeviceDataChangedDTO structure.

NotifyDeviceDataChangedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is deviceDataChanged.

requestId

Optional

String(1-128)

body

Indicates the sequence number of the message, which uniquely identifies the message.

deviceId

Mandatory

String

body

Uniquely identifies a device.

gatewayId

Mandatory

String

body

Uniquely identifies a gateway.

service

Mandatory

DeviceService

body

Indicates service data of the device. For details, see DeviceService structure.

DeviceService structure

Parameter

Mandatory or Optional

Type

Location

Description

serviceId

Mandatory

String

body

Identifies a service.

serviceType

Mandatory

String

body

Indicates the service type.

data

Mandatory

ObjectNode

body

Indicates service data information.

eventTime

Mandatory

String

body

Indicates the event occurrence time in the format of yyyymmddThhmmssZ, for example, 20151212T121212Z.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"deviceDataChanged",
    "requestId":"*************",
    "deviceId":"********************************",
    "gatewayId":"*************",
    "service":{
        "serviceId":"Brightness",
        "serviceType":"Brightness",
        "data":{
            "brightness":80
        },
        "eventTime":"20170311T163657Z"
    }
}

Normal Response Example

response:
Status Code: 200 OK