privacy.cover.plan(设置隐私模式计划时间段属性)
privacy.cover.plan:设置隐私模式计划时间段属性
privacy.cover.plan · 通道级 · 权限 Config
功能详情
本章部分能力仅部分型号在能力清单中暴露;计划、时间点、遮蔽等以 device.capability.list 与读回为准。
设置这路通道的隐私模式计划。mode:0 全天 / 1 仅白天 / 2 仅晚上 / 3 自定义;自定义须同时写 periods(每段 period、beginTime、endTime)。越界拒绝,不截断。
请求地址
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
最小权限
管理员操作自己绑定的设备不需要权限。操作被分享设备须具备本能力 share_auth_code 所列权限之一(如 Config,config;与控制台分享授权一致)。子用户绑定不需要。子账号需要 Config。通道级漏 channelId 返回 DV2007。设备和通道写在同一次请求里返回 DV2008。写超时不代表未执行。详见 权限码。
传入参数说明
| 参数名 | 参数类型 | 是否必填 | 参数说明 |
|---|---|---|---|
token | String | 是 | 管理员、子用户或子账号 accessToken |
deviceId | String | 是 | 设备序列号 |
productId | String | 否 | 可省略。传了且与该设备实际型号不一致 → DV2009 |
channelId | String | 是 | 通道号,IPC 常见 "0" |
properties | Object | 是 | key 为 privacy.cover.plan,下表字段均写在该对象内 |
| 参数名 | 说明 | 类型 | 必填 | 取值 |
|---|---|---|---|---|
properties["privacy.cover.plan"].periods | 时间段。仅 mode.model=3 时使用。至少 1 段;每段必带 period(星期 0-6)、beginTime、endTime(THHmmss)。 | array | 否 | 最多 100 条 |
periods.item.period | 区间。星期 0-6。每一段必带。 | enum | 是 | 0 星期日;1 星期一;2 星期二;3 星期三;4 星期四;5 星期五;6 星期六 |
properties["privacy.cover.plan"].periods.item.beginTime | 开始时间。日内时刻,格式 THHmmss,如 T000000。每一段必带。 | text | 是 | 格式 THHmmss,如 T000000 |
periods.item.endTime | 结束时间。日内时刻,格式 THHmmss,如 T235959。每一段必带。 | text | 是 | 格式 THHmmss,如 T235959 |
mode | 模式。0全天/1仅白天/2仅晚上/3自定义。写入本格须带 model。3=自定义时必须同时写 periods(每段 period、beginTime、endTime)。 | struct | 否 | 含 model、data |
mode.model | 模式。写入 mode 时必带。3=自定义时须同时写 periods。 | enum | 是 | 0 全天;1 仅白天;2 仅晚上;3 自定义 |
mode.data | 时间。设备侧附加时间值(int 0-255),不是星期。 | int | 否 | 0~255,步长 1 |
样例输入
{
"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.cover.plan": {
"mode": {
"model": 0,
"data": 0
}
}
}
}
}
返回 data 字段说明
成功时 code 为 "0",data 为 {}。
样例输出
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
错误码
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名校验异常 | 按 HTTP 开发规范 核对 sign |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV2003 | 设备未声明该属性 | 以 device.capability.list 为准 |
DV2004 | 写入值超出型号范围 | 核对 properties 取值 |
DV2007 | channelId 与 scope 不符 | 通道级必传,设备级不传 |
DV2008 | 同请求混用设备级与通道级 | 拆分请求 |
DV2009 | productId 与型号不一致 | 省略或改为实际型号 |
更多见 能力错误码。
