You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/歌曲查询/查询热歌榜单 ListHotMusic
查询热歌榜单 ListHotMusic
最近更新时间：2024.10.14 17:25:23首次发布时间：2023.03.29 11:07:22
我的收藏

在 K 歌场景中，你可以调用 ListHotMusic 接口，指定热歌榜类型，查询热歌榜单。

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

注意事项

该接口请求接入地址仅支持 rtc.volcengineapi.com。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
661e****543cf
你的音视频应用的唯一标志，参看获取 AppId。
HotTypes
Integer[]
否
[1,2,3]

热歌榜类型。

  • [1]：火山内容中心热歌榜。
  • [2]：项目热歌榜。
  • [1,2]：全部热歌榜。
    默认值为[1,2]。
CustomHotListId
String[]
否
8bc10835-0a23-ba30-9ae6f73722f8
自定义热歌榜ID 列表

返回参数

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

参数
类型
示例值
描述
HotList
Object[]
-
热歌榜单详情
HotType
Integer
1
热歌榜单 ID
HotName
String
火山内容中心热歌榜
热歌榜单名称
HotSong
Object[]
-
歌曲详情
SongId
String
12e0c7cd5b1a9a2eea13c014d9
歌曲 ID
VendorId
Integer
1
供应商 ID
VendorName
String
Vendor1
供应商名称
Songname
String
告白气球
歌曲名称
Singer
String
周杰伦
歌曲歌手名
LyricType
Integer[]
[0]

歌词类型

  • [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
Your_CustomHotListId
自定义热歌榜 ID
CustomHotListName
String
Your_CustomHotListName
自定义热歌榜名

请求示例

POST https://rtc.volcengineapi.com?Action=ListHotMusic&Version=2020-12-01
{
    "AppId": "661e****543cf",
    "CustomHotListId": [
        "8bc10835-0a23-ba30-9ae6f73722f8"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405161117523DBD1BACA9CFE708927C",
        "Action": "",
        "Version": "",
        "Service": "rtc",
        "Region": "cn"
    },
    "Result": {
        "HotList": [
            {
                "HotType": 3,
                "HotName": "自定义热歌榜",
                "HotSong": [
                    {
                        "SongId": "12e0c7cd05d8565b1a9a2eea13c014d9",
                        "VendorId": 1,
                        "VendorName": "Vendor1",
                        "Songname": "告白气球",
                        "Singer": "周杰伦",
                        "LyricType": [
                            0
                        ],
                        "SceneType": 0,
                        "PitchType": 1,
                        "RecordType": 1,
                        "RegionType": 0,
                        "Segment": "[54.912, 136.32]",
                        "Duration": 297,
                        "Rank": 1,
                        "BgmType": 2,
                        "PosterUrl": "http://www.com/xxx.jpg"
                    },
                ]
            }
                ],
                "CustomHotListId": "8bc10835-0a23-ba30-9ae6f73722f8",
                "CustomHotListName": "测试热歌榜"
            }
    }