UpdatePopularitySettingsAPI - 更新直播间互动人气设置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdatePopularitySettingsAPI - 更新直播间互动人气设置

最近更新时间：2025.03.21 16:48:05首次发布时间：2023.07.10 10:49:15

更新指定直播间的互动人气设置。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770091990321207`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsVirtualPopularityEnable	Integer	否	`1`	是否开启人气显示。支持以下取值，默认取值为 `0`。 `0`：关闭 `1`：开启，即可在观看页显示人气值。
VirtualPeopleIncreaseMin	Integer	否	`1`	虚拟人气增长系数最小值。取值范围为 [1,100]，默认取值为 `1`。
VirtualPeopleIncreaseMax	Integer	否	`2`	虚拟人气增长系数最大值。取值范围为 [1,100]，默认取值为 `1`。
VirtualPeopleReduceMin	Integer	否	`1`	虚拟人气消减系数最小值。取值范围为 [0,100]，默认取值为 `1`。
VirtualPeopleReduceMax	Integer	否	`2`	虚拟人气消减系数最大值。取值范围为 [0,100]，默认取值为 `1`。
VirtualPopularity	Integer	否	`0`	初始人气。取值范围为 [0,10,000,000]，默认取值为 `0`。

返回参数

参数类型示例值描述

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

Status

Boolean

true

是否更新成功。支持以下取值：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdatePopularitySettingsAPI&Version=2020-06-01
{
    "ActivityId": 1770091990321207,
    "IsVirtualPopularityEnable": 1,
    "VirtualPeopleIncreaseMin": 1,
    "VirtualPeopleIncreaseMax": 2,
    "VirtualPeopleReduceMin": 1,
    "VirtualPeopleReduceMax": 2,
    "VirtualPopularity": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdatePopularitySettingsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "Status": true
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.VirtualCoefficientValid	The specified parameter VirtualCoefficient is invalid.	虚拟人气增长或消减系数错误。请修改后重试。