GetViewerLevelConfig - 获取观众等级配置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetViewerLevelConfig - 获取观众等级配置

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

调用 GetViewerLevelConfig接口，获取账户中心 > 观众等级页面指定观众等级库中的等级配置信息。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetViewerLevelConfig`	接口名称。当前 API 的名称为 `GetViewerLevelConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ViewerLevelGroupId	Long	否	`123456`	观众等级库 ID。可通过 ListAccountViewerLevelGroup 接口获取。说明使用子账号调用接口时，确保等级库对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。为保证系统兼容，您也可通过不传或将该参数设置为 `0` 来指定默认等级库（包含 3 个默认等级配置）。

返回参数

参数	类型	示例值	描述
ViewerLevelMetas	Array of ViewerLevelMetas	`-`	等级配置信息。

ViewerLevelMetas

参数	类型	示例值	描述
LevelId	Long	`10086`	等级 ID。
LevelOrder	Integer	`1`	等级次序。
LevelName	String	`见习观众`	等级名称。
Color	String	`#808080`	等级名称和图标的背景颜色。
LevelIcon	String	`//example.com/icons/bronze.png`	等级图标的 URL，不包含协议头。
Description	String	`刚开始观看直播的新手观众`	等级描述。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetViewerLevelConfig&Version=2023-08-01&ViewerLevelGroupId=123456

返回示例

{
    "ResponseMetadata": {
        "Action": "GetViewerLevelConfig",
        "Region": "cn-north-1",
        "RequestId": "20230604110420****100232280022D31",
        "Service": "livesaas",
        "SystemTime": 1754275299,
        "Version": "2023-08-01"
    },
    "Result": {
        "ViewerLevelMetas": [
            {
                "Color": "#808080",
                "Description": "刚开始观看直播的新手观众",
                "LevelIcon": "//example.com/icons/bronze.png",
                "LevelId": 10086,
                "LevelName": "见习观众",
                "LevelOrder": 1
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.LevelGroupID	Operation is denied because can not edit this group.	当前子账号没有指定等级库的查看权限。使用子账号调用接口时，请确保等级库对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。