Updated on 2022-02-24 GMT+08:00

Pushing Software Upgrade Status Change Notifications

Typical Scenario

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

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to software 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 swUpgradeStateChangeNotify.

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 software upgrade task.

subOperationId

Mandatory

String

body

Identifies a software upgrade sub-task.

swUpgradeState

Mandatory

String

body

Indicates the software upgrade status.

  • downloading: The device is downloading the software package.
  • downloaded: The device has finished downloading the software package.
  • updating: The device is being upgraded.
  • idle: 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": "swUpgradeStateChangeNotify",
  "deviceId": "******",
  "appId": "***********",
  "operationId": "***********",
  "subOperationId": "***********",
  "swUpgradeState": "downloading"
}

Response Example

Response:
Status Code: 200 OK