文档中心
歌单接口
客户端 API
发送扩展请求接口说明-歌单

发送扩展请求接口说明

更新时间：2023-11-28 17:58

用户通过调用 sendExtendedRequest 接口，传入对应的 command、params，可以获取歌单分类列表、歌单列表以及歌单歌曲，对应结果将通过 ZegoCopyrightedMusicSendExtendedRequestCallback 回调获取。

如下以 Android 端接口调用为示例：

接口原型

public void sendExtendedRequest(String command,String params,IZegoCopyrightedMusicSendExtendedRequestCallback callback)

调用示例（如下以获取“歌单列表”为例）

String command = "/playlist/classify"; // String，command 参数代表您请求的业务指令，该示例为获取歌单列表
String params = "{ \"category_id\": \"577\",  \"page\": 1,  \"size\": 10}"; // params 参数，是 JSON 格式的字符串，需要您传入的额外参数

copyrightedMusic.sendExtendedRequest(command, params, new IZegoCopyrightedMusicSendExtendedRequestCallback() {
    @Override
    public void onSendExtendedRequestCallback(int i, String s, String s1) {
    // s: command
    // s1: result 回调结果，JSON 格式字符串
    }
});

1.1 歌单分类列表

获取歌单的分类列表，包含分类 ID、分类名称。

请求参数

command 参数

/playlist/category // String，获取歌单分类列表

params 参数

该业务不需要额外的参数，开发者传 "{}" 字符串即可。

params 示例

{
}

回调结果

参数	类型	描述
code	Number	返回码，具体请参见错误码，如查询不到可联系 ZEGO 技术支持。
message	String	操作结果描述。
data	Object	响应数据。
└ groups	Array of Object	歌单分类列表。
└ group_id	String	分组 ID。
└ group_name	String	组名。
└ categories	Array of Object	类别。
└ category_id	String	类型 ID。
└ category_name	String	类型名。

回调示例

{
    "code": 0,
    "message": "string",
    "data": {
        "groups": [
            {
                "group_id": "string",       // 分组 id
                "group_name": "string",       // 组名
                "categories": [               // 类别
                    {
                        "category_id": "string",    // 类型 id
                        "category_name": "string"   // 类型名
                    }
                ]
            }
        ]
    }
}

1.2 歌单列表

获取歌单列表，包含歌单 ID、歌单名称和歌单封面。

请求示例

command 参数

"/playlist/classify" // 扩展请求类型，字符串

params 参数

参数	类型	是否必须	描述
category_id	String	是	类型 ID。
page	Int	是	第几页，从 1 开始。
size	Int	是	每页多少项，每页最多 20 项。

params 示例

{
    "category_id": "string",
    "page": 1,
    "size": 10
}

回调结果

参数	类型	描述
code	Number	返回码，具体请参见错误码，如查询不到可联系 ZEGO 技术支持。
message	String	操作结果描述。
data	Object	响应数据。
└ playlists	Array of Object	歌单列表。
└ playlist_id	String	歌单 ID。
└ playlist_name	String	歌单名称。
└ pic	String	歌单封面。

回调示例

{
    "code": 0,
    "message": "string",
    "data": {
        "playlists": [
            {
                "playlist_id": "string",    // 歌单 id
                "playlist_name": "string",      // 歌单名称
                "pic": "string"         // 歌单封面
            }
        ]
    }
}

1.3 歌单歌曲

获取歌单歌曲，包含歌曲信息、歌手信息、歌曲所属专辑信息、版权信息、以及是否有伴奏等。

请求参数

command 参数

"/playlist/song" // 扩展请求类型，字符串

params 参数

参数	类型	是否必须	描述
playlist_id	String	是	歌单 ID。
page	Int	是	第几页，从 1 开始。
filter	Array of Int	否	过滤选项。 1：过滤不包含词曲权限的歌曲 3：过滤没有歌词的歌曲 4：过滤没有音高线的歌曲

params 示例

{
    "playlist_id": "string",
    "page": 1,
    "filter": [1]
}

回调结果

参数	类型	描述
code	Number	返回码，具体请参见错误码，如查询不到可联系 ZEGO 技术支持。
message	String	操作结果描述。
request_id	String	请求 ID。
data	Object	响应数据。
└ songs	Array of Object	歌曲列表。
└ song_id	String	歌曲 ID。
└ song_name	String	歌曲名。
└ singer_id	String	歌手 ID。
└ singer_name	String	歌手名。
└ singer_img	String	歌手头像。
└ album_id	String	歌曲所属专辑 ID。
└ album_name	String	歌曲所属专辑名。
└ album_img	String	专辑封面。
└ album_img_mini	String	专辑封面 100px 左右。
└ album_img_small	String	专辑封面 300px 左右。
└ album_img_medium	String	专辑封面 500px 左右。
└ copyright	Object	版权信息。
└ song_lyric	Number	是否有词曲伴奏版权，可以通过 requestAccompaniment 拿到伴奏资源。 0：否 1：是
└ recording	Number	是否有歌曲录音版权，可以通过 requestSong 拿到歌曲资源。 0：否 1：是
└ channel	Number	歌曲渠道。若 channel 为其他值，表示其他渠道歌曲。若 channel 为 0，需要在 UI 界面展示 logo 标志。开发者可通过本链接下载相关 logo 资源。UI 界面示例如下：

回调示例

{
    "code": 0,
    "message": "string",
    "request_id": "string",
    "data": {
         "songs": [
            {
                "song_id": "string",          // 歌曲 id
                "song_name": "string",          // 歌曲名
                "singer_id": "string",          // 歌手 id
                "singer_name": "string",      // 歌手名
                "singer_img": "string",              // 歌手头像
                "album_id": "string",          // 歌曲所属专辑 id
                "album_name": "string",          // 歌曲所属专辑名
                "album_img": "string",            // 专辑封面
                "album_img_mini": "string",       // 专辑封面 100px 左右
                "album_img_small": "string",      // 专辑封面 300px 左右
                "album_img_medium": "string",     // 专辑封面 500px 左右
                "copyright": {                    // 版权信息
                    "song_lyric": 0,              // 词曲伴奏版权 非 0 表示有版权
                    "recording": 0,              // 歌曲录音版权 非 0 表示有版权
                    "channel": 0              // 歌曲渠道 非 0 表示其他渠道歌曲
                }
            }
        ]
    }
}