deviceBaseList (Device Base List - Retrieve Basic Device Information - Imou Open Platform)

deviceBaseList: Device Base List - Retrieve Basic Device Information - Imou Open Platform

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

Function details

Obtain the basic information of the device channel added or shared by the easy4ip app through the page.

Request address

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

Request format

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

Incoming parameter description

Parameter name	Parameter type	Required or not	Legal value	Parameter description
token	String	Yes		Administrator accessToken
bindId	Long	Yes	The numeric value range is: [-1,N], -1 means the first query from the beginning	Last query of the last device Id
limit	Integer	yes	maximum is 128	number of entries
type	String	Yes	bind: query bound devices; share: query shared devices; bindAndShare: query bound and shared devices	binding type
needApInfo	Boolean	Yes	true: required; false: not required	Do you need accessory list information

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_00006acr3456d12312d3grf60147de7ec",
 "bindId":-1,
 "limit":10,
 "type":"bind",
 "needApInfo":true
 }
}

Return data field description

Field	Type	Description
count	Integer	Number of devices queried this time
deviceList.bindId	Long	Bind sharing table auto-increment id
deviceList.deviceId	String	Device serial number
deviceList.channels.channelId	String	Channel number
deviceList.channels.channelName	String	Channel name
deviceList.aplist.apId	String	Accessory id
deviceList.aplist.apName	String	Accessory name
deviceList.aplist.apType	String	Accessories type

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "count":20,
 "deviceList":[{
 "bindId":5596,
 "deviceId":"TESTQWERXXXX",
 "channels":[{
 "channelId":"0",
 "channelName":"channelName"
 }],
 "aplist":[{
 "apId":"TESTQWERXXXX",
 "apName": "K6_39",
 "apType": "SmartLock"
 }]
 }]
 }
 },
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}

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 binding (DV10xx)

Code	Meaning	Next step
`DV1001`	Bound to another account	Unbind or use another device
`DV1002`	Device does not exist	Verify serial number
`DV1003`	Already bound to current account	No need to bind again
`DV1005`	Verification code error	Check device label code
`DV1008`	Bind count limit exceeded	Unbind extra devices
`DV1011`	Device not bound	Bind first
`DV1029`	Device already bound	Do not bind again

See Return codes · DV.