Webcast Json API

1 概述

本文档作为Web端提供给第三方接口开发的依据。

2 访问说明

2.1 采用Http

采用http访问，提供Post方式。

2.2 访问路径

接口调用访问路径规则：http://{站点域名}/integration/site/{接口路径}

某个接口的访问路径要与第三方所在站点域名保持一致。

比如开了一个站点test 域名是test.gensee.com，接口路径/webcast/user/created,那么该站点接口访问路径为http://test.gensee.com/integration/site/webcast/user/created 。

2.3 时间规则

发送参数时间格式：yyyy-MM-dd HH:mm:ss或者为long型（如果时间格式为long型那么该值为从1970年1月1日00:00:00 GMT以来此时间对象表示的毫秒数）

返回参数时间格式：long，（该long型那么该值为从1970年1月1日00:00:00 GMT以来此时间对象表示的毫秒数）

2.4 返回格式

返回的数据格式都是以JSON格式，以下接口中返回数据多是在json格式转换后的参数。对于返回参数有些属性没有则表示该项值为null。

2.5 返回数据说明

返回的数据中如果某个参数返回的值是个JSON的对象或者是list对象，那么list对象可能为空值或者JSON对象可能为null，而对于list内如果还是JSON对象对于其属性值为空时则不显示，而对于JSON对象的属性为null则为空。

2.6返回码定义

返回代码	说明
0	成功
-1	失败
101	参数错误
102	参数转换错误
200	认证失败
201	口令过期
300	系统错误
500	业务错误
501	业务错误 – 数据不存在
502	业务错误 – 重复数据
600	接口被禁用，请联系管理员

2.7 MD5/SHA-1说明

MD5/SHA-1生成规则可以在如下网页测试效果：http://tool.oschina.net/encrypt?type=2

3 测试工具

3.1 测试工具的使用

如开了一个站点test 域名是test.gensee.com那么测试工具的地址就是http://test.gensee.com/webcast/static/integration/tool.html域名必须填写正确。在测试工具中选择教育系统就可以选着对应的接口，测试工具的左边是参数的填写，点击发送之后的结果会显示在右边。

3.2 测试工具例子

上图中游览器url地址为：http://192.168.0.170/webcast/static/integration/tool.html 其中192.168.0.170即就是域名，因此如果某个站点的域名为test.gensee.com那么该处url的地址即为http://test.gensee.com/webcast/static/integration /tool.html。在左上角有两个选择框，第一个选择框在该处选择直播，第二个选择框是选择对应的接口，在选择框旁边有一个地址即为该选择接口的完整的地址。在左边的大区域内，有两个种输入框，第一种输入框是固定的分别对应的是：loginName和password，sec，这种输入框是输入登录名和密码以及是否加密，这三个参数所有的接口都有，第二种输入框是变动的会更具接口的不同而不同，这两个输入框的参数所有结合起来就是接口的参数了，参数名与输入框前的面子是一样的（对应的区域如图2）。在填写好参数之后点击发送按钮就会在右边输出对应的结果（对应的区域如图3）。

图2（左边图对应选择和填写参数）

图3（右边图输出结果区域）

4 接口定义

4.1 创建用户

4.1.1 描述

为站点创建用户基本信息，定义角色。该API要求认证用户必须具有管理员角色。

4.1.2 接口详情

接口路径	/webcast/user/created			请求方式	POST/GET
接口说明	创建用户
	属性名称	类型	说明			是否可为空
	userLoginName	String	要创建的用户的登录名
	userPassword	String	要创建的用户的密码
	maxPoints	Long	最大并发点数（只能对于被创建用户的角色是组织者才有效，同时该站点具有最大并发配置的功能，当站点配置的点数小于设置的点数则取站点配置的点数，当值为0是表示null）			是
	maxVodPoints	Long	组织者最大点播并发			是
	effectiveDate	string	生效时间(详情见2.3)			是
	invalidDate	string	失效时间(详情见2.3)			是
	name	String	用户名
	address	String	地址			是
	company	String	公司名称			是
	country	String	国家			是
	description	String	描述			是
	firstName	String	名			是
	lastName	String	姓			是
	job	String	职业			是
	male	String	性别 true - 男; false - 女, 默认为false			是
	mobile	String	手机号码			是
	nickName	String	昵称			是
	phone	String	电话号码			是
	role	String	角色 admin-管理员;organizer-组织者;user-普通用户, 默认为user			是
	state	String	地区/城市			是
	zipcode	String	邮编			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
返回参数	message	String	结果说明			是

4.2 修改用户。

4.2.1 描述

根据登录名查找用户，修改该用户基本信息，重新设置密码或角色。

该API要求认证用户必须具有管理员角色。

站点初始管理员不允许被修改。

4.2.2 接口详情

接口路径	/webcast/user/ update			请求方式	POST/GET
接口说明	修改用户
	属性名称	类型	说明			是否可为空
	userLoginName	String	要修改的用户的登录名
	userPassword	String	要修改的用户的密码
	maxPoints	Long	最大并发点数（只能对于被创建用户的角色是组织者才有效，同时该站点具有最大并发配置的功能，当站点配置的点数小于设置的点数则取站点配置的点数，当值为0是表示null）			是
	maxVodPoints	Long	组织者最大点播并发			是
	effectiveDate	String	生效时间(详情见2.3)			是
	invalidDate	String	失效时间(详情见2.3)			是
	name	String	用户名
	address	String	地址			是
	company	String	公司名称			是
	country	String	国家			是
	description	String	描述			是
	firstName	String	名			是
	lastName	String	姓			是
	job	String	职业			是
	male	String	性别 true - 男; false - 女, 默认为false			是
	mobile	String	手机号码			是
	nickName	String	昵称			是
	phone	String	电话号码			是
	role	String	角色 admin-管理员;organizer-组织者;user-普通用户, 默认为user			是
	state	String	地区/城市			是
	zipcode	String	邮编			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
返回参数	message	String	结果说明			是

4.3 改变用户状态。

4.3.1 描述

改变用户状态，禁用或者启用用户。

该API要求认证用户必须具有管理员角色。

站点初始管理员不允许被修改。

4.3.2 接口详情

接口路径	/webcast/user/change			请求方式	POST/GET
接口说明	改变用户状态
	属性名称	类型	说明			是否可为空
	userLoginName	String	要改变状态的用户登录名
	status	String	0 – 禁用；1 – 启用
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.4 创建直播

4.4.1 描述

