实时互动-教育版 Web 及 H5 快速接入

这篇档将指导你如何通过服务端 API 创建课堂,并生成 Web 端访问链接以进入课堂。

相关产品
实时互动-教育版 产品页,含版本规格、价格与购买入口。

一、进入课堂

参考 接入准备 获取必要参数后,通过拼接 URL 即可访问互动课堂网页版。

请将获取到的参数替换至以下 URL 模板中(可参考 参数详解):

https://${请根据下述表格选用课堂站点域名}/latest/class.html?schoolid=${schoolid}&classid=${classid}&userid=${userid}&token=${token}

注意:请对 URL 中的参数值进行 encodeURIComponent 编码处理。

二、课堂站点域名

请根据用户所在地域及实际情况,选用一个合适的课堂站点域名,供用户访问。拼接到上述的课堂进房链接中。

域名 服务器地域 说明
class.qcloudclass.com 中国大陆(全球加速) 中国大陆用户及全球不确定位置用户选用。
www.tencentclass.com 新加坡(全球加速) 非中国大陆用户首选访问,海外主体独立域名且纯海外原生部署,性能优化,全球可用性高。

三、iframe 集成

如果你需要将课堂页面集成到 iframe 中,需要给 iframe 元素添加 allow 属性,以确保课堂页面可以正确获取到所需的浏览器权限。

<iframe allow="camera; microphone; fullscreen; display-capture; clipboard-read; clipboard-write; autoplay;" src="https://${请根据上方表格选用课堂站点域名}/latest/class.html?userid=12345&token=xxx">

四、核心鉴权参数(必填)

以下参数为进入课堂的必要条件,缺失将导致无法正常访问。

参数字段 类型 含义 说明
schoolid String 应用 ID 在 接入准备 中创建的应用 ID (SdkAppId)。
userid String 用户 ID 通过 RegisterUser 接口获取。
token String 鉴权 Token 通过 LoginUser 接口获取。
classid String 课堂 ID 通过 CreateRoom 接口获取。

五、基础配置参数(可选)

用于控制课堂的语言、角色及场景模式。

参数 类型 默认值 说明
lng String zh-CN 界面语言设置。支持值:zh-CN:中文简体zh-TW:中文繁体en-US:英语ja:日语ko:韩语ar:阿拉伯语vi:越南语id:印尼语
role String 空 进入课堂的角色。可选值:supervisor:巡课/内容审查(仅限已注册应用内 巡课用户)。
scene String default 场景名称,用于区分不同的定制布局,有两种配置方式:方式1:使用 SetAppCustomContent 接口配置。方式2:控制台 场景配置。

六、设备与行为控制(可选)

用于控制用户进入课堂时的设备状态及交互行为。

参数字段 类型 默认值 说明
micAutoOpen Number – 麦克风默认状态(仅对上台用户有效)。0:关闭1:开启
cameraAutoOpen Number – 摄像头默认状态(仅对上台用户有效)。0:关闭1:开启
location Boolean false 是否上报经纬度位置信息。
noEndClass Boolean false 若设置该参数(任意值),将隐藏「下课」,仅展示「离开」按钮。
back_url String 空 退出或返回课堂时的回调跳转地址。注意:该参数值必须使用 encodeURIComponent 进行 URL 编码。

七、UI 与布局定制(可选)

用于自定义课堂的视觉表现。

参数字段 类型 默认值 说明
layout String top 布局模式(仅SubType为videodoc时有效)。支持值:top:顶部布局(默认)double:双排布局right:右侧布局left:左侧布局three:三分布局
boardColor String #182E25 白板背景颜色。支持 Hex 格式或 rgba(0, 0, 0, .3) 格式。
debugjs String – 自定义 UI 的 JS 文件链接。本地开发时使用,仅支持 localhost。
debugcss String – 自定义 UI 的 CSS 文件链接。本地开发时使用,仅支持 localhost。
赞 (0)
上一篇 4天前
下一篇 4天前