detection.siren.plan (Read siren arming time periods)
detection.siren.plan: Read siren arming time periods
detection.siren.plan · Channel scope · Permission Config
What it does
Reads siren arming time periods on this channel. Up to 5 entries; each has date, time, and enable.
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.siren.plan"] |
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.siren.plan"
]
}
}
Response data fields
The value is in result.data.properties["detection.siren.plan"]. Array limit 5.
| Name | Type | Required | Description |
|---|---|---|---|
item.date | int | yes | Arming days bitmask (bit0–bit6, Sun–Sat); 0–255, step 1 |
item.time | text | yes | Start–end time HH:mm-HH:mm (e.g. 08:30-22:00) |
item.enable | enum | yes | 0 off; 1 on |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.siren.plan": [
{
"date": 127,
"time": "08:30-22:00",
"enable": 0
}
]
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.