文档中心
KTV_Live_Chorus_Program_down 在线KTV
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 在线KTV
  • 服务端 API
  • 根据标签获取歌曲

服务端 API 版块于4月16日至5月15日升级维护,期间暂停信息更新,如有任何疑问,请联系ZEGO技术支持。

根据标签获取歌曲

更新时间:2025-04-15 19:16

1 描述

本接口调用需通过 获取标签列表 中的标签 ID,可获取对应的歌曲 ID、歌曲名、歌曲专辑、以及版权相关信息等。

相比原有 歌单 接口,本接口歌曲资源更丰富,且支持动态更新。因此,ZEGO 推荐开发者使用本接口获得歌曲列表相关内容。

2 接口原型

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

3 请求参数

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

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

参数 类型 是否必选 描述
TagId
String
是
标签 ID,通过 获取标签列表 接口获取。
Page
Number
是
第几页,从 1 开始。
Filter[]
Array of Number
否
过滤选项。
  • 1:过滤不包含词曲版权的歌曲
  • 3:过滤没有逐字歌词的歌曲
  • 4:过滤没有音高线的歌曲

4 请求示例

https://ktv-api.zego.im/?Action=DescribeTagSongs
&TagId=1107
&Page=1
&Filter[]=1
&Filter[]=3
&<公共请求参数>

以上示例表示:根据标签 ID 是 1107,通过过滤选项 1 和 3,筛选出有词曲版权且含有歌词的歌曲,展示列表第一页的内容。

5 响应参数

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

其中参数 Data:

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

其中参数 Songs:

参数 类型 描述
SongId
String
歌曲 ID。
SongName
String
歌曲名。
SingerName
String
歌手名。
SingerImg
String
歌手头像。
AlbumName
String
歌曲所属专辑名。
AlbumImg
String
专辑封面。
AlbumImgMini
String
专辑封面 100px 左右。
AlbumImgSmall
String
专辑封面 300px 左右。
AlbumImgMedium
String
专辑封面 500px 左右。
Duration
Number
歌曲时长,单位:毫秒。
HasClip
Number
是否具有长分片高潮片段资源。
  • 0:否
  • 1:是

VendorId 为 2 时,不会返回此字段。

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": [
            {
                "SingerImg": "http://singerimg.kugou.com/uploadpic/softhead/150/20210107/20210107101003717.jpg",
                "AlbumImg": "http://imge.kugou.com/stdmusic/150/20160907/20160907184908526143.jpg",
                "AlbumImgMini": "http://imge.kugou.com/stdmusic/150/20160907/20160907184908526143.jpg",
                "AlbumImgSmall": "http://imge.kugou.com/stdmusic/240/20160907/20160907184908526143.jpg",
                "AlbumImgMedium": "http://imge.kugou.com/stdmusic/480/20160907/20160907184908526143.jpg",
                "SongId": "28341435",
                "SongName": "朋友的酒",
                "SingerName": "李晓杰",
                "AlbumName": "老大",
                "Duration": 250000,
                "HasClip": 1,
                "VendorId": 2,  // 歌曲的版权方。版权方的详细信息,请联系 ZEGO 商务人员咨询
                "PitchAbility": 1, //仅当 VendorId 为 2 时,才会返回此字段
                "Copyright": {
                    "SongLyric": 1,
                    "Recording": 1,
                    "Channel": 0
                }
            }
        ]
    }
}

7 返回码

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

返回码 说明 处理建议
320000004 参数非法。 请根据 Message 提示判断非法参数,调整对应参数值。
320010000 AppId 不可用 请联系 ZEGO 技术支持开通版权音乐服务。
320010001 不支持的付费类型。 请联系 ZEGO 技术支持开通版权音乐对应的付费类型。
  • 按次计费
320050000 系统错误。 请联系 ZEGO 技术支持。
320050002 系统繁忙。 请稍后重试。
320050003 未定义的引擎错误。 请联系 ZEGO 技术支持。
320050004 引擎内部错误。 请联系 ZEGO 技术支持。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