新建直播，配置直播属性。创建成功返回该直播相关URL链接地址。

该API要求认证用户具有组织者或管理员角色。

4.4.2 接口详情

接口路径	/ webcast/created			请求方式	POST/GET
接口说明	创建直播
	属性名称	类型	说明			是否可为空
	subject	String	直播主题（长度：1-250）
	startTime	String	直播开启时间（详情见2.3）
	maxAttendees	Long	最大并发点数（该站点具有配置最大并发的功能，当站点配置的点数小于设置的点数则取站点配置的点数）			是
	loginRequired	String	是否要求用户登录，默认为false(true\|false)			是
	opened	String	是否公开，默认为false(true\|false)			是
	description	String	直播描述信息			是
	plan	String	直播议程安排			是
	speakerInfo	String	直播演讲者信息			是
	endTime	String	只有当站点具有定时关闭功能该设置的值才生效（详情见2.3）			是
	switchClient	String	是否允许升级到客户端方式，默认为false(true\|false)			是
	organizerToken	String	组织者加入直播口令。(长度：6-15)
	panelistToken	String	嘉宾加入直播口令。(长度：6-15)
	attendeeToken	String	普通参加者加入直播口令。			是
	realtime	String	是否开启实时功能，默认值为false(true\|false)			是
	aac	String	AAC开启将导致直播时WEB端用户使用语音功能失效,,默认值为false(true\|false)			是
	telconf	String	值为（0,1,2）中的一个分别对应着 0: 不开启 1: 仅开启外呼邀请 2: 开启外呼邀请，同时接受电话呼入当值为2时AAC的值必须不生效值变为false			是
	clientType	Int	值为（0,1） 0：标准版 1：轻量版默认为标准版			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	organizerJoinUrl	String	组织者加入URL(标准版组织者不用昵称口令加入URL)
	panelistJoinUrl	String	客户端加入URL（组织者/主讲/嘉宾/客户端参加者）
	attendeeJoinUrl	String	普通参加者加入URL(带token)
	id	String	直播ID
	number	String	直播编号
	attendeeAShortJoinUrl	String	普通参加者加入URL(不带token)
	organizerToken	String	组织者口令
	panelistToken	String	嘉宾口令
	attendeeToken	String	普通参加者口令
	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.5 修改直播配置

4.5.1 描述

根据直播ID配置直播属性。

该API要求认证用户具有组织者或管理员角色。

管理员可以配置站点所有直播，组织者只能配置自己创建的直播。

4.5.2 接口详情

接口路径	/webcast/update			请求方式	POST/GET
接口说明	修改直播配置
	属性名称	类型	说明			是否可为空
	id	String	直播的ID
	skin	String	皮肤，可选值为 default – 默认 gray – 灰色 blue – 蓝色 green – 绿色			是
	subject	String	直播主题（长度：1-250）
	startTime	String	直播开启时间（详情见2.3）
	maxAttendees	Long	最大并发点数（该站点具有配置最大并发的功能，当站点配置的点数小于设置的点数则取站点配置的点数）			是
	loginRequired	String	是否要求用户登录，默认为false			是
	opened	String	是否公开，默认为false			是
	endTime	Long	只有当站点具有定时关闭功能该设置的值才生效			是
	description	String	直播描述信息			是
	plan	String	直播议程安排			是
	speakerInfo	String	直播演讲者信息			是
	switchClient	String	是否允许升级到客户端方式，默认为false			是
	organizerToken	String	组织者加入直播口令。(长度：6-15)
	panelistToken	String	嘉宾加入直播口令。(长度：6-15)
	attendeeToken	String	普通参加者加入直播口令。不带该参数系统会自动分配一个口令。该参数允许输入为空字符串，意味普通参加者加入直播无需口令。			是
	realtime	String	是否开启实时功能 (true\|false)			是
	aac	String	AAC开启将导致直播时WEB端用户使用语音功能失效, (true\|false)			是
	telconf	String	值为（0,1,2）中的一个分别对应着 0: 不开启 1: 仅开启外呼邀请 2: 开启外呼邀请，同时接受电话呼入当值为2时AAC的值必须不生效值变为false			是
	clientType	Int	值为（0,1） 0：标准版 1：轻量版注：不填或者填入除0和1之外的值，数据库中该值不做改动
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
返回参数	message	String	结果说明			是

4.6 删除直播(不可恢复)

4.6.1 描述

删除已创建的直播

该API要求认证用户具有组织者或管理员角色。

管理员可以删除站点所有直播，组织者只能删除自己创建的直播。

4.6.2 接口详情

接口路径	/webcast/deleted			请求方式	POST/GET
接口说明	删除直播
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明

4.7 结束直播（可恢复）

4.7.1 描述

根据直播ID终止直播。直播终止后将不能再被开启使用。

该API要求认证用户具有组织者或管理员角色。

管理员可以终止站点所有直播，组织者只能终止自己创建的直播。

终止后可以在“已删除直播”列表内找到该直播，并且可以通过站点后台执行“恢复”操作。

4.7.2 接口详情

接口路径	/webcast/finish			请求方式	POST/GET
接口说明	结束直播
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明

4.8 获取直播配置信息

4.8.1 描述

根据直播ID获取直播各项属性信息。

该API要求认证用户具有组织者或管理员角色。

管理员可以获取站点所有直播配置信息，组织者只能获取自己创建的直播配置信息。

4.8.2 接口详情

接口路径	/webcast/setting/info			请求方式	POST/GET
接口说明	获取直播配置信息
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	id	String	直播ID
	description	String	描述
	number	String	直播编号
	endTime	Long	当站点开启定时关闭功能该字段才会有数据
	organizerJoinUrl	String	组织者加入URL(标准版组织者不用昵称口令加入URL)
	panelistJoinUrl	String	客户端加入URL（组织者/主讲/嘉宾/客户端参加者）
	attendeeJoinUrl	String	普通参加者加入URL
	loginRequired	boolean	是否要求登录(true\|false)
	opened	boolean	是否公开(true\|false)
	plan	String	议程信息
	startTime	long	开始时间(详情见2.3)
	subject	String	主题
	speakerInfo	String	演讲人信息
	maxAttendees	Long	最大并发
	organizerToken	String	组织者口令
	panelistToken	String	嘉宾口令
	attendeeToken	String	普通参加者口令
	switchClient	String	是否允许升级到客户端
	posterUrl	String	直播配图URL
	warmUpId	String	用于暖场的点播ID
	aac	boolean	是否开启（true\|false）开启AAC后将无法使用web语音功能；需要使用HTML5播放器观看请在直播开始前开启AAC
	realtime	boolean	是否开启（true\|false）开启实时直播（降低延迟，优先保证音频，适用于强调互动性的场景）
	telconf	boolean	是否开启（true\|false）电话会议集成功能
	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.9 分页同步站点直播列表

