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

企业直播

复制全文
下载 pdf
点播间管理
CreateVideoRoom - 创建点播间
复制全文
下载 pdf
CreateVideoRoom - 创建点播间

调用 CreateVideoRoom 接口,创建一个知识课程点播间,或复制已有点播间。成功创建后,您可获取到点播间 ID,并根据此 ID 调用其他接口管理点播间。

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateVideoRoom接口名称。当前 API 的名称为 CreateVideoRoom
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述
OldVideoRoomIdLong10001要复制点播间,您可传入被复制的源点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。不传表示创建一个新的点播间。
NameStringPython数据分析入门到应用点播间名称。长度为 1 到 20 个字符。

ViewUrlPath

String

demovideo

点播间观看地址中的路径标识,用于标识点播间,为 URL path 的最后一段。例如,若观看地址为 https://live.byteoc.com/5528/3085317,则 ViewUrlPath 的值为 3085317。默认不传则由系统自动生成。
长度为 1 到 20 个字符。支持以下字符:

  • 大写字母 A - Z
  • 小写字母 a - z
  • 数字
DescribeString这是一个视频教室示例点播间的描述。最多可输入 150 个字符。
CoverImageStringhttps://example.com/cover.jpg点播间的横屏封面图的 URL。需包含协议头。建议图片比例为 16:9,支持上传格式为 JPG、PNG 和 JPEG 的图片。图片大小不超过 2 MB。
VideoRoomClassificationInteger1点播间类型。目前需固定传入 1,表示知识课程类型的点播间。
KnowledgeClassSpecificsObject of KnowledgeClassSpecifics-点播间的视频配置。

KnowledgeClassSpecifics

参数类型是否必选示例值描述
VideoVidsArray of VideoVids-点播间视频列表。最多支持添加 100 个视频,视频总大小不可超过 50 GB。
KnowledgeClassNameString课程列表菜单名称。显示在观看端的菜单展示名称。最多可输入 20 个字符。

VideoVids

参数类型是否必选示例值描述

Vid

String

v02a49g10000ck****3c77u8uhf09ebg

视频的 ID。您可通过调用 ListActivityMediaAPI 接口获取 Vid。

说明

使用子账号调用接口时,确保视频对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

NameString第一章视频名称。不传则默认使用视频已有名称。
VodCoverImgStringhttps://example.com/vod-cover-1.jpg当前视频的横屏封面图的 URL。需包含协议头。建议图片比例为 16:9,支持上传格式为 JPG、PNG 和 JPEG 的图片。图片大小不超过 2 MB。

返回参数

参数类型示例值描述
VideoRoomIdInteger20001新创建的点播间的 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
    }
}

错误码

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

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