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

文档预解析

本文定义 PPT、PDF、Word、Excel 等文档预解析的服务端接口、回调和 SDK 加载协议。

1. 何时需要预解析#

当课堂需要高效展示 PPT/PDF/Word/Excel 等课件,并希望 SDK 按页加载图片、HTML、JSON 等解析产物时,需要接入预解析。
预解析不是单纯的客户端能力,它需要服务端、对象存储和客户端 SDK 配合。

2. 端到端流程#

1.
客户端把原文件上传到客户文件服务。
2.
客户文件服务把原文件保存到 OSS,并记录文件 ID。
3.
客户文件服务调用伯索文档解析接口创建解析任务。
4.
伯索解析服务异步生成解析产物,并回调客户文件服务。
5.
客户文件服务保存 taskId、targetPath、页数和解析状态。
6.
客户端在课堂中插入预解析资源,传入文件标识和页数。
7.
SDK 按需回调 getPreParseFileName / onGetPreParseFileNameFn,携带 info 和 suffix。
8.
客户端向客户文件服务请求指定 suffix 的短时签名 URL。
9.
SDK 使用该 URL 加载解析产物。
下图给出预解析总体方案架构:
预解析方案
端到端时序(sequenceDiagram)
客户端 Demo 参考流程(文档解析)

3. 创建解析任务#

参数类型必填说明
appIdstring是应用 ID
sourcePathstring是原文件 OSS 路径,如 oss://bucket/path/file.pptx
taskTypenumber是任务类型
callbackUrlstring是解析结果回调地址
validBeginnumber是Unix 秒级时间戳
validTimenumber是有效期,建议 300 秒
signaturestring是签名
exportBoardboolean否是否生成导出板书所需文件
任务类型:
值类型
4PPT
5Word/Excel
8PDF

3.1 响应#

成功响应:
{
  "code": 0,
  "msg": "success",
  "obj": {
    "taskId": "task-id"
  }
}
失败响应:
{
  "code": 1001,
  "msg": "源文件路径不存在"
}

3.2 OSS 权限建议#

文档解析涉及原文件读取和解析产物写入。建议使用最小权限或临时凭证:
场景权限
读取源文件GetObject
写入解析产物PutObject
列出解析产物ListObjects
导出板书读取解析信息GetObject、ListObjects
如需设置 ACL,应明确仅限解析产物目录,避免给整个 Bucket 过宽权限。

4. 解析结果回调#

解析完成后,伯索服务调用创建任务时传入的 callbackUrl。
参数类型必填说明
taskIdstring是解析任务 ID
taskStatusnumber是100 成功,101 失败
targetPathstring成功时必填解析产物目录
convertPagesnumber部分类型成功时返回转换页数
客户服务端应按 taskId 幂等更新任务状态。重复回调不能产生重复业务副作用。

4.1 回调重试#

解析完成回调的重试策略如下:
首次回调失败后等待 5 秒重试;
最多重试 3 次;
重试间隔递增:5 秒、10 秒、20 秒;
3 次仍失败后任务标记为回调失败。
重试条件通常包括:
HTTP 状态码 >= 500;
网络超时;
连接失败。
HTTP 4xx 是否重试应以当前服务端实现和联调结果为准。

5. 解析产物 URL 签发#

SDK 回调时会传入 suffix,例如:
/index.html
/ispring.html
/info.json
/1.jpg
/2.jpg
/1.jpg?x-oss-process=...
服务端应根据文件记录找到解析产物目录,再结合 suffix 生成短时 URL。
安全要求:
suffix 必须做规范化和白名单校验。
不允许 ../、反斜杠、绝对路径、空路径。
查询参数只允许受控的 OSS 图片处理参数。
拼接后的 Object Key 必须仍位于该文件的解析产物目录下。
签发 URL 时建议使用短有效期。

6. SDK 回调契约#

平台回调
AndroidgetPreParseFileName(info, suffix, callback)
iOSgetPreParseFileName info, suffix, result
ElectrononGetPreParseFileNameFn(info, { suffix })
播放器 SDKgetPreParseFileName(info, { suffix })
失败时必须及时返回失败值,不能让 SDK 无限等待。
播放器 SDK 预解析回调时序(PPT / iSpring)
播放器 SDK 预解析回调时序(PDF / 解析产物)

7. 历史课堂影响#

如果课堂中插入过预解析资源,历史课堂播放时播放器也会重新请求解析产物 URL。此时必须使用播放器 jssdk 接入,并实现 getPreParseFileName。
修改于 2026-11-17 07:40:26
上一页
资料中心与文件 URL
下一页
课堂进行中数据回调
Built with