4.9.1 描述

分页同步本站点所有未终止的直播列表。每页50条数据。

该API要求认证用户具有组织者或管理员角色。

管理员可以获取站点所有直播列表，组织者只能获取自己创建的直播列表。

4.9.2 接口详情

接口路径	/webcast/page			请求方式	POST/GET
接口说明	分页获取站点直播列表
	属性名称	类型	说明			是否可为空
	pageNo	String	指定第几页（默认是1）			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	status	int	直播当前状态： 0 – 未开始。 1 – 未开始，但有客户端加入。 2 – 已开始。 99 – 已终止默认（不使用该参数时候）是获取所有未终止的直播			是
	expired	boolean	是否过期。 true表示过期。 false表示不过期。默认（不使用该参数时候）是全部直播。			是
	createdTime	String	创建时间。格式见2.3章节使用该参数时，会查询在当天创建的直播。			是
	password	String	密码

返回参数	list		JSONArray
		Id	String	直播ID
		subject	String	主题
		startTime	long	开始时间（详情见2.3）
		createdTime	long	创建时间
		description	String	描述
		number	String	直播编号
		organizerJoinUrl	String	组织者加入URL
		panelistJoinUrl	String	嘉宾加入URL
		AttendeeJoinUrl	String	普通参加者加入URL
		posterUrl	String	直播配图URL
		speakerInfo	String	演讲人信息
		status	int	直播当前状态： 0: 未开始 1: 开始但未发布直播 2: 开始且已发布直播
		creator	string	创建者
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明	是

4.10 获取直播录制的点播列表

4.10.1 描述

根据直播ID获取直播过程中录制下来的点播列表。

该API要求认证用户具有组织者或管理员角色。

管理员可以获取站点所有直播的点播列表，组织者只能获取自己创建的直播产生的点播列表。

4.10.2 接口详情

接口路径	/webcast/record/info				请求方式	POST/GET
接口说明	获取直播录制的点播列表
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	Id		String	点播ID
	recordList		JSONArray
		Id	String	点播ID
		url	String	点播URL
		size	long	存储空间大小
		subject	String	点播名称
		password	String	观看密码
		createdTime	日期	创建时间
		recordStartTime	日期	录制开始时间
		recordEndTime	日期	录制结束时间
		duration	long	点播时长			是
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.11 新增直播附件

4.11.1 描述

为直播添加文档附件。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.11.2 接口详情

接口路径	/webcast/file/attach				请求方式	POST/GET
接口说明	新增直播附件
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	attachmentList		JSONArray
		url	String	文档附件的URL链接
		name	String	文档附件名称			是
		description	String	文档附件描述			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.12 删除直播附件

4.12.1 描述

删除直播的文档附件。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.12.2 接口详情

接口路径	/webcast/file/detach			请求方式	POST/GET
接口说明	删除直播附件
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	urls	String[]	被删除文档附件的URL链接
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.13 导出直播用户访问历史记录

4.13.1 描述

根据开始时间和结束时间，导出加入时间在此范围内的参会者访问记录

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的访问记录。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.13.2 接口详情

接口路径	/webcast/export/history				请求方式	POST/GET
接口说明	导出直播用户访问历史记录
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	startTime		String	导出的数据大等于开始时间			是
	endTime		String	导出的数据小等于结束时间			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		nickname	String	昵称
		joinTime	long	加入时间（详情见2.3）
		leaveTime	long	离开时间（详情见2.5）
		ip	String	IP地址
		uid	long	用户ID
		area	String	区域
		mobile	String	手机
		company	String	公司
		userdata	String	自定义参数。格式类似URL parameter：key1=value1&key2=value2… 需要获取数据后自行解析
		joinType	long	加入终端类型。值说明： 0 PC客户端 1 PC Web端（Flash） 2 PC Web端(Flash http流) 3 IPAD Web端 4 IPHONE Web端 5 APAD Web端 6 APHONE Web端 7 IPAD APP端 8 IPHONE APP端 9 APAD APP端 10 APHONE APP端 11 MAC 客户端 12 电话端 16 PLAYER SDK IOS端 17 PLAYER SDK 安卓端 20 安卓G直播TV版 21 小程序IOS端 22 小程序安卓端 23 小程序sdk IOS端 24 小程序sdk 安卓端 26 PC Web端（FLV H5） 27 PC Web端（H5）
		idcid（可选）	String	idcid（启用海外高速线路增加该字段导出）
		foreignHighLine（可选）	Boolean	是否是海外高速线路 true为海外高速线路（启用海外高速线路增加该字段导出）
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.14 导出直播投票结果

4.14.1 描述

根据开始时间和结束时间，导出发起时间在此范围内的投票所有反馈结果。

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的所有投票反馈结果。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.14.2 接口详情

接口路径	/webcast/export/vote							请求方式	POST/GET
接口说明	导出直播投票结果
	属性名称					类型	说明			是否可为空
	webcastId					String	直播ID
	startTime					String	导出的数据大等于开始时间			是
	endTime					String	导出的数据小等于结束时间			是
	sec					String	true:表示密码是经过加密的。			是
	loginName					String	登录名
	password					String	密码
返回参数	voteList					JSONArray
		subject				String	投票的主题
		questions				JSONArray
			content			String	问题内容
			answer			String	标准答案（多个答案用逗号连接）。答案用数字表示，比如 1第一个选项是标准答案。 1,2第一第二选项是标准答案。			是
			score			int	分数			是
			type			int	类型（0 – 单选；1 – 多选；2 – 文本）
			options			JSONArray
				value		String	问题的值
				result		String	投票结果
				precentage		BigDecimal	百分比
				results		JSONArray
					nickName	String	昵称
					answer	String	回答（当非选择题）
					uid	Long	用户ID
	code					String	返回结果代码（详情见2.5）
	message					String	结果说明			是

4.15 导出直播用户提问数据

4.15.1 描述

根据开始时间和结束时间，导出直播用户提问数据。

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的提问数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.15.2 接口详情

