调用 UpdateVideoRoomBasicInfo 接口,更新单个点播间的基础信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateVideoRoomBasicInfo | 接口名称。当前 API 的名称为 UpdateVideoRoomBasicInfo。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| VideoRoomId | Integer | 是 | 20001 | 要更新的点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。 |
| Name | String | 否 | Python数据分析入门到应用 | 点播间名称。长度为 1 到 20 个字符。 |
| CoverImage | String | 否 | https://example.com/cover.jpg | 点播间的横屏封面图的 URL。需包含协议头。建议图片比例为 16:9,支持上传格式为 JPG、PNG 和 JPEG 的图片。图片大小不超过 2 MB。 |
| VideoRoomClassification | Integer | 否 | 1 | 点播间类型。目前固定为 1,表示知识课程类型的点播间。 |
| KnowledgeClassMeta | Object of KnowledgeClassMeta | 否 | - | 点播间基础信息。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| KnowledgeClassDesc | String | 否 | 基础课程介绍 | 点播间的描述。 |
IsBulletScreenEnable | Boolean | 否 |
| 点播间是否开启互动弹幕。取值如下:
|
| KnowledgeClassName | String | 否 | 课程列表 | 菜单名称。显示在观看端的菜单展示名称。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否更新成功。成功返回 true。 |
POST https://livesaas.volcengineapi.com/?Action=UpdateVideoRoomBasicInfo&Version=2023-08-01 { "VideoRoomId": 20001, "Name": "Python数据分析入门到应用", "CoverImage": "https://example.com/cover.jpg", "VideoRoomClassification": 1, "KnowledgeClassMeta": { "KnowledgeClassDesc": "基础课程介绍", "IsBulletScreenEnable": true, "KnowledgeClassName": "课程列表" } }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateVideoRoomBasicInfo", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true } }