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

文档中心

立即注册

导航

企业直播

CreateViewerLevelConfig - 新增观众等级配置

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

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ViewerLevelConfigs	Array of ViewerLevelConfigs	是	`-`	新增的等级配置信息。若指定的等级库中已存在等级，则新增的等级将按入参顺序继续在已有等级后添加。等级总数量不可超过 100 条。
ViewerLevelGroupId	Long	否	`123456`	观众等级库 ID。可通过 ListAccountViewerLevelGroup 接口获取。说明使用子账号调用接口时，确保子账号拥有对等级库的可编辑权限。有关如何配置子账号的权限范围，详见子账号管理。为保证系统兼容，您也可通过不传或将该参数设置为 `0` 来指定默认等级库（包含 3 个默认等级配置）。

ViewerLevelConfigs

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

返回参数

参数	类型	示例值	描述
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	`刚开始观看直播的新手观众`	等级描述。

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateViewerLevelConfig&Version=2023-08-01
{
    "ViewerLevelConfigs": [
        {
            "LevelName": "见习观众",
            "Color": "#808080",
            "LevelIcon": "http://example.com/icons/bronze.png",
            "Description": "刚开始观看直播的新手观众"
        }
    ],
    "ViewerLevelGroupId": 123456
}

返回示例

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

错误码

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