IVM 接口文档 v1.1

1. ONEWO-IVM 接口文档

简介: ONEWO-IVM 接口文档

HOST: http://10.39.130.195:18080

联系人: pan

Version: v3.1.0

接口路径: /v3/api-docs/1. 全部

2. 国标设备查询

2.1 修改数据流传输模式

接口地址: /api/device/query/transport/{deviceId}/{streamMode}

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

响应状态:

状态码	说明
200	OK
400	Bad Request
500	Internal Server Error

响应状态码-400:

响应参数:

参数名称	参数说明	类型
code	错误码，0为成功	integer(int32)
msg	描述，错误时描述错误原因	string
data	数据	string

响应示例:

json

{
    "code": 0,
    "msg": "",
    "data": ""
}

2.2 导出设备通道台账

接口地址: /api/device/query/exportDeviceChannel

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "deviceIds": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceChannelExport	DeviceChannelExport	body	true	DeviceChannelExport
deviceIds			false	array

2.3 更新设备信息

接口地址: /api/device/query/device/update/

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
device	国标设备/平台	query	true	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	是否在线，true为在线，false为离线		false	boolean
registerTime	注册时间		false	string
keepaliveTime	心跳时间		false	string
keepaliveIntervalTime	心跳间隔		false	integer(int32)
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	目录订阅周期，o为不订阅		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
password	密码		false	string
sdpIp	收流IP		false	string
localIp	SIP交互IP（设备访问平台的IP）		false	string
asMessageChannel	是否作为消息通道		false	boolean
sipTransactionInfo			false	SipTransactionInfo
callId			false	string
fromTag			false	string
toTag			false	string
viaBranch			false	string
asSender			false	boolean
broadcastPushAfterAck	控制语音对讲流程，释放收到ACK后发流		false	boolean
streamModeForParam			false	integer(int32)

2.4 添加设备信息

接口地址: /api/device/query/device/add/

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 同 2.3 更新设备信息

2.5 更新通道信息

接口地址: /api/device/query/channel/update/{deviceId}

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channel	通道信息	query	true	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
ptzType	云台类型		false	integer(int32)
ptzTypeText	云台类型描述字符串		false	string
createTime	创建时间		false	string
updateTime	更新时间		false	string
status	在线/离线， 1在线,0离线		false	boolean
longitude	经度		false	number(double)
latitude	纬度		false	number(double)
customLongitude	自定义经度		false	number(double)
customLatitude	自定义纬度		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
streamIdentification	码流标识，优先级高于设备中码流标识，用于选择码流时组成码流标识。默认为null，不设置。可选值: stream/streamnumber/streamprofile/streamMode		false	string

2.6 修改通道的码流类型

接口地址: /api/device/query/channel/stream/identification/update/

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
channel	通道信息	query	true	DeviceChannel
deviceId	设备国标编号	query	true	string
(其他字段同2.5)

2.7 获取通道同步进度

接口地址: /api/device/query/{deviceId}/sync_status

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

响应状态码-200:

响应参数:

参数名称	参数说明	类型
code	错误码，0为成功	integer(int32)
msg	描述，错误时描述错误原因	string
data		SyncStatus
total	总数	integer(int32)
current	当前更新多少	integer(int32)
errorMsg	错误描述	string
syncIng	是否同步中	boolean

响应示例:

json

{
    "code": 0,
    "msg": "",
    "data": {
        "total": 0,
        "current": 0,
        "errorMsg": "",
        "syncIng": true
    }
}

2.8 获取设备的订阅状态

接口地址: /api/device/query/{deviceId}/subscribe_info

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

响应状态码-200:

响应参数:

参数名称	参数说明	类型
code	错误码，0为成功	integer(int32)
msg	描述，错误时描述错误原因	string
data	数据	object

响应示例:

json

{
    "code": 0,
    "msg": "",
    "data": {}
}

2.9 查询通道状态

接口地址: /api/device/query/{deviceId}/status/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channelId	设备国标通道编号	path	true	string

2.10 查询国标树

接口地址: /api/device/query/tree/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

2.11 查询国标树下的通道

接口地址: /api/device/query/tree/channel/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

2.12 分页查询子目录通道

接口地址: /api/device/query/sub_channels/{deviceId}/{channelId}/channels

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

