README.md 76.2 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. 歌手全部歌曲
186 187
168. 精品歌单标签列表
169. 用户等级信息
B
binaryify 已提交
188
170. 电台个性推荐
189 190 191 192 193 194 195 196
171. 用户绑定信息
172. 用户绑定手机
173. 新版评论
174. 点赞过的视频
175. 收藏视频到视频歌单
176. 删除视频歌单里的视频
177. 最近播放的视频
178. 音乐日历
B
v3.0.0  
binaryify 已提交
197

B
improve  
binaryify 已提交
198
## 安装
B
improve  
binaryify 已提交
199 200

```shell
201
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
202

203
$ npm install
B
binaryify 已提交
204
```
B
improve  
binaryify 已提交
205

206
## 运行
B
improve  
binaryify 已提交
207 208

```shell
N
nujhong 已提交
209
$ node app.js
B
binaryify 已提交
210 211
```

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

B
binaryify 已提交
214 215 216 217
```shell
$ PORT=4000 node app.js
```

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

B
binaryify 已提交
220 221 222
```shell
$ set PORT=4000 && node app.js
```
B
binaryify 已提交
223

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

```shell
B
binaryify 已提交
231
$ set HOST=127.0.0.1 && node app.js
B
#615  
binaryify 已提交
232
```
233 234 235 236 237 238
## 可以使用代理

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

```javascript
// 例子
B
v3.0.0  
binaryify 已提交
239
const url = `http://localhost:3000/song/url?id=33894312&proxy=http://121.196.226.246:84`
240 241 242 243 244 245 246
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}
```
247
v3.3.0 后支持使用 PAC代理,如 `?proxy=http://192.168.0.1/proxy.pac`
B
binaryify 已提交
248

B
binaryify 已提交
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
## 可以在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 已提交
272 273 274 275 276 277 278 279 280
## 支持 TypeScript
```ts
// test.ts
import { banner } from 'NeteaseCloudMusicApi'
banner({ type:0 }).then(res=>{
  console.log(res)
})
```

B
binaryify 已提交
281
## 更新到 v3.0 说明
B
binaryify 已提交
282

B
binaryify 已提交
283
!>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+ 将不再维护
284

B
improve  
binaryify 已提交
285 286
## Docker 容器运行

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

request 相关的环境变量

291 292 293 294 295 296 297
1. http_proxy
2. https_proxy
3. HTTP_PROXY
4. HTTPS_PROXY
5. no_proxy
6. NO_PROXY

298
```shell
B
binaryify 已提交
299
docker pull binaryify/netease_cloud_music_api
300

B
binaryify 已提交
301 302 303 304 305
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
306 307

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

B
binaryify 已提交
309 310 311 312
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
313
```
B
binaryify 已提交
314

B
binaryify 已提交
315
> 以下是自行 build docker 镜像方式
316 317 318

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

320
$ sudo docker build . -t netease-music-api
321

322 323
$ sudo docker run -d -p 3000:3000 netease-music-api
```
B
binaryify 已提交
324

325
## 接口文档
B
improve  
binaryify 已提交
326

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

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

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

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

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

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

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

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

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

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

B
binaryify 已提交
353 354
!> 分页接口返回字段里有`more`,more为true则为有下一页

B
binaryify 已提交
355
### 登录
B
improve  
binaryify 已提交
356

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

B
improve  
binaryify 已提交
359
#### 1. 手机登录
360

361 362 363 364
**必选参数 :**   
`phone`: 手机号码

`password`: 密码
365 366


T
trazyn 已提交
367

368
**可选参数 :**   
B
binaryify 已提交
369
`countrycode`: 国家码,用于国外手机号登录,例如美国传入:`1`
370 371 372 373 374 375

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

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

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

B
improve  
binaryify 已提交
377
#### 2. 邮箱登录
B
binaryify 已提交
378

379
**必选参数 :**   
B
binaryify 已提交
380

381
`email`: 163 网易邮箱   
382

383
`password`: 密码
384

385 386 387 388
**可选参数 :**  

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

B
improve  
binaryify 已提交
389
**接口地址 :** `/login`
390

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

B
improve  
binaryify 已提交
393
完成登录后 , 会在浏览器保存一个 Cookies 用作登录凭证 , 大部分 API 都需要用到这个
394 395 396 397 398 399 400 401 402
Cookies,非跨域情况请求会自动带上 Cookies,跨域情况参考`调用前须知`

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

B
binaryify 已提交
404
#### 注意
B
improve  
binaryify 已提交
405 406

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

408
### 刷新登录
N
nujhong 已提交
409

B
improve  
binaryify 已提交
410 411 412
说明 : 调用此接口 , 可刷新登录状态

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

414 415 416 417 418 419 420 421 422
### 发送验证码

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

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

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

423
**接口地址 :** `/captcha/sent`
424

425
**调用例子 :** `/captcha/sent?phone=13xxx`
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440



### 验证验证码

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

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

`captcha`: 验证码

**可选参数 :**

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

441
**接口地址 :** `/captcha/verify`
442

443
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
444 445 446 447 448 449


### 注册(修改密码)

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

450
**必选参数 :** 
451 452 453 454 455 456 457 458 459

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

460 461 462 463
**接口地址 :** `/register/cellphone`

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

464
### 检测手机号码是否已注册
B
binaryify 已提交
465
说明 : 调用此接口 ,可检测手机号码是否已注册  
466 467
**必选参数 :** 
`phone` :  手机号码  
B
boyan 已提交
468 469
**可选参数 :**
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` 
470 471 472 473 474
**接口地址 :** `/cellphone/existence/check`

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

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

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

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

