GetPopularitySettingsAPI - 获取直播间互动人气设置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetPopularitySettingsAPI - 获取直播间互动人气设置

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

获取指定直播间的互动人气设置。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPopularitySettingsAPI`	接口名称。当前 API 的名称为 `GetPopularitySettingsAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1770091990321207`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	示例值	描述
IsVirtualPopularityEnable	Integer	`1`	是否开启人气显示。开启后，观看页可显示人气值。支持以下取值： `0`：关闭 `1`：开启
VirtualPeopleIncreaseMin	Integer	`1`	虚拟人气增长系数最小值。取值范围为 [1,100]。
VirtualPeopleIncreaseMax	Integer	`2`	虚拟人气增长系数最大值。取值范围为 [1,100]。
VirtualPeopleReduceMin	Integer	`1`	虚拟人气消减系数最小值。取值范围为 [0,100]。
VirtualPeopleReduceMax	Integer	`2`	虚拟人气消减系数最大值。取值范围为 [0,100]。
VirtualPopularity	Integer	`0`	初始人气。取值范围为 [0,10,000,000]。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetPopularitySettingsAPI&Version=2020-06-01&ActivityId=1770091990321207

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetPopularitySettingsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "IsVirtualPopularityEnable": 1,
        "VirtualPeopleIncreaseMin": 1,
        "VirtualPeopleIncreaseMax": 2,
        "VirtualPeopleReduceMin": 1,
        "VirtualPeopleReduceMax": 2,
        "VirtualPopularity": 0
    }
}

错误码

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