Pushing Device Shadow Status Change Notifications

Typical Scenario

After an NA subscribes to device shadow status change notifications (the notification type is deviceDesiredPropertiesModifyStatusChanged) on the IoT platform, the IoT platform sends a notification message to the NA when the device shadow on the IoT platform succeeds or fails to synchronize data to the device.

API Function

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

Note

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.
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	funciton handleDeviceDesiredStatusChanged(NotifyDeviceDesiredStatusChangedDTO $body)
Class	PushMessageReceiver

Parameter Description

NotifyDeviceDesiredStatusChangedDTO structure

Parameter	Mandatory or Optional	Location	Description
$notifyType	Mandatory	body	Indicates the notification type. The value is deviceDesiredPropertiesModifyStatusChanged.
$deviceId	Mandatory	body	Identifies a device.
$serviceId	Mandatory	body	Identifies a service.
$properties	Mandatory	body	Indicates data attributes of a device shadow.
$status	Mandatory	body	Indicates the status. The value options are DELIVERED and FAILED.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"deviceDesiredPropertiesModifyStatusChanged",
    "deviceId":"******",
    "serviceId":"Device",
    "properties":{
        "Model Number":1,
        "Serial Number":2,
        "Firmware Version":"v1.1.0"
    },
    "status":"DELIVERED"
}