接口路径	/webcast/export/qa				请求方式	POST/GET
接口说明	导出直播用户提问数据
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	startTime		String	导出的数据大等于开始时间			是
	endTime		String	导出的数据小等于结束时间			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	qaList		JSONArray
		submitTime	Long	提问时间（详情见2.3）
		published	boolean	是否发布(true\|false)
		question	String	问题
		response	String	回答
		responder	String	回答者的名字
		submitter	Long	提问者UserID
		answerBy	Long	回答者UserID
		name	String	提问用户的名字
		answerTime	Long	回复时间（详情见2.3）
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.16 导出直播点名签到数据

4.16.1 描述

根据开始时间和结束时间，导出发起时间在此范围内的用户点名签到信息。

如果没有提供开始时间和结束时间，则找到最近已结束的直播场次，导出该场次的点名签到数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.16.2 接口详情

接口路径	/webcast/export/rollcall						请求方式	POST/GET
接口说明	导出直播点名签到数据
	属性名称			类型		说明			是否可为空
	webcastId			String		直播ID
	startTime			String		导出的数据大等于开始时间			是
	endTime			String		导出的数据小等于结束时间			是
	sec			String		true:表示密码是经过加密的。			是
	loginName			String		登录名
	password			String		密码
返回参数	rollcall			JSONArray
		startTime		long		开始点名时间（详情见2.3）
		endTime		long		结束点名时间（详情见2.3）
		total		Int		总数
		present		int		出席人数
		absent		int		缺席人数
		users		JSONArray
			id		long	用户ID
			name		String	用户名字
			present		boolean	该用户是否出席(true\|false)
	code			String		返回结果代码（详情见2.5）
	message			String		结果说明			是

4.17 更改点播信息

4.17.1 描述

提交需要更改的点播信息。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有点播，组织者只能操作自己创建的点播。

4.17.2 接口详情

接口路径	/webcast/vod/update			请求方式	POST/GET
接口说明	更改点播信息
	属性名称	类型	说明			是否可为空
	Id	String	点播ID
	subject	String	主题
	speakerInfo	String	演讲人介绍，			是
	agenda	String	日程安排，			是
	description	String	点播介绍，			是
	loginRequired	String	是否要求登录，可选。默认为false			是
	opened	String	是否公开，可选。默认为false			是
	vodPassword	String	密码，当pwdRequired为true时候必填			是
	pwdRequired	String	是否需要密码保护，可选。默认为false			是
	skin	String	皮肤，gray, blue, green三者中可选			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
返回参数	message	String	结果说明			是

4.18 撤销已发布点播

4.18.1 描述

将已发布的点播删除。被删除的点播将自动转为未发布点播。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有点播，组织者只能操作自己创建的点播。

4.18.2 接口详情

接口路径	/webcast/vod/unpublish			请求方式	POST/GET
接口说明	撤销已发布点播
	属性名称	类型	说明			是否可为空
	vodId	String	点播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.19 发布点播

4.19.1 描述

发布系统中的未发布点播。点播只有发布后才能够播放。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有点播，组织者只能操作自己创建的点播。

4.19.2 接口详情

接口路径	/webcast/vod/publish			请求方式	POST/GET
接口说明	发布点播
	属性名称	类型	说明			是否可为空
	vodId	String	点播ID，必填
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.20 分页获取由castmaker上传生成的点播列表

4.20.1 描述

分页获取本站点castmaker录制上传的点播列表。每页50条数据。

该API要求认证用户具有组织者或管理员角色。

管理员可以获取站点所有点播列表，组织者只能获取自己创建的点播列表。

4.20.2 接口详情

接口路径	/webcast/castmaker/page				请求方式	POST/GET
接口说明	分页获取由castmaker上传生成的点播列表
	属性名称		类型	说明			是否可为空
	pageNo		String	指定第几页，默认为1			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	startTime		String	导出的数据大等于开始时间			是
	endTime		String	导出的数据小等于结束时间			是
	password		String	密码
返回参数	page		JSONArray
		pageNo	int	当前页数
		totalPages	int	总的页数
		totalCounts	int	总的条数
	list		JSONArray
		Id	String	点播ID
		subject	String	主题
		password	String	观看口令，允许为空
		description	String	描述
		createdTime	Long	创建时间（详情见2.3）
		screenshot	String
		webcast	String	直播ID
		creator	Long	创建用户ID
		recordId	Long	资源ID
		attendeeJoinUrl	String	加入URL
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.21 分页获取正在进行的直播列表

4.21.1 描述

分页获取本站点正在进行的直播列表。

正在进行的定义，是指组织者已加入客户端并且点击了“开启直播”按钮。

该API要求认证用户具有组织者或管理员角色。

管理员可以获取站点所有正在进行的直播列表，组织者只能获取自己创建的直播列表。

4.21.2 接口详情

接口路径	/webcast/ongoing/page					请求方式	POST/GET
接口说明	分页获取正在进行的直播列表
	属性名称			类型	说明			是否可为空
	pageNo			int	指定第几页，默认为1			是
	pageSize			int	每页多少条数据，默认是20			是
	sec			String	true:表示密码是经过加密的。			是
	loginName			String	登录名
	password			String	密码
返回参数	page			JSONArray
			pageNo	int	当前页数
			totalPages	int	总的页数
			totalCounts	int	总的条数
	list			JSONArray
		Id		String	直播ID
		subject		String	主题
		online		Int	当前人数
		startTime		Long	计划开始时间（详情见2.3）
		createdTime		Long	创建时间（详情见2.3）
		attendeeJoinUrl		String	Web端加入URL
		panelistJoinUrl		String	客户端加入URL
		description		String	描述
		attendeeToken		String	Web端口令
		panelistToken		String	嘉宾口令
		organizerToken		String	组织者口令
	code			String	返回结果代码（详情见2.5）
	message			String	结果说明			是

4.22 分页同步录制件数据

4.22.1 描述

分页获取本站点保存的录制件数据。每页50条数据。

在很多场合下，第三方希望能同步Gensee的录制件信息到自己的系统中。第三方业务系统在同步数据后可以根据自己的业务进行查询，对账等操作。

第三方可以使用录制件信息在自己系统实现对直播的插播列表配置。

该API要求认证用户具有管理员角色。

4.22.2 接口详情

