伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. 服务端接口与协议
  • 产品介绍
    • SDK简介
    • SDK支持的业务场景
    • 产品特色
  • 产品功能
    • 实时课堂功能介绍
    • 微课功能介绍
    • 上传课件功能介绍
    • SDK后台功能介绍
  • 接入指引
    • SDK对接标准流程说明
    • 关键概念
  • SDK接入
    • 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
      • 文档预解析
      • 课堂进行中数据回调
      • 课堂结束数据回调
      • 历史课堂转视频与下载
  • Open API
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
      • 恢复删除的用户
      • 设置学生属性(是否跟随/是否加联/分配课程顾问)
      • 学生随机分配课程顾问(V2)
      • 根据ids,批量查询用户
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
      • 批量绑定老师到班级
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 查询课堂下历史课堂信息
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
      • 获取课堂中引用的课件列表
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
      • 获取学生课程统计数据
      • 获取学生课程详情统计数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
    • 积分管理
      • 机构积分规则
      • 查下学生当前积分数
      • 查下机构每天的积分明细记录
    • 课程顾问
      • 新建课程顾问
      • 编辑课程顾问
      • 查询课程顾问
      • 停用/启用课程顾问
      • 更新课程顾问密码
    • 课程管理
      • 创建课程
      • 单次创建直播/实时课堂
      • 查询课程列表
      • 新增课程下发学生
      • 删除课程下发学生
      • 查询课程下发学生列表
      • 下发课程到班级
      • 移除课程班级绑定
      • 查询课程绑定班级IDs
      • 查询课程任务列表
      • 更新课程
      • 查询课程学生
      • 查询学生作业
      • 查询订单详情
    • 校区管理
      • 创建校区
      • 编辑校区
      • 关闭校区
    • 事件推送
      • 事件推送机制
      • 事件推送接入指南
    • 其他接口
      • 三方系统唤起客户端上课方案说明
      • 唤起客户端URL
    • 资源管理
      • 老师资料上传凭证
      • 创建老师资料目录
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐配置
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. 服务端接口与协议

课堂结束数据回调

伯索云学堂各功能调用时间往往很长:一堂实时在线课从创建到结束可能十几分钟到数小时不等。课堂结束后的关键返回数据,通过异步回调投递是推荐方案。
本文定义实时课堂结束后的课后数据回调。它与播放器 SDK、转视频/下载的关系如下:
播放历史课堂:通常需要从回调数据或业务系统中获得 recordId。
导出 MP4 或下载:使用《历史课堂转视频与下载》。
如果课堂中以 info 方式插入过自有资料或预解析资源,播放历史课堂时仍需实现资源 URL 回调;以 url 方式插入的资源无需回调。

1. 配置#

由伯索侧配置,客户不在进房 query 里传递。需要开通时联系伯索对接同事,提供公网可访问的 HTTPS 地址(建议不要携带 query 参数)。开发前约定好 URL 即可发给对接人完成平台侧配置。
本文对应的机构配置字段为 liveCallBackUrl:课堂结束时推送课堂数据(含互动、举手连麦、答题等课后汇总)。
字段类型说明示例
liveCallBackUrlstring课堂数据回调地址。未配置则不推送课后汇总https://xxxxx/meetingEndCallback
伯索以 POST 投递到该地址;请求体为 JSON,HTTP 头 Content-Type 为 application/json;charset=utf-8。报文、验签与字段见下文。

2. 响应约定#

客户回调接口的返回结果须遵守:
场景HTTP 状态Content-TypeBody
接收成功200application/json;charset=utf-8{"code":0,"msg":""}
业务拒绝且不希望按「临时失败」语义重试200application/json;charset=utf-8{"code":非0,"msg":"原因"}(msg 填异常原因)
临时失败、超时、服务不可用非 2xx 或无响应-触发重试
验签失败400-不应处理业务
重试策略(以原始对接约定为准):
回调响应不符合预期(例如 HTTP 状态为 400、503 等)时,伯索会在 24 小时内以不断递增的时间间隔重试最多 5 次。
5 次仍不成功,则不再重试。
若联调环境与上表不一致,以双方确认为准并回填本文。

