全民K歌IOT开放平台
  1. 基础类
全民K歌IOT开放平台
  • 厂商合作流程
  • 快速接入K歌开放平台流程
  • SDK bug提单规范
  • 如何在线调试接口
  • 常见问题FAQ
  • 开放平台API错误码说明
  • 开放平台接入指南
    • 登录鉴权方式介绍V2(推荐)
    • 如何申请接入
    • CDK权限申请流程
    • 暗账号绑定明账号对接文档
    • 获取应用级token
      POST
    • 获取登录二维码
      POST
    • 查询二维码的状态
      POST
    • 获取用户级token
      POST
    • 刷新用户级token
      POST
  • 基础类
    • tagId对照表
    • 歌曲详情
      POST
    • 查询mv的播放地址
      POST
    • 搜索
      POST
    • 搜索联想
      POST
    • 查询歌手歌曲
      POST
    • 获取歌曲歌词文件
      POST
    • Q音歌曲mid映射K歌
      POST
    • 短剧播放链接
      POST
    • 查询应用限免配置
      POST
    • 转换Q音或酷狗歌曲ID
      POST
  • 运营类
    • 排行榜id说明
    • 获取城市id列表
      GET
    • 获取专题分类列表
      POST
    • 获取云端配置
      POST
    • 热门ugc
      POST
    • 热搜词
      POST
    • 排行榜
      POST
    • 获取专题下歌曲信息
      POST
    • 获取车联渠道映射
      POST
    • 热门推荐
      POST
    • (新)排行榜
      POST
    • 综合歌单列表查询
      POST
    • 设置缓存设备
      POST
    • TV版分类歌单列表
      POST
    • 获取用户协议
      POST
    • 综合歌单列表查询(海外)
      POST
    • 榜单列表查询(海外)
      POST
    • 自建歌单列表查询(海外)
      POST
    • 获取广告配置
      POST
    • 拉取短剧合集的列表
      POST
  • 用户类
    • 用户信息查询
    • 删除用户UGC作品
    • 获取推荐/翻唱作品
    • 获取同城作品
    • 用户作品列表
    • 获取好友作品
    • UGC作品详情
    • 更改作品访问权限
    • 用户个推歌单
  • 支付类
    • 支付接入流程
    • 订单发货使用简述
    • 开通设备会员限免简述
    • 订单发货中通用sign计算规则
    • 通用返回结构
    • 【CDK】CDK兑换
    • 【CDK】生成CDK
    • 【CDK】CDK召回
    • 【CDK】CDK状态查询
    • 【三方支付】订单发货
    • 【三方支付】手机号发货
    • 【三方支付】订单状态查询
    • 【米大师支付】获取会员商品列表
    • 【米大师支付】未登录-查询会员商品列表
    • 【米大师支付】支付下单
    • 【米大师支付】支付成功通知
    • 【米大师支付】查询用户支付成功订单记录
    • 查询设备以及用户是否有赠送资格
    • 查询设备限免剩余时长
    • 设备会员迁移
    • 查询会员赠送时长
    • 同步支付订单接口
    • 【三方支付】存量会员迁移领取查询
    • 【三方支付】存量会员迁移接口
    • 授权设备体验会员
    • 查询用户会员信息
    • 【三方支付】超会发货
    • 取消授权设备体验会员
  • 用户作品-文件类
    • callback_url说明
    • 上传音频源文件
    • (服务端)上传音频作品的链接
  • 通用类
    • 【厂商定制】匹配搜索
    • 获取kg的短链接
  1. 基础类

搜索

正式环境
https://api.kg.qq.com
正式环境
https://api.kg.qq.com
POST
/karaoke/base/v2/search
搜索相关歌曲、歌手、MV等内容。
因为接口数据有过滤,所以每次请求20条时,返回的数据可能不足20条。
我们客户端都是这样处理,比如界面1页显示20条数据,我们就每一次请求30条数据。
当不足一页需要请求下一页时,通过上一页接口中返回的nextIndex和hasMore确认startPage,即下一页要从哪一条开始请求。
如果nextIndex没有,则只看hasMore。
if (it.nextIndex >= 0 && it.hasMore) {
startPage = it.nextIndex
}
直到has_more为false。
总数total不一定准,每次接口请求回来的总数都会刷新到界面上。
【2024.09.20更新】
新增语种分类lang_category参数,用于限定搜索的语种或者类别分类。目前支持的限定词有:
语种类:国语,粤语,闽南语,英语,日语,韩语,泰语,马来语,印尼语,越南语,菲律宾语
戏曲类:黄梅戏、京剧、粤剧、秦腔、越剧、潮剧、豫剧、沪剧、二人转

