调用 GetVideoRoomBasicInfo 接口,获取单个点播间的基础信息,包括点播间的名称、观看地址、封面图、描述等信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetVideoRoomBasicInfo | 接口名称。当前 API 的名称为 GetVideoRoomBasicInfo。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| VideoRoomId | Long | 是 | 20001 | 要查询的点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Name | String | Python数据分析入门到应用 | 点播间名称。 |
CoverImage | String |
| 点播间的封面图 URL。
|
| VideoRoomClassification | Integer | 1 | 点播间类型。目前固定为 1,表示知识课程类型的点播间。 |
| KnowledgeClassMeta | Object of KnowledgeClassMeta | - | 点播间基础信息。 |
| ViewUrlPath | String | 3085317 | 点播间观看地址中的路径标识,用于标识点播间,为 URL path 的最后一段。例如,若观看地址为 https://live.byteoc.com/5528/3085317,则 ViewUrlPath 的值为 3085317。 |
| ViewUrlNameSpace | String | 5545 | 点播间观看地址中的路径标识,系统自动分配。例如,若观看地址为 https://live.byteoc.com/5545/3085317,则 ViewUrlNameSpace 的值为 5545。 |
| CreateTime | Integer | 1710000000 | 点播间的创建时间。Unix 时间戳,单位为秒。 |
| ViewUrl | String | https://example.com/video-room/20001 | PC 端和移动端点播间的观看地址。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| KnowledgeClassDesc | String | 基础课程介绍 | 点播间的描述。 |
IsBulletScreenEnable | Boolean |
| 点播间是否了开启互动弹幕。取值如下:
|
| KnowledgeClassName | String | 课程列表 | 菜单名称。显示在观看端的菜单展示名称。 |
GET https://livesaas.volcengineapi.com/?Action=GetVideoRoomBasicInfo&Version=2023-08-01&VideoRoomId=20001
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetVideoRoomBasicInfo", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Name": "Python数据分析入门到应用", "CoverImage": "https://tplv-gjr25qtd0-image.image", "VideoRoomClassification": 1, "KnowledgeClassMeta": { "KnowledgeClassDesc": "基础课程介绍", "IsBulletScreenEnable": true, "KnowledgeClassName": "课程列表" }, "ViewUrlPath": "3085317", "ViewUrlNameSpace": "5545", "CreateTime": 1710000000, "ViewUrl": "https://example.com/video-room/20001" } }