1.项目说明

标题:WVP-PRO 接口文档
简介:WVP-PRO 接口文档
作者:pan
HOST:http://localhost:18080
basePath:/
termsOfService:
联系人:pan
Version:v2.0
GroupName:1. 全部
分组Url:/v3/api-docs/1. 全部
分组Location:/v3/api-docs/1. 全部

2.接口列表

2.1国标设备查询

2.1.1修改数据流传输模式

接口地址
POST  /api/device/query/transport/{deviceId}/{streamMode}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
streamMode 数据流传输模式, 取值：UDP（udp传输），TCP-ACTIVE（tcp主动模式,暂不支持），TCP-PASSIVE（tcp被动模式） path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.2同步设备通道

接口地址
POST  /api/device/query/devices/{deviceId}/sync
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK WVPResultSyncStatus
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data SyncStatus SyncStatus
 total 总数 integer(int32)
 current 当前更新多少 integer(int32)
 errorMsg 错误描述 string
 syncIng 是否同步中 boolean
响应示例
{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"current": 0,
		"errorMsg": "",
		"syncIng": true
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.3更新设备信息

接口地址
POST  /api/device/query/device/update/
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
device 国标设备/平台 query true Device Device
 deviceId 设备国标编号 false string
 name 名称 false string
 manufacturer 生产厂商 false string
 model 型号 false string
 firmware 固件版本 false string
 transport 传输协议（UDP/TCP） false string
 streamMode 数据流传输模式 false string
 ip IP false string
 port 端口 false integer(int32)
 hostAddress wan地址 false string
 online 是否在线，1为在线，0为离线 false integer(int32)
 registerTime 注册时间 false string
 keepaliveTime 心跳时间 false string
 channelCount 通道个数 false integer(int32)
 expires 注册有效期 false integer(int32)
 createTime 创建时间 false string
 updateTime 更新时间 false string
 mediaServerId 设备使用的媒体id, 默认为null false string
 charset 符集, 支持 UTF-8 与 GB2312 false string
 subscribeCycleForCatalog 目录订阅周期，0为不订阅 false integer(int32)
 subscribeCycleForMobilePosition 移动设备位置订阅周期，0为不订阅 false integer(int32)
 mobilePositionSubmissionInterval 移动设备位置信息上报时间间隔,单位:秒,默认值5 false integer(int32)
 subscribeCycleForAlarm 报警心跳时间订阅周期，0为不订阅 false integer(int32)
 ssrcCheck 是否开启ssrc校验，默认关闭，开启可以防止串流 false boolean
 geoCoordSys 地理坐标系， 目前支持 WGS84,GCJ02 false string
 treeType 树类型 国标规定了两种树的展现方式 行政区划：CivilCode 和业务分组:BusinessGroup false string
响应状态

状态码说明schema
200 OK WVPResultString
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.4更新通道信息

接口地址
POST  /api/device/query/channel/update/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channel 通道信息 query true DeviceChannel DeviceChannel
 id 数据库自增ID false integer(int32)
 channelId 通道国标编号 false string
 deviceId 设备国标编号 false string
 name 名称 false string
 manufacture 生产厂商 false string
 model 型号 false string
 owner 设备归属 false string
 civilCode 行政区域 false string
 block 警区 false string
 address 安装地址 false string
 parental 是否有子设备 1有, 0没有 false integer(int32)
 parentId 父级id false string
 safetyWay 信令安全模式 缺省为0; 0:不采用; 2: S/MIME签名方式; 3: S/ MIME加密签名同时采用方式; 4:数字摘要方式 false integer(int32)
 registerWay 注册方式 缺省为1;1:符合IETFRFC3261标准的认证注册模 式; 2:基于口令的双向认证注册模式; 3:基于数字证书的双向认证注册模式 false integer(int32)
 certNum 证书序列号 false string
 certifiable 证书有效标识 缺省为0;证书有效标识:0:无效1: 有效 false integer(int32)
 errCode 证书无效原因码 false integer(int32)
 endTime 证书终止有效期 false string
 secrecy 保密属性 缺省为0; 0:不涉密, 1:涉密 false string
 ipAddress IP地址 false string
 port 端口号 false integer(int32)
 password 密码 false string
 createTime 创建时间 false string
 updateTime 更新时间 false string
 status 在线/离线， 1在线,0离线 false integer(int32)
 longitude 经度 false number(double)
 latitude 纬度 false number(double)
 longitudeGcj02 GCJ02坐标系经度 false number(double)
 latitudeGcj02 GCJ02坐标系纬度 false number(double)
 longitudeWgs84 WGS84坐标系经度 false number(double)
 latitudeWgs84 WGS84坐标系纬度 false number(double)
 subCount 子设备数 false integer(int32)
 streamId 流唯一编号，存在表示正在直播 false string
 hasAudio 是否含有音频 false boolean
 channelType 标记通道的类型，0->国标通道 1->直播流通道 2->业务分组/虚拟组织/行政区划 false integer(int32)
 businessGroupId 业务分组 false string
 gpsTime GPS的更新时间 false string
 ptztype false integer(int32)
 ptztypeText false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.5获取通道同步进度

接口地址
GET  /api/device/query/{deviceId}/sync_status
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK WVPResultSyncStatus
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data SyncStatus SyncStatus
 total 总数 integer(int32)
 current 当前更新多少 integer(int32)
 errorMsg 错误描述 string
 syncIng 是否同步中 boolean
响应示例
{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"current": 0,
		"errorMsg": "",
		"syncIng": true
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.6获取设备的订阅状态

接口地址
GET  /api/device/query/{deviceId}/subscribe_info
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK WVPResultMapStringString
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 object
响应示例
{
	"code": 0,
	"msg": "",
	"data": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.7查询国标树

接口地址
GET  /api/device/query/tree/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
page 当前页 query true integer(int32)
count 每页条数 query true integer(int32)
parentId 父级国标编号 query false string
onlyCatalog 只获取目录 query false boolean
响应状态

状态码说明schema
200 OK PageInfoObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.8查询国标树下的通道

接口地址
GET  /api/device/query/tree/channel/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
page 当前页 query true integer(int32)
count 每页条数 query true integer(int32)
parentId 父级国标编号 query false string
响应状态

状态码说明schema
200 OK PageInfoObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.9分页查询子目录通道

接口地址
GET  /api/device/query/sub_channels/{deviceId}/{channelId}/channels
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
query 查询内容 query false string
online 是否在线 query false boolean
channelType 设备/子目录-> false/true query false boolean
响应状态

状态码说明schema
200 OK PageInfoObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.10请求截图

接口地址
GET  /api/device/query/snap/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.11分页查询国标设备

接口地址
GET  /api/device/query/devices
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
响应状态

状态码说明schema
200 OK PageInfoDevice
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array Device
 deviceId 设备国标编号 string
 name 名称 string
 manufacturer 生产厂商 string
 model 型号 string
 firmware 固件版本 string
 transport 传输协议（UDP/TCP） string
 streamMode 数据流传输模式 string
 ip IP string
 port 端口 integer(int32)
 hostAddress wan地址 string
 online 是否在线，1为在线，0为离线 integer(int32)
 registerTime 注册时间 string
 keepaliveTime 心跳时间 string
 channelCount 通道个数 integer(int32)
 expires 注册有效期 integer(int32)
 createTime 创建时间 string
 updateTime 更新时间 string
 mediaServerId 设备使用的媒体id, 默认为null string
 charset 符集, 支持 UTF-8 与 GB2312 string
 subscribeCycleForCatalog 目录订阅周期，0为不订阅 integer(int32)
 subscribeCycleForMobilePosition 移动设备位置订阅周期，0为不订阅 integer(int32)
 mobilePositionSubmissionInterval 移动设备位置信息上报时间间隔,单位:秒,默认值5 integer(int32)
 subscribeCycleForAlarm 报警心跳时间订阅周期，0为不订阅 integer(int32)
 ssrcCheck 是否开启ssrc校验，默认关闭，开启可以防止串流 boolean
 geoCoordSys 地理坐标系， 目前支持 WGS84,GCJ02 string
 treeType 树类型 国标规定了两种树的展现方式 行政区划：CivilCode 和业务分组:BusinessGroup string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"deviceId": "",
			"name": "",
			"manufacturer": "",
			"model": "",
			"firmware": "",
			"transport": "",
			"streamMode": "",
			"ip": "",
			"port": 0,
			"hostAddress": "",
			"online": 0,
			"registerTime": "",
			"keepaliveTime": "",
			"channelCount": 0,
			"expires": 0,
			"createTime": "",
			"updateTime": "",
			"mediaServerId": "",
			"charset": "",
			"subscribeCycleForCatalog": 0,
			"subscribeCycleForMobilePosition": 0,
			"mobilePositionSubmissionInterval": 0,
			"subscribeCycleForAlarm": 0,
			"ssrcCheck": true,
			"geoCoordSys": "",
			"treeType": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.12查询国标设备

接口地址
GET  /api/device/query/devices/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK Device
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
deviceId 设备国标编号 string
name 名称 string
manufacturer 生产厂商 string
model 型号 string
firmware 固件版本 string
transport 传输协议（UDP/TCP） string
streamMode 数据流传输模式 string
ip IP string
port 端口 integer(int32) integer(int32)
hostAddress wan地址 string
online 是否在线，1为在线，0为离线 integer(int32) integer(int32)
registerTime 注册时间 string
keepaliveTime 心跳时间 string
channelCount 通道个数 integer(int32) integer(int32)
expires 注册有效期 integer(int32) integer(int32)
createTime 创建时间 string
updateTime 更新时间 string
mediaServerId 设备使用的媒体id, 默认为null string
charset 符集, 支持 UTF-8 与 GB2312 string
subscribeCycleForCatalog 目录订阅周期，0为不订阅 integer(int32) integer(int32)
subscribeCycleForMobilePosition 移动设备位置订阅周期，0为不订阅 integer(int32) integer(int32)
mobilePositionSubmissionInterval 移动设备位置信息上报时间间隔,单位:秒,默认值5 integer(int32) integer(int32)
subscribeCycleForAlarm 报警心跳时间订阅周期，0为不订阅 integer(int32) integer(int32)
ssrcCheck 是否开启ssrc校验，默认关闭，开启可以防止串流 boolean
geoCoordSys 地理坐标系， 目前支持 WGS84,GCJ02 string
treeType 树类型 国标规定了两种树的展现方式 行政区划：CivilCode 和业务分组:BusinessGroup string
响应示例
{
	"deviceId": "",
	"name": "",
	"manufacturer": "",
	"model": "",
	"firmware": "",
	"transport": "",
	"streamMode": "",
	"ip": "",
	"port": 0,
	"hostAddress": "",
	"online": 0,
	"registerTime": "",
	"keepaliveTime": "",
	"channelCount": 0,
	"expires": 0,
	"createTime": "",
	"updateTime": "",
	"mediaServerId": "",
	"charset": "",
	"subscribeCycleForCatalog": 0,
	"subscribeCycleForMobilePosition": 0,
	"mobilePositionSubmissionInterval": 0,
	"subscribeCycleForAlarm": 0,
	"ssrcCheck": true,
	"geoCoordSys": "",
	"treeType": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.13设备状态查询

接口地址
GET  /api/device/query/devices/{deviceId}/status
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.14分页查询通道

接口地址
GET  /api/device/query/devices/{deviceId}/channels
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
query 查询内容 query false string
online 是否在线 query false boolean
channelType 设备/子目录-> false/true query false boolean
catalogUnderDevice 是否直属与设备的目录 query false boolean
响应状态

状态码说明schema
200 OK PageInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.15设备状态查询

接口地址
GET  /api/device/query/alarm/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
startPriority 报警起始级别 query false string
endPriority 报警终止级别 query false string
alarmMethod 报警方式条件 query false string
alarmType 报警类型 query false string
startTime 报警发生起始时间 query false string
endTime 报警发生终止时间 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.1.16移除设备

接口地址
DELETE  /api/device/query/devices/{deviceId}/delete
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2用户管理

2.2.1修改密码

接口地址
POST  /api/user/changePassword
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
oldPassword query true string
password 新密码（未md5加密的密码） query true string
username 用户名 true
oldpassword 旧密码（已md5加密的密码） true
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.2管理员修改普通用户密码

接口地址
POST  /api/user/changePasswordForAdmin
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户id query true integer(int32)
password 新密码（未md5加密的密码） query true string
adminId 管理员id true
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.3停止视频回放

接口地址
POST  /api/user/add
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
username 用户名 query true string
password 密码（未md5加密的密码） query true string
roleId 角色ID query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.4分页查询用户

接口地址
GET  /api/user/users
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
响应状态

状态码说明schema
200 OK PageInfoUser
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array User
 id integer(int32)
 username string
 password string
 createTime string
 updateTime string
 pushKey string
 role Role Role
  id integer
  name string
  authority string
  createTime string
  updateTime string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"id": 0,
			"username": "",
			"password": "",
			"createTime": "",
			"updateTime": "",
			"pushKey": "",
			"role": {
				"id": 0,
				"name": "",
				"authority": "",
				"createTime": "",
				"updateTime": ""
			}
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.5登录

接口地址
GET  /api/user/login
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
username 用户名 query true string
password 密码（32位md5加密） query true string
响应状态

状态码说明schema
200 OK LoginUser
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id integer(int32) integer(int32)
enabled boolean
role Role Role
 id integer(int32)
 name string
 authority string
 createTime string
 updateTime string
password string
authorities array GrantedAuthority
 authority string
username string
credentialsNonExpired boolean
accountNonLocked boolean
accountNonExpired boolean
响应示例
{
	"id": 0,
	"enabled": true,
	"role": {
		"id": 0,
		"name": "",
		"authority": "",
		"createTime": "",
		"updateTime": ""
	},
	"password": "",
	"authorities": [
		{
			"authority": ""
		}
	],
	"username": "",
	"credentialsNonExpired": true,
	"accountNonLocked": true,
	"accountNonExpired": true
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.6查询用户

接口地址
GET  /api/user/all
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK User
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id integer(int32) integer(int32)
username string
password string
createTime string
updateTime string
pushKey string
role Role Role
 id integer(int32)
 name string
 authority string
 createTime string
 updateTime string
响应示例
[
	{
		"id": 0,
		"username": "",
		"password": "",
		"createTime": "",
		"updateTime": "",
		"pushKey": "",
		"role": {
			"id": 0,
			"name": "",
			"authority": "",
			"createTime": "",
			"updateTime": ""
		}
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.2.7停止视频回放

接口地址
DELETE  /api/user/删除用户
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 用户Id query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.8修改pushkey

接口地址
GET  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.9修改pushkey

接口地址
POST  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.10修改pushkey

接口地址
PUT  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.11修改pushkey

接口地址
DELETE  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.12修改pushkey

接口地址
PATCH  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.13修改pushkey

接口地址
OPTIONS  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.2.14修改pushkey

接口地址
HEAD  /api/user/changePushKey
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
userId 用户Id query true integer(int32)
pushKey 新的pushKey query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3服务控制

2.3.1保存流媒体服务

接口地址
POST  /api/server/media_server/save
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
mediaServerItem 流媒体信息 true
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.2获取版本信息

接口地址
GET  /api/server/version
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK VersionPo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
artifactId string
version string
project string
git_Revision_SHORT string
git_BRANCH string
build_DATE string
create_By string
build_Jdk string
git_Revision string
git_URL string
响应示例
{
	"artifactId": "",
	"version": "",
	"project": "",
	"git_Revision_SHORT": "",
	"git_BRANCH": "",
	"build_DATE": "",
	"create_By": "",
	"build_Jdk": "",
	"git_Revision": "",
	"git_URL": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.3重启服务

接口地址
GET  /api/server/restart
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.4测试流媒体录像管理服务

接口地址
GET  /api/server/media_server/record/check
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
ip 流媒体服务IP query true string
port 流媒体服务HTT端口 query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.5在线流媒体服务列表

接口地址
GET  /api/server/media_server/online/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK MediaServerItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID string
ip IP string
hookIp hook使用的IP（zlm访问WVP使用的IP） string
sdpIp SDP IP string
streamIp 流IP string
httpPort HTTP端口 integer(int32) integer(int32)
httpSSlPort HTTPS端口 integer(int32) integer(int32)
rtmpPort RTMP端口 integer(int32) integer(int32)
rtmpSSlPort RTMPS端口 integer(int32) integer(int32)
rtpProxyPort RTP收流端口（单端口模式有用） integer(int32) integer(int32)
rtspPort RTSP端口 integer(int32) integer(int32)
rtspSSLPort RTSPS端口 integer(int32) integer(int32)
autoConfig 是否开启自动配置ZLM boolean
secret ZLM鉴权参数 string
streamNoneReaderDelayMS 某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒 integer(int32) integer(int32)
hookAliveInterval keepalive hook触发间隔,单位秒 integer(int32) integer(int32)
rtpEnable 是否使用多端口模式 boolean
status 状态 boolean
rtpPortRange 多端口RTP收流端口范围 string
sendRtpPortRange RTP发流端口范围 string
recordAssistPort assist服务端口 integer(int32) integer(int32)
createTime 创建时间 string
updateTime 更新时间 string
lastKeepaliveTime 上次心跳时间 string
defaultServer 是否是默认ZLM boolean
ssrcConfig SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
currentPort 当前使用到的端口 integer(int32) integer(int32)
mediaServerSsrcMap ID SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
响应示例
[
	{
		"id": "",
		"ip": "",
		"hookIp": "",
		"sdpIp": "",
		"streamIp": "",
		"httpPort": 0,
		"httpSSlPort": 0,
		"rtmpPort": 0,
		"rtmpSSlPort": 0,
		"rtpProxyPort": 0,
		"rtspPort": 0,
		"rtspSSLPort": 0,
		"autoConfig": true,
		"secret": "",
		"streamNoneReaderDelayMS": 0,
		"hookAliveInterval": 0,
		"rtpEnable": true,
		"status": true,
		"rtpPortRange": "",
		"sendRtpPortRange": "",
		"recordAssistPort": 0,
		"createTime": "",
		"updateTime": "",
		"lastKeepaliveTime": "",
		"defaultServer": true,
		"ssrcConfig": {
			"mediaServerId": "",
			"ssrcPrefix": "",
			"isUsed": [],
			"notUsed": [],
			"playSsrc": "",
			"playBackSsrc": ""
		},
		"currentPort": 0,
		"mediaServerSsrcMap": {
			"additionalProperties1": {
				"mediaServerId": "",
				"ssrcPrefix": "",
				"isUsed": [],
				"notUsed": [],
				"playSsrc": "",
				"playBackSsrc": ""
			}
		}
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.3.6停止视频回放

接口地址
GET  /api/server/media_server/one/{id}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 流媒体服务ID path true string
响应状态

状态码说明schema
200 OK MediaServerItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID string
ip IP string
hookIp hook使用的IP（zlm访问WVP使用的IP） string
sdpIp SDP IP string
streamIp 流IP string
httpPort HTTP端口 integer(int32) integer(int32)
httpSSlPort HTTPS端口 integer(int32) integer(int32)
rtmpPort RTMP端口 integer(int32) integer(int32)
rtmpSSlPort RTMPS端口 integer(int32) integer(int32)
rtpProxyPort RTP收流端口（单端口模式有用） integer(int32) integer(int32)
rtspPort RTSP端口 integer(int32) integer(int32)
rtspSSLPort RTSPS端口 integer(int32) integer(int32)
autoConfig 是否开启自动配置ZLM boolean
secret ZLM鉴权参数 string
streamNoneReaderDelayMS 某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒 integer(int32) integer(int32)
hookAliveInterval keepalive hook触发间隔,单位秒 integer(int32) integer(int32)
rtpEnable 是否使用多端口模式 boolean
status 状态 boolean
rtpPortRange 多端口RTP收流端口范围 string
sendRtpPortRange RTP发流端口范围 string
recordAssistPort assist服务端口 integer(int32) integer(int32)
createTime 创建时间 string
updateTime 更新时间 string
lastKeepaliveTime 上次心跳时间 string
defaultServer 是否是默认ZLM boolean
ssrcConfig SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
currentPort 当前使用到的端口 integer(int32) integer(int32)
mediaServerSsrcMap ID SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
响应示例
{
	"id": "",
	"ip": "",
	"hookIp": "",
	"sdpIp": "",
	"streamIp": "",
	"httpPort": 0,
	"httpSSlPort": 0,
	"rtmpPort": 0,
	"rtmpSSlPort": 0,
	"rtpProxyPort": 0,
	"rtspPort": 0,
	"rtspSSLPort": 0,
	"autoConfig": true,
	"secret": "",
	"streamNoneReaderDelayMS": 0,
	"hookAliveInterval": 0,
	"rtpEnable": true,
	"status": true,
	"rtpPortRange": "",
	"sendRtpPortRange": "",
	"recordAssistPort": 0,
	"createTime": "",
	"updateTime": "",
	"lastKeepaliveTime": "",
	"defaultServer": true,
	"ssrcConfig": {
		"mediaServerId": "",
		"ssrcPrefix": "",
		"isUsed": [],
		"notUsed": [],
		"playSsrc": "",
		"playBackSsrc": ""
	},
	"currentPort": 0,
	"mediaServerSsrcMap": {
		"additionalProperties1": {
			"mediaServerId": "",
			"ssrcPrefix": "",
			"isUsed": [],
			"notUsed": [],
			"playSsrc": "",
			"playBackSsrc": ""
		}
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.7流媒体服务列表

接口地址
GET  /api/server/media_server/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK MediaServerItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID string
ip IP string
hookIp hook使用的IP（zlm访问WVP使用的IP） string
sdpIp SDP IP string
streamIp 流IP string
httpPort HTTP端口 integer(int32) integer(int32)
httpSSlPort HTTPS端口 integer(int32) integer(int32)
rtmpPort RTMP端口 integer(int32) integer(int32)
rtmpSSlPort RTMPS端口 integer(int32) integer(int32)
rtpProxyPort RTP收流端口（单端口模式有用） integer(int32) integer(int32)
rtspPort RTSP端口 integer(int32) integer(int32)
rtspSSLPort RTSPS端口 integer(int32) integer(int32)
autoConfig 是否开启自动配置ZLM boolean
secret ZLM鉴权参数 string
streamNoneReaderDelayMS 某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒 integer(int32) integer(int32)
hookAliveInterval keepalive hook触发间隔,单位秒 integer(int32) integer(int32)
rtpEnable 是否使用多端口模式 boolean
status 状态 boolean
rtpPortRange 多端口RTP收流端口范围 string
sendRtpPortRange RTP发流端口范围 string
recordAssistPort assist服务端口 integer(int32) integer(int32)
createTime 创建时间 string
updateTime 更新时间 string
lastKeepaliveTime 上次心跳时间 string
defaultServer 是否是默认ZLM boolean
ssrcConfig SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
currentPort 当前使用到的端口 integer(int32) integer(int32)
mediaServerSsrcMap ID SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
响应示例
[
	{
		"id": "",
		"ip": "",
		"hookIp": "",
		"sdpIp": "",
		"streamIp": "",
		"httpPort": 0,
		"httpSSlPort": 0,
		"rtmpPort": 0,
		"rtmpSSlPort": 0,
		"rtpProxyPort": 0,
		"rtspPort": 0,
		"rtspSSLPort": 0,
		"autoConfig": true,
		"secret": "",
		"streamNoneReaderDelayMS": 0,
		"hookAliveInterval": 0,
		"rtpEnable": true,
		"status": true,
		"rtpPortRange": "",
		"sendRtpPortRange": "",
		"recordAssistPort": 0,
		"createTime": "",
		"updateTime": "",
		"lastKeepaliveTime": "",
		"defaultServer": true,
		"ssrcConfig": {
			"mediaServerId": "",
			"ssrcPrefix": "",
			"isUsed": [],
			"notUsed": [],
			"playSsrc": "",
			"playBackSsrc": ""
		},
		"currentPort": 0,
		"mediaServerSsrcMap": {
			"additionalProperties1": {
				"mediaServerId": "",
				"ssrcPrefix": "",
				"isUsed": [],
				"notUsed": [],
				"playSsrc": "",
				"playBackSsrc": ""
			}
		}
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.3.8测试流媒体服务

接口地址
GET  /api/server/media_server/check
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
ip 流媒体服务IP query true string
port 流媒体服务HTT端口 query true integer(int32)
secret 流媒体服务secret query true string
响应状态

状态码说明schema
200 OK MediaServerItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID string
ip IP string
hookIp hook使用的IP（zlm访问WVP使用的IP） string
sdpIp SDP IP string
streamIp 流IP string
httpPort HTTP端口 integer(int32) integer(int32)
httpSSlPort HTTPS端口 integer(int32) integer(int32)
rtmpPort RTMP端口 integer(int32) integer(int32)
rtmpSSlPort RTMPS端口 integer(int32) integer(int32)
rtpProxyPort RTP收流端口（单端口模式有用） integer(int32) integer(int32)
rtspPort RTSP端口 integer(int32) integer(int32)
rtspSSLPort RTSPS端口 integer(int32) integer(int32)
autoConfig 是否开启自动配置ZLM boolean
secret ZLM鉴权参数 string
streamNoneReaderDelayMS 某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒 integer(int32) integer(int32)
hookAliveInterval keepalive hook触发间隔,单位秒 integer(int32) integer(int32)
rtpEnable 是否使用多端口模式 boolean
status 状态 boolean
rtpPortRange 多端口RTP收流端口范围 string
sendRtpPortRange RTP发流端口范围 string
recordAssistPort assist服务端口 integer(int32) integer(int32)
createTime 创建时间 string
updateTime 更新时间 string
lastKeepaliveTime 上次心跳时间 string
defaultServer 是否是默认ZLM boolean
ssrcConfig SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
currentPort 当前使用到的端口 integer(int32) integer(int32)
mediaServerSsrcMap ID SsrcConfig SsrcConfig
 mediaServerId 流媒体服务器Id string
 ssrcPrefix SSRC前缀 string
 isUsed zlm流媒体服务器已用会话句柄 array string
 notUsed zlm流媒体服务器可用会话句柄 array string
 playSsrc string
 playBackSsrc string
响应示例
{
	"id": "",
	"ip": "",
	"hookIp": "",
	"sdpIp": "",
	"streamIp": "",
	"httpPort": 0,
	"httpSSlPort": 0,
	"rtmpPort": 0,
	"rtmpSSlPort": 0,
	"rtpProxyPort": 0,
	"rtspPort": 0,
	"rtspSSLPort": 0,
	"autoConfig": true,
	"secret": "",
	"streamNoneReaderDelayMS": 0,
	"hookAliveInterval": 0,
	"rtpEnable": true,
	"status": true,
	"rtpPortRange": "",
	"sendRtpPortRange": "",
	"recordAssistPort": 0,
	"createTime": "",
	"updateTime": "",
	"lastKeepaliveTime": "",
	"defaultServer": true,
	"ssrcConfig": {
		"mediaServerId": "",
		"ssrcPrefix": "",
		"isUsed": [],
		"notUsed": [],
		"playSsrc": "",
		"playBackSsrc": ""
	},
	"currentPort": 0,
	"mediaServerSsrcMap": {
		"additionalProperties1": {
			"mediaServerId": "",
			"ssrcPrefix": "",
			"isUsed": [],
			"notUsed": [],
			"playSsrc": "",
			"playBackSsrc": ""
		}
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.9获取当前所有hook

接口地址
GET  /api/server/hooks
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK IHookSubscribe
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
content object
expires string(date-time) string(date-time)
hookType 可用值:on_flow_report,on_http_access,on_play,on_publish,on_record_mp4,on_rtsp_auth,on_rtsp_realm,on_shell_login,on_stream_changed,on_stream_none_reader,on_stream_not_found,on_server_started,on_server_keepalive string
响应示例
[
	{
		"content": {},
		"expires": "",
		"hookType": ""
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.3.10获取配置信息

接口地址
GET  /api/server/config
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
type 配置类型（sip, base） query true string
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.3.11移除流媒体服务

接口地址
DELETE  /api/server/media_server/delete
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 流媒体ID query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.4角色管理

2.4.1添加角色

接口地址
POST  /api/role/add
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
name 角色名 query true string
authority 权限（自行定义内容，目前未使用） query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.4.2查询角色

接口地址
GET  /api/role/all
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK Role
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id integer(int32) integer(int32)
name string
authority string
createTime string
updateTime string
响应示例
[
	{
		"id": 0,
		"name": "",
		"authority": "",
		"createTime": "",
		"updateTime": ""
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.4.3删除角色

接口地址
DELETE  /api/role/delete
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 用户Id query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5推流信息管理

2.5.1uploadChannelFile

接口地址
POST  /api/push/upload
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
file query true file
响应状态

状态码说明schema
200 OK WVPResultObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 object
响应示例
{
	"code": 0,
	"msg": "",
	"data": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.2中止一个推流

接口地址
POST  /api/push/stop
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
streamId query true string
stream 流id true
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.3将推流添加到国标

接口地址
POST  /api/push/save_to_gb
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "gbStreamId": 0,
  "platformId": "",
  "catalogId": "",
  "app": "",
  "stream": "",
  "gbId": "",
  "name": "",
  "mediaServerId": "",
  "longitude": 0,
  "latitude": 0,
  "streamType": "",
  "status": true,
  "createTime": ""
}
请求参数

参数名称参数说明请求类型必须数据类型schema
gbStream 直播流关联国标上级平台 body true GbStream GbStream
 gbStreamId ID false integer(int32)
 platformId 平台ID false string
 catalogId 目录ID false string
 app 应用名 false string
 stream 流ID false string
 gbId 国标ID false string
 name 名称 false string
 mediaServerId 流媒体ID false string
 longitude 经度 false number(double)
 latitude 纬度 false number(double)
 streamType 流类型（拉流/推流） false string
 status 状态 false boolean
 createTime 创建时间 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.4添加推流信息

接口地址
POST  /api/push/add
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "gbStreamId": 0,
  "platformId": "",
  "catalogId": "",
  "app": "",
  "stream": "",
  "gbId": "",
  "name": "",
  "mediaServerId": "",
  "longitude": 0,
  "latitude": 0,
  "streamType": "",
  "status": true,
  "createTime": "",
  "id": 0,
  "totalReaderCount": "",
  "schemas": [
    {
      "schema": "",
      "bytesSpeed": 0
    }
  ],
  "originType": 0,
  "originSock": {
    "identifier": "",
    "local_ip": "",
    "local_port": 0,
    "peer_ip": "",
    "peer_port": 0
  },
  "originTypeStr": "",
  "originUrl": "",
  "aliveSecond": 0,
  "tracks": [
    {
      "channels": 0,
      "codecId": 0,
      "codecIdName": "",
      "codecType": 0,
      "ready": true,
      "sampleBit": 0,
      "sampleRate": 0,
      "fps": 0,
      "height": 0,
      "width": 0
    }
  ],
  "vhost": "",
  "serverId": "",
  "pushTime": "",
  "updateTime": "",
  "pushIng": true,
  "self": true
}
请求参数

参数名称参数说明请求类型必须数据类型schema
streamPushItem 推流信息 body true StreamPushItem StreamPushItem
 gbStreamId ID false integer(int32)
 platformId 平台ID false string
 catalogId 目录ID false string
 app 应用名 false string
 stream 流id false string
 gbId 国标ID false string
 name 名称 false string
 mediaServerId 使用的流媒体ID false string
 longitude 经度 false number(double)
 latitude 纬度 false number(double)
 streamType 流类型（拉流/推流） false string
 status 状态 false boolean
 createTime 创建时间 false string
 id id false integer(int32)
 totalReaderCount 观看总人数 false string
 schemas 协议 包括hls/rtsp/rtmp/http-flv/ws-flv false array MediaSchema
  schema false string
  bytesSpeed false integer
 originType 产生源类型 false integer(int32)
 originSock false OriginSock OriginSock
  identifier false string
  local_ip false string
  local_port false integer
  peer_ip false string
  peer_port false integer
 originTypeStr 产生源类型的字符串描述 false string
 originUrl 产生源的url false string
 aliveSecond 存活时间，单位秒 false integer(int64)
 tracks 音视频轨道 false array MediaTrack
  channels false integer
  codecId false integer
  codecIdName false string
  codecType false integer
  ready false boolean
  sampleBit false integer
  sampleRate false integer
  fps false integer
  height false integer
  width false integer
 vhost 音视频轨道 false string
 serverId 使用的服务ID false string
 pushTime 推流时间 false string
 updateTime 更新时间 false string
 pushIng 是否正在推流 false boolean
 self 是否自己平台的推流 false boolean
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.5推流列表查询

接口地址
GET  /api/push/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query false integer(int32)
count 每页查询数量 query false integer(int32)
query 查询内容 query false string
pushing 是否正在推流 query false boolean
mediaServerId 流媒体ID query false string
响应状态

状态码说明schema
200 OK PageInfoStreamPushItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array StreamPushItem
 gbStreamId ID integer(int32)
 platformId 平台ID string
 catalogId 目录ID string
 app 应用名 string
 stream 流id string
 gbId 国标ID string
 name 名称 string
 mediaServerId 使用的流媒体ID string
 longitude 经度 number(double)
 latitude 纬度 number(double)
 streamType 流类型（拉流/推流） string
 status 状态 boolean
 createTime 创建时间 string
 id id integer(int32)
 totalReaderCount 观看总人数 string
 schemas 协议 包括hls/rtsp/rtmp/http-flv/ws-flv array MediaSchema
  schema string
  bytesSpeed integer
 originType 产生源类型 integer(int32)
 originSock OriginSock OriginSock
  identifier string
  local_ip string
  local_port integer
  peer_ip string
  peer_port integer
 originTypeStr 产生源类型的字符串描述 string
 originUrl 产生源的url string
 aliveSecond 存活时间，单位秒 integer(int64)
 tracks 音视频轨道 array MediaTrack
  channels integer
  codecId integer
  codecIdName string
  codecType integer
  ready boolean
  sampleBit integer
  sampleRate integer
  fps integer
  height integer
  width integer
 vhost 音视频轨道 string
 serverId 使用的服务ID string
 pushTime 推流时间 string
 updateTime 更新时间 string
 pushIng 是否正在推流 boolean
 self 是否自己平台的推流 boolean
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"gbStreamId": 0,
			"platformId": "",
			"catalogId": "",
			"app": "",
			"stream": "",
			"gbId": "",
			"name": "",
			"mediaServerId": "",
			"longitude": 0,
			"latitude": 0,
			"streamType": "",
			"status": true,
			"createTime": "",
			"id": 0,
			"totalReaderCount": "",
			"schemas": [
				{
					"schema": "",
					"bytesSpeed": 0
				}
			],
			"originType": 0,
			"originSock": {
				"identifier": "",
				"local_ip": "",
				"local_port": 0,
				"peer_ip": "",
				"peer_port": 0
			},
			"originTypeStr": "",
			"originUrl": "",
			"aliveSecond": 0,
			"tracks": [
				{
					"channels": 0,
					"codecId": 0,
					"codecIdName": "",
					"codecType": 0,
					"ready": true,
					"sampleBit": 0,
					"sampleRate": 0,
					"fps": 0,
					"height": 0,
					"width": 0
				}
			],
			"vhost": "",
			"serverId": "",
			"pushTime": "",
			"updateTime": "",
			"pushIng": true,
			"self": true
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.6获取推流播放地址

接口地址
GET  /api/push/getPlayUrl
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
stream 流id query true string
mediaServerId 媒体服务器id query false string
响应状态

状态码说明schema
200 OK StreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
app string
stream string
deviceID string
channelId string
flv string
ip string
https_flv string
ws_flv string
wss_flv string
fmp4 string
https_fmp4 string
ws_fmp4 string
wss_fmp4 string
hls string
https_hls string
ws_hls string
wss_hls string
ts string
https_ts string
ws_ts string
wss_ts string
rtmp string
rtmps string
rtsp string
rtsps string
rtc string
rtcs string
mediaServerId string
tracks object
startTime string
endTime string
progress number(double) number(double)
transactionInfo TransactionInfo TransactionInfo
 callId string
 localTag string
 remoteTag string
 branch string
响应示例
{
	"app": "",
	"stream": "",
	"deviceID": "",
	"channelId": "",
	"flv": "",
	"ip": "",
	"https_flv": "",
	"ws_flv": "",
	"wss_flv": "",
	"fmp4": "",
	"https_fmp4": "",
	"ws_fmp4": "",
	"wss_fmp4": "",
	"hls": "",
	"https_hls": "",
	"ws_hls": "",
	"wss_hls": "",
	"ts": "",
	"https_ts": "",
	"ws_ts": "",
	"wss_ts": "",
	"rtmp": "",
	"rtmps": "",
	"rtsp": "",
	"rtsps": "",
	"rtc": "",
	"rtcs": "",
	"mediaServerId": "",
	"tracks": {},
	"startTime": "",
	"endTime": "",
	"progress": 0,
	"transactionInfo": {
		"callId": "",
		"localTag": "",
		"remoteTag": "",
		"branch": ""
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.7将推流移出到国标

接口地址
DELETE  /api/push/remove_form_gb
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "gbStreamId": 0,
  "platformId": "",
  "catalogId": "",
  "app": "",
  "stream": "",
  "gbId": "",
  "name": "",
  "mediaServerId": "",
  "longitude": 0,
  "latitude": 0,
  "streamType": "",
  "status": true,
  "createTime": ""
}
请求参数

参数名称参数说明请求类型必须数据类型schema
gbStream 直播流关联国标上级平台 body true GbStream GbStream
 gbStreamId ID false integer(int32)
 platformId 平台ID false string
 catalogId 目录ID false string
 app 应用名 false string
 stream 流ID false string
 gbId 国标ID false string
 name 名称 false string
 mediaServerId 流媒体ID false string
 longitude 经度 false number(double)
 latitude 纬度 false number(double)
 streamType 流类型（拉流/推流） false string
 status 状态 false boolean
 createTime 创建时间 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.5.8中止多个推流

接口地址
DELETE  /api/push/batchStop
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "gbStreams": [
    {
      "gbStreamId": 0,
      "platformId": "",
      "catalogId": "",
      "app": "",
      "stream": "",
      "gbId": "",
      "name": "",
      "mediaServerId": "",
      "longitude": 0,
      "latitude": 0,
      "streamType": "",
      "status": true,
      "createTime": ""
    }
  ]
}
请求参数

参数名称参数说明请求类型必须数据类型schema
batchGBStreamParam 多个推流信息 body true BatchGBStreamParam BatchGBStreamParam
 gbStreams 推流信息列表 false array GbStream
  gbStreamId ID false integer
  platformId 平台ID false string
  catalogId 目录ID false string
  app 应用名 false string
  stream 流ID false string
  gbId 国标ID false string
  name 名称 false string
  mediaServerId 流媒体ID false string
  longitude 经度 false number
  latitude 纬度 false number
  streamType 流类型（拉流/推流） false string
  status 状态 false boolean
  createTime 创建时间 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.6云台控制

2.6.1通用前端控制命令

接口地址
POST  /api/ptz/front_end_command/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
cmdCode 指令码 query true integer(int32)
parameter1 数据一 query true integer(int32)
parameter2 数据二 query true integer(int32)
combindCode2 组合码二 query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.6.2云台控制

接口地址
POST  /api/ptz/control/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
command 控制指令,允许值: left, right, up, down, upleft, upright, downleft, downright, zoomin, zoomout, stop query true string
horizonSpeed 水平速度 query true integer(int32)
verticalSpeed 垂直速度 query true integer(int32)
zoomSpeed 缩放速度 query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.6.3预置位查询

接口地址
GET  /api/ptz/preset/query/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7拉流代理

2.7.1保存代理

接口地址
POST  /api/proxy/save
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "gbStreamId": 0,
  "platformId": "",
  "catalogId": "",
  "app": "",
  "stream": "",
  "gbId": "",
  "name": "",
  "mediaServerId": "",
  "longitude": 0,
  "latitude": 0,
  "streamType": "",
  "status": true,
  "createTime": "",
  "type": "",
  "url": "",
  "src_url": "",
  "dst_url": "",
  "timeout_ms": 0,
  "ffmpeg_cmd_key": "",
  "rtp_type": "",
  "enable": true,
  "enable_hls": true,
  "enable_mp4": true,
  "enable_remove_none_reader": true,
  "enable_disable_none_reader": true,
  "platformGbId": ""
}
请求参数

参数名称参数说明请求类型必须数据类型schema
param 代理参数 true
streamProxyItem 拉流代理的信息 body true StreamProxyItem StreamProxyItem
 gbStreamId ID false integer(int32)
 platformId 平台ID false string
 catalogId 目录ID false string
 app 应用名 false string
 stream 流ID false string
 gbId 国标ID false string
 name 名称 false string
 mediaServerId 流媒体服务ID false string
 longitude 经度 false number(double)
 latitude 纬度 false number(double)
 streamType 流类型（拉流/推流） false string
 status 状态 false boolean
 createTime 创建时间 false string
 type 类型 false string
 url 拉流地址 false string
 src_url 拉流地址 false string
 dst_url 目标地址 false string
 timeout_ms 超时时间 false integer(int32)
 ffmpeg_cmd_key ffmpeg模板KEY false string
 rtp_type rtsp拉流时，拉流方式，0：tcp，1：udp，2：组播 false string
 enable 是否启用 false boolean
 enable_hls 是否启用HLS false boolean
 enable_mp4 是否启用MP4 false boolean
 enable_remove_none_reader 是否 无人观看时删除 false boolean
 enable_disable_none_reader 是否 无人观看时不启用 false boolean
 platformGbId 上级平台国标ID false string
响应状态

状态码说明schema
200 OK StreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
app string
stream string
deviceID string
channelId string
flv string
ip string
https_flv string
ws_flv string
wss_flv string
fmp4 string
https_fmp4 string
ws_fmp4 string
wss_fmp4 string
hls string
https_hls string
ws_hls string
wss_hls string
ts string
https_ts string
ws_ts string
wss_ts string
rtmp string
rtmps string
rtsp string
rtsps string
rtc string
rtcs string
mediaServerId string
tracks object
startTime string
endTime string
progress number(double) number(double)
transactionInfo TransactionInfo TransactionInfo
 callId string
 localTag string
 remoteTag string
 branch string
响应示例
{
	"app": "",
	"stream": "",
	"deviceID": "",
	"channelId": "",
	"flv": "",
	"ip": "",
	"https_flv": "",
	"ws_flv": "",
	"wss_flv": "",
	"fmp4": "",
	"https_fmp4": "",
	"ws_fmp4": "",
	"wss_fmp4": "",
	"hls": "",
	"https_hls": "",
	"ws_hls": "",
	"wss_hls": "",
	"ts": "",
	"https_ts": "",
	"ws_ts": "",
	"wss_ts": "",
	"rtmp": "",
	"rtmps": "",
	"rtsp": "",
	"rtsps": "",
	"rtc": "",
	"rtcs": "",
	"mediaServerId": "",
	"tracks": {},
	"startTime": "",
	"endTime": "",
	"progress": 0,
	"transactionInfo": {
		"callId": "",
		"localTag": "",
		"remoteTag": "",
		"branch": ""
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7.2停用代理

接口地址
GET  /api/proxy/stop
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
stream 流id query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7.3启用代理

接口地址
GET  /api/proxy/start
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
stream 流id query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7.4分页查询流代理

接口地址
GET  /api/proxy/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query false integer(int32)
count 每页查询数量 query false integer(int32)
query 查询内容 query false string
online 是否在线 query false boolean
响应状态

状态码说明schema
200 OK PageInfoStreamProxyItem
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array StreamProxyItem
 gbStreamId ID integer(int32)
 platformId 平台ID string
 catalogId 目录ID string
 app 应用名 string
 stream 流ID string
 gbId 国标ID string
 name 名称 string
 mediaServerId 流媒体服务ID string
 longitude 经度 number(double)
 latitude 纬度 number(double)
 streamType 流类型（拉流/推流） string
 status 状态 boolean
 createTime 创建时间 string
 type 类型 string
 url 拉流地址 string
 src_url 拉流地址 string
 dst_url 目标地址 string
 timeout_ms 超时时间 integer(int32)
 ffmpeg_cmd_key ffmpeg模板KEY string
 rtp_type rtsp拉流时，拉流方式，0：tcp，1：udp，2：组播 string
 enable 是否启用 boolean
 enable_hls 是否启用HLS boolean
 enable_mp4 是否启用MP4 boolean
 enable_remove_none_reader 是否 无人观看时删除 boolean
 enable_disable_none_reader 是否 无人观看时不启用 boolean
 platformGbId 上级平台国标ID string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"gbStreamId": 0,
			"platformId": "",
			"catalogId": "",
			"app": "",
			"stream": "",
			"gbId": "",
			"name": "",
			"mediaServerId": "",
			"longitude": 0,
			"latitude": 0,
			"streamType": "",
			"status": true,
			"createTime": "",
			"type": "",
			"url": "",
			"src_url": "",
			"dst_url": "",
			"timeout_ms": 0,
			"ffmpeg_cmd_key": "",
			"rtp_type": "",
			"enable": true,
			"enable_hls": true,
			"enable_mp4": true,
			"enable_remove_none_reader": true,
			"enable_disable_none_reader": true,
			"platformGbId": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7.5获取ffmpeg.cmd模板

接口地址
GET  /api/proxy/ffmpeg_cmd/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
mediaServerId 流媒体ID query true string
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.7.6移除代理

接口地址
DELETE  /api/proxy/del
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
stream 流id query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8国标设备点播

2.8.1结束转码

接口地址
POST  /api/play/convertStop/{key}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
key 视频流key path true string
mediaServerId 流媒体服务ID query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8.2将不是h264的视频通过ffmpeg 转码为h264 + aac

接口地址
POST  /api/play/convert/{streamId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
streamId 视频流ID path true string
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8.3停止点播

接口地址
GET  /api/play/stop/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8.4开始点播

接口地址
GET  /api/play/start/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
响应状态

状态码说明schema
200 OK WVPResultString
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8.5获取所有的ssrc

接口地址
GET  /api/play/ssrc
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.8.6语音广播命令

接口地址
GET  /api/play/broadcast/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9级联平台管理

2.9.1向上级平台添加国标通道

接口地址
POST  /api/platform/update_channel_for_gb
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "platformId": "",
  "catalogId": "",
  "channelReduces": [
    {
      "id": 0,
      "channelId": "",
      "deviceId": "",
      "name": "",
      "manufacturer": "",
      "hostAddress": "",
      "subCount": 0,
      "platformId": "",
      "catalogId": ""
    }
  ]
}
请求参数

参数名称参数说明请求类型必须数据类型schema
updateChannelParam 通道关联参数 body true UpdateChannelParam UpdateChannelParam
 platformId 上级平台的国标编号 false string
 catalogId 目录的国标编号 false string
 channelReduces false array ChannelReduce
  id deviceChannel的数据库自增ID false integer
  channelId 通道国标编号 false string
  deviceId 设备国标编号 false string
  name 通道名 false string
  manufacturer 生产厂商 false string
  hostAddress wan地址 false string
  subCount 子节点数 false integer
  platformId 平台上级国标编号 false string
  catalogId 目录国标编号 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.2保存上级平台信息

接口地址
POST  /api/platform/save
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "id": 0,
  "enable": true,
  "name": "",
  "serverGBId": "",
  "serverGBDomain": "",
  "serverIP": "",
  "serverPort": 0,
  "deviceGBId": "",
  "deviceIp": "",
  "devicePort": "",
  "username": "",
  "password": "",
  "expires": 0,
  "keepTimeout": 0,
  "transport": "",
  "characterSet": "",
  "ptz": true,
  "rtcp": true,
  "status": true,
  "channelCount": 0,
  "catalogId": "",
  "catalogSubscribe": true,
  "alarmSubscribe": true,
  "mobilePositionSubscribe": true,
  "startOfflinePush": true,
  "catalogGroup": 0,
  "administrativeDivision": "",
  "updateTime": "",
  "createTime": "",
  "treeType": ""
}
请求参数

参数名称参数说明请求类型必须数据类型schema
parentPlatform 平台信息 body true ParentPlatform ParentPlatform
 id ID(数据库中) false integer(int32)
 enable 是否启用 false boolean
 name 名称 false string
 serverGBId SIP服务国标编码 false string
 serverGBDomain SIP服务国标域 false string
 serverIP SIP服务IP false string
 serverPort SIP服务端口 false integer(int32)
 deviceGBId 设备国标编号 false string
 deviceIp 设备ip false string
 devicePort 设备端口 false string
 username SIP认证用户名(默认使用设备国标编号) false string
 password SIP认证密码 false string
 expires 注册周期 (秒) false integer(int32)
 keepTimeout 心跳周期(秒) false integer(int32)
 transport 传输协议 false string
 characterSet 字符集 false string
 ptz 允许云台控制 false boolean
 rtcp RTCP流保活 false boolean
 status 在线状态 false boolean
 channelCount 在线状态 false integer(int32)
 catalogId 默认目录Id,自动添加的通道多放在这个目录下 false string
 catalogSubscribe 已被订阅目录信息 false boolean
 alarmSubscribe 已被订阅报警信息 false boolean
 mobilePositionSubscribe 已被订阅移动位置信息 false boolean
 startOfflinePush 点播未推流的设备时是否使用redis通知拉起 false boolean
 catalogGroup 目录分组-每次向上级发送通道信息时单个包携带的通道数量，取值1,2,4,8 false integer(int32)
 administrativeDivision 行政区划 false string
 updateTime 更新时间 false string
 createTime 创建时间 false string
 treeType 树类型 国标规定了两种树的展现方式 行政区划 CivilCode 和业务分组:BusinessGrou false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.3编辑目录

接口地址
POST  /api/platform/catalog/edit
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "id": "",
  "name": "",
  "platformId": "",
  "parentId": "",
  "civilCode": "",
  "businessGroupId": "",
  "childrenCount": 0,
  "type": 0
}
请求参数

参数名称参数说明请求类型必须数据类型schema
platformCatalog 目录信息 body true PlatformCatalog PlatformCatalog
 id ID false string
 name 名称 false string
 platformId 平台ID false string
 parentId 父级目录ID false string
 civilCode 行政区划 false string
 businessGroupId 目录分组 false string
 childrenCount 子节点数 false integer(int32)
 type 类型：0 目录, 1 国标通道, 2 直播流 false integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.4修改默认目录

接口地址
POST  /api/platform/catalog/default/update
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
platformId 平台Id query true string
catalogId 目录Id query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.5添加目录

接口地址
POST  /api/platform/catalog/add
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "id": "",
  "name": "",
  "platformId": "",
  "parentId": "",
  "civilCode": "",
  "businessGroupId": "",
  "childrenCount": 0,
  "type": 0
}
请求参数

参数名称参数说明请求类型必须数据类型schema
platformCatalog 目录信息 body true PlatformCatalog PlatformCatalog
 id ID false string
 name 名称 false string
 platformId 平台ID false string
 parentId 父级目录ID false string
 civilCode 行政区划 false string
 businessGroupId 目录分组 false string
 childrenCount 子节点数 false integer(int32)
 type 类型：0 目录, 1 国标通道, 2 直播流 false integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.6添加上级平台信息

接口地址
POST  /api/platform/add
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "id": 0,
  "enable": true,
  "name": "",
  "serverGBId": "",
  "serverGBDomain": "",
  "serverIP": "",
  "serverPort": 0,
  "deviceGBId": "",
  "deviceIp": "",
  "devicePort": "",
  "username": "",
  "password": "",
  "expires": 0,
  "keepTimeout": 0,
  "transport": "",
  "characterSet": "",
  "ptz": true,
  "rtcp": true,
  "status": true,
  "channelCount": 0,
  "catalogId": "",
  "catalogSubscribe": true,
  "alarmSubscribe": true,
  "mobilePositionSubscribe": true,
  "startOfflinePush": true,
  "catalogGroup": 0,
  "administrativeDivision": "",
  "updateTime": "",
  "createTime": "",
  "treeType": ""
}
请求参数

参数名称参数说明请求类型必须数据类型schema
parentPlatform 平台信息 body true ParentPlatform ParentPlatform
 id ID(数据库中) false integer(int32)
 enable 是否启用 false boolean
 name 名称 false string
 serverGBId SIP服务国标编码 false string
 serverGBDomain SIP服务国标域 false string
 serverIP SIP服务IP false string
 serverPort SIP服务端口 false integer(int32)
 deviceGBId 设备国标编号 false string
 deviceIp 设备ip false string
 devicePort 设备端口 false string
 username SIP认证用户名(默认使用设备国标编号) false string
 password SIP认证密码 false string
 expires 注册周期 (秒) false integer(int32)
 keepTimeout 心跳周期(秒) false integer(int32)
 transport 传输协议 false string
 characterSet 字符集 false string
 ptz 允许云台控制 false boolean
 rtcp RTCP流保活 false boolean
 status 在线状态 false boolean
 channelCount 在线状态 false integer(int32)
 catalogId 默认目录Id,自动添加的通道多放在这个目录下 false string
 catalogSubscribe 已被订阅目录信息 false boolean
 alarmSubscribe 已被订阅报警信息 false boolean
 mobilePositionSubscribe 已被订阅移动位置信息 false boolean
 startOfflinePush 点播未推流的设备时是否使用redis通知拉起 false boolean
 catalogGroup 目录分组-每次向上级发送通道信息时单个包携带的通道数量，取值1,2,4,8 false integer(int32)
 administrativeDivision 行政区划 false string
 updateTime 更新时间 false string
 createTime 创建时间 false string
 treeType 树类型 国标规定了两种树的展现方式 行政区划 CivilCode 和业务分组:BusinessGrou false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.7获取国标服务的配置

接口地址
GET  /api/platform/server_config
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK JSONObject
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
empty boolean
innerMap object
响应示例
{
	"empty": true,
	"innerMap": {}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.8分页查询级联平台

接口地址
GET  /api/platform/query/{count}/{page}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 path true integer(int32)
count 每页条数 path true integer(int32)
响应状态

状态码说明schema
200 OK PageInfoParentPlatform
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array ParentPlatform
 id ID(数据库中) integer(int32)
 enable 是否启用 boolean
 name 名称 string
 serverGBId SIP服务国标编码 string
 serverGBDomain SIP服务国标域 string
 serverIP SIP服务IP string
 serverPort SIP服务端口 integer(int32)
 deviceGBId 设备国标编号 string
 deviceIp 设备ip string
 devicePort 设备端口 string
 username SIP认证用户名(默认使用设备国标编号) string
 password SIP认证密码 string
 expires 注册周期 (秒) integer(int32)
 keepTimeout 心跳周期(秒) integer(int32)
 transport 传输协议 string
 characterSet 字符集 string
 ptz 允许云台控制 boolean
 rtcp RTCP流保活 boolean
 status 在线状态 boolean
 channelCount 在线状态 integer(int32)
 catalogId 默认目录Id,自动添加的通道多放在这个目录下 string
 catalogSubscribe 已被订阅目录信息 boolean
 alarmSubscribe 已被订阅报警信息 boolean
 mobilePositionSubscribe 已被订阅移动位置信息 boolean
 startOfflinePush 点播未推流的设备时是否使用redis通知拉起 boolean
 catalogGroup 目录分组-每次向上级发送通道信息时单个包携带的通道数量，取值1,2,4,8 integer(int32)
 administrativeDivision 行政区划 string
 updateTime 更新时间 string
 createTime 创建时间 string
 treeType 树类型 国标规定了两种树的展现方式 行政区划 CivilCode 和业务分组:BusinessGrou string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"id": 0,
			"enable": true,
			"name": "",
			"serverGBId": "",
			"serverGBDomain": "",
			"serverIP": "",
			"serverPort": 0,
			"deviceGBId": "",
			"deviceIp": "",
			"devicePort": "",
			"username": "",
			"password": "",
			"expires": 0,
			"keepTimeout": 0,
			"transport": "",
			"characterSet": "",
			"ptz": true,
			"rtcp": true,
			"status": true,
			"channelCount": 0,
			"catalogId": "",
			"catalogSubscribe": true,
			"alarmSubscribe": true,
			"mobilePositionSubscribe": true,
			"startOfflinePush": true,
			"catalogGroup": 0,
			"administrativeDivision": "",
			"updateTime": "",
			"createTime": "",
			"treeType": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.9获取级联服务器信息

接口地址
GET  /api/platform/info/{id}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 平台国标编号 path true string
响应状态

状态码说明schema
200 OK ParentPlatform
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID(数据库中) integer(int32) integer(int32)
enable 是否启用 boolean
name 名称 string
serverGBId SIP服务国标编码 string
serverGBDomain SIP服务国标域 string
serverIP SIP服务IP string
serverPort SIP服务端口 integer(int32) integer(int32)
deviceGBId 设备国标编号 string
deviceIp 设备ip string
devicePort 设备端口 string
username SIP认证用户名(默认使用设备国标编号) string
password SIP认证密码 string
expires 注册周期 (秒) integer(int32) integer(int32)
keepTimeout 心跳周期(秒) integer(int32) integer(int32)
transport 传输协议 string
characterSet 字符集 string
ptz 允许云台控制 boolean
rtcp RTCP流保活 boolean
status 在线状态 boolean
channelCount 在线状态 integer(int32) integer(int32)
catalogId 默认目录Id,自动添加的通道多放在这个目录下 string
catalogSubscribe 已被订阅目录信息 boolean
alarmSubscribe 已被订阅报警信息 boolean
mobilePositionSubscribe 已被订阅移动位置信息 boolean
startOfflinePush 点播未推流的设备时是否使用redis通知拉起 boolean
catalogGroup 目录分组-每次向上级发送通道信息时单个包携带的通道数量，取值1,2,4,8 integer(int32) integer(int32)
administrativeDivision 行政区划 string
updateTime 更新时间 string
createTime 创建时间 string
treeType 树类型 国标规定了两种树的展现方式 行政区划 CivilCode 和业务分组:BusinessGrou string
响应示例
{
	"id": 0,
	"enable": true,
	"name": "",
	"serverGBId": "",
	"serverGBDomain": "",
	"serverIP": "",
	"serverPort": 0,
	"deviceGBId": "",
	"deviceIp": "",
	"devicePort": "",
	"username": "",
	"password": "",
	"expires": 0,
	"keepTimeout": 0,
	"transport": "",
	"characterSet": "",
	"ptz": true,
	"rtcp": true,
	"status": true,
	"channelCount": 0,
	"catalogId": "",
	"catalogSubscribe": true,
	"alarmSubscribe": true,
	"mobilePositionSubscribe": true,
	"startOfflinePush": true,
	"catalogGroup": 0,
	"administrativeDivision": "",
	"updateTime": "",
	"createTime": "",
	"treeType": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.10查询上级平台是否存在

接口地址
GET  /api/platform/exit/{serverGBId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
serverGBId 上级平台的国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.11查询上级平台是否存在

接口地址
GET  /api/platform/channel_list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页条数 query true integer(int32)
platformId 上级平台的国标编号 query false string
catalogId 目录ID query false string
query 查询内容 query false string
online 是否在线 query false boolean
channelType 通道类型 query false boolean
响应状态

状态码说明schema
200 OK PageInfoChannelReduce
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array ChannelReduce
 id deviceChannel的数据库自增ID integer(int32)
 channelId 通道国标编号 string
 deviceId 设备国标编号 string
 name 通道名 string
 manufacturer 生产厂商 string
 hostAddress wan地址 string
 subCount 子节点数 integer(int32)
 platformId 平台上级国标编号 string
 catalogId 目录国标编号 string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"id": 0,
			"channelId": "",
			"deviceId": "",
			"name": "",
			"manufacturer": "",
			"hostAddress": "",
			"subCount": 0,
			"platformId": "",
			"catalogId": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.12获取目录

接口地址
GET  /api/platform/catalog
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
platformId 上级平台的国标编号 query true string
parentId 父级目录的国标编号 query true string
响应状态

状态码说明schema
200 OK PlatformCatalog
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
id ID string
name 名称 string
platformId 平台ID string
parentId 父级目录ID string
civilCode 行政区划 string
businessGroupId 目录分组 string
childrenCount 子节点数 integer(int32) integer(int32)
type 类型：0 目录, 1 国标通道, 2 直播流 integer(int32) integer(int32)
响应示例
[
	{
		"id": "",
		"name": "",
		"platformId": "",
		"parentId": "",
		"civilCode": "",
		"businessGroupId": "",
		"childrenCount": 0,
		"type": 0
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.9.13删除上级平台

接口地址
DELETE  /api/platform/delete/{serverGBId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
serverGBId 上级平台的国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.14从上级平台移除国标通道

接口地址
DELETE  /api/platform/del_channel_for_gb
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "platformId": "",
  "catalogId": "",
  "channelReduces": [
    {
      "id": 0,
      "channelId": "",
      "deviceId": "",
      "name": "",
      "manufacturer": "",
      "hostAddress": "",
      "subCount": 0,
      "platformId": "",
      "catalogId": ""
    }
  ]
}
请求参数

参数名称参数说明请求类型必须数据类型schema
updateChannelParam 通道关联参数 body true UpdateChannelParam UpdateChannelParam
 platformId 上级平台的国标编号 false string
 catalogId 目录的国标编号 false string
 channelReduces false array ChannelReduce
  id deviceChannel的数据库自增ID false integer
  channelId 通道国标编号 false string
  deviceId 设备国标编号 false string
  name 通道名 false string
  manufacturer 生产厂商 false string
  hostAddress wan地址 false string
  subCount 子节点数 false integer
  platformId 平台上级国标编号 false string
  catalogId 目录国标编号 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.15删除关联

接口地址
DELETE  /api/platform/catalog/relation/del
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "id": "",
  "name": "",
  "platformId": "",
  "parentId": "",
  "civilCode": "",
  "businessGroupId": "",
  "childrenCount": 0,
  "type": 0
}
请求参数

参数名称参数说明请求类型必须数据类型schema
platformCatalog 目录信息 body true PlatformCatalog PlatformCatalog
 id ID false string
 name 名称 false string
 platformId 平台ID false string
 parentId 父级目录ID false string
 civilCode 行政区划 false string
 businessGroupId 目录分组 false string
 childrenCount 子节点数 false integer(int32)
 type 类型：0 目录, 1 国标通道, 2 直播流 false integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.9.16删除目录

接口地址
DELETE  /api/platform/catalog/del
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id 目录Id query true string
platformId 平台Id query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.10视频流关联到级联平台

2.10.1保存国标关联

接口地址
POST  /api/gbStream/add
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "platformId": "",
  "catalogId": "",
  "gbStreams": [
    {
      "gbStreamId": 0,
      "platformId": "",
      "catalogId": "",
      "app": "",
      "stream": "",
      "gbId": "",
      "name": "",
      "mediaServerId": "",
      "longitude": 0,
      "latitude": 0,
      "streamType": "",
      "status": true,
      "createTime": ""
    }
  ]
}
请求参数

参数名称参数说明请求类型必须数据类型schema
gbStreamParam 国标关联参数 body true GbStreamParam GbStreamParam
 platformId 平台ID false string
 catalogId 目录ID false string
 gbStreams 流国标信息列表 false array GbStream
  gbStreamId ID false integer
  platformId 平台ID false string
  catalogId 目录ID false string
  app 应用名 false string
  stream 流ID false string
  gbId 国标ID false string
  name 名称 false string
  mediaServerId 流媒体ID false string
  longitude 经度 false number
  latitude 纬度 false number
  streamType 流类型（拉流/推流） false string
  status 状态 false boolean
  createTime 创建时间 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.10.2查询国标通道

接口地址
GET  /api/gbStream/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页条数 query true integer(int32)
platformId 平台ID query true string
catalogId 目录ID query false string
query 查询内容 query false string
mediaServerId 流媒体ID query false string
响应状态

状态码说明schema
200 OK PageInfoGbStream
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array GbStream
 gbStreamId ID integer(int32)
 platformId 平台ID string
 catalogId 目录ID string
 app 应用名 string
 stream 流ID string
 gbId 国标ID string
 name 名称 string
 mediaServerId 流媒体ID string
 longitude 经度 number(double)
 latitude 纬度 number(double)
 streamType 流类型（拉流/推流） string
 status 状态 boolean
 createTime 创建时间 string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"gbStreamId": 0,
			"platformId": "",
			"catalogId": "",
			"app": "",
			"stream": "",
			"gbId": "",
			"name": "",
			"mediaServerId": "",
			"longitude": 0,
			"latitude": 0,
			"streamType": "",
			"status": true,
			"createTime": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.10.3移除国标关联

接口地址
DELETE  /api/gbStream/del
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
  "platformId": "",
  "catalogId": "",
  "gbStreams": [
    {
      "gbStreamId": 0,
      "platformId": "",
      "catalogId": "",
      "app": "",
      "stream": "",
      "gbId": "",
      "name": "",
      "mediaServerId": "",
      "longitude": 0,
      "latitude": 0,
      "streamType": "",
      "status": true,
      "createTime": ""
    }
  ]
}
请求参数

参数名称参数说明请求类型必须数据类型schema
gbStreamParam 国标关联参数 body true GbStreamParam GbStreamParam
 platformId 平台ID false string
 catalogId 目录ID false string
 gbStreams 流国标信息列表 false array GbStream
  gbStreamId ID false integer
  platformId 平台ID false string
  catalogId 目录ID false string
  app 应用名 false string
  stream 流ID false string
  gbId 国标ID false string
  name 名称 false string
  mediaServerId 流媒体ID false string
  longitude 经度 false number
  latitude 纬度 false number
  streamType 流类型（拉流/推流） false string
  status 状态 false boolean
  createTime 创建时间 false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.11位置信息管理

2.11.1订阅位置信息

接口地址
GET  /api/position/subscribe/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
expires 订阅超时时间 query true string
interval 上报时间间隔 query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.11.2获取移动位置信息

接口地址
GET  /api/position/realtime/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK MobilePosition
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
deviceId string
channelId string
deviceName string
time string
longitude number(double) number(double)
latitude number(double) number(double)
altitude number(double) number(double)
speed number(double) number(double)
direction number(double) number(double)
reportSource string
longitudeGcj02 number(double) number(double)
latitudeGcj02 number(double) number(double)
longitudeWgs84 number(double) number(double)
latitudeWgs84 number(double) number(double)
createTime string
响应示例
{
	"deviceId": "",
	"channelId": "",
	"deviceName": "",
	"time": "",
	"longitude": 0,
	"latitude": 0,
	"altitude": 0,
	"speed": 0,
	"direction": 0,
	"reportSource": "",
	"longitudeGcj02": 0,
	"latitudeGcj02": 0,
	"longitudeWgs84": 0,
	"latitudeWgs84": 0,
	"createTime": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.11.3查询设备最新位置

接口地址
GET  /api/position/latest/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK MobilePosition
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
deviceId string
channelId string
deviceName string
time string
longitude number(double) number(double)
latitude number(double) number(double)
altitude number(double) number(double)
speed number(double) number(double)
direction number(double) number(double)
reportSource string
longitudeGcj02 number(double) number(double)
latitudeGcj02 number(double) number(double)
longitudeWgs84 number(double) number(double)
latitudeWgs84 number(double) number(double)
createTime string
响应示例
{
	"deviceId": "",
	"channelId": "",
	"deviceName": "",
	"time": "",
	"longitude": 0,
	"latitude": 0,
	"altitude": 0,
	"speed": 0,
	"direction": 0,
	"reportSource": "",
	"longitudeGcj02": 0,
	"latitudeGcj02": 0,
	"longitudeWgs84": 0,
	"latitudeWgs84": 0,
	"createTime": ""
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.11.4查询历史轨迹

接口地址
GET  /api/position/history/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 query false string
start 开始时间 query false string
end 结束时间 query false string
响应状态

状态码说明schema
200 OK MobilePosition
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
deviceId string
channelId string
deviceName string
time string
longitude number(double) number(double)
latitude number(double) number(double)
altitude number(double) number(double)
speed number(double) number(double)
direction number(double) number(double)
reportSource string
longitudeGcj02 number(double) number(double)
latitudeGcj02 number(double) number(double)
longitudeWgs84 number(double) number(double)
latitudeWgs84 number(double) number(double)
createTime string
响应示例
[
	{
		"deviceId": "",
		"channelId": "",
		"deviceName": "",
		"time": "",
		"longitude": 0,
		"latitude": 0,
		"altitude": 0,
		"speed": 0,
		"direction": 0,
		"reportSource": "",
		"longitudeGcj02": 0,
		"latitudeGcj02": 0,
		"longitudeWgs84": 0,
		"latitudeWgs84": 0,
		"createTime": ""
	}
]
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
[
	{
		"code": 0,
		"msg": "",
		"data": ""
	}
]

2.12视频回放

2.12.1停止视频回放

接口地址
GET  /api/playback/stop/{deviceId}/{channelId}/{stream}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
stream 流ID path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.12.2开始视频回放

接口地址
GET  /api/playback/start/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
startTime 开始时间 query true string
endTime 结束时间 query true string
响应状态

状态码说明schema
200 OK WVPResultStreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data StreamInfo StreamInfo
 app string
 stream string
 deviceID string
 channelId string
 flv string
 ip string
 https_flv string
 ws_flv string
 wss_flv string
 fmp4 string
 https_fmp4 string
 ws_fmp4 string
 wss_fmp4 string
 hls string
 https_hls string
 ws_hls string
 wss_hls string
 ts string
 https_ts string
 ws_ts string
 wss_ts string
 rtmp string
 rtmps string
 rtsp string
 rtsps string
 rtc string
 rtcs string
 mediaServerId string
 tracks object
 startTime string
 endTime string
 progress number(double)
 transactionInfo TransactionInfo TransactionInfo
  callId string
  localTag string
  remoteTag string
  branch string
响应示例
{
	"code": 0,
	"msg": "",
	"data": {
		"app": "",
		"stream": "",
		"deviceID": "",
		"channelId": "",
		"flv": "",
		"ip": "",
		"https_flv": "",
		"ws_flv": "",
		"wss_flv": "",
		"fmp4": "",
		"https_fmp4": "",
		"ws_fmp4": "",
		"wss_fmp4": "",
		"hls": "",
		"https_hls": "",
		"ws_hls": "",
		"wss_hls": "",
		"ts": "",
		"https_ts": "",
		"ws_ts": "",
		"wss_ts": "",
		"rtmp": "",
		"rtmps": "",
		"rtsp": "",
		"rtsps": "",
		"rtc": "",
		"rtcs": "",
		"mediaServerId": "",
		"tracks": {},
		"startTime": "",
		"endTime": "",
		"progress": 0,
		"transactionInfo": {
			"callId": "",
			"localTag": "",
			"remoteTag": "",
			"branch": ""
		}
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.12.3回放倍速播放

接口地址
GET  /api/playback/speed/{streamId}/{speed}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
streamId 回放流ID path true string
speed 倍速0.25 0.5 1、2、4 path true number(double)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.12.4回放拖动播放

接口地址
GET  /api/playback/seek/{streamId}/{seekTime}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
streamId 回放流ID path true string
seekTime 拖动偏移量，单位s path true integer(int64)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.12.5回放恢复

接口地址
GET  /api/playback/resume/{streamId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
streamId 回放流ID path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.12.6回放暂停

接口地址
GET  /api/playback/pause/{streamId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
streamId 回放流ID path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.13媒体流相关

2.13.1根据应用名和流id获取播放地址

接口地址
GET  /api/media/stream_info_by_app_and_stream
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
app 应用名 query true string
stream 流id query true string
mediaServerId 媒体服务器id query false string
callId 推流时携带的自定义鉴权ID query false string
useSourceIpAsStreamIp 是否使用请求IP作为返回的地址IP query false boolean
响应状态

状态码说明schema
200 OK StreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
app string
stream string
deviceID string
channelId string
flv string
ip string
https_flv string
ws_flv string
wss_flv string
fmp4 string
https_fmp4 string
ws_fmp4 string
wss_fmp4 string
hls string
https_hls string
ws_hls string
wss_hls string
ts string
https_ts string
ws_ts string
wss_ts string
rtmp string
rtmps string
rtsp string
rtsps string
rtc string
rtcs string
mediaServerId string
tracks object
startTime string
endTime string
progress number(double) number(double)
transactionInfo TransactionInfo TransactionInfo
 callId string
 localTag string
 remoteTag string
 branch string
响应示例
{
	"app": "",
	"stream": "",
	"deviceID": "",
	"channelId": "",
	"flv": "",
	"ip": "",
	"https_flv": "",
	"ws_flv": "",
	"wss_flv": "",
	"fmp4": "",
	"https_fmp4": "",
	"ws_fmp4": "",
	"wss_fmp4": "",
	"hls": "",
	"https_hls": "",
	"ws_hls": "",
	"wss_hls": "",
	"ts": "",
	"https_ts": "",
	"ws_ts": "",
	"wss_ts": "",
	"rtmp": "",
	"rtmps": "",
	"rtsp": "",
	"rtsps": "",
	"rtc": "",
	"rtcs": "",
	"mediaServerId": "",
	"tracks": {},
	"startTime": "",
	"endTime": "",
	"progress": 0,
	"transactionInfo": {
		"callId": "",
		"localTag": "",
		"remoteTag": "",
		"branch": ""
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.14日志管理

2.14.1分页查询报警

接口地址
GET  /api/log/all
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
query 查询内容 query true string
type 类型 query true string
startTime 开始时间 query true string
endTime 结束时间 query true string
响应状态

状态码说明schema
200 OK PageInfoLogDto
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array LogDto
 id integer(int32)
 name string
 type string
 uri string
 address string
 result string
 timing integer(int64)
 username string
 createTime string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"id": 0,
			"name": "",
			"type": "",
			"uri": "",
			"address": "",
			"result": "",
			"timing": 0,
			"username": "",
			"createTime": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.14.2停止视频回放

接口地址
DELETE  /api/log/clear
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
暂无
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.15国标录像

2.15.1录像查询

接口地址
GET  /api/gb_record/query/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
startTime 开始时间 query true string
endTime 结束时间 query true string
响应状态

状态码说明schema
200 OK WVPResultRecordInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data RecordInfo RecordInfo
 deviceId string
 channelId string
 sn string
 name string
 sumNum integer(int32)
 lastTime string(date-time)
 recordList array RecordItem
  deviceId string
  name string
  filePath string
  fileSize string
  address string
  startTime string
  endTime string
  secrecy integer
  type string
  recorderId string
响应示例
{
	"code": 0,
	"msg": "",
	"data": {
		"deviceId": "",
		"channelId": "",
		"sn": "",
		"name": "",
		"sumNum": 0,
		"lastTime": "",
		"recordList": [
			{
				"deviceId": "",
				"name": "",
				"filePath": "",
				"fileSize": "",
				"address": "",
				"startTime": "",
				"endTime": "",
				"secrecy": 0,
				"type": "",
				"recorderId": ""
			}
		]
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.15.2停止历史媒体下载

接口地址
GET  /api/gb_record/download/stop/{deviceId}/{channelId}/{stream}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
stream 流ID path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.15.3开始历史媒体下载

接口地址
GET  /api/gb_record/download/start/{deviceId}/{channelId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
startTime 开始时间 query true string
endTime 结束时间 query true string
downloadSpeed 下载倍速 query true string
响应状态

状态码说明schema
200 OK WVPResultStreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data StreamInfo StreamInfo
 app string
 stream string
 deviceID string
 channelId string
 flv string
 ip string
 https_flv string
 ws_flv string
 wss_flv string
 fmp4 string
 https_fmp4 string
 ws_fmp4 string
 wss_fmp4 string
 hls string
 https_hls string
 ws_hls string
 wss_hls string
 ts string
 https_ts string
 ws_ts string
 wss_ts string
 rtmp string
 rtmps string
 rtsp string
 rtsps string
 rtc string
 rtcs string
 mediaServerId string
 tracks object
 startTime string
 endTime string
 progress number(double)
 transactionInfo TransactionInfo TransactionInfo
  callId string
  localTag string
  remoteTag string
  branch string
响应示例
{
	"code": 0,
	"msg": "",
	"data": {
		"app": "",
		"stream": "",
		"deviceID": "",
		"channelId": "",
		"flv": "",
		"ip": "",
		"https_flv": "",
		"ws_flv": "",
		"wss_flv": "",
		"fmp4": "",
		"https_fmp4": "",
		"ws_fmp4": "",
		"wss_fmp4": "",
		"hls": "",
		"https_hls": "",
		"ws_hls": "",
		"wss_hls": "",
		"ts": "",
		"https_ts": "",
		"ws_ts": "",
		"wss_ts": "",
		"rtmp": "",
		"rtmps": "",
		"rtsp": "",
		"rtsps": "",
		"rtc": "",
		"rtcs": "",
		"mediaServerId": "",
		"tracks": {},
		"startTime": "",
		"endTime": "",
		"progress": 0,
		"transactionInfo": {
			"callId": "",
			"localTag": "",
			"remoteTag": "",
			"branch": ""
		}
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.15.4获取历史媒体下载进度

接口地址
GET  /api/gb_record/download/progress/{deviceId}/{channelId}/{stream}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 path true string
stream 流ID path true string
响应状态

状态码说明schema
200 OK StreamInfo
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
app string
stream string
deviceID string
channelId string
flv string
ip string
https_flv string
ws_flv string
wss_flv string
fmp4 string
https_fmp4 string
ws_fmp4 string
wss_fmp4 string
hls string
https_hls string
ws_hls string
wss_hls string
ts string
https_ts string
ws_ts string
wss_ts string
rtmp string
rtmps string
rtsp string
rtsps string
rtc string
rtcs string
mediaServerId string
tracks object
startTime string
endTime string
progress number(double) number(double)
transactionInfo TransactionInfo TransactionInfo
 callId string
 localTag string
 remoteTag string
 branch string
响应示例
{
	"app": "",
	"stream": "",
	"deviceID": "",
	"channelId": "",
	"flv": "",
	"ip": "",
	"https_flv": "",
	"ws_flv": "",
	"wss_flv": "",
	"fmp4": "",
	"https_fmp4": "",
	"ws_fmp4": "",
	"wss_fmp4": "",
	"hls": "",
	"https_hls": "",
	"ws_hls": "",
	"wss_hls": "",
	"ts": "",
	"https_ts": "",
	"ws_ts": "",
	"wss_ts": "",
	"rtmp": "",
	"rtmps": "",
	"rtsp": "",
	"rtsps": "",
	"rtc": "",
	"rtcs": "",
	"mediaServerId": "",
	"tracks": {},
	"startTime": "",
	"endTime": "",
	"progress": 0,
	"transactionInfo": {
		"callId": "",
		"localTag": "",
		"remoteTag": "",
		"branch": ""
	}
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16国标设备控制

2.16.1远程启动控制命令

接口地址
GET  /api/device/control/teleboot/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.2报警复位

接口地址
GET  /api/device/control/reset_alarm/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 query true string
alarmMethod 报警方式 query false string
alarmType 报警类型 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.3录像控制

接口地址
GET  /api/device/control/record/{deviceId}/{recordCmdStr}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
recordCmdStr 命令， 可选值：Record（手动录像），StopRecord（停止手动录像） path true string
channelId 通道国标编号 query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.4强制关键帧

接口地址
GET  /api/device/control/i_frame/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.5看守位控制

接口地址
GET  /api/device/control/home_position/{deviceId}/{enabled}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
enabled 是否开启看守位 1:开启,0:关闭 path true string
channelId 通道国标编号 query true string
resetTime 自动归位时间间隔 query false string
presetIndex 调用预置位编号 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.6布防-撤防命令

接口地址
GET  /api/device/control/guard/{deviceId}/{guardCmdStr}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 query true string
guardCmdStr 命令， 可选值：SetGuard（布防），ResetGuard（撤防） path true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.7拉框放大

接口地址
GET  /api/device/control/drag_zoom/zoom_out
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 query true string
length 播放窗口长度像素值 query true integer(int32)
width 拉框中心的横轴坐标像素值 query true integer(int32)
midpointx 拉框中心的横轴坐标像素值 query true integer(int32)
midpointy 拉框中心的纵轴坐标像素值 query true integer(int32)
lengthx 拉框长度像素值 query true integer(int32)
lengthy 拉框宽度像素值 query true integer(int32)
channelId 通道国标编号 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.16.8拉框放大

接口地址
GET  /api/device/control/drag_zoom/zoom_in
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 query true string
channelId 通道国标编号 query true string
length 播放窗口长度像素值 query true integer(int32)
width query true integer(int32)
midpointx 拉框中心的横轴坐标像素值 query true integer(int32)
midpointy 拉框中心的纵轴坐标像素值 query true integer(int32)
lengthx 拉框长度像素值 query true integer(int32)
lengthy lengthy query true integer(int32)
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.17国标设备配置

2.17.1设备配置查询请求

接口地址
GET  /api/device/config/query/{deviceId}/{configType}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
configType 配置类型 path true string
channelId 通道国标编号 query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.17.2基本配置设置命令

接口地址
GET  /api/device/config/basicParam/{deviceId}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 path true string
channelId 通道国标编号 query true string
name 名称 query false string
expiration 到期时间 query false string
heartBeatInterval 心跳间隔 query false string
heartBeatCount 心跳计数 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.18报警信息管理

2.18.1测试向上级-设备发送模拟报警通知

接口地址
GET  /api/alarm/test/notify/alarm
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
deviceId 设备国标编号 query true string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.18.2分页查询报警

接口地址
GET  /api/alarm/all
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
page 当前页 query true integer(int32)
count 每页查询数量 query true integer(int32)
deviceId 设备id query false string
alarmPriority 查询内容 query false string
alarmMethod 查询内容 query false string
alarmType 每页查询数量 query false string
startTime 开始时间 query false string
endTime 结束时间 query false string
响应状态

状态码说明schema
200 OK PageInfoDeviceAlarm
500 Internal Server Error WVPResultString

响应状态码-200
响应参数
参数名称参数说明类型schema
total integer(int64) integer(int64)
list array DeviceAlarm
 id 数据库id string
 deviceId 设备的国标编号 string
 channelId 通道的国标编号 string
 alarmPriority 报警级别, 1为一级警情, 2为二级警情, 3为三级警情, 4为四级警情 string
 alarmMethod 报警方式 , 1为电话报警, 2为设备报警, 3为短信报警, 4为 GPS报警, 5为视频报警, 6为设备故障报警,\n * 7其他报警;可以为直接组合如12为电话报警或设备报警 string
 alarmTime 报警时间 string
 alarmDescription 报警内容描述 string
 longitude 经度 number(double)
 latitude 纬度 number(double)
 alarmType 报警类型 string
 createTime 创建时间 string
pageNum integer(int32) integer(int32)
pageSize integer(int32) integer(int32)
size integer(int32) integer(int32)
startRow integer(int64) integer(int64)
endRow integer(int64) integer(int64)
pages integer(int32) integer(int32)
prePage integer(int32) integer(int32)
nextPage integer(int32) integer(int32)
isFirstPage boolean
isLastPage boolean
hasPreviousPage boolean
hasNextPage boolean
navigatePages integer(int32) integer(int32)
navigatepageNums array
navigateFirstPage integer(int32) integer(int32)
navigateLastPage integer(int32) integer(int32)
响应示例
{
	"total": 0,
	"list": [
		{
			"id": "",
			"deviceId": "",
			"channelId": "",
			"alarmPriority": "",
			"alarmMethod": "",
			"alarmTime": "",
			"alarmDescription": "",
			"longitude": 0,
			"latitude": 0,
			"alarmType": "",
			"createTime": ""
		}
	],
	"pageNum": 0,
	"pageSize": 0,
	"size": 0,
	"startRow": 0,
	"endRow": 0,
	"pages": 0,
	"prePage": 0,
	"nextPage": 0,
	"isFirstPage": true,
	"isLastPage": true,
	"hasPreviousPage": true,
	"hasNextPage": true,
	"navigatePages": 0,
	"navigatepageNums": [],
	"navigateFirstPage": 0,
	"navigateLastPage": 0
}
响应状态码-500
响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}

2.18.3删除报警

接口地址
DELETE  /api/alarm/delete
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数

参数名称参数说明请求类型必须数据类型schema
id ID query false integer(int32)
deviceIds 多个设备id,逗号分隔 query false string
time 结束时间 query false string
响应状态

状态码说明schema
200 OK
500 Internal Server Error WVPResultString

响应参数
参数名称参数说明类型schema
code 错误码，0为成功 integer(int32) integer(int32)
msg 描述，错误时描述错误原因 string
data 数据 string
响应示例
{
	"code": 0,
	"msg": "",
	"data": ""
}