You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

更新直播间标签信息

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

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

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

注意

在调用本接口前,您需要先调用 ListSiteTagAPIV2 接口。在调用本接口时,按需修改 ListSiteTagAPIV2 接口的返回参数值并传入本接口。为保证参数值不被删除,即便某些标签信息无需修改,也需要将未修改的返回参数值传入本接口。

请求说明

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

请求参数

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

Query

参数

类型

是否必选

描述

Action

String

接口名称。

Version

String

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

Body

参数

类型

是否必选

描述

SiteTags

Array of Tag

直播间分类标签信息列表。您可以通过调用 ListSiteTagAPIV2 接口查询直播间的标签信息。

TextSiteTags

Array of TextTag

直播间文本标签信息列表。您可以通过调用 ListSiteTagAPIV2 接口查询直播间的标签信息。

Tag

参数

类型

是否必选

描述

Index

Int

分类标签的索引标识,用于标识分类标签在控制台展示的位置,取值范围为[0,19]。

Name

String

分类标签名称。

Value

Array of String

可选的分类标签值。

Show

Int

已废弃

TextTag

参数

类型

是否必选

描述

Index

Int

文本标签的索引标识,用于标识文本标签在控制台展示的位置,取值范围为[0,4]。

Name

String

文本标签名称。

Value

Array of String

已废弃

Show

Int

已废弃

返回参数

参数

类型

描述

Status

Boolean

是否更新成功。

  • true:成功
  • false:失败

示例

请求示例

Post http://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
      }       
}

异常返回示例

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

错误码

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