You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

查询热歌榜单 ListHotMusic

最近更新时间：2024.02.29 19:30:26

首次发布时间：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

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
应用的唯一标志
HotTypes
Integer[]
否
[1,2,3]

热歌榜类型。

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

返回参数

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

参数
类型
示例值
描述
HotList
Object[]
热歌榜单详情
HotType
Integer
1
热歌榜单 ID
HotName
String
火山内容中心热歌榜
热歌榜单名称
HotSong
Object[]
歌曲详情
SongId
String
Your_SongId
歌曲 ID
VendorId
Integer
1
供应商 ID
VendorName
String
Your_VendorName
供应商名称
Songname
String
告白气球
歌曲名称
Singer
String
周杰伦
歌曲歌手名
LyricType
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：全球
Segment
String
"[65.088, 87.168]"
歌曲高潮部分
Duration
Integer
200
歌曲时长，单位为秒
Rank
Integer
1
歌曲排名
BgmType
Integer
2

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

  • 0： 不支持。
  • 1： 声道切换
  • 2： 音轨切换
PosterUrl
String
http://www.com/xxx.jpg
歌曲封面地址
CustomHotListId
String
CustomHotListName
String

请求示例

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": {}
}