1、接口列表

本节包含设备基本操作相关接口等。

接口列表如下:

序号 接口功能 描述
1 添加设备 添加设备到账号下
2 删除设备 删除账号下指定设备
3 修改设备名称 修改设备名称
4 设备抓拍图片 抓拍设备的当前画面
5 NVR设备关联IPC NVR设备关联IPC
6 NVR设备删除IPC NVR设备删除IPC
7 修改设备视频加密密码 修改设备视频加密密码
8 生成设备配网二维码 生成设备扫描配网二维码二进制数据
9 修改通道名称 修改通道名称

1.1 添加设备

  • 接口功能

    添加设备到账号下

  • 请求地址

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

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
validateCode String 设备验证码,设备机身上的六位大写字母 Y
  • HTTP请求报文
POST /api/lapp/device/add HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888&validateCode=ABCDEF
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在 该接口出现这个错误码表示设备未注册至萤石云
20007 设备不在线 检查设备是否在线
20010 设备验证码错误 检查设备验证码是否错误
20011 设备添加失败 检查设备网络等是否正常
20013 设备已被别人添加 该设备已被别的账号添加
20014 deviceSerial不合法
20017 设备已被自己添加 设备已经添加到该账号下
49999 数据异常 接口调用异常

1.2 删除设备

  • 接口功能

    删除账号下设备(为保证该接口正常使用,请勿在萤石云APP开启终端绑定。如果该接口报错20031请手机登录萤石云视频客户端“我的”--“通用设置”--“账号安全”--“终端绑定”,关闭即可)

  • 请求地址

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

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

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

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

1.3 修改设备名称

  • 接口功能

    修改设备名称

  • 请求地址

    https://open.ys7.com/api/lapp/device/name/update

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
deviceName String 设备名称,长度不大于50字节,不能包含特殊字符 Y
  • HTTP请求报文
POST /api/lapp/device/name/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

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

1.4 设备抓拍图片

  • 接口功能

    抓拍设备当前画面,该接口仅适用于IPC或者关联IPC的DVR设备,该接口并非预览时的截图功能。海康型号设备可能不支持萤石协议抓拍功能,使用该接口可能返回不支持或者超时。

    注意:设备抓图能力有限,请勿频繁调用,频繁调用将会被拉入限制黑名单,建议调用的间隔为4s左右

  • 请求地址

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

  • 请求方式

    POST

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

    "Permission":"Capture" "Resource":"Cam:序列号:通道号"

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
channelNo int 通道号,IPC设备填写1 Y
  • HTTP请求报文
