更新时间:2022-02-24 GMT+08:00

软件升级结果通知

典型场景

应用服务器在物联网平台订阅了软件升级结果通知后(订阅的通知类型为swUpgradeResultNotify),当设备的软件升级任务执行完成时,平台会向应用服务器推送通知消息。

接口功能

支持物联网平台向订阅了软件升级结果通知的应用服务器推送通知消息。

注意事项

应用收到推送消息,请务必返回响应码。

接口原型

请求方法

POST

请求地址

由应用服务器订阅请求消息中的callbackurl决定。

传输协议

HTTPS/HTTP

请求参数

参数

必选/可选

类型

位置

描述

notifyType

必选

String

body

通知类型,取值:swUpgradeResultNotify。

deviceId

必选

String

body

设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

appId

必选

String

body

设备所属应用的应用ID。

operationId

必选

String

body

软件升级任务ID。

subOperationId

必选

String

body

软件升级子任务ID。

curVersion

必选

String

body

设备当前的软件版本。

targetVersion

必选

String

body

设备要升级的目标软件版本。

sourceVersion

必选

String

body

设备的源软件版本。

swUpgradeResult

必选

String

body

软件升级结果。

  • SUCCESS:设备升级成功
  • FAIL:设备升级失败

upgradeTime

必选

String

body

升级时长。

resultDesc

必选

String

body

升级结果描述。

errorCode

必选

String

body

设备上报的状态错误码。

description

必选

String

body

错误原因描述。

响应参数

Status Code: 200 OK

请求示例

Method: POST
request: {callbackUrl}
Header:
Content-Type: application/json
Body:
{
  "notifyType": "swUpgradeResultNotify",
  "deviceId": "******",
  "appId": "***********",
  "operationId": "***********",
  "subOperationId": "***********",
  "curVersion": "1.3",
  "targetVersion": "1.5",
  "sourceVersion": "1.0",
  "swUpgradeResult": "SUCCESS",
  "upgradeTime": "***",
  "resultDesc": "***",
  "errorCode": "***",
  "description": "***"
}

响应示例

response:
Status Code: 200 OK