课件库与上传

控制台客户端配置 · 返回值与共享类型

课件上传分为三步：申请上传地址、将原始文件 PUT 到对象存储、调用 create 创建课件记录并提交转码。contentHash 为文件内容的 SHA-256 十六进制字符串。上传时使用 upload-url 返回的 contentType。

get 返回转码状态、进度和错误信息。课件就绪后，getManifest 返回页面与步骤清单，可据此预览内容。retry 重试转码，remove 删除课件。列表可按课堂、状态、关键词筛选并分页。

应用后端使用应用业务接口和应用凭证。本页描述独立的租户管理调用。

coursewares.list

课件库列表。

GET /v1/coursewares

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.list(appId, input)
Python	c.coursewares.list(app_id, **input)
Java	c.coursewares.list(appId, input)
Go	c.Coursewares.List(ctx, appID, input, &result)
PHP	$c->coursewares->list($appId, $input)

输入：ListCoursewaresInput。 字段放在 URL 查询参数中。

字段	必填	类型	说明
classroomId	否	string | undefined	课堂 ID
ownerEduUserId	否	string | undefined	私有课件库归属用户；上传与创建保持一致
status	否	CoursewareStatus | undefined	状态筛选或目标状态
q	否	string | undefined	搜索关键词
page	否	number | undefined	页码，从 1 开始
pageSize	否	number | undefined	单页数量

返回：ListCoursewaresResult。嵌套字段见共享类型。

coursewares.createUploadUrl

课件上传地址。

POST /v1/coursewares/upload-url

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.createUploadUrl(appId, input)
Python	c.coursewares.create_upload_url(app_id, **input)
Java	c.coursewares.createUploadUrl(appId, input)
Go	c.Coursewares.CreateUploadUrl(ctx, appID, input, &result)
PHP	$c->coursewares->createUploadUrl($appId, $input)

输入：CreateUploadUrlPayload。 字段放在 JSON Body 中。

字段	必填	类型	说明
fileName	是	string	文件名，含扩展名
contentHash	是	string	文件内容 SHA-256，小写十六进制；课件要求 64 字符
contentType	否	string | undefined	文件 MIME 类型
expiresSeconds	否	number | undefined	上传 URL 有效期，秒，0–86400；0 使用默认
ownerEduUserId	否	string | undefined	私有课件库归属用户；上传与创建保持一致

返回：UploadUrlResult。嵌套字段见共享类型。

coursewares.create

创建并转码课件。

POST /v1/coursewares

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.create(appId, input)
Python	c.coursewares.create(app_id, **input)
Java	c.coursewares.create(appId, input)
Go	c.Coursewares.Create(ctx, appID, input, &result)
PHP	$c->coursewares->create($appId, $input)

输入：CreateCoursewarePayload。 字段放在 JSON Body 中。

字段	必填	类型	说明
fileName	是	string	文件名，含扩展名
originalName	是	string	原始文件名，含扩展名
format	是	string	课件文件格式
sizeBytes	是	number	文件字节数
objectKey	是	string	上传接口返回的对象键
sourceUrl	是	string	上传接口返回的源文件地址
contentHash	是	string	文件内容 SHA-256，小写十六进制；课件要求 64 字符
ownerEduUserId	否	string | undefined	私有课件库归属用户；上传与创建保持一致

返回：CoursewareRecord。嵌套字段见共享类型。

coursewares.get

课件详情。

GET /v1/coursewares/detail

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.get(appId, input)
Python	c.coursewares.get(app_id, **input)
Java	c.coursewares.get(appId, input)
Go	c.Coursewares.Get(ctx, appID, input, &result)
PHP	$c->coursewares->get($appId, $input)

输入：CoursewareIdInput。 字段放在 URL 查询参数中。

字段	必填	类型	说明
coursewareId	是	string	课件 ID

返回：CoursewareRecord。嵌套字段见共享类型。

coursewares.getManifest

课件页面清单。

GET /v1/coursewares/manifest

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.getManifest(appId, input)
Python	c.coursewares.get_manifest(app_id, **input)
Java	c.coursewares.getManifest(appId, input)
Go	c.Coursewares.GetManifest(ctx, appID, input, &result)
PHP	$c->coursewares->getManifest($appId, $input)

输入：CoursewareIdInput。 字段放在 URL 查询参数中。

字段	必填	类型	说明
coursewareId	是	string	课件 ID

返回：CoursewareManifest。嵌套字段见共享类型。

coursewares.remove

删除课件。

DELETE /v1/coursewares/remove

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.remove(appId, input)
Python	c.coursewares.remove(app_id, **input)
Java	c.coursewares.remove(appId, input)
Go	c.Coursewares.Remove(ctx, appID, input, &result)
PHP	$c->coursewares->remove($appId, $input)

输入：CoursewareIdInput。 字段放在 URL 查询参数中。

字段	必填	类型	说明
coursewareId	是	string	课件 ID

返回：DeleteResult。嵌套字段见共享类型。

coursewares.retry

重试课件转码。

POST /v1/coursewares/retry

鉴权：租户 Bearer Token 与 x-app-id。

语言	调用
Node.js	c.coursewares.retry(appId, input)
Python	c.coursewares.retry(app_id, **input)
Java	c.coursewares.retry(appId, input)
Go	c.Coursewares.Retry(ctx, appID, input, &result)
PHP	$c->coursewares->retry($appId, $input)

输入：CoursewareIdInput。 字段放在 JSON Body 中。

字段	必填	类型	说明
coursewareId	是	string	课件 ID

返回：CoursewareRecord。嵌套字段见共享类型。