开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
        • 镜头遮蔽
          • privacy.cover.enabled(获取隐私模式开关属性)
          • privacy.cover.enabled(设置隐私模式开关属性)
          • privacy.cover.plan(获取隐私模式计划时间段属性)
          • privacy.cover.plan(设置隐私模式计划时间段属性)
          • privacy.cover.timePoints(获取隐私模式布防时间(时间点模式)属性)
          • privacy.cover.timePoints(设置隐私模式布防时间(时间点模式)属性)
        • 人形遮蔽
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

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.get

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备须具备本能力 share_auth_code 所列权限之一(如 Config,config;与控制台分享授权一致)。子用户绑定不需要。子账号需要 Config。通道级漏 channelId 返回 DV2007。设备和通道写在同一次请求里返回 DV2008。详见 权限码。

传入参数说明

参数名参数类型是否必填参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString是通道号,IPC 常见 "0"
propertiesArray是["privacy.cover.plan"]

公共请求字段与签名见 签名约定 与 公共请求负载。

样例输入

{
 "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"
 ]
 }
}

返回 data 字段说明

值在 result.data.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 星期六
periods.item.beginTime开始时间。日内时刻,格式 THHmmss,如 T000000。每一段必带。text是格式 THHmmss,如 T235959
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",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "privacy.cover.plan": {
 "mode": {
 "model": 0,
 "data": 0
 }
 }
 }
 }
 }
}

错误码

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

错误码错误码说明下一步
DV2003设备未声明该属性以 device.capability.list 为准
DV2004写入值超出型号范围核对 properties 取值
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号

更多见 能力错误码。

设置隐私模式计划时间段属性 · 镜头遮蔽

privacy.cover.enabled(设置隐私模式开关属性)
privacy.cover.plan(设置隐私模式计划时间段属性)