Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Message Push> Pushing Software Upgrade Status Change Notifications

Pushing Software Upgrade Status Change Notifications

Updated at: Aug 28, 2019 GMT+08:00

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

  1. When Subscribing to Management Data of the IoT Platform, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA.
  2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
  3. If the callback address is not the address of the NA, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

function handleSwUpgradeStateChanged(NotifySwUpgradeStateChangedDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifySwUpgradeStateChangedDTO structure

Parameter

Mandatory or Optional

Location

Description

$notifyType

Mandatory

body

Indicates the notification type. The value is swUpgradeStateChangeNotify.

$deviceId

Mandatory

body

Identifies a device.

$appId

Mandatory

body

Identifies the application to which the device belongs.

$operationId

Mandatory

body

Identifies a software upgrade task.

$subOperationId

Mandatory

body

Identifies a software upgrade sub-task.

$swUpgradeState

Mandatory

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

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel