接口列表

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

接口列表如下:

序号 接口功能 描述
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"
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号
deviceName String 设备名称
model String 设备型号,如CS-C2S-21WPFR-WX
status int 在线状态:0-不在线,1-在线
defence int 具有防护能力的设备布撤防状态:0-睡眠,8-在家,16-外出普通IPC布撤防状态:0-撤防,1-布防
isEncrypt int 是否加密:0-不加密,1-加密
alarmSoundMode int 告警声音模式:0-短叫,1-长叫,2-静音
offlineNotify int 设备下线是否通知:0-不通知 1-通知
category String 设备大类
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

获取摄像头列表

  • 接口功能:

    获取监控点列表

  • 请求地址:

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

  • 请求方式

    POST

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

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

  • 请求参数;

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
pageStart int 分页起始页,从0开始 N
pageSize int 分页大小,默认为10,最大为50 N
  • HTTP请求报文
POST /api/lapp/camera/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&pageStart=0&pageSize=2
  • 返回数据
{
    "page": {
        "total": 2,
        "page": 0,
        "size": 10
    },
    "data": [
        {
            "deviceSerial": "427734444",
            "channelNo": 1,
            "channelName": "C1(427734444)",
            "status": 1,
            "isShared": "1",
            "picUrl": "http://img.ys7.com/group1/M00/02/B4/CmGCA1dRGyuAdJ_RAABJBCB_Re4796.jpg",
            "isEncrypt": 1,
            "videoLevel": 2,
            "permission": -1
        },
        {
            "deviceSerial": "519544444",
            "channelNo": 1,
            "channelName": "C2C(519544444)",
            "status": 0,
            "isShared": "2",
            "picUrl": "https://i.ys7.com/assets/imgs/public/homeDevice.jpeg",
            "isEncrypt": 0,
            "videoLevel": 2,
            "permission": -1

        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
deviceSerial String 设备序列号
channelNo int 通道号
channelName String 通道名
status int 在线状态:0-不在线,1-在线
picUrl String 图片地址(大图),若在萤石客户端设置封面则返回封面图片,未设置则返回默认图片
isEncrypt int 是否加密,0:不加密,1:加密
videoLevel int 视频质量:0-流畅,1-均衡,2-高清,3-超清
permission int 分享设备的权限字段

permission权限解析方式: 判断是否有该权限样例代码:

public boolean hasThisPermission(int permission) {
        return (this.code & permission) == this.code;
    }

code类型: 预览权限:1,回放权限:1<<1,告警权限:1<<2,对讲权限:1<<3 (<<表示位或)

  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

获取设备状态信息

  • 接口功能:

    该接口用于根据序列号通道号获取设备状态信息

  • 请求地址:

    https://open.ys7.com/api/lapp/device/status/get

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734168&channel=1
  • 返回数据
{
    "data": {
        "privacyStatus": 0,
        "pirStatus": -2,
        "alarmSoundMode": 2,
        "battryStatus": -1,
        "lockSignal": -1,
        "diskNum": 1,
        "diskState": "0---------------",
        "cloudType": 0,
        "cloudStatus": 2,
        "nvrDiskNum": 1,
        "nvrDiskState": "0---------------"
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
privacyStatus int 隐私状态: 0:隐私状态关闭;1:隐私状态打开;-1:初始值;2:不支持,C1专用,-2:设备没有上报或者设备不支持该状态
pirStatus int 红外状态,1:红外启用,0:红外禁用,-1:初始值,2:不支持,-2:设备没有上报或者设备不支持该状态
alarmSoundMode int 告警声音模式,0:短叫,1:长叫,2:静音,3:自定义语音,-1:设备没有上报或者设备不支持该状态
battryStatus int 电池电量,1到100(%),-1:设备没有上报或者设备不支持该状态
lockSignal int 门锁和网关间的无线信号,百分比表示 差值超过10上报,-1:设备没有上报或者设备不支持该状态
diskNum int 挂载的sd硬盘数量,-1:设备没有上报或者设备不支持该状态
diskState String sd硬盘状态:0:正常;1:存储介质错;2:未格式化;3:正在格式化;返回形式:一个硬盘表示为"0---------------",两个硬盘表示为"00--------------",以此类推;-1:设备没有上报或者设备不支持该状态
cloudStatus int 云存储状态: -2:设备不支持;-1: 未开通;0: 未激活;1: 激活;2: 过期
nvrDiskNum int NVR上挂载的硬盘数量: -1:设备没有上报或者设备不支持;-2:未关联,类似于NVR类型的上级设备
nvrDiskState String NVR上挂载的硬盘状态:0:正常;1:存储介质错;2:未格式化;3:正在格式化;返回形式:一个硬盘表示为"0---------------",两个硬盘表示为"00--------------",以此类推;-1:设备没有上报或者设备不支持该状态;-2:未关联,类似于NVR类型的上级设备
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

获取指定设备的通道信息

  • 接口功能:

    获取指定设备的通道信息。

  • 请求地址:

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

  • 请求方式

    POST

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

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

  • 请求参数;

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

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734222
  • 返回数据
{
    "data": [
        {
            "deviceSerial": "427734222",
            "ipcSerial": "427734222",
            "channelNo": 1,
            "deviceName": "My(427734222)427734222",
            "channelName": "My(427734222)427734222",
            "status": 1,
            "isShared": "0",
            "picUrl": "https://portal.ys7.com/assets/imgs/public/homeDevice.jpeg",
            "isEncrypt": 0,
            "videoLevel": 2,
            "relatedIpc": false
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
deviceSerial String 设备序列号
ipcSerial String IPC序列号
channelNo int 通道号
deviceName String 设备名
channelName String 通道名
status int 在线状态:0-不在线,1-在线,-1设备未上报
picUrl String 图片地址(大图),若在萤石客户端设置封面则返回封面图片,未设置则返回默认图片
isEncrypt int 是否加密,0:不加密,1:加密
videoLevel int 视频质量:0-流畅,1-均衡,2-高清,3-超清
relatedIpc boolean 当前通道是否关联IPC:true-是,false-否。设备未上报或者未关联都是false

注:获取到的通道信息,若NVR设备自动上报关联的IPC信息则返回的是IPC的信息,若NVR设备不进行上报,将获取不到关联的IPC信息。

  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

查询设备是否支持萤石协议

  • 接口功能:

    根据设备型号以及设备版本号查询设备是否支持萤石协议

  • 请求地址:

    https://open.ys7.com/api/lapp/device/support/ezviz

  • 请求方式

    POST

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

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

  • 请求参数;

参数名 类型 描述 是否必选
appKey String 用户appKey Y
model String 设备型号 Y
version String 设备版本号 Y
  • HTTP请求报文
POST /api/lapp/device/support/ezviz HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

model=CS-C1-10F&version=V4.1.0 build 130101&appKey=ae1b9af9dcac4caeb88da6dbbf2dd8d5
  • 返回数据
{
    "data": [
        {
            "model": "CS-C1-10F",
            "version":"V4.1.0 build 130101",
            "isSupport": 1
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
model String 设备型号
version String 设备版本号,当isSupport=0时,返回最近支持的版本,当isSupport=1时,返回当前版本
isSupport int 是否支持萤石协议, 0:不支持, 1:支持
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或参数不存在
49999 数据异常 接口调用异常

根据设备序列号查询设备能力集

  • 接口功能:

    该接口用户根据设备序列号查询设备能力集

  • 请求地址:

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

  • 请求方式

    POST

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

  • 请求参数;

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

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "support_cloud": "1",
        "support_intelligent_track": "1",
        "support_p2p_mode": "1",
        "support_resolution": "16-9",
        "support_talk": "1",
        "video_quality_capacity": [
            {
                "streamType": "1",
                "videoLevel": "0",
                "resolution": "1",
                "videoBitRate": "5",
                "maxBitRate": "0"
            },
            {
                "streamType": "1",
                "videoLevel": "1",
                "resolution": "3",
                "videoBitRate": "9",
                "maxBitRate": "0"
            },
            {
                "streamType": "1",
                "videoLevel": "2",
                "resolution": "19",
                "videoBitRate": "13",
                "maxBitRate": "0"
            }
        ],
        "support_wifi_userId": "1",
        "support_remote_auth_randcode": "1",
        "support_upgrade": "1",
        "support_smart_wifi": "1",
        "support_ssl": "1",
        "support_weixin": "1",
        "ptz_close_scene": "1",
        "support_preset_alarm": "1",
        "support_related_device": "0",
        "support_message": "0",
        "ptz_preset": "1",
        "support_wifi": "3",
        "support_cloud_version": "1",
        "ptz_center_mirror": "1",
        "support_defence": "1",
        "ptz_top_bottom": "1",
        "support_fullscreen_ptz": "1",
        "support_defenceplan": "1",
        "support_disk": "1",
        "support_alarm_voice": "1",
        "ptz_left_right": "1",
        "support_modify_pwd": "1",
        "support_capture": "1",
        "support_privacy": "1",
        "support_encrypt": "1",
        "support_auto_offline": "1"

    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段:

详见设备能力集说明

能力集说明中有的,而返回字段中没有的那些能力默认不支持

  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或参数不合法
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
20002 设备不存在 设备序列号输入有误或者设备未添加或者通道异常
20014 deviceSerial不合法
49999 数据异常 接口请求异常

根据时间获取存储文件信息

  • 接口功能:

    该接口用于根据时间获取存储文件信息

  • 请求地址:

    https://open.ys7.com/api/lapp/video/by/time

  • 请求方式

    POST

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

  • 请求参数;

参数名 类型 描述 是否必选
accessToken String 访问令牌 Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 通道号,非必选,默认为1 N
startTime long 起始时间,时间格式为:1378345128000。非必选,默认为当天0点 N
endTime long 结束时间,时间格式为:1378345128000。非必选,默认为当前时间 N
recType int 回放源,0-系统自动选择,1-云存储,2-本地录像。非必选,默认为0 N
  • HTTP请求报文
POST /api/lapp/alarm/video HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&channelNo=1&startTime=1378345128000&endTime=1378345128000&recType=0
  • 返回数据
{
    "code": "200",
    "msg": "操作成功",
    "data": [
        {
            "recType": 0,
            "startTime": 1378345128000,
            "endTime": 1378345128000,
            "deviceSerial": "409864662",
            "cameraNo": "1",
            "localType": "ALLEVENT",
            "channelType": "D",
            "id": 20432171600,
            "fileId": "20432171600",
            "ownerId": "chenyong",
            "fileType": 1,
            "fileName": "",
            "cloudType": 1,
            "fileIndex": "5d5b6d94-13e8-440b-a25b-00eda521c35f",
            "fileSize": 4011828,
            "locked": 0,
            "createTime": "2016-08-22 13:59:13",
            "crypt": 22,
            "keyChecksum": "",
            "videoLong": 150000,
            "coverPic": "https://218.244.139.5:0/api/cloud?method=download&fid=a14f8348-1dd1-11b2-aef9-dbed68cc4c3e&session=hik%24shipin7%231%23USK%23at.a2rwv07y6v44ozhqblhb0tly337hb4vq-4jktv8rbjh-193fe5b-cm38stbht",
            "downloadPath": "218.244.139.5:0",
            "type": 1
        },
        {
            "recType": 0,
            "startTime": 1378345128000,
            "endTime": 1378345128000,
            "deviceSerial": "409864662",
            "cameraNo": "1",
            "localType": "ALLEVENT",
            "channelType": "D",
            "id": 20432171600,
            "fileId": "20432171600",
            "ownerId": "chenyong",
            "fileType": 1,
            "fileName": "",
            "cloudType": 1,
            "fileIndex": "5d5b6d94-13e8-440b-a25b-00eda521c35f",
            "fileSize": 4011828,
            "locked": 0,
            "createTime": "2016-08-22 13:59:13",
            "crypt": 22,
            "keyChecksum": "",
            "videoLong": 150000,
            "coverPic": "https://218.244.139.5:0/api/cloud?method=download&fid=a14f8348-1dd1-11b2-aef9-dbed68cc4c3e&session=hik%24shipin7%231%23USK%23at.a2rwv07y6v44ozhqblhb0tly337hb4vq-4jktv8rbjh-193fe5b-cm38stbht",
            "downloadPath": "218.244.139.5:0",
            "type": 1
        }
    ]
}

}
  • 返回字段:
字段名 类型 描述
recType int 回放源,0-系统自动选择,1-云存储,2-本地录像
startTime long 文件开始时间
endTime long 文件结束时间
deviceSerial String 设备序列号
channelNo int 设备通道号
localType String 文件类型 0:ALARM 1:TIMING 2:IO */
channelType String 该字段已废弃
id long 云存储信息主键ID
fileId string 文件ID
ownerId string 文件所属用户ID
fileType int 文件类型0:目录1:视频文件2:图片文件3:音频文件
fileName String 文件名称
cloudType int 该字段已废弃
fileIndex string 文件在云存储上的唯一索引
fileSize long 文件大小,单位B
locked int 是否被锁定。1-锁定;0-未锁定
createTime long 创建时间
crypt int 是否加密0--不加1--加密
keyChecksum String 验证码MD5值
videoLong long 录像长度
coverPic String 封面图片地址
downloadPath String 下载路径
type int 该字段已废弃
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
10013 非开发者账号无权限调用
10030 appkey和appsecret不匹配
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20014 deviceSerial不合法
20032 该用户下通道不存在
60024 取消订阅操作失败
49999 操作异常 -

results matching ""

    No results matching ""