查询等待音乐列表

查询等待音乐播放列表。

请求 URL

GET {base_url}/{api_path}/play_list/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。

请求参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 等待音乐播放列表的总数。
play_list Array <MoH_Playlist> 每个等待音乐播放列表的基本信息。
MoH_Playlist
参数 类型 说明
id Integer 等待音乐播放列表的唯一 ID。
list_name String 等待音乐播放列表的名称。
play_order String 播放列表中等待音乐的播放顺序。
  • random：随机
  • alphabetical：按字母排序
list_type Integer 等待音乐播放列表的类型。
  • 1：本地音频。
  • 2：在线音频。
stream_url String 在线音频的 URL。
prompt_list Array <MoH_File> 每个等待音乐文件的信息。

MoH_File

参数 类型 说明
file String 等待音乐文件名称。

示例

请求示例

GET /openapi/v1.0/play_list/list?access_token=Av4ZxfcjqeHAWvNK9IeISDC6TnmiTpra HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "play_list": [
        {
            "id": 14,
            "list_name": "SoftBreeze",
            "play_order": "random",
            "list_type": 1,
            "stream_url": "",
            "prompt_list": [
                {
                    "file": "DawnChime.wav"
                },
                {
                    "file": "WhisperingPine.wav"
                }
            ]
        },
        {
            "id": 15,
            "list_name": "CalmPulse",
            "play_order": "random",
            "list_type": 1,
            "stream_url": "",
            "prompt_list": [
                {
                    "file": "SilentTide.wav"
                },
                {
                    "file": "CloudLullaby.wav"
                }
            ]
        }
    ]
}