You need to enable JavaScript to run this app.
导航

查询热歌榜单 ListHotMusic

最近更新时间2024.01.12 16:39:44

首次发布时间2023.03.29 11:07:22

在 K 歌场景中,你可能需要查询热歌榜单。你可以使用 ListHotMusic 这个 OpenAPI 来实现这一功能。

使用说明

接口行为

你可以调用 ListHotMusic 接口,指定热歌榜类型,查询热歌榜单。

歌曲排行统计时间为前一天凌晨 00:00 到 当天凌晨 00:00。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=ListHotMusic&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringListHotMusic接口名称。当前 API 的名称为 ListHotMusic
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId应用的唯一标志

HotTypes

Array of Integer

[1,2]

热歌榜类型。

  • [1]:火山内容中心热歌榜。
  • [2]:项目热歌榜。
  • [1,2]:全部热歌榜。
    默认值为[1,2]

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数类型示例值描述
HotListArray of HotList热歌榜单详情

HotList

参数类型示例值描述
HotTypeInteger1热歌榜单 ID
HotNameString火山内容中心热歌榜 热歌榜单名称
HotSongArray of HotSong歌曲详情

HotSong

参数类型示例值描述
SongIdStringYour_SongId歌曲 ID
VendorIdInteger1供应商 ID
VendorNameStringYour_VendorName供应商名称
SongnameString告白气球歌曲名称
SingerString周杰伦歌曲歌手名

LyricType

Array of Integer

歌词类型

  • [0]krc
  • [1]lrc
  • [0,1]: 两种歌词均有。
    若为空,则表示为无歌词。

SceneType

Integer

1

场景类型:

  • 0:所有。
  • 1:BGM
  • 2:k 歌

PitchType

Integer

1

歌曲是否支持打分。

  • 0: 不支持
  • 1: 支持

RecordType

Integer

1

歌曲是否支持录制。

  • 0: 不支持
  • 1: 支持

RegionType

Integer

1

歌曲授权范围。

  • 0:中国大陆
  • 1:全球
SegmentString"[65.088, 87.168]"歌曲高潮部分
DurationInteger200歌曲时长,单位为秒
RankInteger1歌曲排名

BgmType

Integer

2

歌曲是否支持伴唱原唱切换。

  • 0: 不支持。
  • 1: 声道切换
  • 2: 音轨切换
PosterUrlStringhttp://www.com/xxx.jpg歌曲封面地址

请求示例

POST https://rtc.volcengineapi.com?Action=ListHotMusic&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "HotTypes": [
        1
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListHotMusic",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-beijing"
    },
    "Result": {}
}