483 484 485 486 487 488 489 490 491 492 493 494 495
### 更换绑定手机
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

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

`captcha`: 新手机验证码

`phone` :  手机号码  

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

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

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

B
v2.20.3  
binaryify 已提交
499 500 501 502 503 504
### 退出登录

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

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

505
### 登录状态
B
binaryify 已提交
506

507 508 509
说明 : 调用此接口,可获取登录状态

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

511

B
binaryify 已提交
512 513
### 获取用户详情

B
binaryify 已提交
514
说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户详情
B
binaryify 已提交
515

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

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

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

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

B
binaryify 已提交
524
说明 : 登录后调用此接口 , 可以获取用户信息
525

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

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

530 531
### 获取用户等级信息

B
binaryify 已提交
532
说明 : 登录后调用此接口 , 可以获取用户等级信息,包含当前登录天数,听歌次数,下一等级需要的登录天数和听歌次数,当前等级进度,对应 https://music.163.com/#/user/level 
533 534 535 536 537

**接口地址 :** `/user/level`

**调用例子 :** `/user/level`

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

### 获取用户绑定信息

说明 : 登录后调用此接口 , 可以获取用户绑定信息

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


**接口地址 :** `/user/binding`

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


### 用户绑定手机

说明 : 登录后调用此接口 , 可以更换绑定手机

**必选参数 :**   

`phone` : 手机号码 

`oldcaptcha`: 原手机号码的验证码

`captcha`:新手机号码的验证码

**可选参数 :**  

`countrycode`: 国家地区代码,默认86


**接口地址 :** `/user/replacephone`

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


573 574
### 更新用户信息

B
binaryify 已提交
575
说明 : 登录后调用此接口 , 传入相关信息,可以更新用户信息
576 577

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

579 580
```
gender: 性别 0:保密 1:男性 2:女性
581

582
birthday: 出生日期,时间戳 unix timestamp
583

584
nickname: 用户昵称
585

586
province: 省份id
587

588
city: 城市id
589

590 591 592
signature:用户签名
```

B
binaryify 已提交
593
**接口地址 :** `/user/update`
594

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

597
### 更新头像
B
binaryify 已提交
598
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新头像(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/avatar_update.html)
599 600 601 602 603 604 605 606 607 608 609 610

**可选参数 :**

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

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

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

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

611 612 613 614 615
### 国家编码列表
说明 : 调用此接口,可获取国家编码列表

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

B
binaryify 已提交
616
### 获取用户歌单
617

B
binaryify 已提交
618
说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户歌单
619

B
binaryify 已提交
620 621 622 623 624 625 626
**必选参数 :** `uid` : 用户 id  

**可选参数 :**

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

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

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

B
improve  
binaryify 已提交
630 631 632
**调用例子 :** `/user/playlist?uid=32953014`

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

635 636
### 更新歌单

B
binaryify 已提交
637
说明 : 登录后调用此接口,可以更新用户歌单
B
binaryify 已提交
638 639

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

641 642
```
id:歌单id
643

B
binaryify 已提交
644
name:歌单名字
645

646
desc:歌单描述
647

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

651 652
**接口地址 :** `/playlist/update`

B
binaryify 已提交
653
**调用例子 :** `/playlist/update?id=24381616&name=新歌单&desc=描述&tags=欧美`
B
binaryify 已提交
654 655

### 更新歌单描述
B
binaryify 已提交
656
说明 : 登录后调用此接口,可以单独更新用户歌单描述
B
binaryify 已提交
657

B
binaryify 已提交
658
**必选参数 :**  
B
binaryify 已提交
659 660 661 662 663 664 665 666 667 668 669
```
id:歌单id

desc:歌单描述

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

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

### 更新歌单名
B
binaryify 已提交
670
说明 : 登录后调用此接口,可以单独更新用户歌单名
B
binaryify 已提交
671 672

**必选参数 :**  
B
binaryify 已提交
673 674 675 676 677 678 679 680 681 682 683 684

```
id: 歌单id

name: 歌单名

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

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

### 更新歌单标签
B
binaryify 已提交
685
说明 : 登录后调用此接口,可以单独更新用户歌单标签
B
binaryify 已提交
686 687

**必选参数 :**  
B
binaryify 已提交
688 689 690 691 692 693 694 695 696 697

```
id: 歌单id

tags: 歌单标签

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

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

699 700

### 歌单封面上传
B
binaryify 已提交
701
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新歌单封面(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/playlist_cover_update.html)
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

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

**可选参数 :**

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

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

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

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


B
v3.32.0  
binaryify 已提交
718
### 调整歌单顺序
B
binaryify 已提交
719
说明 : 登录后调用此接口,可以根据歌单id顺序调整歌单顺序
B
binaryify 已提交
720 721


B
v3.32.0  
binaryify 已提交
722 723 724 725 726 727 728 729
**必选参数 :**   

`ids`: 歌单id列表

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

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

B
binaryify 已提交
730
### 调整歌曲顺序
B
binaryify 已提交
731
说明 : 登录后调用此接口,可以根据歌曲id顺序调整歌曲顺序  
B
binaryify 已提交
732 733 734 735 736 737 738 739 740 741 742


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

`ids`: 歌曲id列表

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

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

743 744
### 获取用户电台

B
binaryify 已提交
745
说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户电台
B
improve  
binaryify 已提交
746 747

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

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

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

B
improve  
binaryify 已提交
753
### 获取用户关注列表
754

B
binaryify 已提交
755
说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户关注列表
B
improve  
binaryify 已提交
756 757

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

B
binaryify 已提交
759
**可选参数 :**  
760

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

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

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

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

B
improve  
binaryify 已提交
769
### 获取用户粉丝列表
770

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

