detection.person.trackRegion (Read close-up tracking region)
detection.person.trackRegion: Read close-up tracking region
detection.person.trackRegion · Channel scope · Permission Config
What it does
Reads close-up tracking region (ipc_trackDefaultRegion). Enable smart tracking first and confirm detection.person.trackRegion via device.capability.list. Includes centerPoint, wide, high (pixels 0–99999).
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.person.trackRegion"] |
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.person.trackRegion"
]
}
}
Response data fields
The value is in result.data.properties["detection.person.trackRegion"]。
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
centerPoint | Center point. | text | yes | String such as "[x,y]"; registry default (0,0) encodes as "[0,0]" |
wide | Width. Range 0–99999, step 1. | int | yes | 0–99999, step 1 |
high | Height. Range 0–99999, step 1. | int | yes | 0–99999, step 1 |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.person.trackRegion": {
"centerPoint": "[50,50]",
"wide": 320,
"high": 240
}
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.