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

查询歌曲列表 ListMusics

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

首次发布时间：2023.03.02 11:09:49

我的收藏

在 K 歌场景中，你可能需要按照筛选条件来查询歌曲列表。你可以使用 ListMusics 这个 OpenAPI 来实现这一功能。

使用说明

接口行为

你可以调用 ListMusics 接口，指定过滤选项、歌曲新增或更新时间戳和歌曲 ID，查询歌曲列表。

如果你在控制台配置了曲库下架歌曲通知相关回调，在曲库中的歌曲下架后，你可以在配置的 URL 地址中获得通知。此时，你可以调用该接口获取最新歌曲列表。

调用接口

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

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
应用的唯一标志
PageNum
Integer
否
1
分页序号，默认值为1
PageSize
Integer
否
10
每页歌曲数量，取值范围为 (0,100]，默认值为 10
Filters
Integer[]
否
1

过滤选项：

  • 1：过滤没有歌词的歌曲
  • 2：过滤不支持打分的歌曲
  • 3：过滤不支持伴唱切换的歌曲
  • 4：过滤没有高潮片段的歌曲
LastUpdateTime
Integer
否
1839427200
歌曲更新或新增时间戳，Unix 时间，单位为秒。表示筛选更新或新增时间大于等于 LastUpdateTime 的有效歌曲
SongIds
Integer[]
否
Your_SongId
查询歌曲 ID，最多可以指定 200 个

返回参数

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

参数
类型
示例值
描述
Total
Integer
66
返回歌曲总数
List
Object[]
-
返回歌曲详情
SongId
String
Your_SongId
歌曲 ID
Songname
String
告白气球
歌曲名称
Singer
String
周杰伦
歌曲歌手名
VendorId
Integer
1
供应商 ID
VendorName
String
Your_VendorName
供应商名称
PosterUrl
String
http://www.com/xxx.jpg
歌曲封面地址
LyricType
Integer[]

歌词类型

  • 0： krc
  • 1： lrc
  • [0,1]： 两种歌词均有。
    若为空，则表示为无歌词。
Duration
Integer
200
歌曲时长，单位为秒
BgmType
Integer
2

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

  • 0： 不支持。
  • 1： 声道切换
  • 2： 音轨切换
PitchType
Integer
1

歌曲是否支持打分。

  • 0： 不支持
  • 1： 支持
RecordType
Integer
1

歌曲是否支持录制。

  • 0： 不支持
  • 1： 支持
Segment
String
"[65.088, 87.168]"
歌曲高潮部分
UpdateAt
Integer
1670518801
歌曲更新时间戳，unix 时间，单位为秒
LyricUrl
Object
歌词文件地址。 建议优先使用 krc、不存在时下可选择 lrc
KrcUrl
String
http://www.xxx.krc
krc 歌词地址
LrcUrl
String
http://www.xxx.lrc
lrc 歌词地址
MidiUrl
String
http://www.xxx.mid
midi 文件地址

请求示例

POST https://rtc.volcengineapi.com?Action=ListMusics&Version=2020-12-01

{
    "AppId": "Your_AppId",
    "PageNum": 1,
    "SongIds": [
        "Your_SongId"
    ],
    "PageSize": 10,
    "Filters": [
        1
    ],
    "LastUpdateTime": 1839427200
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListMusics",
        "Version": "2020-12-01",
        "RequestId": "Your_RequestId",
        "Region": "cn-north-1",
        "Service": "rtc"
    },
    "Result": {
        "Total": 866,
        "List": [
            {
                "SongId": "Your_SongId",
                "BgmType": 2,
                "Duration": 186,
                "LyricType": [
                    1
                ],
                "PosterUrl": "http://www.com/xxx.jpg",
                "VendorName": "Your_VendorName",
                "Singer": "周杰伦",
                "Songname": "告白气球",
                "RecordType": 1,
                "PitchType": 1,
                "UpdateAt": 1670518801,
                "Segment": "[65.088, 87.168]",
                "VendorId": 1,
                "LyricUrl": {
                    "KrcUrl": "http://www.xxx.krc",
                    "LrcUrl": "http://www.xxx.lrc",
                    "MidiUrl": "http://www.xxx.mid"
                }
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。