伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. SDK接入文档
  • 产品介绍
    • SDK简介
    • SDK支持的业务场景
    • 产品特色
  • 产品功能
    • 实时课堂功能介绍
    • 微课功能介绍
    • 作业批改功能介绍
    • 上传课件功能介绍
    • SDK后台功能介绍
  • 接入指引
    • SDK对接标准流程说明
    • 关键概念
  • SDK接入文档
    • 历史课堂数据回调接入
    • 签名示例
    • 历史课堂转视频接入方式
    • 历史课堂/微课下载接口
    • query参数说明
    • Web SDK
      • PlasoStyleUpime API说明
      • 云盘接入
      • 直播SDK
        • 快速接入
      • 微课SDK
        • 快速接入
      • 批注SDK
        • 快速接入
    • Android SDK
      • 直播SDK
        • 快速接入
      • 微课SDK
        • 快速接入
      • 批注SDK
        • 快速接入
    • iOS SDK
      • 直播SDK
        • 快速接入
      • 微课SDK
        • 快速接入
      • 批注SDK
        • 快速接入
    • 播放器SDK
      • Web播放器
    • 「伯索云学堂」跳转接入指南
      • 跳转接入指南
  • 最佳实践
  • Open API帮助文档
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户信息管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
    • 教材包管理
      • 查询机构教材包
      • 查询教材包内教材
      • 向学生分发教材包
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. SDK接入文档

query参数说明

名称类型是否必填说明
appIdstring是在申请接入时,伯索平台给予的appId
appTypestring否应用类型,使用WebSDK时为必填项,固定值为liveclassSDK
validBeginnumber是签名query的起始时间,Unix Epoch 时间戳,单位为秒
validTimenumber是签名query的有效期,从validBegin开始计算,单位为秒
mediaTypestring是媒体类型,取值:
  • audio: 音频课堂
  • video: 视频课堂
meetingTypestring是课堂类型,固定值为public
meetingIdstring是课堂ID,唯一标识该课堂;使用ASSIIC字符,不得包含/,,空格等;长度在40字节以内的字符串。
userTypestring是用户角色类型,取值:
  • speaker: 课堂的主讲者,有控制其他listener是否可板书/发言的权限。课堂中只能有一个主讲
  • assistant:助教,辅助主讲授课的角色,在课堂中的权限与主讲基本一致。课堂中可以有多个助教
  • listener:听众,可以理解为学生
loginNamestring是唯一标识该用户的id,不能为空,相同的loginName进入课堂时,后面进入的会使前面进入的登出
d_dimensionstring是固定值为1280x720,定义界面尺寸为16:9 界面
userNamestring是用户昵称,头像缺省时会显示
topicstring否课堂名称
endTimestring否课堂结束时间,格式为 Unix Epoch 时间戳,单位为秒
recordTimestring否课堂开始录制的时间;如果不填,则进入课堂后立即开始录制;格式为 Unix Epoch 时间戳,单位为秒
onlineModenumber否当mediaType为video时生效,表示最大能开启的listener的摄像头的个数。默认值为6,取值:
  • 1
  • 6
  • 12
d_sharpnessnumber否当mediaType为video时生效,表示摄像头画面的清晰度。默认值为10,取值:
  • 10: 360p
  • 20: 720p
  • 30: 1080p
d_switchnumber否该字段使用二进制标志位,0号位为1表示解除禁言,学生可以在聊天区交流;1号位为1,表示学生开启成员列表功能,学生可以在工具栏中打开成员列表。最终传入10进制的值,比如二进制11最终传入3。不传默认是全部开启的状态。
enableNewClassExamnumber否是否启用新版随堂测,默认不启用。取值:
  • 0: 不启用
  • 1: 启用
d_enableObjectErasernumber否是否启用新版板书,新版板书的橡皮擦支持对象擦除,默认不启用,传入大于0的值启用新版板书。取值:
  • 0: 不启用,橡皮功能为点擦
  • 1: 支持对象擦除手写
  • 3: 支持对象擦除手写+文本
  • 5: 支持对象擦除手写+图形
  • 7: 支持对象擦除手写+文本+图形
修改于 2025-08-20 06:21:47
上一页
历史课堂/微课下载接口
下一页
PlasoStyleUpime API说明
Built with