Pushing Batch Device Data Change Notifications

Typical Scenario

After an application subscribes to batch device data change notifications (the notification type is deviceDatasChanged) on the platform, the platform sends a notification to the application when the device reports data of multiple service properties.

API Function

This API is used by the platform to push notifications to an application that has subscribed to batch device data change 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 handleDeviceDatasChanged(NotifyDeviceDatasChangedDTO body)

Class

PushMessageReceiver

Parameter Description

NotifyDeviceDatasChangedDTO 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

Identifies a device.

gatewayId

Mandatory

String

body

Uniquely identifies a gateway.

services

Mandatory

List<DeviceService>

body

Indicates a service list. 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 time when an event is reported. The value is in the format of yyyymmddThhmmssZ. An example value is 20151212T121212Z.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"deviceDatasChanged",
    "requestId":"*************",
    "deviceId":"********************************",
    "gatewayId":"*************",
    "service":[
        {
            "serviceId":"Brightness",
            "serviceType":"Brightness",
            "data":{
                "brightness":80
            },
            "eventTime":"20170311T163657Z"
        },
        {
            "serviceId":"Color",
            "serviceType":"Color",
            "data":{
                "value":"red"
            },
            "eventTime":"20170311T163657Z"
        }
    ]
}

Normal Response Example

Response:
Status Code: 200 OK