773 774 775 776 777
**必选参数 :** `uid` : 用户 id  

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

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


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

782
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&time=1560152549136`
783 784 785

### 获取用户动态

B
binaryify 已提交
786
说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户动态
B
improve  
binaryify 已提交
787 788

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

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

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

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

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

B
binaryify 已提交
798 799 800 801 802 803 804 805 806 807 808 809
返回结果的`type`参数对应:
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
810
### 转发用户动态
B
binaryify 已提交
811
说明 : 登录后调用此接口 ,可以转发用户动态
B
binaryify 已提交
812 813 814 815 816 817 818 819 820 821 822 823

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

`evId` : 动态 id  

`forwards` : 转发的评论

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

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


B
binaryify 已提交
824
### 删除用户动态
B
binaryify 已提交
825
说明 : 登录后调用此接口 ,可以删除用户动态
B
binaryify 已提交
826 827 828 829 830 831 832

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

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

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

833
### 分享歌曲、歌单、mv、电台、电台节目到动态
B
binaryify 已提交
834
说明 : 登录后调用此接口 ,可以分享歌曲、歌单、mv、电台、电台节目到动态
835 836 837 838 839 840 841 842 843 844 845

**必选参数 :** `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 测试` 

846 847
### 获取动态评论

B
binaryify 已提交
848
说明 : 登录后调用此接口 , 可以获取动态下评论
849 850 851

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

852
**接口地址 :** `/comment/event`
853

854
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
855

B
v3.0.0  
binaryify 已提交
856 857
### 关注/取消关注用户

B
binaryify 已提交
858
说明 : 登录后调用此接口 , 传入用户 id, 和操作 t,可关注/取消关注用户
B
v3.0.0  
binaryify 已提交
859 860 861

**必选参数 :**

B
binaryify 已提交
862
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
863

B
binaryify 已提交
864
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
865 866 867 868 869

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

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

870 871
### 获取用户播放记录

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

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

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

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

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

882 883 884 885 886 887 888 889
### 获取热门话题

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

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

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

B
binaryify 已提交
890
**接口地址 :** `/hot/topic`
891

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

894 895 896 897 898 899 900 901

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

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

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

902
### 心动模式/智能播放
903
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
904 905 906 907 908 909 910 911 912 913 914
**必选参数 :** `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 已提交
915 916
### 获取动态消息

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

920 921 922 923
**必选参数 :** 
`pagesize` : 每页数据,默认20

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

B
improve  
binaryify 已提交
925 926
**接口地址 :** `/event`

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

929
### 歌手分类列表
B
binaryify 已提交
930

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

933
**可选参数 :**
934

935 936 937 938
`limit` : 返回数量 , 默认为 30

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

941
`type` 取值:
B
binaryify 已提交
942

943
```
B
binaryify 已提交
944
-1:全部
945 946 947 948
1:男歌手
2:女歌手
3:乐队
```
949

