乐橙云开发文档
控制台
更新日志
控制台
更新日志
快速入门
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • 账号与授权
    • 设备管理
    • 设备能力
      • device.capability.list(查询可用能力)
      • device.cover.refresh(刷新封面)
      • device.name.set(改名)
      • device.password.set(改密)
      • device.password.verify(验密)
      • device.property.get(批量读配置)
      • device.property.set(批量写配置)
      • device.reboot.execute(重启设备)
      • device.restore.execute(恢复出厂)
      • device.service.invoke(调用一次动作)
      • device.time.get(获取 UTC 时钟)
      • device.time.sync(平台校时)
      • device.upgrade.execute(触发升级)
      • device.upgrade.process(升级进度)
      • device.wifi.control(连接或断开 WiFi)
      • device.wifi.current(当前 WiFi)
      • device.wifi.scan(扫描热点)
    • 设备配置与操作
    • 直播地址
    • 录像查询
    • 告警记录
    • 推送配置
    • 门锁
    • 云存储
    • 云转存
    • AI分析
    • AI智见
    • 资源池额度管理
    • 遗留接口
  • SDK 与工具
  • 行业方案
  • 平台与支持
本页目录
请求参数
请求示例
响应字段
响应示例
错误码
说明
相关

device.capability.list(查询可用能力)

device.capability.list:查询可用能力

要点:https://openapi.lechange.cn/openapi/v2/device.capability.list · 见 错误码

查询可用能力,含取值说明。按设备查(这台现在能干什么)或按型号查(还没有设备时评估)。本接口不按权限裁清单。

请求参数

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString条件按设备查时传。与 productId 至少传一个
productIdString条件按型号查时传。与 deviceId 至少传一个
channelIdString否通道号,IPC 常见 "0"。不要传 -1只在按设备查时有意义。不传 = 查设备级。传 = 该通道通道级 外加 设备级
langString否应用站点默认如 zh-CN展示文案语言
incloudTslBoolean否falsetrue / false为 true 时,叶子 property/service/event 附带绑定 ident/ref 的 tsl 元数据

都传 deviceId 与 productId 时以设备为准;型号不一致返回 DV2009。

请求示例

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

响应字段

参数名参数类型参数说明
deviceIdString回显。按型号查时不返回
channelIdString回显;未传则不返回
productIdString型号。按设备查时由平台解析回显
bindTypeString型号绑定类型
capabilitiesArray可用能力清单
capabilities[].capabilityIdString一组能力的 id。仅作响应字段,不要拿去发 get / set / invoke / 查告警;请用下面的整段 propertyId / serviceId / eventId
capabilities[].nameString展示名
capabilities[].scopeStringdevice 设备 / channel 通道 / all 两者都有
capabilities[].propertiesArray配置 / 状态项;无则为 []
capabilities[].properties[].propertyIdString整段 propertyId
capabilities[].properties[].nameString展示名
capabilities[].properties[].descString说明。空则不返回
capabilities[].properties[].accessModeStringr 只读 / w 只写 / rw 可读写。含 w 才允许 set
capabilities[].properties[].defaultData同点位默认值。无则不返回。开关为 int 0/1
capabilities[].properties[].dataTypeObject取值说明
capabilities[].properties[].dataType.typeStringint / float / enum / text / struct / array。公开不出现 bool
capabilities[].properties[].dataType.specs.rangeArray[下限, 上限],仅数值类型
capabilities[].properties[].dataType.specs.listArray枚举项。每项含 value 与 desc
capabilities[].properties[].tslObject仅 incloudTsl=true 时出现;含绑定 ident/ref 等
capabilities[].servicesArray一次性动作;无则为 []
capabilities[].services[].serviceIdString整段 serviceId
capabilities[].services[].nameString展示名
capabilities[].services[].inputDataArray入参。field 为调用 key。无入参为 []
capabilities[].services[].outputDataArray出参。无出参为 []
capabilities[].services[].timeoutMsInt建议超时
capabilities[].services[].tslObject仅 incloudTsl=true 时出现
capabilities[].eventsArray上报事件;无则为 []
capabilities[].events[].eventIdString整段 eventId;查询报文里的 msgType 即此值
capabilities[].events[].nameString展示名
capabilities[].events[].outputDataArray事件字段。没有则为 []
capabilities[].events[].tslObject仅 incloudTsl=true 时出现

struct 子项 key 为 field。某型号实际档位可能是目录子集。

响应示例

{
  "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
  "result": {
    "code": "0",
    "msg": "Operation is successful",
    "data": {
      "deviceId": "TESTIPC000012345",
      "channelId": "0",
      "productId": "56WGTET2",
      "bindType": "paas",
      "capabilities": [
        {
          "capabilityId": "detection.motion",
          "name": "动检",
          "scope": "channel",
          "properties": [
            {
              "propertyId": "detection.motion.enabled",
              "name": "移动检测",
              "accessMode": "rw",
              "defaultData": 0,
              "dataType": {
                "type": "int",
                "specs": {
                  "range": [0, 1]
                }
              }
            },
            {
              "propertyId": "detection.motion.sensitivity",
              "name": "灵敏度",
              "accessMode": "rw",
              "dataType": {
                "type": "enum",
                "specs": {
                  "list": [
                    { "value": "1", "desc": "低" },
                    { "value": "3", "desc": "中" },
                    { "value": "5", "desc": "高" }
                  ]
                }
              }
            }
          ],
          "services": [],
          "events": [
            {
              "eventId": "detection.motion.detected",
              "name": "移动检测报警",
              "outputData": []
            }
          ]
        },
        {
          "capabilityId": "ptz.aim",
          "name": "云台瞄准",
          "scope": "channel",
          "properties": [],
          "services": [
            {
              "serviceId": "ptz.aim.relative",
              "name": "按速度转动",
              "inputData": [
                {
                  "field": "horizontal",
                  "name": "水平速度",
                  "dataType": { "type": "text" }
                },
                {
                  "field": "vertical",
                  "name": "垂直速度",
                  "dataType": { "type": "text" }
                },
                {
                  "field": "zoom",
                  "name": "变倍",
                  "dataType": { "type": "text" }
                },
                {
                  "field": "duration",
                  "name": "持续时间",
                  "dataType": { "type": "int" }
                }
              ],
              "outputData": [],
              "timeoutMs": 10000
            }
          ],
          "events": []
        }
      ]
    }
  }
}

错误码

本接口可能返回下列码;完整分组见 错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名异常按 签名 核对 sign
TK1002token 无效或过期重新获取 token
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1039分钟级限流等到下一分钟再试
OP1040调用超限降低频率
DV1007设备离线或超时等设备上线

能力清单(DV20xx)

错误码错误码说明下一步
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2009productId 与设备实际型号不一致去掉 productId 或改成实际型号
DV2012设备不存在核对序列号

说明

按设备查(传 deviceId)须设备已绑定,否则 DV2013;按型号查(仅 productId)只验 token。管理员:绑定或被分享设备可查;子用户:自己绑定;子账号:已授权设备。本接口不按权限裁清单。

相关

  • 设备能力
  • 权限码

商务合作:cloud_openteam@imou.com · 工单 · 获取帮助(公众号、小程序试用中心)

Copyright © 2015-2026 IMOU. All Rights Reserved. 浙ICP备16023676号

device.network.get(获取局域网信息)
device.cover.refresh(刷新封面)