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

综合歌单列表查询

正式环境
https://api.kg.qq.com
正式环境
https://api.kg.qq.com
POST
/karaoke/oper/v2/multi_playlist
运营类
综合歌单列表查询,可以查询排行榜、分类专题、自建歌单、标签、个性歌单。推荐优先使用该接口查询歌单。
接口需要在Header:Client-IP里面传客户端的真实ip,不然结果可能不准确。
歌单说明: https://docs.qq.com/sheet/DSkRDbW5iTVBEbkdT?tab=BB08J2

请求参数

Header 参数
X-Open-Access-Token
string 
必需
access token
默认值:
{{X-Open-Access-Token}}
X-Open-ID
string 
openid
可选
默认值:
{{X-Open-ID}}
X-Open-App-ID
string 
业务appid
必需
默认值:
{{X-Open-App-ID}}
Device-ID
string 
可选
设备id,调用KtvSdk.getSdkImei()获取
Body 参数application/json
index
integer 
位置
可选
>= 0
nums
integer 
数量
可选
>= 1<= 50
pass_back
string 
可选
playlist_id
string 
歌单id
可选
playlist_type
string 
歌单类型
可选
示例
{
  "playlist_id": "5004",
  "playlist_type": "label",
  "index": 0,
  "nums": 20
}

示例代码

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/oper/v2/multi_playlist' \
--header 'X-Open-Access-Token;' \
--header 'X-Open-ID: ' \
--header 'X-Open-App-ID;' \
--header 'Device-ID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playlist_id": "5004",
    "playlist_type": "label",
    "index": 0,
    "nums": 20
}'

返回响应

🟢200OK
application/json
Body
detail
object (protocol.PlaylistInfo) 
可选
desc
string 
描述
可选
long_img
string 
长图
可选
square_img
string 
方图
可选
sub_title
string 
副标题
可选
title
string 
标题
可选
has_more
integer 
是否有更多
可选
mini_show_items
array[object (protocol.MiniShowItem) {9}] 
短剧列表
可选
album_cover
string 
专辑封面
可选
album_id
integer 
专辑ID
可选
album_title
string 
标题
可选
desc
string 
剧情介绍
可选
is_free
boolean 
短剧是否全免费
可选
jump_ugcid
string 
可选
跳转作品ID,一般是第一集
offline
integer 
可选
是否下架 offline=1 已下架
play_num
integer 
短剧合辑播放总量
可选
total_set
integer 
总集数
可选
next_index
integer 
可选
有更多时,下一次传的index值
pass_back
string 
可选
分页回传。若该字段有值,需要在请求下一页的时候带上
singers
array[object (protocol.SingerInfo) {5}] 
歌手信息
可选
block_mask
integer 
可选

屏蔽mask 非0时标识被屏蔽(为0时不返回) 1<<1为歌手屏蔽位

block_reason
string 
屏蔽原因
可选
singer_cover
string 
歌手图片
可选
singer_id
string 
歌手唯一id
可选
singer_name
string 
歌手名字
可选
songs
array[object (protocol.SongInfo) {31}] 
歌曲信息
可选
1080_mv_cover_size
integer 
可选
遮挡mv1080质量文件大小
1080_mv_size
integer 
可选
mv1080质量文件大小
480_mv_cover_size
integer 
可选
遮挡mv480质量文件大小
480_mv_size
integer 
可选
mv480质量文件大小
720_mv_cover_size
integer 
可选
遮挡mv720质量文件大小
720_mv_size
integer 
可选
mv720质量文件大小
album_img
string 
可选
歌曲专辑封面图片500*500
cp_status
integer 
可选

版权状态,1:有版权, [-99,0]无版权,可播, <-300,无版权,不可播