950 951 952 953 954 955 956 957
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
958
```
959
    
960 961 962

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

963
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
964 965


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

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

B
binaryify 已提交
970
**必选参数 :**
971

B
binaryify 已提交
972
`artistId` : 歌手 id
973

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

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

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

980 981 982

### 歌手热门50首歌曲

983
说明 : 调用此接口,可获取歌手热门50首歌曲
984 985 986 987 988 989 990 991 992

**必选参数 :**

`id` : 歌手 id

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

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

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
### 歌手全部歌曲
说明 : 调用此接口,可获取歌手全部歌曲
**必选参数 :**

`id` : 歌手 id

**可选参数 :**

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

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

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

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

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

1011
### 收藏的歌手列表
B
binaryify 已提交
1012

1013 1014 1015 1016 1017 1018
说明 : 调用此接口,可获取收藏的歌手列表

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

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

B
v3.0.0  
binaryify 已提交
1019 1020 1021 1022
### 收藏视频

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

B
binaryify 已提交
1023
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032

`id` : 视频 id

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

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

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

1033
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
1034

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

B
binaryify 已提交
1037
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1038

B
binaryify 已提交
1039
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
1040 1041 1042 1043 1044 1045 1046

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

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

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

1047 1048 1049 1050 1051 1052 1053 1054
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
1055
### 歌单分类
B
binaryify 已提交
1056

B
binaryify 已提交
1057 1058 1059 1060 1061 1062 1063
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

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

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

B
binaryify 已提交
1085
**接口地址 :** `/top/playlist`
1086

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

1089 1090 1091 1092 1093 1094 1095
### 精品歌单标签列表
说明 : 调用此接口 , 可获取精品歌单标签列表

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

**调用例子 :** `/playlist/highquality/tags`

B
improve  
binaryify 已提交
1096
### 获取精品歌单
1097

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

B
improve  
binaryify 已提交
1100
**可选参数 :** `cat`: tag, 比如 " 华语 "、" 古风 " 、" 欧美 "、" 流行 ", 默认为
1101
"全部",可从精品歌单标签列表接口获取(`/playlist/highquality/tags`)
1102

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

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

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

1109
**调用例子 :** `/top/playlist/highquality?before=1503639064232&limit=3`
1110

B
binaryify 已提交
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
### 相关歌单推荐

说明 : 调用此接口,传入歌单 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 已提交
1121
### 获取歌单详情
1122

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

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

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

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

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

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

### 获取音乐 url
1138

1139
说明 : 使用歌单详情接口后 , 能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口, 传入的音乐 id( 可多个 , 用逗号隔开 ), 可以获取对应的音乐的 url,未登录状态返回试听片段(返回字段包含被截取的正常歌曲的开始时间和结束时间)
B
improve  
binaryify 已提交
1140

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

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

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

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

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

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

1154
### 音乐是否可用
B
binaryify 已提交
1155

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

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

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

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

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

1166
### 搜索
1167

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

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

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

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

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

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

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

B
binaryify 已提交
1187 1188 1189 1190 1191 1192

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

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

1193
### 热搜列表(简略)
B
binaryify 已提交
1194

B
binaryify 已提交
1195 1196 1197 1198 1199 1200
说明 : 调用此接口,可获取热门搜索列表

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

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

1201 1202 1203 1204 1205 1206 1207 1208
### 热搜列表(详细)

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

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

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

1209 1210
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1222 1223
### 搜索多重匹配

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

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

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

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

1232 1233 1234 1235
### 新建歌单

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

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

1238
**可选参数 :**   
1239

1240
`privacy` : 是否设置为隐私歌单,默认否,传'10'则设置成隐私歌单  
1241

1242
`type` : 歌单类型,默认'NORMAL',传 'VIDEO'则为视频歌单
1243

1244
**接口地址 :** `/playlist/create`
1245

1246
**调用例子 :** `/playlist/create?name=测试歌单`,`/playlist/create?name=test&type=VIDEO`
B
binaryify 已提交
1247 1248 1249 1250 1251

### 删除歌单

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

B
binaryify 已提交
1252
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1253 1254 1255

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

B
binaryify 已提交
1256
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1257 1258


1259 1260 1261 1262 1263
### 收藏/取消收藏歌单

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

**必选参数 :**
1264

B
binaryify 已提交
1265
`t` : 类型,1:收藏,2:取消收藏
1266 1267 1268 1269 1270 1271
`id` : 歌单 id

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

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

1272

1273

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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


1289
### 对歌单添加或删除歌曲
B
binaryify 已提交
1290

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

1293
**必选参数 :**
1294

1295 1296 1297 1298
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

B
binaryify 已提交
1302
**调用例子 :** `/playlist/tracks?op=add&pid=24381616&tracks=347231` ( 对应把歌曲添加到 ' 我 ' 的歌单 , 测试的时候请把这里的 pid 换成你自己的, id 和 tracks 不对可能会报 502 错误)
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
### 收藏视频到视频歌单
说明 : 调用此接口 , 可收藏视频到视频歌单 ( 需要登录 )

**必选参数 :**

`pid` : 歌单 id

`ids` : 视频id,支持多个,用`,`隔开

**接口地址 :** `/playlist/track/add`

**调用例子 :** `/playlist/track/add?pid=5271999357&ids=186041`

### 删除视频歌单里的视频
说明 : 调用此接口 , 可删除视频歌单里的视频 ( 需要登录 )
**必选参数 :**

`pid` : 歌单 id

`ids` : 视频id,支持多个,用`,`隔开

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

**调用例子 :** `/playlist/track/delete?pid=5271999357&ids=186041`

### 最近播放的视频
说明 : 调用此接口 , 可获取最近播放的视频 ( 需要登录 )

**接口地址 :** `/playlist/video/recent`

**调用例子 :** `/playlist/video/recent`

B
binaryify 已提交
1336
### 获取歌词
1337

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

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

B
improve  
binaryify 已提交
1342
**接口地址 :** `/lyric`
1343

B
improve  
binaryify 已提交
1344 1345 1346
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1359

B
binaryify 已提交
1360
华语:7
1361

B
binaryify 已提交
1362
欧美:96
1363

B
binaryify 已提交
1364
日本:8
1365

B
binaryify 已提交
1366 1367 1368 1369 1370 1371 1372
韩国:16
```

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

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

1373 1374 1375
### 首页-发现
说明 : 调用此接口 , 可获取APP首页信息

B
binaryify 已提交
1376 1377 1378 1379
**接口地址 :** `/homepage/block/page` 

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

1380 1381 1382 1383 1384 1385 1386

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

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


1387
### 歌曲评论
1388

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

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

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

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

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

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

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

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

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
### 歌曲楼层评论

说明 : 调用此接口 , 传入音乐 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` 

1443 1444
### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1456 1457 1458
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1459 1460 1461

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1475
**调用例子 :** `/comment/playlist?id=705123491`
1476 1477 1478

### mv 评论

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

B
improve  
binaryify 已提交
1482
**必选参数 :** `id`: mv id
1483

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

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

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

B
improve  
binaryify 已提交
1490 1491 1492
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1493 1494 1495

### 电台节目评论

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

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

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

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

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

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

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

1511 1512 1513 1514 1515 1516 1517 1518 1519
### 视频评论

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

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

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

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

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

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1529 1530

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1531 1532 1533 1534 1535 1536 1537 1538 1539

**必选参数 :**

`id` : 资源 id

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

```
0: 歌曲
1540

1541
1: mv
1542

1543
2: 歌单
1544

1545
3: 专辑
1546

1547
4: 电台
1548

1549 1550
5: 视频
```
B
v2.20.3  
binaryify 已提交
1551

1552 1553 1554 1555 1556 1557
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

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

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

1558 1559 1560 1561
**接口地址 :** `/comment/hot`

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

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
### 新版评论接口
说明 : 调用此接口 , 传入资源类型和资源id,以及排序方式,可获取对应资源的评论

**必选参数 :**   
`id` : 资源 id, 如歌曲 id,mv id  

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

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频

6: 动态
```
**可选参数 :**   
`pageNo`:分页参数,第N页,默认为1

`pageSize`:分页参数,每页多少条数据,默认20

`sortType` 排序方式,1:按推荐排序,2:按热度排序,3:按时间排序


B
binaryify 已提交
1592 1593
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1599
`cid` : 评论 id
B
binaryify 已提交
1600

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

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

