README.md 72.5 KB
Newer Older
B
binaryify 已提交
1 2 3
# NeteaseCloudMusicApi

网易云音乐 NodeJS 版 API
B
binaryify 已提交
4

B
binaryify 已提交
5
## 灵感来自
B
improve  
binaryify 已提交
6

B
binaryify 已提交
7 8 9 10
[disoul/electron-cloud-music](https://github.com/disoul/electron-cloud-music)

[darknessomi/musicbox](https://github.com/darknessomi/musicbox)

11
[sqaiyan/netmusic-node](https://github.com/sqaiyan/netmusic-node)
B
binaryify 已提交
12

B
binaryify 已提交
13
## 工作原理
B
improve  
binaryify 已提交
14 15

跨站请求伪造 (CSRF), 伪造请求头 , 调用官方 API
B
binaryify 已提交
16

17
## 功能特性
B
improve  
binaryify 已提交
18

19
1. 登录
20
2. 刷新登录
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
3. 发送验证码
4. 校验验证码
5. 注册(修改密码)
6. 获取用户信息 , 歌单,收藏,mv, dj 数量
7. 获取用户歌单
8. 获取用户电台
9. 获取用户关注列表
10. 获取用户粉丝列表
11. 获取用户动态
12. 获取用户播放记录
13. 获取精品歌单
14. 获取歌单详情
15. 搜索
16. 搜索建议
17. 获取歌词
18. 歌曲评论
19. 收藏单曲到歌单
20. 专辑评论
21. 歌单评论
22. mv 评论
23. 电台节目评论
24. banner
25. 获取歌曲详情
26. 获取专辑内容
27. 获取歌手单曲
28. 获取歌手 mv
29. 获取歌手专辑
30. 获取歌手描述
31. 获取相似歌手
32. 获取相似歌单
33. 相似 mv
34. 获取相似音乐
35. 获取最近 5 个听了这首歌的用户
36. 获取每日推荐歌单
37. 获取每日推荐歌曲
38. 私人 FM
39. 签到
40. 喜欢音乐
41. 垃圾桶
42. 歌单 ( 网友精选碟 )
43. 新碟上架
44. 热门歌手
45. 最新 mv
46. 推荐 mv
47. 推荐歌单
48. 推荐新音乐
49. 推荐电台
50. 推荐节目
51. 独家放送
52. mv 排行
53. 获取 mv 数据
54. 播放 mv/视频
55. 排行榜
56. 歌手榜
57. 云盘
58. 电台 - 推荐
59. 电台 - 分类
60. 电台 - 分类推荐
61. 电台 - 订阅
62. 电台 - 详情
63. 电台 - 节目
64. 给评论点赞
65. 获取动态
84
66. 热搜列表(简略)
85 86 87 88 89 90 91 92 93 94 95
67. 发送私信
68. 发送私信歌单
69. 新建歌单
70. 收藏/取消收藏歌单
71. 歌单分类
72. 收藏的歌手列表
73. 订阅的电台列表
74. 相关歌单推荐
75. 付费精选接口
76. 音乐是否可用检查接口
77. 登录状态
96
78. 获取视频播放地址
97 98 99 100 101 102 103
79. 发送/删除评论
80. 热门评论
81. 视频评论
82. 退出登录
83. 所有榜单
84. 所有榜单内容摘要
85. 收藏视频
104
86. 收藏 MV
105 106 107 108 109 110 111 112
87. 视频详情
88. 相关视频
89. 关注用户
90. 新歌速递
91. 喜欢音乐列表(无序)
92. 收藏的 MV 列表
93. 获取最新专辑
94. 听歌打卡
B
binaryify 已提交
113
95. 获取视频标签/分类下的视频
114 115 116
96. 已收藏专辑列表
97. 获取动态评论
98. 歌单收藏者列表
117 118 119 120 121 122
99. 云盘歌曲删除
100. 热门话题
101. 电台 - 推荐类型
102. 电台 - 非热门类型
103. 电台 - 今日优选
104. 心动模式/智能播放
B
binaryify 已提交
123
105. 转发动态
B
binaryify 已提交
124
106. 删除动态
125
107. 分享歌曲、歌单、mv、电台、电台节目到动态
B
binaryify 已提交
126 127 128 129 130 131
108. 通知-私信
109. 通知-评论
110. 通知-@我
111. 通知-通知
112. 设置
113. 云盘数据详情
B
v3.12.0  
binaryify 已提交
132 133
114. 私信内容
115. 我的数字专辑
B
v3.13.0  
binaryify 已提交
134
116. batch批量请求接口
135 136 137
117. 获取视频标签列表
118. 全部mv
119. 网易出品mv
138
120. 收藏/取消收藏专辑
139 140
121. 专辑动态信息
122. 热搜列表(详细)
141
123. 更换绑定手机
142 143
124. 检测手机号码是否已注册
125. 初始化昵称
B
binaryify 已提交
144 145 146 147
126. 更新歌单描述
127. 更新歌单名
128. 更新歌单标签
129. 默认搜索关键词
B
binaryify 已提交
148
130. 删除歌单
B
binaryify 已提交
149 150 151 152
131. 电台banner
132. 用户电台
133. 热门电台
134. 电台 - 节目详情
153 154
135. 电台 - 节目榜
136. 电台 - 新晋电台榜/热门电台榜
B
binaryify 已提交
155
137. 类别热门电台
156 157 158 159 160 161 162
138. 云村热评
139. 电台24小时节目榜
140. 电台24小时主播榜
141. 电台最热主播榜
142. 电台主播新人榜
143. 电台付费精品榜
144. 歌手热门50首歌曲
B
binaryify 已提交
163
145. 购买数字专辑
164 165
146. 获取 mv 点赞转发评论数数据
147. 获取视频点赞转发评论数数据
B
binaryify 已提交
166 167 168
148. 调整歌单顺序
149. 调整歌曲顺序
150. 独家放送列表
B
binaryify 已提交
169 170 171
151. 获取推荐视频
152. 获取视频分类列表 
153. 获取全部视频列表接口
172 173
154. 获取历史日推可用日期列表
155. 获取历史日推详细数据
174
156. 国家编码列表
175 176
157. 首页-发现
158. 首页-发现-圆形图标入口列表
177 178 179 180 181
159. 全部新碟
160. 数字专辑-新碟上架
161. 数字专辑&数字单曲-榜单
162. 数字专辑-语种风格馆
163. 数字专辑详情
182 183
164. 更新头像
165. 歌单封面上传
184 185
166. 歌曲楼层评论
167. 歌手全部歌曲
B
v3.0.0  
binaryify 已提交
186

B
improve  
binaryify 已提交
187
## 安装
B
improve  
binaryify 已提交
188 189

```shell
190
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
191

192
$ npm install
B
binaryify 已提交
193
```
B
improve  
binaryify 已提交
194

195
## 运行
B
improve  
binaryify 已提交
196 197

```shell
N
nujhong 已提交
198
$ node app.js
B
binaryify 已提交
199 200
```

B
improve  
binaryify 已提交
201 202
服务器启动默认端口为 3000, 若不想使用 3000 端口 , 可使用以下命令 : Mac/Linux

B
binaryify 已提交
203 204 205 206
```shell
$ PORT=4000 node app.js
```

B
improve  
binaryify 已提交
207 208
windows 下使用 git-bash 或者 cmder 等终端执行以下命令 :

B
binaryify 已提交
209 210 211
```shell
$ set PORT=4000 && node app.js
```
B
binaryify 已提交
212

B
binaryify 已提交
213
服务器启动默认 host 为localhost,如果需要更改, 可使用以下命令 : Mac/Linux
B
#615  
binaryify 已提交
214
```shell
B
binaryify 已提交
215
$ HOST=127.0.0.1 node app.js
B
#615  
binaryify 已提交
216 217 218 219
```
windows 下使用 git-bash 或者 cmder 等终端执行以下命令 :

```shell
B
binaryify 已提交
220
$ set HOST=127.0.0.1 && node app.js
B
#615  
binaryify 已提交
221
```
222 223 224 225 226 227
## 可以使用代理

在 query 参数中加上 proxy=your-proxy 即可让这一次的请求使用 proxy

```javascript
// 例子
B
v3.0.0  
binaryify 已提交
228
const url = `http://localhost:3000/song/url?id=33894312&proxy=http://121.196.226.246:84`
229 230 231 232 233 234 235
fetch(url).then(function() {
  // do what you want
})

// 结果
// {"data":[{"id":33894312,"url":"http://m10.music.126.net/20180104125640/930a968b3fb04908b733506b3833e60b/ymusic/0fd6/4f65/43ed/a8772889f38dfcb91c04da915b301617.mp3","br":320000,"size":10691439,"md5":"a8772889f38dfcb91c04da915b301617","code":200,"expi":1200,"type":"mp3","gain":-2.0E-4,"fee":0,"uf":null,"payed":0,"flag":0,"canExtend":false}],"code": 200}
```
236
v3.3.0 后支持使用 PAC代理,如 `?proxy=http://192.168.0.1/proxy.pac`
B
binaryify 已提交
237

B
binaryify 已提交
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
## 可以在Node.js调用
v3.31.0后支持Node.js调用,导入的方法为`module`内的文件名,返回内容包含`status``body`,`status`为状态码,`body`为请求返回内容,参考`module_example` 文件夹下的 `test.js`
```js
const { login_cellphone, user_cloud } = require('NeteaseCloudMusicApi')
async function main() {
  try {
    const result = await login_cellphone({
      phone: '手机号',
      password: '密码'
    })
    console.log(result)
    const result2 = await user_cloud({
      cookie: result.body.cookie // 凭证
    })
    console.log(result2.body)
      
  } catch (error) {
    console.log(error)
  }
}
main()
```

B
binaryify 已提交
261
## 更新到 v3.0 说明
B
binaryify 已提交
262

B
binaryify 已提交
263
!>2018.10.14 更新到 3.0.0,使用了模块化机制,因为部分接口参数和 url 做了调整,如还不想升级到 3.0.0,请查看 [v2 的文档](http://binaryify.github.io/NeteaseCloudMusicApi/#/v2), [更新日志](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/CHANGELOG.MD), [2.0+下载地址](https://github.com/Binaryify/NeteaseCloudMusicApi/releases/tag/v2.20.5), 同时 2.0+ 将不再维护
264

B
improve  
binaryify 已提交
265 266
## Docker 容器运行

B
binaryify 已提交
267
> 注意: 在 docker 中运行的时候, 由于使用了 request 来发请求, 所以会检查几个 proxy 相关的环境变量(如下所列), 这些环境变量 会影响到 request 的代理, 详情请参考[request 的文档](https://github.com/request/request#proxies), 如果这些环境变量 指向的代理不可用, 那么就会造成错误, 所以在使用 docker 的时候一定要注意这些环境变量. 不过, 要是你在 query 中加上了 proxy 参数, 那么环境变量会被覆盖, 就会用你通过 proxy 参数提供的代理了.
268 269 270

request 相关的环境变量

271 272 273 274 275 276 277
1. http_proxy
2. https_proxy
3. HTTP_PROXY
4. HTTPS_PROXY
5. no_proxy
6. NO_PROXY

278
```shell
B
binaryify 已提交
279
docker pull binaryify/netease_cloud_music_api
280

B
binaryify 已提交
281 282 283 284 285
docker run -d -p 3000:3000 --name netease_cloud_music_api    binaryify/netease_cloud_music_api


// 或者 
docker run -d -p 3000:3000 binaryify/netease_cloud_music_api
286 287

// 去掉或者设置相关的环境变量
288

B
binaryify 已提交
289 290 291 292
docker run -d -p 3000:3000 --name netease_cloud_music_api -e http_proxy= -e https_proxy= -e no_proxy= -e HTTP_PROXY= -e HTTPS_PROXY= -e NO_PROXY= binaryify/netease_cloud_music_api

// 或者
docker run -d -p 3000:3000 -e http_proxy= -e https_proxy= -e no_proxy= -e HTTP_PROXY= -e HTTPS_PROXY= -e NO_PROXY= binaryify/netease_cloud_music_api
293
```
B
binaryify 已提交
294

B
binaryify 已提交
295
> 以下是自行 build docker 镜像方式
296 297 298

```
$ git clone https://github.com/Binaryify/NeteaseCloudMusicApi && cd NeteaseCloudMusicApi
299

300
$ sudo docker build . -t netease-music-api
301

302 303
$ sudo docker run -d -p 3000:3000 netease-music-api
```
B
binaryify 已提交
304

305
## 接口文档
B
improve  
binaryify 已提交
306

B
binaryify 已提交
307
### 调用前须知
B
binaryify 已提交
308
!> 本项目不提供线上 demo,请不要轻易信任使用他人提供的公开服务,以免发生安全问题,泄露自己的账号和密码
B
improve  
binaryify 已提交
309

B
binaryify 已提交
310
!> 为使用方便,降低门槛, 文档示例接口直接使用了 GET 请求,本项目同时支持 GET/POST 请按实际需求使用 (POST请求url必须添加时间戳,使每次请求url不一样,不然请求会被缓存)
B
binaryify 已提交
311

B
binaryify 已提交
312
!> 由于接口做了缓存处理 ( 缓存 2 分钟,不缓存数据极容易引起网易服务器高频ip错误 , 可在 app.js 设置 , 可能会导致登陆后获取不到 cookie), **相同的 url** 会在两分钟内只向网易服务器发一次请求 , 如果遇到不需要缓
B
binaryify 已提交
313
存结果的接口 , 可在请求 url 后面加一个时间戳参数使 url 不同 , 例子 :
B
binaryify 已提交
314
`/simi/playlist?id=347230&timestamp=1503019930000` (之所以加入缓存机制是因为项目早期没有缓存机制,很多  issues 都是报 IP高频,请按自己需求改造缓存中间件(app.js),源码不复杂)
B
improve  
binaryify 已提交
315

B
binaryify 已提交
316
!> 如果是跨域请求 , 请在所有请求带上 `xhrFields: { withCredentials: true }` (axios 为 `withCredentials: true`)否则
317
可能会因为没带上 cookie 导致 301, 具体例子可看 `public/test.html`, 访问`http://localhost:3000/test.html`(默认端口的话) 例子使用 jQuery 和 axios 
B
improve  
binaryify 已提交
318

B
binaryify 已提交
319
!> 301 错误基本都是没登录就调用了需要登录的接口,如果登陆了还是提示 301, 基本都是缓存把数据缓存起来了,解决方法是加时间戳或者等待 2 分钟或者重启服务重新登录后再调用接口,可自行改造缓存方法
B
binaryify 已提交
320

B
binaryify 已提交
321
!> 部分接口如登录接口不能调用太频繁 , 否则可能会触发 503 错误或者 ip 高频错误 ,若需频繁调用 , 需要准备 IP 代理池 (更新:已加入缓存机制,但仍需注意).
B
improve  
binaryify 已提交
322

B
binaryify 已提交
323 324 325
!> 本项目仅供学习使用,请尊重版权,请勿利用此项目从事商业行为

!> 文档可能会有缓存 , 如果文档版本和 github 上的版本不一致,请清除缓存再查看
B
improve  
binaryify 已提交
326

B
binaryify 已提交
327
!> 由于网易限制,此项目在国外服务器或部分国内云服务上使用会受到限制,如 `460 cheating异常`,如需解决 , 可使用大陆服务器或者使用代理 , 感谢 [@hiyangguo](https://github.com/hiyangguo)提出的[解决方法](https://github.com/Binaryify/NeteaseCloudMusicApi/issues/29#issuecomment-298358438):
B
binaryify 已提交
328
在 '/util/request.js' 的 'headers' 处增加 `X-Real-IP':'211.161.244.70' // 任意国内 IP`
B
binaryify 已提交
329
即可解决
B
binaryify 已提交
330

B
binaryify 已提交
331 332
!> 图片加上 `?param=宽y高` 可控制图片尺寸,如 `http://p4.music.126.net/JzNK4a5PjjPIXAgVlqEc5Q==/109951164154280311.jpg?param=200y200`, `http://p4.music.126.net/JzNK4a5PjjPIXAgVlqEc5Q==/109951164154280311.jpg?param=50y50`

B
binaryify 已提交
333
### 登录
B
improve  
binaryify 已提交
334

B
binaryify 已提交
335
说明 : 登录有两个接口,建议使用`encodeURIComponent`对密码编码或者使用`POST`请求,避免某些特殊字符无法解析,如`#`(`#`在url中会被识别为hash,而不是query)
B
improve  
binaryify 已提交
336

B
improve  
binaryify 已提交
337
#### 1. 手机登录
338

339 340 341 342
**必选参数 :**   
`phone`: 手机号码

`password`: 密码
343 344


T
trazyn 已提交
345

346 347 348 349 350 351 352 353
**可选参数 :**   
`countrycode`: 国家码,用于国外手机号登陆,例如美国传入:`1`

`md5_password`: md5加密后的密码,传入后 `password` 将失效  

**接口地址 :** `/login/cellphone`

**调用例子 :** `/login/cellphone?phone=xxx&password=yyy` `/login/cellphone?phone=xxx&md5_password=yyy`
354

B
improve  
binaryify 已提交
355
#### 2. 邮箱登录
B
binaryify 已提交
356

357
**必选参数 :**   
B
binaryify 已提交
358

359
`email`: 163 网易邮箱   
360

361
`password`: 密码
362

363 364 365 366
**可选参数 :**  

`md5_password`: md5加密后的密码,传入后 `password` 将失效

B
improve  
binaryify 已提交
367
**接口地址 :** `/login`
368

B
improve  
binaryify 已提交
369
**调用例子 :** `/login?email=xxx@163.com&password=yyy`
B
binaryify 已提交
370

B
improve  
binaryify 已提交
371
完成登录后 , 会在浏览器保存一个 Cookies 用作登录凭证 , 大部分 API 都需要用到这个
372 373 374 375 376 377 378 379 380
Cookies,非跨域情况请求会自动带上 Cookies,跨域情况参考`调用前须知`

v3.30.0后支持手动传入cookie,登录接口返回内容新增 `cookie` 字段,保存到本地后,get请求带上`?cookie=xxx` 或者 post请求body带上 `cookie` 即可,如:`/user/cloud?cookie=xxx` 或者
```
{
    ...,
    cookie:"xxx"
}
```
B
binaryify 已提交
381

B
binaryify 已提交
382
#### 注意
B
improve  
binaryify 已提交
383 384

调用登录接口的速度比调用其他接口慢 , 因为登录过程调用了加密算法
B
binaryify 已提交
385

386
### 刷新登录
N
nujhong 已提交
387

B
improve  
binaryify 已提交
388 389 390
说明 : 调用此接口 , 可刷新登录状态

**调用例子 :** `/login/refresh`
391

392 393 394 395 396 397 398 399 400
### 发送验证码

说明 : 调用此接口 ,传入手机号码, 可发送验证码

**必选参数 :** `phone`: 手机号码  

**可选参数 :**
`ctcode`:  国家区号,默认86即中国

401
**接口地址 :** `/captcha/sent`
402

403
**调用例子 :** `/captcha/sent?phone=13xxx`
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418



### 验证验证码

说明 : 调用此接口 ,传入手机号码和验证码, 可校验验证码是否正确

**必选参数 :** `phone`: 手机号码  

`captcha`: 验证码

**可选参数 :**

`ctcode`:  国家区号,默认86即中国

419
**接口地址 :** `/captcha/verify`
420

421
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
422 423 424 425 426 427


### 注册(修改密码)

说明 : 调用此接口 ,传入手机号码和验证码,密码,昵称, 可注册网易云音乐账号(同时可修改密码)

428
**必选参数 :** 
429 430 431 432 433 434 435 436 437

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

438 439 440 441
**接口地址 :** `/register/cellphone`

**调用例子 :** `/register/cellphone?phone=13xxx&password=xxxxx&captcha=1234&nickname=binary1345`

442
### 检测手机号码是否已注册
B
binaryify 已提交
443
说明 : 调用此接口 ,可检测手机号码是否已注册  
444 445
**必选参数 :** 
`phone` :  手机号码  
B
boyan 已提交
446 447
**可选参数 :**
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` 
448 449 450 451 452
**接口地址 :** `/cellphone/existence/check`

**调用例子 :** `/cellphone/existence/check?phone=13xxx`

### 初始化昵称
B
binaryify 已提交
453
说明 : 刚注册的账号(需登录),调用此接口 ,可初始化昵称  
454 455 456
**必选参数 :** 
`nickname` :  昵称  

B
binaryify 已提交
457
**接口地址 :** `/activate/init/profile`
458

B
binaryify 已提交
459
**调用例子 :** `/activate/init/profile?nickname=testUser2019`
460

461 462 463 464 465 466 467 468 469 470 471 472 473
### 更换绑定手机
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

**必选参数 :** 
`oldcaptcha`: 原手机验证码

`captcha`: 新手机验证码

`phone` :  手机号码  

`ctcode` :  国家区号,默认86即中国

**接口地址 :** `/rebind`
474

475
**调用例子 :** `/rebind?phone=xxx&oldcaptcha=1234&captcha=5678`
476

B
v2.20.3  
binaryify 已提交
477 478 479 480 481 482
### 退出登录

说明 : 调用此接口 , 可退出登录

**调用例子 :** `/logout`

483
### 登录状态
B
binaryify 已提交
484

485 486 487
说明 : 调用此接口,可获取登录状态

**接口地址 :** `/login/status`
488

489

B
binaryify 已提交
490 491
### 获取用户详情

B
improve  
binaryify 已提交
492
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户详情
B
binaryify 已提交
493

B
improve  
binaryify 已提交
494
**必选参数 :** `uid` : 用户 id
B
binaryify 已提交
495

B
improve  
binaryify 已提交
496
**接口地址 :** `/user/detail`
B
binaryify 已提交
497

B
improve  
binaryify 已提交
498
**调用例子 :** `/user/detail?uid=32953014`
B
binaryify 已提交
499

B
improve  
binaryify 已提交
500
### 获取用户信息 , 歌单,收藏,mv, dj 数量
501

B
improve  
binaryify 已提交
502
说明 : 登陆后调用此接口 , 可以获取用户信息
503

B
improve  
binaryify 已提交
504
**接口地址 :** `/user/subcount`
505

B
improve  
binaryify 已提交
506
**调用例子 :** `/user/subcount`
507

508 509 510 511 512
### 更新用户信息

说明 : 登陆后调用此接口 , 传入相关信息,可以更新用户信息

**必选参数 :**
B
binaryify 已提交
513

514 515
```
gender: 性别 0:保密 1:男性 2:女性
516

517
birthday: 出生日期,时间戳 unix timestamp
518

519
nickname: 用户昵称
520

521
province: 省份id
522

523
city: 城市id
524

525 526 527
signature:用户签名
```

B
binaryify 已提交
528
**接口地址 :** `/user/update`
529

B
binaryify 已提交
530
**调用例子 :** `/user/update?gender=0&signature=测试签名&city=440300&nickname=binary&birthday=1525918298004&province=440000`
531

532
### 更新头像
B
binaryify 已提交
533
说明 : 登陆后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新头像(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/avatar_update.html)
534 535 536 537 538 539 540 541 542 543 544 545

**可选参数 :**

`imgSize` : 图片尺寸,默认为300

`imgX` : 水平裁剪偏移,方形图片可不传,默认为0
`imgY` : 垂直裁剪偏移,方形图片可不传,默认为0

**接口地址 :** `/avatar/upload`

**调用例子 :** `/avatar/upload?imgSize=200`

546 547 548 549 550
### 国家编码列表
说明 : 调用此接口,可获取国家编码列表

**接口地址 :** `/countries/code/list`

B
binaryify 已提交
551
### 获取用户歌单
552

B
improve  
binaryify 已提交
553
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户歌单
554

B
binaryify 已提交
555 556 557 558 559 560 561
**必选参数 :** `uid` : 用户 id  

**可选参数 :**

`limit` : 返回数量 , 默认为 30  

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
562

B
improve  
binaryify 已提交
563
**接口地址 :** `/user/playlist`
564

B
improve  
binaryify 已提交
565 566 567
**调用例子 :** `/user/playlist?uid=32953014`

返回数据如下图 :
B
binaryify 已提交
568 569
![用户歌单](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E7%94%A8%E6%88%B7%E6%AD%8C%E5%8D%95.png)

570 571 572
### 更新歌单

说明 : 登陆后调用此接口,可以更新用户歌单
B
binaryify 已提交
573 574

**必选参数 :**  
B
binaryify 已提交
575

576 577
```
id:歌单id
578

B
binaryify 已提交
579
name:歌单名字
580

581
desc:歌单描述
582

B
binaryify 已提交
583
tags:歌单tag ,多个用 `;` 隔开,只能用官方规定标签
584
```
B
binaryify 已提交
585

586 587
**接口地址 :** `/playlist/update`

B
binaryify 已提交
588
**调用例子 :** `/playlist/update?id=24381616&name=新歌单&desc=描述&tags=欧美`
B
binaryify 已提交
589 590 591 592

### 更新歌单描述
说明 : 登陆后调用此接口,可以单独更新用户歌单描述

B
binaryify 已提交
593
**必选参数 :**  
B
binaryify 已提交
594 595 596 597 598 599 600 601 602 603 604 605
```
id:歌单id

desc:歌单描述

```
**接口地址 :** `/playlist/desc/update`  

**调用例子 :** `/playlist/desc/update?id=24381616&desc=描述`  

### 更新歌单名
说明 : 登陆后调用此接口,可以单独更新用户歌单名
B
binaryify 已提交
606 607

**必选参数 :**  
B
binaryify 已提交
608 609 610 611 612 613 614 615 616 617 618 619 620

```
id: 歌单id

name: 歌单名

```
**接口地址 :** `/playlist/name/update`  

**调用例子 :** `/playlist/name/update?id=24381616&name=歌单名` 

### 更新歌单标签
说明 : 登陆后调用此接口,可以单独更新用户歌单标签
B
binaryify 已提交
621 622

**必选参数 :**  
B
binaryify 已提交
623 624 625 626 627 628 629 630 631 632

```
id: 歌单id

tags: 歌单标签

```
**接口地址 :** `/playlist/tags/update`  

**调用例子 :** `/playlist/tags/update?id=24381616&tags=学习` 
633

634 635

### 歌单封面上传
B
binaryify 已提交
636
说明 : 登陆后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新歌单封面(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/playlist_cover_update.html)
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

**必选参数 :**  
`id`: 歌单id 3143833470

**可选参数 :**

`imgSize` : 图片尺寸,默认为300

`imgX` : 水平裁剪偏移,方形图片可不传,默认为0
`imgY` : 垂直裁剪偏移,方形图片可不传,默认为0

**接口地址 :** `/playlist/cover/update`

**调用例子 :** `/playlist/cover/update?id=3143833470&imgSize=200`


B
v3.32.0  
binaryify 已提交
653 654
### 调整歌单顺序
说明 : 登陆后调用此接口,可以根据歌单id顺序调整歌单顺序
B
binaryify 已提交
655 656


B
v3.32.0  
binaryify 已提交
657 658 659 660 661 662 663 664
**必选参数 :**   

`ids`: 歌单id列表

**接口地址 :** `/playlist/order/update`  

**调用例子 :** `/playlist/order/update?ids=[111,222]` 

B
binaryify 已提交
665 666 667 668 669 670 671 672 673 674 675 676 677
### 调整歌曲顺序
说明 : 登陆后调用此接口,可以根据歌曲id顺序调整歌曲顺序  


**必选参数 :**   
`pid`: 歌单id  

`ids`: 歌曲id列表

**接口地址 :** `/song/order/update`  

**调用例子 :** `/song/order/update?pid=2039116066&ids=[5268328,1219871]` 

678 679
### 获取用户电台

B
improve  
binaryify 已提交
680 681 682
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户电台

**必选参数 :** `uid` : 用户 id
683

B
improve  
binaryify 已提交
684
**接口地址 :** `/user/dj`
685

B
improve  
binaryify 已提交
686
**调用例子 :** `/user/dj?uid=32953014`
687

B
improve  
binaryify 已提交
688
### 获取用户关注列表
689

B
improve  
binaryify 已提交
690 691 692
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户关注列表

**必选参数 :** `uid` : 用户 id
N
nujhong 已提交
693

B
binaryify 已提交
694
**可选参数 :**  
695

B
binaryify 已提交
696
`limit` : 返回数量 , 默认为 30  
B
binaryify 已提交
697

B
binaryify 已提交
698
`offset` : 偏移数量,用于分页 ,如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
699

B
improve  
binaryify 已提交
700
**接口地址 :** `/user/follows`
701

B
improve  
binaryify 已提交
702
**调用例子 :** `/user/follows?uid=32953014`
703

B
improve  
binaryify 已提交
704
### 获取用户粉丝列表
705

B
improve  
binaryify 已提交
706
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户粉丝列表
707

708 709 710 711 712
**必选参数 :** `uid` : 用户 id  

**可选参数 :** `limit` : 返回数量 , 默认为 30   

`lasttime` : 返回数据的 `lasttime` ,默认-1,传入上一次返回结果的 lasttime,将会返回下一页的数据
713 714


B
improve  
binaryify 已提交
715 716
**接口地址 :** `/user/followeds`

717
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&time=1560152549136`
718 719 720

### 获取用户动态

B
improve  
binaryify 已提交
721 722 723
说明 : 登陆后调用此接口 , 传入用户 id, 可以获取用户动态

**必选参数 :** `uid` : 用户 id
724

725 726 727 728
**可选参数 :** `limit` : 返回数量 , 默认为 30 

`lasttime` : 返回数据的 `lasttime` ,默认-1,传入上一次返回结果的 lasttime,将会返回下一页的数据

B
improve  
binaryify 已提交
729
**接口地址 :** `/user/event`
730

731
**调用例子 :** `/user/event?uid=32953014`  `/user/event?uid=32953014&limit=1&lasttime=1558011138743`
732

B
binaryify 已提交
733 734 735 736 737 738 739 740 741 742 743 744
返回结果的`type`参数对应:
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
745 746 747 748 749 750 751 752 753 754 755 756 757 758
### 转发用户动态
说明 : 登陆后调用此接口 ,可以转发用户动态

**必选参数 :** `uid` : 用户 id  

`evId` : 动态 id  

`forwards` : 转发的评论

**接口地址 :** `/event/forward`

**调用例子 :** `/event/forward?evId=6712917601&uid=32953014&forwards=测试内容`


B
binaryify 已提交
759 760 761 762 763 764 765 766 767
### 删除用户动态
说明 : 登陆后调用此接口 ,可以删除用户动态

**必选参数 :** `evId` :  动态 id  

**接口地址 :** `/event/del`

**调用例子 :** `/event/del?evId=6712917601`

768 769 770 771 772 773 774 775 776 777 778 779 780
### 分享歌曲、歌单、mv、电台、电台节目到动态
说明 : 登陆后调用此接口 ,可以分享歌曲、歌单、mv、电台、电台节目到动态

**必选参数 :** `id` :   资源 id  (歌曲,歌单,mv,电台,电台节目对应 id)

**可选参数 :** `type`: 资源类型,默认歌曲 song,可传 `song`,`playlist`,`mv`,`djradio`,`djprogram`

`msg`: 内容,140 字限制,支持 emoji,@用户名(`/user/follows`接口获取的用户名,用户名后和内容应该有空格),图片暂不支持

**接口地址 :** `/share/resource`

**调用例子 :** `/share/resource?id=1297494209&msg=测试` `/share/resource?type=djradio&id=336355127` `/share/resource?type=djprogram&id=2061034798` `/share/resource?type=djprogram&id=2061034798&msg=测试@binaryify 测试` 

781 782 783 784 785 786
### 获取动态评论

说明 : 登陆后调用此接口 , 可以获取动态下评论

**必选参数 :** `threadId` : 动态 id,可通过 `/event``/user/event` 接口获取

787
**接口地址 :** `/comment/event`
788

789
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
790

B
v3.0.0  
binaryify 已提交
791 792 793 794 795 796
### 关注/取消关注用户

说明 : 登陆后调用此接口 , 传入用户 id, 和操作 t,可关注/取消关注用户

**必选参数 :**

B
binaryify 已提交
797
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
798

B
binaryify 已提交
799
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
800 801 802 803 804

**接口地址 :** `/follow`

**调用例子 :** `/follow?id=32953014&t=1`

805 806
### 获取用户播放记录

B
improve  
binaryify 已提交
807 808 809
说明 : 登陆后调用此接口 , 传入用户 id, 可获取用户播放记录

**必选参数 :** `uid` : 用户 id
810

B
improve  
binaryify 已提交
811
**可选参数 :** `type` : type=1 时只返回 weekData, type=0 时返回 allData
812

B
improve  
binaryify 已提交
813
**接口地址 :** `/user/record`
814

B
improve  
binaryify 已提交
815
**调用例子 :** `/user/record?uid=32953014&type=1`
816

817 818 819 820 821 822 823 824
### 获取热门话题

说明 : 调用此接口 , 可获取热门话题

**可选参数 :** `limit`: 取出评论数量 , 默认为 20

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值

B
binaryify 已提交
825
**接口地址 :** `/hot/topic`
826

B
binaryify 已提交
827
**调用例子 :** `/hot/topic?limit=30&offset=30`
828

829 830 831 832 833 834 835 836

### 云村热评
说明 : 登录后调用此接口 , 可获取云村热评

**接口地址 :** `/comment/hotwall/list`

**调用例子 :** `/comment/hotwall/list`

837
### 心动模式/智能播放
838
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
839 840 841 842 843 844 845 846 847 848 849
**必选参数 :** `id` : 歌曲 id

`pid` : 歌单 id

**可选参数 :**
`sid` : 要开始播放的歌曲的 id

**接口地址 :** `/playmode/intelligence/list`

**调用例子 :** `/playmode/intelligence/list?id=33894312&pid=24381616` , `/playmode/intelligence/list?id=33894312&pid=24381616&sid=36871368`

Z
zhixuan 已提交
850 851
### 获取动态消息

B
improve  
binaryify 已提交
852 853
说明 : 调用此接口 , 可获取各种动态 , 对应网页版网易云,朋友界面里的各种动态消息
,如分享的视频,音乐,照片等!
Z
zhixuan 已提交
854

855 856 857 858
**必选参数 :** 
`pagesize` : 每页数据,默认20

`lasttime` : 返回数据的 `lasttime` ,默认-1,传入上一次返回结果的 lasttime,将会返回下一页的数据
Z
zhixuan 已提交
859

B
improve  
binaryify 已提交
860 861
**接口地址 :** `/event`

862
**调用例子 :** `/event?pagesize=30&lasttime=1556740526369`
Z
zhixuan 已提交
863

864
### 歌手分类列表
B
binaryify 已提交
865

B
binaryify 已提交
866 867
说明 : 调用此接口,可获取歌手分类列表  

868
**可选参数 :**
869

870 871 872 873
`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如
: 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
B
binaryify 已提交
874
`initial`: 按首字母索引查找参数,如 `/artist/list?type=1&area=96&initial=b` 返回内容将以 name 字段开头为 b 或者拼音开头为 b 为顺序排列, 热门传-1,#传0
875

876
`type` 取值:
B
binaryify 已提交
877

878
```
B
binaryify 已提交
879
-1:全部
880 881 882 883
1:男歌手
2:女歌手
3:乐队
```
884

885 886 887 888 889 890 891 892
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
893
```
894
    
895 896 897

**接口地址 :** `/artist/list`

898
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
899 900


B
v3.0.0  
binaryify 已提交
901
### 收藏/取消收藏歌手
B
binaryify 已提交
902

B
binaryify 已提交
903
说明 : 调用此接口,可收藏歌手
B
v3.0.0  
binaryify 已提交
904

B
binaryify 已提交
905
**必选参数 :**
906

B
binaryify 已提交
907
`artistId` : 歌手 id
908

B
binaryify 已提交
909
`t`:操作,1 为收藏,其他为取消收藏
B
binaryify 已提交
910

B
v3.0.0  
binaryify 已提交
911
**接口地址 :** `/artist/sub`
912

B
v3.0.0  
binaryify 已提交
913
**调用例子 :** `/artist/sub?id=6452&t=1`
914

915 916 917

### 歌手热门50首歌曲

918
说明 : 调用此接口,可获取歌手热门50首歌曲
919 920 921 922 923 924 925 926 927

**必选参数 :**

`id` : 歌手 id

**接口地址 :** `/artist/top/song`

**调用例子 :** `/artist/top/song?id=6452`

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
### 歌手全部歌曲
说明 : 调用此接口,可获取歌手全部歌曲
**必选参数 :**

`id` : 歌手 id

**可选参数 :**

`order` : `hot` ,`time` 按照热门或者时间排序

`limit`: 取出歌单数量 , 默认为 50

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*50, 其中 50 为 limit 的值

**接口地址 :** `/artist/songs`

**调用例子 :** `/artist/songs?id=6452`

946
### 收藏的歌手列表
B
binaryify 已提交
947

948 949 950 951 952 953
说明 : 调用此接口,可获取收藏的歌手列表

**接口地址 :** `/artist/sublist`

**调用例子 :** `/artist/sublist`

B
v3.0.0  
binaryify 已提交
954 955 956 957
### 收藏视频

说明 : 调用此接口,可收藏视频

B
binaryify 已提交
958
**必选参数 :**
B
v3.0.0  
binaryify 已提交
959 960 961 962 963 964 965 966 967

`id` : 视频 id

`t` : 1 为收藏,其他为取消收藏

**接口地址 :** `/video/sub`

**调用例子 :** `/video/sub`

968
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
969

970
说明 : 调用此接口,可收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
971

B
binaryify 已提交
972
**必选参数 :**
B
v3.0.0  
binaryify 已提交
973

B
binaryify 已提交
974
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
975 976 977 978 979 980 981

`t` : 1 为收藏,其他为取消收藏

**接口地址 :** `/mv/sub`

**调用例子 :** `/mv/sub`

982 983 984 985 986 987 988 989
### 收藏的 MV 列表

说明 : 调用此接口,可获取收藏的 MV 列表

**接口地址 :** `/mv/sublist`

**调用例子 :** `/mv/sublist`

B
binaryify 已提交
990
### 歌单分类
B
binaryify 已提交
991

B
binaryify 已提交
992 993 994 995 996 997 998
说明 : 调用此接口,可获取歌单分类,包含 category 信息

**接口地址 :** `/playlist/catlist`

**调用例子 :** `/playlist/catlist`

### 热门歌单分类
B
binaryify 已提交
999

B
binaryify 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
说明 : 调用此接口,可获取歌单分类,包含 category 信息

**接口地址 :** `/playlist/hot`

**调用例子 :** `/playlist/hot`

### 歌单 ( 网友精选碟 )

说明 : 调用此接口 , 可获取网友精选碟歌单

**可选参数 :** `order`: 可选值为 'new' 和 'hot', 分别对应最新和最热 , 默认为
'hot'

`cat`:`cat`: tag, 比如 " 华语 "、" 古风 " 、" 欧美 "、" 流行 ", 默认为
B
binaryify 已提交
1014
"全部",可从歌单分类接口获取(/playlist/catlist)  
B
binaryify 已提交
1015

O
omnip 已提交
1016
`limit`: 取出歌单数量 , 默认为 50
B
binaryify 已提交
1017

B
binaryify 已提交
1018
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*50, 其中 50 为 limit 的值
B
binaryify 已提交
1019

B
binaryify 已提交
1020
**接口地址 :** `/top/playlist`
1021

B
binaryify 已提交
1022
**调用例子 :** `/top/playlist?limit=10&order=new`
B
binaryify 已提交
1023

B
improve  
binaryify 已提交
1024
### 获取精品歌单
1025

B
improve  
binaryify 已提交
1026
说明 : 调用此接口 , 可获取精品歌单
1027

B
improve  
binaryify 已提交
1028
**可选参数 :** `cat`: tag, 比如 " 华语 "、" 古风 " 、" 欧美 "、" 流行 ", 默认为
B
binaryify 已提交
1029
"全部",可从歌单分类接口获取(/playlist/catlist)
1030

B
improve  
binaryify 已提交
1031
`limit`: 取出歌单数量 , 默认为 20
1032

B
v3.0.0  
binaryify 已提交
1033 1034
`before`: 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据

B
improve  
binaryify 已提交
1035
**接口地址 :** `/top/playlist/highquality`
1036

B
v3.0.0  
binaryify 已提交
1037
**调用例子 :** `http://localhost:3000/top/playlist/highquality?before=1503639064232&limit=3`
1038

B
binaryify 已提交
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
### 相关歌单推荐

说明 : 调用此接口,传入歌单 id 可获取相关歌单(对应页面 [https://music.163.com/#/playlist?id=1](https://music.163.com/#/playlist?id=1))

**必选参数 :** `id` : 歌单 id

**接口地址 :** `/related/playlist`

**调用例子 :** `/related/playlist?id=1`

B
improve  
binaryify 已提交
1049
### 获取歌单详情
1050

B
binaryify 已提交
1051 1052
说明 : 歌单能看到歌单名字, 但看不到具体歌单内容 , 调用此接口 , 传入歌单 id, 可
以获取对应歌单内的所有的音乐(未登录状态只能获取不完整的歌单,登录后是完整的),但是返回的trackIds是完整的,tracks 则是不完整的,可拿全部 trackIds 请求一次 `song/detail` 接口获取所有歌曲的详情 ([https://github.com/Binaryify/NeteaseCloudMusicApi/issues/452](https://github.com/Binaryify/NeteaseCloudMusicApi/issues/452))
B
improve  
binaryify 已提交
1053 1054

**必选参数 :** `id` : 歌单 id
1055

1056
**可选参数 :** `s` : 歌单最近的 s 个收藏者,默认为8
B
binaryify 已提交
1057

B
improve  
binaryify 已提交
1058
**接口地址 :** `/playlist/detail`
1059

B
improve  
binaryify 已提交
1060
**调用例子 :** `/playlist/detail?id=24381616`
1061

B
improve  
binaryify 已提交
1062
返回数据如下图 :
B
binaryify 已提交
1063 1064 1065
![歌单详情](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%AD%8C%E5%8D%95%E8%AF%A6%E6%83%85.png)

### 获取音乐 url
1066

B
improve  
binaryify 已提交
1067 1068 1069
说明 : 使用歌单详情接口后 , 能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口
, 传入的音乐 id( 可多个 , 用逗号隔开 ), 可以获取对应的音乐的 url( 不需要登录 )

1070
> 注 : 部分用户反馈获取的 url 会 403,[hwaphon](https://github.com/hwaphon)找到的解决方案是当获取到音乐的 id 后,将 https://music.163.com/song/media/outer/url?id=id.mp3 以 src 赋予 Audio 即可播放
B
binaryify 已提交
1071

B
improve  
binaryify 已提交
1072
**必选参数 :** `id` : 音乐 id
1073

B
binaryify 已提交
1074
**可选参数 :** `br`: 码率,默认设置了 999000 即最大码率,如果要 320k 则可设置为 320000,其他类推
B
binaryify 已提交
1075

B
v3.0.0  
binaryify 已提交
1076
**接口地址 :** `/song/url`
1077

B
v3.0.0  
binaryify 已提交
1078
**调用例子 :** `/song/url?id=33894312` `/song/url?id=405998841,33894312`
1079

B
improve  
binaryify 已提交
1080
返回数据如下图 :
B
binaryify 已提交
1081 1082
![音乐 url](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E9%9F%B3%E4%B9%90%20url.png)

1083
### 音乐是否可用
B
binaryify 已提交
1084

1085 1086 1087 1088
说明: 调用此接口,传入歌曲 id, 可获取音乐是否可用,返回 `{ success: true, message: 'ok' }` 或者 `{ success: false, message: '亲爱的,暂无版权' }`

**必选参数 :** `id` : 歌曲 id

B
binaryify 已提交
1089
**可选参数** : `br`: 码率,默认设置了 999000 即最大码率,如果要 320k 则可设置为 320000,其他类推
1090 1091 1092 1093 1094

**接口地址 :** `/check/music`

**调用例子 :** `/check/music?id=33894312`

1095
### 搜索
1096

B
improve  
binaryify 已提交
1097 1098
说明 : 调用此接口 , 传入搜索关键词可以搜索该音乐 / 专辑 / 歌手 / 歌单 / 用户 ,
关键词可以多个 , 以空格隔开 , 如 " 周杰伦 搁浅 "( 不需要登录 ), 搜索获取的
B
v3.0.0  
binaryify 已提交
1099
mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具体的播放链接
1100

B
improve  
binaryify 已提交
1101
**必选参数 :** `keywords` : 关键词
1102

B
improve  
binaryify 已提交
1103 1104
**可选参数 :** `limit` : 返回数量 , 默认为 30 `offset` : 偏移数量,用于分页 , 如
: 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
N
nujhong 已提交
1105

1106
`type`: 搜索类型;默认为 1 即单曲 , 取值意义 : 1: 单曲, 10: 专辑, 100: 歌手, 1000:
B
binaryify 已提交
1107
歌单, 1002: 用户, 1004: MV, 1006: 歌词, 1009: 电台, 1014: 视频, 1018:综合
N
nujhong 已提交
1108

1109
**接口地址 :** `/search` 或者 `/cloudsearch`(更全)
1110

1111
**调用例子 :** `/search?keywords= 海阔天空` `/cloudsearch?keywords= 海阔天空`
1112

B
improve  
binaryify 已提交
1113
返回数据如下图 :
B
binaryify 已提交
1114 1115
![搜索音乐](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%90%9C%E7%B4%A2.png)

B
binaryify 已提交
1116 1117 1118 1119 1120 1121

### 默认搜索关键词
说明 : 调用此接口 , 可获取默认搜索关键词

**接口地址 :** `/search/default`

1122
### 热搜列表(简略)
B
binaryify 已提交
1123

B
binaryify 已提交
1124 1125 1126 1127 1128 1129
说明 : 调用此接口,可获取热门搜索列表

**接口地址 :** `/search/hot`

**调用例子 :** `/search/hot`

1130 1131 1132 1133 1134 1135 1136 1137
### 热搜列表(详细)

说明 : 调用此接口,可获取热门搜索列表

**接口地址 :** `/search/hot/detail`

**调用例子 :** `/search/hot/detail`

1138 1139
### 搜索建议

B
improve  
binaryify 已提交
1140
说明 : 调用此接口 , 传入搜索关键词可获得搜索建议 , 搜索结果同时包含单曲 , 歌手 ,
B
improve  
binaryify 已提交
1141
歌单 ,mv 信息
1142

B
improve  
binaryify 已提交
1143
**必选参数 :** `keywords` : 关键词
N
nujhong 已提交
1144

1145 1146
**可选参数 :** `type` : 如果传 'mobile' 则返回移动端数据

B
improve  
binaryify 已提交
1147
**接口地址 :** `/search/suggest`
1148

1149
**调用例子 :** `/search/suggest?keywords= 海阔天空` `/search/suggest?keywords= 海阔天空&type=mobile`
1150

B
binaryify 已提交
1151 1152
### 搜索多重匹配

B
improve  
binaryify 已提交
1153 1154 1155
说明 : 调用此接口 , 传入搜索关键词可获得搜索结果

**必选参数 :** `keywords` : 关键词
N
nujhong 已提交
1156

B
improve  
binaryify 已提交
1157
**接口地址 :** `/search/multimatch`
B
binaryify 已提交
1158

B
improve  
binaryify 已提交
1159
**调用例子 :** `/search/multimatch?keywords= 海阔天空`
B
binaryify 已提交
1160

1161 1162 1163 1164
### 新建歌单

说明 : 调用此接口 , 传入歌单名字可新建歌单

B
binaryify 已提交
1165
**必选参数 :** `name` : 歌单名
1166

B
v3.12.0  
binaryify 已提交
1167 1168
**可选参数 :** `privacy` : 是否设置为隐私歌单,默认否,传'10'则设置成隐私歌单

1169 1170 1171 1172
**接口地址 :** `/playlist/create`

**调用例子 :** `/playlist/create?name=测试歌单`

1173

1174

B
binaryify 已提交
1175 1176 1177 1178 1179

### 删除歌单

说明 : 调用此接口 , 传入歌单id可删除歌单

B
binaryify 已提交
1180
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1181 1182 1183

**接口地址 :** `/playlist/delete`

B
binaryify 已提交
1184
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1185 1186


1187 1188 1189 1190 1191
### 收藏/取消收藏歌单

说明 : 调用此接口 , 传入类型和歌单 id 可收藏歌单或者取消收藏歌单

**必选参数 :**
1192

B
binaryify 已提交
1193
`t` : 类型,1:收藏,2:取消收藏
1194 1195 1196 1197 1198 1199
`id` : 歌单 id

**接口地址 :** `/playlist/subscribe`

**调用例子 :** `/playlist/subscribe?t=1&id=106697785` `/playlist/subscribe?t=2&id=106697785`

1200

1201

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

**可选参数 :** `limit`: 取出评论数量 , 默认为 20

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值

**接口地址 :** `/playlist/subscribers`

**调用例子 :** `/playlist/subscribers?id=544215255&limit=30`


1217
### 对歌单添加或删除歌曲
B
binaryify 已提交
1218

B
improve  
binaryify 已提交
1219
说明 : 调用此接口 , 可以添加歌曲到歌单或者从歌单删除某首歌曲 ( 需要登录 )
B
binaryify 已提交
1220

1221
**必选参数 :**
1222

1223 1224 1225 1226
`op`: 从歌单增加单曲为 add, 删除为 del

`pid`: 歌单 id
`tracks`: 歌曲 id,可多个,用逗号隔开
B
binaryify 已提交
1227

B
improve  
binaryify 已提交
1228
**接口地址 :** `/playlist/tracks`
B
binaryify 已提交
1229

B
binaryify 已提交
1230
**调用例子 :** `/playlist/tracks?op=add&pid=24381616&tracks=347231` ( 对应把歌曲添加到 ' 我 ' 的歌单 , 测试的时候请把这里的 pid 换成你自己的, id 和 tracks 不对可能会报 502 错误)
1231

B
binaryify 已提交
1232
### 获取歌词
1233

B
improve  
binaryify 已提交
1234
说明 : 调用此接口 , 传入音乐 id 可获得对应音乐的歌词 ( 不需要登录 )
1235

B
improve  
binaryify 已提交
1236
**必选参数 :** `id`: 音乐 id
1237

B
improve  
binaryify 已提交
1238
**接口地址 :** `/lyric`
1239

B
improve  
binaryify 已提交
1240 1241 1242
**调用例子 :** `/lyric?id=33894312`

返回数据如下图 :
1243
![获取歌词](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%AD%8C%E8%AF%8D.png)
B
binaryify 已提交
1244

B
binaryify 已提交
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
### 新歌速递

说明 : 调用此接口 , 可获取新歌速递

**必选参数 :**

`type`: 地区类型 id,对应以下:

```
全部:0
1255

B
binaryify 已提交
1256
华语:7
1257

B
binaryify 已提交
1258
欧美:96
1259

B
binaryify 已提交
1260
日本:8
1261

B
binaryify 已提交
1262 1263 1264 1265 1266 1267 1268
韩国:16
```

**接口地址 :** `/top/song`

**调用例子 :** `/top/song?type=96`

1269 1270 1271
### 首页-发现
说明 : 调用此接口 , 可获取APP首页信息

B
binaryify 已提交
1272 1273 1274 1275
**接口地址 :** `/homepage/block/page` 

**可选参数 :** `refresh`: 是否刷新数据,默认为true

1276 1277 1278 1279 1280 1281 1282

### 首页-发现-圆形图标入口列表
说明 : 调用此接口 , 可获取APP首页圆形图标入口列表

**接口地址 :** `/homepage/dragon/ball`


1283
### 歌曲评论
1284

B
improve  
binaryify 已提交
1285 1286
说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该音乐的所有评论 ( 不需要
登录 )
1287

B
improve  
binaryify 已提交
1288
**必选参数 :** `id`: 音乐 id
1289

B
improve  
binaryify 已提交
1290
**可选参数 :** `limit`: 取出评论数量 , 默认为 20
1291

1292 1293 1294
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)
1295

B
improve  
binaryify 已提交
1296
**接口地址 :** `/comment/music`
1297

B
improve  
binaryify 已提交
1298
**调用例子 :** `/comment/music?id=186016&limit=1` 对应晴天评论
1299

B
improve  
binaryify 已提交
1300 1301
返回数据如下图 :
![获取评论](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/comment.png)
1302

1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
### 歌曲楼层评论

说明 : 调用此接口 , 传入音乐 parentCommentId 和 threadId 参数 , 可获得该音乐的歌曲楼层评论

**必选参数 :**   
`parentCommentId`: 楼层评论 id

`id` : 资源 id

`tpye`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型

```
0: 歌曲

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频
```


**可选参数 :** `limit`: 取出评论数量 , 默认为 20

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`time`: 分页参数,取上一页最后一项的 `time` 获取下一页数据

**接口地址 :** `/comment/floor`

**调用例子 :** `/comment/floor?parentCommentId=1438569889&id=29764564&type=0` 

1339 1340
### 专辑评论

B
improve  
binaryify 已提交
1341 1342
说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该专辑的所有评论 ( 不需要
登录 )
1343

B
improve  
binaryify 已提交
1344
**必选参数 :** `id`: 专辑 id
1345

B
improve  
binaryify 已提交
1346
**可选参数 :** `limit`: 取出评论数量 , 默认为 20
1347

1348 1349 1350
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)  
1351

B
improve  
binaryify 已提交
1352 1353 1354
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1355 1356 1357

### 歌单评论

B
improve  
binaryify 已提交
1358 1359 1360 1361
说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该歌单的所有评论 ( 不需要
登录 )

**必选参数 :** `id`: 歌单 id
1362

B
improve  
binaryify 已提交
1363
**可选参数 :** `limit`: 取出评论数量 , 默认为 20
1364

1365 1366 1367
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)
1368

B
improve  
binaryify 已提交
1369
**接口地址 :** `/comment/playlist`
1370

B
improve  
binaryify 已提交
1371
**调用例子 :** `/comment/playlist?id=705123491`
1372 1373 1374

### mv 评论

B
improve  
binaryify 已提交
1375 1376
说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该 mv 的所有评论 ( 不需要
登录 )
1377

B
improve  
binaryify 已提交
1378
**必选参数 :** `id`: mv id
1379

B
improve  
binaryify 已提交
1380
**可选参数 :** `limit`: 取出评论数量 , 默认为 20
1381

1382 1383 1384
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)
1385

B
improve  
binaryify 已提交
1386 1387 1388
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1389 1390 1391

### 电台节目评论

B
improve  
binaryify 已提交
1392 1393 1394 1395
说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该 电台节目 的所有评论 (
不需要登录 )

**必选参数 :** `id`: 电台节目的 id
1396

B
improve  
binaryify 已提交
1397
**可选参数 :** `limit`: 取出评论数量 , 默认为 20
1398

1399 1400 1401
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)
1402

B
improve  
binaryify 已提交
1403
**接口地址 :** `/comment/dj`
1404

B
improve  
binaryify 已提交
1405
**调用例子 :** `/comment/dj?id=794062371`
1406

1407 1408 1409 1410 1411 1412 1413 1414 1415
### 视频评论

说明 : 调用此接口 , 传入音乐 id 和 limit 参数 , 可获得该 视频 的所有评论 (
不需要登录 )

**必选参数 :** `id`: 视频的 id

**可选参数 :** `limit`: 取出评论数量 , 默认为 20

1416 1417 1418
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)
1419 1420 1421 1422 1423 1424

**接口地址 :** `/comment/video`

**调用例子 :** `/comment/video?id=89ADDE33C0AAE8EC14B99F6750DB954D`

### 热门评论
B
v2.20.3  
binaryify 已提交
1425 1426

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1427 1428 1429 1430 1431 1432 1433 1434 1435

**必选参数 :**

`id` : 资源 id

`tpye`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型

```
0: 歌曲
1436

1437
1: mv
1438

1439
2: 歌单
1440

1441
3: 专辑
1442

1443
4: 电台
1444

1445 1446
5: 视频
```
B
v2.20.3  
binaryify 已提交
1447

1448 1449 1450 1451 1452 1453
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*20, 其中 20 为 limit 的值  

`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过5000条评论的时候需要用到)

1454 1455 1456 1457
**接口地址 :** `/comment/hot`

**调用例子 :** `/comment/hot?id=186016&type=0`

B
binaryify 已提交
1458 1459
### 给评论点赞

B
improve  
binaryify 已提交
1460 1461 1462 1463
说明 : 调用此接口 , 传入 type, 资源 id, 和评论 id cid 和 是否点赞参数 t 即可给对
应评论点赞 ( 需要登录 )

**必选参数 :** `id` : 资源 id, 如歌曲 id,mv id
B
binaryify 已提交
1464

B
improve  
binaryify 已提交
1465
`cid` : 评论 id
B
binaryify 已提交
1466

B
improve  
binaryify 已提交
1467
`t` : 是否点赞 ,1 为点赞 ,0 为取消点赞
B
binaryify 已提交
1468

1469
`tpye`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型
B
binaryify 已提交
1470

B
binaryify 已提交
1471 1472
```
0: 歌曲
1473

B
binaryify 已提交
1474
1: mv
1475

B
binaryify 已提交
1476
2: 歌单
1477

N
nujhong 已提交
1478
3: 专辑
1479

B
binaryify 已提交
1480
4: 电台
1481

1482
5: 视频
1483 1484

6: 动态
B
improve  
binaryify 已提交
1485
```
N
nujhong 已提交
1486

B
improve  
binaryify 已提交
1487
**接口地址 :** `comment/like`
B
binaryify 已提交
1488

B
binaryify 已提交
1489
**调用例子 :** `/comment/like?id=29178366&cid=12840183&t=1&type=0` 对应给 [https://music.163.com/#/song?id=29178366](https://music.163.com/#/song?id=29178366) 最热门的评论点赞
B
binaryify 已提交
1490

1491 1492 1493

注意: 动态点赞不需要传入 id 参数,需要传入动态的 `threadId`  参数,如:`/comment/like?type=6&cid=1419532712&threadId=A_EV_2_6559519868_32953014&t=0``threadId` 可通过 `/event``/user/event` 接口获取

B
binaryify 已提交
1494 1495 1496 1497 1498 1499 1500 1501
### 发送/删除评论

说明 : 调用此接口,可发送评论或者删除评论

**接口地址 :** `/comment`

1. 发送评论

B
binaryify 已提交
1502
   **必选参数**
1503

J
jsososo 已提交
1504
   `t`:1 发送, 2 回复
B
binaryify 已提交
1505

1506
   `tpye`: 数字,资源类型,对应歌曲,mv,专辑,歌单,电台,视频对应以下类型
B
binaryify 已提交
1507 1508 1509

   ```
   0: 歌曲
1510

B
binaryify 已提交
1511
   1: mv
1512

B
binaryify 已提交
1513
   2: 歌单
1514

B
binaryify 已提交
1515
   3: 专辑
1516

B
binaryify 已提交
1517
   4: 电台
1518

1519
   5: 视频
1520 1521

   6: 动态
B
binaryify 已提交
1522 1523 1524 1525 1526 1527
   ```

   `id`:对应资源 id

   `content` :要发送的内容

B
binaryify 已提交
1528
   `commentId` :回复的评论id (回复评论时必填)
J
jsososo 已提交
1529

B
v3.0.0  
binaryify 已提交
1530
   **调用例子** : `/comment?t=1&type=1&id=5436712&content=test` (往广岛之恋 mv 发送评论: test)
B
binaryify 已提交
1531

1532 1533
   注意:如给动态发送评论,则不需要传 id,需要传动态的 `threadId`,如:`/comment?t=1&type=6&threadId=A_EV_2_6559519868_32953014&content=test`

B
binaryify 已提交
1534
2. 删除评论
B
binaryify 已提交
1535 1536

   **必选参数**
1537

B
v3.0.0  
binaryify 已提交
1538
   `t`:0 删除
B
binaryify 已提交
1539

B
binaryify 已提交
1540 1541
   `tpye`: 数字,资源类型,对应歌曲,mv,专辑,歌单,电台,视频对应以下类型  
   
B
binaryify 已提交
1542 1543 1544

   ```
   0: 歌曲
1545

B
binaryify 已提交
1546
   1: mv
1547

B
binaryify 已提交
1548
   2: 歌单
1549

B
binaryify 已提交
1550
   3: 专辑
1551

B
binaryify 已提交
1552
   4: 电台
1553 1554


1555
   5: 视频
1556 1557 1558

   6: 动态
   
B
binaryify 已提交
1559 1560 1561 1562
   ```

   `id`:对应资源 id
   `content` :内容 id,可通过 `/comment/mv` 等接口获取
B
binaryify 已提交
1563

B
v3.0.0  
binaryify 已提交
1564
   **调用例子** : `/comment?t=0&type=1&id=5436712&commentId=1535550516319` (在广岛之恋 mv 删除评论)
1565 1566 1567
    

    注意:如给动态删除评论,则不需要传 id,需要传动态的 `threadId`,如:`/comment?t=0&type=6&threadId=A_EV_2_6559519868_32953014&commentId=1419516382`
B
binaryify 已提交
1568

B
binaryify 已提交
1569

1570 1571
### banner

B
binaryify 已提交
1572
说明 : 调用此接口 , 可获取 banner( 轮播图 ) 数据
1573

1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
**可选参数 :**

`type`:资源类型,对应以下类型,默认为 0 即PC

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1588 1589
**接口地址 :** `/banner`

1590
**调用例子 :** `/banner`, `/banner?type=2`
B
binaryify 已提交
1591

B
v3.0.0  
binaryify 已提交
1592 1593
### 资源点赞( MV,电台,视频)

B
binaryify 已提交
1594
说明 : 调用此接口 , 可对 MV,电台,视频点赞
B
v3.0.0  
binaryify 已提交
1595

B
binaryify 已提交
1596
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1597 1598

`type`:资源类型,对应以下类型
B
binaryify 已提交
1599

B
v3.0.0  
binaryify 已提交
1600 1601
```
1: mv
1602

B
v3.0.0  
binaryify 已提交
1603
4: 电台
1604

B
v3.0.0  
binaryify 已提交
1605
5: 视频
1606 1607

6: 动态
B
v3.0.0  
binaryify 已提交
1608 1609
```

B
binaryify 已提交
1610
`t`: 操作,1 为点赞,其他未取消点赞
B
v3.0.0  
binaryify 已提交
1611

B
binaryify 已提交
1612
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1613 1614 1615 1616 1617

**接口地址 :** `/resource/like`

**调用例子 :** `/resource/like?t=1&type=1&id=5436712`

1618 1619 1620
注意:如给动态点赞,不需要传入 id,需要传入 `threadId`,可通过 `event`,`/user/event` 接口获取,如:
`/resource/like?t=1&type=6&threadId=A_EV_2_6559519868_32953014`

B
binaryify 已提交
1621 1622
### 获取歌曲详情

B
v3.0.0  
binaryify 已提交
1623
说明 : 调用此接口 , 传入音乐 id(支持多个 id, 用 `,` 隔开), 可获得歌曲详情(注意:歌曲封面现在需要通过专辑内容接口获取)
B
binaryify 已提交
1624

B
improve  
binaryify 已提交
1625
**必选参数 :** `ids`: 音乐 id, 如 `ids=347230`
B
binaryify 已提交
1626

B
improve  
binaryify 已提交
1627
**接口地址 :** `/song/detail`
B
binaryify 已提交
1628

B
v3.0.0  
binaryify 已提交
1629
**调用例子 :** `/song/detail?ids=347230`,`/song/detail?ids=347230,347231`
B
binaryify 已提交
1630

B
improve  
binaryify 已提交
1631 1632
返回数据如下图 :
![获取歌曲详情](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/songDetail.png)
B
binaryify 已提交
1633

B
binaryify 已提交
1634
### 获取专辑内容
1635

B
improve  
binaryify 已提交
1636
说明 : 调用此接口 , 传入专辑 id, 可获得专辑内容
1637

B
improve  
binaryify 已提交
1638
**必选参数 :** `id`: 专辑 id
1639

B
improve  
binaryify 已提交
1640
**接口地址 :** `/album`
1641

B
improve  
binaryify 已提交
1642 1643 1644
**调用例子 :** `/album?id=32311`

返回数据如下图 :
1645
![获取专辑内容](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E4%B8%93%E8%BE%91.png)
1646

1647

B
binaryify 已提交
1648
### 专辑动态信息
1649 1650 1651 1652 1653 1654 1655 1656
说明 : 调用此接口 , 传入专辑 id, 可获得专辑动态信息,如是否收藏,收藏数,评论数,分享数

**必选参数 :** `id`: 专辑 id

**接口地址 :** `/album/detail/dynamic`

**调用例子 :** `/album/detail/dynamic?id=32311`

1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
### 收藏/取消收藏专辑

说明 : 调用此接口,可收藏/取消收藏专辑

**必选参数 :**

`id` : 专辑 id

`t` : 1 为收藏,其他为取消收藏

**接口地址 :** `/album/sub`

**调用例子 :** `/album/sub?t=1` `/album/sub?t=0`

1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

**可选参数 :**  
`limit`: 取出数量 , 默认为 25

`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*25, 其中 25 为 limit 的值 , 默认
为 0

**接口地址 :** `/album/sublist`

**调用例子 :** `/album/sublist` ( 周杰伦 )

1684
### 获取歌手单曲
1685

B
improve  
binaryify 已提交
1686
说明 : 调用此接口 , 传入歌手 id, 可获得歌手部分信息和热门歌曲
B
improve  
binaryify 已提交
1687 1688

**必选参数 :** `id`: 歌手 id, 可由搜索接口获得
1689

B
improve  
binaryify 已提交
1690
**接口地址 :** `/artists`
1691

B
improve  
binaryify 已提交
1692
**调用例子 :** `/artists?id=6452`
1693

B
improve  
binaryify 已提交
1694
返回数据如下图 :
1695 1696
![获取歌手单曲](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/artists.png)

1697
### 获取歌手 mv
B
improve  
binaryify 已提交
1698 1699 1700

说明 : 调用此接口 , 传入歌手 id, 可获得歌手 mv 信息 , 具体 mv 播放地址可调
`/mv`传入此接口获得的 mvid 来拿到 , 如 :
1701 1702
`/artist/mv?id=6452`,`/mv?mvid=5461064`

B
improve  
binaryify 已提交
1703
**必选参数 :** `id`: 歌手 id, 可由搜索接口获得
1704

B
improve  
binaryify 已提交
1705
**接口地址 :** `/artist/mv`
1706

B
improve  
binaryify 已提交
1707
**调用例子 :** `/artist/mv?id=6452`
1708

1709
### 获取歌手专辑
1710

B
improve  
binaryify 已提交
1711
说明 : 调用此接口 , 传入歌手 id, 可获得歌手专辑内容
1712

B
improve  
binaryify 已提交
1713
**必选参数 :** `id`: 歌手 id
1714

B
improve  
binaryify 已提交
1715
**可选参数 :** `limit`: 取出数量 , 默认为 50
B
binaryify 已提交
1716

B
improve  
binaryify 已提交
1717 1718
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*50, 其中 50 为 limit 的值 , 默认
为 0
1719

B
improve  
binaryify 已提交
1720
**接口地址 :** `/artist/album`
1721

B
improve  
binaryify 已提交
1722 1723 1724
**调用例子 :** `/artist/album?id=6452&limit=30` ( 周杰伦 )

返回数据如下图 :
1725
![获取专辑内容](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/artist_album.png)
1726

1727 1728
### 获取歌手描述

B
improve  
binaryify 已提交
1729 1730 1731
说明 : 调用此接口 , 传入歌手 id, 可获得歌手描述

**必选参数 :** `id`: 歌手 id
1732

B
improve  
binaryify 已提交
1733
**接口地址 :** `/artist/desc`
1734

B
improve  
binaryify 已提交
1735
**调用例子 :** `/artist/desc?id=6452` ( 周杰伦 )
1736 1737 1738

### 获取相似歌手

B
improve  
binaryify 已提交
1739 1740 1741
说明 : 调用此接口 , 传入歌手 id, 可获得相似歌手

**必选参数 :** `id`: 歌手 id
1742

B
improve  
binaryify 已提交
1743
**接口地址 :** `/simi/artist`
1744

B
improve  
binaryify 已提交
1745
**调用例子 :** `/simi/artist?id=6452` ( 对应和周杰伦相似歌手 )
1746 1747 1748

### 获取相似歌单

B
improve  
binaryify 已提交
1749
说明 : 调用此接口 , 传入歌曲 id, 可获得相似歌单
1750

B
improve  
binaryify 已提交
1751
**必选参数 :** `id`: 歌曲 id
1752

B
improve  
binaryify 已提交
1753
**接口地址 :** `/simi/playlist`
1754

B
improve  
binaryify 已提交
1755
**调用例子 :** `/simi/playlist?id=347230` ( 对应 ' 光辉岁月 ' 相似歌单 )
1756 1757 1758

### 相似 mv

B
binaryify 已提交
1759 1760 1761
说明 : 调用此接口 , 传入 `mvid` 可获取相似 mv

**必选参数 :** `mvid`: mv id
1762

B
improve  
binaryify 已提交
1763
**接口地址 :** `/simi/mv`
1764

B
improve  
binaryify 已提交
1765
**调用例子 :** `/simi/mv?mvid=5436712`
1766 1767 1768

### 获取相似音乐

B
improve  
binaryify 已提交
1769
说明 : 调用此接口 , 传入歌曲 id, 可获得相似歌曲
1770

B
improve  
binaryify 已提交
1771
**必选参数 :** `id`: 歌曲 id
1772

B
improve  
binaryify 已提交
1773
**接口地址 :** `/simi/song`
1774

B
improve  
binaryify 已提交
1775
**调用例子 :** `/simi/song?id=347230` ( 对应 ' 光辉岁月 ' 相似歌曲 )
1776

B
improve  
binaryify 已提交
1777
### 获取最近 5 个听了这首歌的用户
1778

B
improve  
binaryify 已提交
1779
说明 : 调用此接口 , 传入歌曲 id, 最近 5 个听了这首歌的用户
1780

B
improve  
binaryify 已提交
1781
**必选参数 :** `id`: 歌曲 id
1782

B
improve  
binaryify 已提交
1783 1784 1785
**接口地址 :** `/simi/user`

**调用例子 :** `/simi/user?id=347230` ( 对应 ' 光辉岁月 ' 相似歌曲 )
1786

B
binaryify 已提交
1787
### 获取每日推荐歌单
1788

B
improve  
binaryify 已提交
1789 1790 1791
说明 : 调用此接口 , 可获得每日推荐歌单 ( 需要登录 )

**接口地址 :** `/recommend/resource`
1792

B
improve  
binaryify 已提交
1793
**调用例子 :** `/recommend/resource`
1794

B
improve  
binaryify 已提交
1795
返回数据如下图 :
1796
![每日推荐歌单](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%8E%A8%E8%8D%90%E6%AD%8C%E5%8D%95.png)
1797

B
binaryify 已提交
1798
### 获取每日推荐歌曲
1799

B
improve  
binaryify 已提交
1800
说明 : 调用此接口 , 可获得每日推荐歌曲 ( 需要登录 )
1801

B
improve  
binaryify 已提交
1802
**接口地址 :** `/recommend/songs`
1803

B
improve  
binaryify 已提交
1804
**调用例子 :** `/recommend/songs`
B
binaryify 已提交
1805

B
improve  
binaryify 已提交
1806 1807
返回数据如下图 :
![每日推荐歌曲](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%8E%A8%E8%8D%90%E6%AD%8C%E6%9B%B2.png)
1808

1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
### 获取历史日推可用日期列表

说明 : 调用此接口 , 可获得历史日推可用日期列表  

**接口地址 :** `/history/recommend/songs`

**调用例子 :** `/history/recommend/songs`

### 获取历史日推详情数据

说明 : 调用此接口 ,传入当日日期, 可获得当日历史日推数据  

**必选参数 :** `date`: 日期,通过历史日推可用日期列表接口获取,不能任意日期

**接口地址 :** `/history/recommend/songs/detail`

**调用例子 :** `/history/recommend/songs/detail?date=2020-06-21`

1827 1828
### 私人 FM

B
improve  
binaryify 已提交
1829 1830 1831
说明 : 私人 FM( 需要登录 )

**接口地址 :** `/personal_fm`
1832

B
improve  
binaryify 已提交
1833
**调用例子 :** `/personal_fm`
1834

B
improve  
binaryify 已提交
1835
返回数据如下图 :
1836 1837 1838 1839 1840

![私人 FM](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/personal_fm.png)

### 签到

B
improve  
binaryify 已提交
1841 1842 1843
说明 : 调用此接口 , 传入签到类型 ( 可不传 , 默认安卓端签到 ), 可签到 ( 需要登录
), 其中安卓端签到可获得 3 点经验 , web/PC 端签到可获得 2 点经验

B
improve  
binaryify 已提交
1844
**可选参数 :** `type`: 签到类型 , 默认 0, 其中 0 为安卓端签到 ,1 为 web/PC 签到
1845

B
improve  
binaryify 已提交
1846
**接口地址 :** `/daily_signin`
1847

B
improve  
binaryify 已提交
1848 1849 1850
**调用例子 :** `/daily_signin`

返回数据如下图 :
1851

B
binaryify 已提交
1852
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
1853 1854 1855 1856

![签到失败](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinError.png)

### 喜欢音乐
B
binaryify 已提交
1857

B
improve  
binaryify 已提交
1858 1859 1860
说明 : 调用此接口 , 传入音乐 id, 可喜欢该音乐

**必选参数 :** `id`: 歌曲 id
1861

B
improve  
binaryify 已提交
1862
**可选参数 :** `like`: 布尔值 , 默认为 true 即喜欢 , 若传 false, 则取消喜欢
1863

B
improve  
binaryify 已提交
1864
**接口地址 :** `/like`
1865

B
improve  
binaryify 已提交
1866
**调用例子 :** `/like?id=347230`
1867

B
improve  
binaryify 已提交
1868
返回数据如下图 :
1869 1870 1871

![喜欢成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/like.png)

B
improve  
binaryify 已提交
1872
喜欢成功则返回数据的 code 为 200, 其余为失败
B
binaryify 已提交
1873

1874 1875
![喜欢成功截图](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/likeSuccess.png)

1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
### 喜欢音乐列表

说明 : 调用此接口 , 传入用户 id, 可获取已喜欢音乐id列表(id数组)

**必选参数 :** `uid`: 用户 id

**接口地址 :** `/likelist`

**调用例子 :** `/likelist?uid=32953014`

1886 1887
### 垃圾桶

B
improve  
binaryify 已提交
1888 1889 1890
说明 : 调用此接口 , 传入音乐 id, 可把该音乐从私人 FM 中移除至垃圾桶

**必选参数 :** `id`: 歌曲 id
1891

B
improve  
binaryify 已提交
1892
**接口地址 :** `/fm_trash`
1893

B
improve  
binaryify 已提交
1894
**调用例子 :** `/fm_trash?id=347230`
1895

B
improve  
binaryify 已提交
1896
返回数据如下图 :
1897 1898 1899

![移除成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/fm_trash.png)

1900
### 新碟上架
N
nujhong 已提交
1901

B
improve  
binaryify 已提交
1902 1903 1904
说明 : 调用此接口 , 可获取新碟上架列表 , 如需具体音乐信息需要调用获取专辑列表接
`/album` , 然后传入 id, 如 `/album?id=32311&limit=30`

1905 1906 1907
**可选参数 :**    

 `limit`: 取出数量 , 默认为 50
1908

B
improve  
binaryify 已提交
1909 1910
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*50, 其中 50 为 limit 的值 , 默认
为 0
1911

1912 1913 1914 1915 1916 1917 1918 1919
`area`: ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

`type` : new:全部 hot:热门,默认为 new

`year` : 年,默认本年

`month` : 月,默认本月

B
improve  
binaryify 已提交
1920
**接口地址 :** `/top/album`
1921

1922
**调用例子 :** `/top/album?offset=0&limit=30&year=2019&month=6`
1923

1924 1925 1926 1927 1928 1929 1930 1931
### 全部新碟
说明 : 登陆后调用此接口 ,可获取全部新碟  

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0  
1932

1933 1934 1935 1936 1937
`area` : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

**接口地址 :** `/album/new`

**调用例子 :** `/album/new?area=KR&limit=10`
1938

T
trazyn 已提交
1939 1940 1941 1942 1943 1944
### 最新专辑

说明 : 调用此接口 ,获取云音乐首页新碟上架数据

**接口地址 :** `/album/newest`

B
binaryify 已提交
1945
**调用例子 :** `/album/newest`
T
trazyn 已提交
1946 1947 1948 1949 1950 1951 1952

### 听歌打卡

说明 : 调用此接口 , 传入音乐 id, 来源 id,歌曲时间 time,更新听歌排行数据

**必选参数 :** `id`: 歌曲 id, `sourceid`: 歌单或专辑 id

1953
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
1954 1955 1956

**接口地址 :** `/scrobble`

1957
**调用例子 :** `/scrobble?id=518066366&sourceid=36780169&time=291`
T
trazyn 已提交
1958

1959
### 热门歌手
N
nujhong 已提交
1960

B
improve  
binaryify 已提交
1961 1962 1963
说明 : 调用此接口 , 可获取热门歌手数据

**可选参数 :** `limit`: 取出数量 , 默认为 50
1964

B
improve  
binaryify 已提交
1965 1966
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*50, 其中 50 为 limit 的值 , 默认
为 0
1967

B
improve  
binaryify 已提交
1968
**接口地址 :** `/top/artists`
1969

B
improve  
binaryify 已提交
1970
**调用例子 :** `/top/artists?offset=0&limit=30`
1971

B
improve  
binaryify 已提交
1972
返回数据如下图 :
1973 1974 1975

![热门歌手](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/top_artists.png)

1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

**可选参数 :**   
`area`: 地区,可选值为全部,内地,港台,欧美,日本,韩国,不填则为全部
`type`: 类型,可选值为全部,官方版,原生,现场版,网易出品,不填则为全部  

`order`: 排序,可选值为上升最快,最热,最新,不填则为上升最快  

`limit`: 取出数量 , 默认为 30  

`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*50, 其中 50 为 limit 的值 , 默认
为 0  
N
nujhong 已提交
1989

1990 1991 1992 1993 1994
**接口地址 :** `/mv/all`

**调用例子 :** `/mv/all?area=港台`

### 最新 mv
B
improve  
binaryify 已提交
1995
说明 : 调用此接口 , 可获取最新 mv
1996

1997 1998
**可选参数 :** `area`: 地区,可选值为全部,内地,港台,欧美,日本,韩国,不填则为全部

B
improve  
binaryify 已提交
1999
**可选参数 :** `limit`: 取出数量 , 默认为 30
2000

B
improve  
binaryify 已提交
2001 2002 2003
**接口地址 :** `/mv/first`

**调用例子 :** `/mv/first?limit=10`
2004

2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
### 网易出品mv

说明 : 调用此接口 , 可获取网易出品 mv

**可选参数 :** `limit`: 取出数量 , 默认为 30

`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认
为 0

**接口地址 :** `/mv/exclusive/rcmd`

**调用例子 :** `/mv/exclusive/rcmd?limit=10`

2018
### 推荐 mv
N
nujhong 已提交
2019

B
improve  
binaryify 已提交
2020 2021 2022
说明 : 调用此接口 , 可获取推荐 mv

**接口地址 :** `/personalized/mv`
2023

B
improve  
binaryify 已提交
2024
**调用例子 :** `/personalized/mv`
2025 2026

### 推荐歌单
N
nujhong 已提交
2027

B
improve  
binaryify 已提交
2028 2029
说明 : 调用此接口 , 可获取推荐歌单

B
binaryify 已提交
2030
**可选参数 :** `limit`: 取出数量 , 默认为 30 (不支持 offset)
2031

B
improve  
binaryify 已提交
2032
**接口地址 :** `/personalized`
2033

2034 2035 2036
**调用例子 :** `/personalized?limit=1`


2037 2038

### 推荐新音乐
N
nujhong 已提交
2039

B
improve  
binaryify 已提交
2040
说明 : 调用此接口 , 可获取推荐新音乐
2041

B
improve  
binaryify 已提交
2042 2043 2044
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
2045 2046

### 推荐电台
N
nujhong 已提交
2047

B
improve  
binaryify 已提交
2048 2049 2050
说明 : 调用此接口 , 可获取推荐电台

**接口地址 :** `/personalized/djprogram`
2051

B
improve  
binaryify 已提交
2052
**调用例子 :** `/personalized/djprogram`
2053 2054

### 推荐节目
N
nujhong 已提交
2055

B
improve  
binaryify 已提交
2056 2057 2058
说明 : 调用此接口 , 可获取推荐电台

**接口地址 :** `/program/recommend`
2059

B
improve  
binaryify 已提交
2060
**调用例子 :** `/program/recommend`
2061

B
binaryify 已提交
2062
### 独家放送(入口列表)
N
nujhong 已提交
2063

B
improve  
binaryify 已提交
2064
说明 : 调用此接口 , 可获取独家放送
2065

B
improve  
binaryify 已提交
2066
**接口地址 :** `/personalized/privatecontent`
2067

B
improve  
binaryify 已提交
2068
**调用例子 :** `/personalized/privatecontent`
2069

B
binaryify 已提交
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
### 独家放送列表

说明 : 调用此接口 , 可获取独家放送列表  

**可选参数 :**

`limit` : 返回数量 , 默认为 60

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*60, 其中 60 为 limit 的值 , 默认为 0

**接口地址 :** `/personalized/privatecontent/list`

**调用例子 :** `/personalized/privatecontent/list?limit=1&offset=2`

2084
### mv 排行
N
nujhong 已提交
2085

B
improve  
binaryify 已提交
2086
说明 : 调用此接口 , 可获取 mv 排行
2087

2088 2089 2090
**可选参数 :** `limit`: 取出数量 , 默认为 30  

`area`: 地区,可选值为内地,港台,欧美,日本,韩国,不填则为全部  
2091

B
improve  
binaryify 已提交
2092 2093
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认
为 0
2094

2095
**接口地址 :** `/top/mv`
B
improve  
binaryify 已提交
2096

2097
**调用例子 :** `/top/mv?limit=10`
2098 2099

### 获取 mv 数据
N
nujhong 已提交
2100

B
improve  
binaryify 已提交
2101 2102
说明 : 调用此接口 , 传入 mvid ( 在搜索音乐的时候传 type=1004 获得 ) , 可获取对应
MV 数据 , 数据包含 mv 名字 , 歌手 , 发布时间 , mv 视频地址等数据 , 其中 mv 视频
B
v3.0.0  
binaryify 已提交
2103
网易做了防盗链处理 , 可能不能直接播放 , 需要播放的话需要调用 ' mv 地址' 接口
B
binaryify 已提交
2104

B
improve  
binaryify 已提交
2105
**必选参数 :** `mvid`: mv 的 id
B
binaryify 已提交
2106

B
v3.0.0  
binaryify 已提交
2107
**接口地址 :** `/mv/detail`
B
binaryify 已提交
2108

B
v3.0.0  
binaryify 已提交
2109
**调用例子 :** `/mv/detail?mvid=5436712`
B
binaryify 已提交
2110

B
improve  
binaryify 已提交
2111
返回数据如下图 :
B
binaryify 已提交
2112

2113 2114 2115 2116
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

### 获取 mv 点赞转发评论数数据
说明 : 调用此接口 , 传入 mvid ( 在搜索音乐的时候传 type=1004 获得 ) , 可获取对应
B
binaryify 已提交
2117 2118
MV 点赞转发评论数数据  

2119 2120 2121 2122 2123
**必选参数 :** `mvid`: mv 的 id

**接口地址 :** `/mv/detail/info`

**调用例子 :** `/mv/detail/info?mvid=5436712`
B
binaryify 已提交
2124

B
v3.0.0  
binaryify 已提交
2125
### mv 地址
2126

B
v3.0.0  
binaryify 已提交
2127 2128
说明 : 调用此接口 , 传入 mv id,可获取 mv 播放地址

2129 2130 2131
**必选参数 :** `id`: mv id

**可选参数 :** `r`: 分辨率,默认1080,可从 `/mv/detail` 接口获取分辨率列表
B
v3.0.0  
binaryify 已提交
2132 2133 2134 2135

**接口地址 :** `/mv/url`

**调用例子 :**
2136

2137
`/mv/url?id=5436712` `/mv/url?id=10896407&r=1080`
B
v3.0.0  
binaryify 已提交
2138

2139 2140 2141 2142 2143 2144 2145
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

**接口地址 :** `/video/group/list`

**调用例子 :** `/video/group/list`

B
binaryify 已提交
2146 2147
### 获取视频分类列表 
说明 : 调用此接口 , 可获取视频分类列表  
2148

B
binaryify 已提交
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
**接口地址 :** `/video/category/list`

**调用例子 :** `/video/category/list`

### 获取视频标签/分类下的视频
说明 : 调用此接口 , 传入标签/分类`id`,可获取到相关的视频,分页参数只能传入offset 

**必选参数 :** `id`: videoGroup 的 id  

**可选参数 :** `offset`: 默认0
2159 2160 2161 2162 2163

**接口地址 :** `/video/group`

**调用例子 :** `/video/group?id=9104`

B
binaryify 已提交
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
### 获取全部视频列表 
说明 : 调用此接口,可获取视频分类列表,分页参数只能传入offset 

**可选参数 :** `offset`: 默认0

**接口地址 :** `/video/timeline/all`

**调用例子 :** `/video/timeline/all`

### 获取推荐视频
说明 : 调用此接口, 可获取推荐视频,分页参数只能传入offset 

**必选参数 :** `id`: videoGroup 的 id  

**可选参数 :** `offset`: 默认0

**接口地址 :** `/video/group`

**调用例子 :** `/video/timeline/recommend`

B
v3.0.0  
binaryify 已提交
2184
### 相关视频
B
binaryify 已提交
2185

B
v3.0.0  
binaryify 已提交
2186
说明 : 调用此接口 , 可获取相关视频
2187

B
binaryify 已提交
2188
**必选参数 :** `id`: 视频 的 id
2189

B
v3.0.0  
binaryify 已提交
2190
**接口地址 :** `/related/allvideo`
2191

B
v3.0.0  
binaryify 已提交
2192
**调用例子 :** `/related/allvideo?id=89ADDE33C0AAE8EC14B99F6750DB954D`
2193

2194

B
v3.0.0  
binaryify 已提交
2195
### 视频详情
B
binaryify 已提交
2196

2197
说明 : 调用此接口 , 可获取视频详情
2198

B
v3.0.0  
binaryify 已提交
2199
**必选参数 :** `id`: 视频 的 id
2200

B
v3.0.0  
binaryify 已提交
2201
**接口地址 :** `/video/detail`
N
nujhong 已提交
2202

B
v3.0.0  
binaryify 已提交
2203
**调用例子 :** `/video/detail?id=89ADDE33C0AAE8EC14B99F6750DB954D`
B
binaryify 已提交
2204

2205 2206 2207 2208 2209 2210 2211 2212
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

**接口地址 :** `/video/detail/info`

**调用例子 :** `/video/detail/info?vid=89ADDE33C0AAE8EC14B99F6750DB954D`

2213
### 获取视频播放地址
B
binaryify 已提交
2214

B
binaryify 已提交
2215
说明 : 调用此接口 , 传入视频 id,可获取视频播放地址
B
improve  
binaryify 已提交
2216

B
v3.0.0  
binaryify 已提交
2217 2218 2219 2220 2221 2222
**必选参数 :** `id`: 视频 的 id

**接口地址 :** `/video/url`

**调用例子 :** `/video/url?id=89ADDE33C0AAE8EC14B99F6750DB954D`

2223

2224
### 所有榜单
2225

2226 2227
说明 : 调用此接口,可获取所有榜单
**接口地址 :** `/toplist`
2228

2229
**调用例子 :** `/toplist`
2230

B
binaryify 已提交
2231 2232
### 排行榜详情
说明: 请使用[歌单详情](#获取歌单详情)接口,传入排行榜id获取排行榜详情数据(排行榜也是歌单的一种)
2233

B
binaryify 已提交
2234
~~说明 : 调用此接口 , 传入榜单 id, 可获取不同排行榜数据(v3.34.0之后不再支持idx参数)~~
2235

B
binaryify 已提交
2236
~~**必选参数 :** `id`: 榜单id,通过所有榜单接口获取~~
B
binaryify 已提交
2237

B
binaryify 已提交
2238
~~**接口地址 :** `/top/list`~~
B
binaryify 已提交
2239

B
binaryify 已提交
2240
~~**调用例子 :** `/top/list?id=2809577409`~~
2241 2242


B
v3.0.0  
binaryify 已提交
2243
### 所有榜单内容摘要
B
binaryify 已提交
2244

B
binaryify 已提交
2245 2246
说明 : 调用此接口,可获取所有榜单内容摘要  

B
v3.0.0  
binaryify 已提交
2247 2248 2249 2250
**接口地址 :** `/toplist/detail`

**调用例子 :** `/toplist/detail`

H
hzw758 已提交
2251 2252
### 歌手榜

B
v3.0.0  
binaryify 已提交
2253
说明 : 调用此接口 , 可获取排行榜中的歌手榜
H
hzw758 已提交
2254

B
binaryify 已提交
2255 2256 2257 2258 2259 2260 2261 2262
**可选参数 :**
```
type : 地区
1: 华语
2: 欧美
3: 韩国
4: 日本
```
B
improve  
binaryify 已提交
2263 2264 2265
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2266 2267 2268

### 云盘

B
improve  
binaryify 已提交
2269
说明 : 登陆后调用此接口 , 可获取云盘数据 , 获取的数据没有对应 url, 需要再调用一
B
v3.0.0  
binaryify 已提交
2270
`/song/url` 获取 url
B
improve  
binaryify 已提交
2271

2272 2273 2274 2275 2276 2277
**可选参数 :**

`limit` : 返回数量 , 默认为 200

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*200, 其中 200 为 limit 的值 , 默认为 0

B
improve  
binaryify 已提交
2278 2279 2280
**接口地址 :** `/user/cloud`

**调用例子 :** `/user/cloud`
2281

B
binaryify 已提交
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
### 云盘数据详情
说明 : 登陆后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情

**必选参数 :** `id`: 歌曲id,可多个,用逗号隔开

**接口地址 :** `/user/cloud/detail`

**调用例子 :** `/user/cloud/detail?id=5374627`


2292 2293 2294 2295 2296 2297 2298 2299 2300
### 云盘歌曲删除
说明 : 登陆后调用此接口 , 可删除云盘歌曲

**必选参数 :** `id`: 歌曲id,可多个,用逗号隔开

**接口地址 :** `/user/cloud/del`

**调用例子 :** `/user/cloud/del`

B
binaryify 已提交
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
### 电台banner
说明 : 调用此接口,可获取电台banner

**接口地址 :** `/dj/banner`

**调用例子 :** `/dj/banner`


### 用户电台

说明 : 调用此接口, 传入用户id可获取用户创建的电台

**必选参数 :** `uid`: 用户id

**接口地址 :** `/user/audio`

**调用例子 :** `/user/audio?uid=32953014`

### 热门电台
说明 : 调用此接口,可获取热门电台

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
**接口地址 :** `/dj/hot`

**调用例子 :** `/dj/hot`

2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
### 电台 - 节目榜

说明 : 登陆后调用此接口 , 可获得电台节目榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*100, 其中 100 为 limit 的值 , 默认为 0

**接口地址 :** `/dj/program/toplist`

**调用例子 :** `/dj/program/toplist?limit=1`

2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/pay`

**调用例子 :** `/dj/toplist/pay?limit=30`


### 电台 - 24小时节目榜
说明 : 调用此接口,可获取24小时节目榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

B
binaryify 已提交
2364
**接口地址 :** `/dj/program/toplist/hours`
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401

**调用例子 :** `/dj/program/toplist/hours?limit=1`

### 电台 - 24小时主播榜
说明 : 调用此接口,可获取24小时主播榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/hours`

**调用例子 :** `/dj/toplist/hours?limit=30`

### 电台 - 主播新人榜
说明 : 调用此接口,可获取主播新人榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/newcomer`

**调用例子 :** `/dj/toplist/newcomer?limit=30`


### 电台 - 最热主播榜
说明 : 调用此接口,可获取最热主播榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/popular`

**调用例子 :** `/dj/toplist/popular?limit=30`

2402 2403 2404 2405 2406 2407 2408 2409 2410
### 电台 - 新晋电台榜/热门电台榜

说明 : 登陆后调用此接口 , 可获得新晋电台榜/热门电台榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*100, 其中 100 为 limit 的值 , 默认为 0
B
binaryify 已提交
2411 2412 2413

`type`: 榜单类型, `new` 为新晋电台榜,`hot`为热门电台榜

2414 2415 2416 2417
**接口地址 :** `/dj/toplist`

**调用例子 :** `/dj/toplist?type=hot` `/dj/toplist?type=new&limit=1`

B
binaryify 已提交
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
### 电台 - 类别热门电台

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0

`cateId`: 类别 id,可通过 `/dj/category/recommend` 接口获取

**接口地址 :** `/dj/radio/hot`

**调用例子 :** `/dj/radio/hot?cateId=2001`(创作|翻唱) `/dj/radio/hot?cateId=10002` (3D|电子)

B
improve  
binaryify 已提交
2432
### 电台 - 推荐
2433

B
improve  
binaryify 已提交
2434
说明 : 登陆后调用此接口 , 可获得推荐电台
2435

B
improve  
binaryify 已提交
2436
**接口地址 :** `/dj/recommend`
2437

B
improve  
binaryify 已提交
2438
**调用例子 :** `/dj/recommend`
2439

B
improve  
binaryify 已提交
2440
### 电台 - 分类
2441

B
improve  
binaryify 已提交
2442
说明 : 登陆后调用此接口 , 可获得电台类型
2443

B
improve  
binaryify 已提交
2444
**接口地址 :** `/dj/catelist`
2445

B
improve  
binaryify 已提交
2446
**调用例子 :** `/dj/catelist`
2447

B
improve  
binaryify 已提交
2448
### 电台 - 分类推荐
2449

B
binaryify 已提交
2450
说明 : 登陆后调用此接口 , 传入分类,可获得对应类型电台列表
2451

B
improve  
binaryify 已提交
2452
**必选参数 :** `type`: 电台类型 , 数字 , 可通过`/dj/catelist`获取 , 对应关系为
B
binaryify 已提交
2453
id 对应 此接口的 type, name 对应类型
2454

B
improve  
binaryify 已提交
2455
**接口地址 :** `/dj/recommend/type`
2456

B
binaryify 已提交
2457
**调用例子 :** `/dj/recommend/type?type=1`(明星做主播) `/dj/recommend/type?type=2001` (创作|翻唱)
2458

B
improve  
binaryify 已提交
2459
### 电台 - 订阅
2460

B
improve  
binaryify 已提交
2461 2462
说明 : 登陆后调用此接口 , 传入`rid`, 可订阅 dj,dj 的 `rid` 可通过搜索指定
type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
2463

B
improve  
binaryify 已提交
2464
**必选参数 :** `rid`: 电台 的 id
2465

B
improve  
binaryify 已提交
2466
**接口地址 :** `/dj/sub`
2467

B
improve  
binaryify 已提交
2468 2469
**调用例子 :** `/dj/sub?rid=336355127&t=1` ( 对应关注 ' 代码时间 ')
`/dj/sub?rid=336355127&t=0` ( 对应取消关注 ' 代码时间 ')
2470

2471 2472 2473 2474 2475 2476 2477 2478
### 电台的订阅列表

说明 : 登陆后调用此接口 , 可获取订阅的电台列表

**接口地址 :** `/dj/sublist`

**调用例子 :** `/dj/sublist`

add doc  
徐星宇 已提交
2479 2480 2481 2482
### 电台 - 付费精选

说明 : 可以获取付费精选的电台列表 , 传入 `limit``offset` 可以进行分页

2483 2484 2485 2486 2487 2488
**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 ,  如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0

add doc  
徐星宇 已提交
2489 2490 2491 2492
**接口地址 :** `/dj/paygift`

**调用例子 :** `/dj/paygift?limit=10&offset=20`

2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
### 电台 - 非热门类型

说明 : 登陆后调用此接口, 可获得电台非热门类型


**接口地址 :** `/dj/category/excludehot`

**调用例子 :** `/dj/category/excludehot`

### 电台 - 推荐类型

说明 : 登陆后调用此接口, 可获得电台推荐类型


**接口地址 :** `/dj/category/recommend`

**调用例子 :** `/dj/category/recommend`

### 电台 - 今日优选

说明 : 登陆后调用此接口, 可获得电台今日优选


**接口地址 :** `/dj/today/perfered`

**调用例子 :** `/dj/today/perfered`

B
improve  
binaryify 已提交
2520
### 电台 - 详情
2521

B
improve  
binaryify 已提交
2522
说明 : 登陆后调用此接口 , 传入`rid`, 可获得对应电台的详情介绍
2523

B
improve  
binaryify 已提交
2524
**必选参数 :** `rid`: 电台 的 id
2525

2526
**接口地址 :** `/dj/detail`
2527

B
improve  
binaryify 已提交
2528
**调用例子 :** `/dj/detail?rid=336355127` ( 对应 ' 代码时间 ' 的详情介绍 )
2529

B
improve  
binaryify 已提交
2530
### 电台 - 节目
2531

B
improve  
binaryify 已提交
2532
说明 : 登陆后调用此接口 , 传入`rid`, 可查看对应电台的电台节目以及对应的 id, 需要
B
v3.0.0  
binaryify 已提交
2533 2534
注意的是这个接口返回的 mp3Url 已经无效 , 都为 null, 但是通过调用 `/song/url`
个接口 , 传入节目 id 仍然能获取到节目音频 , 如 `/song/url?id=478446370` 获取代
B
improve  
binaryify 已提交
2535 2536 2537 2538
码时间的一个节目的音频

**必选参数 :** `rid`: 电台 的 id

B
binaryify 已提交
2539
**可选参数 :**
2540

B
binaryify 已提交
2541 2542
`limit` : 返回数量 , 默认为 30

2543
`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
B
binaryify 已提交
2544

2545 2546
`asc` : 排序方式,默认为 `false` (新 => 老 ) 设置 `true` 可改为 老 => 新 

B
improve  
binaryify 已提交
2547 2548
**接口地址 :** `/dj/program`

B
binaryify 已提交
2549
**调用例子 :** `/dj/program?rid=336355127&limit=40` ( 对应 ' 代码时间 ' 的节目列表 )
2550

B
binaryify 已提交
2551 2552 2553 2554 2555 2556 2557 2558
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

**必选参数 :** `id`: 电台节目 的 id

**接口地址 :** `/dj/program/detail`

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573

### 通知 - 私信

说明 : 登陆后调用此接口 ,可获取私信

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0

**接口地址 :** `/msg/private`

**调用例子 :** `/msg/private?limit=3`

B
v3.12.0  
binaryify 已提交
2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
### 发送私信

说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)

**必选参数 :**

`user_ids` : 用户 id,多个需用逗号隔开

`msg` : 要发送的信息

**接口地址 :** `/send/text`

**调用例子 :** `/send/text?user_ids=32953014&msg=test`,`/send/text?user_ids=32953014,475625142&msg=test`
2587

B
v3.12.0  
binaryify 已提交
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597

### 私信内容
说明 : 登陆后调用此接口 , 可获取私信内容

**必选参数 :**
`uid` : 用户 id

**可选参数 :**
`limit` : 返回数量 , 默认为 30

2598
`before` : 分页参数,取上一页最后一项的 `time` 获取下一页数据
B
v3.12.0  
binaryify 已提交
2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619

**接口地址 :** 
`/msg/private/history`

**调用例子 :**
`/msg/private/history?uid=9003` (云音乐小秘书)

### 发送私信(带歌单)

说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)

**必选参数 :**

`user_ids` : 用户 id,多个需用逗号隔开

`msg` : 要发送的信息

**接口地址 :** `/send/playlist`

**调用例子 :** `/send/playlist?msg=test&user_ids=475625142&playlist=705123491`,`/send/playlist?msg=test2&user_ids=475625142,32953014&playlist=705123493`

B
binaryify 已提交
2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660

### 通知 - 评论

说明 : 登陆后调用此接口 ,可获取评论

**必选参数 :** `uid`: 用户 的 id,只能和登录账号的 id 一致

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`before` : 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据


**接口地址 :** `/msg/comments`

**调用例子 :** `/msg/comments?uid=32953014`

### 通知 - @我

说明 : 登陆后调用此接口 ,可获取@我数据

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0

**接口地址 :** `/msg/forwards`

**调用例子 :** `/msg/forwards?limit=3`


### 通知 - 通知

说明 : 登陆后调用此接口 ,可获取通知

**可选参数 :**

`limit` : 返回数量 , 默认为 30

B
binaryify 已提交
2661
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674


**接口地址 :** `/msg/notices`

**调用例子 :** `/msg/notices?limit=3`

### 设置
说明 : 登陆后调用此接口 ,可获取用户设置

**接口地址 :** `/setting`

**调用例子 :** `/setting`

2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
### 数字专辑-新碟上架
说明 : 调用此接口 ,可获取数字专辑-新碟上架  

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0  
**接口地址 :** `/album/list`

**调用例子 :** `/album/list?limit=10`

### 数字专辑&数字单曲-榜单
说明 : 调用此接口 ,可获取数字专辑&数字单曲-榜单  

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0  

`albumType` : 为数字专辑,1为数字单曲

`type` : daily:日榜,week:周榜,year:年榜,total:总榜  

**接口地址 :** `/album_songsaleboard`

**调用例子 :** `/album/songsaleboard?type=year&year=2020&albumType=0`

### 数字专辑-语种风格馆

说明 : 调用此接口 ,可获取语种风格馆数字专辑列表  

**可选参数 :**

`limit` : 返回数量 , 默认为 30

`offset` : 偏移数量,用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0  

`area` 地区 Z_H:华语,E_A:欧美,KR:韩国,JP:日本  

**接口地址 :** `/album/list/style`

**调用例子 :** `/album/list/style?area=Z_H&offset=2`

### 数字专辑详情
说明 : 调用此接口 ,传入数字专辑id可获取数字专辑详情(和歌单详情有差异)

**接口地址 :** `/album/detail`

**调用例子 :** `/album/detail?id=84547195`


B
v3.12.0  
binaryify 已提交
2728 2729 2730 2731 2732 2733 2734
### 我的数字专辑
说明 : 登陆后调用此接口 ,可获取我的数字专辑

**接口地址 :** `/digitalAlbum/purchased`

**调用例子 :** `/digitalAlbum/purchased?limit=10`

T
TimonPeng 已提交
2735
### 购买数字专辑
2736
说明 : 登陆后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749

**必选参数 :**

`id` : 专辑的 id

`payment` : 支付方式, 0 为支付宝 3 为微信

`quantity` : 购买的数量

**接口地址 :** `/digitalAlbum/ordering`

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

B
v3.13.0  
binaryify 已提交
2750 2751 2752 2753 2754 2755 2756 2757 2758
### batch批量请求接口
说明 : 登陆后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口

**接口地址 :** `/batch`

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
2759
## 离线访问此文档
B
binaryify 已提交
2760

B
improve  
binaryify 已提交
2761
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
2762 2763

## 关于此文档
B
improve  
binaryify 已提交
2764 2765 2766 2767

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
2768

B
binaryify 已提交
2769
## License
B
improve  
binaryify 已提交
2770

B
binaryify 已提交
2771
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)