获取标签列表

描述

通过获取标签列表，可以知道歌曲资源的标签列表、标签分组名称、标签 ID、标签名称等信息。

说明

相比原有歌单接口，本接口歌曲资源更丰富，且支持动态更新。因此，ZEGO 推荐开发者使用本接口获得歌曲列表相关内容。
调用根据标签获取歌曲接口需要根据标签 ID 获取对应的歌曲资源。

接口原型

请求方法：GET
请求地址：https://ktv-api.zego.im/?Action=DescribeTags
传输协议：HTTPS
调用频率限制：200 次/秒

请求参数

本接口仅需要传入公共参数即可调用，完整公共参数列表请参考调用方式 - 公共请求参数。

说明

在线 KTV 服务端接口的公共请求参数与实时音视频、实时语音的不同，包含了 VendorId（版权方 ID），请务必阅读上述参考文档。

请求示例

Untitled

https://ktv-api.zego.im/?Action=DescribeTags
&<公共请求参数>

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Data	Object	响应结果，详情可见Data。

Data

参数	类型	描述
Groups	Array of JSON	响应结果，详情可见Groups。

Groups

参数	类型	描述
GroupId	String	标签分组 ID。
GroupName	String	标签分组名称。
Tags	Array of JSON	标签列表，详情可见Tags。

参数	类型	描述
TagId	String	标签 ID，具备唯一性。
TagName	String	标签名称。

响应示例

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "Data": {
        "Groups": [
            {
                "GroupId": "5",
                "GroupName": "场景",
                "Tags": [
                    {
                        "TagId": "587",
                        "TagName": "学习"
                    }
                ]
            }
        ]
    }
}

Copied!

返回码

以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
320000004	参数非法。	请根据 Message 提示判断非法参数，调整对应参数值。
320010000	AppId 不可用	请联系 ZEGO 技术支持开通版权音乐服务。
320010001	不支持的付费类型。	请联系 ZEGO 技术支持开通版权音乐对应的付费类型。按次计费
320050000	系统错误。	请联系 ZEGO 技术支持。
320050002	系统繁忙。	请稍后重试。
320050003	未定义的引擎错误。	请联系 ZEGO 技术支持。
320050004	引擎内部错误。	请联系 ZEGO 技术支持。