queryBaseDeviceChannelInfo (Query Base Device Channel Info for easy4ip App - Imou Open Platform)

queryBaseDeviceChannelInfo: Query Base Device Channel Info for easy4ip App - Imou Open Platform

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

Function details

queryBaseDeviceChannelInfo and queryOpenDeviceChannelInfo share the same query handler in current implementation; names reflect integration convention.

According to the device serial number collection, obtain the basic information of the channel of the device added or shared by the easy4ip app.

Request address

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

Request format

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

Minimum permissions

Administrators use their access token. Sub-accounts need resource permission on dev:{deviceId} (see Permission codes).

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		Multiple devices are separated by English commas, for example: "xxxxx,xxxxx,xxxxx", supports up to 10 devices	List of device serial numbers

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_00006acr3456d12312d3grf60147de7ec",
 "deviceIds":"TESTQWERXXXX"
 }
}

Return data field description

Field	Type	Description
devices.deviceId	String	Device serial number
devices.status	String	Device status, online: online, offline: offline, sleep: hibernation, upgrading
devices.channels.channelId	String	Channel number
devices.channels.channelName	String	Channel name
devices.channels.status	String	Channel status, online: online, offline: offline, close: not configured, sleep: hibernation, upgrading in progress

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "devices":[{
 "deviceId":"TESTQWERXXXX",
 "status":"online",
 "channels":[{
 "channelId":"0",
 "channelName":"TESTQWERXXXX-0",
 "status":"online"
 }]
 }]
 }
 },
 "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 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.