接口路径	/webcast/record/sync				请求方式	POST/GET
接口说明	分页同步录制件数据
	属性名称		类型	说明			是否可为空
	pageNo		int	指定第几页，默认为1			是
	startTime		String	同步创建时间大于等于startTime的录制件（详见3.3）
	endTime		String	同步创建时间小于等于endTime的录制件（结束时间（详见3.3）
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	page		JSONArray
		pageNo	int	当前页数
		totalPages	int	总的页数
		totalCounts	int	总的条数
	list		JSONArray
		Id	String	录制件ID
		name	String	名称
		fileName	String	文件名
		recordStartTime	Long	在线录制开始时间（详情见2.3）
		createdTime	Long	创建时间（详情见2.3）
		recordEndTime	Long	在线录制结束时间（详情见2.3）
		size	Long	存储大小，单位byte
		duration	Long	内容时长。单位是毫秒。
		creator	Long	录制或上传该录制件的用户ID
		webcastId	String	直播ID。标明该录制件由哪个直播在线录制生成。
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.23 分页同步点播数据

4.23.1 描述

分页获取本站点中已发布的点播数据。每页最大返回50条数据。

在很多场合下，第三方希望能同步Gensee的已发布点播数据到自己的系统中。第三方业务系统在同步数据后可以根据自己的业务进行查询，对账等操作。

该API要求认证用户具有管理员角色。

4.23.2 接口详情

接口路径	/webcast/vod/sync				请求方式	POST/GET
接口说明	分页同步点播数据
	属性名称		类型	说明			是否可为空
	pageNo		int	指定第几页，默认为1
	startTime		String	同步创建时间大于等于startTime的录制件（详见2.3）
	endTime		String	同步创建时间小于等于endTime的录制件（结束时间（详见2.3）
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	page		JSONArray
		pageNo	int	当前页数
		totalPages	int	总的页数
		totalCounts	int	总的条数
	list		JSONArray
		Id	String	点播ID
		subject	String	主题
		password	String	观看口令，允许为空
		description	String	描述
		createdTime	Long	创建时间（详情见2.3）
		attendeeJoinUrl	String	加入URL
		webcastId	String	直播ID。指明该点播是由哪个直播录制生成的。
		screenshot	String
		creator	Long	创建该点播的用户ID(点播的所有者)
		number	String	点播的编号
		recordId	Long	该点播使用的录制件ID
		recordStartTime	Long	录制开始时间（详情见2.3）
		recordEndTime	Long	录制结束时间（详情见2.3）
		grType	int	0、3、4录制件1多媒体2文档
		duration	Long	内容时长。单位是毫秒。
		convertResult	int	0转换中 1转换成功 -1 失败
		plan	String	议程
		speakerInfo	String	演讲人信息
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.24 为直播分配一个点播作为暖场

4.24.1 描述

为直播指定一个点播作为暖场使用。

暖场指：当直播未开始时候，可以让用户先观看一个点播。

该API要求认证用户具有管理员角色。

4.24.2 接口详情

接口路径	/webcast/warmup/attach			请求方式	POST/GET
接口说明	为直播分配一个点播作为暖场
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	vodId	String	作为暖场的点播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.25 为直播取消暖场

4.25.1 描述

为直播取消暖场。

该API要求认证用户具有管理员角色。

4.25.2 接口详情

接口路径	/webcast/warmup/detach			请求方式	POST/GET
接口说明	为直播取消暖场
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	vodId	String	作为暖场的点播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.26 为直播设置多个录制件作为插播

4.26.1 描述

选择一个或多个录制件，作为直播开启后，客户端中的插播件使用。请调用接口的开发方，注意过滤重复冗余的录制件信息。

插播：客户端开启直播后，可以指定某个录制件内容作为发布源，直播给所有web端用户。

该API要求认证用户具有管理员角色。

4.26.2 接口详情

接口路径	/webcast/record/choose			请求方式	POST/GET
接口说明	为直播设置多个录制件作为插播
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	recordId	List<Long>	录制件ID，作为客户端插播使用。本API不校验重复的录制件，由调用方自行保证录制件不重复。
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.27 为直播取消用作插播的录制件

4.27.1 描述

为直播取消插播件。即去除录制件和直播的关联关系。请调用接口的开发方，注意过滤重复冗余的录制件ID。

该API要求认证用户具有管理员角色。

4.27.2 接口详情

接口路径	/webcast/record/remove			请求方式	POST/GET
接口说明	为直播取消用作插播的录制件
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	recordId	List<Long>	录制件ID，作为客户端插播使用。本API不校验重复的录制件，由调用方自行保证录制件不重复。
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.28 设置Web端播放器模式

4.28.1 描述

为直播或点播配置播放器样式。当前有两种样式可以选择，1是三分屏模式，2是视频/文档模式。

该API要求认证用户具有组织者或管理员角色。组织者只能配置自己的直播或者点播。管理员可以配置所有点播或者直播。

4.28.2 接口详情

接口路径	/webcast/player/setup			请求方式	POST/GET
接口说明	设置Web端播放器模式
	属性名称	类型	说明			是否可为空
	id	String	直播或点播ID。取决于isLive参数
	live	boolean	判断是直播还是点播。为true说明是直播，为false说明是点播。默认是false			是
	mode	int	1是三分屏，2是视频为主，3是两分屏，4是互动增强四分屏，5是互动增强三分屏，6是互动增强全屏
	mobileMode	int	老版本手机播放器:（不建议使用）1文档为主，2视频为主，3音频文档；新版本播放器: 1和2均为视频+文档 3是音频文档默认值为1			是
	padMode	int	1是三分屏，2是视频为主，3是两分屏,默认值为1			是
	autoPlay	Boolean	为视频/文档为主的模式设置是否自动播放。true自动播放器，false不自动播放。该参数只在mode=2时候使用。			是
	video	Boolean	为视频/文档为主的模式设置是否视频为主。true视频为主，false文档为主。该参数只在mode=2时候使用。			是
	showWindow	Boolean	为视频/文档为主的模式设置是否默认显示小窗口。True显示，false不显示。该参数只在mode=2时候使用。			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
	playerTheme	String	互动增强三分屏（uiMode等于4）和互动增强四分屏（uiMode等于5）的默认皮肤。夜空为空，雪峰：“skyblue”			是
	fullScreenModde	int	互动增强全屏的设置，0：视频为主，1：文档为主，2：纯视频，3：存文档			是
返回参数	code	String	返回结果代码（详情见2.5）
返回参数	message	String	结果说明			是

4.29 分页同步文档数据

4.29.1 描述

分页获取本站点保存的文档数据。每页50条数据。

在很多场合下，第三方希望能同步Gensee的服务端文档信息到自己的系统中。第三方业务系统在同步数据后可以根据自己的业务进行查询，为直播分配服务端文档等操作。

