获取直播间标签列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间标签列表

最近更新时间：2023.11.08 09:30:20首次发布时间：2022.08.15 11:38:28

获取当前帐号下配置的直播间标签列表。

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

参数	类型	示例值	描述
SiteTags	Array of SiteTags	`-`	直播间分类标签信息列表。
TextSiteTags	Array of TextSiteTags	`-`	直播间文本标签列表。

SiteTags

参数	类型	示例值	描述
Name	String	`年级`	分类标签名称。
Value	Array of String	`["一年级","二年级"]`	分类标签值。
Show	Integer	`0`	是否显示分类标签。 `1`：显示 `0`：不显示
Index	Integer	`1`	分类标签索引标识，用于标识标签在控制台展示的位置。

TextSiteTags

参数	类型	示例值	描述
Name	String	`文本内容`	文本标签名称。
Index	Integer	`1`	文本标签索引标识，用于标识标签在控制台展示的位置。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListSiteTagAPIV2&Version=2020-06-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022062820372601021***",
    "Action": "ListSiteTagAPIV2",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656419846
  },
  "Result": {
    "SiteTags": [
      {
        "Name": "金融课程",
        "Value": [
          "张三老师",
          "李四老师"
        ],
        "Show": 1,
        "Index": 0
      },
      {
        "Name": "年级",
        "Value": [
          "一年级",
          "二年级"
        ],
        "Show": 0,
        "Index": 1
      }
    ],
    "TextSiteTags": [
      {
        "Name": "文本内容",
        "Index": 0
      },
      {
        "Name": "文本内容",
        "Index": 1
      }
    ]
  }
}

错误码

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