1. 接口列表

本节包含设备开关状态操作的相关接口等。

接口列表如下:

序号 接口功能 描述
1 设备布撤防 设置设备活动检测开关状态
2 关闭设备视频加密 关闭设备视频加密开关
3 开启设备视频加密 打开设备视频加密开关
4 获取wifi配置提示音开关状态 获取wifi配置或者设备重启提示音开关状态
5 设置wifi配置提示音开关 设置wifi配置或者设备重启提示音开关状态
6 获取镜头遮蔽开关状态 获取镜头遮蔽开关状态
7 设置镜头遮蔽开关 设置镜头遮蔽开关
8 获取声源定位开关状态 获取声源定位开关状态
9 设置声源定位开关 设置声源定位开关
10 获取设备布撤防时间计划 获取设备布撤防(活动检测)时间计划
11 设置布撤防时间计划 设置布撤防(活动检测)时间计划
12 获取摄像机指示灯开关状态 获取摄像机指示灯开关状态
13 设置摄像机指示灯开关 设置摄像机指示灯开关
14 获取全天录像开关状态 获取全天录像开关状态
15 设置全天录像开关 设置全天录像开关
16 获取移动侦测灵敏度配置 获取智能算法配置信息
17 设置移动侦测灵敏度 设置智能算法模式
18 设置告警声音模式 设置设备告警声音模式
19 开启或关闭设备下线通知 开启或关闭设备下线通知
20 获取设备麦克风开关状态 获取设备麦克风即声音开关状态
21 设置设备麦克风开关 设置设备麦克风即声音开关
22 设置设备移动跟踪开关 设置设备移动跟踪开关
23 获取设备移动跟踪开关状态 获取设备移动跟踪开关状态
24 设置设备osd名称 设置设备预览时osd名称
25 获取智能检测开关状态 获取设备智能检测开关状态
26 设置智能检测开关状态 设置智能检测开关

