Pushing Firmware Upgrade Result Notifications

Typical Scenario

After an NA subscribes to firmware upgrade result change notifications (the notification type is fwUpgradeResultNotify) on the IoT platform, the IoT platform sends a notification message to the NA when a firmware upgrade task is complete.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to firmware upgrade result 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 fwUpgradeResultNotify.
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.
curVersion	Mandatory	String	body	Indicates the current firmware version of the device.
targetVersion	Mandatory	String	body	Indicates the target firmware version to which the device is to be upgraded.
sourceVersion	Mandatory	String	body	Indicates the source firmware version of the device.
status	Mandatory	String	body	Indicates the upgrade result. SUCCESS FAIL
statusDesc	Mandatory	String	body	Indicates the upgrade result description. SUCCESS: The device upgrade is successful. FAIL: The device upgrade fails.
upgradeTime	Mandatory	String	body	Indicates the firmware upgrade duration.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type: application/json
Body:
{
  "notifyType": "fwUpgradeResultNotify",
  "deviceId": "******",
  "appId": "***********",
  "operationId": "***********",
  "subOperationId": "***********",
  "curVersion": "1.6",
  "targetVersion": "1.6",
  "sourceVersion": "1.3",
  "status": "SUCCESS",
  "statusDesc": "****",
  "upgradeTime": "****"
}