获取同城作品 - 全民K歌IOT开放平台

请求参数

Header 参数

X-Open-Access-Token

string

必需

access token

默认值:

X-Open-ID

string

openid

可选

默认值:

X-Open-App-ID

string

业务appid

必需

默认值:

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

curl --location --request POST 'https://api.kg.qq.com/karaoke/user/v2/get_city_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
    }
  ]
}