开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
      • 门锁(遗留)
      • 告警消息(遗留)
      • 设备查询(已弃用)
        • checkDeviceBindOrNot(查询设备绑定状态)
        • deviceOnline(获取设备在线状态)
        • listDeviceDetailsByIds(批量查询设备详情)
        • listDeviceDetailsByPage(分页查询设备详情)
        • unBindDeviceInfo(获取未绑定设备信息)
        • upgradeProcessDevice(获取设备升级状态与进度)
        • bindDeviceChannelInfo(获取单个设备通道详情)
        • bindDeviceInfo(单个设备信息获取)
        • bindDeviceList(批量设备信息获取)
        • deviceBaseDetailList(批量获取 easy4ip 应用设备详情)
        • deviceBaseList(分页获取 easy4ip 应用设备通道基础信息)
        • deviceList(获取设备列表)
        • deviceOpenDetailList(批量获取开放平台设备详情)
        • deviceOpenList(分页获取开放平台设备通道基础信息)
        • deviceVersionList(获取设备版本与可升级信息)
        • listDeviceAbility(批量获取设备能力集)
        • queryBaseDeviceChannelInfo(获取 easy4ip 应用设备基础通道信息)
        • queryOpenDeviceChannelInfo(获取开放平台设备基础通道信息)
        • shareDeviceList(分页获取 easy4ip 应用分享设备列表)
      • 设备维护(遗留)
      • 设备操作(遗留)
      • 设备使能(遗留)
      • 动检配置(遗留)
      • 收藏点(遗留)
      • 定时巡航(遗留)
      • 本地录像配置(遗留)
      • 音量(遗留)
      • 存储(遗留)
      • 图像与视频(遗留)
      • 时区(遗留)
      • Wi-Fi(遗留)
      • 本地录像查询(遗留)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
子账号 token 权限
请求参数
请求示例
返回 data 字段
响应示例
错误码
相关参考

deviceOnline(获取设备在线状态)

deviceOnline:获取设备在线状态

已弃用: 新接入请使用 查询在离线(device.status.get)。本页仅供存量 HTTP 对接查阅。

功能说明

获取指定设备及其下所有通道的在线状态。

说明:已被他人绑定的设备无法通过本接口获取在线状态。未绑定设备返回结果仅表示设备本体在线状态(非指定通道 0)。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/deviceOnline

请求格式

POST JSON 请求体见 请求约定;签名见 签名。

子账号 token 权限

子账号 token 调用本接口无需校验权限。

请求参数

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员或子账号 accessToken
deviceIdString是设备序列号

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603370654,
 "nonce":"0a95c2a0-5c6f-4e83-91ec-5723253416c7"
 },
 "id":"66363b83-c699-4513-b16b-2ee54fd62031",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

返回 data 字段

字段名字段类型字段说明
deviceIdString设备序列号
onLineString设备在线状态:0 离线;1 在线;3 升级中;4 休眠
productIdString部分设备详情会返回该字段(用于型号与 device.capability.list 等)
channels.channelIdString设备通道号
channels.onLineString通道在线状态:0 离线;1 在线;3 升级中;4 休眠

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "channels":[
 {
 "channelId":"0",
 "onLine":"1"
 }
 ],
 "deviceId":"TESTQWERXXXX",
 "onLine":"1"
 }
 },
 "id":"66363b83-c699-4513-b16b-2ee54fd62031"
}

错误码

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

网关与鉴权(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。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与能力列表
DV1020通道离线检查通道状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId

更多见 错误码 · DV。

相关参考

  • 开发规范
  • 公共约定
  • 查询在离线
  • 本模块索引
checkDeviceBindOrNot(查询设备绑定状态)
listDeviceDetailsByIds(批量查询设备详情)