UpdateActivityStatusAPI - 更新直播间状态--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateActivityStatusAPI - 更新直播间状态

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

更新直播间的状态，支持将直播间恢复为预告状态、锁定预告和释放预告。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1760965157590`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsStreamViewEnable	Integer	是	`4`	预告操作。支持以下三种取值： `3`：恢复为预告。将直播间恢复为预告状态。 `4`：锁定预告 `5`：释放预告

ActivityId

Long

是

1760965157590

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

说明

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

IsStreamViewEnable

Integer

是

4

预告操作。支持以下三种取值：

3：恢复为预告。将直播间恢复为预告状态。
4：锁定预告
5：释放预告

返回参数

参数	类型	示例值	描述
ActivityId	Long	`-`	已废弃
ActivityIdStr	String	`-`	已废弃
Status	Integer	`-`	已废弃

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityStatusAPI&Version=2020-06-01
{
    "ActivityId": 1760965157590,
    "IsStreamViewEnable": 4
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023101218030963106E9D8A6A803967F2",
        "Action": "UpdateActivityStatusAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697104989
    },
    "Result": {
        "ActivityId": 0,
        "ActivityIdStr": "",
        "Status": 0
    }
}

错误码

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