文档中心
在线KTV
服务端 API
获取榜单歌曲

获取榜单歌曲

更新时间：2024-08-15 19:45

1 描述

通过榜单 ID 获取榜单歌曲，包含歌曲信息、歌手信息、歌曲所属专辑信息、版权信息、以及是否有伴奏等。

仅当传入的版权方 VendorId 为 “0（默认）”、“1” 或 “2” 时，才能使用本服务端接口；其余版权方不支持。版权方的详细信息，请联系 ZEGO 商务人员咨询。

2 接口原型

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

3 请求参数

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

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

参数	类型	是否必选	描述
TopId	String	是	榜单 ID。版权方 VendorId 为 “0（默认）” 或 “1” 时，对应榜单 ID 如下： 6666：最新飙升 8888：热歌推荐 23784：网络红歌 24971：动感 DJ 版权方 VendorId 为 “2” 时，对应榜单 ID 如下： 22004：大众流行（K 歌场景） 22005：经典金曲（K 歌场景） 22006：甜蜜情歌（通用场景） 22007：甜蜜情歌（K 歌场景） 22008：甜蜜情歌（听歌场景） 22009：伤感情歌（通用场景） 22010：伤感情歌（K 歌场景） 22011：伤感情歌（听歌场景） 22015：90&00 后（通用场景） 22016：90&00 后（K 歌场景） 22017：90&00 后（听歌场景） 22018：70&80 后（通用场景） 22019：70&80 后（K 歌场景） 22020：70&80 后（听歌场景） 22026：情歌对唱（K 歌场景）
Page	Number	是	第几页，从 1 开始。
Filter[]	Array of Number	否	过滤选项。 1：过滤不包含词曲权限的歌曲 3：过滤没有逐字歌词的歌曲 4：过滤没有音高线的歌曲

4 请求示例

https://ktv-api.zego.im/?Action=DescribeTopSongs
&TopId=8888
&Page=1
&Filter[]=1
&<公共请求参数>

5 响应参数

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

其中参数 Data：

参数	类型	描述
Songs	Array of JSON	歌曲列表。

其中参数 Songs：

参数	类型	描述
SongId	String	歌曲 ID。
SongName	String	歌曲名。
SingerId	String	歌手 ID。
SingerName	String	歌手名。
SingerImg	String	歌手头像。
AlbumId	String	歌曲所属专辑 ID。
AlbumName	String	歌曲所属专辑名。
AlbumImg	String	专辑封面。
AlbumImgMini	String	专辑封面 100px 左右。
AlbumImgSmall	String	专辑封面 300px 左右。
AlbumImgMedium	String	专辑封面 500px 左右。
Duration	Number	歌曲时长，单位：毫秒。
VendorId	Number	歌曲的版权方。版权方的详细信息，请联系 ZEGO 商务人员咨询。
PitchAbility	Number	是否具有音高线。 1：有 2：没有仅当 VendorId 为 2 时，才会返回此字段。
Copyright	Object	版权信息。

其中参数 Copyright：

参数	类型	描述
SongLyric	Number	是否有词曲版权，可以唱。 0：否 1：是
Recording	Number	是否有录音版权，可以播放。 0：否 1：是
Channel	Number	歌曲渠道。若 channel 为其他值，表示其他渠道歌曲。若 channel 为 0，需要在 UI 界面展示 logo 标志。开发者可通过本链接下载相关 logo 资源。UI 界面示例如下：

6 响应示例

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "1a6d02a8-66ba-455f-9e05-fe77da6a1f14",
    "Data": {
        "Songs": [
            {
                "SingerId": "123",
                "SingerImg": "http://xxx.xxx.xxx/uploadpic/softhead/150/20210506/20210506171823975.jpg",
                "AlbumImg": "http://xxx.xxx.xxx/stdmusic/150/20150719/20150719001841825066.jpg",
                "AlbumImgMini": "http://xxx.xxx.xxx/stdmusic/150/20150719/20150719001841825066.jpg",
                "AlbumImgSmall": "http://xxx.xxx.xxx/stdmusic/240/20150719/20150719001841825066.jpg",
                "AlbumImgMedium": "http://xxx.xxx.xxx/stdmusic/480/20150719/20150719001841825066.jpg",
                "SongId": "40282741",
                "SongName": "我和我的祖国",
                "SingerName": "韩红",
                "AlbumId": "345",
                "AlbumName": "红歌②",
                "Duration": 250000,
                "VendorId": 1,
                "PitchAbility": 1, //仅当 VendorId 为 2 时，才会返回此字段
                "Copyright": {
                    "SongLyric": 0,
                    "Recording": 1,
                    "Channel": 0
                }
            }
        ]
    }
}

7 返回码

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

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