文档中心
歌单接口
服务端 API
获取歌单分类列表

获取歌单分类列表

更新时间：2023-07-03 12:07

1 描述

获取歌单的分类列表，包含分类 ID、分类名称。

2 接口原型

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

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

4 请求示例

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

5 响应参数

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

其中参数 Data：

参数	类型	描述
Groups	Array of JSON	歌单分组列表。

其中参数 Groups：

参数	类型	描述
GroupId	String	歌单分组 ID。
GroupName	String	歌单分组名称。
Categories	Array of JSON	分类列表。

其中参数 Categories：

参数	类型	描述
CategoryId	String	歌单分类 ID。
CategoryName	String	歌单分类名称。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "Data": {
        "Groups": [
            {
                "GroupId": "2",
                "GroupName": "语种",
                "Categories": [
                    {
                        "CategoryId": "84",
                        "CategoryName": "国语"
                    }
                ]
            }
        ]
    }
}

7 返回码

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