You need to enable JavaScript to run this app.
导航

获取直播间互动人气设置

最近更新时间2023.12.05 11:06:29

首次发布时间2023.07.10 10:49:15

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetPopularitySettingsAPI接口名称。当前 API 的名称为 GetPopularitySettingsAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
ActivityIdLong1770091990321207直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述

IsVirtualPopularityEnable

Integer

1

是否开启人气显示。开启后,观看页可显示人气值。支持以下取值:

  • 0:关闭
  • 1:开启
VirtualPeopleIncreaseMinInteger1虚拟人气增长系数最小值。取值范围为 [1,100]。
VirtualPeopleIncreaseMaxInteger2虚拟人气增长系数最大值。取值范围为 [1,100]。
VirtualPeopleReduceMinInteger1虚拟人气消减系数最小值。取值范围为 [0,100]。
VirtualPeopleReduceMaxInteger2虚拟人气消减系数最大值。取值范围为 [0,100]。
VirtualPopularityInteger0初始人气。取值范围为 [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
  }
}

错误码

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