请求参数

Header 参数

Body 参数application/json

示例
{
    "start_page": 1,
    "page_num": 3,
    "word": "周杰伦",
    "content": 4,
    "action": 2
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.kg.qq.com/karaoke/base/v2/search' \
--header 'X-Open-Access-Token;' \
--header 'X-Open-ID;' \
--header 'X-Open-App-ID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_page": 1,
    "page_num": 3,
    "word": "周杰伦",
    "content": 4,
    "action": 2
}'

返回响应

🟢200OK
application/json
Body

示例
{
    "code": 0,
    "sub_code": 0,
    "msg": "请求成功",
    "data": {
        "singers": [
            {
                "singer_id": "0025NhlN2yWrP4",
                "singer_name": "周杰伦",
                "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M0000025NhlN2yWrP4.jpg",
                "block_mask": 0,
                "block_reason": ""
            },
            {
                "singer_id": "004Frj3P4Emgu1",
                "singer_name": "周杰伦微博台",
                "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000004Frj3P4Emgu1.jpg",
                "block_mask": 0,
                "block_reason": ""
            },
            {
                "singer_id": "002Kzqzz3qM8Yq",
                "singer_name": "周周后援会",
                "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000002Kzqzz3qM8Yq.jpg",
                "block_mask": 0,
                "block_reason": ""
            }
        ],
        "songs": [
            {
                "status": 1,
                "song_id": "003rw1nY0qfb6w",
                "song_name": "爱情废柴",
                "album_img": "https://y.gtimg.cn/music/photo_new/T002R500x500M000003RMaRI1iFoYd.jpg",
                "singer_id": "0025NhlN2yWrP4",
                "singer_name": "周杰伦",
                "song_type": 0,
                "play_count": 14283295,
                "play_duration": 285,
                "has_mv": true,
                "has_hq": true,
                "has_ori_song": true,
                "has_midi": true,
                "mv_has_lyric": false,
                "cp_status": 1,
                "need_vip": false,
                "qqmusic_id": 0,
                "language": 0
            },
            {
                "status": 1,
                "song_id": "002FVh9i1aaAav",
                "song_name": "枫",
                "album_img": "https://y.gtimg.cn/music/photo_new/T002R500x500M0000024bjiL2aocxT.jpg",
                "singer_id": "0025NhlN2yWrP4",
                "singer_name": "周杰伦",
                "song_type": 0,
                "play_count": 33982686,
                "play_duration": 280,
                "has_mv": true,
                "has_hq": true,
                "has_ori_song": true,
                "has_midi": true,
                "mv_has_lyric": false,
                "cp_status": -1,
                "need_vip": false,
                "qqmusic_id": 0,
                "language": 0
            },
            {
                "status": 1,
                "song_id": "002l2FkL3o6F26",
                "song_name": "搁浅",
                "album_img": "https://y.gtimg.cn/music/photo_new/T002R500x500M000003DFRzD192KKD.jpg",
                "singer_id": "0025NhlN2yWrP4",
                "singer_name": "周杰伦",
                "song_type": 0,
                "play_count": 59001395,
                "play_duration": 262,
                "has_mv": true,
                "has_hq": true,
                "has_ori_song": true,
                "has_midi": true,
                "mv_has_lyric": false,
                "cp_status": -1,
                "need_vip": false,
                "qqmusic_id": 0,
                "language": 0
            }
        ],
        "mvs": null,
        "total_num": 15515,
        "has_more": true
    }
}
修改于 2025-03-26 02:27:45
上一页
查询mv的播放地址
下一页
搜索联想
Built with