2.13 请求截图

接口地址: /api/device/query/snap/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channelId	通道国标编号	path	true	string
mark	标识	query	false	string

2.14 分页查询设备通道

接口地址: /api/device/query/listDeviceAndChannel

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	设备国标编号	query	true	integer(int32)
pageSize	设备国标通道编号	query	true	integer(int32)

2.15 分页查询国标设备

接口地址: /api/device/query/devices

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	query	true	integer(int32)
count		query	true	integer(int32)
onLine	设备状态	query	false	boolean
deviceName	设备名称，支持模糊搜索	query	false	string
deviceNumber	设备ID，支持模糊搜索	query	false	string
deviceIp	设备注册Ip地址，支持模糊搜索	query	false	string

2.16 查询国标设备

接口地址: /api/device/query/devices/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

2.17 同步设备通道

接口地址: /api/device/query/devices/{deviceId}/sync

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

2.18 设备状态查询

接口地址: /api/device/query/devices/{deviceId}/status

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

2.19 分页查询通道

接口地址: /api/device/query/devices/{deviceId}/channels

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

2.20 设备报警查询

接口地址: /api/device/query/alarm/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

2.21 移除设备

接口地址: /api/device/query/devices/{deviceId}/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

3. 用户ApiKey管理

3.1 重置用户ApiKey

接口地址: /api/userApiKey/reset

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户ApiKeyId	query	true	integer(int32)

3.2 备注用户ApiKey

接口地址: /api/userApiKey/remark

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户ApiKeyId	query	true	integer(int32)
remark	用户ApiKey备注	query	false	string

3.3 启用用户ApiKey

接口地址: /api/userApiKey/enable

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户ApiKeyId	query	true	integer(int32)

3.4 停用用户ApiKey

接口地址: /api/userApiKey/disable

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户ApiKeyId	query	true	integer(int32)

3.5 添加用户ApiKey

接口地址: /api/userApiKey/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	用户Id	query	true	integer(int32)
app	应用名称	query	false	string
remark	备注信息	query	false	string
expiresAt		query	false	string
enable		query	false	boolean
expiredAt	过期时间（不传代表永不过期）	query	false

3.6 分页查询用户

接口地址: /api/userApiKey/userApiKeys

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

3.7 删除用户ApiKey

接口地址: /api/userApiKey/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户ApiKeyId	query	true	integer(int32)

4. 用户管理

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

接口地址: /api/user/userInfo

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

4.2 修改密码

接口地址: /api/user/changePassword

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

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

接口地址: /api/user/changePasswordForAdmin

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

4.4 添加用户

接口地址: /api/user/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

4.5 分页查询用户

接口地址: /api/user/users

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

4.6 登录

接口地址: /api/user/login

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

登录成功后返回AccessToken，可以从返回值获取到也可以从响应头中获取到，后续的请求需要添加请求头 'access-token'或者放在参数里

请求参数:

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

4.7 查询用户

接口地址: /api/user/all

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

4.8 删除用户

接口地址: /api/user/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户Id	query	true	integer(int32)

4.9 修改pushkey

接口地址: /api/user/changePushKey

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	用户Id	query	true	integer(int32)
pushKey	新的pushKey	query	true	string

5. 服务控制

5.1 保存流媒体服务

接口地址: /api/server/media_server/save

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "id": "",
    "ip": "",
    "hookIp": "",
    "sdpIp": "",
    "streamIp": "",
    "httpPort": 0,
    "httpSSlPort": 0,
    "rtmpPort": 0,
    "flvPort": 0,
    "flvSSLPort": 0,
    "wsFlvPort": 0,
    "wsFlvSSLPort": 0,
    "rtmpSSlPort": 0,
    "rtpProxyPort": 0,
    "rtspPort": 0,
    "rtspSSLPort": 0,
    "autoConfig": true,
    "secret": "",
    "hookAliveInterval": 0,
    "rtpEnable": true,
    "status": true,
    "rtpPortRange": "",
    "sendRtpPortRange": "",
    "recordAssistPort": 0,
    "createTime": "",
    "updateTime": "",
    "lastKeepaliveTime": "",
    "defaultServer": true,
    "recordDay": 0,
    "recordPath": "",
    "type": "",
    "transcodeSuffix": ""
}

