开启/关闭轮播--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

开启/关闭轮播

最近更新时间：2023.12.01 10:08:49首次发布时间：2022.03.29 22:10:12

开启或关闭配置的视频轮播。

注意事项

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

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

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

ActivityId Long 是 732412312 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`732412312`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IsStartLoopVideo	Integer	是	`1`	是否开启视频轮播。支持以下取值： `1`：开启 `2`：关闭
LineId	Long	是	`123`	直播频道 ID。您可以通过 GetStreamsAPI 接口查询 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=UpdateLoopVideoStatusAPI&Version=2020-06-01

{
  "ActivityId": 732412312,
  "IsStartLoopVideo": 1,
  "LineId": 123
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"UpdateLoopVideoStatusAPI",
        "Version":"2020-06-01", 
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132
    }
    "Result":{
        "Status":true
    }
}

错误码

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