公共分类
- 双师批量创建小直播间
- 账户权限
- 获取直播间直播的访问记录
- 获取直播信息接口
- 查询直播间用户进出日志
- 获取用户直播并发（每日）
- 获取所有流媒体节点信息接口
- 聊天获取被过滤敏感词
- 批量查询用户并发及使用情况
- 直播间用户进出信息
- 获取直播中录制记录
- 模板信息
- 录制状态
- 获取用户并发
- 获取用户并发v1
- 获取用户最大并发
- 获取用户并发列表
- 获取用户统计信息
- 批量获取直播的最大并发
- 获取观看直播的访问记录
连麦配置接口
- 保存/编辑连麦时长配置
- 查询直播信息
- 查询连麦时长配置
白名单验证方式
- 白名单信息查询
- 白名单信息检索
- 白名单信息添加
用量统计相关
- 账户时长余量查询
- 账户时长使用查询
- 账户时长使用详情查询
- 账户用量更新
云录制
- 查询信息
- 查询权限
- 配置云录制权限
- 查询云录制权限
- 录制开始
- 录制暂停
- 录制恢复
- 录制结束
- 查询录制信息
直播和回放并发查询
- 客户回放最大并发查询
- 客户直播最大并发查询
全局设置接口
- 客户全局礼物参数设置
- 客户全局设置参数保存
- 查询全局设置参数配置
集团账号
- 集团账号回放数据统计-统计-观看次数
- 回放地域访问数据统计
- 集团账号直播数据统计-直播记录-直播间信息查询
- 集团账号直播数据统计-直播记录-直播列表查询
- 集团账号直播数据统计-数据概览-观看统计
- 集团账号直播数据统计-数据概览-并发统计
- 集团账号回放数据统计-回放观看次数TOP100记录列表查询
- 集团账号回放数据统计-数据概览-并发统计
- 集团账号回放数据统计-数据概览-观看统计
- 回放终端访问数据统计
- 集团账号直播/回放统计信息查询
- 直播在线人数统计
- 直播终端访问数据统计
- 直播地域访问数据统计
- 回放访问量统计
- 集团账号直播数据统计
- 集团账号直播数据统计详情
- 集团账号直播基础数据查询
互动组件
- 互动组件-修改投票
- 互动组件-邀请卡获取短链接
- 互动组件-投票列表查询
- 互动组件-投票删除
- 互动组件-投票导出
- 互动组件-投票详情查询
- 互动组件-点赞配置查询
- 互动组件-邀请卡数据导出
- 互动组件-邀请卡排行详情
- 互动组件-邀请卡排行榜
- 互动组件-邀请卡基础配置查询
- 互动组件-创建投票
- 互动组件-邀请卡删除
- 互动组件-邀请卡列表
- 互动组件-邀请卡保存
- 互动组件-点赞配置编辑
- 互动组件-礼物配置查询
- 互动组件-礼物配置保存
- 互动组件-礼物特效修改
- 互动组件-礼物配置删除
- 互动组件-直播间红包列表查询
- 互动组件-直播间红包中奖人员列表查询
直播
- 直播分页列表
红包余额
- 导出红包余额交易明细
- 红包余额充值
- 红包余额提现
- 获取余额交易详情
- 获取红包余额交易明细列表
- 获取账户余额
鉴黄
- 直播-图片任务列表
- 直播-场景数量统计
直播生命周期
- 停止直播
直播
- 直播概况查询
- 直播观看记录
- 学员观看直播详情
- 直播聊天数据统计
- 直播点赞数据统计
报名观看
- 查询直播间报名观看学员信息
打赏收益
- 打赏收益-付费打赏列表
- 打赏收益-付费打赏导出
- 打赏收益-礼物提现列表查询
- 打赏收益-礼物收益提现
- 打赏收益-礼物收益查询
客户端信息上报
- 客户端信息上报查询
双语专题
- 删除专题
- 双语专题列表
- 新增（编辑）双语专题
直播带货
- 直播间-取消置顶商品
- 全局商品列表
- 删除商品
- 更新商品
- 直播间-取消推送商品
- 创建商品
- 直播间-导入商品
- 直播间-推送商品
- 直播间-移除商品
- 直播间-置顶商品
- 直播间-账户商品库列表（包含直播间导入状态）
多流直播
- 新增/编辑/删除多流直播
- 查询多流直播列表
白名单2.0
- 白名单信息单条数据插入
- 白名单信息导入
- 白名单用户信息单条数据删除
- 白名单用户信息导出
- 白名单用户信息查询
- 白名单用户信息清空
自定义表情
- 自定义表情-保存
- 自定义表情-删除
- 自定义表情-查询
回放设置
- 自动合并设置
公告
- 发布公告
- 清除公告
聊天
- 发送私聊消息
- 发送群聊消息
- 禁言单个用户
- 聊天统计查询
- 解除单个用户禁言
客户端设置
- 批量保存通用菜单
- 查询通用菜单
随堂测
- 单次随堂测提交总数
- 获取单场直播随堂测总数
- 获取学员提交的数据
- 获取随堂测数据
- 获取随堂测统计信息
- 获取随堂测静态文件信息
声网相关
- 增加声网用量
- 开启/关闭声网服务
- 获取声网统计信息
- 获取声网配置
客户
- 客户-回放-列表-查询
- 客户-直播-列表-查询
流地址
- 获取拉流地址
- 获取用户专属拉流地址
统计
- 查找用户时长使用量（按天范围统计）_copy
- 直播核心统计数据
- 查找用户带宽数据（按天范围查找）
- 查找用户带宽（一天）
- 查找用户时长使用量明细（一天）
- 查找用户时长使用量（按天范围统计）
- 用户剩余流量查询
- 查找用户时长流量使用量（支持多用户）
- 查找用户流量使用量明细（一天）
- 查找用户流量使用量（按天范围统计）
- 用户剩余时长查询
- 批量查询用户时长及使用情况
- 修改用户配置信息
抽奖
- 抽奖记录查询
账户
- 批量获取账户配置
- 更新账户配置
- 获取账户配置
直播连麦
- 保存直播连麦时长配置(覆盖模式)
- 查询用户直播连麦时长配置
自定义配置
- 配置用户自定义未登录页面
回放打点
- 删除回放打点
- 增加/编辑回放打点
- 查询回放打点列表
问卷
- 设置问卷在线导入地址
问答
- 获取直播问答数据
课件水印
- 保存课件水印配置
- 查询用户课件水印权限
- 获取课件水印配置
在线用户
- 助教端查询在线用户
- 搜索在线用户信息
- 查询直播间在线用户
多人连麦
- 增加多人连麦时长
- 多人连麦每日连麦统计
- 多人连麦每日连麦详情统计
- 多人连麦每日连麦详情统计导出
- 多人连麦直播数量统计
- 批量获取多人连麦时长配置
- 获取多人连麦时长配置
- 集团账号增加多人连麦时长
直播核心业务指标
- 数据曲线
- 用户排行（基础统计）
- 用户排行（并发统计）
- 用户统计
- 直播统计(基础统计)
回调
- 回放回调url查询
- 保存用户回调设置
- 回调查询接口(新接口)
- 设置用户回调设置(新接口)
直播间
- 查询当前用户是否被禁言
- 伪直播状态查询
- 关闭直播间
- 创建直播间
- 删除直播间
- 开启直播间
- 开启直播间禁言
- 批量修改直播间虚拟人数基数
- 批量创建转播小直播间
- 批量查询专题直播间信息
- 批量查询直播间虚拟人数基数
- 伪直播资源信息查询
- 查询直播间信息
- 直播间列表查询
- 直播间在线用户列表
- 直播间封禁列表查询（IP列表+用户列表）数据量太大时存在性能问题
- 直播间转播信息查询
- 研讨课直播间配置查询
- 编辑直播间
- 获取直播间代码
- 获取直播间信息（批量）
- 解除直播间禁言
- 转播接受直播间列表
文档功能
- 上传文档
- 创建文档上传信息
- 删除文档
- 批量上传H5课件
- 文档转码回调
- 查询文档信息
内部接口
- 查询客户APIKEY
- 直播查询
主持人
- 停止录制
- 开始录制
- 开始直播
- 恢复录制
- 暂停录制
- 结束直播
- 获取推流信息
code
- code_shibl
广播消息
- 直播间自定义消息
回放重制成视频
- 新增回放重制
- 保存用户回放重制计费配置(覆盖模式)
- 取消重置中的任务
- 合成回调接口
- 合成进度查询
- 回放重制任务列表
- 批量查新用户回放重制计费信息
- 保存用户配置
- 查询单个回放重制任务(对外开放接口)
- 查询回放重制列表(新接口用户调用)
- 查询某段时间用户回放重制统计数据
- 查询用户回放重制分辨率配置
- 用户调用接口单个或批量添加回放重制
- 获取用户配置
- 设置合成mp4账户优先级
推流信息数据监控
- 直播间流信息数据
打卡
- 打卡互动的详细信息
- 直播间打卡互动列表
- 获取打卡静态文件状态
回放
- 客户-翻页文档-列表-查询
- 删除回放
- 回放信息查询（集团账号使用）
- 回放剪辑
- 回放合并
- 回放查询
- 回放观看记录
- 回放观看记录（V2版本）
- 回放观看记录（按月查询特定回放观看记录）
- 回放观看记录（查询特定回放观看记录）
- 回放信息
- 批量查询用户回放下载信息
- 查询伪直播回放/视频状态是否正常
- 查询回放列表
- 根据回放ID查询回放信息
- 根据回放标题查询回放列表
- 根据直播间ID等条件查询回访信息
- 直播录制日志查询
- 直播间回放在线人数
- 编辑回放

LiveAPI

公共分类

双师批量创建小直播间

基本信息

Path： /api/rebroadcast-double/receiver/room/creates

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
roomInfo	object []	必须		item 类型: object
├─ roomName	string	必须
├─ authType	string	必须
count	integer	必须	直播间数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须
success	boolean	非必须

账户权限

基本信息

Path： /api/v1/account/permission

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	EFBD36DD60E3AD1E	账户ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	必须
├─ message	string	必须
data	object	必须
├─ watermarkPermission	boolean	必须	课件水印权限
├─ rebroadcastPermission	boolean	必须	转播权限；单师权限、双师权限存在1个即为true，都不存在时为false
├─ rebroadcastSingleLecturerPermission	boolean	必须	转播单师权限
├─ rebroadcastDoubleLecturerPermission	boolean	必须	转播双师权限

获取直播间直播的访问记录

基本信息

Path： /api/live/user/useraction

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	用户ID
roomId	是	直播间id
pageNum	否	每页显示的个数, 默认值为50,最大阈值为1000
pageIndex	是	页码,默认值为1
startTime	是	查询该直播时刻后进入学员的数据格式：yyyy-MM-dd HH:mm:ss 示例：2022-8-20 9：12：20
endTime	是	查询该直播时刻前进入学员的数据时间不超过1天格式：yyyy-MM-dd HH:mm:ss 示例：2022-8-20 9：12：20

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须	访问记录集合
├─ userActions	object []	非必须		item 类型: object
├─ liveId	string	必须	直播id
├─ userId	string	必须	用户id
├─ userName	string	必须	用户名
├─ userIp	string	必须	用户ip
├─ city	string	必须	城市信息
├─ enter	string	必须	进入时间
├─ leave	string	必须	离开时间
├─ watchDuration	integer	必须	观看时长
├─ terminal	string	必须	终端类型，0表示PC端，1表示移动端
├─ customInfo	string	非必须	自定义用户信息
├─ role	integer	必须	用户角色，1:主讲、推流端角色， 2:助教端角色，3:主持人角色，4:学生、观看端角色
├─ count	string	必须	总条数
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

获取直播信息接口

基本信息

Path： /api/live/info/search

Method： GET

接口描述：

默认分页50, 最大100

模板类型 1：视频 2：视频，聊天，问答 3：视频，聊天 4：视频，文档，聊天 5：视频，文档，聊天，问答 6：视频，问答

请求参数

Query

参数名称	是否必须	示例	备注
roomId	是	96CDEE621BBA8617F5EE7465F17F8398	直播间id
startTime	是	2020-02-20 00:00:00	开始日期
endTime	是	2020-02-21 00:00:00
pageSize	是		分页大小
minId	否		滚动分页id
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ lives	object []	非必须		item 类型: object
├─ roomId	string	必须	直播间id
├─ accountId	string	必须	账户id
├─ publishMode	number	必须	推流方式0:客户端推流 1:第三方推流2:回放推流3:点播推流
├─ templateType	number	必须	模板类型
├─ hostMode	number	必须	是否主持人模式 0:否 1:是
├─ startTime	string	必须	直播开始时间
├─ endTime	string	非必须	直播结束时间（未结束时没这个字段）
├─ status	number	必须	直播状态
├─ id	string	必须	直播id
├─ accountId	string	必须	账户id

查询直播间用户进出日志

基本信息

Path： /api/v2/statis/useraction

Method： GET

接口描述：

开始时间与结束时间不能大于7天

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	C783F0F7CB77E1F3	CC账户ID
roomid	是	41269B96FEA0FEF20498CE5AAF1F53F5	直播间加密ID
starttime	是	2021-06-10 13:12	开始时间,yyyy-MM-dd HH:mm或者yyyy-MM-dd HH:mm:ss
endtime	是	2021-06-10 15:12	结束时间,yyyy-MM-dd HH:mm或者yyyy-MM-dd HH:mm:ss

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
roomId	string	非必须
userActions	object []	非必须	item 类型: object
├─ userCustomInfo	string	必须
├─ userIpArea	string	必须
├─ userId	string	必须
├─ userName	string	必须
├─ userIp	string	必须
├─ userPlatform	number	必须
├─ enterTime	string	必须
├─ leaveTime	string	必须

获取用户直播并发（每日）

基本信息

Path： /api/v1/account/live/concurrency

Method： GET

接口描述：

查询时间间隔最大为2个月

若开始日期和结束日期相同，则展示结果按小时分组

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	132464	加密账户ID
startTime	是	2019-06-01T00:00:00	开始日期
endTime	是	2019-06-10T00:00:00	结束日期
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	其他信息
data	object	非必须
├─ concurrencys	object []	非必须	item 类型: object
├─ time	string	必须
├─ count	number	必须
success	boolean	非必须

获取所有流媒体节点信息接口

基本信息

Path： /api/source-node/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
sourceType	是	1	请求来源 1:流媒体
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ sourceNodes	object []	非必须		item 类型: object
├─ weight	integer	必须	权重
├─ isp	string	必须	0:双线 10:CND推流 20:Atlas推流 30:Wowza推流 100:CND录制
├─ ip	string	必须
├─ description	string	必须	描述
├─ status	integer	必须	0:正常状态 1:不可推流状态 5:不可用状态
├─ id	integer	必须

聊天获取被过滤敏感词

基本信息

Path： /api/live/chat/dirty

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
startTime	是	2022-09-19 10:40:48	yyyy-MM-dd HH:mm:ss
endTime	是	2022-09-19 10:40:48	yyyy-MM-dd HH:mm:ss
pageNo	否	1	页码
pageSize	否	50	分页条数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ chats	object []	非必须	命中脏词集合	item 类型: object
├─ userId	string	必须	学员id
├─ roomId	string	必须	直播间id
├─ userRole	integer	必须	用户角色 1:讲师 2：助教 4：学员
├─ userIp	string	必须	用户ip
├─ userName	string	必须	学员名称
├─ time	integer	必须	聊天时间（时间戳）
├─ content	string	必须	聊天内容
├─ totalCount	integer	非必须	总条数
error	object	非必须
├─ code	string	必须
├─ message	string	必须

批量查询用户并发及使用情况

基本信息

Path： /api/v1/accounts/concurrency

Method： GET

接口描述：

1.一次最多查询50个用户

2.不填写日期默认查询当月到现在的数据

3.若参数有日期，日期相隔不得超过31天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	132464,232463	账户ID，多个以 , 号分隔
startTime	否	开始日期	2019-06-01T00:00:00
endTime	否	结束日期	2019-06-01T00:00:00

返回数据

{
	"success": true,
	"data": {
		"concurrencys": [{
			"accountId": "132464",
			"total": 1000,
			"monthMax": 200
		}, {
			"accountId": "232463",
			"total": 1000,
			"monthMax": 200
		}]
	}
}

直播间用户进出信息

基本信息

Path： /api/statis/room/useraction

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	B27039502337407C	客户ID
roomid	是	862B7F999F4602159C33DC5901307461	直播间ID
starttime	是	2015-01-01 12:30:00	查询起始时间，格式：yyyy-MM-dd HH:mm:ss
endtime	是	2015-01-02 12:30:00	查询截止时间，格式：yyyy-MM-dd HH:mm:ss ，endtime和starttime相差不能超过30天
action	是	0	按进入或离开查询，0表示进入直播间，1表示离开直播间
pageindex	否	1	查询页码，默认为1
pagenum	否	50	单页所查询的数据条数，默认为50，最大阈值为1000

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须
userActions	object []	非必须		item 类型: object
├─ userId	string	非必须	用户ID
├─ userName	string	非必须	用户名称
├─ userIp	string	非必须	用户IP
├─ time	string	非必须	时间
├─ UAType	number	非必须	用户UA信息
├─ socketId	string	非必须	socketId
action	number	非必须	行为
pageIndex	number	非必须	页码
count	number	非必须	总个数

获取直播中录制记录

基本信息

Path： /api/statis/record/operation

Method： GET

接口描述：

接口时间格式为 yyyy-MM-dd HH:mm:ss
此接口支持批量查询，批量查询结果仅返回直播id与账户id存在对应关系的信息。

请求参数

Query

参数名称	是否必须	示例	备注
liveIds	是	1D52D751566002F1	多个直播id，逗号分割
accountId	是	C783F0F7CB77E1F3	客户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object []	非必须		item 类型: object
├─ liveEndTime	string	必须	直播结束时间
├─ records	object []	必须		item 类型: object
├─ recordStopTime	string	必须	录制停止时间
├─ recordId	string	必须	回放ID
├─ recordStartTime	string	必须	录制开始时间
├─ pauseLogs	object []	必须		item 类型: object
├─ relativeTime	number	必须	操作相对时间（相对于该次录制开始时间），单位：秒
├─ status	number	必须	操作类型：10:暂停/20:恢复
├─ liveStartTime	string	必须	直播开始时间
├─ liveId	string	必须	直播ID

模板信息

基本信息

Path： /api/viewtemplate/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		客户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

录制状态

基本信息

Path： /api/live/recordstatus

Method： GET

接口描述：

THQS加密

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	C0447E2889930B14	账户ID
roomid	是	000F94FA465E033A9C33DC5901307461	直播间ID
liveid	是	C0447E2889930B14	直播ID

获取用户并发

基本信息

Path： /api/statis/userconnections

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	132464,	加密账户ID
starttime	是	开始日期	2019-06-01 00:00:00
endtime	是	结束日期	2019-06-01 00:00:00
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	THQS算法所得hash值
pagenum	否	1	默认：50，每页展示记录数
pageindex	否	1	默认：1，当前页

获取用户并发v1

基本信息

Path： /api/v1/user/concurrency

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userId	是	3D2A70BCF554680D	加密账户ID
startTime	是	2019-06-01T00:00:00	开始日期
endTime	是	2019-06-10T00:00:00	结束日期
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash
pageNo	是		默认：1
pageSize	是		默认：50

获取用户最大并发

基本信息

Path： /api/statis/maxuserconnection

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	251141	账户ID
starttime	是	2019-06-01T00:00:00	开始日期
endtime	是	2019-06-10T00:00:00	结束日期
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK	mock: OK
maxConnection	integer	必须		最大并发数	mock: 10

获取用户并发列表

基本信息

Path： /api/statis/connections

Method： GET

接口描述：

提供入参：pagenum 、 pageindex 则为分页查询，否则非分页查询

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	251141	账户ID
starttime	是	2019-06-01 00:00:00	开始日期
endtime	是	2019-06-10 00:00:00	结束日期
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash
roomid	是	B6BEB22D8F23A4D59C33DC5901307461	房间id(加密)
pagenum	否	20	无默认值
pageindex	否	1	无默认值

返回数据

名称	类型	是否必须	备注	其他信息
result	string	必须	OK/FAIL
roomId	string	非必须	直播间ID
count	number	非必须	总条数
pageIndex	integer	非必须	分页页码
connections	object []	非必须	统计信息	item 类型: object
├─ time	string	必须	统计时间
├─ count	integer	必须	直播并发数
├─ replayCount	integer	必须	回放并发数
reason	string	非必须	错误信息描述

获取用户统计信息

基本信息

Path： /api/statis/userview

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	920022FE264A70C1	账户ID(加密或者不加密都可)
liveid	是	2B89287FC2805F5A	直播id(加密或者不加密都可)

返回数据

名称	类型	是否必须	备注	其他信息
liveId	string	必须	直播id(加密)
status	string	必须	统计状态：1-完成，只返回1
maxConcurrent	integer	必须	最大并发
maxConcurrentTime	string	必须	最大并发时间	mock: 2020-06-01 11:00:00
totalCount	string	必须	并发(pc+手机)
uaCount	object	必须
├─ pc	integer	必须	pc并发
├─ mobile	integer	必须	手机并发
customUaCount	object	必须	自定义UA统计信息
├─ ${activeKey}	integer	必须	可变key,value为count

批量获取直播的最大并发

基本信息

Path： /api/live/concurrent

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
liveids	是	111,222,333	直播ids(加密),多个以逗号隔开，eg ."id1, id2"
time	是	1595926987037	当前时间戳（毫秒）
hash	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	默认值	备注	其他信息
userCount	object	必须
├─ ${activeLiveId}	integer	必须		key: 直播id(加密)，value：直播的最大并发

获取观看直播的访问记录

基本信息

Path： /api/statis/live/useraction

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	用户ID
liveid	是	直播ID
pagenum	否	每页显示的个数, 默认值为50,最大阈值为1000
pageindex	是	页码,默认值为1

返回数据

名称	类型	是否必须	备注	其他信息
result	string	必须	请求是否成功。OK：成功；FAIL：失败
userEnterLeaveActions	object []	必须	访问记录集合	item 类型: object
├─ viewerId	string	非必须	用户ID
├─ viewerName	string	非必须	用户昵称
├─ viewerIp	string	非必须	用户IP
├─ city	string	非必须	用户地域
├─ enterTime	string	非必须	进入时间
├─ leaveTime	string	非必须	离开时间
├─ watchTime	number	非必须	直播观看时长
├─ terminal	number	非必须	终端类型，0表示PC端，1表示移动端
├─ customInfo	string	非必须	自定义用户信息
├─ userRole	string	非必须	用户角色，1:主讲、推流端角色， 2:助教端角色，3:主持人角色，4:学生、观看端角色
pageIndex	number	必须	当前页码
count	number	必须	总访问次数

连麦配置接口

保存/编辑连麦时长配置

基本信息

Path： /api/multivoice/config/save

Method： GET

接口描述：

   [
        {
            "id":1, 配置id(编辑必传)
            "resolution":1,分辨率  1:  640*360   2: 1280*720
            "availableType":1,时长用尽是否停用
            "addTime":1添加时长(分钟)
        }
    ]

时间单位/分钟

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
configs	是	[{"id":1,"resolution":1,"availableType":1,"addTime":1}]	时间单位/分钟
accountId	是		客户id

Body

名称	类型	是否必须	其他信息
configs	object []	非必须	item 类型: object
├─ id	integer	非必须
├─ accountId	integer	必须
├─ resolution	integer	必须
├─ totalTime	integer	必须
├─ remainTime	integer	必须
├─ available_type	integer	必须
├─ addTime	string	必须

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

查询直播信息

基本信息

Path： /api/live/search/id

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		客户id
liveId	是

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
├─ live	object	必须
├─ id	string	必须
├─ status	string	必须
├─ roomId	string	必须
├─ userId	string	必须
├─ startTime	string	必须
├─ endTime	string	必须
├─ recordVideoId	string	必须
├─ recordTime	string	必须
├─ sourceNodeId	string	必须
├─ recordVideoStatus	string	必须
├─ templateType	string	必须
├─ sourceType	string	必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

查询连麦时长配置

基本信息

Path： /api/multivoice/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		客户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ configs	object []	必须	可能为空集合	item 类型: object
├─ id	integer	非必须
├─ accountId	integer	非必须	客户Id
├─ resolution	integer	非必须	分辨率 1: 640360 2: 1280720
├─ totalTime	integer	非必须	总时长
├─ remainTime	integer	非必须	剩余时长
├─ availableType	integer	非必须	时长用尽是否停用
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

白名单验证方式

白名单信息查询

基本信息

Path： /api/liveroom/whitelist/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	148BBDAC36DAA	客户id
roomid	是	默认：0	直播间id
whitelistid	是	249	白名单id
pagenum	否		分页数量
pageindex	否		分页下标从1开始

返回数据

名称	类型	是否必须	备注	其他信息
whiteListId	number	非必须	白名单id
result	string	非必须
pageIndex	number	非必须	分页下标
count	number	非必须	总条数
whiteListUsers	object []	非必须	白名单数据	item 类型: object
├─ viewerName	string	非必须	用户名称
├─ viewerToken	string	非必须	用户密码
├─ whiteListId	number	非必须	白名单id
├─ id	number	非必须	用户id
userId	number	非必须	客户id
pageNum	number	非必须	分页数量
roomId	number	非必须	直播间id
lastUpdateTime	string	非必须	最近一次更新时间

白名单信息检索

基本信息

Path： /api/liveroom/whitelist/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	客户id
viewername	是	用户名称
whitelistid	是	白名单id
pageNum	否	分页数量
pageIndex	否	分页下标从1开始

返回数据

名称	类型	是否必须	备注	其他信息
whiteListId	number	非必须	白名单id
result	string	非必须
pageIndex	number	非必须	分页下标
count	number	非必须	总条数
whiteListUsers	object []	非必须	白名单数据	item 类型: object
├─ viewerName	string	必须	用户名称
├─ viewerToken	string	必须	用户密码
├─ whiteListId	string	必须	白名单id
├─ id	string	必须	用户id
userId	number	非必须	客户id
pageNum	number	非必须	分页数量
lastUpdateTime	string	非必须	最近一次更新时间

白名单信息添加

基本信息

Path： /api/liveroom/whitelist/add

Method： POST

接口描述：

白名单验证类型：3
参数需要：THQS加密
返回结果：
{"result":"OK","whitelistid":"479"}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例
userid	text	是	148BBDAC36D
roomid	text	是	默认：0
filename	text	是	文件名称
whitelists	text	是	[{"viewerId":"15252","viewerName":"62626","viewerToken":"151515"},{"viewerId":"552525","viewerName":"ll","viewerToken":"llll"}]
isSupportViewId	text	否	"isSupportViewId" 如果支持viewId填入此值

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须
whitelistid	string	非必须		白名单id

用量统计相关

账户时长余量查询

基本信息

Path： /api/account/duration/remaining

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	账户ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ duration	object []	必须		item 类型: object
├─ viewMode	number	必须	观看模式
├─ desc	string	必须	时长类型描述
├─ remainingDuration	number	必须	剩余时长，单位：s
error	object	必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

账户时长使用查询

基本信息

Path： /api/account/duration/usage

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	账号ID
startTime	否	2021-09-01 00:00:00	查询开始日期，默认当前月第一天
endTime	否	2021-09-30 23:29:59	查询结束日期，默认当天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ usage	object	必须
├─ domestic	object []	必须	国内	item 类型: object
├─ statDay	number	必须	统计日期
├─ standard	number	必须	标准
├─ lowLatency	number	必须	低延迟
├─ noDelay	number	必须	无延迟
├─ abroad	object []	必须	国外	item 类型: object
├─ statDay	number	必须	统计日期
├─ standard	number	必须	标准
├─ lowLatency	number	必须	低延迟
├─ noDelay	number	必须	无延迟
error	object	必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

账户时长使用详情查询

基本信息

Path： /api/account/duration/usage/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	账号ID
statDay	否	2021-09-01	查询日期，默认当天
region	否	0	默认0 0：国内 1：国外
pageNo	否	1	分页查询：当前页，默认第一页
pageSize	否	200	分页查询：每页条数，默认200条，最大500条

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ usage	object []	必须		item 类型: object
├─ roomId	string	必须	直播间ID
├─ liveId	string	必须	直播ID
├─ standard	number	必须	标准观看模式使用时长
├─ lowLatency	number	必须	低延迟观看模式使用时长
├─ noDelay	number	必须	无延迟观看模式使用时长
├─ pagination	object	必须
├─ pageNo	integer	必须	当前页码
├─ pageSize	integer	必须	每页条数
├─ pageCount	number	必须	总页数
├─ totalCount	number	必须	总条数
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

账户用量更新

基本信息

Path： /api/user/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	214045	账户ID
videobitrate	是	1	直播码率
billingmode	否	1	计费类型 0：并发 1：时长 2：流量 3.带宽
register	否	1	是否为新注册 0：否 1是
usermaxconnection	否	100	用户最大并发（单位：人）计费类型是并发计费时必须
incremental	否	1000	流量(单位：byte)
viewMode	否	[{"mode":0,"increment":1000},{"mode":1,"increment":2000},{"mode":2,"increment":0}]	每种时长类型增量对应增量 mode:0 标准 mode:1 低延迟 mode:2 无延迟

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK/FAIL
reason	string	非必须		错误原因

云录制

查询信息

基本信息