3. 安全字段#

字段说明
appId申请接入时伯索平台分配的 appId
validBegin发送方发送请求时的 Unix Epoch 时间戳,单位秒
validTime有效期,固定 1200,单位秒
signature按《签名与鉴权》生成的签名字符串
回调接口暴露在公网。忽略安全字段直接处理业务也能跑通流程,但为防止欺诈攻击,强烈建议强制验签:
签名不正确,或
当前 Unix Epoch 时间已超出 validBegin + validTime
均视为非法,返回 400,不处理业务。

4. 主要业务字段#

字段说明
meetingId客户自行生成的课堂/会议唯一 ID
meetingType会议类型
appId机构 id
mediaType媒体类型
recordId本段历史课堂 id;一堂课可能因中断等原因生成多段历史课堂
duration课堂计时时长,单位秒。若中途重新录制,只保留之后的时长
recordDuration从开始录制到结束的完整计时时长,单位秒。重新录制不会截断这段时长
userCount课堂总共人数
listenerCount参与的听众数,即学生人数
speakerCount主讲人数(样例中会出现)
cover课堂封面地址;若以 /file-plaso/ 开头,将 /file-plaso/ 替换为 https://file.plaso.cn/ 即为完整封面下载路径
userCS所有用户在线总秒数(不包括主讲老师)
teacherCS老师/助教在线总秒数(含主讲老师在线总秒数)
speakerShareTime桌面共享累计时长,单位秒
listenerShareTime所有学生接收桌面共享的总时长,单位秒
beginTime课堂开始的 Unix Epoch 时间戳,单位毫秒;从第一个人进入课堂开始计时
endTime课堂结束的 Unix Epoch 时间戳,单位毫秒
recordBegin开始录制的 Unix Epoch 时间戳,单位毫秒
statistics课堂参与者信息数组
test随堂测题目数组;每题形如 [[答案], 老师给予答题时长]
chatMsg聊天消息列表;仅在 showHisChatMsg=1(开启历史课堂消息)且存在消息时返回
refFiles课堂关联文件
topic课堂主题
hasMedia是否有媒体
fileSize历史课堂文件大小
fileLocation文件位置
样例中还可能出现、业务可按需忽略的扩展字段:callback、dirname、recordAvator、videoStream、richMedia、attachment、saved、_id 等。

5. 参与者字段#

statistics 中每个元素表示一个课堂参与者:
字段说明
id课堂参与者 id
uniqueId参与者唯一 ID
name用户唯一名,即进入课堂时传入的 loginName
roleType角色,如 speaker、assistant、listener
logCount登录次数
testStar随堂测分数
awardStar课堂老师主动奖励的分数
answers答题明细;形如 [[[选项1, 选项2], 答题时长(秒)], [[选项1], 答题时长(秒)], ...]
answerDuration答题总时长,秒
handUpCount举手次数
joinClassTime第一次进入课堂的时间,毫秒
leaveClassTime主动离开课堂的时间,毫秒
redPacketStar红包雨积分
OpenCameraCount开摄像头次数
onlineDuration在线时长,秒
onstageDuration上台时长,秒
faceDuration摄像头露脸时长,秒
resource客户端环境信息
mediaConnectionDelay媒体连接耗时
样例中还可能出现、业务可按需忽略的扩展字段:crowd、nHeatBeat、autoOut、socketClose、seq、prefix、isSpeaker、online、addr、agoraUid、idInMedia、shareStreamTimer 等。

6. 聊天消息格式#

开启 showHisChatMsg=1 且存在历史消息时,chatMsg 中每条消息为:
[消息id, 发送人loginName, [内容类型, 消息内容], [消息类型, 私聊对象], 发送人姓名, 播放器相对时间(毫秒), 发送消息的Unix毫秒时间戳, 发送人角色]
示例:
[1, "0_1701661", [0, "消息测试"], [0], "xxxx", 27567, 1765348085904, "speaker"]
内容类型:
值说明
0文字
1图片消息
消息类型:
值说明
0普通消息
1私聊