该API要求认证用户具有管理员角色。

4.29.2 接口详情

接口路径	/webcast/doc/sync					请求方式	POST/GET
接口说明	分页同步文档数据
	属性名称			类型	说明			是否可为空
	pageNo			int	指定第几页，默认为1			是
	startTime			String	同步创建时间大于等于startTime的文档件（详情见2.3）
	endTime			String	同步创建时间小于等于endTime的文档件（详情见2.3）
	sec			String	true:表示密码是经过加密的。			是
	loginName			String	登录名
	password			String	密码
返回参数	page			JSONArray
		pageNo		int	当前页数
		totalPages		int	总的页数
		totalCounts		int	总的条数
	list			JSONArray
			createdTime	Long	创建时间（详情见2.3）
			upload	Boolean	是否由castmaker上传生成的。true表明是castmaker上传，false表明是在线直播保存的。
			id	Long	文档ID
			name	String	文档名字
			convCode	int	0表示success,1表示fail,2表示正在转码
	code			String	返回结果代码（详情见2.5）
	message			String	结果说明			是

4.30 为直播分配一个服务端文档

4.30.1 描述

选择一个服务端文档，作为直播开启后，客户端中的文档内容使用。

该API要求认证用户具有管理员角色。

4.30.2 接口详情

接口路径	/webcast/doc/attach			请求方式	POST/GET
接口说明	为直播分配一个服务端文档
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	docId	String	文档ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.31 为直播取消服务端文档

4.31.1 描述

为直播取消服务端文档。即去除文档和直播的关联关系。

该API要求认证用户具有管理员角色。

4.31.2 接口详情

接口路径	/webcast/doc/detach			请求方式	POST/GET
接口说明	为直播取消服务端文档
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID
	docId	String	文档ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.32 按天同步点播访问记录

4.32.1 描述

为点播导出按天同步访问记录。

该API要求认证用户具有管理员角色。

4.32.2 接口详情

接口路径	/webcast/export/vod/history				请求方式	POST/GET
接口说明	按天同步点播访问记录
	属性名称		类型	说明			是否可为空
	pageNo		Int	页数（从1开始）			是
	date		String	开始时间（详情见2.3）
	hour		int	小时（0-23）不填默认为全天数据			是
	joinTimeSync		Boolean	为空或者为true 按加入时间同步，其他按离开时间同步			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		vodId	String	点播ID
		uid	String	用户ID
		startTime	long	加入时间（详情见2.3）
		leaveTime	long	离开时间（详情见2.3）
		name	String	姓名
		duration	int	观看时长，单位为毫秒
		ip	String	IP地址
		area	String	区域
		device	int	终端类型。值说明： 0 PC 1 Mac 2 Linux 4 Ipad 8 Iphone 16 Andriod Pad 32 Andriod Phone 132 IPad(PlayerSDK) 136 IPhone(PlayerSDK) 144 Andriod Pad(PlayerSDK) 256 Andriod Phone(PlayerSDK) 0xED Mobile 237 移动设备（以前版本的移动端的playersdk和app） 21 小程序IOS端 22 小程序安卓端 23 小程序sdk IOS端 24小程序sdk 安卓端其他值为 Unknown
	pageNo		int	当前页数
	totalCounts		int	总的数目
	totalPages		Int	总的页数
	code		String	返回结果代码（详情见3.5）
	message		String	结果说明			是

4.33 导出直播公共聊天数据

4.33.1 描述

根据开始时间和结束时间，导出直播用户的公共聊天数据。

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的公共聊天数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.33.2 接口详情

接口路径	/webcast/export/chat				请求方式	POST/GET
接口说明	导出直播用户聊天数据
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	startTime		String	导出的数据大等于开始时间			是
	endTime		String	导出的数据小等于结束时间			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		time	Long	聊天时间（详情见2.3）
		sender	String	发送者名称
		receiver	String	接收者名称
		senderId	Long	发送者UserID
		receiverId	Long	接收者UserID
		msg	String	内容
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.34 导出直播使用场次纪录

4.34.1 描述

根据开始时间和结束时间，导出某个直播结束时间在此范围内的使用场次纪录。

如果不提供webcastId，则导出所有直播在此范围内的数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有管理员角色。

4.34.2 接口详情

接口路径	/webcast/export/usage				请求方式	POST/GET
接口说明	导出直播使用场次纪录
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID			是
	startTime		String	导出的数据大等于开始时间
	endTime		String	导出的数据小等于结束时间
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		id	Long	课堂ID
		startTime	Date	课堂开启时间
		endTime	Date	课堂结束时间
		subject	String	直播主题
		number	String	直播编号
		maxConcurrent	Int	最大并发
		total	Int	参会人次
		maxConcurrentVip（可选）	Int	该直播对应的最大的海外高速线路并发（站点启用增加该字段的导出）
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.35 后台文档上传转码

4.35.1 描述

通过该接口上传转码第三方文档

该API要求认证用户必须具有管理员角色或组织者角色

4.35.2 接口详情

接口路径	/webcast/courseware/transcode			请求方式	POST/GET
接口说明	后台文档上传转码
	属性名称	类型	说明			是否可为空
	resourceUrl	String	原始文档地址 (对于有些用户通过接口请求转码时，给定的原始文件url路径中没有显式的包含文件名与文件类型后缀（如 wendang.ppt)，导致最终转码失败，这里给出一个解决方案，如url路径中无法包含文件名与后缀，需在url参数中增加gs_filename参数，用于存放文件名与后缀。下载服务会优先使用gs_filename参数中给定的文件名，若不存在，再从url路径中解析文件名与后缀例如：http://example.com/abc/def/download?a=x&b=y&gs_filename=file.pptx)
	callbackUrl	String	通知转码状态的url由用户提供，转码结束后post请求通知转码状态参数 gscoursewareId--点播id gsstatus--点播状态ok 或者error;为空则不通知			是
	name	String	文档名称
	convmode	Integer	0:矢量模式转码；1:图片模式转码注：不填为矢量模式			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是
	coursewareId	String	点播id
	coursewareCode	String	点播编码
	visitUrl	String	访问url
	docId	String	文档id

4.36 后台多媒体上传转码

4.36.1 描述

通过该接口上传转码第三方多媒体

该API要求认证用户必须具有管理员角色或组织者角色

4.36.2 接口详情