B
binaryify 已提交
1605 1606
```
0: 歌曲
1607

B
binaryify 已提交
1608
1: mv
1609

B
binaryify 已提交
1610
2: 歌单
1611

N
nujhong 已提交
1612
3: 专辑
1613

B
binaryify 已提交
1614
4: 电台
1615

1616
5: 视频
1617 1618

6: 动态
B
improve  
binaryify 已提交
1619
```
N
nujhong 已提交
1620

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

B
binaryify 已提交
1623
**调用例子 :** `/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 已提交
1624

1625 1626 1627

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

B
binaryify 已提交
1628 1629 1630 1631 1632 1633 1634 1635
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1636
   **必选参数**
1637

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

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

   ```
   0: 歌曲
1644

B
binaryify 已提交
1645
   1: mv
1646

B
binaryify 已提交
1647
   2: 歌单
1648

B
binaryify 已提交
1649
   3: 专辑
1650

B
binaryify 已提交
1651
   4: 电台
1652

1653
   5: 视频
1654 1655

   6: 动态
B
binaryify 已提交
1656 1657 1658 1659 1660 1661
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1668
2. 删除评论
B
binaryify 已提交
1669 1670

   **必选参数**
1671

B
v3.0.0  
binaryify 已提交
1672
   `t`:0 删除
B
binaryify 已提交
1673

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

   ```
   0: 歌曲
1679

B
binaryify 已提交
1680
   1: mv
1681

B
binaryify 已提交
1682
   2: 歌单
1683

B
binaryify 已提交
1684
   3: 专辑
1685

B
binaryify 已提交
1686
   4: 电台
1687 1688


1689
   5: 视频
1690 1691 1692

   6: 动态
   
B
binaryify 已提交
1693 1694 1695 1696
   ```

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

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

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

B
binaryify 已提交
1703

1704 1705
### banner

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

1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
**可选参数 :**

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

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1722 1723
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1730
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1731 1732

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

B
v3.0.0  
binaryify 已提交
1734 1735
```
1: mv
1736

B
v3.0.0  
binaryify 已提交
1737
4: 电台
1738

B
v3.0.0  
binaryify 已提交
1739
5: 视频
1740 1741

6: 动态
B
v3.0.0  
binaryify 已提交
1742 1743
```

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

B
binaryify 已提交
1746
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1747 1748 1749 1750 1751

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

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

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

1755 1756 1757 1758 1759 1760 1761 1762
### 获取点赞过的视频

说明 : 调用此接口, 可获取获取点赞过的视频  

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

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

B
binaryify 已提交
1763 1764
### 获取歌曲详情

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

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

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

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

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

B
binaryify 已提交
1776
### 获取专辑内容
1777

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

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

B
improve  
binaryify 已提交
1782
**接口地址 :** `/album`
1783

B
improve  
binaryify 已提交
1784 1785 1786
**调用例子 :** `/album?id=32311`

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

1789

B
binaryify 已提交
1790
### 专辑动态信息
1791 1792 1793 1794 1795 1796 1797 1798
说明 : 调用此接口 , 传入专辑 id, 可获得专辑动态信息,如是否收藏,收藏数,评论数,分享数

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

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

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

1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

1826
### 获取歌手单曲
1827

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

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

B
improve  
binaryify 已提交
1832
**接口地址 :** `/artists`
1833

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

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

1839
### 获取歌手 mv
B
improve  
binaryify 已提交
1840 1841 1842

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

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

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

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

1851
### 获取歌手专辑
1852

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

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

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

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

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

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

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

1869 1870
### 获取歌手描述

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

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

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

B
improve  
binaryify 已提交
1877
**调用例子 :** `/artist/desc?id=6452` ( 周杰伦 )
1878 1879 1880

### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
1907
**调用例子 :** `/simi/mv?mvid=5436712`
1908 1909 1910

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
1925 1926 1927
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
1929
### 获取每日推荐歌单
1930

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

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

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

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

B
binaryify 已提交
1940
### 获取每日推荐歌曲
1941

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

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

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

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

1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968
### 获取历史日推可用日期列表

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

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

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

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

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

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

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

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

1969 1970
### 私人 FM

B
improve  
binaryify 已提交
1971 1972 1973
说明 : 私人 FM( 需要登录 )

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

B
improve  
binaryify 已提交
1975
**调用例子 :** `/personal_fm`
1976

B
improve  
binaryify 已提交
1977
返回数据如下图 :
1978 1979 1980 1981 1982

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

### 签到

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

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

B
improve  
binaryify 已提交
1988
**接口地址 :** `/daily_signin`
1989

B
improve  
binaryify 已提交
1990 1991 1992
**调用例子 :** `/daily_signin`

返回数据如下图 :
1993

B
binaryify 已提交
1994
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
1995 1996 1997 1998

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

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

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

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

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

B
improve  
binaryify 已提交
2006
**接口地址 :** `/like`
2007

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

B
improve  
binaryify 已提交
2010
返回数据如下图 :
2011 2012 2013

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

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

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

2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
### 喜欢音乐列表

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

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

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

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

2028 2029
### 垃圾桶

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

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

B
improve  
binaryify 已提交
2034
**接口地址 :** `/fm_trash`
2035

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

B
improve  
binaryify 已提交
2038
返回数据如下图 :
2039 2040 2041

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

2042
### 新碟上架
N
nujhong 已提交
2043

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

2047 2048 2049
**可选参数 :**    

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

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

2054 2055 2056 2057 2058 2059 2060 2061
`area`: ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

`year` : 年,默认本年

`month` : 月,默认本月

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

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

