音速达直播音乐版权引擎
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 音速达直播音乐版权引擎 > API 文档 > 歌曲相关接口 > 获取歌单详情

获取歌单详情

最近更新时间：2024-03-12 02:08:02

我的收藏

本页目录：

1. 接口描述

接口请求域名： yinsuda.tencentcloudapi.com 。

根据歌单 Id 获取歌单详情。

默认接口请求频率限制：50次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeKTVPlaylistDetail。
Version 是 String 公共参数，本接口取值：2022-05-27。
Region 否 String 公共参数，本接口不需要传递此参数。
AppName 是 String 应用名称。
UserId 是 String 用户标识。
PlaylistId 是 String 歌单 Id。
ScrollToken 否 String 滚动标记。
Limit 否 Integer 返回条数，默认：20，最大：50。
RightFilters.N 否 Array of String 权益过滤，取值有：
  • Play：可播；
  • Sing：可唱。
    		•
    PlayScene 否 String 播放场景。默认为Chat
  • Live：直播
  • Chat：语聊
    		•
    MaterialFilters.N 否 Array of String 物料过滤，取值有：
  • Lyrics：含有歌词；
  • Midi：含有音高线。
    		•

    3. 输出参数

    参数名称 类型 描述
    KTVMusicInfoSet Array of KTVMusicBaseInfo 歌曲信息列表。
    ScrollToken String 滚动标记，用于设置下次请求的 ScrollToken 参数。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取歌单详情

    获取歌单详情

    输入示例

    POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKTVPlaylistDetail
<公共请求参数>

{
    "UserId": "10087",
    "PlaylistId": "pid-3dd22",
    "Limit": 10,
    "AppName": "test"
}

    输出示例

    {
    "Response": {
        "RequestId": "58bfe77f-d477-48e8-9922-55f56d0b88fb",
        "ScrollToken": "eyJDdXJQYWdlTnVtIjozLCJDdXJJbmRleCI6MH0=",
        "KTVMusicInfoSet": [
            {
                "AlbumInfo": {
                    "CoverInfoSet": [
                        {
                            "Dimension": "Mini",
                            "Url": "http://imge.xxxx.com/stdmusic/150/20191125/20191125163409414057.jpg"
                        },
                        {
                            "Dimension": "Small",
                            "Url": "http://imge.xxxx.com/stdmusic/240/20191125/20191125163409414057.jpg"
                        },
                        {
                            "Dimension": "Medium",
                            "Url": "http://imge.xxxx.com/stdmusic/480/20191125/20191125163409414057.jpg"
                        }
                    ],
                    "Name": "等"
                },
                "Duration": 216000,
                "MusicId": "mid-11x9dj3",
                "Name": "等",
                "RecommendType": "Other",
                "SingerImageUrl": "http://singerimg.xxxxx.com/uploadpic/softhead/150/20210326/20210326145830248137.jpg",
                "SingerSet": [
                    "贾振峰"
                ],
                "RightSet": [
                    "Play",
                    "Sing"
                ]
            }
        ]
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    ResourceNotFound 资源不存在。
    中国站