UpdateSiteTagAPIV2 - 更新直播间标签信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateSiteTagAPIV2 - 更新直播间标签信息

最近更新时间：2025.03.24 16:50:55首次发布时间：2022.08.15 11:38:49

更新当前账号下配置的直播间标签信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备我的直播 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateSiteTagAPIV2&Version=2020-06-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
SiteTags	Array of SiteTags	是	`-`	待更新的直播间分类标签信息列表。您可通过ListSiteTagAPI 接口查询原直播间标签信息。
TextSiteTags	Array of TextSiteTags	是	`-`	待更新的直播间文本标签信息列表。您可通过ListSiteTagAPI 接口查询原直播间标签信息。

SiteTags

参数	类型	是否必选	示例值	描述
Name	String	是	`科目`	分类标签名称。
Value	Array of String	是	`["语文","数学"]`	分类标签值。
Show	Integer	是	`0`	是否显示分类标签。 `0`：不显示 `1`：显示
Index	Integer	是	`1`	分类标签索引标识，用于标识标签在控制台展示的位置，取值为 [0,19]。

TextSiteTags

参数	类型	是否必选	示例值	描述
Name	String	是	`科目`	文本标签名称。
Index	Integer	是	`1`	文本标签索引标识，用于标识标签在控制台展示的位置，取值为 [0,4]。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否修改成功。 `true`：成功 `false`：失败

Status

Boolean

true

是否修改成功。

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateSiteTagAPIV2&Version=2020-06-01
{
    "SiteTags": [
        {
            "Name": "年级",
            "Value": [
                "一年级",
                "二年级"
            ],
            "Show": 0,
            "Index": 0
        },
        {
            "Name": "科目",
            "Value": [
                "语文",
                "数学"
            ],
            "Show": 0,
            "Index": 1
        }
    ],
    "TextSiteTags": [
        {
            "Name": "年级",
            "Index": 0
        },
        {
            "Name": "科目",
            "Index": 1
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022062820372601021***",
        "Action": "UpdateSiteTagAPIV2",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656419846
    },
    "Result": {
        "Status": true
    }
}

错误码

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