Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Python SDK API Reference> Message Push> Pushing a Device Shadow Status Change Notification
View PDF

Pushing a Device Shadow Status Change Notification

Typical Scenario

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

API Function

This API is used by the platform to push notifications to an application that has subscribed to device shadow status 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 handleDeviceDesiredStatusChanged(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

nddscDTO

Mandatory

NotifyDeviceDesiredStatusChangedDTO

body

For details, see NotifyDeviceDesiredStatusChangedDTO structure.

NotifyDeviceDesiredStatusChangedDTO structure

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.

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"
}

Normal Response Example

response:
Status Code: 200 OK
Parent topic: Message Push