5.2 获取版本信息

接口地址: /api/server/version

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.3 获取系统信息

接口地址: /api/server/system/info

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.4 获取系统信息信息

接口地址: /api/server/system/configInfo

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.5 重启服务

接口地址: /api/server/restart

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.6 获取负载信息

接口地址: /api/server/resource/info

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

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

接口地址: /api/server/media_server/record/check

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

5.8 在线流媒体服务列表

接口地址: /api/server/media_server/online/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.9 停止视频回放

接口地址: /api/server/media_server/one/{id}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	流媒体服务ID	path	true	string

5.10 获取负载信息

接口地址: /api/server/media_server/load

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.11 流媒体服务列表

接口地址: /api/server/media_server/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

5.12 测试流媒体服务

接口地址: /api/server/media_server/check

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

5.13 获取配置信息

接口地址: /api/server/config

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	配置类型（sip, base）	query	true	string

5.14 移除流媒体服务

接口地址: /api/server/media_server/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	流媒体ID	query	true	string

6. 角色管理

6.1 添加角色

接口地址: /api/role/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

6.2 查询角色

接口地址: /api/role/all

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

6.3 删除角色

接口地址: /api/role/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户Id	query	true	integer(int32)

7. 推流信息管理

7.1 uploadChannelFile

接口地址: /api/push/upload

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
file		query	true	file

7.2 中止一个推流

接口地址: /api/push/stop

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流id	query	true	string

7.3 将推流添加到国标

接口地址: /api/push/save_to_gb

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "gbStreamId": 0,
    "platformId": "",
    "catalogId": "",
    "app": "",
    "stream": "",
    "gbId": "",
    "name": "",
    "mediaServerId": "",
    "longitude": 0,
    "latitude": 0,
    "streamType": "",
    "status": true,
    "createTime": ""
}

7.4 添加推流信息

接口地址: /api/push/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "gbStreamId": 0,
    "platformId": "",
    "catalogId": "",
    "app": "",
    "stream": "",
    "gbId": "",
    "name": "",
    "mediaServerId": "",
    "longitude": 0,
    "latitude": 0,
    "streamType": "",
    "status": true,
    "createTime": "",
    "id": 0,
    "totalReaderCount": 0,
    "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,
            "codec_id": 0,
            "codec_id_name": "",
            "codec_type": 0,
            "ready": true,
            "sample_bit": 0,
            "sample_rate": 0,
            "fps": 0,
            "height": 0,
            "width": 0,
            "frames": 0,
            "key_frames": 0,
            "gop_size": 0,
            "gop_interval_ms": 0,
            "loss": 0
        }
    ],
    "vhost": "",
    "serverId": "",
    "pushTime": "",
    "updateTime": "",
    "pushIng": true,
    "self": true
}

7.5 推流列表查询

接口地址: /api/push/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

7.6 获取推流播放地址

接口地址: /api/push/getPlayUrl

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

7.7 将推流移出到国标

接口地址: /api/push/remove_form_gb

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "gbStreamId": 0,
    "platformId": "",
    "catalogId": "",
    "app": "",
    "stream": "",
    "gbId": "",
    "name": "",
    "mediaServerId": "",
    "longitude": 0,
    "latitude": 0,
    "streamType": "",
    "status": true,
    "createTime": ""
}

7.8 中止多个推流

接口地址: /api/push/batchStop

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "gbStreams": [
        {
            "gbStreamId": 0,
            "platformId": "",
            "catalogId": "",
            "app": "",
            "stream": "",
            "gbId": "",
            "name": "",
            "mediaServerId": "",
            "longitude": 0,
            "latitude": 0,
            "streamType": "",
            "status": true,
            "createTime": ""
        }
    ]
}

8. 云台控制

8.1 通用前端控制命令

接口地址: /api/ptz/front_end_command/{deviceId}/{channelId}

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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)

8.2 云台控制

接口地址: /api/ptz/control/{deviceId}/{channelId}

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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)

8.3 预置位查询

接口地址: /api/ptz/preset/query/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channelId	通道国标编号	path	true	string

9. 拉流代理

9.1 保存代理

