课堂视频导出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

请求参数

名称	类型	必填	描述
fileName	String	是	目标文件名称
recordId	String	是	历史课堂ID
convertMode	Number	否	视频模式，取值如下： 1：仅头像 2：仅白板 3：仅音频 10：白板+大头像 20：头像+白板（默认值）
resolution	String	否	转码分辨率，支持： 720P（默认值） 1080P
videoBitrate	Number	否	视频码率，范围：500-8000 kbps（预期码率，以最终转码结果为准）
audioBitrate	Number	否	音频码率，范围：64-320 kbps（预期码率，以最终转码结果为准）
frameRate	Number	否	视频帧率，范围：15-60 fps（默认值：45）

返回结果

名称	类型	描述
code	Number	0：执行成功；22001:存在进行中的任务； 22003:课堂不存在
obj	Object
├ taskId	String	任务编号

2.2 查询视频导出任务

接口描述：查询视频导出任务的执行状态

接口地址

https://www.plaso.cn/dataentry/liveclass/getVideoTask

请求参数

名称	类型	必填	描述
taskId	String	是	任务ID

返回结果

名称	类型	描述
code	Number	0：执行成功；22001:存在进行中的任务； 22003:课堂不存在
obj	Object
├ status	Number	当前任务状态，取值如下： 0：等待 1：开始执行 2：开始上传 3：开始回调 99：成功 -1：转码失败 -2：上传失败 -3：回调失败
├ videoUrl	String	对应视频存储的OSS地址，status=99时有效

2.3 课堂转录制结果回调

接口描述：在视频转录制结束后发起回调，通知转录制结果

接口地址

需要提前配置回调URL

请求参数

参数名	类型	描述
taskId	String	转录制任务ID
status	String	转录制状态： 99：成功 -1：转码失败 -2：上传失败
location	String	转录制成功的视频完整路径，失败时为空

期望响应参数

参数名	类型	描述
code	Number	0表示成功，及其它错误码
message	String	错误消息，成功时可以传空字符串

重试机制

该接口调用失败后进行重试，最多5次

重试间隔1分钟

3. OSS配置参数说明

当需要将视频存储至客户自有服务器时，需要提供以下OSS配置参数：

参数名	类型	必填	描述
ossAKey	String	是	存储OSS的AccessKey，需要有写权限
ossSKey	String	是	存储OSS的SecretKey
bucket	String	是	对应bucket名称
region	String	是	OSS区域，如：oss-cn-shanghai
path	String	是	视频保存目录
callbackUrl	String	是	转码事件回调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. 任务状态说明

状态值	状态名称	描述
0	Wait	等待处理
1	Transfer	开始执行转码
2	Upload	开始上传
3	Callback	开始回调
99	Finish	成功完成
-1	FailedTransfer	转码失败
-2	FailedUpload	上传失败
-3	FailedCallback	回调失败

历史课堂/微课下载接口

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

1. 接口概述#

2. API接口详情#

2.1 导出历史课堂为视频#

2.2 查询视频导出任务#

2.3 课堂转录制结果回调#

3. OSS配置参数说明#

4. 参数类型说明#

5. 错误码说明#

6. 任务状态说明#

课堂视频导出API接口文档

1. 接口概述

2. API接口详情

2.1 导出历史课堂为视频

2.2 查询视频导出任务

2.3 课堂转录制结果回调

3. OSS配置参数说明

4. 参数类型说明

5. 错误码说明

6. 任务状态说明