deviceOpenDetailList(批量获取设备的详细信息)
新接入请使用 推荐入口。本页保留给仍在调用 POST /openapi/deviceOpenDetailList 的兼容对接。
deviceOpenDetailList:批量获取设备的详细信息
要点:https://openapi.lechange.cn/openapi/deviceOpenDetailList · 见 错误码
批量根据设备序列号、通道号列表和配件号列表,获取设备的详细信息。channelList 可选:省略或传空表示不按通道过滤;缺省时不返回通道级详情(与实现「长度为 0 不返回通道」一致)。
注意:查询乐橙App绑定的设备需要通过deviceBaseDetailList接口获取 。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 | |
|---|---|---|---|---|---|---|
| token | String | 是 | 管理员或子账号 accessToken(子账号须已授权;部分 early app 场景仅管理员,以实现为准) | |||
| deviceList | deviceId | String | 是 | 设备序列号;`deviceList` 数组最多 **32** 台 | ||
| channelList | String | 否 | 多个通道号逗号隔开,如 `0,1` | 通道号列表;省略或空表示不按通道过滤详情 | ||
| apList | String | 否 | "1,2,3,4,5":多个配件号逗号隔开 | 配件Id列表 | ||
请求示例
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time":1603370757,
"nonce":"1a411d5a-e88b-45ee-b590-53da98375edd"
},
"id":"beb24691-d173-473a-8d3d-92db3aee0027",
"params":{
"deviceList":[
{
"deviceId":"TESTQWERXXXX"
}
],
"token": "<yourAccessToken>"
}
}
响应字段
| 字段名 | 字段类型 | 字段说明 | |||
|---|---|---|---|---|---|
| count | Integer | 本次查询到的设备数 | |||
| deviceList | deviceId | String | 设备序列号 | ||
| productId | String | 产品id | |||
| status | String | 设备状态,online:在线,offline:离线,sleep:休眠,upgrading升级中 | |||
| deviceModel | String | 设备型号 | |||
| catalog | String | 设备大类【NVR/DVR/HCVR/IPC/SD/IHG/ARC】 | |||
| brand | String | 设备品牌信息:lechange-乐橙设备,general-通用设备 | |||
| version | String | 设备软件版本号 | |||
| name | String | 设备名称 | |||
| ability | String | 设备能力项,逗号隔开;释义见 [能力集对照](/api/legacy/ability-switch/)(新接入用 [device.capability.list](/api/device.capability.list/)) | |||
| accessType | String | 设备接入类型,PaaS-表示Paas程序接入、Lechange-表示乐橙非PaaS设备、Easy4IP表示Easy4IP程序设备、P2P表示P2P程序设备 | |||
| encryptMode | String | 加密模式,0:默认加密模式,1:用户自定义加密模式 | |||
| playToken | String | 设备播放码,opensdk使用 | |||
| channels | channelId | String | 通道号 | ||
| deviceId | String | 设备序列号 | |||
| channelName | String | 通道名称 | |||
| ability | String | 通道能力集(逗号分隔);释义见 [能力集对照](/api/legacy/ability-switch/)(新接入用 [device.capability.list](/api/device.capability.list/)) | |||
| status | String | 远程通道状态,online:在线,offline:离线,close:未配置,sleep:休眠,upgrading升级中 | |||
| picUrl | String | 缩略图URL | |||
| remindStatus | String | 提醒状态,`0` 不提醒 / `1` 提醒([deviceBaseDetailList](/api/deviceBaseDetailList/) 同字段为 `off`/`on` 字面量,语义相同) | |||
| cameraStatus | String | 遮罩状态,on:打开,off:关闭 | |||
| storageStrategyStatus | String | 云存储状态,notExist:未开通套餐,using:开通云存储且没有过期,expired:套餐过期 | |||
| shareStatus | String | "":设备属于自己,share:通过乐橙app共享给此用户 | |||
| shareFunctions | String | 被共享和授权的权限功能列表(逗号隔开) | |||
| resolutions | name | String | 客户端界面展示的分辨率名称 | ||
| imageSize | Integer | 分辨率枚举 | |||
| streamType | Integer | 码流类型,0:主码流,1:辅码流 | |||
| aplist | apId | String | 配件id | ||
| apName | String | 配件名称 | |||
| apType | String | 配件类型 | |||
| apModel | String | 配件的型号 | |||
| ioType | String | 配件的io类型,in:输入,out:输出 | |||
| apVersion | String | 配件的版本号 | |||
| apStatus | String | 配件的在线状态,online:在线,offline:离线 | |||
| apEnable | String | 配件的使能,on:使能开启,off:使能关闭 | |||
| apCapacity | String | 配件能力项,逗号隔开,如AudioTalk,PT | |||
响应示例
{
"result":{
"msg":"操作成功。",
"code":"0",
"data":{
"count":1,
"deviceList":[
{
"catalog":"ARC",
"deviceId":"DEVXXXXXXXXXXXX",
"productId":"xxxXXXXXXXXXXXX",
"version":"2.145.1000.0.R.20181112",
"aplist":[{
"apId":"APXXXXXXXXXXXX",
"apName":"cname",
"apType":"ability",
"apModel":"wbs",
"ioType":"auto",
"apVersion":"V1.2.3",
"apStatus":"online",
"apEnable":"on",
"apCapacity":"AudioTalk,PT"
}],
"accessType":"PaaS",
"channels":[{
"channelId":"0",
"deviceId":"DEVXXXXXXXXXXX",
"channelName":"channelName",
"ability":"ability",
"status":"online",
"picUrl":"http://xxx.xx.com/xxx/3.jpg",
"remindStatus":"0",
"cameraStatus":"on",
"storageStrategyStatus":"using",
"shareStatus":"share",
"shareFunctions":"videoMonitor",
"resolutions":[{
"name":"1080P",
"imageSize":18,
"streamType":0
}]
}],
"encryptMode":"0",
"name":"TP1S-1842",
"deviceModel":"TP1S",
"ability":"WLAN,Auth,BreathingLight,CloudStorage,LocalStorage",
"brand":"lechange",
"playToken":"r3d9yLR2VmjQvDdweRmOaWdTNi1iqUHNCJ0Ptzyxxxxxxxx",
"status":"online"
}
]
}
},
"id":"beb24691-d173-473a-8d3d-92db3aee0027"
}
错误码
本接口可能返回下列码;完整分组见 错误码。
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名异常 | 按 签名 核对 sign |
TK1002 | token 无效或过期 | 重新获取 token |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1039 | 分钟级限流 | 等到下一分钟再试 |
OP1040 | 调用超限 | 降低频率 |
DV1007 | 设备离线或超时 | 等设备上线 |
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001 | 子账号无指定权限 | 在 子账号策略 中补权限 |
SUB1002 | 子账号无任何设备权限 | 授权设备或调整策略 |
SUB1005 | 子账号 token 过期 | 重新 获取子账号 token |
SUB1006 | 子账号与设备无授权关系 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定当前应用 | 先创建并绑定子账号 |
SUB1007 | 创建子账号失败 | 核对参数后重试 |
SUB1009 | 子账号创建失败,账号格式错误 | account 须为手机号或邮箱 |
SUB1010 | 子账号创建失败,账号已存在 | 勿重复绑定同一子账号到应用 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线;低电休眠先 唤醒 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与 设备能力 |
DV1020 | 通道离线 | 检查通道与设备状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
DV1030 | 设备休眠 | 唤醒后再调 |
DV1057 | 通道不存在 | 核对通道号 |
DV1061 | 设备响应超时 | 检查设备网络 |
DV1062 | 需先唤醒设备 | 调用唤醒接口 |
DV1069 | 不满足操作条件 | 见 msg |
说明
支持管理员或子账号 accessToken。子账号须在策略中授予对应设备/通道权限,配置见 权限码。
本接口属于旧版协议。新接入 Open 设备分页详情见 device.detail.page(source=open 等参数以实现为准);批量见 device.detail.list。