伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. SDK文档
  • 历史课堂数据回调接入
  • 签名示例
  • 历史课堂转视频接入方式
  • 历史课堂/微课下载接口
  • query参数说明
  • Web SDK
    • PlasoStyleUpime API说明
    • 云盘接入
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • Android SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • iOS SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • 播放器SDK
    • Web播放器
  • 「伯索云学堂」跳转接入指南
    • 跳转接入指南
  1. SDK文档

历史课堂/微课下载接口

课堂视频导出API接口文档#

📌
注意:因历史课堂/微课下载会产生额外转录费用,使用此接口将按转录时长计费,单价固定1元/小时。
📌
按照接口传参规则,实现下载历史课堂视频、微课视频 ;
实现数据沉淀,二次维护与转换。
接口签名参考签名示例
视频存储至客户自有服务器中,需要提供可以上传OSS的AK和SK;
配置参数如下:
        "ossAKey": "xxx",                     // 存储oss的ak,需要有写权限
        "ossSKey": "xxx",                     // 存储oss的sk
        "bucket": "xxx",                      // 对应bucket名称
        "region": "oss-cn-shanghai",          // oss region
        "path": "dir",                        // 视频保存目录
        "callbackUrl": "https://xxx/callback" // 转码事件回调

1. 接口概述#

本文档描述了课堂视频导出相关的API接口,包括视频导出、任务查询和结果回调等功能。

2. API接口详情#

2.1 导出历史课堂为视频#

接口描述:将历史课堂转换为视频文件或音频文件
接口地址
https://www.plaso.cn/dataentry/liveclass/transferVideo
请求参数
名称类型必填描述
fileNameString是目标文件名称
recordIdString是历史课堂ID
convertModeNumber否视频模式,取值如下:
1:仅头像
2:仅白板
3:仅音频
10:白板+大头像
20:头像+白板(默认值)
resolutionString否转码分辨率,支持:
720P(默认值)
1080P
videoBitrateNumber否视频码率,范围:500-8000 kbps(预期码率,以最终转码结果为准)
audioBitrateNumber否音频码率,范围:64-320 kbps(预期码率,以最终转码结果为准)
frameRateNumber否视频帧率,范围:15-60 fps(默认值:45)
返回结果
名称类型描述
codeNumber0:执行成功 ;22001:存在进行中的任务 ; 22003:课堂不存在
objObject
├ taskIdString任务编号

2.2 查询视频导出任务#

接口描述:查询视频导出任务的执行状态
接口地址
https://www.plaso.cn/dataentry/liveclass/getVideoTask
请求参数
名称类型必填描述
taskIdString是任务ID
返回结果
名称类型描述
codeNumber0:执行成功 ;22001:存在进行中的任务 ; 22003:课堂不存在
objObject
├ statusNumber当前任务状态,取值如下:
0:等待
1:开始执行
2:开始上传
3:开始回调
99:成功
-1:转码失败
-2:上传失败
-3:回调失败
├ videoUrlString对应视频存储的OSS地址,status=99时有效

2.3 课堂转录制结果回调#

接口描述:在视频转录制结束后发起回调,通知转录制结果
接口地址
需要提前配置回调URL
请求参数
参数名类型描述
taskIdString转录制任务ID
statusString转录制状态:
99:成功
-1:转码失败
-2:上传失败
locationString转录制成功的视频完整路径,失败时为空
期望响应参数
参数名类型描述
codeNumber0表示成功,及其它错误码
messageString错误消息,成功时可以传空字符串
重试机制
该接口调用失败后进行重试,最多5次
重试间隔1分钟

3. OSS配置参数说明#

当需要将视频存储至客户自有服务器时,需要提供以下OSS配置参数:
参数名类型必填描述
ossAKeyString是存储OSS的AccessKey,需要有写权限
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://xxx/callback"
}

4. 参数类型说明#

String:字符串类型,如 "abc123"
Number:数字类型,如 20、720、128
必填:标注"true"为必填项,"false"为可选项

5. 错误码说明#

错误码描述
0执行成功
22001存在进行中的任务
22003课堂不存在

6. 任务状态说明#

状态值状态名称描述
0Wait等待处理
1Transfer开始执行转码
2Upload开始上传
3Callback开始回调
99Finish成功完成
-1FailedTransfer转码失败
-2FailedUpload上传失败
-3FailedCallback回调失败
修改于 2025-09-26 05:15:55
上一页
历史课堂转视频接入方式
下一页
query参数说明
Built with