更新指定直播间的互动人气设置。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdatePopularitySettingsAPI | 接口名称。当前 API 的名称为 UpdatePopularitySettingsAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 1770091990321207 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
IsVirtualPopularityEnable | Integer | 否 |
| 是否开启人气显示。支持以下取值,默认取值为
|
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 |
| 是否更新成功。支持以下取值:
|
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", "SystemTime": 1701309870 }, "Result": { "Status": true } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.VirtualCoefficientValid | The specified parameter VirtualCoefficient is invalid. | 虚拟人气增长或消减系数错误。请修改后重试。 |