接口路径	/ webcast/media/transcode			请求方式	POST/GET
接口说明	后台多媒体上传转码
	属性名称	类型	说明			是否可为空
	resourceUrl	String	原始多媒体地址
	callbackUrl	String	通知转码状态的url由用户提供，转码结束后post请求通知转码状态参数 gscoursewareId--点播id gsstatus--点播状态ok 或者error;为空则不通知			是
	name	String	文件名称
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是
	coursewareId	String	点播id
	coursewareCode	String	点播编码
	visitUrl	String	访问url
	recordId	String	多媒体id

4.37 按天导出直播历史并发

4.37.1 描述

根据开始日期和结束日期，导出在此时间范围内的按天统计的最大直播并发记录。

注意：开始日期和结束日期间隔不能超过30天。

该API要求认证用户具有管理员角色。

4.37.2 接口详情

接口路径	/webcast/room/concurrent				请求方式	POST/GET
接口说明	按天导出直播历史并发
	属性名称		类型	说明			是否可为空
	startDate		String	开始日期格式必须为"yyyy-MM-dd"
	endDate		String	结束日期格式必须为"yyyy-MM-dd"
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		date	String	日期格式为"yyyy-MM-dd"
		maxConcurrent	Int	最大并发
		maxVip（可选）	Int	对应的最大的海外高速线路并发（站点启用增加该字段的导出）
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.38 按天导出点播历史并发

4.38.1 描述

根据开始日期和结束日期，导出在此时间范围内的按天统计的最大点播并发记录。

注意：开始日期和结束日期间隔不能超过30天。

该API要求认证用户具有管理员角色。

4.38.2 接口详情

接口路径	/webcast/vod/concurrent				请求方式	POST/GET
接口说明	按天导出点播历史并发
	属性名称		类型	说明			是否可为空
	startDate		String	开始日期格式必须为"yyyy-MM-dd"
	endDate		String	结束日期格式必须为"yyyy-MM-dd"
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		date	String	日期格式为"yyyy-MM-dd"
		maxConcurrent	Int	最大并发
	code		String	返回结果代码（详情见2.5）
	message		String	结果说明			是

4.39 为直播添加一条转播源记录

4.39.1 描述

当前直播可以选择多个本站点其它直播作为转播源。该接口为当前直播添加一条转播源记录。

该API要求认证用户具有组织者角色。

4.39.2 接口详情

接口路径	/webcast/relay/add			请求方式	POST/GET
接口说明	为直播添加一条转播源记录
	属性名称	类型	说明			是否可为空
	webcastId	String	当前直播ID
	relayId	String	作为转播源的直播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.40 为直播取消一条转播源记录

4.40.1 描述

当前直播可以选择多个本站点其它直播作为转播源。该接口为当前直播取消一条转播源记录。

该API要求认证用户具有组织者角色。

4.40.2 接口详情

接口路径	/webcast/relay/remove			请求方式	POST/GET
接口说明	为直播取消一条转播源记录
	属性名称	类型	说明			是否可为空
	webcastId	String	当前直播ID
	relayId	String	作为转播源的直播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见2.5）
	message	String	结果说明			是

4.41获取点播的观看人次

4.41.1描述

该接口为获取点播的观看人次。

该API要求认证用户具有组织者角色。

4.41.2接口详情

接口路径	/webcast/vod/vodview			请求方式	POST/GET
接口说明	获取点播的观看人次
	属性名称	类型	说明			是否可为空
	id	String	点播ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	total	Integer	观看人次
	code	String	返回结果代码（详情见3.5）
	message	String	结果说明			是

4.42创建点播

4.42.1描述

该接口为创建点播。

该API要求认证用户具有组织者或管理员角色。

说明 Boolean类型的数据必须为true/false或者为空(false)。

isPublish=false 创建的为未发布的点播返回{code:0,message:’成功消息’}

isPublish=true 创建的为已发布的点播成功返回的包含所有的返回参数信息。

参数recordId必须属于该管理者/组织者。

4.42.2接口详情

接口路径	/webcast/vod/vodcreate			请求方式	POST/GET
接口说明	创建点播
	属性名称	类型	说明			是否可为空
	subject	String	点播主题
	opened	Boolean	是否公开			是
	loginRequired	Boolean	是否需要登录			是
	passwords	String	点播密码			是
	description	String	点播内容介绍			是
	speakerInfo	String	演讲人介绍			是
	agenda	String	议程安排			是
	recordId	Long	录制件ID
	isPublish	Boolean	是否发布			是
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	id	Integer	点播ID			是
	vodCode	String	点播编号			是
	url	String	点播URL			是
	token	String	点播口令			是
	subject	String	关联录制件主题			是
	during	String	点播时长			是
	code	String	返回结果代码（详情见3.5）
	message	String	结果说明			是

4.44 创建多媒体点播

4.44.1描述

该接口为创建多媒体点播。

该API要求认证用户具有组织者或管理员角色。

说明 Boolean类型的数据必须为true/false或者为空(false)。

参数mediaId必须属于该管理者/组织者。

4.44.2接口详情

接口路径	/webcast/svrMedia/vod/create			请求方式	POST/GET
接口说明	创建多媒体点播
	属性名称	类型	说明			是否可为空
	subject	String	点播主题
	opened	Boolean	是否公开			是
	loginRequired	Boolean	是否需要登录			是
	passwords	String	点播密码			是
	description	String	点播内容介绍			是
	speakerInfo	String	演讲人介绍			是
	agenda	String	议程安排			是
	recordId	Long	多媒体ID
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	id	Integer	点播ID			是
	vodCode	String	点播编号			是
	url	String	点播URL			是
	token	String	点播口令			是
	subject	String	关联录制件主题			是
	code	String	返回结果代码（详情见3.5）
	message	String	结果说明			是

4.45 ptz指令

4.45.1描述

指定直播间的指定客户端控制摄像头

该API要求认证用户具有管理员角色。

4.45.2接口详情

接口路径	/webcast/ptz			请求方式	POST/GET
接口说明	指定直播间的指定客户端控制摄像头
	属性名称	类型	说明			是否可为空
	webcastId	String	直播ID			否
	userid	String	用户id			否
	command	String	0:上 1:下 2:左 3:右 4:zoom in 5: zoom out 6:恢复1 7:恢复2 8:恢复3			否
	loginName	String	登录名			否
	sec	String	true:表示密码是经过加密的。			是
	password	String	密码			否
	times	Int	次数（默认值为1）当command=0-5 times生效取值范围为1-20。			否

4.46 按天导出打赏金额

4.46.1描述

