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

The NA must return a response code after receiving a message pushed by the IoT platform.

API Prototype

Method	POST
URL	The URL is determined by callbackUrl in the subscription request sent by the NA.
Transport Protocol	HTTPS/HTTP

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
notifyType	Mandatory	String	body	Indicates the notification type. The value is deviceDesiredPropertiesModifyStatusChanged.
deviceId	Mandatory	String	body	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
serviceId	Mandatory	String	body	Identifies a service.
properties	Mandatory	ObjectNode	body	Indicates data attributes of a device shadow.
status	Mandatory	String	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"
}