You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

创建直播间

最近更新时间：2024.03.19 11:22:04

首次发布时间：2022.03.29 22:10:12

我的收藏

您可以通过本接口创建直播间用于直播活动。可根据直播模板创建直播间，或直接复制已存在的直播间生成新的直播间。成功创建后，您可获取到直播间 ID，并根据此 ID 调用其他接口装修和管理直播间。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
NameString是直播间 A直播间名称。
LiveTimeLong否1642668850直播开播时间，默认为当前时间。Unix 时间戳，单位为秒。

LiveMode

Integer

否

2

直播延时类型。支持以下取值，默认取值为 0。

  • 0：继承直播模板配置的直播延时类型。有关如何创建直播模板，详见直播模板。
  • 1：超低延时直播（延时时间在 1 秒以内的直播）
  • 2：普通延时直播（延时时间在 5～10 秒的直播）

说明

当通过复制直播间方式创建新的直播间时，复制出的直播间将继承原直播间的直播延时类型。本参数的配置将不生效。

ViewUrlPath

String

否

3085317

观看地址中的 path 字段，不填则由系统自动生成。例如观看地址为 https://live.byteoc.com/5528/3085317，则 ViewUrlPath 取值为 3085317。

说明

path 字段不可超过 20 个字符，且仅支持输入数字和英文字母。

CoverImage

String

否

https://tplv-gjr25qtd0-image.image

横屏直播的封面图 URL。

  • 若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。
  • 若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。

VerticalCoverImage

String

否

https://gjr293lqtd0-image.image

竖屏直播的封面图 URL。若未设置该参数值，则默认读取 CoverImage 的值。

  • 若通过控制台配置竖屏直播封面图且配置成功，则封面图的 URL 无协议头。
  • 若通过调用 API 接口配置竖屏直播封面图，则封面图的 URL 有协议头。
OldIdLong否174718784770被复制的直播间的 ID。通过已创建的直播间复制出新的直播间时，需要配置该参数。您可以通过 ListActivityAPI 接口查询 ID。

CopyStream

Boolean

否

true

复制直播间时，是否同时复制直播流。支持以下取值，默认取值为 false。

  • true：是
  • false：否
TemplateIdLong否4984658直播模板 ID。通过直播模板创建直播间时，需要配置该参数。取值为空，表示使用默认直播模板。您可以通过 GetAccountTemplateAPI 接口查询 ID。
SiteTagsArray of SiteTags否-直播间分类标签信息列表。 您可以通过 ListSiteTagAPIV2 接口获取分类标签信息。
TextSiteTagsArray of TextSiteTags否-直播间文本标签信息列表。 您可以通过 ListSiteTagAPIV2 接口获取文本标签信息。

SiteTags

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

TextSiteTags

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

返回参数

参数类型示例值描述
ActivityIdLong1732412312新创建直播间的 ID。
ActivityIdStrString-已废弃
StatusInteger-已废弃

示例

请求示例

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

返回示例

{
  "ResponseMetadata":{
		"RequestId":"201806041104200100100232280022D30",
		"Action":"CreateActivityAPIV2",
		"Version":"2020-06-01",	
		"Service":"livesaas",
		"Region":"cn-north-1"，
		"SystemTime":1656067132
	},
	"Result":{
		"ActivityId":1732412312,
		"ActivityIdStr":"1732412312",
		"Status":0
	}
}

错误码

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