排行榜 - 全民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

city_id

integer

地区Id

可选

hot_type

enum<integer>

可选

0-周榜、1-月榜、2-总榜；仅当rankType=’HOT’时有效

枚举值:

012

index

integer

可选

从0开始，传index则不需要start_page

page_num

integer

最大30

可选

>= 1

rank_type

enum<string>

必需

HOT-热歌榜，NEW-新歌榜，RISE-飙升榜，YEAR-年代榜，CITY-地区榜

枚举值:

HOTNEWRISEYEARCITY

start_page

integer

可选

>= 1

year_type

enum<integer>

可选

60\70\80\90\00；仅当rankType=’YEAR’时有效

枚举值:

607080900

示例

{
  "city_id": 0,
  "hot_type": 0,
  "index": 0,
  "page_num": 1,
  "rank_type": "HOT",
  "start_page": 1,
  "year_type": 60
}

示例代码

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/oper/v2/get_ranking_list' \
--header 'X-Open-Access-Token;' \
--header 'X-Open-ID: ' \
--header 'X-Open-App-ID;' \
--header 'Device-ID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "city_id": 0,
    "hot_type": 0,
    "index": 0,
    "page_num": 1,
    "rank_type": "HOT",
    "start_page": 1,
    "year_type": 60
}'

返回响应

🟢200OK

application/json

Body

desc

string

详情描述

可选

has_more

boolean

可选

next_index

integer

可选

pic_url

string

完整图片Url

可选

songs

array[object (protocol.SongInfo) {31}]

可选

1080_mv_cover_size

integer

可选

遮挡mv1080质量文件大小

1080_mv_size

integer

可选

mv1080质量文件大小

480_mv_cover_size

integer

可选

遮挡mv480质量文件大小

480_mv_size

integer

可选

mv480质量文件大小

720_mv_cover_size

integer

可选

遮挡mv720质量文件大小

720_mv_size

integer

可选

mv720质量文件大小

album_img

string

可选

歌曲专辑封面图片500*500

cp_status

integer

可选

版权状态，1:有版权， [-99,0]无版权，可播， <-300,无版权，不可播

has_hq

boolean

是否有HQ品质伴奏

可选

has_lyric

integer

可选

（废弃）是否有字幕(0-未知 1-无字幕 2-有字幕)

has_midi

boolean

唱歌时是否支持打分

可选

has_mv

boolean

是否有MV

可选

has_ori_song

boolean

歌曲是否有原唱

可选

language

integer

可选

语种：0-国语 1-粤语 2-闽南语 3-日语 4-韩语 5-英语 6-法语 7-其他 9-纯音乐

mv_cover

string

mv视频封面

可选

mv_has_lyric

boolean

可选

MV是否包含KTV歌词字幕：0-无，1-有（这种情况可以不用再加载伴奏歌词了）

mv_height

integer

mv视频高度

可选

mv_width

integer

mv视频宽度

可选

need_vip

boolean

是否需要VIP

可选

play_count

integer

歌曲播放量

可选

play_duration

integer

播放时长

可选

qqmusic_id

integer

可选

废弃(该字段返回0)

singer_id

string

歌手Id

可选

singer_name

string

歌手名称

可选

song_desc

string

歌曲描述

可选

song_id

string

歌曲编号

可选

song_lyric_mask

integer

可选

伴奏歌词标记，可按位判断与是否有对应的类型。(1:有qrc歌词)+(2:有lrc歌词)

song_name

string

歌曲名称

可选

song_type

integer

可选

歌曲类型 0-完整版 3-Live 6-Remix 100-和声

status

integer

可选

状态 0-下架 1-正常

tag_id_list

array[integer]

可选

tagid列表。参考《TagId对照表》

total_num

integer

可选

示例

{
  "desc": "string",
  "has_more": true,
  "next_index": 0,
  "pic_url": "string",
  "songs": [
    {
      "1080_mv_cover_size": 0,
      "1080_mv_size": 0,
      "480_mv_cover_size": 0,
      "480_mv_size": 0,
      "720_mv_cover_size": 0,
      "720_mv_size": 0,
      "album_img": "string",
      "cp_status": 0,
      "has_hq": true,
      "has_lyric": 0,
      "has_midi": true,
      "has_mv": true,
      "has_ori_song": true,
      "language": 0,
      "mv_cover": "string",
      "mv_has_lyric": true,
      "mv_height": 0,
      "mv_width": 0,
      "need_vip": true,
      "play_count": 0,
      "play_duration": 0,
      "qqmusic_id": 0,
      "singer_id": "string",
      "singer_name": "string",
      "song_desc": "string",
      "song_id": "string",
      "song_lyric_mask": 0,
      "song_name": "string",
      "song_type": 0,
      "status": 0,
      "tag_id_list": [
        0
      ]
    }
  ],
  "total_num": 0
}