Path： /remake/find

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
type	否	查询类型 1：回放ID 2：视频ID 3：直播间ID
searchId	否	查询ID
startTime	否	开始时间，开始时间和结束时间需要同时存在
endTime	否	结束时间，开始时间和结束时间需要同时存在
pageNo	否	页码默认1
pageSize	否	每页条数默认20，最多50条
status	否	查询状态重制中0 1成功失败 -1
accountId	是	账户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	number	非必须	错误码
├─ message	string	非必须	错误信息
data	object	非必须	成功时返回
├─ pagination	object	非必须
├─ pageNo	number	非必须	当前页码
├─ pageSize	number	非必须	每页大小
├─ totalCount	number	非必须	总条数
├─ pageCount	number	非必须	总页数
├─ remakes	object []	非必须		item 类型: object
├─ recordId	string	必须	加密回放id
├─ title	string	必须	回放名称
├─ roomId	string	必须	加密直播间id
├─ status	integer	必须	1成功，0失败 -1重置中
├─ startTime	string	必须	重置开始时间
├─ duration	integer	非必须	视频时长，单位秒
├─ videoId	string	非必须	加密视频id

查询权限

基本信息

Path： /remake/access

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	是否成功
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述
data	object	非必须	正确时返回
├─ accountId	string	必须	账户id
├─ access	integer	必须	1：有权限 0：无权限

配置云录制权限

基本信息

Path： /cloud/record/permission/config

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
accountId	string	必须		账户id
permission	integer	必须		0没有权限 1有权限

返回数据

名称	类型	是否必须	备注
success	boolean	必须	正确时返回true，错误时返回false
error	object	非必须	错误时返回
├─ code	integer	非必须	错误码
├─ message	string	非必须	错误信息
data	object	非必须	正确时返回
├─ accountId	string	必须	账户id

查询云录制权限

基本信息

Path： /cloud/record/access/find

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	是否成功
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述
data	object	非必须	正确时返回
├─ accountId	string	必须	账户id
├─ access	integer	必须	1：有权限 0：无权限

录制开始

基本信息

Path： /api/cloud/record/start

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
accountId	string	必须	账户id
resolutionType	integer	非必须	录制分辨率类型默认4 :1080p，1: 360p 2: 480p 3:720p 4:1080p 5:2k
recordURL	string	必须	录制地址
callbackURL	string	必须	回调地址

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述信息
data	object	非必须	成功时返回
├─ taskId	string	非必须	任务id

录制暂停

基本信息

Path： /api/cloud/record/pause

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
accountId	string	必须		账户id
taskId	string	必须		任务id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述信息
data	object	非必须	成功时返回
├─ taskId	string	非必须	任务id

录制恢复

基本信息

Path： /api/cloud/record/resume

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
accountId	string	必须		账户id
taskId	string	必须		任务id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述信息
data	object	非必须	成功时返回
├─ taskId	string	非必须	任务id

录制结束

基本信息

Path： /api/cloud/record/stop

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
accountId	string	必须		账户id
taskId	string	必须		任务id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	integer	非必须	状态码
├─ message	string	非必须	错误描述信息
data	object	非必须	成功时返回
├─ taskId	string	非必须	任务id

查询录制信息

基本信息

Path： /api/cloud/record/find.do

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户id
startTime	否	开始时间，开始时间和结束时间需要同时存在格式：yyyy-MM-dd HH:mm:ss ，最大查询时间间隔31天内
endTime	否	结束时间，开始时间和结束时间需要同时存在格式：yyyy-MM-dd HH:mm:ss，最大查询时间间隔31天内
pageNo	否	页码默认1
pageSize	否	每页条数默认20，最多50条
status	否	查询状态录制中:0 暂停:1 转码中:2 成功:3 失败:4
taskId	否	任务id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	成功true 失败false
error	object	非必须	错误时返回
├─ code	number	非必须	错误码
├─ message	string	非必须	错误信息
data	object	非必须	成功时返回
├─ pagination	object	非必须
├─ pageNo	number	非必须	当前页码
├─ pageSize	number	非必须	每页大小
├─ totalCount	number	非必须	总条数
├─ records	object []	非必须		item 类型: object
├─ taskId	string	必须	任务id
├─ status	integer	必须	查询状态录制中:0 暂停:1 转码中:2 成功:3 失败:4
├─ startTime	string	必须	录制开始时间
├─ endTime	string	必须	录制结束时间
├─ duration	integer	非必须	视频时长，单位秒
├─ videoId	string	非必须	加密视频id
├─ downloadUrl	string	非必须	下载链接
├─ totalUseDuration	integer	必须	总使用时长
├─ totalUseCount	integer	必须	总使用任务数

直播和回放并发查询

客户回放最大并发查询

基本信息

Path： /api/user/replay/concurrent

Method： GET

接口描述：

1.如果startDate和endDate值相同,返回date格式为yyyy-MM-dd HH 按小时统计
2.如果startDate和endDate值不同,返回date格式为yyyy-MM-dd 按天统计
3.时间范围最大31天

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	A08AA80B32A8724B	账户ID
startDate	是	2021-10-08	开始时间,yyyy-MM-dd 时间范围最大31天
endDate	是	2021-10-09	结束时间,yyyy-MM-dd 时间范围最大31天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ concurrents	object []	非必须		item 类型: object
├─ date	string	必须	日期
├─ concurrent	number	必须	每日天或每小时的最大并发
error	object	非必须
├─ code	number	必须
├─ message	string	必须

客户直播最大并发查询

基本信息

Path： /api/user/live/concurrent

Method： GET

接口描述：

1.如果startDate和endDate值相同,返回date格式为yyyy-MM-dd HH 按小时统计
2.如果startDate和endDate值不同,返回date格式为yyyy-MM-dd 按天统计
3.时间范围最大31天

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	A08AA80B32A8724B	账户ID
startDate	是	2021-10-08	开始时间,yyyy-MM-dd 时间范围最大31天
endDate	是	2021-10-09	结束时间,yyyy-MM-dd 时间范围最大31天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ concurrents	object []	必须		item 类型: object
├─ date	string	必须	日期
├─ concurrent	number	必须	每天或每小时最大并发
error	object	非必须
├─ code	number	必须
├─ message	string	必须

全局设置接口

客户全局礼物参数设置

基本信息

Path： /api/global/gift/setting/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户id
globalGiftSwitch	是		礼物全局开关 0 关闭 1 开启

Body

名称	类型	是否必须	默认值	备注	其他信息
giftSpecialEffects	integer	必须		礼物开关 0关闭 1开启

返回数据

名称	类型	是否必须	备注
result	boolean	必须
error	object	非必须	错误时返回
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

客户全局设置参数保存

基本信息

Path： /api/room/global/setting/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
accountId	text	是	客户id
templateVersion	text	是	1: 老模板 2:新模板
skinId	text	是	皮肤Id
skinName	text	是	皮肤名称
skinBgImg	text	是	背景图
skinBgColor	text	是	皮肤颜色
skinMarginTop	text	是	上边距
skinLoginPcBgImg	text	否	PC登录页背景图
skinLoginMobileBgImg	text	否	移动登录页背景图
globalVideoLogoSwitch	text	是	视频logo开关
img	text	是	图片地址
position	text	是	位置

返回数据

名称	类型	是否必须	默认值	备注	其他信息

查询全局设置参数配置

基本信息

Path： /api/room/global/setting

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	账号id	内部使用，解密账号id

返回数据

名称	类型	是否必须	备注
result	string	非必须
globalSetting	object	非必须
├─ accountId	number	非必须
├─ skin	object	非必须	皮肤配置
├─ bgImg	string	非必须
├─ bgColor	string	非必须
├─ marginTop	number	非必须
├─ skinId	string	非必须
├─ skinName	string	非必须
├─ loginPcBgImg	string	非必须
├─ loginMobileBgImg	string	非必须
├─ templateVersion	number	非必须
├─ videoLogo	object	非必须	视频logo配置
├─ position	number	非必须
├─ globalVideoLogoSwitch	number	非必须
├─ img	string	非必须
├─ gift	object	非必须	礼物配置
├─ giftSwitch	number	非必须	全局礼物开关
├─ specialEffects	number	非必须	礼物特效特效，1：左侧显示，2：居中显示

集团账号

集团账号回放数据统计-统计-观看次数

基本信息

Path： /api/group/replay/pv

Method： GET

接口描述：

查询范围最大跨度为365天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ statistic	object []	必须		item 类型: object
├─ date	integer	必须	日期
├─ uv	integer	必须	观看人数
├─ replayCount	integer	必须	直播场次
├─ pv	integer	必须	观看次数
├─ replayCount	integer	必须	回放个数
├─ pv	integer	必须	观看次数
├─ uv	integer	必须	观看人数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放地域访问数据统计

基本信息

Path： /api/replay/region/viewer/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id,加密id，thqs加密访问
replayId	是		回放id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须	正确时返回
├─ statistic	object	必须
├─ replayId	string	必须	回放ID
├─ total	integer	必须	总观看次数
├─ pc	integer	必须	pc端观看次数
├─ mobile	integer	必须	移动端观看次数
├─ totalStatistic	object []	非必须	所有端统计	item 类型: object
├─ province	string	必须	省份
├─ city	string	必须	城市
├─ count	integer	必须	观看人数
├─ pcStatistic	object []	必须	PC端统计	item 类型: object
├─ province	string	非必须	省份
├─ city	string	非必须	城市
├─ count	integer	非必须	观看人数
├─ mobileStatistic	object []	必须	移动端统计	item 类型: object
├─ province	string	非必须	省份
├─ city	string	非必须	城市
├─ count	integer	非必须	观看人数
error	object	非必须	错误时返回
├─ code	integer	必须
├─ message	string	必须

集团账号直播数据统计-直播记录-直播间信息查询

基本信息

Path： /api/group/room

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
roomIds	是	18D7601F211856029C33DC5901307461,DDA6863D4B48A9CA9C33DC5901307461	直播间ID,多个账号ID之间按逗号,分割

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ rooms	object []	必须		item 类型: object
├─ accountId	string	必须	账号ID
├─ id	string	必须	直播间ID
├─ name	string	必须	直播间名称
├─ templateType	integer	必须	模板类型
├─ authType	integer	必须	登录验证类型
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号直播数据统计-直播记录-直播列表查询

基本信息

Path： /api/group/live

Method： GET

接口描述：

查询范围最大跨度为365天
按直播结束时间倒序排列，若直播未结束，则列表中查询不到该场直播信息。
非正常直播（剪辑，合并，上传，迁移）生成的直播，最大并发数，观看人数，观看次数都为0

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
pageNo	否	1	分页页码，默认第一页
pageSize	否	200	分页每页条数，默认每页200条,最大每页1000条

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ lives	object []	必须		item 类型: object
├─ accountId	string	必须	账号ID
├─ id	string	必须	直播ID
├─ roomId	string	必须	直播间ID
├─ startTime	string	必须	直播开始时间
├─ endTime	string	必须	直播结束时间
├─ duration	string	必须	直播时长
├─ maxConcurrency	integer	必须	最大并发数
├─ viewerCount	integer	必须	观看人数
├─ watchCount	integer	必须	观看次数
├─ pagination	object	必须	分页信息
├─ totalCount	integer	必须	总条数
├─ pageCount	integer	必须	总页数
├─ pageNo	integer	必须	当前页
├─ pageSize	integer	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号直播数据统计-数据概览-观看统计

基本信息

Path： /api/group/live/viewer

Method： GET

接口描述：

查询范围最大跨度为365天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
aggregate	是	1	0:不分组统计，1：按小时统计 2：按天统计

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ statistic	object []	必须		item 类型: object
├─ date	integer	必须	日期
├─ viewerCount	integer	必须	观看人数
├─ liveCount	integer	必须	直播场次
├─ watchCount	integer	必须	观看次数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号直播数据统计-数据概览-并发统计

基本信息

Path： /api/group/live/concurrency

Method： GET

接口描述：

查询范围最大跨度为365天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
aggregate	是	1	0:不分组统计，1：按小时统计 2：按天统计

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ concurrency	object []	必须		item 类型: object
├─ date	string	必须	最大并发时间
├─ maxConcurrency	integer	必须	最大并发数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号回放数据统计-回放观看次数TOP100记录列表查询

基本信息

Path： /api/group/replay/watch/rank

Method： GET

接口描述：

查询范围最大跨度为366天
按回放观看次数倒序排列，若回放不可用，则列表中查询不到该场回放信息。

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
pageNo	否	1	分页页码，默认第一页
pageSize	否	20	分页每页条数，默认每页20条,最大每页1000条

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ replays	object []	必须		item 类型: object
├─ accountId	string	必须	账号ID
├─ id	string	必须	回放ID
├─ title	string	必须	回放名称
├─ startTime	string	必须	回放开始时间
├─ endTime	string	必须	回放结束时间
├─ duration	string	必须	回放时长
├─ maxConcurrency	integer	必须	最大并发数
├─ viewerCount	integer	必须	观看人数
├─ watchCount	integer	必须	观看次数
├─ pagination	object	必须	分页信息
├─ totalCount	integer	必须	总条数
├─ pageCount	integer	必须	总页数
├─ pageNo	integer	必须	当前页
├─ pageSize	integer	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号回放数据统计-数据概览-并发统计

基本信息

Path： /api/group/replay/concurrency

Method： GET

接口描述：

查询范围最大跨度为365天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	admin账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ statistic	object	必须
├─ maxConcurrency	integer	必须	查询时段内最大并发数
├─ detail	object []	必须	详情	item 类型: object
├─ date	string	必须	查询时段内每日日期
├─ concurrency	integer	必须	查询时段内每日最大并发
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号回放数据统计-数据概览-观看统计

基本信息

Path： /api/group/replay/viewer

Method： GET

接口描述：

查询范围最大跨度为365天

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期（必须为YYYY-MM-DD HH:mm:ss时间格式）
endTime	是	2021-10-21 23:59:59	查询结束日期（必须为YYYY-MM-DD HH:mm:ss时间格式）

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	必须
├─ statistic	object	必须
├─ replayCount	integer	必须	回放总个数
├─ pv	integer	必须	总观看次数
├─ uv	integer	必须	总观看人数
├─ detail	object	必须	详情
├─ date	string	必须	统计日期
├─ uv	string	必须	观看人数
├─ pv	string	必须	观看次数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放终端访问数据统计

基本信息

Path： /api/replay/terminal/viewer/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id,加密id，thqs加密访问
replayId	是		回放id

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息
data	object	非必须
├─ statistic	object	必须
├─ replayId	string	必须	回放ID
├─ totalCount	integer	必须	总观看次数
├─ pc	object	必须	pc端统计信息
├─ total	string	必须	总观看次数
├─ webPage	integer	必须	web 非sdk观看次数
├─ webSdk	integer	必须	web sdk观看次数
├─ mobile	object	必须	移动端统计信息
├─ total	integer	必须	总观看次数
├─ h5Page	integer	必须	h5移动端观看次数
├─ h5Sdk	integer	必须	h5 SDK观看次数
├─ android	integer	必须	android观看次数
├─ ios	integer	必须	ios端观看次数
├─ wx	integer	必须	微信观看次数

集团账号直播/回放统计信息查询

基本信息

Path： /api/group/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
type	否	0	查询类型： 0 直播（默认） 1 回放
startTime	是	2021-01-10 00:00:00	查询开始日期
endTime	是	2021-02-10 00:00:00	查询结束日期
statType	是	2	查询时间类型 0：按年查询 1：按月查询 2：按天查询

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
├─ maxConcurrency	integer	必须	最大并发数
├─ details	object	必须
├─ statDate	string	必须	日期
├─ viewerCount	string	必须	观看人数
├─ watchCount	string	必须	观看次数
├─ maxConcurrency	string	必须	最大并发数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

直播在线人数统计

基本信息

Path： /api/live/connections

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id,加密id，thqs加密访问
liveId	是		直播id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须	错误时返回
├─ code	integer	非必须	错误码
├─ message	string	非必须	错误信息
data	object	非必须	正确时返回
├─ statistic	object	必须
├─ liveId	string	必须	直播ID
├─ startTime	string	必须	直播开始时间，格式yyyy-MM-dd HH:mm:ss
├─ stopTime	string	必须	直播结束时间格式yyyy-MM-dd HH:mm:ss
├─ maxConcurrency	string	必须	最大在线人数
├─ maxConcurrencyTime	string	必须	最大在线人数时间
├─ concurrency	object []	必须		item 类型: object
├─ time	string	必须	时间
├─ concurrency	integer	必须	在线人数

直播终端访问数据统计

基本信息

Path： /api/live/terminal/viewer/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id,加密id，thqs加密访问
liveId	是		直播id

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息
data	object	非必须
├─ statistic	object	必须
├─ liveId	string	必须	直播ID
├─ totalCount	integer	必须	总观看次数
├─ pc	object	必须	pc端统计信息
├─ total	string	必须	总观看次数
├─ webPage	integer	必须	web 非sdk观看次数
├─ webSdk	integer	必须	web sdk观看次数
├─ mobile	object	必须	移动端统计信息
├─ total	integer	必须	总观看次数
├─ h5Page	integer	必须	h5移动端观看次数
├─ h5Sdk	integer	必须	h5 SDK观看次数
├─ android	integer	必须	android观看次数
├─ ios	integer	必须	ios端观看次数
├─ wx	integer	必须	微信观看次数

直播地域访问数据统计

基本信息

Path： /api/live/region/viewer/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id,加密id，thqs加密访问
liveId	是		直播id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须	正确时返回
├─ statistic	object	必须
├─ liveId	string	必须	直播ID
├─ total	integer	必须	总观看次数
├─ pc	integer	必须	pc端观看次数
├─ mobile	integer	必须	移动端观看次数
├─ totalStatistic	object []	非必须	所有端统计	item 类型: object
├─ province	string	必须	省份
├─ city	string	必须	城市
├─ count	integer	必须	观看人数
├─ pcStatistic	object []	必须	PC端统计	item 类型: object
├─ province	string	非必须	省份
├─ city	string	非必须	城市
├─ count	integer	非必须	观看人数
├─ mobileStatistic	object []	必须	移动端统计	item 类型: object
├─ province	string	非必须	省份
├─ city	string	非必须	城市
├─ count	integer	非必须	观看人数
error	object	非必须	错误时返回
├─ code	integer	必须
├─ message	string	必须

回放访问量统计

基本信息

Path： /api/replay/view/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户id,非加密id，thqs加密访问
replayId	是	回放id
startTime	是	格式：yyyy-MM-dd HH:mm:ss ，最大40天
endTime	是	格式：yyyy-MM-dd HH:mm:ss ，最大40天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须	错误时返回
├─ code	number	必须	错误码
├─ message	string	必须	错误描述
data	object	非必须	正确时返回
├─ statistic	object	必须
├─ replayId	string	必须	回放ID
├─ maxViewCount	integer	必须	该时间段最大观看次数
├─ maxViewCountTime	string	必须	最大观看次数所在的时间
├─ viewerStatistic	object []	必须		item 类型: object
├─ time	string	必须	时间，跨越1天返回格式yyyy-MM-dd ，当天返回格式 yyyy-MM-dd n 00<=n<=23 )
├─ total	integer	必须	总观看人数
├─ pc	integer	必须	pc端观看人数
├─ mobile	integer	必须	移动端观看人数

集团账号直播数据统计

基本信息

Path： /api/group/whole/live/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期
endTime	是	2021-10-21 23:59:59	查询结束日期

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
├─ liveCount	integer	必须	直播场次
├─ watchCount	integer	必须	观看次数
├─ userCount	integer	必须	观看人数
├─ maxConcurrency	integer	必须	最大并发数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号直播数据统计详情

基本信息

Path： /api/group/whole/live/statistic/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期
endTime	是	2021-10-21 23:59:59	查询结束日期

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object []	非必须		item 类型: object
├─ date	string	必须	时间
├─ viewerCount	integer	必须	观看人数
├─ liveCount	integer	必须	直播场次
├─ watchCount	integer	必须	观看次数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

集团账号直播基础数据查询

基本信息

Path： /api/group/base/live/statistic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	3848DB3FB422057F,4848DB3FB422057D	集团账号ID,多个账号ID之间按逗号,分割
startTime	是	2021-10-01 00:00:00	查询开始日期
endTime	是	2021-10-21 23:59:59	查询结束日期
pageNo	是	1	分页页码
pageSize	是	20	每页条数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
datas	object	必须
├─ lives	object []	必须		item 类型: object
├─ liveId	string	必须	直播ID
├─ roomId	string	必须	直播间ID
├─ maxConcurrency	integer	必须	最大并发数
├─ viewerCount	integer	必须	观看人数
├─ watchCount	integer	必须	观看次数
├─ startTime	string	必须	直播开始时间
├─ endTime	string	必须	直播结束时间
├─ duration	string	必须	直播时长
├─ accountId	string	必须	账户ID
├─ pagination	object	必须
├─ pageNo	string	必须	当前页码
├─ pageSize	string	必须	每页条数
├─ pageCount	string	必须	数据总页数
├─ totalCount	string	必须	数据总条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

互动组件

互动组件-修改投票

基本信息

Path： /api/vote/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

Body

名称	类型	是否必须	备注	其他信息
activityId	string	必须	投票活动ID
accountId	string	必须	账号ID
roomId	string	必须	直播间ID
title	string	必须	投票标题
endTime	string	必须	截止时间
themeColor	integer	必须	主题色:1.白色 2.绿色 3红色 4橙色 5蓝色
showBanner	integer	必须	是否显示banner 0 不显示 1 显示
voteForm	integer	必须	投票形式 1.图文 2.文字
voteType	integer	必须	选项类型 1.单选 2.多选
voteLimit	integer	必须	多选限制 0不限制
bannerUrl	string	非必须	banner图地址
showResult	integer	必须	显示结果 0不显示 1显示
voteOptions	object []	必须	选项	item 类型: object
├─ optionDesc	string	必须	选项描述
├─ optionUrl	string	必须	选项图片地址

返回数据

名称	类型	是否必须	备注
data	object	非必须
success	boolean	必须
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-邀请卡获取短链接

基本信息

Path： /api/invitation/short/url

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

Body

名称	类型	是否必须	备注
accountId	string	必须	账号ID
roomId	string	必须	直播间ID
originUrl	string	必须	原始链接

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ shortUrl	string	必须	短链接
├─ qrCodeUrl	string	必须	二维码
error	object	非必须	错误信息
├─ code	integer	非必须	错误码
├─ message	string	非必须	提示信息

互动组件-投票列表查询

基本信息

Path： /api/vote/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
pageNo	是	1	页码默认1
pageSize	是	20	分页大小默认20

返回数据

名称	类型	是否必须	备注	其他信息
data	object	非必须
├─ votes	object []	非必须	投票数据	item 类型: object
├─ activityId	string	必须	投票活动ID
├─ createTime	string	必须	创建时间
├─ endTime	string	必须	截止时间
├─ showResult	integer	必须	显示结果 0不显示 1显示
├─ status	integer	必须	状态: 0未开始 1.投票中 2.已结束
├─ title	string	必须	投票标题
├─ voteCount	integer	必须	参与人数
├─ pagination	object	非必须	分页
├─ total	integer	必须	总数
├─ pageNo	integer	必须	当前页
├─ pageSize	integer	必须	每页条数
success	boolean	非必须	true:返回data数据 false:返回error
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-投票删除

基本信息

Path： /api/vote/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
activityId	是	C783F0F7C	投票活动ID

返回数据

名称	类型	是否必须	备注
data	object	非必须
success	boolean	必须
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-投票导出

基本信息

Path： /api/vote/export

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
activityId	是	C783F0F7C	投票活动ID

返回数据

名称	类型	是否必须	备注	其他信息
data	object []	非必须		item 类型: object
├─ userId	string	必须	用户ID
├─ username	string	必须	用户昵称
├─ selectedOptionIds	string	必须	选项ID, 多个选项逗号分割
├─ createTime	string	必须	投票时间
success	boolean	必须
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-投票详情查询

基本信息

Path： /api/vote/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
activityId	是	0F7CB77E1F3	活动id

返回数据

名称	类型	是否必须	备注	其他信息
data	object	非必须
├─ status	integer	必须	状态: 0未开始 1.投票中 2.已结束
├─ activityId	string	必须	投票活动ID
├─ themeColor	integer	必须	主题色:1.白色 2.绿色 3红色 4橙色 5蓝色
├─ showBanner	integer	必须	显示banner
├─ voteForm	integer	必须	投票形式1.图文 2.文字
├─ voteType	integer	必须	选项类型 1.单选 2.多选
├─ voteLimit	integer	必须	多选限制 0为不限制
├─ showResult	integer	必须	显示结果 0不显示 1显示
├─ voteOptions	object []	必须	投票选项	item 类型: object
├─ count	integer	必须	选择人数
├─ id	integer	必须	选项id
├─ optionUrl	string	必须	选项图片地址
├─ optionDesc	string	必须	选项描述
├─ probability	integer	必须	选择比例
├─ selected	boolean	必须	是否选择
├─ endTime	string	必须	截止时间
├─ createTime	string	必须	创建时间
├─ title	string	必须	投票标题
├─ voteCount	integer	必须	参与人数
├─ bannerUrl	string	必须	banner图片地址
success	boolean	必须	true:返回data数据 false:返回error
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-点赞配置查询

基本信息

Path： /api/like/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ config	object	非必须
├─ activityId	string	非必须	活动ID
├─ basicTimes	integer	非必须	基础倍数
├─ basicNumbers	integer	非必须	基础人数
error	object	必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

互动组件-邀请卡数据导出

基本信息

Path： /api/invitation/rank/export

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
size	否	2000	导出最大条数（最大20000）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ detail	object []	必须	排行榜详情	item 类型: object
├─ accountId	string	必须	账号ID
├─ roomId	string	必须	直播间ID
├─ fromUserId	string	必须	邀请人ID
├─ fromUsername	string	必须	邀请人名称
├─ fromHeadUrl	string	必须	邀请人头像
├─ toUserId	string	必须	被邀请ID
├─ toUsername	string	必须	被邀请名称
├─ toHeadUrl	string	必须	被邀请头像
├─ deviceType	string	必须	设备类型
├─ area	string	必须	地区
├─ ipAddress	string	必须	ip地址
├─ createTime	string	必须	邀请时间
├─ id	string	必须	ID
├─ rank	object []	必须	排行榜	item 类型: object
├─ fromUserId	string	必须	邀请人id
├─ fromUsername	string	必须	邀请人名称
├─ fromHeadUrl	string	必须	头像
├─ count	integer	必须	邀请人数
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-邀请卡排行详情

基本信息

Path： /api/invitation/rank/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
pageNo	是	1	页码默认1
pageSize	是	20	分页大小默认20
fromUserId	是	C783F0F7CB77E1F3	邀请人id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ pagination	object	非必须	分页
├─ pageNo	integer	必须	页码
├─ total	integer	必须	总条数
├─ pageSize	integer	必须	分页大小
├─ rankDetails	object []	非必须	详情列表	item 类型: object
├─ accountId	string	必须	账号ID
├─ roomId	string	必须	直播间ID
├─ fromUserId	string	必须	邀请人ID
├─ fromUsername	string	必须	邀请人名称
├─ fromHeadUrl	string	必须	邀请人头像
├─ toUserId	string	必须	被邀请ID
├─ toUsername	string	必须	被邀请名称
├─ toHeadUrl	string	必须	被邀请头像
├─ deviceType	string	必须	设备类型
├─ area	string	必须	地区
├─ ipAddress	string	必须	ip地址
├─ createTime	string	必须	邀请时间
├─ id	string	必须	ID
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-邀请卡排行榜

基本信息

Path： /api/invitation/rank

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
pageNo	是	1	页码默认1
pageSize	是	20	分页大小默认20

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ pagination	object	非必须	分页
├─ pageNo	integer	必须	页码
├─ total	integer	必须	总条数
├─ pageSize	integer	必须	分页大小
├─ ranks	object []	非必须	排行榜列表	item 类型: object
├─ fromUserId	string	必须	邀请人id
├─ fromUsername	string	必须	邀请人名称
├─ fromHeadUrl	string	必须	头像
├─ count	integer	必须	邀请人数
├─ self	boolean	必须	是否自己
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-邀请卡基础配置查询

基本信息

Path： /api/invitation/card/default/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ layouts	object []	非必须	默认布局	item 类型: object
├─ name	string	必须	布局模板名称
├─ content	string	必须	布局模板内容
├─ id	integer	必须	布局模板ID
├─ backgrounds	object []	非必须	默认背景图	item 类型: object
├─ url	string	必须	背景图地址
├─ id	integer	必须	背景图ID
├─ thumbnail	string	必须	略缩图
error	object	非必须	错误信息
├─ code	integer	非必须	错误码
├─ message	string	非必须	提示信息

互动组件-创建投票

基本信息

Path： /api/vote/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

Body

名称	类型	是否必须	备注	其他信息
accountId	string	必须	账号ID
roomId	string	必须	直播间ID
title	string	必须	投票标题
endTime	string	必须	截止时间
themeColor	integer	必须	主题色:1.白色 2.绿色 3红色 4橙色 5蓝色
showBanner	integer	必须	是否显示banner 0 不显示 1 显示
voteForm	integer	必须	投票形式 1.图文 2.文字
voteType	integer	必须	选项类型 1.单选 2.多选
voteLimit	integer	必须	多选限制 0不限制
bannerUrl	string	非必须	banner图地址
showResult	integer	必须	显示结果 0不显示 1显示
voteOptions	object []	必须	选项	item 类型: object
├─ optionDesc	string	必须	选项描述
├─ optionUrl	string	必须	选项图片地址

返回数据

名称	类型	是否必须	备注
data	object	非必须
├─ activityId	string	非必须	投票活动ID
success	boolean	必须	true:返回data数据 false:返回error
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-邀请卡删除

基本信息

Path： /api/invitation/card/del

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
id	是	1001	邀请卡Id

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
error	object	非必须	错误信息
├─ code	integer	非必须	错误码
├─ message	string	非必须	提示信息

互动组件-邀请卡列表

基本信息

