detection.motion.sensitivity (Set motion sensitivity)
detection.motion.sensitivity: Set motion sensitivity
detection.motion.sensitivity · Channel scope · Permission Config
What it does
Sets motion sensitivity on this channel (channelId required; general / polygon / person / pir). Request values are API levels 1–5 per field (same as Get motion sensitivity). You may send only the slots you need to change, based on discovery and what the device supports; omit slots that are not on the device. Out-of-range values are rejected, not clamped. Legacy setDeviceAlarmSensitivity uses a single sensitive field; getDeviceAlarmParam returns stall.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
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. A write timeout does not mean the operation did not run.
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 | Object | yes | key is detection.motion.sensitivity |
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
general | General sensitivity level. | enum | no | 1–5 (1 is lowest) |
polygon | Polygon region level. | enum | no | 1–5 |
person | Person sensitivity level. | enum | no | 1–5 |
pir | PIR sensitivity level. | enum | no | 1–5 |
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.sensitivity": {
"general": 1,
"polygon": 1,
"person": 1,
"pir": 1
}
}
}
}
Response data fields
On success, code is "0" and data is {}.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
Error codes
Gateway and device error codes are in Global return codes.