You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
点播间管理
GetVideoRoomBasicInfo- 获取点播间基础信息
复制全文
下载 pdf
GetVideoRoomBasicInfo- 获取点播间基础信息

调用 GetVideoRoomBasicInfo 接口,获取单个点播间的基础信息,包括点播间的名称、观看地址、封面图、描述等信息。

注意事项

  • 请求频率:单用户请求频率限制为 120 次/分钟
  • 前提条件:确保您拥有火山引擎主账号或具备点播间的基础信息 > 仅查看可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=GetVideoRoomBasicInfo&Version=2023-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringGetVideoRoomBasicInfo接口名称。当前 API 的名称为 GetVideoRoomBasicInfo
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
VideoRoomIdLong20001要查询的点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。

返回参数

参数类型示例值描述
NameStringPython数据分析入门到应用点播间名称。

CoverImage

String

https://tplv-gjr25qtd0-image.image

点播间的封面图 URL。

  • 若通过控制台配置横屏直播封面图且配置成功,则封面图的 URL 无协议头。
  • 若通过调用 API 接口配置横屏直播封面图,则封面图的 URL 有协议头。
VideoRoomClassificationInteger1点播间类型。目前固定为 1,表示知识课程类型的点播间。
KnowledgeClassMetaObject of KnowledgeClassMeta-点播间基础信息。
ViewUrlPathString3085317点播间观看地址中的路径标识,用于标识点播间,为 URL path 的最后一段。例如,若观看地址为 https://live.byteoc.com/5528/3085317,则 ViewUrlPath 的值为 3085317
ViewUrlNameSpaceString5545点播间观看地址中的路径标识,系统自动分配。例如,若观看地址为 https://live.byteoc.com/5545/3085317,则 ViewUrlNameSpace 的值为 5545
CreateTimeInteger1710000000点播间的创建时间。Unix 时间戳,单位为秒。
ViewUrlStringhttps://example.com/video-room/20001PC 端和移动端点播间的观看地址。

KnowledgeClassMeta

参数类型示例值描述
KnowledgeClassDescString基础课程介绍点播间的描述。

IsBulletScreenEnable

Boolean

true

点播间是否了开启互动弹幕。取值如下:

  • true:开启。开启后,观众可在观看课程时发送弹幕。
  • false:关闭。
KnowledgeClassNameString课程列表菜单名称。显示在观看端的菜单展示名称。

请求示例

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"
    }
}

错误码

访问公共错误码错误码获取详细信息。

最近更新时间:2026.06.24 11:45:18
这个页面对您有帮助吗?
有用
有用
无用
无用