1. 接口描述
接口请求域名： yinsuda.tencentcloudapi.com 。
根据输入的规则匹配曲库中的歌曲。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeKTVMatchMusics。 |
| Version | 是 | String | 公共参数，本接口取值：2022-05-27。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| AppName | 是 | String | 应用名称。 示例值：超酷音乐盒子 |
| UserId | 是 | String | 用户标识。 示例值：2a7ivdfh4u |
| Rules.N | 是 | Array of KTVMatchRule | 匹配规则列表。 示例值：[{"AMEMusicId": "bmp7a8yut5","MusicInfo": {"MusicName": "反方向的钟","SingerSet": ["周杰伦","陈奕迅"]},"MusicIdToMatchAME": "hr9nqvkz46"}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MatchMusicSet | Array of KTVMatchMusic | 匹配到的歌曲列表。 示例值：[{"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"},"MatchRule": {"AMEMusicId": "bmp7a8yut5","MusicInfo": {"MusicName": "反方向的钟","SingerSet": ["周杰伦","陈奕迅"]},"MusicIdToMatchAME": "hr9nqvkz46"},"AMEMusicBaseInfo": {"MusicId": "bmp7a8yut5","Name": "反方向的钟","SingerSet": ["周杰伦","陈奕迅"]}}] |
| NotMatchRuleSet | Array of KTVMatchRule | 未匹配的规则列表。 示例值：[{"AMEMusicId": "bmp7a8yut5","MusicInfo": {"MusicName": "反方向的钟","SingerSet": ["周杰伦","陈奕迅"]},"MusicIdToMatchAME": "hr9nqvkz46"}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 匹配 AME 歌曲
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKTVMatchMusics
<公共请求参数>
{
"Rules": [
{
"AMEMusicId": "1111003-xxx2-2edd"
}
],
"UserId": "10087",
"AppName": "test"
}输出示例
{
"Response": {
"MatchMusicSet": [
{
"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"
},
"MatchRule": {
"AMEMusicId": "bmp7a8yut5",
"MusicInfo": {
"MusicName": "反方向的钟",
"SingerSet": [
"周杰伦",
"陈奕迅"
]
},
"MusicIdToMatchAME": "hr9nqvkz46"
},
"AMEMusicBaseInfo": {
"MusicId": "bmp7a8yut5",
"Name": "反方向的钟",
"SingerSet": [
"周杰伦",
"陈奕迅"
]
}
}
],
"NotMatchRuleSet": [
{
"AMEMusicId": "abc",
"MusicInfo": {
"MusicName": "abc",
"SingerSet": [
"abc"
]
},
"MusicIdToMatchAME": "abc"
}
],
"RequestId": "abc"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
