UpdateLoopVideoStatus - 更新录播直播开启状态--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateLoopVideoStatus - 更新录播直播开启状态

最近更新时间：2025.07.22 22:27:59首次发布时间：2024.06.19 11:42:27

调用 UpdateLoopVideoStatus接口更新指定直播间录播直播的开启状态。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

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

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1776****89138`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsStartLoopVideo	Integer	是	`1`	是否开始录播直播。取值如下： `1`：开始 `2`：关闭
LineId	Long	是	`123`	直播频道 ID。您可通过调用 GetStreamsAPI 接口获取 ID。说明确保直播间内仅存在一个直播频道。

ActivityId

Long

是

1776****89138

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

IsStartLoopVideo

Integer

是

1

是否开始录播直播。取值如下：

1：开始
2：关闭

LineId

Long

是

123

直播频道 ID。您可通过调用 GetStreamsAPI 接口获取 ID。

说明

确保直播间内仅存在一个直播频道。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。取值如下： `true`：成功 `false`：失败

Status

Boolean

true

是否更新成功。取值如下：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideoStatus&Version=2023-08-01
{
    "ActivityId": 1776****89138,
    "IsStartLoopVideo": 1,
    "LineId": 123
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLoopVideoStatus",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
403	OperationDenied.VideoDurationInvalid	Operation is denied because video duration is too short.	录播直播视频时长过短。请确保视频时长大于等于 1 秒。您可调用 UpdateLoopVideos 接口，更新录播直播视频。
403	OperationDenied.ActivityLineExceedLimit	Operation is denied because the number of activity line exceeds the limit.	录播直播仅支持单频道。当前直播间的直播频道数已超出上限 1。请删除部分直播频道，确保直播间中仅保留一个直播频道。