Path： /api/invitation/card/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ showHead	integer	非必须	邀请人头像 0 不显示 1显示
├─ showName	integer	非必须	邀请人昵称 0 不显示 1显示
├─ showTime	integer	非必须	时间 0 不显示 1显示
├─ showRank	integer	非必须	排行榜 0 不显示 1显示
├─ watermark	string	非必须	水印
├─ showWatermark	integer	非必须	水印 0 不显示 1显示
├─ title	string	非必须	标题
├─ showTitle	integer	非必须	标题 0 不显示 1跟随直播间 2自定义
├─ description	string	非必须	自定义简介内容
├─ showDesc	integer	非必须	简介 0 不显示 1跟随直播间 2自定义
├─ invitationCards	object []	非必须		item 类型: object
├─ layoutId	integer	必须	布局ID
├─ backUrl	string	必须	背景图地址
├─ thumbnail	string	必须	缩略图地址
├─ id	integer	必须	邀请卡ID
├─ id	integer	非必须	邀请卡内容ID
error	object	非必须	错误信息
├─ code	integer	非必须	错误码
├─ message	string	非必须	提示信息

互动组件-邀请卡保存

基本信息

Path： /api/invitation/card/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

Body

名称	类型	是否必须	备注
accountId	string	必须	账号ID
roomId	string	必须	直播间ID
invitationCard	object	必须	邀请卡
├─ id	integer	非必须	邀请卡id 不传：创建传递：修改
├─ layoutId	integer	必须	布局ID
├─ backUrl	string	必须	背景图
├─ thumbnail	string	必须	背景图缩略图
invitationContent	object	非必须	内容
├─ showHead	integer	必须	头像
├─ showName	integer	必须	名称
├─ showTime	integer	必须	时间
├─ showRank	integer	必须	排行榜
├─ watermark	string	必须	水印内容
├─ showWatermark	integer	必须	水印
├─ title	string	必须	自定义标题
├─ showTitle	integer	必须	标题
├─ description	string	必须	自定义简介
├─ showDesc	integer	必须	简介
├─ id	integer	必须	内容ID

返回数据

名称	类型	是否必须	备注
data	object	非必须
├─ activityId	string	非必须	投票活动ID
success	boolean	必须	true:返回data数据 false:返回error
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-点赞配置编辑

基本信息

Path： /api/like/config/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	3848DB3FB422057F	账号id
roomId	是		直播间id

Body

名称	类型	是否必须	备注
basicTimes	integer	必须	基礎倍數
basicNumbers	integer	必须	基础人数
activityId	string	必须	活动id

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	非必须
├─ config	object	必须
├─ activityId	string	必须	活动ID
├─ basicTimes	integer	必须	基础倍数
├─ basicNumbers	integer	必须	基础人数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误描述

互动组件-礼物配置查询

基本信息

Path： /api/gift/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
pageNo	否	1	页码默认为1
pageSize	否	20	每页大小，默认为20，最大值为50 当传入大于50的值时，按照每页50条处理

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ pagination	object	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ total	number	非必须
├─ data	object []	非必须		item 类型: object
├─ id	number	必须	礼物id
├─ giftName	string	必须	礼物名字
├─ giftThumbnail	string	必须	礼物图片url
├─ giftDefault	number	必须	是否是默认礼物 1 是 0 否
├─ giftStatus	number	必须	礼物状态 0@禁用 1@启用默认为启用
├─ price	number	必须	礼物价格
├─ specialEffects	string	必须	礼物特效 1@左侧显示 2@居中显示
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

互动组件-礼物配置保存

基本信息

Path： /api/gift/config/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id

Body

名称	类型	是否必须	备注
giftName	string	必须	礼物名
giftThumbnail	string	必须	礼物图片
giftStatus	integer	必须	状态 0@禁用 1@启用默认为启用
price	integer	必须	礼物金额单位分
id	string	非必须	礼物id，如果为修改，该值必传

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	非必须
├─ giftId	string	必须	礼物id
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误描述

互动组件-礼物特效修改

基本信息

Path： /api/gift/effects/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
accountId	是		账号id
specialEffects	是		礼物特效 1@左侧显示 2@居中显示

返回数据

名称	类型	是否必须	备注
success	boolean	必须	是否操作成功
error	object	非必须	错误时显示
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

互动组件-礼物配置删除

基本信息

Path： /api/gift/config/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
giftId	是	16406029CB3DBEB7	礼物id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误描述

互动组件-直播间红包列表查询

基本信息

Path： /api/red/envelopes/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
pageNo	是	1	页码默认1
pageSize	是	20	分页大小默认20

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ pagination	object	非必须	分页
├─ pageNo	integer	必须	页码
├─ total	integer	必须	总条数
├─ pageSize	integer	必须	分页大小
├─ redEnvelopes	object []	非必须	红包列表	item 类型: object
├─ orderNo	string	必须	订单编号
├─ redActivityId	string	必须	红包活动id
├─ redName	string	必须	红包名称
├─ redSendTime	string	必须	红包发送时间
├─ redPirce	integer	必须	红包价格
├─ redType	integer	必须	红包类型:1@随机红包 2@等分红包
├─ redKind	integer	必须	红包种类:1@普通红包 2@积分红包
├─ redReceive	integer	必须	红包领取金额
├─ redNumber	integer	必须	红包数量
├─ redExpireTime	integer	必须	红包有效期
├─ redDuration	integer	必须	红包时长
├─ redDesc	string	必须	红包描述
├─ redProbability	integer	必须	红包概率
├─ redSpeed	integer	必须	红包掉落的速度:1@慢 2@正常 3@快 4@很快
├─ redMinPrice	integer	必须	红包最小金额
├─ redStatus	integer	必须	红包状态 1@初始化 2@充值完成 3@活动开始 4@活动结束 5@支付失败
├─ redWinTimes	integer	必须	中奖次数
├─ redAutoClose	integer	必须	是否自动关闭 1@是 0@不是
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

互动组件-直播间红包中奖人员列表查询

基本信息

Path： /api/red/envelopes/win/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id
pageNo	是	1	页码默认1
pageSize	是	20	分页大小默认20
redActivityId	是	0F7CB77E1F3	红包活动id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true:返回data数据 false:返回error
data	object	非必须
├─ redEnvelopesWins	object []	非必须	中奖人员列表	item 类型: object
├─ wxOpenId	string	必须	中奖用户微信openid
├─ wxOpenName	string	必须	中奖用户微信名称
├─ winPrice	integer	必须	中奖金额
├─ userName	string	必须	中奖用户名称
├─ userId	string	必须	中奖用户id
├─ winTime	string	必须	中奖时间
├─ pagination	object	非必须	分页
├─ pageNo	integer	必须	页码
├─ total	integer	必须	总条数
├─ pageSize	integer	必须	分页大小
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	提示信息

直播

直播分页列表

基本信息

Path： /api/v2/live/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	998757E82C929B67	账号id
roomid	否	94EF65F45D4904779C33DC5901307461	直播间id
pageindex	否	1	第几页，为空时默认值1，不为空时必须为正整数。
pagenum	否	2	每页条数，为空时默认值50，不为空时必须为正整数。
starttime	否	2021-11-11 11:30:15	范围查询，最小直播开始时间；不为空时支持yyyy-MM-dd HH:mm和yyyy-MM-dd HH:mm:ss两种格式
endtime	否	2021-12-11 11:30:15	范围查询，最大直播开始时间；不为空时支持yyyy-MM-dd HH:mm和yyyy-MM-dd HH:mm:ss两种格式

返回数据

名称	类型	是否必须	备注	其他信息
result	string	必须	OK表示成功，FAIL表示失败
reason	string	非必须	result=FAIL时，该字段会返回错误信息。
pageIndex	number	非必须	第几页
count	number	非必须	总条数
lives	object []	非必须	直播数据	item 类型: object
├─ recordVideoStatus	number	必须	回放视频状态
├─ templateType	number	必须	直播模版类型
├─ sourceType	number	必须	直播类型
├─ id	string	必须	直播id
├─ startTime	string	必须	直播开始时间
├─ endTime	string	必须	直播结束时间
├─ roomId	string	必须	房间id

红包余额

导出红包余额交易明细

基本信息

Path： /api/red/envelopes/balance/transaction/export

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
transactionType	是		交易类型 1@充值 2@提现 3@使用 4@退款不传则查询全部类型

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
data	object []	非必须	item 类型: object
├─ transactionId	string	必须
├─ transactionTime	string	必须
├─ transactionType	string	必须
├─ transactionDesc	string	必须
├─ transactionStatus	string	必须
├─ amount	string	必须

红包余额充值

基本信息

Path： /api/red/envelopes/balance/recharge

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
roomId	是	1C6EAB2F4056166B9C33DC5901307461	直播间id

Body

名称	类型	是否必须	默认值	备注	其他信息
actualAmount	string	必须		充值金额
accountId	string	必须

返回数据

名称	类型	是否必须
success	boolean	非必须
data	object	非必须
├─ wxPayUrl	string	非必须
├─ totalPrice	string	非必须
├─ transactionId	string	非必须
├─ orderNo	string	非必须

红包余额提现

基本信息

Path： /api/red/envelopes/balance/withdrawal

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
actualAmount	是	1C6EAB2F4056166B9C33DC5901307461	提现金额
reMark	否
openId	是		绑定的openid

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ config	object	非必须
├─ activityId	string	非必须	活动ID
├─ basicTimes	integer	非必须	基础倍数
├─ basicNumbers	integer	非必须	基础人数

获取余额交易详情

基本信息

Path： /api/red/envelopes/balance/transaction/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
transactionId	是	1C6EAB2F4056166B9C33DC5901307461	交易id

返回数据

名称	类型	是否必须
success	boolean	非必须
data	object	非必须
├─ accountId	string	非必须
├─ transactionId	string	非必须
├─ transactionType	number	非必须
├─ orderNo	string	非必须
├─ transactionTime	string	非必须
├─ transactionStatus	number	非必须
├─ actualAmount	number	非必须
├─ totalAmount	number	非必须
├─ transactionDesc	string	非必须
├─ source	number	非必须

获取红包余额交易明细列表

基本信息

Path： /api/red/envelopes/balance/transaction

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
transactionType	是	1C6EAB2F4056166B9C33DC5901307461	交易类型 1@充值 2@提现 3@使用 4@退款不传则查询全部类型
pageSize	是
pageNo	是

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
data	object	非必须
├─ pagination	object	非必须
├─ pageNo	string	非必须
├─ total	string	非必须
├─ pageSize	string	非必须
├─ transactions	object []	非必须	item 类型: object
├─ transcationId	number	必须
├─ accountId	string	必须
├─ transcationType	number	必须
├─ tracnsactionTime	string	必须
├─ tracnsactionStatus	number	必须
├─ actualAmount	number	必须
├─ totalAmount	number	必须
├─ desc	string	必须
├─ source	number	必须

获取账户余额

基本信息

Path： /api/red/envelopes/balance/amount

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ balance	integer	非必须	余额

鉴黄

直播-图片任务列表

基本信息

Path： /api/green/live/pic/tasks

Method： GET

接口描述：

直播维度获取鉴黄图片列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
liveId	是	直播id
scenes	是	场景	可选值： 2-暴恐涉政场景；1-鉴黄场景，支持多选， eg:1,2
results	是	图片鉴定结果	可选值：1-疑似;2-违规;3-正常；支持多选，eg: 1,2 ,多个以逗号分隔
accountId	是	账户id
pageNo	否
pageSize	否

Body

名称	类型	是否必须	备注
callback	object	非必须	回调配置
├─ scene	string	非必须	回调场景；多个以为逗号分隔；
├─ status	integer	非必须	是否开启回调：1-开启；0-关闭
├─ url	string	非必须	回调地址
scene	string	非必须	鉴黄场景；多个以为逗号分隔；
status	integer	必须	是否开启审核：1-开启；0-关闭

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true-成功
error	object	非必须	success=fail ,包含此对象
├─ code	string	必须
├─ message	string	非必须
data	object	必须
├─ records	object []	非必须	列表	item 类型: object
├─ url	string	非必须	图片地址
├─ picId	number	非必须	图片id
├─ label	string	非必须	标签（类型）
├─ scene	number	非必须	场景：1-porn-鉴黄, 2-terrorism-暴恐涉政
├─ result	number	非必须	鉴定结果。1-疑似;2-违规;3-正常；
├─ time	number	非必须	截图时间。时间戳（ms）
├─ pagination	object	非必须	分页
├─ pageNo	number	非必须	当前页,从请求那边传过来
├─ pageSize	number	非必须	每页显示的数据条数
├─ totalCount	number	非必须	总记录数
├─ pageCount	number	非必须	总页码

直播-场景数量统计

基本信息

Path： /api/green/live/scene/summary

Method： GET

接口描述：

1、查询单直播维度，正常、疑似、违规图片总数。
2、未提供直播id,查询账户下每个直播的正常、疑似、违规图片总数。
3、数据基础：鉴黄图片任务表，直播未参与鉴黄，不展示在列表里。
备注：直播id 倒序排列

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是
liveId	否		liveId不提供，默认分页查询账户下直播列表

Body

名称	类型	是否必须	备注
callback	object	非必须	回调配置
├─ scene	string	非必须	回调场景；多个以为逗号分隔；
├─ status	integer	非必须	是否开启回调：1-开启；0-关闭
├─ url	string	非必须	回调地址
scene	string	非必须	鉴黄场景；多个以为逗号分隔；
status	integer	必须	是否开启审核：1-开启；0-关闭

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true-成功
error	object	非必须	success=fail ,包含此对象
├─ code	string	必须
├─ message	string	非必须
data	object	必须
├─ records	object []	非必须	直播列表	item 类型: object
├─ liveId	string	非必须	加密直播id
├─ porn	object	非必须	场景：涉黄
├─ normal	number	非必须	正常数量 (Long)
├─ review	number	非必须	疑似数量 (Long)
├─ block	number	非必须	违规数量 (Long)
├─ terrorism	object	非必须	场景：暴恐涉政
├─ normal	number	非必须	正常数量 (Long)
├─ review	number	非必须	疑似数量 (Long)
├─ block	number	非必须	违规数量 (Long)
├─ pagination	object	非必须	分页
├─ pageNo	number	非必须	当前页,从请求那边传过来
├─ pageSize	number	非必须	每页显示的数据条数
├─ totalCount	number	非必须	总记录数
├─ pageCount	number	非必须	总页码

直播生命周期

停止直播

基本信息

Path： /api/live/stop

Method： GET

接口描述：

tipIndex 和 tips说明。

假设
tips = "to stu::to tea::to 22::to publisher"
tipIndex = "0,2,3,1'

逻辑：
将tips字符串用::分隔后得到数组 tipsArr = ["to stu","to tea","to 22","to publisher"];
将tipIndex用逗号,分隔得到数组 tipIndexArr = [0,2,3,1]

0：表示学员提示语，在数组tipsArr的index， eg,学员提示语为 tipsArr[0] = "to stu"
2：表示助教提示语，在数组tipsArr的index， eg.助教提示语为tipsArr[2] = "to 22"
3：表示主持人提示语，在数组tipsArr的index
1：表示推流者提示语，在数组tipsArr的index

请求参数

Query

参数名称	是否必须	备注
accountId	是	用户ID
liveId	是	直播ID
tips	否	提示语。用::分隔，eg. to teacher::to student ,每个提示语不可超过40个字符。
tipIndex	否	eg 0,0,0,0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		success = true ,表示成功

直播

直播概况查询

基本信息

Path： /api/live/statistic/situation

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	AF58B89EF2C17DA4	账号ID
liveId	是	159950E7337F0CB7	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
├─ situation	object	必须
├─ duration	string	必须	直播时长（秒）
├─ view	object	必须	观看统计
├─ enrollment	integer	必须	报名观看人数
├─ pv	integer	必须	观看次数
├─ uv	integer	必须	观看人数
├─ duration	string	必须	总观看时长（秒）
├─ maxConcurrency	integer	必须	人气峰值
├─ avgDuration	string	必须	平均观看时长（秒）
├─ finishedRate	string	必须	完播率
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

直播观看记录

基本信息

Path： /api/live/statistic/view-record

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账号ID
liveId	是	直播ID
pageNo	是	页码
pageSize	是	每页条数（默认50，最大500）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ user	object []	必须	观看记录	item 类型: object
├─ id	string	必须	用户ID
├─ name	string	必须	昵称
├─ enterTime	string	必须	首次进入时间
├─ leaveTime	string	必须	最后离开时间
├─ duration	string	必须	观看总时长（多次进出时，时长 !=最后离开-首次进入）
├─ region	string	必须	地域
├─ pagination	object	非必须	分页信息
├─ pageNo	integer	必须	当前页码
├─ pageSize	integer	必须	每页条数
├─ totalCount	number	必须	数据总条数
├─ pageCount	number	必须	总页码
error	object	非必须	错误信息
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

学员观看直播详情

基本信息

Path： /api/live/statistic/view-user-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账号ID
liveId	是	直播ID
userId	是	用户ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ user	object	必须	用户信息
├─ id	string	必须	用户ID
├─ name	string	必须	用户昵称
├─ terminal	string	必须	终端类型
├─ region	string	必须	地域
├─ duration	string	必须	观看总时长（2小时10分15秒）
├─ interval	object []	必须	观看时段	item 类型: object
├─ enter	string	必须	进入时间
├─ leave	string	必须	离开时间
├─ interaction	object	必须	互动统计
├─ invite	integer	必须	邀请人数
├─ chat	integer	必须	聊天数量
├─ redPacket	integer	必须	红包雨
error	object	非必须	错误信息
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

直播聊天数据统计

基本信息

Path： /api/live/statistic/chat

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账号ID
liveId	是		直播ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ chat	object	必须	聊天信息
├─ count	integer	必须	直播聊天总数
├─ userNum	integer	必须	直播聊天人数
├─ rank	object []	必须	聊天数量排名	item 类型: object
├─ userName	string	必须	用户名
├─ count	string	必须	本场直播该用户发送聊天总数
├─ interval	object []	必须	分段统计	item 类型: object
├─ time	string	必须	统计时间
├─ count	integer	必须	统计时间至(统计时间+统计间隔时段)内的聊天总数

直播点赞数据统计

基本信息

Path： /api/live/statistic/like

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账号ID
liveId	是		直播ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ interval	object []	必须	分段统计信息	item 类型: object
├─ time	string	必须	统计时间
├─ count	integer	必须	统计时间至(统计时间+统计间隔时段)内的聊天总数
├─ likedCount	string	必须	点赞总数
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

报名观看

查询直播间报名观看学员信息

基本信息

Path： /api/room/sign-up-user/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
roomId	是
pageNo	是	查询页码
pageSize	是	每页条数，默认50条，最大100条
phone	否	手机号
status	是	审核状态：0：未审核 1：审核通过 2：审核拒绝
accountId	是	账户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ list	object []	必须	表头数据	item 类型: object
├─ id	string	必须
├─ detail	string	必须
├─ users	object []	必须		item 类型: object
├─ userId	string	必须	用户id
├─ phone	string	必须	手机号
├─ nickName	string	必须	昵称
├─ orderTime	string	必须	预约时间，格式'yyyy-MM-dd HH:mm:ss"
├─ status	string	必须	审核状态 0：未审核 1：已通过 2：已拒绝
├─ auditTime	string	非必须	审核时间格式'yyyy-MM-dd HH:mm:ss"
├─ subjectsValue	object []	非必须		item 类型: object
├─ id	string	必须
├─ value	string	必须
├─ totalNum	string	必须	总条数
├─ pageSize	string	必须	每页大小
error	object	必须
├─ code	string	必须
├─ message	string	必须

打赏收益

打赏收益-付费打赏列表

基本信息

Path： /api/gift/pay/record/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
pageNo	是
pageSize	是
startTime	否
endTime	否
roomId	否

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ payRecords	object []	非必须		item 类型: object
├─ roomId	string	必须	直播间id
├─ orderNo	number	必须	订单ID
├─ amount	number	必须	付费金额
├─ transTime	string	必须	支付时间
├─ username	string	必须	用户昵称
├─ pagination	object	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ total	number	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

打赏收益-付费打赏导出

基本信息

Path： /api/gift/pay/record/export

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
pageNo	是
pageSize	是
startTime	否
endTime	否
roomId	否

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ roomId	string	非必须	直播间id
├─ orderNo	number	非必须	订单ID
├─ amount	number	非必须	付费金额
├─ transTime	string	非必须	支付时间
├─ username	string	非必须	用户昵称
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

打赏收益-礼物提现列表查询

基本信息

Path： /api/gift/withdraw/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
pageNo	是
pageSize	是
startTime	是
endTime	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ withdraws	object []	非必须		item 类型: object
├─ withdrawName	string	必须	提现账户昵称
├─ withdrawAmount	number	必须	提现金额
├─ withdrawStatus	number	必须	提现状态
├─ withdrawTime	string	必须	提现日期
├─ pagination	object	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ total	number	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

打赏收益-礼物收益提现

基本信息

Path： /api/gift/withdraw/start

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id
withdrawAmount	是
remark	是

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	非必须
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

打赏收益-礼物收益查询

基本信息

Path： /api/gift/profit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账号id

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	非必须
├─ balance	string	必须	余额
├─ profit	string	必须	总收益
├─ status	string	必须	0 不可提现 1可提现
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

客户端信息上报

客户端信息上报查询

基本信息

Path： /api/live/report/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ACB026848DEA495B	账户id
queryTime	是	2022-8-10 14:30	查询时间的时刻格式 yyyy-MM-dd HH:mm，查询的为当前时刻的上报数据
roomId	是	3A7F4345F81B43BA9C33DC5901307461	直播间id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ systemVersion	string	必须	系统版本
├─ sdkVersion	string	必须	客户端版本
├─ reportInfos	object []	非必须	上报信息	item 类型: object
├─ resolution	object	必须	分辨率
├─ w	number	非必须
├─ h	number	非必须
├─ cpu	number	必须	cpu使用率
├─ memoryTotal	number	必须	总内存容量单位M
├─ memoryUse	number	必须	内存已使用容量单位M
├─ memoryFree	number	必须	内存空闲容量单位M
├─ lostFrameRate	number	必须	丢帧率
├─ bitRate	number	必须	码率
├─ frameRate	number	必须	帧率
├─ time	number	必须	时间戳，单位毫秒
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

双语专题

删除专题

基本信息

Path： /api/topic/del

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账号ID
id	是		专题ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

双语专题列表

基本信息

Path： /api/topic/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账号ID
title	否	专题名称
pageNo	是	分页页码
pageSize	是	每页条数，不超过100

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ topics	object []	非必须		item 类型: object
├─ id	string	必须	专题ID
├─ accountId	string	必须	账号ID
├─ title	string	必须	专题名称
├─ status	number	必须	专题状态
├─ createTime	string	必须	创建时间
├─ room	object []	必须	专题关联直播间	item 类型: object
├─ roomId	string	必须	直播间ID
├─ type	number	必须	直播间类型 0：中文 1英文
├─ pagination	object	非必须	分页信息
├─ pageNo	number	非必须	当前页码
├─ pageSize	number	非必须	每页条数
├─ totalCount	number	非必须	总条数
├─ pageCount	number	非必须	总页数
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

新增（编辑）双语专题

基本信息

Path： /api/topic/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	备注
accountId	是	账号ID
title	是	专题名称
id	否	专题ID,编辑时必传

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ roomId	string	必须	直播间ID
├─ type	number	必须	直播间类型 0：中文直播间 1：英文直播间

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

直播带货

直播间-取消置顶商品

基本信息

Path： /api/product/opt/top/cancel

Method： POST

接口描述：

错误码：

错误码	产品线	模块	错误信息	错误级别	备注
20390000	直播	InteractionSell	TOKEN_INVALID	高	互动token无效，过期，无操作权限
20390001	直播	InteractionSell	PRODUCT_DELETED	低	商品已无效
20390002	直播	InteractionSell	ROOM_NOT_REF_PRODUCT	低	直播间未关联到该商品
20390003	直播	InteractionSell	ROOM_NOT_EXISTS_PUSHING_PRODUCT	低	直播间不存在正在推送的商品
20390004	直播	InteractionSell	CALL_IM_FAIL	高	调用IM组件失败
20390005	直播	InteractionSell	ROOM REL HAS EXITS	低	直播间已导入该商品，请刷新列表
20390006	直播	InteractionSell	ROOM_PRODUCT_TOP_AMOUNT_LIMIT	低	直播间置顶商品数量超过限制
20390007	直播	InteractionSell	ROOM PRODUCT REl AMOUNT LIMIT	低	直播间导入商品已达上限
20390008	直播	InteractionSell	PUSHING PRODUCT REL DEL FORBIDDEN	低	推送中商品，不可取消导入

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

Body

名称	类型	是否必须	默认值	备注	其他信息
roomId	string	必须		直播间id
productId	string	必须		商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true- 成功；false - 失败；
data	object	非必须

全局商品列表

基本信息

Path： /api/product/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
kw	否	商品名称
pageNo	是	第几页, 默认1
pageSize	是	每页大小, 默认20

返回数据

名称	类型	是否必须	其他信息
success	boolean	必须
data	object	非必须
├─ records	object []	非必须	item 类型: object
├─ id	string	非必须
├─ cover	string	非必须
├─ title	string	非必须
├─ currentPrice	number	非必须
├─ gmtCreate	number	非必须
├─ tag	string	非必须
├─ status	number	非必须
├─ button	string	非必须
├─ originPrice	number	非必须
├─ desc	string	非必须
├─ linkType	number	非必须
├─ platformLink	object []	非必须	item 类型: object
├─ terminal	string	必须
├─ link	string	必须
├─ pagination	object	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ totalCount	number	非必须
├─ pageCount	number	非必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

删除商品

基本信息

Path： /api/product/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
ids	是		最多支持批量删除200个

更新商品

基本信息

Path： /api/product/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
title	string	必须	商品名称
cover	string	必须	封面
tag	string	非必须	标签，逗号分隔
desc	string	非必须	描述
originPrice	number	必须	划线价格（单位分）
currentPrice	number	必须	购买价格（单位分）
link	string	必须	链接
button	string	必须	按钮文案
id	integer	必须	商品ID
gmtCreate	number	必须	商品创建时间
status	number	必须	产品状态

返回数据

名称	类型	是否必须	默认值	备注	其他信息

直播间-取消推送商品

基本信息

Path： /api/product/opt/push/cancel

Method： POST

接口描述：

错误码：

错误码	产品线	模块	错误信息	错误级别	备注
20390000	直播	InteractionSell	TOKEN_INVALID	高	互动token无效，过期，无操作权限
20390001	直播	InteractionSell	PRODUCT_DELETED	低	商品已无效
20390002	直播	InteractionSell	ROOM_NOT_REF_PRODUCT	低	直播间未关联到该商品
20390003	直播	InteractionSell	ROOM_NOT_EXISTS_PUSHING_PRODUCT	低	直播间不存在正在推送的商品
20390004	直播	InteractionSell	CALL_IM_FAIL	高	调用IM组件失败
20390005	直播	InteractionSell	ROOM REL HAS EXITS	低	直播间已导入该商品，请刷新列表
20390006	直播	InteractionSell	ROOM_PRODUCT_TOP_AMOUNT_LIMIT	低	直播间置顶商品数量超过限制
20390007	直播	InteractionSell	ROOM PRODUCT REl AMOUNT LIMIT	低	直播间导入商品已达上限
20390008	直播	InteractionSell	PUSHING PRODUCT REL DEL FORBIDDEN	低	推送中商品，不可取消导入

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

Body

名称	类型	是否必须	默认值	备注	其他信息
roomId	string	必须		直播间id
productId	string	必须		商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true- 成功；false - 失败；
data	object	非必须

创建商品

基本信息

Path： /api/product/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
title	string	必须	商品名称
cover	string	必须	封面
tag	string	非必须	"香甜,可口"
desc	string	非必须	描述
originPrice	number	必须	划线价格, 单位分
currentPrice	number	必须	购买价格,单位分
link	string	必须	链接,通用链接
linkType	integer	非必须	链接类型：0：通用链接 1：多平台链接，默认为0
platformLink	object []	非必须	当为多平台链接时传入	item 类型: object
├─ terminal	integer	必须	终端类型终端：1：PC 2：H5 3: App 4：微信小程序id 5：微信小程序路径
├─ link	string	必须	链接地址
button	string	必须	按钮文案
gmtCreate	number	非必须	产品创建时间（复制的时候必传，新增非必须传

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
error	object	必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

直播间-导入商品

基本信息

Path： /api/product/room/rel/add

Method： GET

接口描述：

错误码：

错误码	产品线	模块	错误信息	错误级别	备注
20390000	直播	InteractionSell	TOKEN_INVALID	高	互动token无效，过期，无操作权限
20390001	直播	InteractionSell	PRODUCT_DELETED	低	商品已无效
20390002	直播	InteractionSell	ROOM_NOT_REF_PRODUCT	低	直播间未关联到该商品
20390003	直播	InteractionSell	ROOM_NOT_EXISTS_PUSHING_PRODUCT	低	直播间不存在正在推送的商品
20390004	直播	InteractionSell	CALL_IM_FAIL	高	调用IM组件失败
20390005	直播	InteractionSell	ROOM REL HAS EXITS	低	直播间已导入该商品，请刷新列表
20390006	直播	InteractionSell	ROOM_PRODUCT_TOP_AMOUNT_LIMIT	低	直播间置顶商品数量超过限制
20390007	直播	InteractionSell	ROOM PRODUCT REl AMOUNT LIMIT	低	直播间导入商品已达上限
20390008	直播	InteractionSell	PUSHING PRODUCT REL DEL FORBIDDEN	低	推送中商品，不可取消导入

请求参数

Query

参数名称	是否必须	备注
productId	是	商品id
roomId	是	直播间id
accountId	是	账户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true- 成功；false - 失败；

直播间-推送商品

基本信息

Path： /api/product/opt/push

Method： POST

接口描述：

错误码：

