伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. SDK文档
  • 历史课堂数据回调接入
  • 课堂出勤上下台数据回调通知接入
  • 签名示例
  • 历史课堂转视频接入方式
  • 历史课堂/微课下载接口
  • query参数说明
  • 文档解析接口
  • SDK预解析服务接入说明
  • 「伯索云学堂」跳转接入指南
  • SDK版本发布记录
  • 课堂业务事件数据统一回调通知接入(内部文档,暂未上线)
  • Web SDK
    • PlasoStyleUpime API说明
    • 云盘接入
    • 接入预解析能力 (Web端)
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • Electron SDK
    • 快速接入
  • Android SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • iOS SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • 播放器SDK
    • Web播放器
  1. SDK文档

课堂业务事件数据统一回调通知接入(内部文档,暂未上线)

回调接口是一个URL地址,通过HTTP/HTTPS协议访问,强烈建议使用HTTPS以增强安全性。 在回调接口开始开发前就可以约定好接口的URL发给伯索对接人进行配置。
联系伯索业务人员 zyjtool系统中完成配置。

 配置参数: liveEventCallBackUrl 
 填写 完整回调接口地址
当前支持的业务事件类型:
1.
课堂出勤上下台
2.
一键召回
3.
课堂缺勤通知
回调接口的返回结果请务必遵守以下约定:
正常返回
HTTP头的状态码为200
HTTP头的Content-Type值为"application/json;charset=utf-8"
HTTP消息体为json对象,标准格式为
{"code":0, "msg":""}
异常返回
HTTP头的状态码为200
HTTP头的Content-Type值为"application/json;charset=utf-8"
HTTP消息体为json对象,格式为:
{"code":404, "msg":"error reason"}
msg填入异常原因
2.
回调消息的返回结果如果不符合预期,比如HTTP头状态码为400,503等,将自动在24小时内以不断递增的时间间隔重试5次。 5次发送回调都不成功,回调将不再重试。
3.
伯索的回调数据使用Json格式,包装在Post Body中以Post方式发送, HTTP头的Content-Type值为"application/json;charset=utf-8"
回调基本数据格式
💡
安全签名信息:
appId : 在申请接入时,伯索平台给予的appId
validBegin: 发送方发送请求时的Unix Epoch 时间戳,单位秒
validTime: 取固定值1200,单位秒
signature: 按照 签名加密 提供的方法返回的签名字符串
📌
忽略安全签名信息,直接处理业务字段,也可以跑通业务流程。但是由于回调接口是暴露在公网上,为了防止欺诈攻击,在此强烈建议第三方的回调接口,对signature字段的签名进行强制认证:凡是签名不正确,或者当前 Unix Epoch 时间已超出validBegin + validTime有效期,都认为非法,返回400。
下面针对不同的事件类型做报文体的具体说明
事件基本数据格式
eventInfo: 字符串类型,消息主体
参考样例:
{
   "eventInfo": "{\"eventType\":\"attendance\",\"meetingId\":26225987,\"events\":{\"teacherId\":\"0_19035\",\"users\":[{\"eventTime\":1778125370654,\"eventType\":1,\"userId\":\"0_19035\"}]}}"
}
eventInfo 本质上是一个Json字符串。通常转换为对象后,会有三个固定的结构体。
eventType: 字符串,事件类型
meetingId: int类型,课堂Id
events: 数组,事件详细内容 (需要参考下面三个不同的事件类型,做区分)

一. 课堂出勤上下台事件 (eventType = "attendance")#

课堂开始后,一旦有成员加入/离开课堂,会触发出勤数据的回调。
1.
事件报文格式说明 ( events可以转换的结构体)
teacherId: 字符串类型,主讲老师的Id
users: 
[
  {
      "eventTime": int类型 时间时间戳,
      "eventType": int类型  事件类型 1:进入 2:离开,
      "userId": 字符串类型,学生/老师的用户Id值
  }
]
参考样例:
{
   "eventInfo": "{\"eventType\":\"attendance\",\"meetingId\":26225987,\"events\":{\"teacherId\":\"0_19035\",\"users\":[{\"eventTime\":1778125370654,\"eventType\":1,\"userId\":\"0_19035\"}]}}"
}

二. 一键召回事件 (eventType = "recall")#

课堂中选定部分人员,发起一键召回动作。
1.
事件报文格式说明 ( events可以转换的结构体)
teacherId: 字符串类型,主讲老师的Id
operatorId: 字符串类型,发起召回的用户Id
content: 字符串类型,发起召回的内容
students: 
[
  {
     "userId": 字符串类型,学生/老师的用户Id值
     "attendStatus": int类型, 是否出勤过 1:出勤过 2:未出勤过
   
  }
]
参考样例:
{
    "appId": "zk",
    "eventInfo": "{\"eventType\":\"recall\",\"meetingId\":26226039,\"events\":{\"teacherId\":\"0_19035\",\"operatorId\":\"19036\",\"content\":\"召回信息内容你好吗\",\"students\":[{\"userId\":\"10001\",\"attendStatus\":1},{\"userId\":\"10002\",\"attendStatus\":2}]}}"
}

三. 课堂缺勤事件 (eventType = "absence")#

直播开课之后,自动提醒离线学生,督促学生到课。
1.
事件报文格式说明 ( events可以转换的结构体)
teacherId: 字符串类型,主讲老师的Id
users: 
[
  {
      "groupId": int类型,课堂绑定班级id,
      "assistantIds": 数组, 助教用户Id值ids,
      "students": 数组 
      [
          {
             "userId": 字符串类型,学生的用户Id值
             "attendStatus": int类型, 是否出勤过 1:出勤过 2:未出勤
          }
        ]
  }
]
参考样例:
{
    "eventInfo":"{\"eventType\":\"absence\",\"meetingId\":26226072,\"events\":{\"teacherId\":\"0_19035\",\"users\":[{\"groupId\":1003104257,\"assistantIds\":[],\"students\":[{\"userId\":\"1_32662548\",\"attendStatus\":2},{\"userId\":\"1_32670490\",\"attendStatus\":1}]}]}}"
}
修改于 2026-05-13 01:57:39
上一页
SDK版本发布记录
下一页
PlasoStyleUpime API说明
Built with