has_hq
boolean 
是否有HQ品质伴奏
可选
has_lyric
integer 
可选
(废弃)是否有字幕(0-未知 1-无字幕 2-有字幕)
has_midi
boolean 
唱歌时是否支持打分
可选
has_mv
boolean 
是否有MV
可选
has_ori_song
boolean 
歌曲是否有原唱
可选
language
integer 
可选
语种:0-国语 1-粤语 2-闽南语 3-日语 4-韩语 5-英语 6-法语 7-其他 9-纯音乐
mv_cover
string 
mv视频封面
可选
mv_has_lyric
boolean 
可选
MV是否包含KTV歌词字幕:0-无,1-有(这种情况可以不用再加载伴奏歌词了)
mv_height
integer 
mv视频高度
可选
mv_width
integer 
mv视频宽度
可选
need_vip
boolean 
是否需要VIP
可选
play_count
integer 
歌曲播放量
可选
play_duration
integer 
播放时长
可选
qqmusic_id
integer 
可选
废弃(该字段返回0)
singer_id
string 
歌手Id
可选
singer_name
string 
歌手名称
可选
song_desc
string 
歌曲描述
可选
song_id
string 
歌曲编号
可选
song_lyric_mask
integer 
可选
伴奏歌词标记,可按位判断与是否有对应的类型。(1:有qrc歌词)+(2:有lrc歌词)
song_name
string 
歌曲名称
可选
song_type
integer 
可选
歌曲类型 0-完整版 3-Live 6-Remix 100-和声
status
integer 
可选
状态 0-下架 1-正常
tag_id_list
array[integer]
可选
tagid列表。参考《TagId对照表》
total
integer 
可选
总数量。该值不一定有
ugcs
array[object (protocol.UgcItem) {20}] 
ugc作品列表
可选
content
string 
ugc描述
可选
cover_img
string 
专辑封面图片
可选
create_time
integer 
生成时间
可选
nick_name
string 
作品作者昵称
可选
play_count
integer 
播放量
可选
private
integer 
可选
为1的时候是隐私作品
qc_ugc
integer 
1-是清唱作品
可选
rec_reason
string 
可选
同城作品推荐的理由,优先使用距离,也有可能是其他文案
score
integer 
分数
可选
score_rank
integer 
可选
分数等级 0-未开起打分 1-C 2-B 3-A 4-S 5-SS 6-SSS
segment_end
integer 
可选
片段结束位置(毫秒)
segment_start
integer 
可选
片段起始位置(毫秒)
singer_name
string 
原唱歌手名称
可选
song_id
string 
可选
原唱歌曲id 清唱歌曲没有原唱,为空
song_name
string 
原唱歌曲名称
可选
ugc_id
string 
ugcid
可选
ugc_mask
integer 
可选
用于标识ugc附加属性信息,bit方式标识,具体定义见 KGE_UGC_MASK_BIT
user_age
integer 
作品作者年龄
可选
user_avatar
string 
作品作者头像
可选
user_gender
integer 
可选
作品作者性别 1:男 2:女
示例
{
  "code": 0,
  "sub_code": 0,
  "msg": "请求成功",
  "data": {
    "has_more": 0,
    "next_index": 0,
    "pass_back": "",
    "total": 10,
    "singers": [
      {
        "singer_id": "0025NhlN2yWrP4",
        "singer_name": "周杰伦",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M0000025NhlN2yWrP4.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "003nRjEX3diMiV",
        "singer_name": "刘艺雯",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000003nRjEX3diMiV.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "003RVAdJ1YT5AI",
        "singer_name": "王心凌",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000003RVAdJ1YT5AI.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "003Nz2So3XXYek",
        "singer_name": "陈奕迅",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000003Nz2So3XXYek.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "001nMsEp1RMsiO",
        "singer_name": "黄绮珊",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000001nMsEp1RMsiO.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "000PJRig3WnHYX",
        "singer_name": "希林娜依高",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000000PJRig3WnHYX.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "004Be55m1SJaLk",
        "singer_name": "张学友",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000004Be55m1SJaLk.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "002azErJ0UcDN6",
        "singer_name": "张杰",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000002azErJ0UcDN6.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "002J4UUk29y8BY",
        "singer_name": "薛之谦",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000002J4UUk29y8BY.jpg",
        "block_mask": 0,
        "block_reason": ""
      },
      {
        "singer_id": "000GDDuQ3sGQiT",
        "singer_name": "王菲",
        "singer_cover": "https://y.gtimg.cn/music/photo_new/T001R500x500M000000GDDuQ3sGQiT.jpg",
        "block_mask": 0,
        "block_reason": ""
      }
    ]
  }
}
上一页
(新)排行榜
下一页
设置缓存设备
Built with