2066
### 全部新碟
B
binaryify 已提交
2067
说明 : 登录后调用此接口 ,可获取全部新碟  
2068 2069 2070 2071 2072 2073

**可选参数 :**

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

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

2075 2076 2077 2078 2079
`area` : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

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

T
trazyn 已提交
2081 2082 2083 2084 2085 2086
### 最新专辑

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

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

B
binaryify 已提交
2087
**调用例子 :** `/album/newest`
T
trazyn 已提交
2088 2089 2090 2091 2092 2093 2094

### 听歌打卡

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

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

2095
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
2096 2097 2098

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

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

2101
### 热门歌手
N
nujhong 已提交
2102

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

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

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

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

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

B
improve  
binaryify 已提交
2114
返回数据如下图 :
2115 2116 2117

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

2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

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

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

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

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

2132 2133 2134 2135 2136
**接口地址 :** `/mv/all`

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

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

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

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

B
improve  
binaryify 已提交
2143 2144 2145
**接口地址 :** `/mv/first`

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

2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
### 网易出品mv

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

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

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

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

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

2160
### 推荐 mv
N
nujhong 已提交
2161

B
improve  
binaryify 已提交
2162 2163 2164
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
2166
**调用例子 :** `/personalized/mv`
2167 2168

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

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

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

B
improve  
binaryify 已提交
2174
**接口地址 :** `/personalized`
2175

2176 2177 2178
**调用例子 :** `/personalized?limit=1`


2179 2180

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

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

B
improve  
binaryify 已提交
2184 2185 2186
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
2187 2188

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

B
improve  
binaryify 已提交
2190 2191 2192
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
2194
**调用例子 :** `/personalized/djprogram`
2195 2196

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

B
improve  
binaryify 已提交
2198 2199 2200
说明 : 调用此接口 , 可获取推荐电台

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

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

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

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

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

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

B
binaryify 已提交
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225
### 独家放送列表

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

**可选参数 :**

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

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

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

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

2226
### mv 排行
N
nujhong 已提交
2227

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

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

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

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

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

2239
**调用例子 :** `/top/mv?limit=10`
2240 2241

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

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

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

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

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

B
improve  
binaryify 已提交
2253
返回数据如下图 :
B
binaryify 已提交
2254

2255 2256 2257 2258
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

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

2261 2262 2263 2264 2265
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
2267
### mv 地址
2268

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

2271 2272 2273
**必选参数 :** `id`: mv id

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

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

**调用例子 :**
2278

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

2281 2282 2283 2284 2285 2286 2287
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

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

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

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

B
binaryify 已提交
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
**接口地址 :** `/video/category/list`

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

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

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

**可选参数 :** `offset`: 默认0
2301 2302 2303 2304 2305

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

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

B
binaryify 已提交
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
### 获取全部视频列表 
说明 : 调用此接口,可获取视频分类列表,分页参数只能传入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 已提交
2326
### 相关视频
B
binaryify 已提交
2327

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

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

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

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

2336

B
v3.0.0  
binaryify 已提交
2337
### 视频详情
B
binaryify 已提交
2338

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

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

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

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

2347 2348 2349 2350 2351 2352 2353 2354
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

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

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

2355
### 获取视频播放地址
B
binaryify 已提交
2356

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

B
v3.0.0  
binaryify 已提交
2359 2360 2361 2362 2363 2364
**必选参数 :** `id`: 视频 的 id

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

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

2365

2366
### 所有榜单
2367

2368 2369
说明 : 调用此接口,可获取所有榜单
**接口地址 :** `/toplist`
2370

2371
**调用例子 :** `/toplist`
2372

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

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

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

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

B
binaryify 已提交
2382
~~**调用例子 :** `/top/list?id=2809577409`~~
2383 2384


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

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

B
v3.0.0  
binaryify 已提交
2389 2390 2391 2392
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2393 2394
### 歌手榜

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

B
binaryify 已提交
2397 2398 2399 2400 2401 2402 2403 2404
**可选参数 :**
```
type : 地区
1: 华语
2: 欧美
3: 韩国
4: 日本
```
B
improve  
binaryify 已提交
2405 2406 2407
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2408 2409 2410

### 云盘

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

2414 2415 2416 2417 2418 2419
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2420 2421 2422
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2424
### 云盘数据详情
B
binaryify 已提交
2425
说明 : 登录后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情
B
binaryify 已提交
2426 2427 2428 2429 2430 2431 2432 2433

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

**接口地址 :** `/user/cloud/detail`

**调用例子 :** `/user/cloud/detail?id=5374627`


2434
### 云盘歌曲删除
B
binaryify 已提交
2435
说明 : 登录后调用此接口 , 可删除云盘歌曲
2436 2437 2438 2439 2440 2441 2442

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

**接口地址 :** `/user/cloud/del`

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

B
binaryify 已提交
2443 2444 2445 2446 2447 2448 2449
### 电台banner
说明 : 调用此接口,可获取电台banner

**接口地址 :** `/dj/banner`

**调用例子 :** `/dj/banner`

B
binaryify 已提交
2450 2451 2452 2453 2454 2455 2456 2457 2458
### 电台个性推荐
说明 : 调用此接口,可获取电台个性推荐列表
**可选参数 :**

`limit` : 返回数量,默认为 6,总条数最多6条

**接口地址 :** `/dj/personalize/recommend`

**调用例子 :** `/dj/personalize/recommend?limit=5`
B
binaryify 已提交
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481

### 用户电台

说明 : 调用此接口, 传入用户id可获取用户创建的电台

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

**接口地址 :** `/user/audio`

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

### 热门电台
说明 : 调用此接口,可获取热门电台

**可选参数 :**

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

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

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

