CreateActivityAPIV2 - 创建直播间--企业直播-火山引擎

文档中心

立即注册

导航

CreateActivityAPIV2 - 创建直播间

最近更新时间：2025.03.21 16:48:04首次发布时间：2022.03.29 22:10:12

调用 CreateActivityAPIV2 接口，创建直播间用于直播活动。成功创建后，您可获取到直播间 ID，并根据此 ID 调用其他接口装修和管理直播间。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备我的直播 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=CreateActivityAPIV2&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateActivityAPIV2`	接口名称。当前 API 的名称为 `CreateActivityAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`直播间 A`	直播间名称。长度为 1 到 150 个字符。
LiveTime	Long	否	`1642668850`	直播开始时间，默认为当前时间。Unix 时间戳，单位为秒。支持精确到分钟级。开始时间取值需小于 `EndTime` 的取值，且与 `EndTime` 的差值最大为 259,200，即 72 小时。
OldId	Long	否	`1747****4770`	被复制的直播间的 ID。您可通过调用 ListActivityAPI 接口获取 ID。如需通过已创建的直播间复制出新的直播间，该参数必选。
CopyStream	Boolean	否	`true`	复制直播间时，是否同时复制直播流。默认值为 `false`。取值如下： `true`：是 `false`：否
TemplateId	Long	否	`498**58`	直播模板 ID。新创建的直播间与直播模板配置相同。您可通过调用 GetAccountTemplateAPI 接口获取 ID。不传该参数，则使用默认直播模板，如未设置默认直播模板，则不使用直播模板，直接创建直播间。如需通过直播模板创建直播间，该参数必选。说明该参数仅在未配置 `OldId` 时生效。如果直播模板 ID 对应的模板包含大量抽奖配置，并且您想复制通过该模板创建的直播间，请在直播间创建 5 分钟后再进行复制，否则抽奖配置可能复制不完整。
IsAutoEndEnable	Integer	否	`1`	是否开启自动关播功能。默认值为 `0`。取值如下： `0`：关闭 `1`：开启说明当通过复制直播间的方式创建新直播间时，新直播间不会复制原直播间是否开启自动关播功能。您可通过该参数配置新直播间是否开启自动关播功能。
EndTime	Long	否	`1718078834`	直播结束时间。Unix 时间戳，单位为秒。支持精确到分钟级。结束时间取值需大于当前时间和 `LiveTime` 的取值，且与 `LiveTime` 的差值最大为 259,200，即 72 小时。说明当 `IsAutoEndEnable` 取值为 `1` 时，该参数必选且生效。当通过复制直播间的方式创建新直播间时，新直播间不会复制原直播间的直播结束时间。您可通过该参数配置新直播间的直播结束时间。
ActivityType	Integer	否	`1`	直播模式。默认值为 `0`。取值如下： `0`：视频直播 `1`：伪直播说明当通过复制直播间的方式创建新直播间时，新直播间将继承原直播间的直播模式，该参数不生效。
LiveMode	Integer	否	`2`	直播延时类型。默认值为 `0`。取值如下： `0`：继承直播模板配置的直播延时类型。有关如何创建直播模板，详见直播模板。 `1`：超低延时（延时小于 1 秒） `2`：普通延时（延时 5-10 秒）说明当通过复制直播间的方式创建新直播间时，新直播间将继承原直播间的直播延时类型，该参数不生效。
ViewUrlPath	String	否	`3085317`	观看地址中的 path 字段，不填则由系统自动生成。例如观看地址为 `https://live.byteoc.com/5528/3085317`，则 `ViewUrlPath` 取值为 `3085317`。长度为 1 到 20 个字符。支持以下字符：大写字母 A - Z 小写字母 a - z 数字
CoverImage	String	否	`https://tplv-gjr25qtd0-image.image`	横屏直播的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。
VerticalCoverImage	String	否	`https://gjr293lqtd0-image.image`	竖屏直播的封面图 URL。若未设置该参数值，则默认读取 `CoverImage` 的值。若通过控制台配置竖屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置竖屏直播封面图，则封面图的 URL 有协议头。
SiteTags	Array of SiteTags	否	`-`	直播间分类标签信息列表。您可以通过 ListSiteTagAPIV2 接口获取分类标签信息。说明当通过复制直播间的方式创建新直播间时，新直播间不会复制原直播间的分类标签信息。您可通过该参数配置新直播间的分类标签信息。
TextSiteTags	Array of TextSiteTags	否	`-`	直播间文本标签信息列表。您可以通过 ListSiteTagAPIV2 接口获取文本标签信息。说明当通过复制直播间的方式创建新直播间时，新直播间不会复制原直播间的文本标签信息。您可通过该参数配置新直播间的文本标签信息。
IsAnswerRepetitionEnable	Integer	否	`1`	是否开启答题重现功能。默认值为 `0`。取值如下： `0`：不开启 `1`：开启。直播中发送的答题和简答，将在直播回放的对应时间点自动弹出重现说明通过复制直播间的方式或使用直播模板创建直播间时，以被复制的直播间或使用的直播模板中的配置为准，该参数不生效。
LiveLayout	Integer	否	`2`	视频布局。默认值为 `2`。取值如下： `1`：三分屏。主播画面和视频画面使用不同视频源，主播画面不会遮挡视频画面。详见三分屏直播 `2`：纯视频。主播画面和视频画面共用一个视频源，支持调整主播画面位置
CreatorName	String	否	`user@example.com`	创建直播间的账号信息。参数取值为子账号的账号，表示通过指定子账号创建直播间。您可调用 ListSubAccounts 接口，通过参数 `Name` 获取子账号的账号。使用主账号调用接口时，不传该参数，则直播间将通过主账号创建。使用子账号调用接口时，直播间将默认通过该子账号创建，该参数不生效。
IsAutoStartEnable	Integer	否	`0`	是否开启自动开播功能。默认值为 `0`。取值如下： `0`：关闭 `1`：开启。开启后，会在 `LiveTime` 时自动开播，请确保 `LiveTime` 的时间大于当前时间说明该参数仅在直播模式为伪直播（`ActivityType` 取值为 `1`）时生效。当通过复制直播间的方式创建新直播间时，新直播间不会复制原直播间是否开启自动开播功能。您可通过该参数配置新直播间是否开启自动开播功能。
LoopVideos	Array of LoopVideos	否	`-`	伪直播视频列表。说明最多支持配置 50 个伪直播视频且视频总大小需小于等于 200 GB。该参数仅在直播模式为伪直播（`ActivityType` 取值为 `1`）时生效。
IsReplayAutoOnlineEnable	Integer	否	`0`	是否开启回放自动上架。默认值为 `0`。取值如下： `0`：关闭 `1`：开启。在直播结束后，自动将直播回放上架到观看页
Vid	String	否	`v02a49g10000ck****3c77u8uhf09ebg`	视频库或直播暂存中视频的 Vid。您可调用 ListActivityMediaAPI 接口，通过返回参数 `Vid` 获取视频的 Vid。新创建的直播间状态为回放，同时该视频会作为直播间的回放上架观看页。说明如果传入的 Vid 属于直播暂存中的视频，则该视频会自动存入视频库的默认分类下，请确保您的媒体库容量充足。使用子账号调用接口时，该视频必须对子账号可见，且子账号必须具备视频库或直播暂存的仅查看或可编辑权限。有关如何配置子账号的可见范围和权限，详见子账号管理。

