伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. 服务端接口与协议
  • SDK 接入总览
  • 实时课堂
    • Android 实时课堂接入
    • Harmony 实时课堂接入
    • iOS 实时课堂接入
    • Electron 实时课堂接入
    • Web 实时课堂监课接入
  • 极速课堂
    • Android 极速课堂接入
    • Harmony 极速课堂接入
    • iOS 极速课堂接入
    • Electron 极速课堂接入
  • 微课
    • Android 微课接入
    • Harmony 微课接入
    • iOS 微课接入
    • Electron 微课接入
  • 资料中心
    • Android 资料中心接入
    • Harmony 资料中心接入
    • iOS 资料中心接入
    • Electron 资料中心接入
    • Web 资料中心接入
  • 文件预解析
    • Android 文件预解析接入
    • Harmony 文件预解析
    • iOS 文件预解析接入
    • Electron 文件预解析接入
  • 历史课堂回放
    • Android 历史课堂回放
    • Harmony 历史课堂回放
    • iOS 历史课堂回放
    • Electron 历史课堂回放
    • 播放器
      • 播放器 SDK 概述
      • 播放器 SDK 快速开始
      • 播放器 SDK 初始化与配置
      • 播放器 SDK 历史课堂回放
      • 播放器 SDK 移动端 WebView 嵌入
      • 播放器 SDK API 参考
      • 播放器 SDK 事件
      • 播放器 SDK 错误码
      • 播放器 SDK 常见问题
  • 云学堂模块化SDK
    • 云学堂模块化 SDK 概述
    • 云学堂模块化 SDK · Android 接入
    • 云学堂模块化 SDK · iOS 接入
    • 云学堂模块化 SDK · Harmony 接入
    • 云学堂模块化 SDK · PC 接入
    • 伯索云学堂跳转接入
  • 接入基础(Electron & Web)
    • Web
      • Web 概述
      • Web 快速开始:URL 接入监课
      • Web 初始化与配置(监课)
      • Web API 参考(监课)
      • Web 事件与回调(监课)
      • Web 错误码(监课)
      • Web 常见问题(监课)
    • Electron
      • Electron 概述
      • Electron 快速开始
      • Electron 初始化与配置
      • Electron API 参考
      • Electron 事件与回调
      • Electron 错误码
      • Electron 常见问题
  • 服务端接口与协议
    • 服务端接口与协议阅读顺序
    • 签名与鉴权
    • 签名示例
    • query 参数
    • 资料中心与文件 URL
    • 文档预解析
    • 课堂进行中数据回调
    • 课堂结束数据回调
    • 历史课堂转视频与下载
  1. 服务端接口与协议

query 参数

本文是课堂和播放器 query 参数的权威表。各端文档只保留最小必填参数和本端示例。

1. 实时课堂 query#

参数类型必填说明
appIdstring是伯索分配的应用标识
appTypestring是实时课堂固定为 liveclassSDK(各端均必填,含 Android / iOS / Harmony / Electron / Web)
validBeginnumber是签名生效时间,Unix 秒级时间戳
validTimenumber是query 有效期,单位秒
signaturestring是签名值
mediaTypestring是audio 或 video
meetingTypestring是通常为 public;如使用会议模式,按 SDK 能力约定
meetingIdstring是课堂 ID,建议只使用 ASCII 字符,不包含 /、\、空格,长度不超过 40 字节
userTypestring是speaker、assistant、listener、monitor
loginNamestring是用户唯一 ID;同一 loginName 重复进入会顶掉前一个登录
userNamestring是用户昵称
d_dimensionstring是固定 1280x720
topicstring否课堂名称
endTimenumber否课堂结束时间,Unix 秒级时间戳,不传默认5小时后结束
recordTimenumber否开始录制时间,Unix 秒级时间戳
onlineModenumber否视频课堂中 listener 可开摄像头数量,如 1、6、12 默认6
d_sharpnessnumber否清晰度:10 为 360p,20 为 720p,30 为 1080p
d_switchnumber否功能开关位,按二进制标志位换算为十进制
enableNewClassExamnumber否新版随堂测题型:0 不支持(沿用老版随堂测)、1 选择题、2 填空题、3 选择题+填空题(建议传 3)
d_enableObjectErasernumber否是否启用新版板书(橡皮擦支持对象擦除);默认不启用,传入大于 0 的值启用。取值:0 不启用(点擦),1 对象擦除手写,3 手写+文本,5 手写+图形,7 手写+文本+图形
showHisChatMsgnumber否历史课堂是否记录消息,0 否,1 是
d_lowLatencyClassnumber极速课堂必填固定传 1,标识以极速课堂模式进入;与其他参数一样参与签名。示例见 极速课堂/Electron

1.1 常见扩展参数#

参数类型必填说明
d_delayEndTimesnumber否单节课最大延时下课次数,默认1,如果小于等于0则会被重置为1
d_delayEndnumber否单次延时时间,单位秒,常见值 300,600等
d_enableAvatarFreeScalenumber否是否开启头像任意比例缩放,0 关闭,1 开启
d_voteStarAwardnumber否投票积分,默认0
isNewMTnumber否是否支持移动授课模式,建议传 1
recordAvatorstring否传入老师或助教的 loginName 表示录制对应人的头像
recordScreenstring否传入 screen 表示录制屏幕
d_enableReRecordingnumber否是否允许重新录制,0 不允许,1 老师,2 助教,3 老师和助教 默认允许老师与助教重新录制
d_restrictAssistantPermnumber否是否限制助教权限,0 否,1 是

1.2 用户角色说明#

角色说明
speaker主讲老师,一堂课堂通常只能有一个主讲
assistant助教,辅助主讲授课,权限与主讲基本一致,可有多个
listener听众,通常对应学生
monitor监课,旁观课堂,不出现在成员列表中、不参与课堂互动;Web SDK 仅支持该角色

2. 播放器 query#

参数类型必填说明
appIdstring是伯索分配的应用标识
appTypestring是播放器固定为 player
validBeginnumber是签名生效时间,Unix 秒级时间戳
validTimenumber是query 有效期,单位秒
signaturestring是签名值
recordIdstring是历史课堂 ID
showTypenumber否播放器展示类型:1 仅头像,2 仅白板,40 头像+白板
avatarHeightnumber否showType=40 时生效,头像高度,最小 90

3. query 组装建议#

1.
服务端按《签名与鉴权》完成签名。对照结果见《签名示例》。
2.
将所有参数按业务需要组装为 query string。
3.
query string 中的值使用 URL 编码。
4.
客户端不要修改已签名参数,否则可能导致验签失败。
修改于 2026-11-17 07:47:57
上一页
签名示例
下一页
资料中心与文件 URL
Built with