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

历史课堂转视频与下载

本文面向服务端开发,说明如何把历史课堂或微课导出为普通视频文件,以及如何查询任务和接收结果回调。

1. 使用前确认#

转视频/下载可能产生额外转录费用。
如果历史课堂中包含预解析课件,提交任务时需要提供可播放的历史课堂地址。
视频保存到OSS,当前只支持传入长期 AccessKey(ossAKey / ossSKey),暂不支持 STS 临时凭证。建议使用仅对目标 Bucket 有写权限的专用密钥,不要使用账号主密钥。

2. 整体架构#

转视频是一个异步任务:客户业务服务端创建任务后,伯索转视频服务在后台完成转码,并将视频上传到客户 OSS。任务结果通过回调通知,或由客户业务服务端主动查询。两种方式应统一按 taskId 幂等更新任务状态。
关键约定:
创建任务和查询任务均由客户业务服务端调用,避免在客户端暴露签名凭证。
status=99 是成功终态;-1、-2、-3 分别表示转码、上传、回调失败。
回调可能重复或延迟,客户业务服务端必须以 taskId 为幂等键;成功终态不能被迟到的处理中状态覆盖,重复成功回调也不能重复触发下载、计费或消息等下游动作。回调未到达时,可调用查询任务接口补偿。
本地状态只接受本文列出的 0/1/2/3/99/-1/-2/-3,未知状态应保留原状态并告警;成功终态不得回退到处理中状态。-1、-2 视为转码、上传失败终态,-3 仅表示回调投递失败,应查询任务并核对 OSS 对象后再确定业务最终状态。
建议客户 OSS Bucket 保持私有。用户播放或下载时,由业务服务端鉴权后签发有有效期、最小权限的 URL,不直接暴露 OSS 长期凭证。

3. 创建转视频任务#

参数类型必填说明
fileNamestring是目标文件名称
recordIdstring是历史课堂 ID
recordUrlstring否历史课堂播放地址;含预解析课件时必须提供
convertModenumber否1 仅头像,2 仅白板,3 仅音频,10 白板+大头像,20 头像+白板
resolutionstring否720P 或 1080P
videoBitratenumber否视频码率,500-8000 kbps
audioBitratenumber否音频码率,64-320 kbps
frameRatenumber否视频帧率,15-60 fps
返回:
字段说明
code0 成功,其他为失败
obj.taskId任务 ID
常见错误码:
错误码说明
0执行成功
22001存在进行中的任务
22003课堂不存在

4. 查询任务#

参数类型必填说明
taskIdstring是任务 ID
任务状态:
值说明
0等待
1开始执行
2开始上传
3开始回调
99成功
-1转码失败
-2上传失败
-3回调失败

5. 结果回调#

参数类型说明
taskIdstring转视频任务 ID
statusnumber99 成功,负数为失败
locationstring成功时的视频路径
回调接收方应幂等处理,并返回:
{
  "code": 0,
  "message": ""
}
回调失败后会重试,最多 5 次,间隔 1 分钟;实际投递策略以联调环境确认为准。

6. OSS 配置参数#

当需要将视频存储至客户自有 OSS 时,需要提供以下配置。当前仅支持长期 AccessKey(ossAKey / ossSKey),暂不支持 STS 临时凭证;建议使用仅对目标 Bucket 有写权限的专用密钥,不要使用账号主密钥。
参数类型必填说明
ossAKeystring是OSS AccessKey,需要对目标 Bucket 有写权限;当前不支持 STS
ossSKeystring是OSS SecretKey
bucketstring是Bucket 名称
regionstring是OSS 区域,如 oss-cn-shanghai
pathstring是视频保存目录
callbackUrlstring是转码事件回调 URL
示例:
{
  "ossAKey": "xxx",
  "ossSKey": "xxx",
  "bucket": "xxx",
  "region": "oss-cn-shanghai",
  "path": "dir",
  "callbackUrl": "https://example.com/callback"
}
修改于 2026-11-17 07:40:26
上一页
课堂结束数据回调
Built with