You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取直播间标签列表

最近更新时间：2023.06.28 15:22:45

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

我的收藏

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

请求说明

  • 接口名称：ListSiteTagAPIV2
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=ListSiteTagAPIV2&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数

类型

是否必选

描述

Action

String

是

接口名称。

Version

String

是

接口版本。直播当前 API 的版本为 2020-06-01。

返回参数

参数

类型

描述

SiteTags

Array of Tag

直播间分类标签信息列表。

TextSiteTags

Array of TextTag

直播间文本标签信息列表。

Tag

参数

类型

描述

Index

Int

分类标签的索引标识，用于标识标签在控制台展示的位置。

Name

String

分类标签名称。

Value

Array of String

可选的分类标签值。

Show

Int

已废弃

TextTag

参数

类型

描述

Index

Int

文本标签的索引标识，用于标识标签在控制台展示的位置。

Name

String

文本标签名称。

Value

Array of String

已废弃

Show

Int

已废弃

示例

请求示例

Get http://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":[
                  {
                        "Index":0,
                        "Name":"金融课程",
                        "Value":[
                              "张三老师",
                              "李四老师"
                        ],
                        "Show":0                     
                  },
                  {
                        "Index":1,
                        "Name":"年级",
                        "Value":[
                              "一年纪",
                              "二年级"
                        ],
                        "Show":0                        
                  }
            ],
            "TextSiteTags":[
                  {
                        "Index":0,
                        "Name":"文本内容1",
                        "Value": "",
                        "Show": 0
                  },
                  {
                        "Index":1,
                        "Name":"文本内容2",                        
                        "Value": "",
                        "Show": 0
                  }
            ]
      }
}

异常返回示例

{
     "ResponseMetadata":{
        "RequestId":"201806041104200100***",
        "Action":"ListSiteTagAPIV2",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
      }
}

错误码

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