全民K歌IOT开放平台
  1. 用户类
全民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列表
    • 获取专题分类列表
    • 获取云端配置
    • 热门ugc
    • 热搜词
    • 排行榜
    • 获取专题下歌曲信息
    • 获取车联渠道映射
    • 热门推荐
    • (新)排行榜
    • 综合歌单列表查询
    • 设置缓存设备
    • TV版分类歌单列表
    • 获取TV频道页tab配置
    • 获取用户协议
    • 获取广告配置
    • 拉取短剧合集的列表
  • 用户类
    • 用户信息查询
      POST
    • 删除用户UGC作品
      POST
    • 获取推荐/翻唱作品
      POST
    • 获取同城作品
      POST
    • 用户作品列表
      POST
    • 获取好友作品
      POST
    • UGC作品详情
      POST
    • 更改作品访问权限
      POST
    • 用户个推歌单
      POST
  • 支付类
    • 支付接入流程
    • 订单发货使用简述
    • 开通设备会员限免简述
    • 通用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/user/v2/get_friend_work
用户类UGC
获取好友分享的作品,每页默认20条,支持翻页

请求参数

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
num
integer 
数量
必需
>= 1
passback
string 
可选
回传数据,第一次请求不传,第二次请求传上一次返回的内容
示例
{
  "num": 1,
  "passback": "string"
}

示例代码

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/user/v2/get_friend_work' \
--header 'X-Open-Access-Token;' \
--header 'X-Open-ID: ' \
--header 'X-Open-App-ID;' \
--header 'Device-ID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "num": 1,
    "passback": "string"
}'

返回响应

🟢200OK
application/json
Body
has_more
boolean 
是否有更多
可选
passback
string 
可选
回传数据,第一次请求不传,第二次请求传上一次rsp的passback内容
ugcs
array[object (protocol.UgcItem) {20}] 
作品列表
可选
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:女
示例
{
  "has_more": true,
  "passback": "string",
  "ugcs": [
    {
      "content": "string",
      "cover_img": "string",
      "create_time": 0,
      "nick_name": "string",
      "play_count": 0,
      "private": 0,
      "qc_ugc": 0,
      "rec_reason": "string",
      "score": 0,
      "score_rank": 0,
      "segment_end": 0,
      "segment_start": 0,
      "singer_name": "string",
      "song_id": "string",
      "song_name": "string",
      "ugc_id": "string",
      "ugc_mask": 0,
      "user_age": 0,
      "user_avatar": "string",
      "user_gender": 0
    }
  ]
}
上一页
用户作品列表
下一页
UGC作品详情
Built with