本页目录
请求参数
请求示例
响应字段
响应示例
错误码
说明
相关

deviceBaseDetailList（批量获取乐橙app添加或分享的设备详细信息）

新接入请使用 推荐入口。本页保留给仍在调用 POST /openapi/deviceBaseDetailList 的兼容对接。

deviceBaseDetailList：批量获取乐橙app添加或分享的设备详细信息

要点：https://openapi.lechange.cn/openapi/deviceBaseDetailList · 见 错误码

批量根据设备序列号、通道号列表和配件号列表，获取乐橙app添加或分享的设备的详细信息。顶层 channelList 可选；deviceList 项内通道过滤规则与 deviceOpenDetailList 一致。

请求参数

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员或子账号 accessToken（子账号须已授权；部分 early app 返回 `OP_SUB_NO_USE`，仅管理员可用）
deviceListdeviceIdString是设备序列号；`deviceList` 最多 **32** 台（与 [deviceOpenDetailList](/api/deviceOpenDetailList/) 一致）
channelListString否多个通道号逗号隔开通道号列表；可省略
apListString否"1,2,3,4,5":多个配件号逗号隔开配件Id列表

请求示例

{
    "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>",
        "deviceList":[{
            "deviceId":"TESTQWERXXXX",
            "channelList":"0",
            "apList":"TESTQWERXXXX"
        }]
    }
}

响应字段

字段名字段类型字段说明
countInteger本次查询到的设备数
deviceListdeviceIdString设备序列号
statusString设备状态，online：在线，offline：离线，sleep：休眠，upgrading升级中
deviceModelString设备型号
catalogString设备大类【NVR/DVR/HCVR/IPC/SD/IHG/ARC】
brandString设备品牌信息：lechange-乐橙设备，general-通用设备
versionString设备软件版本号
nameString设备名称
abilityString设备能力项，逗号隔开；释义见 [能力集对照](/api/legacy/ability-switch/)（新接入用 [device.capability.list](/api/device.capability.list/)）
accessTypeString设备接入类型，PaaS-表示Paas程序接入、Lechange-表示乐橙非PaaS设备、Easy4IP表示Easy4IP程序设备、P2P表示P2P程序设备
encryptModeString加密模式，0：默认加密模式，1：用户自定义加密模式
playTokenString设备播放码，opensdk使用
channelschannelIdString通道号
deviceIdString设备序列号
channelNameString通道名称
abilityString通道能力集（逗号分隔）；释义见 [能力集对照](/api/legacy/ability-switch/)（新接入用 [device.capability.list](/api/device.capability.list/)）
statusString远程通道状态，online：在线，offline：离线，close：未配置，sleep：休眠，upgrading升级中
picUrlString缩略图URL
remindStatusString提醒状态，`off` 不提醒 / `on` 提醒（[deviceOpenDetailList](/api/deviceOpenDetailList/) 同字段为 `0`/`1`，语义相同）
cameraStatusString遮罩状态，on：打开，off：关闭
storageStrategyStatusString云存储状态，notExist：未开通套餐，using：开通云存储且没有过期，expired：套餐过期
shareStatusString""：设备属于自己，share：通过乐橙app共享给此用户
shareFunctionsString被共享和授权的权限功能列表（逗号隔开）
resolutionsnameString客户端界面展示的分辨率名称
imageSizeInteger分辨率枚举
streamTypeInteger码流类型，0：主码流，1：辅码流
aplistapIdString配件id
apNameString配件名称
apTypeString配件类型
apModelString配件的型号
ioTypeString配件的io类型，in：输入，out：输出
apVersionString配件的版本号
apStatusString配件的在线状态，online：在线，offline：离线
apEnableString配件的使能，on：使能开启，off：使能关闭
apCapacityString配件能力项，逗号隔开，如AudioTalk,PT

响应示例

{
    "result":{
        "msg":"操作成功。",
        "code":"0",
        "data":{
            "count":1,
            "deviceList":[{
                "deviceId":"TESTQWERXXXX",
                "status":"online",
                "deviceModel":"CE-A-TP1",
                "catalog":"SD",
                "brand":"lechange",
                "version":"Chn_A_V1.1",
                "name":"deviceName",
                "ability":"AlarmMD,AudioTalk,AlarmPIR,WLAN,VVP2P",
                "accessType":"PaaS",
                "encryptMode":"0",
                "playToken":"qwejhfdhrubfsdbisjfasnd",
                "channels":[{
                    "channelId":"0",
                    "deviceId":"TESTQWERXXXX",
                    "channelName":"channelName",
                    "ability":"ability",
                    "status":"online", 
                    "picUrl":"http://xxx.xx.com/xxx/3.jpg",
                    "remindStatus":"on",
                    "cameraStatus":"on",
                    "storageStrategyStatus":"using",
                    "shareStatus":"share",
                    "shareFunctions":"videoMonitor",
                    "resolutions":[{
                        "name":"1080P",
                        "imageSize":18,
                        "streamType":0
                    }]
                }],
                "aplist":[{
                    "apId":"APXXXXXXXXXXX",
                    "apName":"cname",
                    "apType":"ability",
                    "apModel":"wbs",
                    "ioType":"auto",
                    "apVersion":"V1.2.3",
                    "apStatus":"online",
                    "apEnable":"on",
                    "apCapacity":"AudioTalk,PT"
                }]
            }]
        }
    },
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}

错误码

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

网关与鉴权（SN / TK / OP）

错误码错误码说明下一步
SN1001签名异常按 签名 核对 sign
TK1002token 无效或过期重新获取 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。子账号须在策略中授予对应设备/通道权限，配置见 权限码。

本接口属于旧版协议，无替代。

相关

bindDeviceList（根据设备序列号获取多个设备信息）
deviceBaseList（分页获取乐橙app添加或分享的设备通道基本信息）