伯索开放平台
首页
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. 服务端接口与协议

课堂进行中数据回调

本文说明机构配置里的两个回调:课堂延时/提前结束回调和课堂出勤回调。二者都是伯索服务主动 POST 到客户公网地址。
回调什么时候到用来做什么
课堂延时/提前结束回调老师延时课堂,或老师提前结束课堂把新的结束时间同步到客户业务系统
课堂出勤回调本段课堂第一次开始录制后,再等待伯索人员配置的出勤回调时间推送当时已进入课堂的人员名单
到点自动结束(计时器走到预定结束时间)不会调用课堂延时/提前结束回调。

1. 配置#

由伯索侧配置,客户不在进房 query 里传递。需要开通时联系伯索对接同事,提供公网可访问的 HTTPS 地址。地址不要携带 query 参数。
字段类型说明
liveStatusCallBackUrlstring课堂延时/提前结束回调地址。未配置则不推送
orgArrivalAddrstring课堂出勤回调地址。空字符串不推送
orgDelaynumber课堂出勤回调的等待时长,单位毫秒。由伯索人员按机构设置,客户不能在进房参数里指定。0 表示录制一开始就推送。例如 600000 表示 10 分钟

2. 课堂延时/提前结束回调#

配置字段为 liveStatusCallBackUrl。课堂服务在老师延时课堂或老师提前结束课堂时调用该地址。
场景是否回调newEndTime
老师延时课堂是有。新的结束时间,Unix 毫秒时间戳,JSON 里是字符串
老师提前结束课堂是无。请求体里不出现该字段
到达预定结束时间自动下课否—
appId 为伯索内部机构否走内部排课,不回调客户地址
投递约定:
约定说明
方法POST
Content-Typeapplication/json
超时3 秒
重试失败只记日志,不重试
成功判定HTTP 2xx。响应体不参与判定
因为没有重试,接收方应尽快返回 2xx,并按 id + opTime 做幂等。漏一次回调时,以客户自己的排课结束时间为准。

2.1 请求体#

字段类型必填说明
appIdstring是机构 appId
idstring是课堂 ID,即进房时的 meetingId
opTimestring是本次操作时间,Unix 毫秒时间戳
newEndTimestring延时课堂时有新的课堂结束时间,Unix 毫秒时间戳。提前结束课堂时没有此字段
validBeginnumber是签名生效时间,Unix 秒
beginTimenumber是与 validBegin 相同,Unix 秒。它不是课堂开始时间
validTimenumber是固定 300,单位秒
signaturestring是用机构 signKey 做 HMAC-SHA1,40 位大写十六进制
签名规则与《签名与鉴权》相同:去掉 signature,跳过未出现的字段,参数名按 UTF-8 字节升序,拼成 key=value&key=value,用 signKey 做 HMAC-SHA1,输出大写十六进制。数字按十进制原文参与计算,不要加引号,也不要做 URL 编码。
延时课堂时待签名内容示例(密钥 demoSignKey):
appId=demo&beginTime=1763395200&id=20261117001&newEndTime=1763398800000&opTime=1763395300123&validBegin=1763395200&validTime=300
提前结束课堂时没有 newEndTime:
appId=demo&beginTime=1763396400&id=20261117001&opTime=1763396400456&validBegin=1763396400&validTime=300

2.2 报文示例#

延时课堂:
{
  "appId": "demo",
  "validBegin": 1763395200,
  "beginTime": 1763395200,
  "validTime": 300,
  "newEndTime": "1763398800000",
  "opTime": "1763395300123",
  "id": "20261117001",
  "signature": "DC2CA2A2AC288790AE503DF5E8323BA2B5EF9958"
}
老师提前结束课堂:
{
  "appId": "demo",
  "validBegin": 1763396400,
  "beginTime": 1763396400,
  "validTime": 300,
  "opTime": "1763396400456",
  "id": "20261117001",
  "signature": "2422740002EA46D620619AA8752A332F9F29A24F"
}
收到延时课堂报文后,把该 meetingId 的结束时间更新为 newEndTime。收到没有 newEndTime 的报文后,把课堂标记为老师已提前结束,结束时间取 opTime。同一 id + opTime 重复到达时只更新一次。

3. 课堂出勤回调#

配置字段为 orgArrivalAddr。推送时机不由客户在进房参数里指定。录制开始后等待多久,由伯索人员在机构配置里设置延时时间。需要开通或调整这个等待时长时,联系伯索对接同事。未配置 orgArrivalAddr 则不会推送。
流程:
1.
第一次开始录制。常见起点是主讲或需要录制的成员打开音视频,或开始桌面共享等独立录制。
2.
等待伯索人员配置的 orgDelay 毫秒。0 表示录制一开始就推送。
3.
取当时已经进入过本段课堂的成员(含已经离开的人),POST 到课堂出勤回调地址。
4.
HTTP 失败时,5 秒后再试一次。第二次仍失败则放弃。
5.
HTTP 成功即视为投递成功,不解析响应体。
这次回调不带签名。地址必须只对伯索出口开放,或由业务侧用 meetingId 归属和来源网络做校验。不要把这个接口做成可被任意公网调用的写接口。

3.1 请求体#

字段类型说明
meetingIdstring客户侧课堂 ID
recordIdstring本段录制 ID。一堂课中断后可能产生多段
statisticsarray延迟时刻已经进入过课堂的成员
statistics 每个元素:
字段类型说明
loginNamestring进房时的用户 ID
userNamestring显示名
roleTypestring角色,见下表
joinClassTimenumber第一次进入本段课堂的时间,Unix 毫秒
roleType 常见取值:
值角色
speaker主讲
assistant助教
listener学生
visitor访客
monitor监课
名单是延迟时刻的快照。之后进入的人不会再通过这个地址补推。

3.2 报文示例#

伯索人员把延时汇报出勤情况设为 600000 时,录制开始 10 分钟后推送:
{
  "meetingId": "20261117001",
  "recordId": "6740a1b2c3d4e5f678901234",
  "statistics": [
    {
      "loginName": "t1",
      "userName": "老师1",
      "roleType": "speaker",
      "joinClassTime": 1763391000123
    },
    {
      "loginName": "s1",
      "userName": "学生1",
      "roleType": "listener",
      "joinClassTime": 1763391060456
    }
  ]
}
接收方按 meetingId + recordId 幂等保存。重复报文覆盖同一条出勤记录,不要重复开课、重复计费。

4. Demo#

下面是一个可运行的 Node.js 接收服务。课堂延时/提前结束回调指向 /class-end-time,课堂出勤回调指向 /arrival。密钥只放在服务端。
本地核对延时课堂签名:
输出应为:
appId=demo&beginTime=1763395200&id=20261117001&newEndTime=1763398800000&opTime=1763395300123&validBegin=1763395200&validTime=300
DC2CA2A2AC288790AE503DF5E8323BA2B5EF9958
联调时把机构配置指到上述两个路径,分别做一次延时课堂、一次老师提前结束课堂、一次开麦录制并等待 orgDelay,确认三条报文的字段和签名与本文一致。
修改于 2026-11-18 03:49:18
上一页
文档预解析
下一页
课堂结束数据回调
Built with