软件升级结果变更通知
典型场景
第三方应用在物联网平台订阅了软件升级结果通知后(订阅的通知类型为swUpgradeResultNotify),当设备的软件升级任务执行完成时,平台会向第三方应用推送通知消息。
接口功能
支持物联网平台向订阅了软件升级结果通知的第三方应用推送通知消息。
注意事项
- 应用在订阅平台管理数据时需要订阅接口描述中的指定回调地址,回调地址中的server与port为应用服务器公网地址与服务器配置中指定的端口。
- 应用通过继承PushMessageReceiver类并重写回调接口接收推送消息的内容。
- 如果回调地址不是应用服务器本身的地址,则第三方应用需要自己实现原始回调接口,接口内容请参考IoT平台北向API参考中的消息推送章节。
接口描述
回调地址 |
https://server:port/v1.0.0/messageReceiver |
---|---|
回调接口 |
function handleSwUpgradeResult(NotifySwUpgradeResultDTO $body) |
接口所属类 |
PushMessageReceiver |
参数说明
NotifySwUpgradeResultDTO
参数 |
必选/可选 |
位置 |
描述 |
---|---|---|---|
$notifyType |
必选 |
body |
通知类型,取值:“swUpgradeResultNotify”。 |
$deviceId |
必选 |
body |
设备ID,用于唯一标识一个设备。 |
$appId |
必选 |
body |
设备所属应用的应用ID。 |
$operationId |
必选 |
body |
软件升级任务ID。 |
$subOperationId |
必选 |
body |
软件升级子任务ID。 |
$curVersion |
必选 |
body |
设备当前的软件版本。 |
$targetVersion |
必选 |
body |
设备要升级的目标软件版本。 |
$sourceVersion |
必选 |
body |
设备的源软件版本。 |
$swUpgradeResult |
必选 |
body |
软件升级结果。
|
$upgradeTime |
必选 |
body |
升级时长。 |
$resultDesc |
必选 |
body |
升级结果描述。 |
$errorCode |
必选 |
body |
设备上报的状态错误码。 |
$description |
必选 |
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