接口列表

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

接口列表如下：

设备布撤防

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

关闭设备视频加密

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

开启设备视频加密

• 接口功能

  开启设备视频加密开关

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

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

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置wifi配置提示音开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取镜头遮蔽开关状态

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置镜头遮蔽开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取声源定位开关状态

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

  无

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置声源定位开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

  无

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取设备布撤防时间计划

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置布撤防时间计划

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

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

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置摄像机指示灯开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取全天录像开关状态

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置全天录像开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取移动侦测灵敏度配置

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置移动侦测灵敏度

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

设置告警声音模式

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

开启或关闭设备下线通知

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

获取设备麦克风开关状态

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回字段

• 返回码

设置设备麦克风开关状态

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

设置设备移动跟踪开关

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

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

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

设置设备的osd名称

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

• 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": "操作成功!"
}

• 返回码

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

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

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

• 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": "操作成功!"
}

• 返回码

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

• 接口功能

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

• 请求地址

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

• 请求方式

  POST

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

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

• 请求参数

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

• 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": "操作成功!"
}

• 返回码