deviceOpenDetailList(批量获取开放平台设备详情)
deviceOpenDetailList:批量获取开放平台设备详情
遗留 HTTP 保留: 供已有对接继续调用。新接入请见 设备 API 总览。
遗留 HTTP: 供已有对接继续调用。新接入请从 设备 API 总览与 V2 查询方法选型。
相关当前接口: 新接入也可参考 按 ID 批量详情(
device.detail.list)。 本 HTTP 方法仍保留在当前路径,权威材料未给出一对一替代。
功能说明
按设备序列号、通道号列表、配件号列表批量获取设备详细信息。
说明:查询 easy4ip 应用绑定的设备请使用 deviceBaseDetailList 接口。
请求地址
https://openapi-[DataCenter].easy4ip.com/openapi/deviceOpenDetailList
请求格式
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法取值 | 参数说明 |
|---|---|---|---|---|---|
| token | String | 是 | 管理员 accessToken | ||
| deviceList.deviceId | String | 是 | 设备序列号列表,最多查询 8 台 | ||
| deviceList.channelList | String | 是 | "1,2,3,4,5":逗号分隔的多个通道号 | 通道号列表 | |
| deviceList.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":"At_00000ad9e6e87f0142eb92e207aec46a"
}
}
返回 data 字段
| 字段名 | 字段类型 | 字段说明 |
|---|---|---|
| count | Integer | 本次查询的设备数量 |
| deviceList.deviceId | String | 设备序列号 |
| deviceList.status | String | 设备状态:online 在线,offline 离线,sleep 休眠,upgrading 升级中 |
| deviceList.deviceModel | String | 设备型号 |
| deviceList.catalog | String | 设备品类 [NVR/DVR/HCVR/IPC/SD/IHG/ARC] |
| deviceList.brand | String | 设备品牌:lechange 为 Imou 设备,general 为通用设备 |
| deviceList.channels.resolutions.aplist.name | String | 设备名称 |
| deviceList.channels.resolutions.aplist.ability | String | 设备能力项,逗号分隔,详见设备能力集说明 |
| deviceList.channels.aplist.accessType | String | 设备接入类型:空 表示开放平台程序接入;Lechange 表示乐橙/Imou 常规接入设备;Easy4IP 表示 Easy4IP 程序设备;P2P 表示 P2P 程序设备 |
| deviceList.channels.aplist.encryptMode | String | 加密模式:0 默认加密,1 用户自定义加密 |
| deviceList.channels.aplist.playToken | String | 设备播放码,供 OpenSDK 使用 |
| deviceList.channels.channelId | String | 通道号 |
| deviceList.channels.deviceId | String | 设备序列号 |
| deviceList.channels.channelName | String | 通道名称 |
| deviceList.channels.ability | String | 通道能力集,如 AlarmMD、AudioTalk,逗号分隔 |
| deviceList.channels.status | String | 远程通道状态:online 在线,offline 离线,close 未配置,sleep 休眠,upgrading 升级中 |
| deviceList.channels.picUrl | String | 缩略图 URL |
| deviceList.channels.remindStatus | String | 提醒状态:0 不提醒,1 提醒 |
| deviceList.channels.cameraStatus | String | 镜头遮蔽:on 开启,off 关闭 |
| deviceList.channels.storageStrategyStatus | String | 云存储状态:notExist 未开通套餐,using 已开通且未过期,expired 套餐已过期 |
| deviceList.channels.shareStatus | String | "" 设备属于本人;share 经 easy4ip 应用分享给当前用户 |
| deviceList.channels.shareFunctions | String | 分享/授权的功能权限列表(逗号分隔) |
| deviceList.resolutions.channels.name | String | 客户端展示的分辨率名称 |
| deviceList.resolutions.channels.imageSize | Integer | 分辨率枚举值 |
| deviceList.resolutions.channels.streamType | Integer | 码流类型:0 高清主码流,1 标清辅码流 |
| deviceList.aplist.apId | String | 配件 ID |
| deviceList.aplist.apName | String | 配件名称 |
| deviceList.aplist.apType | String | 配件类型 |
| deviceList.aplist.apModel | String | 配件型号 |
| deviceList.aplist.ioType | String | 配件 IO 类型:in 输入,out 输出 |
| deviceList.aplist.apVersion | String | 配件版本号 |
| deviceList.aplist.apStatus | String | 配件在线状态:online 在线,offline 离线 |
| deviceList.aplist.apEnable | String | 配件启用:on 启用,off 关闭 |
| deviceList.aplist.apCapacity | String | 配件能力项,逗号分隔,如 AudioTalk、PT |
响应示例
{
"result":{
"msg":"操作成功.",
"code":"0",
"data":{
"count":1,
"deviceList":[{
"catalog":"ARC",
"deviceId":"DEVXXXXXXXXXXXX",
"version":"2.145.1000.0.R.20181112",
"aplist":[{
"apId":"APXXXXXXXXXXX",
"apName":"cname",
"apType":"ability",
"apModel":"wbs",
"ioType":"auto",
"apVersion":"V1.2.3",
"apStatus":"online",
"apEnable":"on",
"apCapacity":"AudioTalk,PT"
}],
"accessType":"",
"channels":[{
"channelId":"0",
"deviceId":"DEVXXXXXXXXXXXX",
"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,PlaybackByFilename",
"brand":"lechange",
"playToken":"r3d9yLR2VmjQvDdweRmOaWdTNi1iqUHNCG7sZFQQbvRZ6zw==",
"status":"online"
}]
}
},
"id":"beb24691-d173-473a-8d3d-92db3aee0027"
}
错误码
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名校验异常 | 按 HTTP 开发规范 核对 sign |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001–SUB1002 | 子账号无接口权限 | 在 addPolicy 中补策略 |
SUB1005 | 子账号 token 过期 | 重新 subAccountToken |
SUB1006 | 子账号与设备无授权 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定应用 | 先创建并绑定子账号 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与能力列表 |
DV1020 | 通道离线 | 检查通道状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
更多见 错误码 · DV。
