开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
      • bindDevice(绑定设备)
      • unBindDevice(解绑设备)
      • device.detail.list(按 ID 批量详情)
      • device.detail.page(分页详情)
      • device.status.get(查询在离线)
      • device.prebind.get(绑定前信息)
      • device.bindstate.get(是否已绑定)
      • subAccountDeviceInfo(获取子账号指定授权设备详情)
      • subAccountDeviceList(分页获取子账号授权设备详情)
      • setDeviceSnap(设备抓图)
      • setDeviceSnapEnhanced(设备抓图增强)
      • timeZoneConfigByDay(按日期设置设备时区夏令时)
      • timeZoneConfigByWeek(按周设置设备时区夏令时)
      • timeZoneQueryByDay(按日查询设备时区夏令时)
      • timeZoneQueryByWeek(按周查询设备时区夏令时)
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

device.detail.page(分页详情)

device.detail.page:分页详情

功能详情

分页查询设备详情。本方法不会出现在 device.capability.list 里。详情里的 capabilityIds[] 是一组能力的 id,不要拿去发 get / set / invoke。canBeUpgrade 等为 Boolean;能力目录里的开关仍是 0 / 1,两套不要混。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.detail.page

最小权限

仅返回当前 token 可见设备:按 source(bind / share / bindAndShare)过滤绑定与分享范围;子账号须传 openid,按授权表分页。与 按 ID 批量详情 同级口径,非「只验 token 即全账号设备」。

传入参数说明

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
pageInt是≥1页码
pageSizeInt是1~50每页条数
sourceString否bindAndSharebind / share / bindAndShare来源过滤
openidString否子账号

样例输入

{
 "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>",
 "page": 1,
 "pageSize": 10,
 "source": "bindAndShare"
 }
}

返回 data 字段说明

参数名参数类型参数说明
countInt本批条数
deviceListArray设备详情,字段见下表

deviceList[]

参数名参数类型参数说明
deviceIdString设备序列号
productIdString已知则返回
deviceStatusStringonline / offline / sleep / upgrading
deviceModelString型号
catalogString大类
brandString品牌
accessTypeString接入类型
deviceVersionString版本
deviceNameString名称
canBeUpgradeBoolean是否可升级
upgradeInfoObject可升级时返回
upgradeInfo.versionString目标版本
upgradeInfo.attentionString升级说明
upgradeInfo.packageUrlString升级包地址
encryptModeString0 / 1
lastOffLineTimeString最后离线时间
bindTimeLong绑定时间
sourceString来源
channelNumInt通道数
playTokenV2String播放码
sdcardStatusStringSD 状态
wifiTransferModeString频段
isSubDeviceBoolean是否子设备
parentDeviceIdString父设备序列号
parentProductIdString父设备型号
capabilityIdsString[]一组能力的 id。不要拿去发 get / set / invoke
channelListArray通道列表,字段见下表
subDeviceListArray子设备摘要
httpPortString海外端口
rtspPortString海外端口
tlsPrivatePortString海外端口
deviceUsernameV2String海外加密账号
devicePasswordV2String海外加密密码

channelList[]

参数名参数类型参数说明
channelIdString通道号
channelNameString通道名称
channelStatusStringonline / offline / sleep / upgrading
cameraStatusStringon / off
channelPicUrlString封面
alarmStatusString布撤防
csStatusString云存储
aiInsightStatusString智见
shareStatusString分享状态
shareFunctionsString分享功能
lastOffLineTimeString离线时间
capabilityIdsString[]通道级,一组能力的 id。不要拿去发 get / set / invoke
resolutionsArray分辨率列表
resolutions[].nameString分辨率名称
resolutions[].imageSizeString图像尺寸
resolutions[].streamTypeString码流类型
productIdString多目等场景下的通道型号

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "count": 1,
 "deviceList": [
 {
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "deviceStatus": "online",
 "deviceModel": "IPC-C22EP",
 "catalog": "IPC",
 "brand": "lechange",
 "deviceVersion": "2.800.0000000.0.R.230101",
 "deviceName": "客厅",
 "canBeUpgrade": false,
 "encryptMode": "0",
 "lastOffLineTime": "",
 "bindTime": 1599031074,
 "source": "bind",
 "channelNum": 1,
 "playTokenV2": "pt_xxx",
 "sdcardStatus": "empty",
 "wifiTransferMode": "5G",
 "isSubDevice": false,
 "capabilityIds": ["detection.motion", "ptz.aim"],
 "channelList": [
 {
 "channelId": "0",
 "channelName": "通道1",
 "channelStatus": "online",
 "cameraStatus": "on",
 "channelPicUrl": "https://example.imou.com/pic/cover.jpg",
 "alarmStatus": "on",
 "csStatus": "off",
 "aiInsightStatus": "off",
 "shareStatus": "",
 "shareFunctions": "",
 "lastOffLineTime": "",
 "capabilityIds": ["detection.motion", "ptz.aim"],
 "resolutions": [
 {
 "name": "1080P",
 "imageSize": "1920x1080",
 "streamType": "main"
 }
 ]
 }
 ],
 "subDeviceList": []
 }
 ]
 }
 }
}

错误码

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

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

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

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

子账号(SUB)

错误码错误码说明下一步
SUB1001–SUB1002子账号无接口权限在 addPolicy 中补策略
SUB1005子账号 token 过期重新 subAccountToken
SUB1006子账号与设备无授权核对 Resource 与设备序列号
SUB1008子账号未绑定应用先创建并绑定子账号

更多见 错误码 · SUB。

设备查询(DV20xx)

错误码错误码说明下一步
DV2012设备不存在核对序列号
:---:---:---
DV2013设备未绑定先绑定(device.capability.list 不用于判绑定)
:---:---:---
DV2011无该能力权限见 权限码
device.detail.list(按 ID 批量详情)
device.status.get(查询在离线)