1. 视频API

API列表

编号	API名称	路径	版本
1.1	新增视频	/v1/iot/video/add	1.0
1.2	视频详情	/v1/iot/video/detail	1.0
1.3	修改视频	/v1/iot/video/update	1.0
1.4	删除视频	/v1/iot/video/remove	1.0
1.5	视频列表	/v1/iot/video/list	1.0
1.6	视频分页	/v1/iot/video/page	1.0
1.7	未关联设备列表	/v1/iot/video/unbind/device/page	1.0
1.8	绑定设备	/v1/iot/video/bind/devices	1.0
1.9	状态同步	/v1/iot/video/sync
2.0	导出列表	/v1/iot/video/export
2.1	导入列表	/v1/iot/video/import

API调用

1.1: 新增视频

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/add

方法：POST

请求参数

名称	位置	类型	必填	描述
isOnline	body	int	y	在线状态
templateId	body	string	y	模板id
templateName	body	string	y	模板名称
resolution	body	string	y	分辨率
cameraType	body	string	y	摄像头类型
mac	body	string	y	mac地址
typeCode	body	string	y	关联空间类型
spaceId	body	string	y	关联空间ID
groupName	body	string	y	分组名称
isPublicVideo	body	int	y	是否公区视频
name	body	string	y	视频名称
id	body	Int	y	视频id
topOrgCode	body	string	y	顶级业务组织ID

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.2: 视频详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/detail

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	int	y	主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	y	响应码标识
message	顶层	STRING	y	响应消息文本
data	顶层	JSONObject	y	响应数据对象
isOnline	body	int	y	在线状态
templateId	body	string	y	模板id
templateName	body	string	y	模板名称
resolution	body	string	y	分辨率
cameraType	body	string	y	摄像头类型
mac	body	string	y	mac地址
typeCode	body	string	y	关联空间类型
spaceName	body	string	y	空间名称
spaceId	body	string	y	关联空间ID
groupName	body	string	y	分组名称
isPublicVideo	body	int	y	是否公区视频
name	body	string	y	视频名称
topOrgCode	body	string	y	顶级业务组织ID
id	body	Int	y	视频id

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
       "name": ""
  }
}

1.3: 修改视频

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/update

方法：POST

请求参数

名称	位置	类型	必填	描述
isOnline	body	int	y	在线状态
templateId	body	string	y	模板id
templateName	body	string	y	模板名称
resolution	body	string	y	分辨率
cameraType	body	string	y	摄像头类型
mac	body	string	y	mac地址
typeCode	body	string	y	关联空间类型
spaceId	body	string	y	关联空间ID
groupName	body	string	y	分组名称
isPublicVideo	body	int	y	是否公区视频
name	body	string	y	视频名称
id	body	Int	y	视频id

请求Body描述(非Form表单数据)

{
    "id": 1,
    "name": "",
    "orderNo": "",
    "pid": 0
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 删除视频

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/remove

方法：POST

请求参数

名称	位置	类型	必填	描述
ids	body	array	y	主键id

请求Body描述(非Form表单数据)

{
    "ids": [1]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 视频列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/list

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目ID

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
records	data	Array	是	列表
isOnline	records	int	y	在线状态
templateId	records	string	y	模板id
templateName	records	string	y	模板名称
resolution	records	string	y	分辨率
cameraType	records	string	y	摄像头类型
mac	records	string	y	mac地址
typeCode	records	string	y	关联空间类型
spaceId	records	string	y	关联空间ID
groupName	records	string	y	分组名称
isPublicVideo	records	int	y	是否公区视频
name	records	string	y	视频名称
id	records	Int	y	视频id
createTime	records	string	y	创建时间
createBy	records	string	y	创建人
updateTime	records	string	y	更新时间
updateBy	records	string	y	更新人
templateName	records	string	y	模板名称
spaceName	records	string	y	空间名称
topOrgCode	body	string	y	顶级业务组织ID

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "",
            "orderNo": "",
            "pid": 0
        }
      ]
  }
}

1.6: 视频分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/page

方法：POST

请求参数

名称	位置	类型	必填	描述
pageSize	body	int	y	每页条数
pageNo	body	int	y	当前页数

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	y	响应码标识
message	顶层	STRING	y	响应消息文本
data	顶层	JSONObject	y	响应数据对象
total	data	int	y	总条数
records	data	Array	y	列表
isOnline	records	int	y	在线状态
templateId	records	string	y	模板id
templateName	records	string	y	模板名称
resolution	records	string	y	分辨率
cameraType	records	string	y	摄像头类型
mac	records	string	y	mac地址
typeCode	records	string	y	关联空间类型
spaceId	records	string	y	关联空间ID
groupName	records	string	y	分组名称
isPublicVideo	records	int	y	是否公区视频
name	records	string	y	视频名称
id	records	Int	y	视频id
createTime	records	string	y	创建时间
createBy	records	string	y	创建人
updateTime	records	string	y	更新时间
updateBy	records	string	y	更新人
templateName	records	string	y	模板名称
spaceName	records	string	y	空间名称
topOrgCode	body	string	y	顶级业务组织ID

返回结果示例

{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "isOnline": "1",
                "updateTime": null,
                "templateId": "3133",
                "resolution": "600x800",
                "cameraType": "人脸",
                "mac": "DSFSOIF23",
                "typeCode": "house",
                "deleteFlag": "0",
                "spaceId": 1234,
                "spaceName": "",
                "createBy": null,
                "groupName": "重点关注",
                "createTime": null,
                "updateBy": null,
                "isPublicVideo": "1",
                "name": "海康摄像头",
                "id": 1
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "请求成功!"
}

1.7: 选择设备列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/unbind/device/page

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目ID
pageNo	body	in	n	页码
pageSize	body	int	n	每页条数
mac	body	string	n	mac地址
deviceName	body	string	n	设备名称
deviceId	body	string	n	设备id
categoryPid	body	String	n	分类ID
categoryId	body	String	n	类型ID
idsIn	body	Array	n	设备ID集合
idsOut	body	Array	n	排除设备ID集合
online	Body	Int	n	在线状态

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.8: 绑定视频设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/bind/devices

方法：POST

请求参数

名称	位置	类型	必填	描述
deviceId	body	string	y	设备ID
projectId	body	string	y	项目ID
groupName	body	string	y	分组名
cameraType	body	string	y	设备类型
isPublicVideo	body	int	y	是否公区摄像头

请求Body描述(非Form表单数据)

{
    "projectId": 610,
    "devices": [
            {

                "deviceId": "57a97ac81554d2dc",
                "groupName": "重点设备",
                "cameraType": "人脸摄像头",
                "isPublicVideo": 1
            }
        ]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.9: 状态同步

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/sync

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目ID

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.0: 导出列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/export

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	string	y	项目ID
deviceIds	body	array	y	设备ID列表

请求Body描述(非Form表单数据)

{
  "deviceIds": [
    "1234",
    "5678"
  ]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.1: 导入列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/import

方法：POST

请求参数

名称	位置	类型	必填	描述
file	param	file	y	导入csv文件

请求描述(csv数据)

设备名称	MAC地址	视频名称	视频分组	摄像头类型	公区视频	视频分辨率	项目ID

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}