根据开始日期和结束日期，导出在此时间范围内的按天统计的打赏信息。

注意：开始日期和结束日期间隔不能超过30天。

该API要求认证用户具有管理员角色。

4.46.2接口详情

接口路径	/webcast/export/reward					请求方式	POST/GET
接口说明	按天导出打赏信息
	属性名称			类型	说明			是否可为空
	startDate			String	开始日期格式必须为"yyyy-MM-dd"
	endDate			String	结束日期格式必须为"yyyy-MM-dd"
	sec			String	true:表示密码是经过加密的。			是
	loginName			String	登录名
	password			String	密码
返回参数	list			JSONArray
		subject		String	直播主题
		startDate		Date	直播开始时间
		endDate		Date	直播结束时间
		totalReward		Long	直播打赏总收入
		speakerInfoList		JSONArray
			speakerName	String	主讲人
			speakerReward	Integer	主讲金额
	code			String	返回结果代码（详情见3.5）
	message			String	结果说明			是

4.47查询直播状态

4.47.1描述

根据直播Id查询直播状态。

该API要求认证用户具有组织者或管理员角色。

4.47.2接口详情

接口路径	/webcast/ query/status			请求方式	POST/GET
接口说明	查询直播状态
	属性名称	类型	说明			是否可为空
	webcastId	String	直播Id
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	status	Integer	0:直播未开始或者已结束 1:直播前准备（有客户端在直播间但是未点击‘开始直播’按钮） 2:直播已开始
	code	String	返回结果代码（详情见3.5）
	message	String	结果说明			是

4.48删除单个录制件

4.48.1描述

根据录制件id删除录制件。

该API要求认证用户具有组织者或管理员角色。

*说明：该操作同时会删除相关的点播，插播，暖场。

4.48.2接口详情

接口路径	/webcast/record/delete			请求方式	POST/GET
接口说明	删除单个录制件
	属性名称	类型	说明			是否可为空
	resourceId	Long	录制件Id
	sec	String	true:表示密码是经过加密的。			是
	loginName	String	登录名
	password	String	密码
返回参数	code	String	返回结果代码（详情见3.5）
	message	String	结果说明			是

4.49 分页导出直播用户访问历史记录

4.49.1 描述

根据开始时间和结束时间，导出加入时间在此范围内的参会者访问记录

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的访问记录。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户具有组织者或管理员角色。

管理员可以操作站点内所有直播，组织者只能操作自己创建的直播。

4.49.2 接口详情

接口路径	/webcast/export/history/page				请求方式	POST/GET
接口说明	分页导出直播用户访问历史记录
	属性名称		类型	说明			是否可为空
	webcastId		String	直播ID
	startTime		String	导出的数据大等于开始时间			是
	endTime		String	导出的数据小等于结束时间			是
	pageNo		Integer	当前页默认首页			是
	sec		String	true:表示密码是经过加密的。			是
	loginName		String	登录名
	password		String	密码
返回参数	list		JSONArray
		nickname	String	昵称
		joinTime	long	加入时间（详情见3.3）
		leaveTime	long	离开时间（详情见3.5）
		ip	String	IP地址
		uid	long	用户ID
		area	String	区域
		mobile	String	手机
		company	String	公司
		userdata	String	自定义参数。格式类似URL parameter：key1=value1&key2=value2… 需要获取数据后自行解析
		joinType	long	加入终端类型。值说明： 0 PC客户端 1 PC Web端 2 PC Web端(http流) 3 IPAD Web端 4 IPHONE Web端 5 APAD Web端 6 APHONE Web端 7 IPAD APP端 8 IPHONE APP端 9 APAD APP端 10 APHONE APP端 11 MAC 客户端 12 电话端 16 PLAYER SDK IOS端 17 PLAYER SDK 安卓端 21 小程序IOS端 22 小程序安卓端 23 小程序sdk IOS端 24小程序sdk 安卓端
		idcid（可选）	String	idcid（启用海外高速线路增加该字段导出）
		foreignHighLine（可选）	Boolean	是否是海外高速线路 true为海外高速线路（启用海外高速线路增加该字段导出）
	pageDto		JSONOBJECT
		pageNo	int	当前页数
		totalPages	int	总的页数
		totalCounts	int	总的条数
	code		String	返回结果代码（详情见3.5）
	message		String	结果说明			是

4.50 导出直播点赞统计

4.50.1 描述

根据开始时间和结束时间，为直播导出在此时段内的点赞数据。

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的所有点赞数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户必须具有管理员角色或教师角色

4.50.2 接口详情

接口路径	/webcast/export/praise					请求方式	POST/GET
接口说明	导出直播点赞统计
	属性名称			类型	说明			是否可为空
	webcastId			String	直播ID
	startTime			String	开始时间			是
	endTime			String	结束时间			是
	pageNo			int	指定第几页，默认为1			是
	sec			String	true:表示密码是经过加密的。			是
	loginName			String	登录名
	password			String	密码
返回参数	praiseDtos			JSONArray
		userName		String	接收人
		userId		int	接收人的ID
		count		int	接收人点赞的数量
		roomStartTime		Date	课堂开始时间
	page			JSONArray
			pageNo	int	当前页数
			totalPages	int	总的页数
			totalCounts	int	总的条数
	code			String	返回结果代码（详情见3.5）
	message			String	结果说明			是

4.51 导出直播点赞明细

4.51.1 描述

根据开始时间和结束时间，为直播导出在此时段内的点赞数据。

如果没有提供开始时间和结束时间，则找到最近结束的直播场次，导出该场次的所有点赞数据。

注意：开始时间和结束时间间隔不能超过7天。

该API要求认证用户必须具有管理员角色或教师角色

4.51.2 接口详情

接口路径	/webcast/export/praise/detail					请求方式	POST/GET
接口说明	导出直播点赞明细
	属性名称			类型	说明			是否可为空
	webcastId			String	直播ID
	startTime			String	开始时间			是
	endTime			String	结束时间			是
	sec			String	true:表示密码是经过加密的。			是
	loginName			String	登录名
	password			String	密码
返回参数	praiseDtos			JSONArray
		userId		Long	点赞用户ID
		userName		String	点赞用户昵称
		actionTime		Date	点赞时间
		targetUserId		Long	收赞用户ID
		targetUserName		String	收赞用户昵称
	page			JSONArray
			pageNo	int	当前页数
			totalPages	int	总的页数
			totalCounts	int	总的条数
	code			String	返回结果代码（详情见3.5）