7. 参考样例#

{
  "validBegin": 1596876202,
  "validTime": 1200,
  "signature": "1AC85CB317DADA4864FFF213AE86BB086AE5A13B",
  "meetingId": "sfas-da55-ddf-fdfdf-dfdfdfdf",
  "meetingType": "public",
  "appId": "some_id",
  "callback": "https://dear.client.com/callback",
  "mediaType": "video",
  "duration": 7841,
  "recordDuration": 7801,
  "userCount": 27,
  "listenerCount": 26,
  "speakerCount": 1,
  "userCS": 1212,
  "teacherCS": 7849,
  "speakerShareTime": 758,
  "listenerShareTime": 18069,
  "beginTime": 1594511352501,
  "endTime": 1594519202002,
  "recordBegin": 1594511360631,
  "dirname": "/some/dir",
  "recordAvator": "sfdf-ddfd-fffg-223-df34",
  "videoStream": 3,
  "richMedia": true,
  "cover": null,
  "statistics": [
    {
      "id": "sfdf-ddfd-fffg-223-df34",
      "crowd": 1,
      "logCount": 2,
      "nHeatBeat": 0,
      "autoOut": 0,
      "socketClose": 0,
      "seq": 1,
      "prefix": 100000,
      "testStar": 0,
      "awardStar": 0,
      "answerDuration": 0,
      "uniqueId": "sfdf-ddfd-fffg-223-df34",
      "handUpCount": 0,
      "joinClassTime": 1594511352502,
      "leaveClassTime": 1594519202000,
      "roleType": "speaker",
      "name": "张三",
      "isSpeaker": true,
      "online": false,
      "addr": "::ffff:121.28.85.34:53699",
      "resource": "Chrome 83.0.4103.106(pc)",
      "mediaConnectionDelay": 601,
      "agoraUid": 12,
      "idInMedia": 12,
      "shareStreamTimer": {"__total": 758783, "__paused": true, "__begin": 1594514989684},
      "onstageDuration": 7849,
      "onlineDuration": 7849,
      "faceDuration": 7340
    },
    {
      "id": "dfddf-7445-41-dfdf-agdgdgd",
      "crowd": 1,
      "logCount": 6,
      "nHeatBeat": 0,
      "autoOut": 0,
      "socketClose": 4,
      "seq": 2,
      "prefix": 200000,
      "testStar": 0,
      "awardStar": 1,
      "answers": [],
      "answerDuration": 0,
      "uniqueId": "dfddf-7445-41-dfdf-agdgdgd",
      "handUpCount": 0,
      "joinClassTime": 1594511718775,
      "leaveClassTime": 1594519202002,
      "roleType": "listener",
      "name": "李四",
      "online": false,
      "addr": "::ffff:183.198.133.159:3609",
      "resource": "OPPO 5.1(android)",
      "mediaConnectionDelay": 190,
      "agoraUid": 13,
      "idInMedia": 13,
      "shareStreamTimer": {"__total": 758783, "__paused": true, "__begin": 1594514989684},
      "onstageDuration": 282,
      "onlineDuration": 7414,
      "faceDuration": 281
    }
  ],
  "refFiles": [],
  "attachment": 1,
  "recordId": "5fsd4dd8db81a25a44200643",
  "saved": true,
  "topic": "数学精讲",
  "hasMedia": true,
  "fileSize": 304793833,
  "fileLocation": "/some/location",
  "_id": "sfsffwefwfwsfsdfsdf"
}

8. 幂等要求#

客户服务端应以 recordId 或 meetingId + recordId 做幂等键。重复回调只更新同一条记录,不重复计费、不重复触发下游任务。
修改于 2026-11-18 03:45:56
上一页
课堂进行中数据回调
下一页
历史课堂转视频与下载
Built with