全民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

    SDK bug提单规范

    bug提单规范#

    tips:有什么问题,建议先使用智能问答平台咨询后,再确定是否需要提单
    https://developer.y.qq.com/kgAiChat
    1、提单说明
    若需提sdk相关bug,各合作方需先做出一定排查,找出问题点,确认为sdk问题才可提单。
    提问题单时,需提供:厂商名称、sdk接口出错场景、视频、日志、时间点,和问题初步分析。
    1.
    重点关注优先级和严重程度说明和是否为新增问题 ;同时有ddl的bug,一定要标注具体ddl,再同步至我们产品,我们会优先跟进处理。
    2.
    如果有sdk定制需求,需要找K歌产品评估是否可做。
    2、问题单提给谁/找谁解决?
    模块及相关负责人:
    登录鉴权:徐晗
    下载缓存: 徐晗
    歌词打分:徐晗
    扫码点歌(待下线):徐晗(hankkxu)
    作品合成:王瑞峰(jackrfwang)
    声音通道:王瑞峰
    播放:王瑞峰&徐晗
    支付:王瑞峰
    后台接口: 毛勤斌(qbmao)
    运营:刘静芸(v_ljyaliu)
    测试:梅阿晶(macymei)
    技术负责人:董良丰/孙康(kevinlfdong/kingsun)
    产品:阚楚涵(euphiekan)
    3、优先级说明:
    紧急:阻塞测试/开发,必须要马上解决的
    高:修复时间需要在2周内的,或者功能不可用的必现问题
    中:除高优外都可以为中
    低:小的体验问题,可改可不改
    4、严重程度说明:
    致命bug:阻塞测试流程
    严重bug:功能缺失,功能不可用,无法恢复
    一般bug:除以上两类都是一般bug
    5、通用/兼容性问题说明:
    通用:属于sdk问题,且和设备/麦克风无关,且必现的问题才为通用性问题
    兼容性问题:和特定设备/麦克风有关,才为兼容性问题
    6、必现/偶现问题说明:
    必现问题需写明操作路径
    偶现问题一定要日志和视频和操作场景
    7、是否为新增问题:
    新增问题:仅当前版本引入的新问题
    历史问题:现网版本已存在的问题,历史问题优先级非特殊情况不能为高
    渠道为各车厂名称,模块和发现版本(sdk版本号)为必填字段,如实填写即可
    示例:
    【蔚来】【2.1.0】【偶现】无法播放兜底MV
    必须要按模板创建bug,要不然会被打回!!
    图片
    提示:以下类型的bug会直接拒绝:
    1.
    不是KtvSdk的bug和k歌类bug,如APP本身的bug。
    2.
    未按提单说明中规范提单:如bug标题不规范、未提供日志、未描述操作流程等。

    如何创建问题单#

    1.
    目前所有SDK问题都提单至tapd上管理
    TAPD地址:https://tapd.tencent.com/ptlogin/ptlogins/login?site=TAPD&ref=https%3A%2F%2Ftapd.tencent.com%2F
    2.
    如何申请账号,提供邮箱、英文名、姓名,给梅阿晶(微信昵称:煎蛋的阿晶晶),开通账号权限即可;开通权限后会给提供的邮箱发一个激活账号的邮件,可按提示操作下
    3.
    激活成功后,点击此,登录tapd
    image.png
    4.
    账号名为提供的英文名后再加_odc;然后使用自己的账号密码登录即可,例如:macymei_odc
    5.
    登录成功后,可以让梅阿晶(微信昵称:煎蛋的阿晶晶),帮忙加下tapd项目权限。
    6.
    进入到以下页面,即完成所有步骤。
    image.png

    bug跟进流程及频次#

    1.
    内部测试每周四会优先跟进,确认是否为问题,问题具体现象,是否为通用问题等,此处需各合作方测试配合;这里若发觉问题优先级等不合理我们会自行调整
    2.
    每周五我们会review所有已提bug,排期确认下周需修改bug列表;主要根据ddl和优先级降序跟进
    3.
    部份bug若缺少日志等排查条件时,各合作方应积极配合测试验证
    4.
    bug修复后,开发会将单流转至已解决,并评论备注测试包地址或版本号,大家自行取包验证
    5.
    若为通用bug,K歌侧会先行验证一轮再流转,其余无设备或sdk无法复现的问题,则只能合作方验证
    6.
    即当bug流转为厂商验收时,各合作方即可取包验证bug,验证通过后,需及时关单
    修改于 2025-05-26 04:37:56
    上一页
    快速接入K歌开放平台流程
    下一页
    如何在线调试接口
    Built with