UpdateViewerLevelConfig - 更新观众等级配置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateViewerLevelConfig - 更新观众等级配置

最近更新时间：2025.09.26 10:46:05首次发布时间：2025.08.04 14:37:18

调用 UpdateViewerLevelConfig 接口，在账户中心 > 观众等级页面的指定观众等级库中，更新等级配置。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备观众等级 > 可编辑权限的子账号。详见权限管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateViewerLevelConfig&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
UpdateLevelUnits	Array of UpdateLevelUnits	是	`-`	待更新的等级配置信息。
ViewerLevelGroupId	Long	否	`123456`	观众等级库 ID。可通过 ListAccountViewerLevelGroup 接口获取。说明使用子账号调用接口时，确保子账号拥有对等级库的可编辑权限。有关如何配置子账号的权限范围，详见子账号管理。为保证系统兼容，您也可通过不传或将该参数设置为 `0` 来指定默认等级库（包含 3 个默认等级配置）。

UpdateLevelUnits

参数	类型	是否必选	示例值	描述
LevelId	Long	是	`10086`	等级 ID。可通过 GetViewerLevelConfig 接口获取。
ViewerLevelConfigs	Object of ViewerLevelConfigs	是	`-`	要更新的等级配置信息。说明参数 LevelName、Color、LevelIcon 和 Description 至少需要传一个。

ViewerLevelConfigs

参数	类型	是否必选	示例值	描述
LevelName	String	否	`青铜会员`	等级名称，不可超过 5 个字符。
Color	String	否	`#CD7F32`	等级名称和图标的背景颜色，需遵循十六进制颜色码格式。
LevelIcon	String	否	`http://example.com/icons/bronze.png`	等级图标的 URL，包含协议头。最多支持 1024 个字符。
Description	String	否	`刚开始观看直播的新手观众`	等级描述。最多支持 200 个字符。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateViewerLevelConfig&Version=2023-08-01
{
    "UpdateLevelUnits": [
        {
            "LevelId": 10086,
            "ViewerLevelConfigs": {
                "LevelName": "青铜会员",
                "Color": "#CD7F32",
                "LevelIcon": "http://example.com/icons/bronze.png",
                "Description": "刚开始观看直播的新手观众"
            }
        }
    ],
    "ViewerLevelGroupId": 123456
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateViewerLevelConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.LevelGroupID	Operation is denied because can not edit this group.	当前子账号没有指定等级库的编辑权限。您可通过 ListAccountViewerLevelGroup 接口判断子账号是否可编辑指定等级库。有关如何配置子账号的权限范围，详见子账号管理。