接口地址: /api/proxy/save

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "gbStreamId": 0,
    "platformId": "",
    "catalogId": "",
    "app": "",
    "stream": "",
    "gbId": "",
    "name": "",
    "mediaServerId": "",
    "longitude": 0,
    "latitude": 0,
    "streamType": "",
    "status": true,
    "createTime": "",
    "type": "",
    "url": "",
    "srcUrl": "",
    "dstUrl": "",
    "timeoutMs": 0,
    "ffmpegCmdKey": "",
    "rtpType": "",
    "enable": true,
    "enableAudio": true,
    "enableMp4": true,
    "enableRemoveNoneReader": true,
    "enableDisableNoneReader": true,
    "streamKey": ""
}

9.2 停用代理

接口地址: /api/proxy/stop

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流id	query	true	string

9.3 启用代理

接口地址: /api/proxy/start

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流id	query	true	string

9.4 查询流代理

接口地址: /api/proxy/one

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流Id	query	true	string

9.5 分页查询流代理

接口地址: /api/proxy/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

9.6 获取ffmpeg.cmd模板

接口地址: /api/proxy/ffmpeg_cmd/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
mediaServerId	流媒体ID	query	true	string

9.7 移除代理

接口地址: /api/proxy/del

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流id	query	true	string

10. 国标设备点播

10.1 结束转码

接口地址: /api/play/convertStop/{key}

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
key	视频流key	path	true	string
mediaServerId	流媒体服务ID	query	true	string

10.2 停止点播

接口地址: /api/play/stop/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channelId	通道国标编号	path	true	string

10.3 开始点播

接口地址: /api/play/start/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
channelId	通道国标编号	path	true	string

10.4 获取所有的ssrc

接口地址: /api/play/ssrc

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

10.5 获取截图,返回截图全部信息

接口地址: /api/play/snapshot

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	query	true	string
channelId	通道国标编号	query	true	string
isSubStream	是否子码流（true-子码流，false-主码流），默认为false	query	true	boolean

10.6 获取截图

接口地址: /api/play/snap

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	query	true	string
channelId	通道国标编号	query	true	string
isSubStream	是否子码流（true-子码流，false-主码流），默认为false	query	true	boolean

10.7 语音广播命令

接口地址: /api/play/broadcast/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	通道国标编号	path	true	string
channelId		path	true	string
timeout	推流超时时间(秒)	query	true	integer(int32)
broadcastMode		query	true	boolean

10.8 停止语音广播

接口地址: /api/play/broadcast/stop/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备Id	path	true	string
channelId	通道Id	path	true	string

11. 级联平台管理

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

接口地址: /api/platform/update_channel_for_gb

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "platformId": "",
    "catalogId": "",
    "all": true,
    "channelReduces": [
        {
            "id": 0,
            "channelId": "",
            "deviceId": "",
            "name": "",
            "manufacturer": "",
            "hostAddress": "",
            "subCount": 0,
            "platformId": "",
            "catalogId": ""
        }
    ]
}

11.2 保存上级平台信息

接口地址: /api/platform/save

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "id": 0,
    "enable": true,
    "name": "",
    "serverGBId": "",
    "serverGBDomain": "",
    "serverIP": "",
    "serverPort": 0,
    "deviceGBId": "",
    "deviceIp": "",
    "devicePort": 0,
    "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": "",
    "asMessageChannel": true,
    "autoPushChannel": true,
    "sendStreamIp": ""
}

11.3 编辑目录

接口地址: /api/platform/catalog/edit

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "id": "",
    "name": "",
    "platformId": "",
    "parentId": "",
    "civilCode": "",
    "businessGroupId": "",
    "childrenCount": 0,
    "type": 0
}

11.4 修改默认目录

接口地址: /api/platform/catalog/default/update

请求方式: POST

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
platformId	平台Id	query	true	string
catalogId	目录Id	query	true	string

11.5 添加目录

接口地址: /api/platform/catalog/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "id": "",
    "name": "",
    "platformId": "",
    "parentId": "",
    "civilCode": "",
    "businessGroupId": "",
    "childrenCount": 0,
    "type": 0
}

11.6 添加上级平台信息

接口地址: /api/platform/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例: 同 11.2

11.7 获取国标服务的配置

接口地址: /api/platform/server_config

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

11.8 分页查询级联平台