2482 2483
### 电台 - 节目榜

B
binaryify 已提交
2484
说明 : 登录后调用此接口 , 可获得电台节目榜
2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495

**可选参数 :**

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

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

**接口地址 :** `/dj/program/toplist`

**调用例子 :** `/dj/program/toplist?limit=1`

2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/pay`

**调用例子 :** `/dj/toplist/pay?limit=30`


### 电台 - 24小时节目榜
说明 : 调用此接口,可获取24小时节目榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

B
binaryify 已提交
2515
**接口地址 :** `/dj/program/toplist/hours`
2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552

**调用例子 :** `/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`

2553 2554
### 电台 - 新晋电台榜/热门电台榜

B
binaryify 已提交
2555
说明 : 登录后调用此接口 , 可获得新晋电台榜/热门电台榜
2556 2557 2558 2559 2560 2561

**可选参数 :**

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

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

`type`: 榜单类型, `new` 为新晋电台榜,`hot`为热门电台榜

2565 2566 2567 2568
**接口地址 :** `/dj/toplist`

**调用例子 :** `/dj/toplist?type=hot` `/dj/toplist?type=new&limit=1`

B
binaryify 已提交
2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
### 电台 - 类别热门电台

**可选参数 :**

`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 已提交
2583
### 电台 - 推荐
2584

B
binaryify 已提交
2585
说明 : 登录后调用此接口 , 可获得推荐电台
2586

B
improve  
binaryify 已提交
2587
**接口地址 :** `/dj/recommend`
2588

B
improve  
binaryify 已提交
2589
**调用例子 :** `/dj/recommend`
2590

B
improve  
binaryify 已提交
2591
### 电台 - 分类
2592

B
binaryify 已提交
2593
说明 : 登录后调用此接口 , 可获得电台类型
2594

B
improve  
binaryify 已提交
2595
**接口地址 :** `/dj/catelist`
2596

B
improve  
binaryify 已提交
2597
**调用例子 :** `/dj/catelist`
2598

B
improve  
binaryify 已提交
2599
### 电台 - 分类推荐
2600

B
binaryify 已提交
2601
说明 : 登录后调用此接口 , 传入分类,可获得对应类型电台列表
2602

B
improve  
binaryify 已提交
2603
**必选参数 :** `type`: 电台类型 , 数字 , 可通过`/dj/catelist`获取 , 对应关系为
B
binaryify 已提交
2604
id 对应 此接口的 type, name 对应类型
2605

B
improve  
binaryify 已提交
2606
**接口地址 :** `/dj/recommend/type`
2607

B
binaryify 已提交
2608
**调用例子 :** `/dj/recommend/type?type=1`(明星做主播) `/dj/recommend/type?type=2001` (创作|翻唱)
2609

B
improve  
binaryify 已提交
2610
### 电台 - 订阅
2611

B
binaryify 已提交
2612
说明 : 登录后调用此接口 , 传入`rid`, 可订阅 dj,dj 的 `rid` 可通过搜索指定
B
improve  
binaryify 已提交
2613
type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
2614

B
improve  
binaryify 已提交
2615
**必选参数 :** `rid`: 电台 的 id
2616

B
improve  
binaryify 已提交
2617
**接口地址 :** `/dj/sub`
2618

B
improve  
binaryify 已提交
2619 2620
**调用例子 :** `/dj/sub?rid=336355127&t=1` ( 对应关注 ' 代码时间 ')
`/dj/sub?rid=336355127&t=0` ( 对应取消关注 ' 代码时间 ')
2621

2622 2623
### 电台的订阅列表

B
binaryify 已提交
2624
说明 : 登录后调用此接口 , 可获取订阅的电台列表
2625 2626 2627 2628 2629

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

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

add doc  
徐星宇 已提交
2630 2631 2632 2633
### 电台 - 付费精选

说明 : 可以获取付费精选的电台列表 , 传入 `limit``offset` 可以进行分页

2634 2635 2636 2637 2638 2639
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2640 2641 2642 2643
**接口地址 :** `/dj/paygift`

**调用例子 :** `/dj/paygift?limit=10&offset=20`

2644 2645
### 电台 - 非热门类型

B
binaryify 已提交
2646
说明 : 登录后调用此接口, 可获得电台非热门类型
2647 2648 2649 2650 2651 2652 2653 2654


**接口地址 :** `/dj/category/excludehot`

**调用例子 :** `/dj/category/excludehot`

### 电台 - 推荐类型

B
binaryify 已提交
2655
说明 : 登录后调用此接口, 可获得电台推荐类型
2656 2657 2658 2659 2660 2661 2662 2663


**接口地址 :** `/dj/category/recommend`

**调用例子 :** `/dj/category/recommend`

### 电台 - 今日优选

B
binaryify 已提交
2664
说明 : 登录后调用此接口, 可获得电台今日优选
2665 2666 2667 2668 2669 2670


**接口地址 :** `/dj/today/perfered`

**调用例子 :** `/dj/today/perfered`

B
improve  
binaryify 已提交
2671
### 电台 - 详情
2672

B
binaryify 已提交
2673
说明 : 登录后调用此接口 , 传入`rid`, 可获得对应电台的详情介绍
2674

B
improve  
binaryify 已提交
2675
**必选参数 :** `rid`: 电台 的 id
2676

2677
**接口地址 :** `/dj/detail`
2678

B
improve  
binaryify 已提交
2679
**调用例子 :** `/dj/detail?rid=336355127` ( 对应 ' 代码时间 ' 的详情介绍 )
2680

B
improve  
binaryify 已提交
2681
### 电台 - 节目
2682

