1. 接口描述
接口请求域名: yinsuda.tencentcloudapi.com 。
批量获取歌曲详细信息,包括:歌词下载链接、播放凭证、音高数据下载链接信息等。
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BatchDescribeKTVMusicDetails。 |
Version | 是 | String | 公共参数,本接口取值:2022-05-27。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AppName | 是 | String | 应用名称。 示例值:app-test |
UserId | 是 | String | 用户标识。 示例值:7jd457rjz2 |
MusicIds.N | 是 | Array of String | 歌曲 Id 列表。 示例值:["ttxvqa4buy","c2ez447xpd"] |
PlayScene | 否 | String | 播放场景。默认为Chat 示例值:Chat |
GuestUserId | 否 | String | 玩家用户标识 示例值:d2w7m6t9z8 |
RoomId | 否 | String | 房间Id 示例值:29ds5emhuf |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
KTVMusicDetailInfoSet | Array of KTVMusicDetailInfo | 歌曲详细信息列表。 示例值:[{"KTVMusicBaseInfo": {"MusicId": "3mcwprujq9","Name": "七里香","SingerSet": ["周杰伦"],"Duration": 120,"SingerImageUrl": "http://image.tencent.com","AlbumInfo": {"Name": "一个浪漫的专辑","CoverInfoSet": [{"Dimension": "Mini","Url": "http://download.tencent.com"}]},"RightSet": ["Play"],"RecommendType": "Featured"},"PlayToken": "4g8jfa9bjz","LyricsUrl": "http://download.tencent.com","MidiUrl": "http://download.tencent.com","ChorusClipSet": [{"Type": "Slow","Value": 100}],"PreludeInterval": 100,"GenreSet": ["2a7ivdfh4u","pejyjvfitc"],"BPMInfo": {"Type": "Slow","Value": 100}}] |
NotExistMusicIdSet | Array of String | 不存在歌曲Id列表。 示例值:["7jd457rjz2"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量获取曲目详情
批量获取曲目详情
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchDescribeKTVMusicDetails
<公共请求参数>
{
"UserId": "userid1",
"MusicIds": [
"mid-47n6qwV1",
"testdddd"
],
"AppName": "AppName1",
"PlayScene": "Live",
"GuestUserId": "userid2",
"RoomId": "1883"
}
输出示例
{
"Response": {
"KTVMusicDetailInfoSet": [
{
"ChorusClipSet": [
{
"EndTime": 55206,
"StartTime": 37988
}
],
"KTVMusicBaseInfo": {
"AlbumInfo": {
"CoverInfoSet": [
{
"Dimension": "Mini",
"Url": "http://imge.xxxx.com/stdmusic/150/20220521/20220521000237730193.jpg"
},
{
"Dimension": "Small",
"Url": "http://imge.xxxx.com/stdmusic/240/20220521/20220521000237730193.jpg"
},
{
"Dimension": "Medium",
"Url": "http://imge.xxxx.com/stdmusic/480/20220521/20220521000237730193.jpg"
}
],
"Name": "予·君"
},
"Duration": 210051,
"MusicId": "mid-47n6qwV1",
"Name": "踏雪",
"RightSet": [
"Play",
"Sing"
],
"SingerImageUrl": "http://singerimg.xxxx.com/uploadpic/softhead/150/20220329/20220329151558179.jpg",
"SingerSet": [
"等什么君(邓寓君)",
"FOX胡天渝"
],
"RecommendType": "Other"
},
"LyricsUrl": "https://mcetest.ame.qcloud.com/download?sign=xxxxx&source=%2FLyrics%2F47n6qwV1%2Fsubtitle.vtt&t=1653897260&us=1300054767_test_1111",
"MidiUrl": "https://mcetest.ame.qcloud.com/download?sign=xxxx&source=%2FPitch%2F47n6qwV1%2Fmusic.pitch&t=1653897260&us=1300054767_test_1111",
"PlayToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBcHBJZCI6MTMwMDA1NDc2NywiQXBwTmFtZSI6InRlc3QiLCJDdXJUaW1lIjowLCJFeHBpcmVUaW1lIjoxNjUzOTA0NDYwLCJNdXNpY0lkIjoibWlkLTQ3bjZxd1YxIiwiVXNlcklkIjoiMTExMSJ9.xxxxxiwlc",
"GenreSet": [
"fg"
],
"PreludeInterval": 12,
"BPMInfo": {
"Type": "axx",
"Value": 12
}
}
],
"NotExistMusicIdSet": [
"testdddd"
],
"RequestId": "8319127f-4284-4ac1-af40-8b195582256a"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.UserLiveVipTimeExpire | 直播会员已经过期 |
FailedOperation.UserNotLiveVip | 非直播会员用户 |