privacy.mask.plan (Read person mask schedule)
privacy.mask.plan: Read person mask schedule
privacy.mask.plan · channel scope · permission Config
What it does
Some leaves apply only on certain models; plans, schedules, and mask settings follow device.capability.list and read-back.
Reads the person mask schedule (split leaf: periods from std_imouHumPriMaskPlan/165700, mode struct from std_imouHumPriMaskPlanV1/165800, merged as privacy.mask.plan). mode: 0 all day / 1 daytime / 2 night / 3 custom; custom requires mode.model=3 and periods.
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 properties in one request returns DV2008. See Permission codes. Shared devices must satisfy one alias in the capability row share_auth_code (for example Config,config).
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 |
channelId | String | yes | Channel index; "0" is typical for IPCs |
properties | Array | yes | ["privacy.mask.plan"] |
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",
"channelId": "0",
"properties": [
"privacy.mask.plan"
]
}
}
Response data fields
The value is in result.data.properties["privacy.mask.plan"].
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
periods | Time windows. Used only when mode.model=3. At least one segment; each needs date (weekday 0–6), beginTime, endTime (THHmmss). | array | no | Up to 21 entries |
periods.item.date | Weekday 0–6. Required on every segment. | enum | yes | 0 Sunday; 1 Monday; 2 Tuesday; 3 Wednesday; 4 Thursday; 5 Friday; 6 Saturday |
periods.item.beginTime | Start time within the day, format THHmmss, e.g. T000000. Required on every segment. | text | yes | Format THHmmss, e.g. T235959 |
periods.item.endTime | End time within the day, format THHmmss, e.g. T235959. Required on every segment. | text | yes | Format THHmmss, e.g. T235959 |
mode | Mode struct. | struct | no | Contains model, date |
mode.model | Mode. When 3 (custom), periods is returned. | enum | yes | 0 all day; 1 daytime; 2 night; 3 custom |
mode.date | Time. Device-side extra time value (int 0–255), not weekday. | int | no | 0–255, step 1 |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"privacy.mask.plan": {
"mode": {
"model": 0,
"date": 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.