有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

获取歌单列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKTVPlaylists。
Version String 公共参数,本接口取值:2022-05-27。
Region String 公共参数,本接口不需要传递此参数。
AppName String 应用名称。
UserId String 用户标识。
Types.N Array of String 类型列表,取值有:
  • OfficialRec:官方推荐;
  • Customize:自定义。

  • 默认值为 OfficialRec。
    Offset Integer 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
    Limit Integer 分页返回的记录条数,默认值:20,最大值:50。

    3. 输出参数

    参数名称 类型 描述
    PlaylistBaseInfoSet Array of KTVPlaylistBaseInfo 歌单基础信息。
    TotalCount Integer 歌单总数。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取曲库歌单

    获取曲库歌单

    输入示例

    POST / HTTP/1.1
    Host: yinsuda.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeKTVPlaylists
    <公共请求参数>
    
    {
        "UserId": "11113451",
        "AppName": "test"
    }

    输出示例

    {
        "Response": {
            "TotalCount": 4,
            "PlaylistBaseInfoSet": [
                {
                    "PlaylistId": "pid-8888",
                    "Title": "热歌推荐"
                },
                {
                    "PlaylistId": "pid-23784",
                    "Title": "网络红歌"
                },
                {
                    "PlaylistId": "pid-24971",
                    "Title": "动感DJ"
                },
                {
                    "PlaylistId": "pid-6666",
                    "Title": "最新飙升"
                }
            ],
            "RequestId": "81c684e1-4b88-4c08-ba8e-16d3459893dc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。