提交工单
咨询集成、功能及报价等问题
通过输入关键词搜索歌曲,同时在多家版权方曲库中搜索查询,支持对搜索结果筛选、排序等。搜索结果包含歌曲信息、歌手信息、歌曲所属专辑信息、版权信息、以及是否有伴奏等。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Keyword |
String |
是 |
关键词。 |
Page |
Number |
是 |
第几页,从 1 开始。 |
Filter[] |
Array of Number |
否 |
过滤选项。
|
VendorsId[] |
Array of Number |
否 |
需要进行搜索的版权方 ID 列表。默认支持搜索所有的版权方。 版权方的详细信息,请联系 ZEGO 商务人员咨询。 |
KeepVendor |
Number |
否 |
同一歌曲在多个版权方都存在资源时,在搜索结果中指定保留的版权方 ID。 版权方的详细信息,请联系 ZEGO 商务人员咨询。 |
Items[] |
Array of Number |
否 |
版权方条目,对应 VendorsId[] 参数中的各个版权方的展示条目,默认每个版权方各取一条展示。 |
如果您填写了 VendorsId[] 和 Items[] 参数(不使用默认配置),请注意确保 VendorsId[] 中的版权方和 Items[] 中的版权方条目是一一对应的,否则调用本接口将会出错。
https://ktv-api.zego.im/?Action=QuerySongPlus
&Keyword=我和我的祖国
&Page=1
&Filter[]=1
&VendorsId[]=1
&VendorsId[]=2
&KeepVendor=1
&Items[]=1
&Items[]=2
&<公共请求参数>
参数 | 类型 | 描述 |
---|---|---|
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 |
是否具有音高线。
仅当 VendorId 为 2 时,才会返回此字段。 |
HasShortSegment |
Number |
是否具有短分片高潮片段资源。
仅当 VendorId 为 2 时,才会返回此字段。 |
Copyright |
Object |
版权信息。 |
其中参数 Copyright:
参数 | 类型 | 描述 |
---|---|---|
SongLyric |
Number |
是否有词曲版权,可以唱。
|
Recording |
Number |
是否有录音版权,可以播放。
|
Channel |
Number |
歌曲渠道。
|
{
"Code": 0,
"Message": "succeed",
"RequestId": "1a6d02a8-66ba-455f-9e05-fe77da6a1f14",
"Data": {
"Songs": [
{
"SingerImg": "http://xxx.xxx.xxx/uploadpic/softhead/150/20210506/20210506171823975.jpg",
"AlbumId": "123",
"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": "我和我的祖国",
"SingerId": "2345",
"SingerName": "韩红",
"AlbumName": "红歌②",
"Duration": 250000,
"VendorId": 2, // 歌曲的版权方。版权方的详细信息,请联系 ZEGO 商务人员咨询
"PitchAbility": 1, //仅当 VendorId 为 2 时,才会返回此字段
"HasShortSegment": 1, //仅当 VendorId 为 2 时,才会返回此字段
"Copyright": {
"SongLyric": 0,
"Recording": 1,
"Channel": 0
}
}
]
}
}
以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
320000004 | 参数非法。 | 请根据 Message 提示判断非法参数,调整对应参数值。 |
320010000 | AppId 不可用 | 请联系 ZEGO 技术支持开通版权音乐服务。 |
320010001 | 不支持的付费类型。 | 请联系 ZEGO 技术支持开通版权音乐对应的付费类型。
|
320050000 | 系统错误。 | 请联系 ZEGO 技术支持。 |
320050002 | 系统繁忙。 | 请稍后重试。 |
320050003 | 未定义的引擎错误。 | 请联系 ZEGO 技术支持。 |
320050004 | 引擎内部错误。 | 请联系 ZEGO 技术支持。 |
联系我们
文档反馈