deviceVersionList (Device Version List - Get Information and Upgrades - Imou Open Platform)

deviceVersionList: Device Version List - Get Information and Upgrades - Imou Open Platform

Legacy HTTP retained: For existing integrations. New integrations should use the Device APIs overview.

Function details

Get device version and upgradeable information.

Request address

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

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
deviceIds	String	Yes		"1313131313,364663,af41414"	Device serial number. Batch query is possible, and the device serial numbers are separated by commas, and a maximum of 20 device queries are supported

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":{
 "deviceIds":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

Field	Type	Description
count	Integer	Total number of returned device lists
deviceVersionList.deviceId	String	Device channel number
deviceVersionList.version	String	The current version number of the device
deviceVersionList.canBeUpgrade	Boolean	Is it possible to upgrade, true: there is a new version that can be upgraded, and the upgradeInfo field information is returned; false: the upgrade is not possible, and the upgradeInfo field is not required to return
deviceVersionList.upgradeInfo.version	String	Upgrade package version number
deviceVersionList.upgradeInfo.description	String	Description of the upgrade package
deviceVersionList.upgradeInfo.packageUrl	String	Upgrade package url address

Sample output

{
 "result":{
 "msg":"Successful operation。",
 "code":"0",
 "data":{
 "count":1,
 "deviceVersionList":[
 {
 "canBeUpgrade":false,
 "deviceId":"TESTQWERXXXX",
 "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.