视频监控接口

1. 报警事件回调数据

接口说明：接口需接受post application/json请求，用于接收监控设备的报警事件回调信息。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret)，32小写

Body域

名称	类型	可空	描述
callbackType	String	N	VIDEO_EVENT_ALARM
data	对象	N
+deviceSerial	String	N	设备序列号
+deviceChannelNo	String		设备通道号
+deviceType	String	N	设备类型 0摄像头 1录像机 2中控网关
+deviceName	String	N	设备名称
+alarmType	String	N	告警类型，参考附录
+alarmId	String	N	告警id
+alarmPicUrl	String		告警图片
+alarmTime	String	N	告警时间

示例数据

{
  "callbackType": "VIDEO_EVENT_ALARM",
  "data": {
    "deviceSerial": "123456789012345",
    "deviceChannelNo": "1",
    "deviceType": "0",
    "deviceName": "南门摄像头",
    "alarmType": "motion_detection",
    "alarmId": "10001",
    "alarmPicUrl": "http://example.com/alarm.jpg",
    "alarmTime": "2024-05-20 15:30:22"
  }
}

2. 获取设备分组

接口地址：POST /open-api/video/group-list

接口说明：通过此接口获取监控设备的分组数据。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

Query参数

无

返回数据

名称	类型	描述
code	int	0成功 1失败
msg	string
result	Object	返回结果
+data	Object[]
++groupId	string	分组编号
++groupName	string	分组名称
++children	Object[]	下级分组

示例数据

{
  "code": 0,
  "msg": "操作成功",
  "result": {
    "data": [
      {
        "groupId": "1",
        "groupName": "1年级",
        "children": [
          {
            "groupId": "11",
            "groupName": "1年级1班"
          },
          {
            "groupId": "12",
            "groupName": "1年级2班"
          }
        ]
      }
    ]
  }
}

2.1 添加分组

接口地址：POST /open-api/video/group/add

接口说明：添加设备分组

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
groupName	String	N	-	分组名称

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	N	-	返回状态，成功：true,失败：false
data	Long	N	-	分组id

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

2.1 编辑分组

接口地址：POST /open-api/video/group/edit

接口说明：修改分组名称

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
groupId	Long	N	-	分组名id
groupName	String	N	-	分组名称

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	N	-	返回状态，成功：true,失败：false
data	String	N	-	分组id

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

2.3 删除分组

接口地址：POST /open-api/video/group/delete

接口说明：删除设备分组

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
groupId	Long	N	-	分组id

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	N	-	返回状态，成功：true,失败：false
data	String	N	-	分组id

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

3. 获取设备

接口地址：POST /open-api/video/device-list

接口说明：通过此接口获取监控设备数据。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

Query参数

名称	类型	可空	默认	描述
groupId	string	Y		分组编号

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++groupId	string		分组id
++deviceSerial	String	N	设备序列号
++channelNo	String	Y	设备通道号
++deviceType	String	N	设备类型 0摄像头 1录像机 2中控网关
+deviceName	String	N	设备名称
+brandType	String	N	品牌类型（海康/萤石/国标=“ysy"，大华/乐橙="lcy"）
+isManual	int	Y	接入方式（0=标准接入，1=国标接入）

示例数据

{
  "code": 0,
  "msg": "操作成功",
  "result": {
    "data": [
      {
        "groupId": "11",
        "deviceSerial": "987654321098765",
        "channelNo": "1",
        "deviceType": "0",
        "deviceName": "1年级1班摄像头",
        "brandType": "ysy",
        "isManual": 0
      }
    ]
  }
}

3.1 添加设备

接口地址：POST /open-api/video/device/add

接口说明：添加摄像头、录像机等设备

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
deviceSerial	String	N	-	设备序列号，九位
validateCode	String	N	-	设备验证码
deviceType	String	Y	"0"	设备类型 0摄像头 1录像机 2中控网关
deviceName	String	N	-	设备名称

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	-	-	返回状态，成功：true,失败：false

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

3.2 关闭加密

接口地址：POST /open-api/video/device/encrypt/off

接口说明：修改摄像头、录像机等设备

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
deviceSerial	String	N	-	设备序列号，九位
validateCode	String	Y	-	设备验证码
deviceType	String	Y	"0"	设备类型 0摄像头 1录像机 2中控网关

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	-	-	返回状态，成功：true,失败：false

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

3.3 删除设备

接口地址：POST /open-api/video/device/delete

接口说明：删除摄像头、录像机等设备，删除录像机，底下的摄像头也会删除

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
deviceSerial	String	N	-	设备序列号，九位
deviceType	String	Y	"0"	设备类型 0摄像头 1录像机 2中控网关

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	-	-	返回状态，成功：true,失败：false

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "data": 2584232114542,
  "success": true
}

4. 获取设备预览地址

接口地址：POST /open-api/video/getHls

接口说明：通过此接口获取监控设备的预览地址。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

Query参数

名称	类型	可空	默认	描述
deviceSerial	string	N		设备序列号
channelNo	int	N		通道号
brandType	string	Y	"ysy"	品牌类型（海康/萤石/国标=“ysy"，大华/乐橙="lcy"）
isManual	int	Y	0	接入方式（0=标准接入，1=国标接入）

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++hls_hd	string		播放地址(主码流)
++hls	string		播放地址(子码流)

示例数据

