Pushing Firmware Upgrade Status Change Notifications

Typical Scenario

After an NA subscribes to firmware upgrade status change notifications (the notification type is fwUpgradeStateChangeNotify) on the IoT platform, the IoT platform sends a notification message to the NA when the firmware upgrade status changes.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to firmware upgrade 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 fwUpgradeStateChangeNotify.
deviceId	Mandatory	String	body	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
appId	Mandatory	String	body	Identifies the application to which the device belongs.
operationId	Mandatory	String	body	Identifies a firmware upgrade task.
subOperationId	Mandatory	String	body	Identifies a firmware upgrade sub-task.
step	Mandatory	String	body	Indicates the firmware upgrade status. The value options are 0, 1, 2, and 3.
stepDesc	Mandatory	String	body	Indicates the upgrade status description. downloading (corresponding to value 1 of step): The device is downloading the firmware package. downloaded (corresponding to value 2 of step): The device has finished downloading the firmware package. updating (corresponding to value 3 of step): The device is being upgraded. idle (corresponding to value 0 of step): The device is in the idle state.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type: application/json
Body:
{
  "notifyType": "fwUpgradeStateChangeNotify",
  "deviceId": "******",
  "appId": "***********",
  "operationId": "**************",
  "subOperationId": "***********",
  "step": "1",
  "stepDesc": "downloading"
}