detection.motion.region (Read detection region)
detection.motion.region: Read detection region
detection.motion.region · Channel scope · Permission Config
What it does
Reads detection regions on this channel. rect is a rectangle coordinate string; polygon has up to 100 entries, each with name, type, and points.
Values: follow capability discovery, read-back, and the ranges on this page; allowed values and JSON types (number or string) vary by model.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Administrator, sub-user, or sub-account accessToken |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
channelId | String | yes | Channel ID; "0" is common on IPCs |
properties | Array | yes | ["detection.motion.region"] |
Common request fields and the signature are in Development specification.
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",
"channelId": "0",
"properties": [
"detection.motion.region"
]
}
}
Response data fields
The value is in result.data.properties["detection.motion.region"]。
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
rect | Rectangle coordinate string (device/capability model format). | text | yes | string |
polygon | Polygons. Up to 100 entries. | array | yes | up to 100 entries |
polygon.item.name | Name. | text | yes | string |
polygon.item.type | Region type. | enum | yes | 0 all; 1 motion; 2 child exit; 3 package detection; 4 visitor; 5 package zone; 6 privacy |
polygon.item.points | Region coordinates (device/capability model format). | text | yes | string |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.motion.region": {
"rect": "[0,0,100,100]",
"polygon": [
{
"name": "example",
"type": 0,
"points": "[0,0,100,0,100,100,0,100]"
}
]
}
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.