{
  "code": 0,
  "msg": "操作成功",
  "result": {
    "data": [
      {
        "hls_hd": "https://open.ys7.com/v3/openlive/deviceSerial_1_1.m3u8?expire=1725071223&id=619478666&t=76f0a99e1e1bfece2f776ef1cfde9f0841f7a92b9&ev=100",
        "hls": "https://open.ys7.com/v3/openlive/deviceSerial_1_2.m3u8?expire=1725071223&id=619478667&t=87f1b00f2f2cffdf3f887ff2d0e0fa09520f8b3c0&ev=100"
      }
    ]
  }
}

4. 注册报警事件回调

接口地址：POST /open-api/video/alert/register

接口说明：摄像头、录像机等设备报警信息的注册

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

body域

名称	类型	可空	默认	描述
enable	String	N	1	注册状态，0：关闭，1：开启
callBackUrl	String	Y	-	回调地址

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	-	-	返回状态，成功：true,失败：false

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "success": true
}

5. 报警事件回调数据

接口说明：接口需接受post application/json请求，摄像头、录像机等设备报警信息的报警回调

请求数据

header域

名称	类型	可空	默认	描述
token	String	N	-	调用获取accesstToken获取（有效期24h）
Content-Type	String	N	application/json	指定请求的媒体类型

Body域

返回数据

名称	类型	可空	默认	描述
code	Integer	N	-	状态码，参考附录状态码
msg	String	N	-	备注，一般为错误原因
success	boolean	-	-	返回状态，成功：true,失败：false
data	json	-	-	报警信息
-header	-	-	-	-
--type	String	-	-	-
--deviceId	String	-	-	-
--channelNo	String	-	-	-
--messageId	String	-	-	-
-body	-	-	-	-
---devSerial	String	-	-	设备序列号
---channel	Integer	-	-	设备通道号
---channelType	Integer	-	-	设备通道类型: 1-视频通道信息; 2-IO通道
---alarmType	String	-	-	告警类型, 见附录:设备告警消息类型
---alarmId	String	-	-	设备自己生成的UUID, 用来标识唯一的告警,统一告警的开始、结束采用统一alarmId
---relationId	String	-	-	告警关联ID，由发起联动方产生，用来表示联动的关联关系
---status	Integer	-	-	告警状态 1-开始
---location	String	-	-	告警位置信息：长度不能超过80字节
---describe	String	-	-	告警描述，需要推送给客户的信息
---alarmTime	String	-	-	告警时间，格式： yyyy-MM-ddTHH:mm:ss
---customType	String	-	-	自定义协议类型，命名规则：设备型号_协议标识如：CS-A1-32W_XX
---crypt	Integer	-	-	图片加密类型：0-不加密，1-用户加密，2-平台加密
---requestTime	Long	-	-	服务端记录的请求时间
---pictureList	-	-	-	-
----shortUrl	String	-	-	告警图片短地址
----id	String	-	-	平台生成的告警Id
----url	String	-	-	告警图片URL
-subSerial	String	-	-	设备序列号
-occurTime	String	-	-	设备上线（离线）时间，格式： yyyy-MM-dd HH:mm:ss
-regTime	String	-	-	设备上一次注册时间，格式： yyyy-MM-dd HH:mm:ss
-natIp	String	-	-	设备外网IP
-devType	String	-	-	设备类型
-deviceName	String	-	-	设备名称
-msgType	String	-	-	消息类型：OFFLINE-设备离线消息，ONLINE-设备上线消息

示例数据

{
  "code": 1,
  "msg": "操作成功",
  "success": true,
"data":[
    {
        "header":{
            "messageTime":1639567589137,
            "channelNo":37,
            "messageId":"61b9d0e59883f662cf2e07d1",
            "type":"ys.alarm",
            "deviceId":"F02340166"
        },
        "body":{
            "crypt":0,
            "alarmTime":"2021-12-15T19:26:28",
            "channel":37,
            "channelType":1,
            "relationId":"",
            "customInfo":"",
            "requestTime":1639567589137,
            "devSerial":"F02340166",
            "alarmType":"motiondetect",
            "customType":"",
            "alarmId":"20211215192627-F02340166-37-10002",
            "checksum":"",
            "channelName":"视频37@DS-8864N-R8(F02340166)",
            "location":"",
            "describe":"motiondetect",
            "pictureList":[
                {
                    "id":"20211215192627-F02340166-37-10002-2-1",
                    "url":"https://i.ys7.com/streamer/alarm/url/get?fileId=20211215192627-F02340166-37-10002-2-1&deviceSerialNo=F02340166&cn=37&isEncrypted=0&isCloudStored=0&ct=30&lc=7&bn=30_hikalarm-txsh-1256683041&isDevVideo=0"
                }
            ],
            "status":1
        }
    }
] 

}

1. 报警事件回调数据#

#

2. 获取设备分组#

2.1 添加分组#

2.1 编辑分组#

2.3 删除分组#

3. 获取设备#

3.1 添加设备#

3.2 关闭加密#

3.3 删除设备#

4. 获取设备预览地址#

4. 注册报警事件回调#

5. 报警事件回调数据#

1. 报警事件回调数据

2. 获取设备分组

2.1 添加分组

2.1 编辑分组

2.3 删除分组

3. 获取设备

3.1 添加设备

3.2 关闭加密

3.3 删除设备

4. 获取设备预览地址

4. 注册报警事件回调

5. 报警事件回调数据