upgradeProcessDevice (Get Device Upgrade Status and Progress - Imou Open Platform)

upgradeProcessDevice: Get Device Upgrade Status and Progress - Imou Open Platform

Deprecated: Use Upgrade progress (device.upgrade.process). This legacy HTTP page is retained for existing integrations.

Function details

Get device upgrade status and progress.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/upgradeProcessDevice

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Minimum permissions required for sub-account token request

"Permission":"Upgrade" "Resource":"dev:serial number"

Incoming parameter description

Parameter name	Parameter type	Required or not	Default value	Legal value	Parameter description
token	String	Yes			Administrator or sub-account accessToken
deviceId	String	Yes			Device serial number

Sample input

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603371026,
 "nonce":"4279d75d-742a-4e40-a5a0-5fdd096305f5"
 },
 "id":"e65e61bf-b5c4-4989-850e-808216c00ce9",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

Field name	Field type	Field description
version	String	Device program version number
status	String	Device upgrade status, idle: not upgrading, downloading: downloading the upgrade package, upgrading: upgrading
percent	String	Equipment upgrade progress percentage

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "percent":"60",
 "status":"upgrading",
 "version":"2.145.1000.0.R.20181112"
 }
 },
 "id":"e65e61bf-b5c4-4989-850e-808216c00ce9"
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.

Device upgrade (DV10xx)

Code	Meaning	Next step
`DV1006`	Upgrade in progress	Wait for completion
:---	:---	:---
`DV1017`	Upgrade package mismatch	Use the correct firmware

See Return codes · catalog.