接口地址: /api/platform/query/{count}/{page}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	path	true	integer(int32)
count	每页条数	path	true	integer(int32)

11.9 获取级联服务器信息

接口地址: /api/platform/info/{id}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	平台国标编号	path	true	string

11.10 查询上级平台是否存在

接口地址: /api/platform/exit/{serverGBId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
serverGBId	上级平台的国标编号	path	true	string

11.11 查询上级平台是否存在

接口地址: /api/platform/channel_list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

11.12 获取目录

接口地址: /api/platform/catalog

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

11.13 删除上级平台

接口地址: /api/platform/delete/{serverGBId}

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
serverGBId	上级平台的国标编号	path	true	string

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

接口地址: /api/platform/del_channel_for_gb

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例: 同 11.1

11.15 删除关联

接口地址: /api/platform/catalog/relation/del

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例: 同 11.3

11.16 删除目录

接口地址: /api/platform/catalog/del

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	目录Id	query	true	string
platformId	平台Id	query	true	string

12. 视频流关联到级联平台

12.1 保存国标关联

接口地址: /api/gbStream/add

请求方式: POST

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例:

json

{
    "platformId": "",
    "catalogId": "",
    "all": true,
    "gbStreams": [
        {
            "gbStreamId": 0,
            "platformId": "",
            "catalogId": "",
            "app": "",
            "stream": "",
            "gbId": "",
            "name": "",
            "mediaServerId": "",
            "longitude": 0,
            "latitude": 0,
            "streamType": "",
            "status": true,
            "createTime": ""
        }
    ]
}

12.2 查询国标通道

接口地址: /api/gbStream/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

12.3 保存国标关联

接口地址: /api/gbStream/addWithGbid

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
gbId	query	true	string
platformGbId	query	true	string
catalogGbId	query	false	string

12.4 移除国标关联

接口地址: /api/gbStream/del

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded,application/json

响应数据类型: */*

接口描述:

请求示例: 同 12.1

13. 第三方服务对接

13.1 关闭发送流

接口地址: /api/rtp/send/stop

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
callId	整个过程的唯一标识，不传则使用随机端口发流	query	true	string

13.2 发送流

接口地址: /api/rtp/send/start

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
ssrc	发送流的SSRC	query	true	string
app	待发送应用名	query	true	string
stream	待发送流Id	query	true	string
callId	整个过程的唯一标识，不传则使用随机端口发流	query	true	string
isUdp	是否为UDP	query	true	boolean
dstIpForAudio	目标音频收流IP	query	false	string
dstIpForVideo	目标视频收流IP	query	false	string
dstPortForAudio	目标音频收流端口	query	false	integer(int32)
dstPortForVideo	目标视频收流端口	query	false	integer(int32)
ptForAudio	rtp的音频pt	query	false	integer(int32)
ptForVideo	rtp的视频pt	query	false	integer(int32)

13.3 开启收流和获取发流信息

接口地址: /api/rtp/receive/open

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
isSend	是否发送，false时只开启收流， true同时返回推流信息	query	true	boolean
callId	整个过程的唯一标识，为了与后续接口关联	query	true	string
stream	形成的流的ID	query	true	string
tcpMode	收流模式， 0为UDP， 1为TCP被动	query	true	integer(int32)
callBack	回调地址，如果收流超时会通道回调通知，回调为get请求，参数为callId	query	true	string
ssrc	来源流的SSRC，不传则不校验来源ssrc	query	false	string

13.4 关闭收流

接口地址: /api/rtp/receive/close

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
stream	流的ID	query	true	string

14. 第三方PS服务对接

14.1 关闭发送流

接口地址: /api/ps/send/stop

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
callId	整个过程的唯一标识，不传则使用随机端口发流	query	true	string

14.2 发送流

接口地址: /api/ps/send/start

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
ssrc	发送流的SSRC	query	true	string
dstIp	目标收流IP	query	true	string
dstPort	目标收流端口	query	true	integer(int32)
app	待发送应用名	query	true	string
stream	待发送流Id	query	true	string
callId	整个过程的唯一标识，不传则使用随机端口发流	query	true	string
isUdp	是否为UDP	query	true	boolean

14.3 开启收流和获取发流信息

接口地址: /api/ps/receive/open

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
isSend	是否发送，false时只开启收流， true同时返回推流信息	query	true	boolean
callId	整个过程的唯一标识，为了与后续接口关联	query	true	string
stream	形成的流的ID	query	true	string
tcpMode	收流模式， 0为UDP， 1为TCP被动	query	true	integer(int32)
callBack	回调地址，如果收流超时会通道回调通知，回调为get请求，参数为callId	query	true	string
ssrc	来源流的SSRC，不传则不校验来源ssrc	query	false	string

14.4 关闭收流

接口地址: /api/ps/receive/close

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
stream	流的ID	query	true	string

14.5 getTestPort

接口地址: /api/ps/getTestPort

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

15. 位置信息管理

15.1 数据位置信息格式处理

接口地址: /api/position/transform/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

15.2 订阅位置信息

接口地址: /api/position/subscribe/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

15.3 获取移动位置信息

接口地址: /api/position/realtime/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

15.4 查询设备最新位置

接口地址: /api/position/latest/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

15.5 查询历史轨迹

接口地址: /api/position/history/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

16. 视频回放

16.1 停止视频回放

接口地址: /api/playback/stop/{deviceId}/{channelId}/{stream}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

16.2 开始视频回放

接口地址: /api/playback/start/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

16.3 回放倍速播放

接口地址: /api/playback/speed/{streamId}/{speed}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

16.4 回放拖动播放

接口地址: /api/playback/seek/{streamId}/{seekTime}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

16.5 回放恢复

接口地址: /api/playback/resume/{streamId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
streamId	回放流ID	path	true	string

16.6 回放暂停

接口地址: /api/playback/pause/{streamId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
streamId	回放流ID	path	true	string

17. 媒体流相关

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

接口地址: /api/media/stream_info_by_app_and_stream

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

18. 日志管理

18.1 日志数量

接口地址: /api/log/test/count

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

18.2 分页查询日志

接口地址: /api/log/all

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

18.3 清空日志

接口地址: /api/log/clear

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数: 暂无

19. 国标录像

19.1 录像查询

接口地址: /api/gb_record/query/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

19.2 停止历史媒体下载

接口地址: /api/gb_record/download/stop/{deviceId}/{channelId}/{stream}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

19.3 开始历史媒体下载

接口地址: /api/gb_record/download/start/{deviceId}/{channelId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

19.4 获取历史媒体下载进度

接口地址: /api/gb_record/download/progress/{deviceId}/{channelId}/{stream}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

20. SSE 推送

20.1 emit

接口地址: /api/emit

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
browserId		query	true	string

21. 国标设备控制

21.1 远程启动控制命令

接口地址: /api/device/control/teleboot/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string

21.2 报警复位

接口地址: /api/device/control/reset_alarm/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

21.3 录像控制

接口地址: /api/device/control/record/{deviceId}/{recordCmdStr}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

21.4 强制关键帧

接口地址: /api/device/control/i_frame/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

21.5 看守位控制

接口地址: /api/device/control/home_position

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	query	true	string
channelId	通道国标编号	query	true	string
enabled	是否开启看守位	query	true	boolean
resetTime	自动归位时间间隔单位：秒	query	false	integer(int32)
presetIndex	调用预置位编号	query	false	integer(int32)

21.6 布防-撤防命令

接口地址: /api/device/control/guard/{deviceId}/{guardCmdStr}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	path	true	string
guardCmdStr	命令，可选值：SetGuard（布防），ResetGuard（撤防）	path	true	string

21.7 拉框缩小

接口地址: /api/device/control/drag_zoom/zoom_out

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

21.8 拉框放大

接口地址: /api/device/control/drag_zoom/zoom_in

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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)

22. 国标设备配置

22.1 设备配置查询请求

接口地址: /api/device/config/query/{deviceId}/{configType}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

22.2 基本配置设置命令

接口地址: /api/device/config/basicParam/{deviceId}

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

23. 云端录像接口

23.1 下载Zip文件

接口地址: /api/cloud/record/zip

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
query	query	false	string
app	query	false	string
stream	query	false	string
startTime	query	false	string
endTime	query	false	string
mediaServerId	query	false	string
callId	query	false	string
ids	query	false	array

23.2 查询合并任务

接口地址: /api/cloud/record/task/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app		query	false	string
stream		query	false	string
callId		query	false	string
taskId	任务Id	query	false	string
mediaServerId	流媒体ID	query	false	string
isEnd	是否结束	query	false	boolean

23.3 添加合并任务

接口地址: /api/cloud/record/task/add

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	false	string
stream	流ID	query	false	string
mediaServerId	流媒体ID	query	false	string
startTime	鉴权ID	query	false	string
endTime	鉴权ID	query	false	string
callId	鉴权ID	query	false	string
remoteHost	返回地址时的远程地址	query	false	string

23.4 获取播放地址

接口地址: /api/cloud/record/play/path

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
recordId	录像记录的ID	query	true	integer(int32)

23.5 分页查询云端录像

接口地址: /api/cloud/record/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	query	true	integer(int32)
count	每页查询数量	query	true	integer(int32)
query	检索内容	query	false	string
app	应用名	query	false	string
stream	流ID	query	false	string
startTime	开始时间(yyyy-MM-dd HH:mm:ss)	query	false	string
endTime	结束时间(yyyy-MM-dd HH:mm:ss)	query	false	string
mediaServerId	流媒体ID，置空则查询全部流媒体	query	false	string
callId	每次录像的唯一标识，置空则查询全部流媒体	query	false	string

23.6 分页查询云端录像

接口地址: /api/cloud/record/list-url

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	query	true	integer(int32)
count	每页查询数量	query	true	integer(int32)
query	检索内容	query	false	string
app	应用名	query	false	string
stream	流ID	query	false	string
startTime	开始时间(yyyy-MM-dd HH:mm:ss)	query	false	string
endTime	结束时间(yyyy-MM-dd HH:mm:ss)	query	false	string
mediaServerId	流媒体ID，置空则查询全部流媒体	query	false	string
callId	每次录像的唯一标识，置空则查询全部流媒体	query	false	string
remoteHost		query	false	string

23.7 查询存在云端录像的日期

接口地址: /api/cloud/record/date/list

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	true	string
stream	流ID	query	true	string
year	年，置空则查询当年	query	false	integer(int32)
month	月，置空则查询当月	query	false	integer(int32)
mediaServerId	流媒体ID，置空则查询全部	query	false	string

23.8 移除收藏

接口地址: /api/cloud/record/collect/delete

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	false	string
stream	流ID	query	false	string
mediaServerId	流媒体ID	query	false	string
startTime	鉴权ID	query	false	string
endTime	鉴权ID	query	false	string
callId	鉴权ID	query	false	string
recordId	录像记录的ID，用于精准精准移除一个视频文件的收藏	query	false	integer(int32)

23.9 添加收藏

接口地址: /api/cloud/record/collect/add

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
app	应用名	query	false	string
stream	流ID	query	false	string
mediaServerId	流媒体ID	query	false	string
startTime	鉴权ID	query	false	string
endTime	鉴权ID	query	false	string
callId	鉴权ID	query	false	string
recordId	录像记录的ID，用于精准收藏一个视频文件	query	false	integer(int32)

24. 报警信息管理

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

接口地址: /api/alarm/test/notify/alarm

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备国标编号	query	true	string

24.2 分页查询报警

接口地址: /api/alarm/all

请求方式: GET

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

24.3 删除报警

接口地址: /api/alarm/delete

请求方式: DELETE

请求数据类型: application/x-www-form-urlencoded

响应数据类型: */*

接口描述:

请求参数:

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

IVM 接口文档 v1.1 ​

1. ONEWO-IVM 接口文档 ​

2. 国标设备查询 ​

2.1 修改数据流传输模式 ​

2.2 导出设备通道台账 ​

2.3 更新设备信息 ​

2.4 添加设备信息 ​

2.5 更新通道信息 ​

2.6 修改通道的码流类型 ​

2.7 获取通道同步进度 ​

2.8 获取设备的订阅状态 ​

2.9 查询通道状态 ​

2.10 查询国标树 ​

2.11 查询国标树下的通道 ​

2.12 分页查询子目录通道 ​

2.13 请求截图 ​

2.14 分页查询设备通道 ​

2.15 分页查询国标设备 ​

2.16 查询国标设备 ​

2.17 同步设备通道 ​

2.18 设备状态查询 ​

2.19 分页查询通道 ​

2.20 设备报警查询 ​

2.21 移除设备 ​

3. 用户ApiKey管理 ​

3.1 重置用户ApiKey ​

3.2 备注用户ApiKey ​

3.3 启用用户ApiKey ​

3.4 停用用户ApiKey ​

3.5 添加用户ApiKey ​

3.6 分页查询用户 ​

3.7 删除用户ApiKey ​

4. 用户管理 ​

4.1 管理员修改普通用户密码 ​

4.2 修改密码 ​

4.3 管理员修改普通用户密码 ​

4.4 添加用户 ​

4.5 分页查询用户 ​

4.6 登录 ​

4.7 查询用户 ​

4.8 删除用户 ​

4.9 修改pushkey ​

5. 服务控制 ​

5.1 保存流媒体服务 ​

5.2 获取版本信息 ​

5.3 获取系统信息 ​

5.4 获取系统信息信息 ​

5.5 重启服务 ​

5.6 获取负载信息 ​

5.7 测试流媒体录像管理服务 ​

5.8 在线流媒体服务列表 ​

5.9 停止视频回放 ​

5.10 获取负载信息 ​

5.11 流媒体服务列表 ​

5.12 测试流媒体服务 ​

5.13 获取配置信息 ​

5.14 移除流媒体服务 ​

6. 角色管理 ​

6.1 添加角色 ​

6.2 查询角色 ​

6.3 删除角色 ​

7. 推流信息管理 ​

7.1 uploadChannelFile ​

7.2 中止一个推流 ​

7.3 将推流添加到国标 ​

7.4 添加推流信息 ​

7.5 推流列表查询 ​

7.6 获取推流播放地址 ​

7.7 将推流移出到国标 ​

7.8 中止多个推流 ​

8. 云台控制 ​

8.1 通用前端控制命令 ​

8.2 云台控制 ​

8.3 预置位查询 ​

9. 拉流代理 ​

9.1 保存代理 ​

9.2 停用代理 ​

9.3 启用代理 ​

9.4 查询流代理 ​

9.5 分页查询流代理 ​

IVM 接口文档 v1.1

1. ONEWO-IVM 接口文档

2. 国标设备查询

2.1 修改数据流传输模式

2.2 导出设备通道台账

2.3 更新设备信息

2.4 添加设备信息

2.5 更新通道信息

2.6 修改通道的码流类型

2.7 获取通道同步进度

2.8 获取设备的订阅状态

2.9 查询通道状态

2.10 查询国标树

2.11 查询国标树下的通道

2.12 分页查询子目录通道

2.13 请求截图

2.14 分页查询设备通道

2.15 分页查询国标设备

2.16 查询国标设备

2.17 同步设备通道

2.18 设备状态查询

2.19 分页查询通道

2.20 设备报警查询

2.21 移除设备

3. 用户ApiKey管理

3.1 重置用户ApiKey

3.2 备注用户ApiKey

3.3 启用用户ApiKey

3.4 停用用户ApiKey

3.5 添加用户ApiKey

3.6 分页查询用户

3.7 删除用户ApiKey

4. 用户管理

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

4.2 修改密码

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

4.4 添加用户

4.5 分页查询用户

4.6 登录

4.7 查询用户

4.8 删除用户

4.9 修改pushkey

5. 服务控制

5.1 保存流媒体服务

5.2 获取版本信息

5.3 获取系统信息

5.4 获取系统信息信息

5.5 重启服务

5.6 获取负载信息

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

5.8 在线流媒体服务列表

5.9 停止视频回放

5.10 获取负载信息

5.11 流媒体服务列表

5.12 测试流媒体服务

5.13 获取配置信息

5.14 移除流媒体服务

6. 角色管理

6.1 添加角色

6.2 查询角色

6.3 删除角色

7. 推流信息管理

7.1 uploadChannelFile

7.2 中止一个推流

7.3 将推流添加到国标

7.4 添加推流信息

7.5 推流列表查询

7.6 获取推流播放地址

7.7 将推流移出到国标

7.8 中止多个推流

8. 云台控制

8.1 通用前端控制命令

8.2 云台控制

8.3 预置位查询

9. 拉流代理

9.1 保存代理

9.2 停用代理

9.3 启用代理

9.4 查询流代理

9.5 分页查询流代理