device.status.get (Query online status)

device.status.get: Query online status

What it does

Query device and channel online state. Not in device.capability.list. online is Int, not string.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.status.get

Minimum permission

Administrator: bound or shared devices. Sub-user: own bound devices. Sub-account: authorized devices.

Request parameters

Name	Type	Required	Description
`token`	String	yes	accessToken
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional; wrong model may be ignored or handled by PCS—not guaranteed `DV2009` (per `device.status.get`)

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345"
 }
}

Response data fields

Name	Type	Description
`deviceId`	String	Device serial number
`productId`	String	Returned when known
`online`	Int	Device: `0` offline / `1` online / `3` upgrading / `4` sleep
`channels`	Array	Per-channel status
`channels[].channelId`	String	Channel id
`channels[].online`	Int	Same codes as device

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "online": 1,
 "channels": [
 {
 "channelId": "0",
 "online": 1
 }
 ]
 }
 }
}

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 query (DV20xx)

Code	Meaning	Next step
`DV2004`	Invalid property value	Check parameter range
:---	:---	:---
`DV2007`	Missing channelId	Add channelId
:---	:---	:---
`LIMIT_DEVICE_NUM`	Device count limit	Reduce page size or scope
:---	:---	:---
`PARAM_ILLEGAL_VALUE`	Invalid parameter	Fix request body
:---	:---	:---
`PERMISSION_DENIED`	Permission denied	Check token and share policy

See Return codes · catalog.