描述

当用户有自己的网校系统、OA系统时,用户的系统拥有多样的授权观看方式。经过用户体系授权,调用该接口可直接获取课程链接地址。通过该课程链接地址可以直接进入微吼课堂的上课界面,而不用进入角色登录界面输入角色口令。

通过访问接口返回的课程链接,登录课程的验证策略为:不同的角色用户访问课程链接地址(url),先解析token进行鉴权登录,鉴权成功后,浏览器将根据角色不同保存不同的cookie值。

提示:

1.若要进行视频互动,请使用Chrome浏览器61以上版本,否则讲师不能发起。

2.课堂地址,根据业务场景不同,不同角色进入时,会显示不同的状态。例如当课程设置了回放内容,当讲师、嘉宾、助教进入后,看到的是未上课状态,学生、督课进入后,看到的则是回放内容。

3.通过接口获取的直播链接url必须使用https协议,嵌入的客户网页域名也必须使用https协议,否则将导致直播无法发起、获取不到摄像头等问题。

接口地址

http://api-class.e.vhall.com/api/class/live-url

请求参数

公共参数需要每次请求都附带上,详细内容请参考公共参数

参数名 类型 必选 说明
class_id string 课程ID
role_type string 角色类型 1:讲师;2:学员;3:助理;4:嘉宾;5:督课;
nick_name string 昵称(用户账户体系中的用户昵称)
custom_id string 自定义id(用户账户体系中的用户ID,同一个ID只能对应一个角色)
child_id int 子账户ID
terminal_type int 终端类型 1:网页;2:客户端(未传或为空时默认为网页)

响应参数

返回数据如下:

参数名 类型 说明
url string 课程链接地址
join_id string 对应微吼课堂的参会id

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
	   "url":"https://class.e.vhall.com/#/sClass/classID?auth_token=value",
	   "join_id":100
	}
}

错误码

code 含义
500 获取失败
10005 课程不存在
10006 custom_id不能为空
10013 昵称不能为空
10014 角色类型格式不正确
10017 小课堂的角色只有讲师,学员,督课 ,助理
10018 公开课的角色只有讲师,学员,助理,嘉宾,督课