POST /api/lapp/device/capture HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.12xp95k63bboast3aq0g5hg22q468929&deviceSerial=427734888&channelNo=1
  • 返回数据
{
    "data": {
        "picUrl": "http://img.ys7.com//group2/M00/74/22/CmGdBVjBVDCAaFNZAAD4cHwdlXA833.jpg"
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
picUrl String 抓拍后的图片路径,图片保存有效期为2小时
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
10051 无权限进行抓图 设备不属于当前用户或者未分享给当前用户
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁或者设备不支持萤石协议抓拍
20014 deviceSerial不合法
20032 该用户下该通道不存在 检查设备是否包含该通道
49999 数据异常 接口调用异常
60017 设备抓图失败 设备返回失败
60020 不支持该命令 确认设备是否支持抓图

1.5 NVR设备关联IPC

  • 接口功能

    该接口用于NVR设备关联IPC

  • 请求地址

    https://open.ys7.com/api/lapp/device/ipc/add

  • 请求方式

    POST

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

    "Permission":"Config" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
ipcSerial String 待关联的IPC设备序列号 Y
channelNo int 非必选参数,不为空表示给指定通道关联IPC,为空表示给通道1关联IPC N
validateCode String 非必选参数,IPC设备验证码,默认为空 N
  • HTTP请求报文
POST /api/lapp/device/ipc/add HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777&validateCode=
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码
60020 不支持该命令 确认设备是否支持关联IPC
60040 添加的设备不在同一局域网
60041 添加的设备被其他设备关联或响应超时
60042 添加的设备密码错误
60043 添加的设备超出最大数量
60044 添加的设备网络不可达超时
60045 添加的设备的IP和其他通道的IP冲突
60046 添加的设备的IP和本设备的IP冲突
60047 码流类型不支持
60048 带宽超出系统接入带宽
60049 IP或者端口不合法
60050 添加的设备版本不支持需要升级才能接入
60051 添加的设备不支持接入
60052 添加的设备通道号出错
60053 添加的设备分辨率不支持
60054 添加的设备账号被锁定
60055 添加的设备取码流出错 检查IPC设备码流

1.6 NVR设备删除IPC

  • 接口功能

    该接口用于NVR设备解除关联IPC

  • 请求地址

    https://open.ys7.com/api/lapp/device/ipc/delete

  • 请求方式

    POST

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

    "Permission":"Config" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
ipcSerial String 待关联的IPC设备序列号 Y
channelNo int 非必选参数,不为空表示给指定通道关联IPC,为空表示给通道1关联IPC N
  • HTTP请求报文
POST /api/lapp/device/ipc/delete HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码
60020 不支持该命令 确认设备是否支持关联IPC
60056 删除设备失败
60057 删除的设备未关联

1.7 修改设备视频加密密码

  • 接口功能

    该接口用于修改设备视频加密密码(设备重置后修改的密码失效

  • 请求地址

    https://open.ys7.com/api/lapp/device/password/update

  • 请求方式

    POST

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

    "Permission":"Config" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
oldPassword String 设备旧的加密密码 Y
newPassword String 设备新的加密密码,长度大超过12字节 Y
  • HTTP请求报文
POST /api/lapp/device/password/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&oldPassword=AAAAAA&newPassword=BBBBBB
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20010 设备验证码错误 确认输入的旧密码是否正确
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码
60020 不支持该命令 确认设备是否支持修改视频预览密码

1.8 生成设备配网二维码

  • 接口功能

    该接口用于生成设备扫描配网二维码二进制数据,需要自行转换成图片(300x300像素大小)。

  • 请求地址

    https://open.ys7.com/api/lapp/device/wifi/qrcode

  • 请求方式

    POST

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

    "Permission":"Config" "Resource":"Cam:序列号:通道号"

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
ssid String 路由器SSID,即WIFI名称,建议不要设置中文名称 Y
password String WIFI密码 Y
  • HTTP请求报文
POST /api/lapp/device/wifi/qrcode HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&ssid=8d6bi&password=Zhg%2C%2C222
  • 返回数据
{
    "data": {
        "imageData": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQK5nxd/y5/8D/8AZaKK5cH/\r\nAB4/P8j3eJP+RXV/7d/9KRzNFFFe6flR6ZRRRXzJ+4hRRRQAV5nRRXp5d9r5fqfDcZ/8uP8At7/2\r\n0K6bwj/y+f8AAP8A2aiiunGfwJfL8zw+G/8AkaUv+3v/AElnTUUUV4Z+qhRRRQAUUUUAFFFFABXM\r\n+Lv+XP8A4H/7LRRXTg/48fn+R4fEn/Irq/8Abv8A6UjmaKKK90/KgooooAKKKKAP/9k=\r\n"
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
imageData String 生成的二维码二进制数据
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
10017 appKey不存在 确认appKey是否正确
49999 数据异常 接口调用异常
  • 说明

1、目前只有部分设备支持扫描配网二维码进行配网的功能,请确定您要添加的设备在以下支持功能的设备型号(设备型号可在设备底座标签上看到)列表中:

设备型号
CS-C2C-31WFR-B
CS-C2miniS-52WFR
CS-C2W-31WPFR
CS-C6T-32WMFR
CS-F2-31WFSRT

2、该接口获取的是二维码图片二进制数据,生成图片需要将该二进制数据转换为图片,以下提供JAVA转换示例代码(存储到本地):

package com.ys7.open;

import sun.misc.BASE64Decoder;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;

public class TestQRCode {
    static String data = "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQK5nxd/y5/8D/8AZaKK5cH/\r\nAB4/P8j3eJP+RXV/7d/9KRzNFFFe6flR6ZRRRXzJ+4hRRRQAV5nRRXp5d9r5fqfDcZ/8uP8At7/2\r\n0K6bwj/y+f8AAP8A2aiiunGfwJfL8zw+G/8AkaUv+3v/AElnTUUUV4Z+qhRRRQAUUUUAFFFFABXM\r\n+Lv+XP8A4H/7LRRXTg/48fn+R4fEn/Irq/8Abv8A6UjmaKKK90/KgooooAKKKKAP/9k=\r\n";
    static BASE64Decoder decoder = new sun.misc.BASE64Decoder();

    public static void main(String[] args) throws Exception {
        base64StringToImage(data);
    }

    /**
     * 将二进制转换为图片
     *
     * @param base64String
     */
    static void base64StringToImage(String base64String) {
        try {
            byte[] bytes1 = decoder.decodeBuffer(base64String);
            ByteArrayInputStream bais = new ByteArrayInputStream(bytes1);
            BufferedImage bi1 = ImageIO.read(bais);
            File file = new File("D://QRCode.jpg");// 指定图片存储路径、图片名称和格式
            ImageIO.write(bi1, "jpg", file);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

3、接口获取的二维码二进制数据,可以直接写入HTML的img标签中,例如:

<img src="data:image/jpg;base64,...">  /*...填写生成的图片二进制数据即可*/

1.9 修改通道名称

  • 接口功能

    修改通道名称

  • 请求地址

    https://open.ys7.com/api/lapp/camera/name/update

  • 请求方式

    POST

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

    "Permission":"Update" "Resource":"Cam:序列号:通道号"

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号 Y
name String 通道名称,长度不大于50字节,不能包含特殊字符 Y
channelNo int 非必选参数,不为空表示修改指定通道名称,为空表示修改通道1名称 N
  • HTTP请求报文
POST /api/lapp/camera/name/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.cp894sbq65xa5niv0myrfdzma0ja7js1&deviceSerial=0&channelNo=1&name=test
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 检查设备对应通道是否存在
49999 数据异常 接口调用异常

results matching ""

    No results matching ""