B
binaryify 已提交
2683
说明 : 登录后调用此接口 , 传入`rid`, 可查看对应电台的电台节目以及对应的 id, 需要
B
v3.0.0  
binaryify 已提交
2684 2685
注意的是这个接口返回的 mp3Url 已经无效 , 都为 null, 但是通过调用 `/song/url`
个接口 , 传入节目 id 仍然能获取到节目音频 , 如 `/song/url?id=478446370` 获取代
B
improve  
binaryify 已提交
2686 2687 2688 2689
码时间的一个节目的音频

**必选参数 :** `rid`: 电台 的 id

B
binaryify 已提交
2690
**可选参数 :**
2691

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

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

2696 2697
`asc` : 排序方式,默认为 `false` (新 => 老 ) 设置 `true` 可改为 老 => 新 

B
improve  
binaryify 已提交
2698 2699
**接口地址 :** `/dj/program`

B
binaryify 已提交
2700
**调用例子 :** `/dj/program?rid=336355127&limit=40` ( 对应 ' 代码时间 ' 的节目列表 )
2701

B
binaryify 已提交
2702 2703 2704 2705 2706 2707 2708 2709
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

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

**接口地址 :** `/dj/program/detail`

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2710 2711 2712

### 通知 - 私信

B
binaryify 已提交
2713
说明 : 登录后调用此接口 ,可获取私信
B
binaryify 已提交
2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724

**可选参数 :**

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

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

**接口地址 :** `/msg/private`

**调用例子 :** `/msg/private?limit=3`

B
v3.12.0  
binaryify 已提交
2725 2726
### 发送私信

B
binaryify 已提交
2727
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)
B
v3.12.0  
binaryify 已提交
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737

**必选参数 :**

`user_ids` : 用户 id,多个需用逗号隔开

`msg` : 要发送的信息

**接口地址 :** `/send/text`

**调用例子 :** `/send/text?user_ids=32953014&msg=test`,`/send/text?user_ids=32953014,475625142&msg=test`
2738

B
v3.12.0  
binaryify 已提交
2739 2740

### 私信内容
B
binaryify 已提交
2741
说明 : 登录后调用此接口 , 可获取私信内容
B
v3.12.0  
binaryify 已提交
2742 2743 2744 2745 2746 2747 2748

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

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

2749
`before` : 分页参数,取上一页最后一项的 `time` 获取下一页数据
B
v3.12.0  
binaryify 已提交
2750 2751 2752 2753 2754 2755 2756 2757 2758

**接口地址 :** 
`/msg/private/history`

**调用例子 :**
`/msg/private/history?uid=9003` (云音乐小秘书)

### 发送私信(带歌单)

B
binaryify 已提交
2759
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)
B
v3.12.0  
binaryify 已提交
2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770

**必选参数 :**

`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 已提交
2771 2772 2773

### 通知 - 评论

B
binaryify 已提交
2774
说明 : 登录后调用此接口 ,可获取评论
B
binaryify 已提交
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790

**必选参数 :** `uid`: 用户 的 id,只能和登录账号的 id 一致

**可选参数 :**

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

`before` : 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据


**接口地址 :** `/msg/comments`

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

### 通知 - @我

B
binaryify 已提交
2791
说明 : 登录后调用此接口 ,可获取@我数据
B
binaryify 已提交
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805

**可选参数 :**

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

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

**接口地址 :** `/msg/forwards`

**调用例子 :** `/msg/forwards?limit=3`


### 通知 - 通知

B
binaryify 已提交
2806
说明 : 登录后调用此接口 ,可获取通知
B
binaryify 已提交
2807 2808 2809 2810 2811

**可选参数 :**

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

B
binaryify 已提交
2812
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
2813 2814 2815 2816 2817 2818 2819


**接口地址 :** `/msg/notices`

**调用例子 :** `/msg/notices?limit=3`

### 设置
B
binaryify 已提交
2820
说明 : 登录后调用此接口 ,可获取用户设置
B
binaryify 已提交
2821 2822 2823 2824 2825

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

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

2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878
### 数字专辑-新碟上架
说明 : 调用此接口 ,可获取数字专辑-新碟上架  

**可选参数 :**

`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 已提交
2879
### 我的数字专辑
B
binaryify 已提交
2880
说明 : 登录后调用此接口 ,可获取我的数字专辑
B
v3.12.0  
binaryify 已提交
2881 2882 2883 2884 2885

**接口地址 :** `/digitalAlbum/purchased`

**调用例子 :** `/digitalAlbum/purchased?limit=10`

T
TimonPeng 已提交
2886
### 购买数字专辑
B
binaryify 已提交
2887
说明 : 登录后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900

**必选参数 :**

`id` : 专辑的 id

`payment` : 支付方式, 0 为支付宝 3 为微信

`quantity` : 购买的数量

**接口地址 :** `/digitalAlbum/ordering`

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

2901 2902 2903 2904 2905 2906 2907 2908
### 音乐日历
说明 : 登录后调用此接口 传入开始和结束时间,可获取音乐日历

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

**调用例子 :** `/calendar?startTime=1606752000000&endTime=1609430399999`


B
v3.13.0  
binaryify 已提交
2909
### batch批量请求接口
B
binaryify 已提交
2910
说明 : 登录后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口
B
v3.13.0  
binaryify 已提交
2911 2912 2913 2914 2915 2916 2917

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

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
2918
## 离线访问此文档
B
binaryify 已提交
2919

B
improve  
binaryify 已提交
2920
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
2921 2922

## 关于此文档
B
improve  
binaryify 已提交
2923 2924 2925 2926

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
2927

B
binaryify 已提交
2928
## License
B
improve  
binaryify 已提交
2929

B
binaryify 已提交
2930
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)