接口列表

本节包含设备信息查询相关接口等。

接口列表如下:

序号 接口功能 描述
1 获取设备列表 获取用户下的设备列表
2 获取单个设备信息 获取指定设备的信息
3 获取摄像头列表 获取用户下的摄像头列表
4 获取设备状态信息 根据序列号获取设备的状态信息
5 获取指定设备通道信息 根据序列号获取设备的通道信息
6 查询设备是否支持萤石协议 根据设备型号以及设备版本号查询设备是否支持萤石协议
7 查询设备能力集 根据设备序列号查询设备能力集
8 根据时间获取存储文件信息 该接口用于根据时间获取存储文件信息

获取设备列表

  • 接口功能

    查询用户下设备基本信息列表

  • 请求地址

    https://open.ys7.com/api/lapp/device/list

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Get" "Resource":"dev:序列号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
pageStart int 分页起始页,从0开始 N
pageSize int 分页大小,默认为10,最大为50 N

个人版设备接入上限:10台,无分页功能;如需更完善的功能,请升级为企业版

  • HTTP请求报文
POST /api/lapp/device/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&pageStart=0&pageSize=2
  • 返回数据
{
    "page": {
        "total": 2,
        "page": 0,
        "size": 2
    },
    "data": [
        {
            "deviceSerial": "427734000",
            "deviceName": "xiaoge的设备",
            "deviceType": "C1",
            "status": 1,
            "defence": 1,
            "deviceVersion": "V4.2.5 build 151223"
        },
        {
            "deviceSerial": "519266666",
            "deviceName": "测试",
            "deviceType": "UNKNOWN",
            "status": 0,
            "defence": 0,
            "deviceVersion": "V5.3.0 build 150824"
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
deviceName String 设备名称
deviceType String 设备类型
status int 在线状态:0-不在线,1-在线
defence int 具有防护能力的设备布撤防状态:0-睡眠,8-在家,16-外出普通IPC布撤防状态:0-撤防,1-布防
deviceVersion int 设备版本号
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
49999 数据异常 接口调用异常

获取单个设备信息

  • 接口功能

    查询用户下指定设备的基本信息

  • 请求地址

    https://open.ys7.com/api/lapp/device/info

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    "Permission":"Get" "Resource":"dev:序列号"

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/device/info HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734168
  • 返回数据
{
    "data": {
        "deviceSerial": "427734168",
        "deviceName": "",
        "model": "",
        "status": 1,
        "defence": 0,
        "isEncrypt": 1,
        "alarmSoundMode": 2,
        "offlineNotify": 1,
        "category": "C5Si",
        "netType": "wire",
        "signal": "100%"
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号
deviceName String 设备名称
model String 设备型号,如CS-C2S-21WPFR-WX