全民K歌IOT开放平台
    全民K歌IOT开放平台
    • 厂商合作流程
    • 快速接入
    • SDK bug提单规范
    • 如何在线调试接口
    • 常见问题
    • 业务错误码说明
    • 开放平台接入指南
      • 登录鉴权方式介绍V2(推荐)
      • 如何申请接入
      • CDK权限申请流程
      • 获取应用级token
        POST
      • 获取登录二维码
        POST
      • 查询二维码的状态
        POST
      • 获取用户级token
        POST
      • 刷新用户级token
        POST
    • 基础类
      • tagId对照表
      • 歌曲详情
        POST
      • 查询mv的播放地址
        POST
      • 搜索
        POST
      • 搜索联想
        POST
      • 查询歌手歌曲
        POST
      • 获取歌曲歌词文件
        POST
      • 搜索某歌手的歌曲
        POST
      • Q音歌曲mid映射K歌
        POST
      • 短剧播放链接
        POST
      • 查询应用限免配置
        POST
    • 运营类
      • 排行榜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. 正式环境接口和测试环境接口有什么区别?#

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

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

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

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

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

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

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

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

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

    6. 目前有哪些歌单?#

    目前有用户推荐歌单、排行榜、自建歌单、标签歌单、主题歌单、专辑歌单。
    https://docs.qq.com/sheet/DWHNISUZJekFwVmJZ?tab=jhqgxw

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

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

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

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

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

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

    10. 排行榜更新时间?#

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

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

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

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

    推荐使用综合歌单接口,https://apifox.com/apidoc/project-951819/api-80018235
    如果目前歌单类型不满足,则使用对应的专用接口。
    上一页
    如何在线调试接口
    下一页
    业务错误码说明
    Built with