1.1. 设备布撤防

  • 接口功能

    对设备布撤防状态进行修改(活动检测开关),实现布防和撤防功能。

  • 请求地址

    https://open.ys7.com/api/lapp/device/defence/set

  • 请求方式

    POST

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

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

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
isDefence int 具有防护能力设备布撤防状态:0-睡眠,8-在家,16-外出普通IPC设备布撤防状态:`0-撤防,1-布防 Y
  • HTTP请求报文
POST /api/lapp/device/defence/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

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

1.2. 关闭设备视频加密

  • 接口功能

    根据设备验证码关闭设备视频加密开关

  • 请求地址

    https://open.ys7.com/api/lapp/device/encrypt/off

  • 请求方式

    POST

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

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

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

accessToken=at.8z25h2063dapeus7c99bb0r6e0kjfjz5&deviceSerial=427734888&validateCode=ABCDEF
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20010 设备验证码错误 检查设备验证码是否错误
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60016 加密未开启,无需关闭 设备加密开关已是关闭状态

1.3. 开启设备视频加密

  • 接口功能

    开启设备视频加密开关

  • 请求地址

    https://open.ys7.com/api/lapp/device/encrypt/on

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.8z25h2063dapeus7c99bb0r6e0kjfjz5&deviceSerial=427734888
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60019 加密已开启 设备加密开关已是开启状态

1.4. 获取wifi配置提示音开关状态

  • 接口功能

    该接口用于获取wifi配置或设备启动提示音开关状态

  • 请求地址

    https://open.ys7.com/api/lapp/device/sound/switch/status

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=502608888
  • 返回数据
{
    "data": {
        "deviceSerial": "502608888",
        "channelNo": 1,
        "enable": 1
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
enable int 状态:0-关闭,1-开启
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持设置WIFI配置提示音开关功能

1.5. 设置wifi配置提示音开关

  • 接口功能

    该接口用于设置wifi配置或设备启动提示音开关

  • 请求地址

    https://open.ys7.com/api/lapp/device/sound/switch/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 状态:0-关闭,1-开启 Y
channelNo int 通道号,不传表示设备本身 N
  • HTTP请求报文
POST /api/lapp/device/sound/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510888&enable=1&channelNo=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持设置WIFI配置提示音开关功能
60022 已是当前状态 已是当前开关状态

1.6. 获取镜头遮蔽开关状态

  • 接口功能

    该接口用于获取设备镜头遮蔽开关状态(需要设备支持镜头遮蔽功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/scene/switch/status

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
    "data": {
        "deviceSerial": "596510666",
        "channelNo": 1,
        "enable": 1
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
enable int 状态:0-关闭,1-开启
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持镜头遮蔽功能

1.7. 设置镜头遮蔽开关

  • 接口功能

    该接口用于设置设备镜头遮蔽开关状态(需要设备支持镜头遮蔽功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/scene/switch/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 状态:0-关闭,1-开启 Y
channelNo int 通道号,不传表示设备本身 N
  • HTTP请求报文
POST /api/lapp/device/scene/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持镜头遮蔽功能
60022 已是当前状态 已是当前开关状态

1.8. 获取声源定位开关状态

  • 接口功能

    该接口用于获取设备声源定位开关状态(需要设备支持声源定位功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/ssl/switch/status

  • 请求方式

    POST

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
    "data": {
        "deviceSerial": "596510666",
        "channelNo": 1,
        "enable": 1
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
enable int 状态:0-关闭,1-开启
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持声源定位功能

1.9. 设置声源定位开关

  • 接口功能

    该接口用于设置设备声源定位开关状态(需要设备支持声源定位功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/ssl/switch/set

  • 请求方式

    POST

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 状态:0-关闭,1-开启 Y
channelNo int 通道号,不传表示设备本身 N
  • HTTP请求报文
POST /api/lapp/device/ssl/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持声源定位功能
60022 已是当前状态 已是当前开关状态

1.10. 获取设备布撤防时间计划

  • 接口功能

    该接口用于获取设备布撤防计划(需要设备支持布撤防计划

  • 请求地址

    https://open.ys7.com/api/lapp/device/defence/plan/get

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示获取指定通道布撤防计划,为空表示获取设备本身布撤防计划 N
  • HTTP请求报文
POST /api/lapp/device/defence/plan/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888&channelNo=1
  • 返回数据
{
    "data": {
        "startTime": "23:20",
        "stopTime": "23:21",
        "period": "0,1,6",
        "enable": 0
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
startTime String 开始时间,如16:00,默认为00:00
stopTime String 结束时间,如16:00,n00:00表示第二天的0点
period String 周一~周日,用0~6表示,英文逗号分隔
enable int 是否启用:1-启用,0-不启用
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持设备布撤防计划功能

1.11. 设置布撤防时间计划

  • 接口功能

    该接口用于设置设备布撤防(活动检测)时间计划(需要设备支持布撤防计划

  • 请求地址

    https://open.ys7.com/api/lapp/device/defence/plan/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 通道号,不传表示设备本身 N
startTime String 开始时间,如16:00,默认为00:00 N
stopTime String 结束时间,如16:30;如果为第二天,在时间前加上n,如n00:00.结束时间必须在开始时间之后,间隔不能超过24个小时 N
period String 周一~周日,用0~6表示,英文逗号分隔,默认为0,1,2,3,4,5,6 N
enable String 是否启用:1-启用,0-不启用,默认为1 N
  • HTTP请求报文
POST /api/lapp/device/defence/plan/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888&channelNo=1&period=0%2C1%2C6&startTime=23%3A20&stopTime=23%3A21&enable=0
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持设备布撤防计划功能

1.12. 获取摄像机指示灯开关状态

  • 接口功能

    该接口用于获取设备指示灯开关状态(需要设备支持指示灯功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/light/switch/status

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
    "data": {
        "deviceSerial": "596510666",
        "channelNo": 1,
        "enable": 1
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
enable int 状态:0-关闭,1-开启
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持指示灯设置功能

1.13. 设置摄像机指示灯开关

  • 接口功能

    该接口用于设置摄像机指示灯开关状态(需要设备支持指示灯功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/light/switch/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 状态:0-关闭,1-开启 Y
channelNo int 通道号,不传表示设备本身 N
  • HTTP请求报文
POST /api/lapp/device/light/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持指示灯设置功能
60022 已是当前状态 已是当前开关状态

1.14. 获取全天录像开关状态

  • 接口功能

    该接口用于获取设备全天录像开关状态(需要设备支持全天录像功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/fullday/record/switch/status

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
    "data": {
        "deviceSerial": "596510666",
        "channelNo": 1,
        "enable": 1
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
enable int 状态:0-关闭,1-开启
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持全天录像配置

1.15. 设置全天录像开关

  • 接口功能

    该接口用于设置全天录像开关状态(需要设备支持全天录像功能

  • 请求地址

    https://open.ys7.com/api/lapp/device/fullday/record/switch/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 状态:0-关闭,1-开启 Y
channelNo int 通道号,不传表示设备本身 N
  • HTTP请求报文
POST /api/lapp/device/fullday/record/switch/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持全天录像配置
60022 已是当前状态 已是当前开关状态

1.16. 获取移动侦测灵敏度配置

  • 接口功能

    该接口用于获取智能算法配置(目前只支持移动侦测灵敏度配置)信息

  • 请求地址

    https://open.ys7.com/api/lapp/device/algorithm/config/get

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
    "data": [
        {
            "type": "0",
            "channel": 1,
            "value": "3"
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
type String 0表示移动侦测灵敏度
channel String 通道
value int type为0时,该值为0~6,0为灵敏度最低
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持移动侦测灵敏度配置

1.17. 设置移动侦测灵敏度

  • 接口功能

    该接口用于设置智能算法模式(目前只支持移动侦测灵敏度配置)

  • 请求地址

    https://open.ys7.com/api/lapp/device/algorithm/config/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 通道号,不传表示设备本身 N
type int 智能算法模式:0-移动侦测灵敏度。非必选,默认为0 N
value int type为0时,该值为0~6,0表示灵敏度最低 Y
  • HTTP请求报文
POST /api/lapp/device/algorithm/config/set HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&type=0&value=3
  • 返回数据
{
    "code": "200",
    "msg": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60020 不支持该命令 设备不支持移动侦测灵敏度配置

1.18. 设置告警声音模式

  • 接口功能

    该接口用于设置告警声音模式

  • 请求地址

    https://open.ys7.com/api/lapp/device/alarm/sound/set

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.19. 开启或关闭设备下线通知

  • 接口功能

    该接口用于开启或关闭设备下线通知

  • 请求地址

    https://open.ys7.com/api/lapp/device/notify/switch

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.20. 获取设备麦克风开关状态

  • 接口功能

    该接口用于获取设备麦克风开关状态

  • 请求地址

    https://open.ys7.com/api/lapp/camera/video/sound/status

  • 请求方式

    POST

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

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

  • 请求参数

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

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
  • 返回数据
{
  "data": [
      {
          "deviceSerial": "596510666",
          "channelNo": 1,
          "enable": "1"
      }
  ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 设备通道号
enable String 麦克风开关标识:0:关闭;1:打开
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常 检查设备网络状况,稍后再试
20007 设备不在线 检查设备是否在线
20008 设备响应超时 操作过于频繁,稍后再试
20014 deviceSerial不合法
20018 该用户不拥有该设备 检查设备是否属于当前账户
49999 数据异常 接口调用异常

1.21. 设置设备麦克风开关状态

  • 接口功能

    该接口用于设置麦克风开关状态

  • 请求地址

    https://open.ys7.com/api/lapp/camera/video/sound/set

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.22. 设置设备移动跟踪开关

  • 接口功能

    该接口用于设置设备移动跟踪开关

  • 请求地址

    https://open.ys7.com/api/lapp/device/mobile/status/set

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.23. 获取设备移动跟踪开关状态

  • 接口功能

    该接口用于设置设备移动跟踪开关状态

  • 请求地址

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

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.24. 设置设备的osd名称

  • 接口功能

    该接口用于设置设备osd名称(只用于支持osd设置的设备)

  • 请求地址

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

  • 请求方式

    POST

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

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

  • 请求参数

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

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

1.25. 获取设备智能检测开关状态

  • 接口功能

    该该接口用于获取设备智能检测开关状态(该接口仅用于智能设备,如C5SI,如需使用该接口,请联系萤石开放平台确认设备功能)

  • 请求地址

    https://open.ys7.com/api/lapp/device/intelligence/detection/switch/status

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
type String 智能检测开关类型 302-人形过滤,304人脸抠图, 不传则代表人形过滤 N

注:智能检测开关依赖于布撤防状态, 只有布撤防接口开启时,智能检测开关状态才会生效: 开启布撤防状态后,智能检测接口均为关闭状态时为移动侦测, 开启其中一个类型的智能检测开关如人形过滤, 那么就是人形过滤,所有开关状态互斥

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

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

1.26. 设置设备智能检测开关状态

  • 接口功能

    该该接口用于设置设备智能检测开关状态(该接口仅用于智能设备,如C5SI,如需使用该接口,请联系萤石开放平台确认设备功能)

  • 请求地址

    https://open.ys7.com/api/lapp/device/intelligence/detection/switch/set

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable String 状态: 0-关闭, 1-开启 Y
channelNo String 通道号,非必选参数,不传表示设备本身 N
type String 智能检测开关类型 302-人形过滤,304人脸抠图, 不传则代表人形过滤 N

注:智能检测开关依赖于布撤防状态, 只有布撤防接口开启时,智能检测开关状态才会生效: 开启布撤防状态后,智能检测接口均为关闭状态时为移动侦测, 开启其中一个类型的智能检测开关如人形过滤, 那么就是人形过滤,所有开关状态互斥

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

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

results matching ""

    No results matching ""