You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

更新直播间标签信息

最近更新时间：2023.11.08 09:30:20

首次发布时间：2022.08.15 11:38:49

我的收藏

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

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

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

SiteTags

参数类型是否必选示例值描述
NameString是科目分类标签名称。
ValueArray of String是["语文","数学"]分类标签值。

Show

Integer

是

0

是否显示分类标签。

  • 0：不显示
  • 1：显示
IndexInteger是1分类标签索引标识，用于标识标签在控制台展示的位置，取值为 [0,19]。

TextSiteTags

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

返回参数

参数类型示例值描述

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
  }
}

错误码

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