错误码	产品线	模块	错误信息	错误级别	备注
20390000	直播	InteractionSell	TOKEN_INVALID	高	互动token无效，过期，无操作权限
20390001	直播	InteractionSell	PRODUCT_DELETED	低	商品已无效
20390002	直播	InteractionSell	ROOM_NOT_REF_PRODUCT	低	直播间未关联到该商品
20390003	直播	InteractionSell	ROOM_NOT_EXISTS_PUSHING_PRODUCT	低	直播间不存在正在推送的商品
20390004	直播	InteractionSell	CALL_IM_FAIL	高	调用IM组件失败
20390005	直播	InteractionSell	ROOM REL HAS EXITS	低	直播间已导入该商品，请刷新列表
20390006	直播	InteractionSell	ROOM_PRODUCT_TOP_AMOUNT_LIMIT	低	直播间置顶商品数量超过限制
20390007	直播	InteractionSell	ROOM PRODUCT REl AMOUNT LIMIT	低	直播间导入商品已达上限
20390008	直播	InteractionSell	PUSHING PRODUCT REL DEL FORBIDDEN	低	推送中商品，不可取消导入

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

Body

名称	类型	是否必须	默认值	备注	其他信息
roomId	string	必须		直播间id
productId	string	必须		商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true- 成功；false - 失败；
data	object	非必须

直播间-移除商品

基本信息

Path： /api/product/room/rel/delete

Method： GET

接口描述：

错误码见：http://yapi.csslcloud.net/project/35/interface/api/12254

请求参数

Query

参数名称	是否必须	备注
productId	是	商品id
roomId	是	直播间id
accounId	是	账户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true-成功；false - 失败
data	object	非必须

直播间-置顶商品

基本信息

Path： /api/product/opt/top

Method： POST

接口描述：

错误码：

错误码	产品线	模块	错误信息	错误级别	备注
20390000	直播	InteractionSell	TOKEN_INVALID	高	互动token无效，过期，无操作权限
20390001	直播	InteractionSell	PRODUCT_DELETED	低	商品已无效
20390002	直播	InteractionSell	ROOM_NOT_REF_PRODUCT	低	直播间未关联到该商品
20390003	直播	InteractionSell	ROOM_NOT_EXISTS_PUSHING_PRODUCT	低	直播间不存在正在推送的商品
20390004	直播	InteractionSell	CALL_IM_FAIL	高	调用IM组件失败
20390005	直播	InteractionSell	ROOM REL HAS EXITS	低	直播间已导入该商品，请刷新列表
20390006	直播	InteractionSell	ROOM_PRODUCT_TOP_AMOUNT_LIMIT	低	直播间置顶商品数量超过限制
20390007	直播	InteractionSell	ROOM PRODUCT REl AMOUNT LIMIT	低	直播间导入商品已达上限
20390008	直播	InteractionSell	PUSHING PRODUCT REL DEL FORBIDDEN	低	推送中商品，不可取消导入

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

Body

名称	类型	是否必须	默认值	备注	其他信息
roomId	string	必须		直播间id
productId	string	必须		商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true- 成功；false - 失败；
data	object	非必须

直播间-账户商品库列表（包含直播间导入状态）

基本信息

Path： /api/product/list/withRel

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
kw	否	商品名称
roomId	是	直播间id
pageNo	是	页码，默认为1
pageSize	是	每页大小，默认20个

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ records	object []	非必须		item 类型: object
├─ id	string	非必须
├─ cover	string	非必须
├─ title	string	非必须
├─ tag	string	非必须
├─ currentPrice	number	非必须
├─ originPrice	number	非必须
├─ pagination	object	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ totalCount	number	非必须
├─ pageCount	number	非必须
├─ field_1	string	必须
error	object	非必须	错误时返回
├─ code	string	必须
├─ meaasge	string	必须

多流直播

新增/编辑/删除多流直播

基本信息

Path： /api/multi/stream/save

Method： POST

接口描述：

流信息新增、编辑、删除都必须传全量数据。参与THQS加密的参数为accountId和roomId
修改、删除时id为必传字段。
新增时id非必传。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	账号ID
roomId	是	5282F0F4054AB9859C33DC5901307461	直播间ID

Body

名称	类型	是否必须	备注
id	string	非必须	流ID，编辑、删除时必传
name	string	必须	流名称
desc	string	非必须	流描述
rank	number	必须	流排序
cover	string	必须	流封面图
delete	string	非必须	是否删除 0 否 1 是（删除）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ streams	object []	非必须	流信息	item 类型: object
├─ id	number	必须	流ID
├─ name	string	必须	流名称
├─ cover	string	非必须	流封面图
├─ desc	string	非必须	流描述
├─ rank	number	必须	流排名
├─ publishUrl	string	必须	推流地址
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

查询多流直播列表

基本信息

Path： /api/multi/stream/list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	账号ID
roomId	是	5282F0F4054AB9859C33DC5901307461	直播间ID

Body

名称	类型	是否必须	备注
id	string	非必须	流ID，编辑、删除时必传
cover	string	必须	流名称
desc	string	非必须	流描述
rank	number	必须	流封面图
	string	必须	流排序
delete	string	非必须	是否删除 0 否 1 是（删除）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ streams	object []	非必须	流信息	item 类型: object
├─ id	number	必须	流ID
├─ name	string	必须	流名称
├─ cover	string	非必须	流封面图
├─ desc	string	非必须	流描述
├─ rank	number	必须	流排名
├─ publishUrl	string	必须	推流地址
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

白名单2.0

白名单信息单条数据插入

基本信息

Path： /api/room/whitelist/user/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
accountId	是	ACB81999584E9A75
hash	是
time	是

Body

名称	类型	是否必须	备注
roomId	string	必须	直播间ID
whitelistId	string	非必须	白名单ID
userName	string	必须	用户名称
userPassword	string	必须	用户密码

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ whitelistId	string	必须	白名单ID
├─ repeat	string []	非必须	存在重复密码数据	item 类型: string
├─		非必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

白名单信息导入

基本信息

Path： /api/room/whitelist/batch/insert

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
accountId	是	ACB81999584E9A75
roomId	是	EC1750584E9A75ECB81750584E9A75
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息，最大2W条	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ whitelistId	string	必须	白名单ID
├─ repeat	string []	非必须	存在重复密码数据	item 类型: string
├─		非必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

白名单用户信息单条数据删除

基本信息

Path： /api/room/whitelist/user/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75	账号ID
whitelistId	是	EC1750584E9A75ECB81750584E9A75	白名单ID
Id	是		单条数据ID
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

白名单用户信息导出

基本信息

Path： /api/room/whitelist/export

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
accountId	是	ACB81999584E9A75
whitelistId	是	EC1750584E9A75ECB81750584E9A75
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ records	object []	必须	白名单用户信息	item 类型: object
├─ id	string	必须	数据id
├─ userName	string	必须	学员名称
├─ userPassword	string	必须	学员密码
error	object	非必须
├─ code	string	必须
├─ message	string	必须

白名单用户信息查询

基本信息

Path： /api/room/whitelist

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75
whitelistId	是	EC1750584E9A75ECB81750584E9A75
pageNo	是	1	默认 1
pageSize	是	50	默认50，最大50
userName	是		用户名称
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	必须
├─ records	object []	必须	白名单用户信息	item 类型: object
├─ id	integer	必须	数据id
├─ userName	string	必须	学员名称
├─ userPassword	string	必须	学员密码
├─ pagination	object	必须	分页信息
├─ pageNo	integer	必须	当前页
├─ pageSize	integer	必须	每页显示的数据条数
├─ totalCount	integer	必须	总的记录条数
├─ pageCount	integer	必须	总页数
error	object	非必须
├─ code	string	必须
├─ message	string	必须

白名单用户信息清空

基本信息

Path： /api/room/whitelist/clear

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75	账号ID
roomId	是		直播间ID
whitelistId	是	EC1750584E9A75ECB81750584E9A75	白名单ID
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

自定义表情

自定义表情-保存

基本信息

Path： /api/room/whitelist/clear_1673247516507_1673247538995

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75	账号ID
roomId	是		直播间ID
whitelistId	是	EC1750584E9A75ECB81750584E9A75	白名单ID
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

自定义表情-删除

基本信息

Path： /api/room/whitelist/clear_1673247516507_1673247538995_1673247542330

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75	账号ID
roomId	是		直播间ID
whitelistId	是	EC1750584E9A75ECB81750584E9A75	白名单ID
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

自定义表情-查询

基本信息

Path： /api/chat/emoji

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是	ACB81999584E9A75	账号ID
roomId	是		直播间ID
whitelistId	是	EC1750584E9A75ECB81750584E9A75	白名单ID
hash	是
time	是

Body

名称	类型	是否必须	备注	其他信息
filename	string	非必须	导入文件名称
users	object []	必须	用户信息	item 类型: object
├─ userName	string	必须	名称
├─ userPassword	string	必须	密码
whitelistId	string	非必须	白名单ID，增量导入需要传递

返回数据

名称	类型	是否必须
success	boolean	必须
data	object	必须
error	object	非必须
├─ code	string	必须
├─ message	string	必须

回放设置

自动合并设置

基本信息

Path： /api/room/setting/automerge

Method： GET

接口描述：

1、该接口需要thqs加密
2、结束时间必须大于当前时间
3、自动合并任务已经执行过的，不能编辑
4、自动合并只能合并录制的回放

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	备注
userId	是	机构账号
roomId	是	直播间ID
autoMergeSwitch	是	自动合并开关，0：关闭，1：开启
mergeStartTime	是	合并回放开始时间
mergeEndTime	是	合并回放结束时间

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须

公告

发布公告

基本信息

Path： /api/room/announcement/release

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userId	是	ECB81750584E9A75	用户ID
roomId	是	31BBCEE91509D4AE9C33DC5901307461	直播间ID
announcement	是	发布公告	公告信息（不能为空，并且长度不能超过100）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK/FAIL
reason	string	必须		错误信息（如：room has been deleted）

清除公告

基本信息

Path： /api/room/announcement/remove

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userId	是	ECB81750584E9A75	账户ID
roomId	是	31BBCEE91509D4AE9C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK/FAIL
reason	string	必须		错误原因

聊天

发送私聊消息

基本信息

Path： /api/chat/private/send

Method： GET

接口描述：

加密规则请参考:https://doc.bokecc.com/live/Appendix_2.html

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	备注
accountId	是	账号ID
roomId	是	直播间ID
content	是	消息内容限制长度:300
fromUserId	是	发送用户ID 限制长度:40
fromUserName	是	发送用户名称限制长度:20
fromUserRole	是	发送用户角色 1: 主讲; 2: 助教; 3: 主持人; 4: 学员（观众）;
fromUserAvatar	否	用户头像限制长度:200
toUserId	是	接收用户id 限制长度:40

Body

名称	类型	是否必须	备注	其他信息
accountId	string	必须	账号ID
chatList	object []	必须	消息集合限制10条	item 类型: object
├─ content	string	必须	消息内容 300
├─ fromUserId	string	必须	发送用户ID
├─ fromUserName	string	必须	发送用户名称
├─ fromUserRole	string	必须	发送用户角色publisher: 主讲; teacher: 助教; host: 主持人; student: 学员（观众）;
├─ fromUserAvatar	string	非必须	用户头像
├─ fromGroupId	string	非必须	分组ID
├─ fromUserCustomMark	string	非必须	用户自定义标识
├─ sensitiveWord	string	非必须	是否跳过脏词过滤 1.是 0.走脏字过滤默认设置默认 0
├─ chatManage	string	非必须	是否跳过审核 1.是 0.走聊天审核默认设置默认 0
roomId	string	非必须	直播间ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
error	object	非必须	失败时返回
├─ code	string	非必须	错误码
├─ message	string	非必须	错误信息

发送群聊消息

基本信息

Path： /api/chat/send

Method： GET

接口描述：

加密规则请参考:https://doc.bokecc.com/live/Appendix_2.html

请求参数

Query

参数名称	是否必须	备注
accountId	是	账号ID
roomId	是	直播间ID
content	是	消息内容限制长度:300
fromUserId	是	发送用户ID 限制长度:40
fromUserName	是	发送用户名称限制长度:20
fromUserRole	是	发送用户角色 1: 主讲; 2: 助教; 3: 主持人; 4: 学员（观众）;
fromUserAvatar	否	用户头像限制长度:200
fromGroupId	否	分组ID 限制长度:20
fromUserCustomMark	否	用户自定义标识限制长度:300 该信息用于个性化用户角色，可以在直播聊天信息中获取

Body

名称	类型	是否必须	备注	其他信息
accountId	string	必须	账号ID
chatList	object []	必须	消息集合限制10条	item 类型: object
├─ content	string	必须	消息内容 300
├─ fromUserId	string	必须	发送用户ID
├─ fromUserName	string	必须	发送用户名称
├─ fromUserRole	string	必须	发送用户角色publisher: 主讲; teacher: 助教; host: 主持人; student: 学员（观众）;
├─ fromUserAvatar	string	非必须	用户头像
├─ fromGroupId	string	非必须	分组ID
├─ fromUserCustomMark	string	非必须	用户自定义标识
├─ sensitiveWord	string	非必须	是否跳过脏词过滤 1.是 0.走脏字过滤默认设置默认 0
├─ chatManage	string	非必须	是否跳过审核 1.是 0.走聊天审核默认设置默认 0
roomId	string	非必须	直播间ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
error	object	非必须	失败时返回
├─ code	string	非必须	错误码
├─ message	string	非必须	错误信息

禁言单个用户

基本信息

Path： /api/viewer/ban

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	AF58B89EF2C17DA4	账户ID
roomid	是	76620AD36E2F2371008BCD8786E13EB5	直播间ID
viewerid	是	473b783d43cb4ce5932ea82c1766ba3f	被禁言用户ID

返回数据

名称	类型	是否必须
success	boolean	非必须
datas	object	非必须
errorCode	number	非必须

聊天统计查询

基本信息

Path： /api/live/chat/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
liveId	是	直播Id
accountId	是	用户ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ accountId	number	必须	用户ID
├─ duration	number	必须	直播时长
├─ endTime	number	必须	结束时间
├─ excelUrl	string	非必须	下载地址
├─ id	string	必须	主键
├─ liveId	number	必须	直播ID
├─ roomId	number	必须	直播间ID
├─ startTime	number	必须	开始时间
├─ status	number	必须	聊天统计状态,0.执行中,1.已生成,2生成失败,3.没有聊天数据

解除单个用户禁言

基本信息

Path： /api/viewer/unban

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	AF58B89EF2C17DA4	账户ID
roomid	是	76620AD36E2F2371008BCD8786E13EB5	直播间ID
viewerid	是	473b783d43cb4ce5932ea82c1766ba3f	被禁言用户ID

返回数据

名称	类型	是否必须
success	boolean	非必须
datas	object	非必须
errorCode	number	非必须

客户端设置

批量保存通用菜单

基本信息

Path： /api/user/clientmenu/general/batchupdate

Method： GET

接口描述：

code	name
1001	答题卡
1002	随堂测
1003	签到
1004	打卡
1005	抽奖
1006	问卷
1007	连麦
1008	广播
1009	公告
1010	用户列表
1011	用户基数设置

请求参数

Query

参数名称	是否必须	示例	备注
menus	是		"{1001:1,1002:0}" key : 菜单code，value: 1-启用，0-弃用
accountId	是		账户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true/false

查询通用菜单

基本信息

Path： /api/user/clientmenu/general/info

Method： GET

接口描述：

注意：此接口只返回启用的菜单code。

code	name
1001	答题卡
1002	随堂测
1003	签到
1004	打卡
1005	抽奖
1006	问卷
1007	连麦
1008	广播
1009	公告
1010	用户列表
1011	用户基数设置

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object []	必须		item 类型: object
├─ code	number	必须	菜单code

随堂测

单次随堂测提交总数

基本信息

Path： /api/practice/submit/count

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
practiceId	是

返回数据

名称	类型	是否必须
success	boolean	非必须
error	object	非必须
├─ code	string	非必须
├─ message	string	非必须
data	object	非必须
├─ count	number	非必须

获取单场直播随堂测总数

基本信息

Path： /api/practice/count

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
liveId	是

返回数据

名称	类型	是否必须
success	boolean	非必须
error	object	非必须
├─ code	string	非必须
├─ message	string	非必须
data	object	非必须
├─ count	number	非必须

获取学员提交的数据

基本信息

Path： /api/practice/submit/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是
liveid	是
practiceid	是
pageIndex	是
pageSize	是

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
pageIndex	number	非必须
count	number	非必须
submitDatas	object []	非必须	item 类型: object
├─ viewerName	string	必须
├─ submitOptions	number []	必须	item 类型: number
├─		非必须
├─ viewerId	string	必须
├─ submitTime	string	必须

获取随堂测数据

基本信息

Path： /api/practice/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是
liveid	是
pageIndex	是
pageSize	是

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
pageIndex	number	非必须
count	number	非必须
practices	object []	非必须	item 类型: object
├─ publishTime	string	必须
├─ options	object []	必须	item 类型: object
├─ index	number	必须
├─ isCorrect	number	必须
├─ id	string	必须
├─ type	number	必须

获取随堂测统计信息

基本信息

Path： /api/practice/statistics

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
liveId	是
pageIndex	是
pageSize	是

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
error	object	非必须
├─ code	string	非必须
├─ message	string	非必须
data	object	非必须
├─ practice	object []	非必须	item 类型: object
├─ id	string	必须
├─ type	string	必须
├─ total	string	必须
├─ optionRatio	object	必须
├─ optionRatio	object []	必须	item 类型: object
├─ id	string	必须
├─ index	number	必须
├─ count	number	必须
├─ isCorrect	number	必须
├─ percent	string	必须
├─ createTime	string	必须

获取随堂测静态文件信息

基本信息

Path： /api/practice/file/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
liveId	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	string	非必须
├─ message	string	非必须
data	object	非必须
├─ info	object	非必须
├─ status	number	非必须	0:无可用信息;1:正在生成;2:生成成功;3:生成失败
├─ path	string	非必须	只有status为2时返回该值

声网相关

增加声网用量

基本信息

Path： /api/voice/change

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是
addDuration	是	单位：小时
voiceChatMode	是	是否用尽停用

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须

开启/关闭声网服务

基本信息

Path： /api/voice/switch

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
status	是

返回数据

名称	类型	是否必须
data	object	必须
├─ status	boolean	必须
success	boolean	必须

获取声网统计信息

基本信息

Path： /api/agora/usage/statis

Method： GET

接口描述：

统计数据最多延迟48小时

成功返回：
{
    "success": true,
    "data": [
        {
            "usageDuration": 0,
            "date": "2020-11-04 00:00:00.0"
        }
    ]
}

异常返回：
{
    "error": {
        "code": 10000004,
        "message": "invalid thqs"
    },
    "success": false
}

{
    "error": {
        "code": 10000000,
        "message": "Invalid Params"
    },
    "success": false
}

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	35BF2C2678E055D3	加密账户id
startTime	是	2020-11-04	查询起始时间：yyyy-MM-dd
endTime	是	2020-11-04	查询结束时间：yyyy-MM-dd 结束大于起始，不超过100天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须
├─ code	string	必须	异常码
├─ messasge	string	必须	异常信息
data	object []	非必须		item 类型: object
├─ usageDuration	integer	必须	连麦统计时间下使用时长（单位：分钟），包括音频、视频、高清视频、超高清视频时长之和
├─ date	string	必须	连麦统计时间，精确到日

获取声网配置

基本信息

Path： /api/voice/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	必须
├─ total	integer	必须	总量
├─ remain	integer	必须	剩余量
├─ type	integer	必须	用尽是否停用

客户

客户-回放-列表-查询

基本信息

Path： /api/account/replay

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	客户ID
startTime	是	查询范围起始时间，格式: yyyy-MM-dd HH:mm:ss
endTime	是	查询范围结束时间，格式: yyyy-MM-dd HH:mm:ss
type	否	查询类型，按回放开始时间或结束时间，0: 按录制开始时间（默认），1: 按录制结束时间
pageNo	否	页码，默认:1
pageSize	否	每页返回数据条数，默认: 50，取值范围: [1, 100]

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须
├─ message	string	非必须
├─ code	number	非必须
data	object	非必须
├─ totalCount	number	非必须
├─ replays	object []	非必须		item 类型: object
├─ id	string	必须	回放ID
├─ roomId	string	必须	直播间ID
├─ liveId	string	必须	直播ID
├─ startTime	string	必须	录制开始时间，格式: yyyy-MM-dd HH:mm:ss
├─ endTime	string	非必须	录制结束时间，格式: yyyy-MM-dd HH:mm:ss，注：当直播未结束时，该值为空
├─ templateType	integer	必须	模板类型，具体参考：直播间模板
├─ source	integer	必须	生成方式，0: 录制生成， 1: 回放合并生成直播， 2: 迁移直播； 3. 离线生成在线； 4: 剪辑合并
├─ url	string	必须	回放观看地址
├─ title	string	必须	回放标题
├─ recordStatus	integer	必须	录制状态，0表示录制未结束，1表示录制完成(回放生成,不包括离线CCR)
├─ recordVideoId	string	必须	录制视频id，如果recordStatus为0则返回-1
├─ offlineMd5	string	非必须	离线包md5，注：只有开通离线播放权限才会返回该参数
├─ ccrFileSize	string	非必须	离线包文件大小，单位Byte，注：只有开通离线播放权限才会返回该参数

客户-直播-列表-查询

基本信息

Path： /api/account/live

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	客户ID
startTime	是	查询范围起始时间，格式: yyyy-MM-dd HH:mm:ss
endTime	是	查询范围结束时间，格式: yyyy-MM-dd HH:mm:ss
type	否	查询类型，按直播开始时间或结束时间，0: 按直播开始时间（默认），1: 按直播结束时间
pageNo	否	页码，默认:1
pageSize	否	每页返回数据条数，默认: 50，取值范围: [1, 100]

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须
├─ message	string	非必须
├─ code	number	非必须
data	object	非必须
├─ totalCount	number	非必须
├─ lives	object []	非必须		item 类型: object
├─ id	string	必须
├─ roomId	string	必须
├─ startTime	string	必须	直播开始时间，格式: yyyy-MM-dd HH:mm:ss
├─ endTime	string	非必须	直播结束时间，格式: yyyy-MM-dd HH:mm:ss，注：当直播未结束时，该值为空
├─ templateType	integer	必须	模板类型，具体参考：直播间模板
├─ source	integer	必须	直播生成方式，0: 录制生成， 1: 回放合并生成直播， 2: 迁移直播； 3. 离线生成在线； 4: 剪辑合并

流地址

获取拉流地址

基本信息

Path： /api/stream/pull

Method： GET

接口描述：

1、API系统加密方式：THQS加密

2、API获取的拉流地址具有时效性，有效时间为24小时，超过24小时需重新获取拉流地址

3、错误码：

code	message
10000013	component error
10000012	THQS invalid
10000014	exist invalid param \| parameter:types, Only flv or rtmp supported. \| Room do not exists.
10000016	status invalid liveroom
10000001	system error
10000011	account key invalid
10000010	id invalid

请求参数

Query

参数名称	是否必须	示例	备注
roomId	是	直播间id	直播间id
accountId	是	账户id	123456
types	是	flv,rtmp	可选：flv 、 rtmp ；多个以逗号,隔开；

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true-成功；false-失败；
data	object	非必须	success-true,返回此对象
├─ flv	string []	非必须	types包含flv返回，	item 类型: string
├─		非必须
├─ rtmp	string []	非必须	types包含rtmp返回	item 类型: string
├─		非必须
error	object	非必须	success-false,返回此对象
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

获取用户专属拉流地址

基本信息

Path： /api/stream/user/pull

Method： GET

接口描述：

1、API系统加密方式：THQS加密

2、错误码：

code	message
10000013	component error
10000012	THQS invalid
10000014	exist invalid param \| parameter:types, Only flv or rtmp supported. \| Room do not exists.
10000016	status invalid liveroom
10000001	system error
10000011	account key invalid
10000010	id invalid

请求参数

Query

参数名称	是否必须	示例	备注
roomId	是	直播间id	直播间id
accountId	是	账户id	123456
types	是	flv,rtmp	可选：flv 、 rtmp 、hls ；多个以逗号,隔开；

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true-成功；false-失败；
data	object	非必须	success-true,返回此对象
├─ flv	object []	非必须	types包含flv返回，	item 类型: object
├─ videoUrl	string	非必须	播放地址
├─ rtmp	object []	非必须	types包含rtmp返回	item 类型: object
├─ videoUrl	string	非必须	播放地址
├─ hls	object []	非必须	types包含hls返回	item 类型: object
├─ videoUrl	string	非必须	播放地址
error	object	非必须	success-false,返回此对象
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

统计

查找用户时长使用量（按天范围统计）_copy

基本信息

Path： /api/user/statis/duration/range_1607580020061

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
starttime	是	查询开始时间	2020-10-10
endtime	是	查询结束时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
durations	object []	非必须	item 类型: object
├─ statTime	string	非必须
├─ duration	number	非必须

直播核心统计数据

基本信息

Path： /api/live/statistics

Method： GET

接口描述：

当接口有数据时，这三个参数必会同时出现
totalViewCount、pcViewCount、mobileViewCount
即
返回数据的格式有以下3种：
1.  "data": {
    "totalViewCount": -35638195.52016465,
    "pcViewCount": 46485751.532383144,
    "mobileViewCount": 66320516.976273865,
    "userCount": -98687995.63866656
}
2. "data": {
    "totalViewCount": -35638195.52016465,
    "pcViewCount": 46485751.532383144,
    "mobileViewCount": 66320516.976273865
}
3. "data": {
    "userCount": -98687995.63866656
}

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	7A34F782E41071E8	账户ID
roomId	是	69DCE4B1166185719C33DC5901307461	直播间ID
liveId	是	2FE5BCEE49D10FE7	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	成功true, 失败false
error	object	非必须	当success为false时，该参数不为空
├─ code	string	非必须	当success为false时，该参数不为空
├─ message	string	非必须	当success为false时，该参数不为空
data	object	非必须	当success为true时，该参数不为空
├─ stat	object	非必须	当统计完成时该字段不为空
├─ totalViewCount	number	非必须	直播总访问量
├─ pcViewCount	number	非必须	直播PC端访问量
├─ mobileViewCount	number	非必须	直播移动端访问量
├─ userCount	number	非必须	直播独立访客人数

查找用户带宽数据（按天范围查找）

基本信息

Path： /api/user/statis/bandwidth/range

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
starttime	是	2020-10-20	查询开始时间
endtime	是	2020-10-21	查询结束时间，开始和结束之间跨度不能超过一个月

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
bandwidths	object []	非必须	item 类型: object
├─ statTime	string	必须
├─ bandwidth	number	必须

查找用户带宽（一天）

基本信息

Path： /api/user/statis/bandwidth/daily

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
daytime	是	2020-10-20	查找时间

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
bandwidths	object []	非必须	item 类型: object
├─ statTime	string	必须
├─ bandwidth	number	必须

查找用户时长使用量明细（一天）

基本信息

Path： /api/user/statis/duration/daily

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
daytime	是	查询时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
totalDuration	number	非必须
liveDurations	object []	非必须	item 类型: object
├─ liveId	string	必须
├─ roomId	string	必须
├─ duration	number	必须
├─ beginTime	string	必须
├─ endTime	string	必须

查找用户时长使用量（按天范围统计）

基本信息

Path： /api/user/statis/duration/range

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
starttime	是	查询开始时间	2020-10-10
endtime	是	查询结束时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
durations	object []	非必须	item 类型: object
├─ statTime	string	非必须
├─ duration	number	非必须

用户剩余流量查询

基本信息

Path： /api/user/traffic/remaining

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须
remaining	number	非必须

查找用户时长流量使用量（支持多用户）

基本信息

Path： /api/usage/daily/accounts

Method： GET

接口描述：

内部接口，自助化账单上报使用

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	7A34F782E41071E8,7A34F782E41071E8	账户ID列表
statDay	是	查询时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
data	object	非必须
├─ statList	object []	非必须	item 类型: object
├─ duration	string	非必须
├─ accountId	number	非必须
├─ traffic	string	非必须
success	boolean	非必须

查找用户流量使用量明细（一天）

基本信息

Path： /api/user/statis/traffic/daily

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
daytime	是	查询时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
totalTraffic	number	非必须
liveTraffics	object []	非必须	item 类型: object
├─ liveId	string	必须
├─ roomId	string	必须
├─ traffic	number	必须
├─ beginTime	string	必须
├─ endTime	string	必须

查找用户流量使用量（按天范围统计）

基本信息

Path： /api/user/statis/traffic/range

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
starttime	是	查询开始时间	2020-10-10
endtime	是	查询结束时间	2020-10-15

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
traffics	object []	非必须	item 类型: object
├─ statTime	string	必须
├─ traffic	number	必须

用户剩余时长查询

基本信息

Path： /api/user/duration/remaining

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须
remaining	number	非必须

批量查询用户时长及使用情况

基本信息

Path： /api/v1/accounts/duration

Method： GET

接口描述：

注：(每小时会统计一次剩余时长，剩余时长会有1小时延时)

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	232463,232463	账户ID

返回数据

{
	"success": true,
	"data": {
		"durations": [{
			"accountId": "122463",
			"total": 1000,
			"used": 200
		}, {
			"accountId": "232463",
			"total": 1000,
			"used": 200
		}]
	}
}

修改用户配置信息

基本信息

Path： /api/v1/account/config/update

Method： GET

接口描述：

当计费类型为并发计费时，maxConcurrency必填，且为正整数;

当计费类型为时长计费时，totalDuration必填，且为正整数;

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	132464	账户ID
billingMode	是	0	0：并发 1：时长
maxConcurrency	否	最大并发数	600（人）
totalDuration	否	总时长	1000000（单位：s）

返回数据

{
	"success": true,
}

抽奖

抽奖记录查询

基本信息

