调用 CreateVideoRoom 接口,创建一个知识课程点播间,或复制已有点播间。成功创建后,您可获取到点播间 ID,并根据此 ID 调用其他接口管理点播间。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateVideoRoom | 接口名称。当前 API 的名称为 CreateVideoRoom。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| OldVideoRoomId | Long | 否 | 10001 | 要复制点播间,您可传入被复制的源点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。不传表示创建一个新的点播间。 |
| Name | String | 是 | Python数据分析入门到应用 | 点播间名称。长度为 1 到 20 个字符。 |
ViewUrlPath | String | 否 |
| 点播间观看地址中的路径标识,用于标识点播间,为 URL path 的最后一段。例如,若观看地址为
|
| Describe | String | 否 | 这是一个视频教室示例 | 点播间的描述。最多可输入 150 个字符。 |
| CoverImage | String | 否 | https://example.com/cover.jpg | 点播间的横屏封面图的 URL。需包含协议头。建议图片比例为 16:9,支持上传格式为 JPG、PNG 和 JPEG 的图片。图片大小不超过 2 MB。 |
| VideoRoomClassification | Integer | 是 | 1 | 点播间类型。目前需固定传入 1,表示知识课程类型的点播间。 |
| KnowledgeClassSpecifics | Object of KnowledgeClassSpecifics | 否 | - | 点播间的视频配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| VideoVids | Array of VideoVids | 否 | - | 点播间视频列表。最多支持添加 100 个视频,视频总大小不可超过 50 GB。 |
| KnowledgeClassName | String | 否 | 课程列表 | 菜单名称。显示在观看端的菜单展示名称。最多可输入 20 个字符。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vid | String | 是 |
| 视频的 ID。您可通过调用 ListActivityMediaAPI 接口获取 Vid。 说明 使用子账号调用接口时,确保视频对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Name | String | 否 | 第一章 | 视频名称。不传则默认使用视频已有名称。 |
| VodCoverImg | String | 否 | https://example.com/vod-cover-1.jpg | 当前视频的横屏封面图的 URL。需包含协议头。建议图片比例为 16:9,支持上传格式为 JPG、PNG 和 JPEG 的图片。图片大小不超过 2 MB。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| VideoRoomId | Integer | 20001 | 新创建的点播间的 ID。 |
POST https://livesaas.volcengineapi.com/?Action=CreateVideoRoom&Version=2023-08-01 { "OldVideoRoomId": 10001, "Name": "Python数据分析入门到应用", "ViewUrlPath": "demovideo", "Describe": "这是一个视频教室示例", "CoverImage": "https://example.com/cover.jpg", "VideoRoomClassification": 1, "KnowledgeClassSpecifics": { "VideoVids": [ { "Vid": "v02a49g10000ck****3c77u8uhf09ebg", "Name": "第一章", "VodCoverImg": "https://example.com/vod-cover-1.jpg", "MediaLibraryVideoId": 90001 } ], "KnowledgeClassName": "课程列表" } }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateVideoRoom", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "VideoRoomId": 20001 } }