Help Center/ IoT/ API Reference/ Northbound PHP SDK API Reference/ Service API List/ Message Push/ Pushing Batch Device Data Change Notifications
Updated on 2022-02-24 GMT+08:00

Pushing Batch Device Data Change Notifications

Typical Scenario

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

API Function

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

Note

  1. When subscribing to platform service data, 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.
  2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
  3. 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

function handleDeviceDatasChanged(NotifyDeviceDatasChangedDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifyDeviceDatasChangedDTO structure

Parameter

Mandatory or Optional

Location

Description

$notifyType

Mandatory

body

Indicates the notification type. The value is deviceDatasChanged.

$requestId

Mandatory

body

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

$deviceId

Mandatory

body

Identifies a device.

$gatewayId

Mandatory

body

Uniquely identifies a gateway.

$services

Mandatory

body

Indicates a service list. For details, see DeviceService structure.

DeviceService structure

Parameter

Mandatory or Optional

Location

Description

$serviceId

Mandatory

body

Identifies a service.

$serviceType

Mandatory

body

Indicates the service type.

$data

Mandatory

body

Indicates service data information.

$eventTime

Mandatory

body

Indicates the time when an event is reported 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":"deviceDatasChanged",
    "requestId":"*************",
    "deviceId":"********************************",
    "gatewayId":"*************",
    "service":[
        {
            "serviceId":"Brightness",
            "serviceType":"Brightness",
            "data":{
                "brightness":80
            },
            "eventTime":"20170311T163657Z"
        },
        {
            "serviceId":"Color",
            "serviceType":"Color",
            "data":{
                "value":"red"
            },
            "eventTime":"20170311T163657Z"
        }
    ]
}

Response Example

Response:
Status Code: 200 OK