Path： /api/live/lotterys/plus

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	用户ID
roomId	是	房间ID
liveId	是	直播ID
pageNo	否	分页第几页，默认1页
pageSize	否	分页每页条数，默认50条（1条是一轮抽奖的数据）最大100条

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	是否成功
data	object	非必须
├─ count	number	非必须	直播下有多少场抽奖
├─ lotterys	object []	非必须	抽奖信息	item 类型: object
├─ id	string	必须	抽奖ID
├─ winUserCount	number	必须	中奖人数
├─ completeTime	string	必须	完成时间
├─ prize	object	必须	奖品信息
├─ name	string	非必须	奖品名称
├─ winningUsersCollectTemplates	object []	非必须	用户收集信息模版	item 类型: object
├─ index	number	必须	索引
├─ title	string	必须	头信息
├─ tips	string	必须	描述
├─ winUsers	object []	必须	中奖人员信息	item 类型: object
├─ userId	string	必须	用户ID
├─ userName	string	必须	用户名称
├─ userType	number	必须	用户类型
├─ prizeCode	string	必须	中奖码
├─ userCollectInfos	object []	非必须	用户收集信息详情	item 类型: object
├─ index	number	必须	索引，对应模版索引
├─ value	string	必须	索引值

账户

批量获取账户配置

基本信息

Path： /api/users/getconfig

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountIds	是	账户id,多个账户之间以‘‘,’’分割
time	是	thqs
hash	是	thqs

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true
data	object	非必须
├─ users	object []	必须		item 类型: object
├─ accountId	string	必须	账户id
├─ videoBitrate	string	必须	视频码率
error	object	非必须
├─ code	string	必须	错误码
├─ message	string	必须	错误描述

更新账户配置

基本信息

Path： /api/user/config/update

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		账户id
billingmode	否		用户计费配置
usermaxconnection	否		最大并发数
incremental	否
videobitrate	否	10	直播码率
sensitivewords	否	0	敏感词过滤
notfilterrole	否	1,2	敏感词免过滤角色配置
time	是		thqs
hash	是		thqs
pornScene	否	1,2	鉴黄场景；多个以为逗号分隔；可选值：1-鉴黄, 2-暴恐涉政
pornSwitch	否		是否开启鉴黄审核：1-开启；0-关闭
pornCallbackUrl	否		鉴黄命中回调地址
pornCallbackScene	否	1,2	回调场景；多个以为逗号分隔；回调场景；多个以为逗号分隔；可选值：1-疑似;2-违规。 eg:1,2
pornCallbackSwitch	否		是否开启鉴黄回调：1-开启；0-关闭

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取账户配置

基本信息

Path： /api/user/getconfig

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	账户id
time	是	thqs
hash	是	thqs

返回数据

名称	类型	是否必须	备注
user	object	非必须
├─ dirtyWordOperation	integer	非必须	敏感词过滤操作类型：1-删除；2-隐藏
├─ notFilterRole	string	非必须	免过滤角色：
├─ sensitiveWords	string	非必须	是否开启敏感词过滤：1-开启；0-关闭
├─ penSwitch	string	必须	激光笔画笔块切开关：0-关闭，1-开启
├─ videoLogoSwitch	string	必须	视频logo开关：0-关闭，1-开启
├─ id	string	非必须	账户id(加密)
├─ billingMode	string	必须	计费模式：0-并发，1-时长，2-流量，3-带宽
├─ videoBitrate	string	非必须	直播码率
├─ userMaxConnection	string	非必须	用户最大并发
├─ pornPermission	string	必须	直播鉴黄权限 1-开启；0-关闭
├─ pornSwitch	string	必须	直播鉴黄开关 1-开启；0-关闭
├─ pornScene	string	必须	直播鉴黄场景鉴黄场景；多个以为逗号分隔；可选值：1-鉴黄, 2-暴恐涉政
├─ pornCallbackSwitch	string	必须	直播鉴黄回调开关 1-开启；0-关闭
├─ pornCallbackUrl	string	必须	直播鉴黄回调地址
├─ pornCallbackScene	string	必须	直播鉴黄回调场景回调场景；多个以为逗号分隔；回调场景；多个以为逗号分隔；可选值：1-疑似;2-违规。 eg:1,2
result	string	必须	"ok" 表示成功
reason	string	非必须	result=fail, 失败原因

直播连麦

保存直播连麦时长配置(覆盖模式)

基本信息

Path： /api/v1/voice/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户id
totalDuration	是	3600	总时长,单位,分钟,与原来接口保持一致
modeType	是	0	0：余量不足停止 1：余量不足不停止

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true/false
error	object	非必须
├─ code	number	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ effectCount	integer	必须	1

查询用户直播连麦时长配置

基本信息

Path： /api/v1/voice/accounts

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	C783F0F7CB77E1F3,DBF655332633F3BC	用户账户ID,用逗号分割字符串,一次查询用户ID不能大于200个

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须
├─ code	number	非必须	10000000
├─ message	string	非必须	Invalid Params
data	object	非必须
├─ voiceDurations	object []	必须		item 类型: object
├─ accountId	string	必须
├─ totalDuration	number	必须	总时长,单位:分钟
├─ usedDuration	number	必须	已用时长,单位:分钟

自定义配置

配置用户自定义未登录页面

基本信息

Path： /api/custom/page/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	用户账户ID
status	是	状态,0不启用,1启用
url	是	未登录地址

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须
data	boolean	非必须	true

回放打点

删除回放打点

基本信息

Path： /api/replay/mark/point/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	备注
accountId	是	账户ID
replayId	是	回放ID
pointTime	是	删除打点时间

Body

名称	类型	是否必须	备注
accountId	string	必须	账户ID
replayId	string	必须	回放ID
pointTime	integer	必须	时间点

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

增加/编辑回放打点

基本信息

Path： /api/replay/mark/point/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
accountId	是	账户ID
replayId	是	回放ID
pointTime	是	打点时间
desc	是	打点描述
type	是	0：新增 1：修改
preTime	否	修改前的打点时间

Body

名称	类型	是否必须	备注
accountId	string	必须	账户ID
replayId	string	必须	回放ID
pointTime	integer	必须	打点时间
desc	string	必须	打点描述（不超过20个字符）
type	string	必须	0：新增 1：编辑
preTime	string	非必须	修改前的时间点（新增非必填）

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

查询回放打点列表

基本信息

Path： /api/replay/mark/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账户ID
replayId	是	99C33DC5901307461	回放ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ points	object []	必须		item 类型: object
├─ time	integer	必须	打点时间（单位：S）
├─ desc	string	必须	打点描述（不超过20个字符）

问卷

设置问卷在线导入地址

基本信息

Path： /api/userinterface/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	7A34F782E41071E8	账户ID
notifyurl	是	http://baidu.com	在先导入地址
status	是	0	1可用 0 不可用
type	是	1	1 问卷类型

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须

问答

获取直播问答数据

基本信息

Path： /api/live/qas

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	账户ID
roomid	是	直播间ID
liveid	是	直播ID
pagenum	是	每页显示数量
pageindex	是	第几页

返回数据

名称	类型	是否必须	其他信息
result	string	非必须
questionCount	number	非必须
questions	object []	非必须	item 类型: object
├─ viewerName	string	必须
├─ viewerId	string	必须
├─ viewerCustomInfo	string	必须
├─ answers	object []	必须	item 类型: object
├─ viewerName	string	必须
├─ viewerId	string	必须
├─ viewerRole	number	必须
├─ time	string	必须
├─ isPrivate	number	必须
├─ content	string	必须
├─ time	string	必须
├─ content	string	必须

课件水印

保存课件水印配置

基本信息

Path： /api/v1/watermark/account/config/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	CC账号ID
status	是	1	启用状态,默认值0不启用,1启用
type	是	1	水印类型,0用户id,1用户昵称,2固定水印,此时fixedText字段必须有值
fontSize	是	40	字体大小单位px,10-100,默认值40
fontColor	是	000000	字体颜色RGB 16进制不带#,例如000000
rotate	是	23	旋转角度,0标识不旋转,默认值,-1标识随机旋转,参数范围[-1,360]
transparency	是	20	透明度,100标识不透明
fixedText	是	水印测试	固定水印内容,当type值为2时有内容,1-10位汉字,字母或数字

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	number	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ effectCount	number	必须	更新行数

查询用户课件水印权限

基本信息

Path： /api/v1/watermark/account/permission

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	CC账户ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须
data	object	必须
├─ watermarkPermission	boolean	必须	true开启水印权限,false未开水印权限

获取课件水印配置

基本信息

Path： /api/v1/watermark/account/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	CC账户id

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true标识成功,false标识失败
error	object	非必须
├─ code	string	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ config	object	非必须
├─ accountId	string	非必须	CC账号ID,加密
├─ status	number	非必须	启用状态,默认值0不启用,1启用
├─ type	number	非必须	水印类型,0用户id,1用户昵称,2固定水印
├─ fontSize	number	非必须	字体大小单位px,10-100,默认值40
├─ fontColor	string	非必须	字体颜色RGB 16进制不带#,例如000000
├─ rotate	number	非必须	旋转角度,0标识不旋转,默认值,-1标识随机旋转,参数范围[-1,360]
├─ transparency	number	非必须	透明度,100标识不透明
├─ fixedText	string	非必须	固定文本内容,当type值为2时有内容,1-10位汉字,字母或数字

在线用户

助教端查询在线用户

基本信息

Path： /api/room/onlineusers

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
roomid	是	直播间ID
type	是	1.通过在线用户ID查询,2.在线用户名称模糊查询
value	是	在线用户ID或名称
userid	是	客户ID

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须	OK/FAIL
onlineUsers	object []	非必须		item 类型: object
├─ role	number	必须	查询角色:publisher.主讲,teacher.助教,host.主持人,student.学生
├─ ip	string	必须	ip地址
├─ groupId	string	必须	groupid
├─ name	string	必须	在线用户名称
├─ id	string	必须	在线用户ID
├─ terminal	number	必须	设备
├─ platform	number	必须	平台
roomId	string	非必须	直播间ID

搜索在线用户信息

基本信息

Path： /api/room/search/user

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		用户id
roomId	是		直播间id
type	是	1,2	1---根据用户id查询，2---根据用户名查询
value	是		用户id或则用户名值

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ success	boolean	非必须
├─ data	object	非必须
├─ roomId	string	非必须
├─ userNum	number	非必须
├─ userInfos	object []	非必须		item 类型: object
├─ id	string	非必须
├─ name	string	非必须
├─ role	string	非必须	查询角色:publisher.主讲,teacher.助教,host.主持人,student.学生
├─ ip	string	非必须
├─ platform	string	非必须
├─ terminal	string	非必须
├─ groupId	string	非必须

查询直播间在线用户

基本信息

Path： /api/room/userslist

Method： GET

接口描述：

最多只能查询300条数据

请求参数

Query

参数名称	是否必须	示例	备注
roomId	是		直播间ID
accountId	是		客户ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ roomId	string	非必须
├─ userNum	number	非必须
├─ userInfos	object []	非必须		item 类型: object
├─ id	string	非必须
├─ name	string	非必须
├─ role	string	非必须	查询角色:publisher.主讲,teacher.助教,host.主持人,student.学生
├─ ip	string	非必须
├─ platform	string	非必须
├─ terminal	string	非必须
├─ groupId	string	非必须
error	object	必须
├─ code	number	必须
├─ message	string	必须

多人连麦

增加多人连麦时长

基本信息

Path： /api/multivoice/billing/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
accountId	text	是	账号ID
amount	text	是	添加金额可以为负数
availableType	text	是	时长用尽是否停用 0停用 1：不停用
hash	text	是
time	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须

多人连麦每日连麦统计

基本信息

Path： /api/multivoice/statistic/daily

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是
start	是
end	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ date	string	非必须	日期 '2022-04-20'
├─ amount	number	非必须	金额 /分
├─ duration	number	非必须	时长/秒
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

多人连麦每日连麦详情统计

基本信息

Path： /api/multivoice/statistic/day/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
start	是
end	是
accountId	否
pageNo	是	默认从1开始
pageSize	是

返回数据

名称	类型	是否必须	备注	其他信息
multiVoices	object []	非必须		item 类型: object
├─ accountId	string	必须	账号id
├─ liveId	string	必须	直播id
├─ roomName	string	必须	直播间名称
├─ roomId	string	必须	直播间id
├─ accountName	string	必须	账号名称
├─ amount	integer	必须	连麦金额/分
├─ resolution	integer	必须	分辨率 1:240 2:480 3:720 4：1080
├─ multiVoiceDuration	integer	必须	连麦时长/秒
├─ abroad	integer	必须	是否海外 0：否 1：是
├─ interactType	integer	必须	连麦人数 1:1V1 6:1V6
├─ endTime	string	必须	直播结束时间
pagination	object	非必须
├─ pageNo	string	非必须
├─ pageSize	string	非必须
├─ total	string	非必须

多人连麦每日连麦详情统计导出

基本信息

Path： /api/multivoice/statistic/day/detail/export

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	否
date	是		默认从1开始

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
data	object []	非必须	item 类型: object
├─ accountId	string	非必须
├─ accountName	string	非必须
├─ liveId	string	非必须
├─ roomId	string	非必须
├─ roomName	string	非必须
├─ interactType	number	非必须
├─ abroad	number	非必须
├─ multiVoiceDuration	number	非必须
├─ resolution	number	非必须
├─ amount	number	非必须
├─ endTime	string	非必须

多人连麦直播数量统计

基本信息

Path： /api/multivoice/statistic/live/count

Method： GET

接口描述：

[{
"interactType": 1,
"resolution": 1,
"coun": 2000
},
{
"interactType": 6,
"resoultion": 2,
"coun": 2000
}]

请求参数

Query

参数名称	是否必须	示例	备注
date	是	2022-12

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ interactType	integer	必须	房间类型 1:1V1 6:1V6
├─ resolution	integer	必须	分辨率 1：240 2：480 3：720 4：1080 5：桌面共享
├─ count	string	必须	数量
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

批量获取多人连麦时长配置

基本信息

Path： /api/multivoice/billings

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object []	非必须		item 类型: object
├─ accountId	string	必须	账号id
├─ totalAmount	integer	必须	可用金额
├─ amount	integer	必须	已用金额
├─ availableType	integer	必须	时长用尽是否停用 0停用 1：不停用
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

获取多人连麦时长配置

基本信息

Path： /api/multivoice/billing

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	必须
├─ accountId	string	必须	账号id
├─ totalAmount	integer	必须	可用金额
├─ amount	integer	必须	已用金额
├─ availableType	integer	必须	时长用尽是否停用 0停用 1：不停用

集团账号增加多人连麦时长

基本信息

Path： /api/group/multivoice/billing/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
accountId	text	是	账号ID
amount	text	是	账号总量
availableType	text	是	时长用尽是否停用 0停用 1：不停用
hash	text	是
time	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须

直播核心业务指标

数据曲线

基本信息

Path： /api/live/concurrency/curve

Method： GET

接口描述：

说明
单用户查询时，不显示用户累计并发数和复用率
1. 按日查询，最大100天；
2. 按月查询，最大26个月；

请求参数

Query

参数名称	是否必须	示例	备注
searchType	否	0	0:默认，按日查询 1：按月查询
startTime	是	2020-03-01	开始日期
endTime	是	2020-03-13	结束日期
type	否	0	0：（默认）按全部用户查询，1：按单用户查询
accountId	否	2030182	账户ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ statis	object []	非必须		item 类型: object
├─ statisTime	string	必须
├─ room	number	必须	直播平台并发数
├─ record	number	必须	回放并发数
├─ live	number	必须	直播计费并发数
├─ aggregate	number	非必须	用户累计并发数（单用户查询不存在）

用户排行（基础统计）

基本信息

Path： /api/live/base/ranking

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
startTime	是	2020-02-13	开始日期
endTime	是	2020-03-13	结束日期
type	否	0	0：默认，直播间 1，直播，2回放
searchType	否	0	0：默认，增量查询，1，全量查询
pageNo	否	1	分页，默认1
pageSize	否	100	每页个数：100

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ ranking	object []	非必须		item 类型: object
├─ name	string	必须	名称：网络学院
├─ accountId	string	必须	账户ID:986294
├─ mobile	string	必须	手机号码
├─ email	string	必须	邮箱：wlxy@163.com
├─ regTime	string	必须	注册日期：2020-03-01
├─ times	number	必须	次数：100
├─ rank	integer	必须	排名

用户排行（并发统计）

基本信息

Path： /api/live/concurrency/ranking

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
searchType	否	0	0：默认按日查询 1：按月查询
startTime	是	2020-03-01	开始日期
endTime	是	2020-03-13	结束日期
type	否	0	0:默认，直播平台并发数 1：直播计费并发数 2：回放平台并发
pageNo	否	1	分页查询当前页码，默认1
pageSize	否	100	分页查询每页条数，默认100

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ ranking	object []	非必须		item 类型: object
├─ name	string	必须	账户名称
├─ accountId	string	必须	账户ID
├─ mobile	string	必须	手机号码
├─ email	string	必须	邮箱
├─ regTime	string	必须	注册日期
├─ times	number	必须	对应次数
├─ rank	integer	必须	排名

用户统计

基本信息

Path： /api/live/accounts/statis

Method： GET

接口描述：

错误返回信息：
{
"success": false,
"error": {
"code": 10000001,
"msg": 'invalide param'
}
}

请求参数

Query

参数名称	是否必须	示例	备注
startTime	是	2020-03-10	开始日期
endTime	是	2020-03-12	结束日期
pageNo	否	1（默认）	分页页码
pageSize	否	100（默认）	每页查询数据量

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ statis	object []	必须		item 类型: object
├─ statisTime	string	必须	统计日期
├─ servicing	number	必须	服务中的用户
├─ concurrency	number	必须	并发计费用户
├─ flow	number	必须	流量计费用户
├─ duration	number	必须	时长计费用户数
├─ bandwidth	number	必须	带宽计费用户数

直播统计(基础统计)

基本信息

Path： /api/live/base/statis

Method： GET

接口描述：

说明
1. 按日查询，最大100天；
2. 按月查询，最大26个月；

用户ID为空，则查询全部用户（包含过期用户）；
默认为空；

请求参数

Query

参数名称	是否必须	示例	备注
startTime	是	2020-03-02	开始日期
endTime	是	2020-03-06	结束日期
type	是	0	0表示按日查询，1表示按月查询
accountId	否	ECB81750584E9A75	账户ID,没有则查询所有用户的
pageNo	否	1（默认）	分页查询页码
pageSize	否	100（默认）	分页查询每页查询条数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	必须
├─ statis	object []	必须		item 类型: object
├─ statisTime	string	必须	统计日期
├─ room	number	必须	服务中的用户
├─ live	number	必须	并发计费用户
├─ record	number	必须	流量计费用户

回调

回放回调url查询

基本信息

Path： /api/callback/urls

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		账户id

返回数据

名称	类型	是否必须	备注
result	string	必须	OK/FALSE
finishNotifyUrl	string	必须	直播结束
recordCompleteNotifyUrl	string	必须	直播录制
startLiveNotifyUrl	string	必须	直播开始
offlineReplayNotifyUrl	string	必须	离线回放
finishStatus	integer	必须	1:开启 0：关闭
recordCompleteStatus	integer	必须
startLiveStatus	integer	必须
offlineReplayStatus	integer	必须

保存用户回调设置

基本信息

Path： /api/callback/urls/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	账户ID
finishnotifyurl	是	直播结束回调地址
finishstatus	是	直播结束回调是否开启 0关闭： 1开启
recordcompletenotifyurl	是	直播录制回调地址
recordcompletestatus	是	直播录制回调是否开启
startLiveNotifyUrl	是	直播开始回调地址
startLiveStatus	是	直播开始回调是否开启
offlineReplayNotifyUrl	是	离线回放回调地址
offlineReplayStatus	是	离线回放回调是否开启

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK/FALSE
reason	string	必须		invalid param

回调查询接口(新接口)

基本信息

Path： /api/v1/callbacks

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户id

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
error	object	非必须
├─ code	string	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ callbacks	object []	非必须		item 类型: object
├─ notifyUrl	string	必须	回调通知地址
├─ type	number	必须	回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用 6回放重制回调其他值未知
├─ status	number	必须	状态标识,0禁用,1启用

设置用户回调设置(新接口)

基本信息

Path： /api/v1/callbacks/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json;charset=UTF-8	请求类型,必须是:application/json;charset=UTF-8

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户id

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须	数组	item 类型: object
├─ status	number	必须	状态标识,0禁用,1启用
├─ notifyUrl	string	必须	回调地址
├─ type	number	必须	回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用,请不要使用 6回放重制回调其他值未知

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true/false
error	object	非必须
├─ code	number	非必须	10000004
├─ message	string	非必须	invalid thqs

直播间

查询当前用户是否被禁言

基本信息

Path： /api/v1/user/silence/status

Method： GET

接口描述：

请求失败时返回错误示例：
{
"success": false,
"error": {
    "code": 10000010,
    "message": "id invalid"
    }
}

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	746FA73A9959FD6F	账户ID
roomId	是	5BD4C7530C37105A9C33DC5901307461	直播间ID
userId	是	bff57badd0334765ae44926d0918dba5	学员ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true:成功 false:错误
error	object	必须	success为false时返回
├─ code	string	必须	错误码
├─ message	string	必须	错误信息
data	object	非必须
├─ isSilenced	boolean	非必须	true:禁言状态 false:未被禁言

伪直播状态查询

基本信息

Path： /api/pseudo/rooms/status

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
roomIds	是	直播间ID，逗号分隔，最多50个	F2101DC0B7695A239C33DC5901307461,E3101DC0B7695A239C33DC5901307461
accountId	是		账户ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
data	object	非必须
├─ pseudoRooms	object []	必须		item 类型: object
├─ roomId	string	必须	直播间ID
├─ status	string	必须	状态 0:失败 1.准备中 2.完成
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

关闭直播间

基本信息

Path： /api/room/close

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
roomid	是		直播间ID
userid	是		CC账户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK

创建直播间

基本信息

