deviceOnline (Check Device Online Status - Imou Open Platform)

deviceOnline: Check Device Online Status - Imou Open Platform

Deprecated: Use Query online status (device.status.get). This legacy HTTP page is retained for existing integrations.

Function details

Get the online status of the specified device and all channels under the device.

Note: This interface cannot obtain the online status of devices that have been bound by others. For unbound devices, the returned result only indicates the online status of the device (not the given channel 0).

Request address

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

Request format

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

The sub-account token can be requested without permission

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":1603370654,
 "nonce":"0a95c2a0-5c6f-4e83-91ec-5723253416c7"
 },
 "id":"66363b83-c699-4513-b16b-2ee54fd62031",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

Field	Type	Description
`deviceId`	String	Device serial number
`onLine`	String	Device status: `0` offline; `1` online; `3` upgrading; `4` sleep
`productId`	String	Optional; present for some devices when returned by the platform
`channels[].channelId`	String	Channel number
`channels[].onLine`	String	Channel status (same values as `onLine`)

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "channels":[
 {
 "channelId":"0",
 "onLine":"1"
 }
 ],
 "deviceId":"TESTQWERXXXX",
 "onLine":"1"
 }
 },
 "id":"66363b83-c699-4513-b16b-2ee54fd62031"
}

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.