全民K歌IOT开放平台
    全民K歌IOT开放平台
    • 厂商合作流程
    • 快速接入K歌开放平台流程
    • SDK bug提单规范
    • 如何在线调试接口
    • 常见问题FAQ
    • 开放平台API错误码说明
    • 开放平台接入指南
      • 登录鉴权方式介绍V2(推荐)
      • 如何申请接入
      • CDK权限申请流程
      • 暗账号绑定明账号对接文档
      • 全民K歌暗账号登录方案
      • 获取应用级token
        POST
      • 获取登录二维码
        POST
      • 查询二维码的状态
        POST
      • 获取用户级token
        POST
      • 刷新用户级token
        POST
      • 暗账号解绑K歌uid
        POST
      • 获取暗账号绑定信息
        POST
    • KtvSDK3.0接入说明
      • KtvSDK-接入指南
      • KtvSDK-打分
      • KtvSDK-登录
      • KtvSDK-歌词
      • KtvSDK-播放
      • KtvSDK-作品录音、合成与播放2.0版
      • KtvSDK-播放页实现示例
      • KtvSDK-常见问题FAQ
      • KtvSDK-低性能设备处理
      • KtvSDK-反馈
      • KtvSDK-缓存管理
      • KtvSDK-切换音频视频清晰度
      • KtvSDK-跳过前奏
      • Ktv支付-米大师支付
      • KtvSDK-播放失败错误码说明
      • KtvSDK-3.0版本新功能
      • KtvSDK-2.0升级到3.0版本迁移指南
      • KtvSDK-多屏渲染
      • KtvSDK-多屏一起唱---歌词与打分适配
      • KtvSDK-Android4.4设备G2证书兼容处理
      • KtvSDK-APP上报
      • KtvSdk-离线缓存与离线播放
      • KtvSDK-3.0升级到4.0版本迁移指南
    • 基础类
      • tagId对照表
      • 歌曲详情
      • 查询mv的播放地址
      • 搜索
      • 搜索联想
      • 查询歌手歌曲
      • 获取歌曲歌词文件
      • Q音歌曲mid映射K歌
      • 短剧播放链接
      • 查询应用限免配置
      • 转换Q音或酷狗歌曲ID
      • 搜索(海外)
      • 查询歌手类型列表(海外)
      • 查询歌手列表(海外)
      • 查询热门歌手列表(海外)
    • 运营类
      • 排行榜id说明
      • 获取城市id列表
      • 获取专题分类列表
      • 获取云端配置
      • 热门ugc
      • 热搜词
      • 排行榜
      • 获取专题下歌曲信息
      • 获取车联渠道映射
      • 热门推荐
      • (新)排行榜
      • 综合歌单列表查询
      • 设置缓存设备
      • TV版分类歌单列表
      • 获取用户协议
      • 综合歌单列表查询(海外)
      • 榜单列表查询(海外)
      • 自建歌单列表查询(海外)
      • 获取广告配置
      • 拉取短剧合集的列表
      • 获取渠道运营位配置
      • 查询合唱榜单
      • 上报合唱榜单
      • OTA升级版本检查
    • 用户类
      • 用户信息查询
      • 删除用户UGC作品
      • 获取推荐/翻唱作品
      • 获取同城作品
      • 用户作品列表
      • 获取好友作品
      • UGC作品详情
      • 更改作品访问权限
      • 用户个推歌单
    • 支付类
      • 支付接入流程
      • 订单发货使用简述
      • 开通设备会员限免简述
      • 订单发货中通用sign计算规则
      • 通用返回结构
      • 【CDK】CDK兑换
      • 【CDK】生成CDK
      • 【CDK】CDK召回
      • 【CDK】CDK状态查询
      • 【三方支付】订单发货
      • 【三方支付】手机号发货
      • 【三方支付】订单状态查询
      • 【米大师支付】获取会员商品列表
      • 【米大师支付】未登录-查询会员商品列表
      • 【米大师支付】支付下单
      • 【米大师支付】支付成功通知
      • 【米大师支付】查询用户支付成功订单记录
      • 查询设备以及用户是否有赠送资格
      • 查询设备限免剩余时长
      • 设备会员迁移
      • 查询会员赠送时长
      • 同步支付订单接口
      • 【三方支付】存量会员迁移领取查询
      • 【三方支付】存量会员迁移接口
      • 授权设备体验会员
      • 查询用户会员信息
      • 【三方支付】超会发货
      • 取消授权设备体验会员
    • 用户作品-文件类
      • callback_url说明
      • 上传音频源文件
      • (服务端)上传音频作品的链接
    • 通用类
      • 【厂商定制】匹配搜索
      • 获取kg的短链接
      • 三方厂商通用上报
    • KtvSdk4.0接入说明
      • KtvSdk4.0接入文档
      • PK与合唱接入
      • 动效歌词接入文档
      • 手麦接入文档
      • 支持调整录制时长限制
    • 数据模型
      • Schemas
        • protocal.DelUserWorkReq
        • protocal.BarDisplay
        • protocal.GetLyricUrlReq
        • protocal.ConfigItem
        • multipart.FileHeader
        • protocal.ExchangeCdkeyReq
        • protocal.GetLyricUrlRsp
        • protocal.DelUserWorkRsp
        • protocal.GetVipProductRsp
        • protocal.GetChannelReq
        • protocal.ExchangeCdkeyRsp
        • protocal.GetMvUrlReq
        • protocal.GetHitedSongListReq
        • protocal.GoodsInfo
        • protocal.GetChannelRsp
        • protocal.ClientUgcUploadRsp
        • protocal.GetLimitFreeRestTimeReq
        • protocal.GetMvUrlRsp
        • protocal.GetHitedSongListRsp
        • protocal.VipAdItem
        • protocal.GetClassReq
        • protocal.DeleteFileReq
        • protocal.GetLimitFreeRestTimeRsp
        • protocal.GetSongInfoByQmIDReq
        • protocal.GetRecommWorkReq
        • protocal.WebOrderNotifyReq
        • protocal.GetClassRsp
        • protocal.DeleteFileRsp
        • protocal.GetPresentVipConfReq
        • protocal.GetSongInfoByQmIDRsp
        • protocal.GetRecommWorkRsp
        • protocal.WebOrderNotifyRsp
        • protocal.GetConfigReq
        • protocal.UgcUploadReq
        • protocal.GetPresentVipConfRsp
        • protocal.GetSongInfoReq
        • protocal.GetUserInfoReq
        • protocal.GetConfigRsp
        • protocal.UgcUploadRsp
        • protocal.OpenDeviceLimitReq
        • protocal.WebOrderStatusReq
        • protocal.GetSongInfoRsp
        • protocal.GetUserInfoRsp
        • protocal.GetHomePageReq
        • textproto.MIMEHeader
        • protocal.PresentNormalVipReq
        • protocal.WebOrderStatusRsp
        • protocal.GetSongUrlReq
        • protocal.GetUserWorkReq
        • protocal.GetHomePageRsp
        • protocal.PresentNormalVipRsp
        • protocal.GetSongUrlRsp
        • protocal.GetUserWorkRsp
        • protocal.GetHotRecomUgcReq
        • protocal.MvInfo
        • protocal.GetVipInfoRsp
        • protocal.GetHotRecomUgcRsp
        • protocal.SearchReqV2
        • protocal.GetWorkInfoReq
        • protocal.GetHotWordsReq
        • protocal.SearchRsp
        • protocal.GetWorkInfoRsp
        • protocal.GetHotWordsRsp
        • protocal.SingerInfo
        • protocal.SetUgcAccessRightReq
        • protocal.HomePageItem
        • protocal.SingerSongsFilterReq
        • protocal.SetUgcAccessRightRsp
        • protocal.PlayList
        • protocal.SingerSongsFilterRsp
        • protocal.RankSongReq
        • protocal.SingerSongsReq
        • protocal.UgcItem
        • protocal.RankSongRsp
        • protocal.SingerSongsRsp
        • protocal.UserFeatureSongReq
        • protocal.RecommendReq
        • protocal.SongContentStr
        • protocal.UserFeatureSongRsp
        • protocal.RecommendRsp
        • protocal.SongInfo
        • protocal.SongInfoPlus
        • protocal.Theme
        • protocal.TCLGetOpenIdReq
        • protocal.ThemeClass
        • protocal.TCLGetOpenIdRsp
        • protocal.ThemeSongsByIdReq
        • protocal.ThemeSongsByIdRsp
        • protocal.UgcItemInfo
        • protocal.Word
        • protocol.PresentNormalVipReq
        • protocol.UgcUploadRsp
        • protocol.SingerSongsRsp
        • protocol.TCLGetOpenIdRsp
        • protocol.RecommendRsp
        • protocol.Word
        • protocol.UserFeatureSongRsp
        • protocol.CheckDeviceEligibleReq
        • protocol.GetCollectListReq
        • protocol.AddCollectListReq
        • protocol.SongInfo
        • protocol.DelCollectListReq
        • protocol.VipAdItem
        • protocol.WebOrderStatusRsp
        • protocol.ClientUgcUploadReq
        • protocol.GetTopListRsp
        • protocol.OpenDeviceVipRsp
        • protocol.RefundDeviceVipReq
        • protocol.GetLyricUrlRsp
        • protocol.GetSongInfoByQmIDReq
        • protocol.GetSongInfoRsp
        • protocol.GetSongUrlRsp
        • protocol.SearchRsp
        • protocol.SingerSongsFilterReq
        • protocol.SongInfoPlus
        • protocol.GetLyricUrlReq
        • protocol.GetMvUrlReq
        • protocol.GetMvUrlRsp
        • protocol.GetSongInfoByQmIDRsp
        • protocol.GetSongInfoReq
        • protocol.GetSongUrlReq
        • protocol.MvInfo
        • protocol.SearchReqV2
        • protocol.SingerInfo
        • protocol.SingerSongsFilterRsp
        • protocol.SingerSongsReq
        • protocol.SongContentStr
        • protocol.DelCollectListRsp
        • protocol.GetHitedSongListRsp
        • protocol.GetUserWorkReq
        • protocol.GetUserWorkRsp
        • protocol.GetWorkInfoRsp
        • protocol.SetUgcAccessRightRsp
        • protocol.DelUserWorkReq
        • protocol.AddCollectListRsp
        • protocol.DelUserWorkRsp
        • protocol.GetHitedSongListReq
        • protocol.GetCollectListRsp
        • protocol.GetRecommWorkReq
        • protocol.GetUserInfoReq
        • protocol.GetUserInfoRsp
        • protocol.GetRecommWorkRsp
        • protocol.GetVipInfoRsp
        • protocol.GetWorkInfoReq
        • protocol.SetUgcAccessRightReq
        • protocol.UgcItem
        • protocol.UserFeatureSongReq
        • protocol.GoodsInfo
        • protocol.WebOrderNotifyRsp
        • protocol.GetVipProductRsp
        • protocol.BarDisplay
        • protocol.OpenDeviceVipReq
        • protocol.RefundDeviceVipRsp
        • protocol.WebOrderNotifyReq
        • protocol.WebOrderStatusReq
        • protocol.ExchangeCdkeyRsp
        • protocol.GetPresentVipConfRsp
        • protocol.PresentNormalVipRsp
        • protocol.GetLimitFreeRestTimeReq
        • protocol.GetLimitFreeRestTimeRsp
        • protocol.ExchangeCdkeyReq
        • protocol.GetPresentVipConfReq
        • protocol.OpenDeviceLimitReq
        • protocol.GetClassRsp
        • protocol.GetHomePageReq
        • protocol.GetHotRecomUgcReq
        • protocol.GetHotRecomUgcRsp
        • protocol.GetTopListReq
        • protocol.RankSongRsp
        • protocol.RecommendReq
        • protocol.ThemeClass
        • protocol.ThemeSongsByIdRsp
        • protocol.ConfigItem
        • protocol.GetChannelReq
        • protocol.GetChannelRsp
        • protocol.GetClassReq
        • protocol.GetConfigReq
        • protocol.GetConfigRsp
        • protocol.GetHomePageRsp
        • protocol.GetHotWordsReq
        • protocol.GetHotWordsRsp
        • protocol.HomePageItem
        • protocol.PlayList
        • protocol.RankSongReq
        • protocol.Theme
        • protocol.ThemeSongsByIdReq
        • protocol.UgcItemInfo
        • protocol.GetShortUrlReq
        • protocol.GetShortUrlRsp
        • protocol.SearchHintRsp
        • protocol.SearchHintReq
        • protocol.MultiPlaylistRsp
        • protocol.PlaylistInfo
        • protocol.MultiPlaylistReq
        • protocol.GetPayOrderListReq
        • protocol.GetPayOrderListRs p
        • protocol.GetUserVipInfoReq
        • protocol.GetUserVipInfoRsp
        • protocal.GetTvPlaylistSetReq
        • protocol.Playlist
        • protocol.GetTvPlaylistSetRsp
        • protocol.TvChorusUser
        • protocol.ClientUgcUploadRsp
        • protocol.Episode
        • protocol.UgcUploadReq
        • protocol.GenerateNewOrderCdkReq
        • protocol.GetMiniShowUrlReq
        • protocol.GenerateNewOrderCdkRsp
        • protocol.DeleteFileReq
        • protocol.GetVipProductReq
        • protocol.GetMiniShowUrlRsp
        • protocol.DeleteFileRsp
        • protocol.MergerQrCode
        • protocol.GetSdkTokenReq
        • protocol.GetSdkTokenRsp
        • protocol.PlacePayOrderReq
        • protocol.PlacePayOrderRsp
        • protocol.QueryReceiveTransferVipReq
        • protocol.QueryReceiveTransferVipRsp
        • protocol.ReceiveTransferVipReq
        • protocol.ReceiveTransferVipRsp
        • protocol.RecallNewCDKReq
        • protocol.QueryNewCDKReq
        • protocol.QueryNewCDKRsp
        • protocol.OpenDeviceLimitRsp
        • protocol.RecallNewCDKRsp
        • protocol.WebThirdpartyOrderReq
        • protocol.GetMiniShowCollectionReq
        • protocol.WebThirdpartyOrderRsp
        • protocol.GetMiniShowCollectionRsp
        • protocol.MiniShowItem
        • protocol.TCLGetOpenIdReq

    常见问题FAQ

    tips:有什么问题,可使用智能问答平台进行咨询。
    https://developer.y.qq.com/kgAiChat

    Q:1. 正式环境接口和测试环境接口有什么区别?#

    A:正式环境接口访问的是我们正式环境的接口,速度更快,服务也更稳定。测试环境接口访问的是我们环境,方便与接入方进行联调,解决接入过程中遇到的问题。测试环境的写数据和正式环境也是隔离的,方便接入方进行调试。此外,测试环境和正式环境的access_token是不同的,测试环境需要使用测试环境的access_token。

    Q:2. 如何调用测试环境的接口?#

    A:无论是开放平台授权api接口,亦或是K歌业务接口,都是在正式环境url的域名“api.kg.qq.com”后加一个“/test”。

    Q:3. 调用业务接口时,传了参数却不能正确解析#

    A:业务接口的body解析方式为json,所以需要业务方将请求的Content-Type设为“application/json”,并且以正确json的格式传递请求参数,只有这样我们的业务后台才能正确的解析到参数,否则都解析成默认值,有可能就会返回“参数错误”的结果。接口还需要注意是POST接口还是GET接口,否则可能会返回404。

    Q:4. token的有效期是多久?#

    A:acess_token的有效期是两个小时。
    refresh_token的有效期是一个月。
    每次获取的token都是新的token,会覆盖前面的token,导致前面的token失效。在开发过程中务必保证正确的获取和更新token。

    Q:5. 歌单歌曲怎么配置?#

    A:运营同学会提供已有的歌单类型和ID,厂商可以根据自己需求选择调用。也可以提供歌单歌曲mid列表,整理成文档线下发送个K歌运营同学新建和修改。

    Q:6. 目前有哪些歌单?#

    A:目前有用户推荐歌单、排行榜、自建歌单、标签歌单、主题歌单、专辑歌单。
    https://doc.weixin.qq.com/sheet/e3_ATAAzgbRAAsCNjzb22PaKRp2s3Fpi?scode=AJEAIQdfAAouvRdH2ZATAAzgbRAAs&tab=BB08J2

    Q:7. 首页歌单展示分类列表调用哪个接口?#

    A:客户端首页歌单运营配置由厂商具体负责,厂商需要搭建自己的运营配置后台,根据已有的歌单,选取适用的歌单配置客户端个性化展示内容。

    Q:8. 热门歌手通过哪个接口获取?#

    A:可以通过热⻔推荐接口:https://apifox.com/apidoc/project-951819/api-20441460

    Q:9. 全部歌手通过哪个接口获取?#

    A:可以通过搜索接口获取:https://apifox.com/apidoc/project-951819/api-25890497

    Q:10. 排行榜更新时间?#

    A:排行榜更新时间默认为每天更新,总数为100,目前没有返回榜单的更新时间。

    Q:11. 年代、语种、专题歌单在哪个接口获取?#

    A:这些属于主题歌单,可以在文档中分类专题中查找需要的歌单
    https://docs.qq.com/sheet/DWHNISUZJekFwVmJZ?tab=jhqgxw

    Q:12. 文档中有多个歌单相关接口,应该用哪个?#

    A:推荐使用综合歌单接口,https://apifox.com/apidoc/project-951819/api-80018235
    如果目前歌单类型不满足,则使用对应的专用接口。
    修改于 2025-12-05 07:38:24
    上一页
    如何在线调试接口
    下一页
    开放平台API错误码说明
    Built with