Path： /api/room/create

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		CC账户ID
name	是		直播间名称，最大字符40
desc	否		直播间描述，最大字符5000
templatetype	是	1	直播模板类型，请求模板信息接口可获得模板类型的详细信息。
authtype	是	0	验证方式，0：接口验证，需要填写下面的checkurl；1：密码验证，需要填写下面的playpass；2：免密码验证；3白名单验证
publisherpass	是	123456	推流端密码，即讲师密码回放推流/点播推流非必填
assistantpass	是	123456	助教端密码
playpass	是	123456	播放端密码
checkurl	否	http	验证地址
barrage	否	0	是否开启弹幕。0：不开启；1：开启，默认0
foreignpublish	否	1	是否开启第三方推流，可选，默认为0；0：不开启(即客户端推流)；1：开启，2:回放推流 3:点播推流 4网页推流；类型为1时必须开启网页登录的主持人模式，支持模板类型1、2、3、6(即大屏)；类型为2时（即伪直播）模版的大类型必须保持一致，都是文档或都是大屏；类型为3时，模版只能是大屏模版;类似为4时，必须为新模版&研讨课。
openlowdelaymode	否	1	开启直播低延时模式。0：不开启；1：开启，可选，默认为0
openchatmanage	否	1	开启聊天审核。0：不开启；1：开启，可选，默认为0
showusercount	否	0	在页面显示当前在线人数。0：不显示；1：显示可选，默认为0
openhostmode	否	0	开启主持人模式，"0"表示不开启；"1"表示开启可选，默认为0，开通主持人模式权限后方可设置
hostloginmode	否	0	主持人登录模式，"0"表示网页登录；"1"表示客户端登录可选，默认为0，客户端登录只支持模板类型4、5
warmvideoid	否		插播暖场视频，填写同一账号下云点播视频vid 可选，默认关闭；参数值为空，表示关闭
livestarttime	否	2020-01-01 00	直播开始时间；格式：yyyy-MM-dd HH:mm:ss 可选，默认为空，当选择为回放推流或点播推流时，必填，并且直播开始时间-当前时间 > 2小时
playerbackgroundhint	否		播放器提示语。未直播时播放器将显示该提示语可选，最多15个字符
manuallyrecordmode	否	1	手动录制模式。0：关闭；1：开启
clientdocpermissions	否	1	讲师文档权限。0：关闭；1：开启可选，默认关闭；
repeatedloginsetting	否	0	重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
maxaudiencenum	否	0	直播间并发人数上限可选，默认为0，表示不做限制
documentdisplaymode	否	1	文档显示模式。1：适合窗口;2:适合宽度可选，默认适合窗口
openlivecountdown	否	0	开启倒计时模式：可选，默认关闭 1开启，0：关闭
showlectueronlinenum	否	1	讲师端显示在线人数。0：不显示；1：显示可选，默认显示
showassistonlinenum	否	1	助教主持人端显示在线人数。0：不显示；1：显示可选，默认显示
hideexitbutton	否	0	隐藏观看端退出按钮。0：不开启；1：开启
alarms	否	[{"time"	直播提醒设置，格式如下：[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点（单位：分钟），类型为字符串，取值范围1-1000的整数；desc为提醒内容，类型为字符串，最多20个字符可选，默认为空
openTextPicLive	否	1	移动H5页面是否显示图文直播。0：隐藏；1：显示可选，默认为0 （需开通权限）
pseudoNeedRecord	否	1	回放/点播推流是否自动录制 0：不开启；1：开启当推流方式为回放/点播推流时，该参数有效默认为开启
pseudoSourceId	否	EB84B8907FA0EAFB	回放/点播推流资源ID （视频或回放ID，资源必须是可用状态，并且必须与所选对应模板匹配）
pseudoUserName	否	张三	讲师名称，最大字符限制20
pseudoLiveStopTime	否	2020-01-01 12	伪直播结束时间； 1.伪直播结束时间-直播开始时间<=1天并且 >=10分钟; 2.开始时间到结束时间内不能修改伪直播相关参数
chatCallbackApi	否	https	客户聊天回调地址最大300字符
inRemindFlag	否	1	进入直播是否提醒：1-是；0-否
inRole	否	1,2,3	进入直播提醒角色：1-讲师；2-助教；3-主持人；4-观看端，以逗号, 分割
inBeContent	否		进入直播提醒内容前段
inAfContent	否		进入直播提醒内容后段
outRemindFlag	否	1	退出直播是否提醒：1-是；0-否
outRole	否	1,2,3	退出直播提醒角色：1-讲师；2-助教；3-主持人；4-观看端，以逗号, 分割
outBeContent	否		退出直播提醒内容前段
outAfContent	否		退出直播提醒内容后段
cashsreward	否	1	红包打赏，1: 开启，0: 关闭（默认）
propsreward	否	1	道具打赏，1: 开启，0: 关闭（默认）
privateChat	否	1	私聊开关，1: 开启（默认），0: 关闭
mobileH5Delay	否	1	h5低延迟开关，1: 开启，0: 关闭（默认)
customMaxBitrateFlag	否	1	是否设置自定义码率 1.是; 0.否(默认) 非必填
customMaxBitrate	否	800	码率值(100-5000) customMaxBitrateFlag 为1时必填
pseudoNeedChat	否	0	伪直播是否发送回放聊天1.是; 0.否(默认) 非必填
watermark	否	0	直播间开启课件水印0不开启,1开启
relayRoomIds	否	9F06004A4B9E4FCD9C33DC5901307461,2D9A291C72D087899C33DC5901307461	转播直播间ids,以逗号分隔
globalSkinSwitch	否	0	是否引用全局配置 0:不引用 1:引用
templateVersion	否	2	新模板 2:新模板
practiceAnswerUserHide	否		随堂测答题人数隐藏 0:显示 1:隐藏
replayDocShowStatus	否		回放文档目录状态 0:隐藏 1:显示
viewMode	否	0	观看模式：0-标准，1-低延迟，2-无延迟，默认0；
multipleVoice	否	0	多人连麦开关：0-关闭，1-开启；默认0
multipleVoiceResolution	否	0	多人连麦分辨率：1 - 640480; 2 - 1280720
multipleVoiceMaxStream	否	7	1v1 赋值2,1v6赋值7；默认开启情况下，为7
enableCallbackOnLiveRoom	否	0	直播间下回调开关；0-关闭，1-开启；默认0；当前值为0时，所有直播间下回调的开启/关闭、url修改等将不生效。
enableLiveStartCallback	否	0	开启/关闭开始直播回调；0-关闭，1-开启；默认0；
enableLiveEndCallback	否	0	开启/关闭结束直播回调；0-关闭，1-开启；默认0；
enableRecordingCallback	否	0	开启/关闭直播录制回调；0-关闭，1-开启；默认0；
enableCcrCallback	否	0	开启/关闭离线回放回调；0-关闭，1-开启；默认0；
enableCompositionCallback	否	0	开启/关闭回放重制回调；0-关闭，1-开启；默认0；
liveStartCallbackUrl	否	0	直播开始回调地址；enableLiveStartCallback为1时必需且合法；url长度限制500字符以内；
liveEndCallbackUrl	否	0	直播结束回调地址；enableLiveEndCallback为1时必需且合法；url长度限制500字符以内；
recordingCallbackUrl	否	0	直播录制回调地址；enableRecordingCallback为1时必需且合法；url长度限制500字符以内；
ccrCallbackUrl	否	0	离线回放回调地址；enableCcrCallback为1时必需且合法；url长度限制500字符以内；
compositionCallbackUrl	否	0	回放重制回调地址；enableCompositionCallback为1时必需且合法；url长度限制500字符以内；
rebroadcastSwitch	否	0	是否打开转播开关。默认0不打开，1是打开
rebroadcastType	否	sender	转播直播间类型，sender大直播间，receiver小直播间
rebroadcastMode	否	single	转播模式。single单师，double双师。默认single
rebroadcastReceivers	否	9F06004A4B9E4FCD9C33DC5901307461,2D9A291C72D087899C33DC5901307461	接受转播直播间加密id列表；有多个时用逗号分隔
rebroadcastRecording	否	0	是否录制 0关闭，1开启
videoLogoSwitch	是	视频logo开关	0关闭，1开启
replayAutoClipTime	否	2021-11-16 12	自动录制时间
webloginverify	否	0	0关闭，1开启
playerbackgroundimageuri	否	http	播放器背景图
showmobilead	否	0	移动端广告开关，0关闭，1开启
admaterials	否	[{"type"	移动端广告素材;type:1 文本 2 图片
sharepicture	是	http	分享设置：图标
sharetitle	是	这是标题	分享设置：标题
sharedescribe	是	这是描述	分享设置：描述
openmarquee	否	1	跑马灯功能。0：关闭；1：开启可选，默认为0
marFontSize	否	15	跑马灯字体大小最小12 最大50 可选，默认为20，开启跑马灯生效
marFontSpeed	否	1.0	跑马灯字体速度可选值为0.5 1.0 1.5 2.0 可选，默认1.0，开启跑马灯生效
marFontColor	否	#ffffff	跑马灯字体颜色，默认#ffffff（白色），以"#"开头，字符串长度为7，开启跑马灯生效
virtualChat	否	1	虚拟聊天功能，0：关闭；1：开启默认为0
timingRecord	否	1	定时录制开关，1：开启；0-关闭；默认0，其他值将失败。备注: 转播直播间不可开启定时录制
timingRecordStart	否	2022-01-20 16	定时录制开始时间（如：2022-01-20 16:04:25）， timingRecord=1时，此值才生效，有效值范围：(服务器当前时间,服务器当前时间 + 7 *24H]
threePartScreenMode	否	1	三分屏开关，1：开启；0-关闭；默认0，其他值将失败。备注: 三分屏模式只有在直播间为文档模式时生效
likeSwitch	否	1	点赞开关，0为关闭，1为开启默认关闭
giftGlobalSwitch	否	1	是否引用礼物全局开关，0关闭 1开启默认关闭
shareSwitch	否	1	视频分享开关，0关闭 1开启默认开启
inviteSwitch	是	1	邀请卡开关，0关闭 1开启默认开启
seminarMaxStreams	否	5	研讨课最大连麦人数
seminarResolution	否	240	研讨课分辨率
seminarMainSpeakerAuth	否	0	研讨课主讲认证类型，可选0：接口验证，1：单密码验证
seminarMainSpeakerAuthUrl	否		研讨课主讲接口验证地址。seminarMainSpeakerAuth为0时必须。
seminarMainSpeakerAuthPass	否		研讨课主讲验证密码。seminarMainSpeakerAuth为1时必须。
seminarSecondSpeakerAuth	否		研讨课嘉宾认证类型。可选：0接口验证，1:单密码验证，2免密码，3白名单
seminarSecondSpeakerAuthUrl	否		研讨课嘉宾接口验证地址。seminarSecondSpeakerAuth为0时必须。
seminarSecondSpeakerAuthPass	否		研讨课嘉宾验证密码。seminarSecondSpeakerAuth为1时必须。
seminarSecondSpeakerAuthWhiteList	否	{name1	研讨课嘉宾验证白名单。不是id。seminarSecondSpeakerAuth为3时必须。
liveScene	否	0	0为大班课，1是研讨课。默认0
chatSyncUrl	否	http	直播间聊天同步url,长度小于等于250字符,http或https协议
viewStreamSource	否		观看端查看流类型；0-直播合流；1-网页录制流(仅小班课房间支持配置)
mobileViewMode	否		移动端观看模式 1：横屏 2：竖屏(需要vunio竖屏观看权限)，只在纯视频模式下支持
multiStreamSwitch	否	1	多流直播开关 0:关闭 1：开启
seminarSource	否	1	研讨会直播间来源。默认0，小班课1.为1时不再通知小班课。
pcFullScreenMode	否	0	PC播放器全屏模式：0-网页全屏；1-系统全屏;
skinLoginMobileBgImg	否		移动端登录背景图; templateVersion=2且skinId非空此值生效；
skinLoginPcBgImg	否		pc登录背景图； templateVersion=2且skinId非空此值生效；
skinLoginPcBgMode	否	0	pc登录背景图-展示模式：0-全屏封面；1-前景封面； templateVersion=2且skinId非空此值生效；
skinLoginPcBgBrightness	否	8	pc登录背景图-亮度:[0,20]； templateVersion=2且skinId非空此值生效；
skinLoginPcBgBlurriness	否	5	pc登录背景图-模糊度:[0,10]； templateVersion=2且skinId非空此值生效；
skinLoginShareImg	否	0	pc、移动端登录是否共享图片：0-否；1-是； templateVersion=2且skinId非空此值生效；
skinId	否		templateVersion=2且skinId非空此值生效；
skinName	否		templateVersion=2且skinId非空此值生效；
skinBgImg	否		templateVersion=2且skinId非空此值生效；
skinBgColor	否		templateVersion=2且skinId非空此值生效；
skinMarginTop	否		templateVersion=2且skinId非空此值生效；
userRoleSwap	否	1	是否开启'旁听-互动身份互换'，1开启，0反之。

返回数据

名称	类型	是否必须	备注	其他信息
result	string	必须
room	object	非必须
├─ id	string	非必须	直播间id
├─ publishUrls	string []	非必须	推流地址，第三方推流的直播间可以获取到此参数	item 类型: string
├─		非必须

删除直播间

基本信息

Path： /api/room/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
roomids	是		直播间id，支持多个，id之间以英文逗号","分隔，批量删除数量不能超过100个
userid	是		CC账户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK

开启直播间

基本信息

Path： /api/room/open

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
roomid	是		直播间ID
userid	是		CC账户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK

开启直播间禁言

基本信息

Path： /api/room/chat/mute

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
roomId	是	E5D46A05AA9AD4469C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

批量修改直播间虚拟人数基数

基本信息

Path： /api/rooms/usercount/set

Method： GET

接口描述：

用户传入多个直播间id，会对合法的直播间id对应的直播间配置虚拟人数基数。
不合法的直播间id会返回给用户。

请求参数

Query

参数名称	是否必须	示例	备注
roomIds	是	639030792E1704F59C33DC5901307461,A888434215604AB49C33DC5901307461	最多支持50个直播间，多个直播间中间用逗号分割
accountId	是	0E392F1053F73AD5	账户id
count	是	100	虚拟人数基数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ failRooms	string []	非必须	存在异常的直播间id（直播间id格式不正确，直播间id与账户id不匹配）	item 类型: string
├─		非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

批量创建转播小直播间

基本信息

Path： /api/room/rebroadcast/receivers

Method： POST

接口描述：

rebroadcastReceivers对应数组的个数代表要创建的小直播间数量。
"viewerAuth.authType": "直播间学院观看验证方式可选值：api、singlePassword、passwordFree、whiteList",
"viewerAuth.authValidateUrl": "authType为url时，对应的接口验证地址",
"viewerAuth.authPassword": "singlePassword时，对应的密码",
"viewerAuth.authWhiteListId": "whiteList时，对应的白名单列表id"

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
accountId	text	是	998757E82C929B62	账号id
rebroadcastSenderId	text	是	34A952E24E4D3C5B9C33DC5901307461	转播大直播间id
rebroadcastReceivers	text	是	[{"name":"sidaa2","viewerAuth":{"authTypeStr":"singlePassword","authPassword":"112"}}]	字符串格式的自定义小直播间。具体字段含义可参考备注。
time	text	是	1595926987037	当前时间戳（毫秒）
hash	text	是	96CDEE621BBA8617F5EE7465F17F8398	根据THQS算法所得hash

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true时接口执行成功
data	object	必须
├─ rebroadcastReceivers	object []	必须		item 类型: object
├─ id	string	必须	创建好的小直播id
├─ name	string	必须	小直播间name

批量查询专题直播间信息

基本信息

Path： /api/topic/rooms/info

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
accountId	是		C783F0F7CB77E1F3

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ id	string	必须	直播间ID
├─ language	number	必须	0：中文 1：英文

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息
data	object	非必须
├─ rooms	object []	非必须		item 类型: object
├─ viewUrl	string	必须	直播观看链接
├─ templateType	number	必须	模版类型
├─ name	string	必须	直播间名称
├─ id	string	必须	直播间ID
├─ status	number	必须	直播间状态
├─ authType	number	必须	直播间
├─ playPass	string	非必须
├─ checkUrl	string	非必须

批量查询直播间虚拟人数基数

基本信息

Path： /api/rooms/usercount/get

Method： GET

接口描述：

只会返回符合要求的直播间配置的虚拟人数基数。
直播间id格式不正确，直播间id不属于对应账户id不会显示。
如果直播间未配置该参数，则默认显示为0.

请求参数

Query

参数名称	是否必须	示例	备注
roomIds	是		最多支持50个直播间，多个直播间中间用逗号分割
accountId	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ rooms	object []	非必须		item 类型: object
├─ id	string	必须	直播间id
├─ count	integer	必须	虚拟人数基数
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

伪直播资源信息查询

基本信息

Path： /api/pseudo/source

Method： GET

接口描述：

success = true ,说明此资源可用并且支持当前模板

请求参数

Query

参数名称	是否必须	示例	备注
sourceId	是	5F414DB73103B318	资源Id（回放/点播推流ID）
foreignPublish	是	2	推流类型 2：回放推流 3.点播推流
accountId	是	CF414DB73103B318	账户ID

返回数据

名称	类型	是否必须	备注
success	string	非必须
data	object	非必须
├─ sourceInfo	object	必须
├─ sourceType	number	必须	资源类型（2.回放 3.点播视频）
├─ sourceId	string	必须	资源ID
├─ hasPdf	boolean	必须	是否支持文档true/false
├─ pseudoRecordInfo	object	非必须	回放信息
├─ title	string	必须	回放标题
├─ encryptVideoId	string	必须	视频ID（加密）
├─ encryptRecordId	string	必须	回放ID（加密）
├─ url	string	必须	回放观看地址
├─ pseudoVideoInfo	object	非必须	视频信息
├─ url	string	必须	视频下载地址
├─ encryptVideoId	string	必须	回放ID（加密）
├─ md5	string	必须	视频md5
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须

查询直播间信息

基本信息

Path： /api/room/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	ECB81750584E9A75	CC账户id
roomid	是	F26CB70F3F971A609C33DC5901307461	直播间id

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须	"OK"/"FAIL"
room	object	非必须
├─ id	string	必须	直播间ID
├─ name	string	必须	直播间名称
├─ desc	string	必须	直播间描述
├─ status	number	必须	直播间状态
├─ publisherPass	string	必须	推流端登录密码
├─ playPass	string	必须	学员登录密码
├─ assistantPass	string	必须	助教大呢赶路密码
├─ checkUrl	string	必须	接口验证地址
├─ templateType	number	必须	模板
├─ authType	number	必须	登录验证方式
├─ barrage	number	必须
├─ publishUrls	string []	必须	推流地址	item 类型: string
├─		非必须
├─ openLowDelayMode	string	必须	是否开启低延迟模式
├─ delayTime	string	必须	延时时间，单位秒。低延时模式下该值为0.
├─ showUserCount	string	必须	显示在线人数
├─ openHostMode	string	必须	是否开启主持人模式
├─ hostLoginMode	string	必须	主持人登录模式网页登录/客户端登录
├─ foreignPublish	number	必须	第三方推流1,回放推流2,点播推流3,网页推流4(研讨会)
├─ warmVideoId	string	必须	暖场视频ID
├─ liveStartTime	string	必须	直播开始时间
├─ playerBackgroundHint	string	必须	播放器提示语。未直播时播放器将显示该提示语
├─ manuallyRecordMode	string	必须	手动录制模式。0：关闭；1：开启
├─ clientDocPermissions	string	必须	讲师文档权限。0：关闭；1：开启可选，默认关闭；
├─ openMarquee	string	必须	跑马灯功能。0：关闭；1：开启可选，默认为0
├─ marFontSize	string	非必须	跑马灯字体大小最小12 最大50 可选，默认为20，开启跑马灯返回
├─ marFontSpeed	string	非必须	跑马灯字体速度值为0.5 1.0 1.5 2.0 可选，默认1.0，开启跑马灯返回
├─ marFontColor	string	非必须	跑马灯字体颜色以"#"开头，字符串长度为7，默认#ffffff（白色），开启跑马灯返回
├─ repeatedLoginSetting	string	必须	重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
├─ maxAudienceNum	string	必须	直播间并发人数上限可选，默认为0，表示不做限制
├─ openTextPicLive	string	必须	移动H5页面是否显示图文直播。0：隐藏；1：显示可选，默认为0 （需开通权限）
├─ documentDisplayMode	string	必须	文档显示模式。1：适合窗口;2:适合宽度可选，默认适合窗口
├─ openLiveCountdown	string	必须	可选，默认关闭
├─ alarms	string	必须	直播提醒设置，格式如下：[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点（单位：分钟），类型为字符串，取值范围1-1000的整数；desc为提醒内容，类型为字符串，最多20个字符可选，默认为空
├─ openChatManage	string	必须	开启聊天审核。0：不开启；1：开启，可选，默认为0
├─ showLectuerOnlineNum	string	必须	讲师端显示在线人数。0：不显示；1：显示可选，默认显示
├─ showAssistOnlineNum	string	必须	助教主持人端显示在线人数。0：不显示；1：显示可选，默认显示
├─ hideExitButtonFlag	string	必须	隐藏观看端退出按钮
├─ pseudoNeedRecord	string	非必须	伪直播推流是否需要录制 0否 1：是
├─ pseudoSourceId	string	非必须	伪直播推流资源ID
├─ pseudoUserName	string	非必须	伪直播客户端登录名
├─ pseudoLiveStopTime	string	非必须	伪直播结束时间
├─ chatCallbackApi	string	非必须	聊天回调地址
├─ cashsReward	string	非必须	红包打赏，1: 开启，0: 关闭
├─ propsReward	string	非必须	道具打赏，1: 开启，0: 关闭
├─ privateChat	string	非必须	私聊开关，1开启，（默认开启），0：关闭
├─ virtualChat	string	非必须	虚拟聊天，1开启 0关闭
├─ mobileH5Delay	string	非必须	h5低延迟开关，1开启，0：关闭
├─ inRemindFlag	string	必须	进入房间提醒开关，1：开启，0：关闭
├─ inBeContent	string	非必须	进入房间提醒前缀
├─ inAfContent	string	非必须	进入房间提醒后缀
├─ inRole	string	非必须	进入房间提醒角色,1-讲师；2-助教；3-主持人；4-观看端	mock: [1,2,3,4]
├─ outRemindFlag	string	必须	离开房间提醒开关，1：开启，0：关闭
├─ outBeContent	string	非必须	离开房间提醒前缀
├─ outAfContent	string	非必须	离开房间提醒后缀
├─ outRole	string	非必须	离开房间提醒角色,1-讲师；2-助教；3-主持人；4-观看端	mock: [1,2,3,4]
├─ customMaxBitrateFlag	string	必须	是否设置自定义码率 1.是; 0.否
├─ customMaxBitrate	string	非必须	码率值 customMaxBitrateFlag=1时返回
├─ pseudoNeedChat	number	必须	伪直播是否发送回放聊天 1.是; 0.否
├─ createTime	string	必须	创建时间 ,格式:yyyy-MM-dd HH:mm:ss
├─ platform	string	必须	平台,1.云直播;5.云课堂;
├─ relayRoomIds	string	非必须	转播直播间ids. 以逗号, 分隔
├─ viewMode	integer	非必须	观看模式：0-标准，1-递延，2-无延迟，默认0；
├─ multipleVoice	integer	非必须	多人连麦开关：0-关闭，1-开启；默认0
├─ multipleVoiceResolution	integer	非必须	多人连麦分辨率：0 - 640360; 1 - 1280720
├─ multipleVoiceMaxStream	integer	必须	1v1 赋值2,1v6赋值7,1v16赋值17；默认开启情况下，为7
├─ callbackOnLiveRoom	object	必须
├─ enableCallbackOnLiveRoom	integer	必须	直播间下回调开关；0-关闭，1-开启；默认0；	mock: 0
├─ items	object []	必须	所有的具体回调项。	item 类型: object
├─ classify	string	必须	分类：（LIVE_START、LIVE_END、RECORDING、CCR、COMPOSITION）	mock: LIVE_START
├─ enable	integer	必须	开启/关闭当前分类的回调；0-关闭，1-开启；默认0；	mock: 0
├─ url	string	必须	回调地址
├─ rebroadcast	object	必须
├─ switch	integer	必须	转播开关。0未开启转播，1开启了转播。
├─ type	string	非必须	转播类型。sender大直播间，receiver小直播间。
├─ mode	string	非必须	转播模式。single单师，double双师。默认single
├─ recording	integer	非必须	是否录制。0不录制，1录制。
├─ hideLecturerUrl	integer	非必须	是否隐藏讲师推流地址，单师小直播间需要。0不需要隐藏，1需要隐藏。
├─ receivers	string	非必须	所有的小直播间ids。加密id，多个之间用逗号分隔
├─ replayAutoClipTime	string	必须	自动录制时间(yyyy-MM-dd HH:mm:ss)
├─ timingRecord	object	必须	定时录制
├─ ifOpen	integer	必须	定时录制开关。0：关闭；1开启
├─ startTime	string	非必须	定时录制开始时间。如：2022-01-20 16:04:25
├─ likeSwitch	integer	非必须	点赞开关，0为关闭，1为开启默认关闭
├─ giftGlobalSwitch	integer	非必须	是否引用礼物全局开关，0关闭 1开启默认关闭
├─ shareSwitch	string	非必须	视频分享开关，0关闭 1开启默认开启
├─ voteSwitch	integer	非必须
├─ redEnvelopesSwitch	integer	非必须
├─ weChatSwitch	integer	非必须
├─ inviteSwitch	integer	非必须	邀请卡开关，0关闭 1开启默认开启
├─ liveScene	number	必须	0为大班课，1是研讨课。默认0
├─ seminarSettings	object	非必须
├─ seminarStreams	number	非必须	研讨课连麦人数
├─ seminarResolution	number	非必须	研讨课分辨率
├─ seminarMainSpeakerAuth	number	非必须	研讨课主讲认证类型，可选0：接口验证，1：单密码验证
├─ seminarMainSpeakerAuthUrl	string	非必须	研讨课主讲接口验证地址。seminarMainSpeakerAuth为0时必须。
├─ seminarMainSpeakerAuthPass	string	非必须	研讨课主讲验证密码。seminarMainSpeakerAuth为1时必须。
├─ seminarSecondSpeakerAuth	number	非必须	研讨课嘉宾认证类型。可选：0接口验证，1:单密码验证，2免密码，3白名单
├─ seminarSecondSpeakerAuthUrl	string	非必须	研讨课嘉宾接口验证地址。seminarSecondSpeakerAuth为0时必须。
├─ seminarSecondSpeakerAuthPass	string	非必须	研讨课嘉宾验证密码。seminarSecondSpeakerAuth为1时必须。
├─ seminarSecondSpeakerAuthWhiteList	string	非必须	研讨课嘉宾验证白名单。不是id。seminarSecondSpeakerAuth为3时必须。
├─ watchFrequencySwitch	integer	必须	显示观看次数
├─ enableInteractionGame	integer	非必须	1开启互动游戏，0未开启。
├─ enableSuffixViewerId	integer	非必须	1开启昵称后缀，0未开启
├─ mobileViewMode	integer	非必须	移动端观看模式 1：横屏 2：竖屏(需要vunio竖屏观看权限)，只在纯视频模式下支持
├─ multiStreamSwitch	integer	非必须	多流直播开关 0:关闭 1：开启
├─ pcFullScreenMode	integer	非必须	PC播放器全屏模式：0-网页全屏；1-系统全屏;
├─ skinLoginMobileBgImg	integer	非必须	移动端登录背景图
├─ skinLoginPcBgImg	integer	非必须	pc登录背景图
├─ skinLoginPcBgMode	integer	非必须	pc登录背景图-展示模式：0-全屏封面；1-前景封面；
├─ skinLoginPcBgBrightness	integer	非必须	pc登录背景图-亮度:[0,20]；
├─ skinLoginPcBgBlurriness	integer	非必须	pc登录背景图-模糊度:[0,10]；
├─ skinLoginShareImg	integer	非必须	pc、移动端登录是否共享图片：0-否；1-是；
├─ skinId	string	非必须
├─ skinName	string	非必须
├─ skinBgImg	string	非必须
├─ skinBgColor	string	非必须
├─ skinMarginTop	integer	非必须

直播间列表查询

基本信息

Path： /api/rooms/search

Method： GET

接口描述：

Admin系统调用该接口获取直播间列表信息。

增加platform参数未完成。

请求参数

Query

参数名称	是否必须	示例	备注
searchtype	否	0	查询类型，0:全部(default), 1:ID查询, 2:直播间名称查询
q	否	753C612EB38A8D5A	查询内容，如果查询类型为1或2，该字段为必须
searchstatus	否	0	查询状态，0:全部状态(default), 1:开启状态, 2:关闭状态
pagenum	否	50	每页返回个数，默认50
pageindex	否	1	页码，默认1
userid	是	75C86C5FD6EB9934	客户ID
livestarttime	否	2019-09-01	直播开始时间，查询的详细时间为：2019-09-01 00:00:00
liveendtime	否	2019-09-02	直播结束时间，查询的详细时间为：2019-09-02 23:59:59
platform	否	0	平台，0:全部（默认）；1:直播；5:小班课
roomIds	否	75C86C5FD6EB993475C86C5FD6EB9934，65C86C5FD6EB993475C86C5FD6EB9934	查询的直播间ID

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须	"OK"，表示请求成功
rooms	object []	非必须	返回直播间列表	item 类型: object
├─ templateType	number	必须	模板类型
├─ assistantPass	string	必须	助教密码
├─ dvr	string	必须	直播时延开关，1:开启
├─ warmVideoId	string	必须	暖场视频的加密ID
├─ barrage	number	必须	开启弹幕信息，1:开启
├─ foreignPublish	number	必须	第三方推流1,回放推流2,点播推流3,网页推流4(研讨会)
├─ liveStartTime	string	必须	直播的开始时间，时间格式："yyyy-MM-dd HH:mm:ss"
├─ multiQuality	string	必须	多清晰度
├─ publishUrl	string	必须	推流地址
├─ platform	string	必须	平台，1:直播；5:小班课
├─ showUserCount	string	必须	显示在线并发，1:显示
├─ openLowDelayMode	string	必须	开启低延迟模式
├─ openHostMode	string	必须	主持人模式，1:开启
├─ name	string	必须	直播间名称
├─ delayTime	string	必须	延迟时间
├─ id	string	必须	直播间加密ID
├─ playPass	string	必须	观看页面登录密码
├─ authType	number	必须	验证方式，0:接口验证；1:单密码验证；2:免密码验证；3:白名单验证；
├─ checkUrl	string	必须	验证接口
├─ desc	string	必须	描述信息
├─ status	number	必须	直播间状态，10:正常；20:关闭；40:封禁；100:删除；
├─ publisherPass	string	必须	客户端密码
├─ rebroadcast	object	必须
├─ switch	integer	必须	转播开关；0未开转播，1开启了转播。
├─ type	string	非必须	转播类型。sender大直播间，receiver小直播间。
count	number	非必须	查询直播间总数

直播间在线用户列表

基本信息

Path： /api/room/userslist

Method： GET

接口描述：

获取当前直播间用户列表个数，如果当前直播间多余300人，随机返回300人。如果不满300人全部返回用户信息

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		帐号id
roomId	是		直播间id

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须	ok
roomId	string	非必须	直播间id
userNum	number	非必须	获取当前直播间用户个数
onlineUsers	object []	非必须	在线用户信息	item 类型: object
├─ id	string	必须	学员id
├─ name	string	必须	学员姓名
├─ role	string	必须	角色
├─ ip	string	必须	ip地址
├─ platform	string	必须
├─ terminal	string	必须
├─ groupId	string	必须

直播间封禁列表查询（IP列表+用户列表）数据量太大时存在性能问题

基本信息

Path： /api/v1/silence/list

Method： GET

接口描述：

该接口存在性能问题，当数据量太大时会导致接口超时，返回错误
请求失败时返回错误示例：
{
"success": false,
"error": {
    "code": 10000010,
    "message": "id invalid"
    }
}

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账户ID（admin ID）
roomId	是	345F894915873A6D9C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		true:成功 false:失败
error	object	必须		success=false时，必须
├─ code	string	必须		错误码
├─ message	string	必须		错误信息
data	object	非必须
├─ userSilenceList	string []	非必须		用户禁言列表	item 类型: string
├─		非必须	541d866ad96946739e8cf35992991793
├─ ipSilenceList	string []	非必须		IP禁言列表	item 类型: string
├─		非必须	127.0.0.1

直播间转播信息查询

基本信息

Path： /api/v1/rebroadcast/rooms

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	EFBD36DD60E3AD1E	账号id
roomIds	是	A896E54916B561689C33DC5901307461,CA6FFF3570A8F9F7D9C33DC5901307461,C94EF65F45D4904779C33DC5901307461	加密直播间id列表，多个id间逗号分隔

返回数据

名称	类型	是否必须	备注
success	boolean	必须
data	object	必须
├─ A896E54916B561689C33DC5901307461	object	非必须	直播间id1
├─ type	string	非必须	转播直播间类型，sender大直播间，receiver小直播间
├─ switch	string	必须	是否是1个转播直播间；0不是，1是
├─ mode	string	非必须	转播模式。single单师，double双师。默认single
├─ A6FFF3570A8F9F7D9C33DC5901307461	object	非必须	直播间id2
├─ type	string	非必须	转播直播间类型，sender大直播间，receiver小直播间
├─ switch	string	必须	是否是1个转播直播间；0不是，1是
├─ mode	string	非必须	转播模式。single单师，double双师。默认single

研讨课直播间配置查询

基本信息

Path： /room/seminar-conf

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账号id

返回数据

名称	类型	是否必须	备注
result	string	非必须	OK为成功
data	object	非必须
├─ accountId	string	非必须
├─ maxResolution	number	非必须
├─ defaultResolution	number	非必须
├─ maxStreams	number	非必须

编辑直播间

基本信息

Path： /api/room/update

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		CC账户ID
roomid	是		直播间id
name	是		直播间名称
desc	是		直播间描述，最大字符5000
templatetype	是	1	直播模板类型，请求模板信息接口可获得模板类型的详细信息。
authtype	是	0	验证方式，0：接口验证，需要填写下面的checkurl；1：密码验证，需要填写下面的playpass；2：免密码验证
publisherpass	是	123456	讲师端密码回放推流/点播推流非必填
assistantpass	是	123456	助教端密码
playpass	是	123456	播放端密码
checkurl	否	http	验证地址
barrage	否	0	是否开启弹幕。0：不开启；1：开启，默认0
openlowdelaymode	否	1	是否开启低延迟模式
openchatmanage	否	1	开启聊天审核。0：不开启；1：开启，可选，默认为0
showusercount	否	0	在页面显示当前在线人数。0：不显示；1：显示可选，默认为0
warmvideoid	否		暖场视频ID
livestarttime	否	2020-01-01 00	直播开始时间；格式：yyyy-MM-dd HH:mm:ss 可选，默认为空，当选择为回放那个推流或点播推流时，必填，并且直播开始时间-当前时间 > 2小时
playerbackgroundhint	否		播放器提示语。未直播时播放器将显示该提示语可选，最多15个字符
manuallyrecordmode	否	1	手动录制模式。0：关闭；1：开启
clientdocpermissions	否	1	讲师文档权限。0：关闭；1：开启可选，默认关闭；
repeatedloginsetting	否	0	重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
maxaudiencenum	否	0	直播间并发人数上限可选，默认为0，表示不做限制
documentdisplaymode	否	1	文档显示模式。1：适合窗口;2:适合宽度可选，默认适合窗口
openlivecountdown	否	0	开启倒计时模式可选，默认关闭 0关闭 1开启
showlectueronlinenum	否	1	讲师端显示在线人数。0：不显示；1：显示可选，默认显示
showassistonlinenum	否	1	助教主持人端显示在线人数。0：不显示；1：显示可选，默认显示
hideexitbutton	否	0	隐藏观看端退出按钮。0：不开启；1：开启
alarms	否		直播提醒设置，格式如下：[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点（单位：分钟），类型为字符串，取值范围1-1000的整数；desc为提醒内容，类型为字符串，最多20个字符可选，默认为空
openTextPicLive	否	移动H5页面是否显示图文直播。0：隐藏；1：显示	可选，默认为0 （需开通权限）
pseudoNeedRecord	否	1	回放/点播推流是否自动录制 0：不开启；1：开启当推流方式为回放/点播推流时，该参数有效默认为开启
pseudoSourceId	否	EB84B8907FA0EAFB	回放/点播推流资源ID （视频或回放ID，资源必须是可用状态，并且必须与所选对应模板匹配）
pseudoUserName	否	张三	回放/点播推流模式必须，推流客户端登录名称讲师名称，最大字符限制20
pseudoLiveStopTime	否	2020-01-01 12	伪直播结束时间； 1.伪直播结束时间-直播开始时间<=1天并且 >=10分钟; 2.开始时间到结束时间内不能修改伪直播相关参数
chatCallbackApi	否	https	客户聊天回调地址最大300字符,chatCallbackFlag 为1的时候必传
cashsreward	否	1	红包打赏，1: 开启，0: 关闭（默认）
propsreward	否	1	道具打赏，1: 开启，0: 关闭（默认）
privateChat	否	1	私聊开关，1: 开启（默认），0: 关闭
mobileH5Delay	否	1	h5低延迟开关，1: 开启，0: 关闭（默认)
customMaxBitrateFlag	否	1	是否设置自定义码率 1.是; 0.否非必填; 注:不传此参数则保持当前设置
customMaxBitrate	否	800	码率值(100-5000) customMaxBitrateFlag 为1时必填
pseudoNeedChat	否	0	伪直播是否发送回放聊天 1.是; 0.否非必填; 注:不传此参数则保持当前设置
watermark	否	1	直播间课件水印开关,0关闭,1开启
relayRoomIds	否	9F06004A4B9E4FCD9C33DC5901307461,2D9A291C72D087899C33DC5901307461	转播直播间ids ，以逗号, 分隔
viewMode	否	0	观看模式：0-标准，1-低延迟，2-无延迟，默认0；
multipleVoice	否	0	多人连麦开关：0-关闭，1-开启；默认0
multipleVoiceResolution	否	0	多人连麦分辨率：1 - 640480; 2 - 1280720
multipleVoiceMaxStream	否	7	1v1 赋值2,1v6赋值7；默认开启情况下，为7
enableCallbackOnLiveRoom	否	0	直播间下回调开关；0-关闭，1-开启；默认0；当前值为0时，所有直播间下回调的开启/关闭、url修改等将不生效。
enableLiveStartCallback	否	0	开启/关闭开始直播回调；0-关闭，1-开启；默认0；
enableLiveEndCallback	否	0	开启/关闭结束直播回调；0-关闭，1-开启；默认0；
enableRecordingCallback	否	0	开启/关闭直播录制回调；0-关闭，1-开启；默认0；
enableCcrCallback	否	0	开启/关闭离线回放回调；0-关闭，1-开启；默认0；
enableCompositionCallback	否	0	开启/关闭回放重制回调；0-关闭，1-开启；默认0；
liveStartCallbackUrl	否	0	直播开始回调地址；enableLiveStartCallback为1时必需且合法；url长度限制500字符以内；
liveEndCallbackUrl	否	0	直播结束回调地址；enableLiveEndCallback为1时必需且合法；url长度限制500字符以内；
recordingCallbackUrl	否	0	直播录制回调地址；enableRecordingCallback为1时必需且合法；url长度限制500字符以内；
ccrCallbackUrl	否	0	离线回放回调地址；enableCcrCallback为1时必需且合法；url长度限制500字符以内；
compositionCallbackUrl	否	0	回放重制回调地址；enableCompositionCallback为1时必需且合法；url长度限制500字符以内；
customMenu	否		自定义菜单数据
picTxtMenuContent	否		图文菜单数据
rebroadcastSwitch	否	0	是否打开转播开关。默认0不打开，1是打开;该项配置不可更改
rebroadcastType	否	sender	转播直播间类型，sender大直播间，receiver小直播间；
rebroadcastMode	否	single	转播模式。single单师，double双师。默认single
rebroadcastReceivers	否	9F06004A4B9E4FCD9C33DC5901307461,2D9A291C72D087899C33DC5901307461	接受转播直播间加密id列表；有多个时用逗号分隔；
rebroadcastRecording	否	0	是否录制 0关闭，1开启；
replayAutoClipTime	否	2021-11-16 12	自动录制时间
openmarquee	否	1	跑马灯功能。0：关闭；1：开启可选，默认为0
marFontSize	否	25	int 类型默认20 最小12 最大50
marFontSpeed	否	1.5	double类型可选值： 0.5， 1.0 ，1.5 ，2.0 默认1.0
marFontColor	否	#ffffff	string类型默认#ffffff（白色）以"#"开头，字符串长度为7
virtualChat	否	1	虚拟聊天功能。0：关闭；1：开启可选，默认为0
modelId	否	1	模板ID。0：非登记验证 1：登记验证
timingRecord	否	1	定时录制开关，1：开启；0-关闭；默认0
timingRecordStart	否	2022-01-20 16	定时录制开始时间（如：2022-01-20 16:04:25），timingRecord=1时，此值有效值范围：(服务器当前时间,服务器当前时间 + 7 *24H]
threePartScreenMode	否	1	三分屏开关，1：开启；0-关闭；默认0，其他值将失败。备注: 三分屏模式只有在直播间为文档模式时生效
likeSwitch	否	1	点赞开关，0为关闭，1为开启默认关闭
giftGlobalSwitch	否	1	是否引用礼物全局开关，0关闭 1开启默认关闭
shareSwitch	否	1	视频分享开关，0关闭 1开启默认开启
voteSwitch	否		视频分享开关，0关闭 1开启默认关闭
redEnvelopesSwitch	否		视频分享开关，0关闭 1开启默认关闭
weChatSwitch	否		视频分享开关，0关闭 1开启默认关闭
inviteSwitch	否	1	邀请卡开关，0关闭 1开启默认关闭
seminarMaxStreams	是		研讨课最大连麦人数
seminarResolution	是		研讨课分辨率
seminarMainSpeakerAuth	是		研讨课主讲认证类型，可选0：接口验证，1：单密码验证
seminarMainSpeakerAuthUrl	是		研讨课主讲接口验证地址。seminarMainSpeakerAuth为0时必须。
seminarMainSpeakerAuthPass	是		研讨课主讲验证密码。seminarMainSpeakerAuth为1时必须。
seminarSecondSpeakerAuth	是		研讨课嘉宾认证类型。可选：0接口验证，1:单密码验证，2免密码，3白名单
seminarSecondSpeakerAuthUrl	是		研讨课嘉宾接口验证地址。seminarSecondSpeakerAuth为0时必须。
seminarSecondSpeakerAuthPass	是		研讨课嘉宾验证密码。seminarSecondSpeakerAuth为1时必须。
seminarSecondSpeakerAuthWhiteList	是	{name1	研讨课嘉宾验证白名单。不是id。seminarSecondSpeakerAuth为3时必须。
replaySettingStatus	是	1	直播间直播跳转回放状态配置,0关闭,1开启
replaySettingType	是	1	直播间直播跳转回放类型,0直播回放,1外部链接
replayLink	是	https	replaySettingType值为1时必填,最大200,http或者https开头
replayLiveReplayType	是	2	replaySettingType值为0时填写,取值0关联回放,1全部可用回放,2最新回放
replayLiveReplayMenuStatus	是	1	replaySettingType值为0时填写,取值0关闭显示菜单,1开启显示菜单
watchFrequencySwitch	是	0	显示观看次数
chatSyncUrl	否	htp	直播间聊天同步url,长度小于等于250字符,http或https协议
viewStreamSource	否	0	观看端查看流类型；0-直播合流；1-网页录制流 (仅小班课房间支持配置)
enableInteractionGame	否	1	开启互动游戏，1开启，0关闭。
enableSuffixViewerId	否	1	开启昵称后缀，1开启，0关闭。
mobileViewMode	否		移动端观看模式 1：横屏 2：竖屏(需要vunio竖屏观看权限)，只在纯视频模式下支持
multiStreamSwitch	否		多流直播开关 0:关闭 1：开启
seminarSource	否	1	研讨会直播间来源。默认0，小班课1.为1时不再通知小班课。
pcFullScreenMode	否	0	PC播放器全屏模式：0-网页全屏；1-系统全屏;
skinLoginMobileBgImg	否		移动端登录背景图
skinLoginPcBgImg	否		pc登录背景图
skinLoginPcBgMode	否	0	pc登录背景图-展示模式：0-全屏封面；1-前景封面
skinLoginPcBgBrightness	否	8	pc登录背景图-亮度:[0,20]
skinLoginPcBgBlurriness	否	5	pc登录背景图-模糊度:[0,10]
skinLoginShareImg	否	0	pc、移动端登录是否共享图片：0-否；1-是
skinId	是
skinName	是
skinBgImg	是
skinBgColor	是
skinMarginTop	是
userRoleSwap	否	1	是否开启'旁听-互动身份互换'，1开启，0反之。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		OK

获取直播间代码

基本信息

Path： /api/room/code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		客户ID，例：753C612EB38A8D5A
roomid	是		直播间ID，例：000F94FA465E033A9C33DC5901307461

返回数据

名称	类型	是否必须	备注	其他信息
result	string	必须	请求成功"OK"
roomId	string	非必须	直播间ID
clientLoginUrl	string	非必须	客户端登录地址
assistantLoginUrl	string	非必须	助教登录地址
viewUrl	string	非必须	学员登录地址
publishUrls	string []	非必须	第三方推流地址	item 类型: string
├─		非必须
publishUrl	string	非必须	【已废弃】第三方推流地址
hostLoginUrl	string	非必须	主持人登录地址
promulgatorUrl	string	非必须	图文直播登录地址

获取直播间信息（批量）

基本信息

Path： /api/room/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	ECB81750584E9A75	CC账户id
pagenum	否	50	每页显示的个数,系统默认值为50，最大值为100
pageindex	否	1	页码默认1
startcreatetime	否		如果填写该参数则endcreatetime参数必填,直播间创建时间范围查询开始时间.格式: yyyy-MM-dd HH:mm:ss (最多查询一天得数据)
endcreatetime	否		如果填写该参数则startcreatetime参数必填,直播间创建时间范围查询结束时间.格式: yyyy-MM-dd HH:mm:ss (最多查询一天得数据)

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须
pageIndex	number	非必须
count	number	非必须
rooms	object []	非必须		item 类型: object
├─ id	string	必须
├─ name	string	必须
├─ desc	string	必须
├─ status	number	必须
├─ publisherPass	string	必须
├─ playPass	string	必须
├─ assistantPass	string	必须
├─ checkUrl	string	必须
├─ templateType	number	必须
├─ authType	number	必须
├─ barrage	number	必须
├─ publishUrls	string []	必须		item 类型: string
├─		非必须
├─ openLowDelayMode	string	必须
├─ delayTime	string	必须
├─ showUserCount	string	必须
├─ openHostMode	string	必须
├─ hostLoginMode	string	必须
├─ foreignPublish	number	必须
├─ warmVideoId	string	必须
├─ liveStartTime	string	必须
├─ playerBackgroundHint	string	必须
├─ manuallyRecordMode	string	必须
├─ clientDocPermissions	string	必须
├─ openMarquee	string	必须
├─ repeatedLoginSetting	string	必须
├─ maxAudienceNum	string	必须
├─ documentDisplayMode	string	必须
├─ openLiveCountdown	string	必须
├─ alarms	string	必须
├─ openChatManage	string	必须
├─ showLectuerOnlineNum	string	必须
├─ showAssistOnlineNum	string	必须
├─ hideExitButtonFlag	string	必须
├─ privateChat	string	必须
├─ createTime	string	必须	创建时间 ,格式:yyyy-MM-dd HH:mm:ss
├─ platform	string	必须	平台,1.云直播;5.云课堂;

解除直播间禁言

基本信息

Path： /api/room/chat/resume

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
roomId	是	161CEFF8EEA86E389C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

转播接受直播间列表

基本信息

Path： /api/v1/rebroadcast/receivers

Method： GET

接口描述：

创建直播间时：同一直播间模版下的、未删除的、未关联的小直播间
编辑直播间时：同一直播间模版下的、未删除的、未关联的小直播间，以及已与当前直播间关联的小直播间

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	998757E82C929B67	账号id
template	是	1	直播间模版id
mode	是	onUpdate	查询模式，可选只有：onCreate和onUpdate
rebroadcastMode	是	single	转播模式。single单师，double双师。默认single
pageNo	是	1	1
pageSize	是	10	10
roomId	否	F951EC79E04F019B9C33DC5901307461	直播间id。mode=onUpdate时该参数为必须参数。
query	否	123	模糊查询。支持根据直播间id或直播间名称模糊匹配。

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ rooms	object []	非必须		item 类型: object
├─ associated	boolean	非必须	是否跟当前直播间已建立关联。
├─ idEncrypt	string	必须	加密id
├─ roomStatus	string	必须	直播间状态
├─ name	string	必须	直播间名称
├─ page	object	必须
├─ totalCount	number	必须	总记录数
├─ pageCount	number	必须	总页数
├─ pageNo	number	必须	当前页
├─ pageSize	number	必须	每页条数

文档功能

上传文档

基本信息

Path： /postfile?userid=753C612EB38A8D5A&docid=63835A29B2A11961

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Query

参数名称	是否必须	示例	备注
file	是		文件

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		上传文件

返回数据

名称	类型	是否必须
datas	object	非必须
├─ docId	string	非必须
errorCode	number	非必须
success	boolean	非必须

创建文档上传信息

基本信息

Path： /api/document/create

Method： GET

接口描述：

版本：v.1.0.0

最后修改日期：2019-09-26

API系统加密方式：THQS加密

如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。

其中常见的错误码如下：

错误码	描述	备注
1001	参数错误	检查传入参数是否正确
1002	加密错误	THQS加密错误
10000	直播间状态错误	确认直播间状态是否正常
其他值	系统错误	联系客服解决

通过LiveApi上传文档时序图如下：

上传步骤：

创建上传信息；
组建上传地址；
上传文件；

1. 创建上传信息

通过LiveAPI系统的/api/document/create接口创建上传信息，返回结果result：

{
    "success": true,
    "datas": {
        "uploadUrl": "http://doc-bj.csslcloud.net/api/document/upload",
        "docId": "753C612EB38A8D5A"
    },
    "errorCode": 0
}

2. 组建上传地址

通过步骤1返回的信息组建完整的上传地址，格式为：
{result.datas.uploadUrl}?userid={客户ID}&docid={result.datas.docId}&supportanimation={supportanimation}

例：通过步骤1的返回内容组建完整的上传地址为：
http://doc-bj.csslcloud.net/api/document/upload?userid=63835A29B2A11961&docid=753C612EB38A8D5A&supportanimation=0&quality=hd&fitToWindow=1

参数说明：

参数名称	类型	备注
userid	string	必须，客户的唯一ID，可以通过https://admin.bokecc.com右上角账号ID处获取
docid	string	必须，创建上传信息返回
supportanimation	integer	非必须，是否保留动画，只针对ppt、pptx文件有效，0：不保留动画（默认）；1：保留动画；2：保留动画（极速）；
quality	integer	非必须，课件转码清晰度，只有supportanimation=2才支持，取值：0（原始，默认）、1800（标准）、2560（高清），最大不能超过2560（如果清晰度超过2560，强制改为2560）
fitToWindow	integer	非必须，课件是否适配窗口，只有supportanimation=2才支持，枚举值：0（默认，固定大小），1（适配窗口）

3. 上传文件

通过上一部组建的上传地址，使用RFC 1867协议进行文件上传。
实例的Http信息：
Request URL:
http://doc-bj.csslcloud.net/api/document/upload?userid=63835A29B2A11961&docid=753C612EB38A8D5A&supportanimation=0

Request Headers:
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryZfxPQ4ins67a7ppa

Query String Parameters:
supportanimation=0&userid=63835A29B2A11961&docid=753C612EB38A8D5A

Form Data:
------WebKitFormBoundaryZfxPQ4ins67a7ppa
Content-Disposition: form-data; name="file"; filename="我要上传的文档.pptx"
Content-Type: application/vnd.openxmlformats-officedocument.presentationml.presentation

------WebKitFormBoundaryZfxPQ4ins67a7ppa

其他

支持的文件格式：pdf、doc、docx、ppt、pptx、jpg、png，注：仅有ppt和pptx支持保留动画

请求参数

Query

参数名称	是否必须	备注
userid	是	用户ID，例：753C612EB38A8D5A
roomid	是	直播间ID，例：63835A29B2A11961
title	是	文档标题，注：长度不能超过100个字符
filesize	是	文档大小，单位Byte，注：最大不能超过104857600（100MB）
notify	否	回调接口，不对外开放

返回数据

名称	类型	是否必须
datas	object	非必须
├─ uploadUrl	string	非必须
├─ docId	string	非必须
errorCode	number	非必须
success	boolean	非必须

删除文档

基本信息

Path： /api/document/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		客户ID
docids	是		文档ID，以英文逗号分隔，例：F3342D97BB1D6DF8,0498CE5AAF1F53F5

返回数据

名称	类型	是否必须
datas	object	非必须
errorCode	number	非必须
success	boolean	非必须

批量上传H5课件

基本信息

Path： /api/document/h5

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
accountId	string	必须	账户id
roomId	string	必须	直播间id
docs	object []	必须	上传列表,1-10个	item 类型: object
├─ index	string	必须	唯一标识,与返回docId一一对应
├─ title	string	必须	标题,1-100字符
├─ docUrl	string	必须	H5课件地址,最长500,符合url规范

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须
data	object	非必须	success为true返回数据
├─ docs	object []	非必须		item 类型: object
├─ index	string	必须	上传时唯一标识
├─ docId	string	必须	文档id

文档转码回调

基本信息

Path： /anything

Method： GET

接口描述：

返回值不符合则会认为回调失败触发重试，重试次数为8次（回调系统自身原因导致的回调失败也计入重试次数）

请求参数mode代表的含义为文档处理后的状态，非动画的ppt，word，pdf，image处理完成后都为0，动画模式的ppt区分为急速动画和非急速动画。

请求参数

Query

参数名称	是否必须	备注
docId	是	文档ID
roomId	是	直播间ID
docSize	是	文档大小
pageSize	是	总页码
status	是	文档处理状态：20（成功）,30（失败）
mode	是	文档模式：0（图片），1（非急速动画），2（急速动画）
width	是	1800
height	是	720
quality	是	取值：original（原始）、standard（标准）、hd（高清）
fitToWindow	是	保留动画，课件是否适配窗口，枚举值：0（固定大小），1（适配窗口）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	必须		ok

查询文档信息

基本信息

Path： /api/documents

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	客户ID
docids	否	文档ID，以英文逗号分隔，例：F3342D97BB1D6DF8,0498CE5AAF1F53F5
roomid	否	直播间ID，注：与docids参数不能同时存在，否则无效。
pagenum	否	每页返回文档个数，默认：100，注：不能超过100
pageindex	否	页码，默认：1

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
datas	object	非必须
├─ pageIndex	number	非必须
├─ documents	object []	非必须		item 类型: object
├─ pageCount	number	必须	文档页数，当文档为处理中状态该值为0
├─ fileSize	number	必须	文档大小，单位：Byte
├─ supportAnimation	boolean	必须	是否支持动画
├─ id	string	必须	文档ID
├─ originalFileURL	string	必须	源文件下载地址，如果文档源文件不存在，则不返回该字段
├─ type	number	必须	文档类型，0:PDF 1:WORD 2:PPT 3:JPG
├─ title	string	必须	文档名称
├─ uploadTime	string	必须	文档上传时间
├─ roomId	string	必须	直播间ID
├─ status	number	必须	文档状态，10:处理中 20:正常,30:失败
├─ metaUrl	string	非必须	元数据json地址,时效1小时,json文件
├─ count	number	非必须
├─ pageNum	number	非必须
errorCode	number	非必须

内部接口

查询客户APIKEY

基本信息

Path： /api/key

Method： GET

接口描述：

THQS加密。
查询客户API KEY信息，不对外开发。

请求成功：
{
    "result": "OK",
    "apiKey": {
        "key": "erfSvmkv2b8tCqsH82HI5SqCP480",
        "status": "1"
    }
}

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	753C612EB38A8D5A	被查询客户ID

返回数据

名称	类型	是否必须	备注
result	string	非必须	OK表示请求成功
apiKey	object	非必须
├─ key	string	非必须	KEY内容
├─ status	string	非必须	KEY状态，1：启用

直播查询

基本信息

Path： /api/live/search

Method： GET

接口描述：

sourceType类型：
0 正常的直播
1 回放合并生成的直播
2 展示互动生成
3 admin 上传ccr生成直播
4 剪辑生成

请求参数

Query

参数名称	是否必须	示例	备注
userid	是
liveid	是

返回数据

名称	类型	是否必须	备注
result	string	非必须
live	object	非必须
├─ id	string	非必须
├─ templateType	number	非必须	模板类型
├─ sourceType	number	非必须	来源
├─ startTime	string	非必须	直播开始时间
├─ endTime	string	非必须	直播结束时间
├─ recordStatus	number	非必须	录制状态 0：录制中 1：录制完成
├─ recordVideoId	string	非必须	录制视频ID
├─ replayUrl	string	非必须
├─ offlinePackageMd5	string	非必须
├─ offlinePackageUrl	string	非必须
├─ questionnaireStatisExcel	string	非必须
├─ questionnaireStatisStatus	string	非必须	直播问卷状态,0 处理中 5 已生成 -1 直播不存在问卷

主持人

停止录制

基本信息

Path： /api/host/record/stop

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
liveId	是	753C612EB38A8D5A	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	非必须	错误码
├─ message	string	非必须	错误描述信息
data	object	非必须

开始录制

基本信息

Path： /api/host/record/start

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
liveId	是	753C612EB38A8D5A	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	非必须	错误码
├─ message	string	非必须
data	object	非必须
field_1	string	必须
field_2	string	必须

开始直播

基本信息

Path： /api/host/live/start

Method： GET

接口描述：

版本：v.1.0.0

最后修改日期：2019-09-20

API系统加密方式：THQS加密

如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。

其中常见的错误码如下：

错误码	描述	备注
10000000	参数错误	检查请求参数是否有问题
10000001	系统错误	联系客服解决问题
10000010	ID错误	传入加密ID存在问题
10000011	加密KEY错误	账号KEY非法，请求可能传入非法客户ID，或者该客户的加密KEY不存在
10000012	THQS加密错误	THQS加密错误，原因可能是加密错误（参考TQHS），也能是超时
10000013	组件异常	联系客服解决问题
10000014	存在无效参数	可能是直播间与账号不一致、直播不存在等原因导致。
10000015	直播间平台错误	某些操作只能操作直播平台的直播间，如果传入非直播平台的直播间则报该错误信息。
10000016	直播间状态非法	某操作无法在该状态的直播间上进行操作，比如：无法对已关闭的直播间进行开始直播的操作。
10000017	组件调用错误	联系客服解决问题
10000018	组件处理失败	联系客服解决问题
10000019	直播间配置错误	无法对该配置的直播间进行操作，比如：无法对非主持人模式的直播间进行主持人相关的操作
10000020	直播间状态错误	该功能无法在该状态的直播间上进行操作，比如：无法对已删除的直播进行开始直播的操作。
20000000	主槽没有流	主持人，主槽没有流，无法开始直播，主槽推流

注：开始直播但不进行录制。

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
roomId	是	000F94FA465E033A9C33DC5901307461	直播间ID
record	否		是否录制 1.是 0.否默认0

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须	错误信息
├─ code	integer	非必须	错误码
├─ message	string	非必须	错误描述信息
data	object	非必须
├─ live	object	非必须
├─ id	string	非必须	开始的直播ID

恢复录制

基本信息

Path： /api/host/record/resume

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
liveId	是	753C612EB38A8D5A	直播ID

返回数据

名称	类型	是否必须
success	boolean	必须
error	object	非必须
├─ code	integer	非必须
├─ message	string	非必须
data	object	非必须

暂停录制

基本信息

Path： /api/host/record/pause

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
liveId	是	753C612EB38A8D5A	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	非必须	错误码
├─ message	string	非必须
data	object	非必须

结束直播

基本信息

Path： /api/host/live/stop

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
liveId	是	753C612EB38A8D5A	直播ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须
error	object	非必须
├─ code	integer	非必须	错误码
├─ message	string	非必须	错误描述信息
data	object	非必须

获取推流信息

基本信息

Path： /api/host/record/streams

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	2BBA984E86119800	客户ID
roomId	是	000F94FA465E033A9C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	其他信息
success	boolean	必须
error	object	非必须
├─ code	integer	非必须
├─ message	string	非必须
data	object	非必须
├─ mainDocPitId	number	非必须
├─ mainStreamPitId	number	非必须
├─ pits	object []	非必须	item 类型: object
├─ id	number	非必须
├─ status	number	非必须
├─ userId	string	非必须
├─ userName	string	非必须

code

code_shibl

基本信息

Path： /code

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须
ok	boolean	必须
code	integer	必须
msg	string	必须
data	object	必须
├─ version	string	必须

广播消息

直播间自定义消息

基本信息

Path： /api/room/message

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	账户ID
roomid	是	直播间ID
message	是	发送消息，不能为空，并且长度不能超过200个字符，注：数据不会持久化

返回数据

名称	类型	是否必须	默认值	备注	其他信息

回放重制成视频

新增回放重制

基本信息

Path： /api/v1/replay/composition/add

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账户ID
recordId	是	4F89809CE9EDDEFD	回放ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	添加任务成功/失败	mock: @boolean
error	object	必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

保存用户回放重制计费配置(覆盖模式)

基本信息

Path： /api/v1/replay/composition/fee/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户ID
totalDuration	是	3600	回放重制时长,单位:秒
modeType	是	0	0：余量不足停止 1：余量不足不停止

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true/false
error	object	非必须
├─ code	number	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ effectCount	string	必须	1

取消重置中的任务

基本信息

Path： /api/v1/replay/composition/cancel

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	账户id
taskId	是	12312	任务id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ compositionTask	object	非必须
├─ cancelDuration	number	非必须	取消时长

合成回调接口

基本信息

Path： /api/v1/replay/remake/callback

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
taskId	是	任务ID
requestId	是	请求ID
videoId	是	点播videoId
status	是	成功@OK 失败@FAIL
duration	是	片场单位：秒
image	是	视频截图url

返回数据

名称	类型	是否必须	默认值	备注	其他信息

合成进度查询

基本信息

Path： /api/v1/replay/composition/process

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户ID
taskId	是	123456	任务ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	ture/false
error	object	必须
├─ message	string	必须	错误信息
├─ code	string	必须	错误码
data	object	必须
├─ process	object	必须
├─ current	string	必须	当前已经完成的时间，单位毫秒(DOING状态的有值，其他状态无值)
├─ duration	string	必须	回放总时长，可能为0，单位毫秒(DOING状态的有值，其他状态无值)
├─ taskId	string	必须	任务id
├─ status	string	必须	WAITING:待处理 DOING:处理中 DONE:完成

回放重制任务列表

基本信息

Path： /api/v1/replay/composition/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户ID
searchType	否	查询类型 1：回放ID 2：视频ID 3：直播间ID
searchId	否	查询ID
startTime	否	开始时间
endTime	否	结束时间
pageNo	否	页码默认1
pageSize	否	每页条数默认20
searchStatus	否	查询状态重制中 1 成功 5 失败 -1 取消 6

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false
error	object	必须
├─ message	string	必须	错误信息
├─ code	string	必须	错误码
data	object	必须
├─ compositions	object []	必须		item 类型: object
├─ id	integer	非必须
├─ encryptRecordId	string	非必须
├─ encryptRoomId	string	非必须
├─ title	string	非必须
├─ duration	string	非必须
├─ encryptVideoId	string	非必须	视频ID
├─ gmtCreate	string	非必须	创建时间
├─ statusDesc	string	非必须	重制状态
├─ taskId	string	必须	任务ID
├─ cancelDuration	integer	必须	取消时长,单位:秒
├─ pagination	object	必须
├─ pageNo	string	必须	当前页
├─ pageSize	string	必须	每页大小
├─ totalCount	string	必须	总条数
├─ pageCount	string	必须	总页数

批量查新用户回放重制计费信息

基本信息

Path： /api/v1/replay/composition/fee/accounts

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountIds	是	C783F0F7CB77E1F3,DBF655332633F3BC	用户账户ID,用逗号分割,账户ID个数小于等于200

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须
├─ code	number	非必须
├─ message	string	非必须
data	object []	非必须		item 类型: object
├─ replayCompositionDurations	object []	必须		item 类型: object
├─ accountId	string	必须	用户账户加密ID
├─ totalDuration	integer	必须	总时长,单位:秒
├─ usedDuration	integer	必须	使用时长,单位:秒

保存用户配置

基本信息

Path： /api/v1/replay/composition/config/save

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	111	账户ID
layout	是	1	布局 1.纯文档 2.画中画 3.三分屏
background	否	http://image.xxx.net/2.jpg	背景图URL
headLocation	否	1	头像位置 1.右上 2.右下 3.左上 4.左下
proportion	否	1	头像比例
marginX	否	20	x边距
marginY	否	20	y边距
flag	是	1	是否开启自动重制 1开启 0 关闭
backgrounds	否	https://material.csslcloud.net/composition/C783F0F7CB77E1F3/157718904573633.png,https://material.csslcloud.net/composition/C783F0F7CB77E1F3/157718904573633.png	背景图集合,逗号分割字符串
multiQuality	是		回放重制多清晰度转码支持
speed	是		是否极速重制

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	必须
├─ message	string	必须	错误信息
├─ code	string	必须	错误码

查询单个回放重制任务(对外开放接口)

基本信息

Path： /api/v1/replay/composition/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户id
replayCompositionId	是	47aef2d7-c03d-4894-adb2-bb399ab20960	回放重制id,添加接口返回id

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true/false
data	object	非必须
├─ composition	object	非必须
├─ replayCompositionId	string	非必须	回放重制id,添加任务接口返回
├─ accountId	string	非必须	用户账户id
├─ replayId	string	非必须	回放id
├─ roomId	string	非必须	房间id
├─ videoId	string	非必须	视频id,status值为5时存在值
├─ title	string	非必须	标题
├─ duration	number	非必须	时长,status值不为5时,duration值为0
├─ beginTime	string	非必须	重制开始时间
├─ status	number	非必须	重制状态,1重制中,5重制成功,-1重制失败,6任务取消,其他值未知
├─ videoDownLoadUrl	string	必须	回放重制成功后视频下载地址
├─ cancelDuration	integer	必须	取消时长,单位:秒
error	object	必须
├─ code	string	必须	10000014
├─ message	string	必须	exist invalid param

查询回放重制列表(新接口用户调用)

基本信息

Path： /api/v1/replay/composition/find

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户加密id
startTime	是	2020-11-25 12:12:12	开始时间,格式:yyyy-MM-dd HH:mm:ss,需要与结束时间成对存在,开始结束时间范围不能大于7天
endTime	是	2020-11-27 12:12:12	结束时间,格式:yyyy-MM-dd HH:mm:ss需要与开始时间成对存在,开始结束时间范围不能大于7天
pageNo	是	1	页码,默认1
pageSize	是	50	每页数量,默认值50,最大值50
searchType	否	1	查询类型 1：回放ID 2：视频ID 3：直播间ID,只有searchId存在值并且格式合法时才会检查类型
searchId	否	3688DC7A99D6FAEF	根据查询类型传入对应查询id
searchStatus	否	5	查询状态重制中 1 成功 5 失败 -1 取消 6 其它值未知

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	true/false
error	object	必须
├─ code	integer	必须	10000014
├─ message	string	必须	exist invalid param
data	object	非必须
├─ compositions	object []	非必须		item 类型: object
├─ replayCompositionId	string	必须	回放重制id,添加回放重制任务后返回的id
├─ accountId	string	必须	用户账户id
├─ replayId	string	必须	回放id
├─ roomId	string	必须	直播间id
├─ videoId	string	必须	视频id,status值为5时存在值
├─ title	string	必须	标题
├─ duration	number	必须	时长,单位:秒,status值不为5时,其值为0
├─ beginTime	string	必须	开始时间
├─ status	number	必须	状态,1 重制中,5重制成功,-1失败,6取消其它值未知
├─ cancelDuration	integer	必须	取消时长,单位:秒
├─ pagination	object	非必须
├─ pageNo	number	非必须	页码
├─ pageSize	number	非必须	每页数量
├─ totalCount	number	非必须	总数
├─ pageCount	number	非必须	总页数

查询某段时间用户回放重制统计数据

基本信息

Path： /api/v1/replay/composition/fee/statis/search

Method： GET

接口描述：

统计数据延迟2小时

成功返回：
{
    "success": true,
    "data": {
        "searchStatisticResult": {
            "usedHour": 0,
            "usedMinute": 2,
            "remainHour": 99,
            "remainMinute": 39,
            "remainSeconds": 34,
            "searchList": [
                {
                    "feeDate": "2020-10-09",
                    "usedHour": 0,
                    "usedMinute": 2
                }
            ]
        }
    }
}

异常返回示例：
{
    "success": false,
    "error": {
        "code": 10000001,
        "message": "system error"
    }
}

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ACF17D85FD83A47A	加密账户id
beginDate	是	2020-10-09	查询起始时间：yyyy-MM-dd
endDate	是	2020-10-09	查询结束时间：yyyy-MM-dd 结束大于起始，不超过100天

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须
├─ code	string	非必须	异常码
├─ message	string	非必须	异常信息
data	object	非必须
├─ searchStatisticResult	object	必须
├─ usedHour	number	非必须	账户总使用小时数
├─ usedMinute	number	非必须	账户总使用分钟数
├─ remainHour	number	非必须	账户总剩余小时数
├─ remainMinute	number	非必须	账户总剩余分钟数
├─ remainSeconds	number	非必须	账户总剩余秒数
├─ searchList	object []	非必须		item 类型: object
├─ feeDate	string	非必须	重制统计时间，精确到日
├─ usedHour	number	非必须	重制统计时间累积使用小时数
├─ usedMinute	number	非必须	重制统计时间累计使用分钟数

查询用户回放重制分辨率配置

基本信息

Path： /api/v1/replay/composition/resolution

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	true/false
error	object	非必须
├─ code	number	非必须	10000004
├─ message	string	非必须	invalid thqs
data	object	非必须
├─ resolution	object	必须	分辨率配置信息
├─ type	integer	必须	分辨率类型,0(默认值)表示:1280720,1表示:19201080

用户调用接口单个或批量添加回放重制

基本信息

Path： /api/v1/replay/composition/batchAdd

Method： GET

接口描述：

如果一个回放id无法通过如下逻辑,会添加失败
1.直播过期
2.回放重制时长不足并且为用尽停用
3.用户id不存在
4.没有回放重制权限添加失败
5.一批回放id中有一个无法通过如下校验全部添加失败
5.1回放id掺杂不合法回放id
5.2回放id掺杂其他用户回放id
5.3回放id掺杂关联直播非文档模式
5.4回放id掺杂不存在回放id
5.5回放id掺杂正在重制中的回放id
5.6回放id掺杂回放状态不可用

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	用户账户id
replayIds	是	A1976C786733DEED9C33DC5901307461,A1976C786733DEED9C33DC5901307461	回放id,用都逗号分割字符串,回放id数量在1到10之间

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	true/false
data	object	非必须
├─ successReplays	object []	非必须		item 类型: object
├─ replayId	string	必须	成功的回放id
├─ replayCompositionId	string	必须	回放重制id
error	object	必须
├─ code	string	必须	10000000
├─ message	string	必须	Invalid Params

获取用户配置

基本信息

Path： /api/v1/replay/composition/config/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ message	string	必须
├─ code	string	必须
data	object	非必须
├─ compositionConfig	object	非必须
├─ id	number	非必须
├─ accountId	number	非必须	账户ID
├─ layout	number	非必须	布局：1：画中画 2：三分屏(默认值,没有配置时默认值) 3：纯文档
├─ background	string	非必须	视频背景图
├─ headLocation	number	非必须	头像位置：1.右上 2.右下 3.左上 4.左下
├─ proportion	number	非必须	头像比例 1：（4:3）,2:(16:9)
├─ marginX	number	非必须	x边距
├─ marginY	number	非必须	纵边距
├─ flag	number	非必须	是否开启自动重制
├─ multiQuality	integer	非必须	回放重制多清晰度转码支持
├─ speed	integer	非必须	是否极速重制

设置合成mp4账户优先级

基本信息

Path： /api/v1/replay/composition/account/priority/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
accountId	是		账户ID
priority	是	B/C	优先级

Body

名称	类型	是否必须	默认值	备注	其他信息
		非必须

返回数据

名称	类型	是否必须
success	boolean	必须
error	object	必须
├─ message	string	必须
├─ code	string	必须

推流信息数据监控

直播间流信息数据

基本信息

Path： /api/stream/info

Method： GET

接口描述：

API系统加密方式：THQS加密, 开始时间和结束时间不能大于两个小时

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户ID，例：753C612EB38A8D5A
roomId	是	直播间ID，例：000F94FA465E033A13358DE27D943A99
startTime	是	查询开始时间，例：2019-10-30 20:51:17
endTime	是	查询结束时间，例：2019-10-31 20:52:17，注：开始和结束时间差不能超过2小时
pageNo	否	页码，默认：1
pageSize	否	每页数据条数，默认100

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	调用成功为true，调用失败为false
data	object	非必须	调用成功返回数据
├─ streamInfos	object []	非必须		item 类型: object
├─ bitrate	number	必须	码率
├─ fps	string	必须	帧率
├─ missRate	string	必须	丢帧率
├─ originFps	number	必须	原始帧率
├─ time	string	必须	当时的时间
├─ delayTime	number	必须	延时时间

打卡

打卡互动的详细信息

基本信息

Path： /api/punch/detail

Method： GET

接口描述：

API系统加密方式：THQS加密
如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。
其中常见的错误码如下：

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户id
punchId	是	打卡 ID。
pageIndex	是	分页页码，最小值为1，默认值为1。
pageSize	是	分页大小，最小值为1，最大值为100，默认值为100。

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	接口处理结果。
error	object	非必须	失败时的错误信息，success=false时必须。
├─ code	number	必须	错误代码。
├─ message	string	必须	错误描述。
data	object	非必须	成功时返回的数据，success=true时必须。
├─ punch	object	必须	打卡信息。
├─ id	string	必须	打卡ID。
├─ publisherId	string	必须	发起者 ID。
├─ publisherName	string	必须	发起者名称。
├─ createTime	string	必须	打卡开始时间，格式yyyy-MM-dd HH:mm:ss。
├─ total	number	必须	应打卡人数。
├─ punched	number	必须	实际打卡人数。
├─ duration	number	必须	打卡持续时间，单位：秒。无过期时间时，返回完成时间和开始时间的差。若有过期时间，返回完成时间和开始时间的差和过期时间和开始时间的差之间较小的值
├─ punchViewers	object []	必须	参与打卡学员列表，按分页返回。	item 类型: object
├─ id	string	必须	学员 ID。
├─ name	string	必须	学员名称。
├─ createTime	string	必须	参与打卡时间，格式yyyy-MM-dd HH:mm:ss。
├─ isPunched	boolean	必须	是否打卡。
├─ punchTime	string	非必须	打卡时间，格式yyyy-MM-dd HH:mm:ss。isPunched=true 时必须。

直播间打卡互动列表

基本信息

Path： /api/punch/list

Method： GET

接口描述：

API系统加密方式：THQS加密
如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。

请求参数

Query

参数名称	是否必须	备注
accountId	是	账户id
liveId	是	加密直播ID
pageIndex	是	分页页码，最小值为1，默认值为1。
pageSize	是	分页大小，最小值为1，最大值为100，默认值为100。

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
error	object	非必须
├─ code	string	必须	错误代码。
├─ message	string	必须	错误描述。
data	object	非必须
├─ count	number	必须
├─ punches	object []	必须		item 类型: object
├─ id	string	必须	打卡ID。
├─ publisherId	string	必须	发起者 ID。
├─ publisherName	string	必须	发起者名称。
├─ createTime	string	必须	打卡开始时间，格式yyyy-MM-dd HH:mm:ss。
├─ expireTime	string	非必须	打卡到期时间，格式 yyyy-MM-dd HH:mm:ss。打卡无到期时间时，此项不存在。
├─ allowLater	boolean	必须	是否允许后进入者参与打卡。
├─ isFinish	boolean	必须	打卡互动是否结束。
├─ finishTime	string	非必须	打卡结束时间，格式yyyy-MM-dd HH:mm:ss。isFinish=true 时必须。
├─ total	number	必须	应打卡人数。
├─ punched	number	必须	实际打卡人数。isFinish=false 时，此值为0，无意义。

获取打卡静态文件状态

基本信息

Path： /api/punch/file/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
liveId	是
accountId	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
error	object	非必须
├─ code	string	非必须
├─ message	string	非必须
data	object	非必须
├─ info	object	非必须
├─ status	number	必须	0:无可用信息;1:正在生成;2:生成成功;3:生成失败
├─ path	string	必须	只有status为2时返回该值

回放

客户-翻页文档-列表-查询

基本信息

Path： /api/replay/dp/page

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	客户ID
recordId	是	回放ID
pageNo	否	页码，默认:1
pageSize	否	每页返回数据条数，默认: 50，取值范围: [1, 100]

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
error	object	非必须
├─ message	string	非必须
├─ code	number	非必须
data	object	非必须
├─ totalCount	number	非必须
├─ pages	object []	非必须		item 类型: object
├─ docId	string	必须	文档id
├─ docName	string	必须	文档名字
├─ index	integer	必须	文档页码，从0开始
├─ url	string	必须	文档链接
├─ customDocNotes	string	非必须	文档标记，若无不返回该字段
├─ sign	integer	必须	鉴权，若为0 url可以正常访问，为1需要鉴权访问，url不可直接访问
├─ time	number	必须	距离回放开始的时间，单位秒
├─ title	string	必须	该页标题信息,若无不返回该字段

删除回放

基本信息

Path： /api/record/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		账户ID
recordids	是		回放ID，支持多个回放id,id之间以英文逗号","分隔，批量删除数量不能超过100个

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须		请求是否成功。OK：成功；FAIL：失败

回放信息查询（集团账号使用）

基本信息

Path： /api/organization/replay/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
replayId	是	A6CED859855785A	回放ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
error	object	必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息
data	object	必须
├─ replay	object	必须
├─ accountId	string	必须	账户ID
├─ roomId	string	必须	直播间ID
├─ liveId	string	必须	直播ID
├─ startTime	string	必须	录制开始事件
├─ stopTime	string	必须	录制结束时间

回放剪辑

基本信息

Path： /api/v1/record/clip/create

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	ECB81750584E9A75	帐号ID
recordId	是	040257C78020A48A9C33DC5901307461	被剪辑的回放ID
sections	是	10-20,30-50	裁剪段
dstName	是	剪辑回放	剪辑后的回放名称

返回数据

名称	类型	是否必须	备注
success	string	必须	true/false
data	object	必须
├─ replayId	string	必须	剪辑后的回放ID
error	object	必须
├─ code	string	必须	错误码
├─ message	string	必须	错误信息

回放合并

基本信息

Path： /api/live/merge

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例
userid	是	用户ID
roomid	是	直播间ID
recordids	是	待合并回放ID,“,”逗号分隔

返回数据

名称	类型	是否必须	备注
result	string	必须	OK/FAIL
recordid	string	非必须	合并后回放ID:AF58B89EF2C17DA4
error	string	必须	system error

回放查询

基本信息

Path： /api/v2/record/search

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		账户ID，例如：753C612EB38A8D5A
recordid	是		查询回放ID，例如：63835A29B2A11961

返回数据

名称	类型	是否必须	备注
result	string	非必须
record	object	非必须
├─ id	string	非必须
├─ roomId	string	非必须
├─ liveId	string	非必须
├─ startTime	string	非必须
├─ stopTime	string	非必须
├─ recordStatus	number	非必须
├─ recordVideoStatus	number	非必须
├─ recordVideoId	string	非必须
├─ replayUrl	string	非必须
├─ downloadUrl	string	非必须
├─ offlinePackageUrl	string	非必须
├─ offlinePackageMd5	string	非必须
├─ offlinePackageSize	integer	非必须	CCR大小，单位Byte
├─ templateType	number	非必须
├─ sourceType	number	非必须
├─ title	string	非必须
├─ desc	string	非必须

回放观看记录

基本信息

Path： /api/replay/watch/record

Method： GET

接口描述：

最大查询时间间隔 1天

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
startTime	是	2021-06-08 12	查询开始时间 [日期格式：yyyy-MM-dd HH:mm:ss]
endTime	是	2021-06-09 12	查询开始时间 [日期格式：yyyy-MM-dd HH:mm:ss]
pageNo	是	1	页码[ >0]，默认1
pageSize	是	500	每页大小 [1-500 ]，默认200

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ record	object []	非必须	观看记录	item 类型: object
├─ roomId	string	必须	直播间ID
├─ replayId	string	必须	直播ID
├─ userId	string	必须	用户ID
├─ userName	string	必须	用户昵称
├─ userIp	string	必须	用户IP
├─ uaType	number	必须	ua类型 0：PC ， 1：移动端
├─ enterTime	string	必须	进入时间 [日期格式：yyyy-MM-dd HH:mm:ss]
├─ leaveTime	string	必须	离开时间 [日期格式：yyyy-MM-dd HH:mm:ss]
├─ pagination	object	非必须	分页信息
├─ totalCount	number	必须	总条数
├─ pageCount	number	必须	总页数
├─ pageNo	number	必须	当前页码
├─ pageSize	number	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放观看记录（V2版本）

基本信息

Path： /api/v2/replay/watch/record

Method： GET

接口描述：

通过该接口可以查询账号下回放观看记录记录；
注意：最大查询时间间隔 1天；
接口加密方式：THQS加密

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
startTime	是	2021-06-08 12:00:00	查询开始时间 [日期格式：yyyy-MM-dd HH:mm:ss]
endTime	是	2021-06-09 12:00:00	查询结束时间 [日期格式：yyyy-MM-dd HH:mm:ss]
pageNo	是	1	页码[ >0]，默认1
pageSize	是	200	每页大小 [1-500 ]，默认200

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ record	object []	非必须	观看记录	item 类型: object
├─ playId	string	必须	观看记录ID（唯一）
├─ roomId	string	必须	直播间ID
├─ replayId	string	必须	回放ID
├─ replayTitle	string	必须	回放标题
├─ userId	string	必须	用户ID
├─ userName	string	必须	用户昵称
├─ userIp	string	必须	用户IP
├─ userRegion	string	必须	用户IP所在地域（中国-江苏-南京）
├─ uaType	number	必须	ua类型 0：PC ， 1：移动端
├─ enterTime	string	必须	进入时间 [日期格式：yyyy-MM-dd HH:mm:ss]
├─ leaveTime	string	非必须	离开时间 [日期格式：yyyy-MM-dd HH:mm:ss]，非必须，当没有离开时间时不返回
├─ userCustomInfo	string	非必须	用户自定义备注信息
├─ pagination	object	非必须	分页信息
├─ totalCount	number	必须	总条数
├─ pageCount	number	必须	总页数
├─ pageNo	number	必须	当前页码
├─ pageSize	number	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放观看记录（按月查询特定回放观看记录）

基本信息

Path： /api/replay/single/month/watch/record

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
replayId	是	B783F0F7CB77E1F2	回放ID
queryMonth	是	2021-01	查询月份
pageNo	否	1	分页页码（查询页码）
pageSize	否	200	分页条数（每页条数）

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ record	object []	非必须	观看记录	item 类型: object
├─ playId	string	必须	观看记录ID（唯一）
├─ userId	string	必须	用户ID
├─ userName	string	必须	用户昵称
├─ userIp	string	必须	用户IP
├─ userRegion	string	必须	用户IP所在地域（中国-江苏-南京）
├─ ua	string	必须	PC ，移动端
├─ enterTime	string	必须	进入时间 [日期格式：yyyy-MM-dd HH:mm:ss]
├─ leaveTime	string	非必须	离开时间 [日期格式：yyyy-MM-dd HH:mm:ss]，非必须，当没有离开时间时不返回
├─ watchTime	string	必须	观看时长
├─ pagination	object	必须
├─ totalCount	number	必须	总条数
├─ pageCount	string	必须	总页数
├─ pageNo	string	必须	当前页码
├─ pageSize	string	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放观看记录（查询特定回放观看记录）

基本信息

Path： /api/replay/single/watch/record

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	C783F0F7CB77E1F3	帐号ID
replayId	是	B783F0F7CB77E1F2	回放ID
userId	否	B783F0F7CB77E1F2	用户id
pageNo	是	1	页码[ >0]，默认1
pageSize	是	200	每页大小 [1-500 ]，默认200

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须
data	object	非必须
├─ record	object []	非必须	观看记录	item 类型: object
├─ playId	string	必须	观看记录ID（唯一）
├─ userId	string	必须	用户ID
├─ userName	string	必须	用户昵称
├─ userIp	string	必须	用户IP
├─ userRegion	string	必须	用户IP所在地域（中国-江苏-南京）
├─ ua	string	必须	PC 、移动端
├─ enterTime	string	必须	进入时间 [日期格式：yyyy-MM-dd HH:mm:ss]
├─ leaveTime	string	非必须	离开时间 [日期格式：yyyy-MM-dd HH:mm:ss]，非必须，当没有离开时间时不返回
├─ watchTime	string	必须	观看时长
├─ pagination	object	非必须	分页信息
├─ totalCount	number	必须	总条数
├─ pageCount	number	必须	总页数
├─ pageNo	number	必须	当前页码
├─ pageSize	number	必须	每页条数
error	object	非必须
├─ code	integer	必须	错误码
├─ message	string	必须	错误信息

回放信息

基本信息

Path： /api/record/

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		账户ID，例如：753C612EB38A8D5A
recordId	是		查询回放ID，例如：63835A29B2A11961

返回数据

名称	类型	是否必须	备注
result	string	非必须
record	object	非必须
├─ id	string	非必须
├─ roomId	string	非必须
├─ liveId	string	非必须
├─ startTime	string	非必须
├─ stopTime	string	非必须
├─ recordStatus	number	非必须
├─ recordVideoStatus	number	非必须
├─ recordVideoId	string	非必须
├─ replayUrl	string	非必须
├─ downloadUrl	string	非必须
├─ offlinePackageUrl	string	非必须
├─ offlinePackageMd5	string	非必须
├─ offlinePackageSize	integer	非必须	CCR大小，单位Byte
├─ templateType	number	非必须
├─ sourceType	number	非必须
├─ title	string	非必须
├─ desc	string	非必须

批量查询用户回放下载信息

基本信息

Path： /api/v2/record/download

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	C783F0F7CB77E1F3	用户账号ID
recordids	是	EAD293BED2ECE5779C33DC5901307461,13B1569BA069B1CD9C33DC5901307461	回放id,逗号分割字符串

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须	OK/FAIL
reason	string	必须	invalid encrypt
downloadUrls	object []	非必须		item 类型: object
├─ recordId	string	非必须	回放id
├─ status	number	非必须	状态
├─ downloadUrl	string	非必须	http下载地址
├─ httpsDownloadUrl	string	非必须	https下载地址

查询伪直播回放/视频状态是否正常

基本信息

Path： /api/pseudo/source/validate

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
sourceId	是	07470C1AF2019D89	资源ID
sourceType	是	2	资源类型 2:回放 3：视频
accountId	是	B1E599CB7A764251	帐号ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	必须
├─ templateMode	integer	必须	0:大屏模式 1：文档模式

查询回放列表

基本信息

Path： /api/v2/record/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是		账户ID
roomid	是		直播间ID
liveid	否		直播ID，如果为空获取直播间下所有回放信息
starttime	否	2019-01-01 12:30:00	查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数，该查询是按直播的开始时间作为查询条件的。如果填写该参数则endtime参数必填，格式：“yyyy-MM-dd HH:mm:ss”
endtime	否	2019-01-01 13:30:00	查询截止时间
pagenum	否	50	每页显示的个数，默认50
pageindex	否	1	页码，默认1

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须
count	string	非必须
pageIndex	string	非必须
records	object []	非必须		item 类型: object
├─ id	string	非必须
├─ liveId	string	非必须
├─ startTime	string	非必须
├─ stopTime	string	非必须
├─ recordStatus	number	非必须	1：回放可用，其他值：回放不可用
├─ recordVideoStatus	number	非必须	3：回放视频可用，其他值：不可用
├─ recordVideoId	string	非必须
├─ replayUrl	string	非必须
├─ offlinePackageUrl	string	非必须
├─ offlinePackageMd5	string	非必须
├─ templateType	number	非必须
├─ sourceType	number	非必须	0-正常直播生成回放、1-回放合并生成的回放、2-展示互动生成回放、3-admin 上传ccr生成回放 4、回放剪辑生成的回放
├─ title	string	非必须
├─ desc	string	非必须

根据回放ID查询回放信息

基本信息

Path： /api/replay

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		用户ID
replayId	是		回放ID

返回数据

名称	类型	是否必须	备注
error	object	非必须	当请求无法正常处理时返回
├─ message	string	必须	错误原因描述
├─ code	integer	必须	错误码，用于问题具体原因排查
success	boolean	必须	请求是否成功，当且仅当该接口请求成功后返回true
data	object	非必须	查询数据信息
├─ replay	object	必须	回放信息
├─ id	string	必须	回放ID
├─ liveId	string	必须	直播ID
├─ startTime	string	必须	回放开始时间，日期格式: "yyyy-MM-dd HH:mm:ss"
├─ endTime	string	必须	回放结束时间，日期格式: "yyyy-MM-dd HH:mm:ss"；只有回放结束后才返回该信息。
├─ status	integer	必须	回放状态信息， 1: 处理中（回放创建中）； 2: 回放可用； 3: 回放视频被删除；其他值: 未知状态
├─ replayUrl	string	非必须	回放观看地址，当且仅当回放状态为可用时才回放该信息
├─ videoId	string	非必须	回放视频ID，当且仅当回放生成后才会返回有效回放信息
├─ videoDownloadUrl	string	非必须	回放视频下载地址, 注：该下载地址具有时效性, 有效时间为2小时,当status为1时返回该参数
├─ template	integer	必须	模板类型
├─ source	integer	必须	生成回放来源: 0.录制; 1.合并; 2.迁移; 3.上传; 其他值为未知状态;
├─ title	string	必须	回放标题
├─ desc	string	必须	回放描述
├─ ccr	object	非必须	离线回放信息，注：只有开通离线播放权限并且离线包生成之后才会返回该参数
├─ url	string	必须	离线回放下载地址
├─ size	integer	必须	离线回放文件大小，单位: Byte
├─ md5	string	必须	离线回放文件MD5
├─ status	integer	必须	离线回放状态， 1: 生成中； 2: 可用状态；其他值: 未知状态；

根据回放标题查询回放列表

基本信息

Path： /api/v2/record/search/title

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
userid	是	C783F0F7CB77E1F3	用户账号ID
roomid	是	C3B53C5B75C5B6A39C33DC5901307461	直播间id
title	否	iren	搜索标题
pagenum	否	1	分页数量
pageindex	否	1	页码

返回数据

名称	类型	是否必须	备注	其他信息
result	string	非必须
pageIndex	number	非必须
count	number	非必须
records	object []	非必须		item 类型: object
├─ id	string	必须
├─ liveId	string	必须
├─ startTime	string	必须
├─ stopTime	string	必须
├─ recordStatus	number	必须
├─ recordVideoStatus	number	必须
├─ recordVideoId	string	必须
├─ replayUrl	string	必须
├─ offlinePackageUrl	string	必须
├─ offlinePackageMd5	string	必须
├─ httpsOfflinePackageUrl	string	必须	新增支持https
├─ templateType	number	必须
├─ sourceType	number	必须
├─ title	string	必须
├─ desc	string	必须

根据直播间ID等条件查询回访信息

基本信息

Path： /api/replays

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
accountId	是	用户ID
roomId	是	直播间ID
liveId	否	直播ID, 注:不传此字段返回直播间下的所有回放;
pageNo	否	分页页码, 默认1;
pageSize	否	分页条数, 默认50条,最多100,传值超出100则最多返回100条数据;
startTime	否	范围查询起始时间, 查询字段为录制开始时间,格式: yyyy-MM-dd HH:mm:ss
endTime	否	范围查询结束时间, 查询字段为录制开始时间,格式: yyyy-MM-dd HH:mm:ss

返回数据

名称	类型	是否必须	备注	其他信息
error	object	非必须	当请求无法正常处理时返回
├─ message	string	必须	错误信息
├─ code	number	必须	错误码
success	boolean	必须	请求是否成功，当且仅当该接口请求成功后返回true
data	object	非必须	查询数据信息
├─ pageNo	integer	必须	当前页数
├─ totalCount	integer	必须	总条数
├─ replays	object []	必须	回放信息集合	item 类型: object
├─ id	string	必须	回放id
├─ liveId	string	必须	直播id
├─ startTime	string	必须	开始录制时间, 格式为"yyyy-MM-dd HH:mm:ss"
├─ endTime	string	必须	结束录制时间, 格式为"yyyy-MM-dd HH:mm:ss", 如果录制未结束，该值则为""
├─ status	integer	必须	回放状态信息， 1: 处理中（回放创建中）； 2: 回放可用； 3: 回放视频被删除；其他值: 未知状态
├─ videoId	string	非必须	回放视频ID，当且仅当回放生成后才会返回有效回放信息
├─ replayUrl	string	非必须	回放观看地址，当且仅当回放状态为可用时才回放该信息
├─ template	integer	必须	模板类型
├─ source	integer	必须	生成回放来源: 0.录制; 1.合并; 2.迁移; 3.上传; 其他值为未知状态;
├─ title	string	必须	回放标题
├─ desc	string	必须	回放描述
├─ ccr	object	非必须	离线包，注：只有开通离线播放权限并且离线包生成之后才会返回该参数
├─ url	string	必须	离线包下载地址
├─ md5	string	必须	离线包md5
├─ size	integer	必须	离线包文件大小，单位Byte，注：只有开通离线播放权限才会返回该参数
├─ status	integer	必须	离线回放状态， 1: 生成中； 2: 可用状态；其他值: 未知状态

直播录制日志查询

基本信息

Path： /api/v1/record/log

Method： GET

接口描述：

通过该接口可以查询直播过程中，讲师录制行为的操作记录；
注意：单次直播最多可查询100条操作记录；
接口加密方式：THQS加密

请求参数

Query

参数名称	是否必须	示例	备注
liveId	是	450A08FCA2B1207F	直播ID
accountId	是	C783F0F7CB77E1F3	CC账号ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	true/false,成功标识
error	object	非必须
├─ message	string	非必须	THQS invalid
├─ code	string	非必须	10000012
data	object	非必须
├─ live	object	必须
├─ start	string	必须	直播开始时间,yyyy-MM-dd HH:mm:ss
├─ end	string	必须	直播结束时间yyyy-MM-dd HH:mm:ss
├─ replays	object []	必须	回放集合	item 类型: object
├─ id	string	必须	回放id
├─ records	object []	必须	录制日志	item 类型: object
├─ type	integer	必须	操作类型,10暂停,20继续录制,1开始录制,2结束录制
├─ time	string	必须	操作时间,yyyy-MM-dd HH:mm:ss

直播间回放在线人数

基本信息

Path： /api/replay/room/viewer/count

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是	DBF655332633F3BC	账户ID
roomId	是	4DF1E4893F655F779C33DC5901307461	直播间ID

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true/false
data	object	非必须
├─ viewerCount	number	必须	观看人数
error	object	非必须
├─ code	number	必须	错误码
├─ message	string	必须	错误信息

编辑回放

基本信息

Path： /api/record/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
userid	是	账户ID
recordid	是	回放id
title	是	回放标题，最大字符40
desc	否	回放描述，最大字符5000

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须		请求是否成功。OK：成功；FAIL：失败

获得场景视频 接口文档

LiveAPI

公共分类

双师批量创建小直播间

基本信息

请求参数

返回数据

账户权限

基本信息

请求参数

返回数据

获取直播间直播的访问记录

基本信息

请求参数

返回数据

获取直播信息接口

基本信息

请求参数

返回数据

查询直播间用户进出日志

基本信息

请求参数

返回数据

获取用户直播并发（每日）

基本信息

请求参数

返回数据

获取所有流媒体节点信息接口

基本信息

请求参数

返回数据

聊天获取被过滤敏感词

基本信息

请求参数

返回数据

批量查询用户并发及使用情况

基本信息

请求参数

返回数据

直播间用户进出信息

基本信息

请求参数

返回数据

获取直播中录制记录

基本信息

请求参数

返回数据

模板信息

基本信息

请求参数

返回数据

录制状态

基本信息

请求参数

获取用户并发

基本信息

请求参数

获取用户并发v1

基本信息

请求参数

获取用户最大并发

基本信息

请求参数

返回数据

获取用户并发列表

基本信息

请求参数

返回数据

获取用户统计信息

基本信息

请求参数

返回数据

批量获取直播的最大并发

基本信息

请求参数

返回数据

获取观看直播的访问记录

基本信息

请求参数

返回数据

获得场景视频接口文档