detection.door.contactState (Read door contact state)

detection.door.contactState: Read door contact state

detection.door.contactState · device scope · permission Config

What it does

Read door contact state. 0 closed, 1 open (int).

Request URL

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

The administrator does not need an extra permission on a device they bound. A shared device needs one of the capability row share_auth_code aliases (match the console share grant). A bound sub-user does not. A sub-account needs Config. See Permission codes. Do not send channelId on device-scope capabilities. Mixing device and channel properties in one request returns DV2008.

Request parameters

Name	Type	Required	Description
`token`	String	yes	Access token for an administrator, sub-user, or sub-account
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional. If sent and it does not match the device model → `DV2009`
`properties`	Array	yes	`["detection.door.contactState"]`

For common request fields and signing, see Signing conventions and Common request payload.

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",
 
 "properties": ["detection.door.contactState"]
 }
}

Response data fields

Name	Description	Type	Required	Values
`detection.door.contactState`	Door contact	`int`	yes	`0` closed, `1` open

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.door.contactState": 0
 }
 }
 }
}

Error codes

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.

Code	Meaning	Next step
`DV2003`	Property not on device	Use `device.capability.list`
`DV2004`	Value out of range	Check `properties` values
`DV2007`	`channelId` vs scope mismatch	Required for channel scope; omit for device scope
`DV2008`	Mixed device and channel properties	Split the request
`DV2009`	`productId` mismatch	Omit or set actual model id

See Capability errors.

Door contact