SiteTags

参数	类型	是否必选	示例值	描述
Value	String	是	`标签1`	分类标签的可选标签值。
Index	Integer	是	`0`	分类标签的索引值，用于标识分类标签在控制台展示的位置。索引值越小，位置越靠前。取值范围为 [0,19]。

TextSiteTags

参数	类型	是否必选	示例值	描述
Value	String	是	`标签 2`	文本标签值
Index	Integer	是	`0`	文本标签的索引值，用于标识文本标签在控制台展示的位置。索引值越小，位置越靠前。取值范围为 [0,4]。

LoopVideos

参数	类型	是否必选	示例值	描述
Index	Long	是	`1`	伪直播视频序号。该参数取值为从 `1` 开始的连续且不重复的整数，如 `1`、`2`、`3`。取值范围为 [1,50]。取值越小，在伪直播视频列表中的位置越靠前。
VideoName	String	是	`视频.mp4`	伪直播视频名称。
VideoVid	String	是	`v02a49370000br****vm75gbiokkno91`	伪直播视频 Vid。您可通过调用 ListActivityMediaAPI 接口获取 Vid。
Offset	Integer	是	`0`	伪直播启动时刻。单位为秒。例如参数取值为 `10`，则从视频的第 10 秒开始播放。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`173****312`	新创建直播间的 ID。
ActivityIdStr	String	`-`	已废弃
Status	Integer	`-`	已废弃
ViewUrl	String	`https://live.byteoc.com/1399/968****`	PC 端和移动端横屏模式的观看页地址。如需获取移动端竖屏模式的观看页地址，可在该地址后添加 `?portrait=1`，例如 `https://live.byteoc.com/1399/968****?portrait=1`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateActivityAPIV2&Version=2020-06-01
{
    "Name": "直播间 A",
    "LiveTime": 1642668850,
    "LiveMode": 2
}

返回示例

{
	"ResponseMetadata": {
		"RequestId": "20230604110420****100232280022D31",
		"Action": "CreateActivityAPIV2",
		"Version": "2020-06-01",
		"Service": "livesaas",
		"Region": "cn-north-1",
		"SystemTime": 1697446406
	},
	"Result": {
		"ActivityId": 173****312,
		"ActivityIdStr": "",
		"Status": ,
		"ViewUrl": "https://live.byteoc.com/1399/968****"
	}
}

错误码

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