README.md 64.6 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 113 114 115 116
87. 视频详情
88. 相关视频
89. 关注用户
90. 新歌速递
91. 喜欢音乐列表(无序)
92. 收藏的 MV 列表
93. 获取最新专辑
94. 听歌打卡
95. 获取视频标签下的视频
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
v3.0.0  
binaryify 已提交
166

B
improve  
binaryify 已提交
167
## 安装
B
improve  
binaryify 已提交
168 169

```shell
170
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
171

172
$ npm install
B
binaryify 已提交
173
```
B
improve  
binaryify 已提交
174

175
## 运行
B
improve  
binaryify 已提交
176 177

```shell
N
nujhong 已提交
178
$ node app.js
B
binaryify 已提交
179 180
```

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

B
binaryify 已提交
183 184 185 186
```shell
$ PORT=4000 node app.js
```

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

B
binaryify 已提交
189 190 191
```shell
$ set PORT=4000 && node app.js
```
B
binaryify 已提交
192

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

```shell
B
binaryify 已提交
200
$ set HOST=127.0.0.1 && node app.js
B
#615  
binaryify 已提交
201
```
202 203 204 205 206 207
## 可以使用代理

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

```javascript
// 例子
B
v3.0.0  
binaryify 已提交
208
const url = `http://localhost:3000/song/url?id=33894312&proxy=http://121.196.226.246:84`
209 210 211 212 213 214 215
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}
```
216
v3.3.0 后支持使用 PAC代理,如 `?proxy=http://192.168.0.1/proxy.pac`
B
binaryify 已提交
217

B
binaryify 已提交
218
## 更新到 v3.0 说明
B
binaryify 已提交
219

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

B
improve  
binaryify 已提交
222 223
## Docker 容器运行

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

request 相关的环境变量

228 229 230 231 232 233 234
1. http_proxy
2. https_proxy
3. HTTP_PROXY
4. HTTPS_PROXY
5. no_proxy
6. NO_PROXY

235
```shell
B
binaryify 已提交
236
docker pull binaryify/netease_cloud_music_api
237

B
binaryify 已提交
238 239 240 241 242
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
243 244

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

B
binaryify 已提交
246 247 248 249
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
250
```
B
binaryify 已提交
251

B
binaryify 已提交
252
> 以下是自行 build docker 镜像方式
253 254 255

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

257
$ sudo docker build . -t netease-music-api
258

259 260
$ sudo docker run -d -p 3000:3000 netease-music-api
```
B
binaryify 已提交
261

262
## 接口文档
B
improve  
binaryify 已提交
263

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

B
binaryify 已提交
267
!> 为使用方便,降低门槛, 文档示例接口直接使用了 GET 请求,本项目同时支持 GET/POST 请按实际需求使用
B
binaryify 已提交
268

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

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

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

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

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

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

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

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

B
binaryify 已提交
290
### 登录
B
improve  
binaryify 已提交
291 292 293

说明 : 登录有两个接口

B
improve  
binaryify 已提交
294
#### 1. 手机登录
295

296 297 298 299
**必选参数 :**   
`phone`: 手机号码

`password`: 密码
300

B
improve  
binaryify 已提交
301
**接口地址 :** `/login/cellphone`
302

T
trazyn 已提交
303 304
**可选参数 :** `countrycode`: 国家码,用于国外手机号登陆,例如美国传入:`1`

B
improve  
binaryify 已提交
305
**调用例子 :** `/login/cellphone?phone=xxx&password=yyy`
306

B
improve  
binaryify 已提交
307
#### 2. 邮箱登录
B
binaryify 已提交
308

309
**必选参数 :**   
B
binaryify 已提交
310

311
`email`: 163 网易邮箱   
312

313
`password`: 密码
314

B
improve  
binaryify 已提交
315
**接口地址 :** `/login`
316

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

B
improve  
binaryify 已提交
319
完成登录后 , 会在浏览器保存一个 Cookies 用作登录凭证 , 大部分 API 都需要用到这个
320 321 322 323 324 325 326 327 328
Cookies,非跨域情况请求会自动带上 Cookies,跨域情况参考`调用前须知`

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

B
binaryify 已提交
330
#### 注意
B
improve  
binaryify 已提交
331 332

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

334
### 刷新登录
N
nujhong 已提交
335

B
improve  
binaryify 已提交
336 337 338
说明 : 调用此接口 , 可刷新登录状态

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

340 341 342 343 344 345 346 347 348
### 发送验证码

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

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

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

349
**接口地址 :** `/captcha/sent`
350

351
**调用例子 :** `/captcha/sent?phone=13xxx`
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366



### 验证验证码

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

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

`captcha`: 验证码

**可选参数 :**

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

367
**接口地址 :** `/captcha/verify`
368

369
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
370 371 372 373 374 375


### 注册(修改密码)

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

376
**必选参数 :** 
377 378 379 380 381 382 383 384 385

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

386 387 388 389
**接口地址 :** `/register/cellphone`

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

390
### 检测手机号码是否已注册
B
binaryify 已提交
391
说明 : 调用此接口 ,可检测手机号码是否已注册  
392 393
**必选参数 :** 
`phone` :  手机号码  
B
boyan 已提交
394 395
**可选参数 :**
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` 
396 397 398 399 400
**接口地址 :** `/cellphone/existence/check`

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

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

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

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

409 410 411 412 413 414 415 416 417 418 419 420 421
### 更换绑定手机
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

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

`captcha`: 新手机验证码

`phone` :  手机号码  

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

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

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

B
v2.20.3  
binaryify 已提交
425 426 427 428 429 430
### 退出登录

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

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

431
### 登录状态
B
binaryify 已提交
432

433 434 435
说明 : 调用此接口,可获取登录状态

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

437

B
binaryify 已提交
438 439
### 获取用户详情

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

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

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

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

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

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

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

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

456 457 458 459 460
### 更新用户信息

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

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

462 463
```
gender: 性别 0:保密 1:男性 2:女性
464

465
birthday: 出生日期,时间戳 unix timestamp
466

467
nickname: 用户昵称
468

469
province: 省份id
470

471
city: 城市id
472

473 474 475
signature:用户签名
```

B
binaryify 已提交
476
**接口地址 :** `/user/update`
477

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

B
binaryify 已提交
480
### 获取用户歌单
481

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

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

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

B
improve  
binaryify 已提交
488 489 490
**调用例子 :** `/user/playlist?uid=32953014`

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

493 494 495 496
### 更新歌单

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

498 499
```
id:歌单id
500

B
binaryify 已提交
501
name:歌单名字
502

503
desc:歌单描述
504

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

508 509
**接口地址 :** `/playlist/update`

B
binaryify 已提交
510
**调用例子 :** `/playlist/update?id=24381616&name=新歌单&desc=描述&tags=欧美`
B
binaryify 已提交
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552

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

```
id:歌单id

desc:歌单描述

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

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

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

```
id: 歌单id

name: 歌单名

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

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

### 更新歌单标签
说明 : 登陆后调用此接口,可以单独更新用户歌单标签
参数:

```
id: 歌单id

tags: 歌单标签

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

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

554 555
### 获取用户电台

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

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

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

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

B
improve  
binaryify 已提交
564
### 获取用户关注列表
565

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

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

B
binaryify 已提交
570
**可选参数 :**
571

B
binaryify 已提交
572 573 574
`limit` : 返回数量 , 默认为 30

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

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

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

B
improve  
binaryify 已提交
581
### 获取用户粉丝列表
582

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

585 586 587 588 589
**必选参数 :** `uid` : 用户 id  

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

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


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

594
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&time=1560152549136`
595 596 597

### 获取用户动态

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

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

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

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

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

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

B
binaryify 已提交
610 611 612 613 614 615 616 617 618 619 620 621
返回结果的`type`参数对应:
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634 635
### 转发用户动态
说明 : 登陆后调用此接口 ,可以转发用户动态

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

`evId` : 动态 id  

`forwards` : 转发的评论

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

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


B
binaryify 已提交
636 637 638 639 640 641 642 643 644
### 删除用户动态
说明 : 登陆后调用此接口 ,可以删除用户动态

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

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

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

645 646 647 648 649 650 651 652 653 654 655 656 657
### 分享歌曲、歌单、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 测试` 

658 659 660 661 662 663
### 获取动态评论

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

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

664
**接口地址 :** `/comment/event`
665

666
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
667

B
v3.0.0  
binaryify 已提交
668 669 670 671 672 673
### 关注/取消关注用户

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

**必选参数 :**

B
binaryify 已提交
674
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
675

B
binaryify 已提交
676
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
677 678 679 680 681

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

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

682 683
### 获取用户播放记录

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

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

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

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

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

694 695 696 697 698 699 700 701
### 获取热门话题

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

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

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

B
binaryify 已提交
702
**接口地址 :** `/hot/topic`
703

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

706 707 708 709 710 711 712 713

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

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

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

714
### 心动模式/智能播放
715
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
716 717 718 719 720 721 722 723 724 725 726
**必选参数 :** `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 已提交
727 728
### 获取动态消息

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

732 733 734 735
**必选参数 :** 
`pagesize` : 每页数据,默认20

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

B
improve  
binaryify 已提交
737 738
**接口地址 :** `/event`

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

741
### 歌手分类列表
B
binaryify 已提交
742

B
binaryify 已提交
743 744 745 746
说明 : 调用此接口,可获取歌手分类列表  

**必选参数 :** `cat` : 即 category Code,歌手类型,默认 1001,返回华语男歌手数据  

747
**可选参数 :**
748

749 750 751 752
`limit` : 返回数量 , 默认为 30

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

755
`type` 取值:
B
binaryify 已提交
756

757
```
B
binaryify 已提交
758
-1:全部
759 760 761 762
1:男歌手
2:女歌手
3:乐队
```
763

764 765 766 767 768 769 770 771
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
772
```
773
    
774 775 776

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

777
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
778 779


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

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

B
binaryify 已提交
784
**必选参数 :**
785

B
binaryify 已提交
786
`artistId` : 歌手 id
787

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

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

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

794 795 796 797 798 799 800 801 802 803 804 805 806

### 歌手热门50首歌曲

说明 : 调用此接口,可获取

**必选参数 :**

`id` : 歌手 id

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

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

807
### 收藏的歌手列表
B
binaryify 已提交
808

809 810 811 812 813 814
说明 : 调用此接口,可获取收藏的歌手列表

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

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

B
v3.0.0  
binaryify 已提交
815 816 817 818
### 收藏视频

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

B
binaryify 已提交
819
**必选参数 :**
B
v3.0.0  
binaryify 已提交
820 821 822 823 824 825 826 827 828

`id` : 视频 id

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

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

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

829
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
830

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

B
binaryify 已提交
833
**必选参数 :**
B
v3.0.0  
binaryify 已提交
834

B
binaryify 已提交
835
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
836 837 838 839 840 841 842

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

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

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

843 844 845 846 847 848 849 850
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
851
### 歌单分类
B
binaryify 已提交
852

B
binaryify 已提交
853 854 855 856 857 858 859
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
861 862 863 864 865 866 867 868 869 870 871 872 873 874
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

B
binaryify 已提交
877
`limit`: 取出评论数量 , 默认为 50
B
binaryify 已提交
878

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

B
binaryify 已提交
881
**接口地址 :** `/top/playlist`
882

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

B
improve  
binaryify 已提交
885
### 获取精品歌单
886

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

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

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

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

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

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

B
binaryify 已提交
900 901 902 903 904 905 906 907 908 909
### 相关歌单推荐

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

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

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

B
binaryify 已提交
917
**可选参数 :** `s` : 歌单最近的 s 个收藏者
B
binaryify 已提交
918

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

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

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

### 获取音乐 url
927

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

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

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

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

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

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

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

944
### 音乐是否可用
B
binaryify 已提交
945

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

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

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

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

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

956
### 搜索
957

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

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

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

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

B
improve  
binaryify 已提交
970
**接口地址 :** `/search`
971

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

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

B
binaryify 已提交
977 978 979 980 981 982

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

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

983
### 热搜列表(简略)
B
binaryify 已提交
984

B
binaryify 已提交
985 986 987 988 989 990
说明 : 调用此接口,可获取热门搜索列表

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

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

991 992 993 994 995 996 997 998
### 热搜列表(详细)

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

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

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

999 1000
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1012 1013
### 搜索多重匹配

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

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

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

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

1022 1023 1024 1025
### 新建歌单

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

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

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

1030 1031 1032 1033
**接口地址 :** `/playlist/create`

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

1034

1035

B
binaryify 已提交
1036 1037 1038 1039 1040

### 删除歌单

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

B
binaryify 已提交
1041
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1042 1043 1044

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

B
binaryify 已提交
1045
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1046 1047


1048 1049 1050 1051 1052
### 收藏/取消收藏歌单

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

**必选参数 :**
1053

B
binaryify 已提交
1054
`t` : 类型,1:收藏,2:取消收藏
1055 1056 1057 1058 1059 1060
`id` : 歌单 id

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

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

1061

1062

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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


1078
### 对歌单添加或删除歌曲
B
binaryify 已提交
1079

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

1082
**必选参数 :**
1083

1084 1085 1086 1087
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

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

B
binaryify 已提交
1093
### 获取歌词
1094

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

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

B
improve  
binaryify 已提交
1099
**接口地址 :** `/lyric`
1100

B
improve  
binaryify 已提交
1101 1102 1103
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1116

B
binaryify 已提交
1117
华语:7
1118

B
binaryify 已提交
1119
欧美:96
1120

B
binaryify 已提交
1121
日本:8
1122

B
binaryify 已提交
1123 1124 1125 1126 1127 1128 1129
韩国:16
```

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

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

1130
### 歌曲评论
1131

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

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

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

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

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

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

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

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

### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1163 1164 1165
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1166 1167 1168

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1182
**调用例子 :** `/comment/playlist?id=705123491`
1183 1184 1185

### mv 评论

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

B
improve  
binaryify 已提交
1189
**必选参数 :** `id`: mv id
1190

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

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

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

B
improve  
binaryify 已提交
1197 1198 1199
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1200 1201 1202

### 电台节目评论

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

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

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

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

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

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

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

1218 1219 1220 1221 1222 1223 1224 1225 1226
### 视频评论

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

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

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

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

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

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1236 1237

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1238 1239 1240 1241 1242 1243 1244 1245 1246

**必选参数 :**

`id` : 资源 id

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

```
0: 歌曲
1247

1248
1: mv
1249

1250
2: 歌单
1251

1252
3: 专辑
1253

1254
4: 电台
1255

1256 1257
5: 视频
```
B
v2.20.3  
binaryify 已提交
1258

1259 1260 1261 1262 1263 1264
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

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

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

1265 1266 1267 1268
**接口地址 :** `/comment/hot`

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

B
binaryify 已提交
1269 1270
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1276
`cid` : 评论 id
B
binaryify 已提交
1277

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

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

B
binaryify 已提交
1282 1283
```
0: 歌曲
1284

B
binaryify 已提交
1285
1: mv
1286

B
binaryify 已提交
1287
2: 歌单
1288

N
nujhong 已提交
1289
3: 专辑
1290

B
binaryify 已提交
1291
4: 电台
1292

1293
5: 视频
1294 1295

6: 动态
B
improve  
binaryify 已提交
1296
```
N
nujhong 已提交
1297

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

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

1302 1303 1304

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

B
binaryify 已提交
1305 1306 1307 1308 1309 1310 1311 1312
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1313
   **必选参数**
1314

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

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

   ```
   0: 歌曲
1321

B
binaryify 已提交
1322
   1: mv
1323

B
binaryify 已提交
1324
   2: 歌单
1325

B
binaryify 已提交
1326
   3: 专辑
1327

B
binaryify 已提交
1328
   4: 电台
1329

1330
   5: 视频
1331 1332

   6: 动态
B
binaryify 已提交
1333 1334 1335 1336 1337 1338
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1345
2. 删除评论
B
binaryify 已提交
1346 1347

   **必选参数**
1348

B
v3.0.0  
binaryify 已提交
1349
   `t`:0 删除
B
binaryify 已提交
1350

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

   ```
   0: 歌曲
1356

B
binaryify 已提交
1357
   1: mv
1358

B
binaryify 已提交
1359
   2: 歌单
1360

B
binaryify 已提交
1361
   3: 专辑
1362

B
binaryify 已提交
1363
   4: 电台
1364 1365


1366
   5: 视频
1367 1368 1369

   6: 动态
   
B
binaryify 已提交
1370 1371 1372 1373
   ```

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

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

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

B
binaryify 已提交
1380

1381 1382
### banner

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

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
**可选参数 :**

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

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1399 1400
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1407
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1408 1409

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

B
v3.0.0  
binaryify 已提交
1411 1412
```
1: mv
1413

B
v3.0.0  
binaryify 已提交
1414
4: 电台
1415

B
v3.0.0  
binaryify 已提交
1416
5: 视频
1417 1418

6: 动态
B
v3.0.0  
binaryify 已提交
1419 1420
```

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

B
binaryify 已提交
1423
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1424 1425 1426 1427 1428

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

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

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

B
binaryify 已提交
1432 1433
### 获取歌曲详情

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

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

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

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

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

B
binaryify 已提交
1445
### 获取专辑内容
1446

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

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

B
improve  
binaryify 已提交
1451
**接口地址 :** `/album`
1452

B
improve  
binaryify 已提交
1453 1454 1455
**调用例子 :** `/album?id=32311`

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

1458

B
binaryify 已提交
1459
### 专辑动态信息
1460 1461 1462 1463 1464 1465 1466 1467
说明 : 调用此接口 , 传入专辑 id, 可获得专辑动态信息,如是否收藏,收藏数,评论数,分享数

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

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

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

1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

1495
### 获取歌手单曲
1496

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

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

B
improve  
binaryify 已提交
1501
**接口地址 :** `/artists`
1502

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

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

1508
### 获取歌手 mv
B
improve  
binaryify 已提交
1509 1510 1511

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

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

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

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

1520
### 获取歌手专辑
1521

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

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

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

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

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

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

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

1538 1539
### 获取歌手描述

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

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

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

B
improve  
binaryify 已提交
1546
**调用例子 :** `/artist/desc?id=6452` ( 周杰伦 )
1547 1548 1549

### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
1576
**调用例子 :** `/simi/mv?mvid=5436712`
1577 1578 1579

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
1594 1595 1596
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
1598
### 获取每日推荐歌单
1599

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

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

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

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

B
binaryify 已提交
1609
### 获取每日推荐歌曲
1610

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

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

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

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

### 私人 FM

B
improve  
binaryify 已提交
1622 1623 1624
说明 : 私人 FM( 需要登录 )

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

B
improve  
binaryify 已提交
1626
**调用例子 :** `/personal_fm`
1627

B
improve  
binaryify 已提交
1628
返回数据如下图 :
1629 1630 1631 1632 1633

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

### 签到

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

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

B
improve  
binaryify 已提交
1639
**接口地址 :** `/daily_signin`
1640

B
improve  
binaryify 已提交
1641 1642 1643
**调用例子 :** `/daily_signin`

返回数据如下图 :
1644

B
binaryify 已提交
1645
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
1646 1647 1648 1649

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

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

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

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

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

B
improve  
binaryify 已提交
1657
**接口地址 :** `/like`
1658

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

B
improve  
binaryify 已提交
1661
返回数据如下图 :
1662 1663 1664

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

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

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

1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
### 喜欢音乐列表

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

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

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

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

1679 1680
### 垃圾桶

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

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

B
improve  
binaryify 已提交
1685
**接口地址 :** `/fm_trash`
1686

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

B
improve  
binaryify 已提交
1689
返回数据如下图 :
1690 1691 1692

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

1693
### 新碟上架
N
nujhong 已提交
1694

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

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

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

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

B
improve  
binaryify 已提交
1705
**调用例子 :** `/top/album?offset=0&limit=30`
1706

B
improve  
binaryify 已提交
1707
返回数据如下图 :
1708 1709 1710

![新碟上架](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/new_albums.png)

T
trazyn 已提交
1711 1712 1713 1714 1715 1716
### 最新专辑

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

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

B
binaryify 已提交
1717
**调用例子 :** `/album/newest`
T
trazyn 已提交
1718 1719 1720 1721 1722 1723 1724

### 听歌打卡

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

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

1725
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
1726 1727 1728

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

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

1731
### 热门歌手
N
nujhong 已提交
1732

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

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

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

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

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

B
improve  
binaryify 已提交
1744
返回数据如下图 :
1745 1746 1747

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

1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

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

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

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

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

1762 1763 1764 1765 1766
**接口地址 :** `/mv/all`

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

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

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

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

B
improve  
binaryify 已提交
1773 1774 1775
**接口地址 :** `/mv/first`

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

1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
### 网易出品mv

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

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

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

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

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

1790
### 推荐 mv
N
nujhong 已提交
1791

B
improve  
binaryify 已提交
1792 1793 1794
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
1796
**调用例子 :** `/personalized/mv`
1797 1798

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

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

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

B
improve  
binaryify 已提交
1804
**接口地址 :** `/personalized`
1805

1806 1807 1808
**调用例子 :** `/personalized?limit=1`


1809 1810

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

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

B
improve  
binaryify 已提交
1814 1815 1816
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
1817 1818

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

B
improve  
binaryify 已提交
1820 1821 1822
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
1824
**调用例子 :** `/personalized/djprogram`
1825 1826

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

B
improve  
binaryify 已提交
1828 1829 1830
说明 : 调用此接口 , 可获取推荐电台

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

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

### 独家放送
N
nujhong 已提交
1835

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

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

B
improve  
binaryify 已提交
1840
**调用例子 :** `/personalized/privatecontent`
1841 1842

### mv 排行
N
nujhong 已提交
1843

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

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

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

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

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

1855
**调用例子 :** `/top/mv?limit=10`
1856 1857

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

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

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

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

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

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

1871 1872 1873 1874
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

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

1877 1878 1879 1880 1881
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
1883
### mv 地址
1884

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

B
binaryify 已提交
1887
**可选参数 :** `id`: mv id
B
v3.0.0  
binaryify 已提交
1888 1889 1890 1891

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

**调用例子 :**
1892

B
v3.0.0  
binaryify 已提交
1893 1894
`/mv/url?id=5436712`

1895 1896 1897 1898 1899 1900 1901 1902
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

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

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

### 获取视频标签下的视频
B
binaryify 已提交
1903
说明 : 调用此接口 , 传入`id`,可获取到相关的视频。  (ps:无法分页,每次请求返回内容都不一样,官方桌面软件是打开先请求两次,然后每次滚动到底部的时候再请求一次)  
1904 1905 1906 1907 1908 1909 1910

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

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

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

B
v3.0.0  
binaryify 已提交
1911
### 相关视频
B
binaryify 已提交
1912

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

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

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

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

1921

B
v3.0.0  
binaryify 已提交
1922
### 视频详情
B
binaryify 已提交
1923

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

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

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

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

1932 1933 1934 1935 1936 1937 1938 1939
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

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

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

1940
### 获取视频播放地址
B
binaryify 已提交
1941

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

B
v3.0.0  
binaryify 已提交
1944 1945 1946 1947 1948 1949
**必选参数 :** `id`: 视频 的 id

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

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

1950

B
binaryify 已提交
1951
### 排行榜
1952

B
improve  
binaryify 已提交
1953 1954 1955
说明 : 调用此接口 , 传入数字 idx, 可获取不同排行榜

**必选参数 :** `idx`: 对象 key, 对应以下排行榜
B
binaryify 已提交
1956 1957

```
B
improve  
binaryify 已提交
1958
"0": 云音乐新歌榜,
1959

B
improve  
binaryify 已提交
1960
"1": 云音乐热歌榜,
1961

B
improve  
binaryify 已提交
1962
"2": 网易原创歌曲榜,
1963

B
improve  
binaryify 已提交
1964
"3": 云音乐飙升榜,
1965

B
improve  
binaryify 已提交
1966
"4": 云音乐电音榜,
1967

B
improve  
binaryify 已提交
1968
"5": UK排行榜周榜,
1969

B
improve  
binaryify 已提交
1970
"6": 美国Billboard周榜
1971

B
improve  
binaryify 已提交
1972
"7": KTV嗨榜,
1973

B
improve  
binaryify 已提交
1974
"8": iTunes榜,
1975

B
improve  
binaryify 已提交
1976
"9": Hit FM Top榜,
1977

B
improve  
binaryify 已提交
1978
"10": 日本Oricon周榜
1979

B
improve  
binaryify 已提交
1980
"11": 韩国Melon排行榜周榜,
1981

B
improve  
binaryify 已提交
1982
"12": 韩国Mnet排行榜周榜,
1983

B
improve  
binaryify 已提交
1984
"13": 韩国Melon原声周榜,
1985

B
improve  
binaryify 已提交
1986
"14": 中国TOP排行榜(港台榜),
1987

B
improve  
binaryify 已提交
1988
"15": 中国TOP排行榜(内地榜)
1989

B
improve  
binaryify 已提交
1990
"16": 香港电台中文歌曲龙虎榜,
1991

B
improve  
binaryify 已提交
1992
"17": 华语金曲榜,
1993

B
improve  
binaryify 已提交
1994
"18": 中国嘻哈榜,
1995

B
improve  
binaryify 已提交
1996
"19": 法国 NRJ EuroHot 30周榜,
1997

B
improve  
binaryify 已提交
1998
"20": 台湾Hito排行榜,
1999

N
nujhong 已提交
2000
"21": Beatport全球电子舞曲榜,
2001

N
nujhong 已提交
2002
"22": 云音乐ACG音乐榜,
2003

2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
"23": 云音乐说唱榜

"24": 云音乐古典音乐榜

"25": 云音乐电音榜

"26": 抖音排行榜

"27": 新声榜

"28": 云音乐韩语榜

"29": 英国Q杂志中文版周榜

"30": 电竞音乐榜

"31": 云音乐欧美热歌榜

"32": 云音乐欧美新歌榜

"33": 说唱TOP榜

N
nujhong 已提交
2026
```
B
binaryify 已提交
2027

B
improve  
binaryify 已提交
2028
**接口地址 :** `/top/list`
B
binaryify 已提交
2029

B
improve  
binaryify 已提交
2030
**调用例子 :** `/top/list?idx=6`
B
binaryify 已提交
2031

B
improve  
binaryify 已提交
2032
返回数据如下图 :
B
binaryify 已提交
2033 2034

![排行榜](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/top_list.png)
2035

2036 2037 2038 2039 2040 2041 2042
### 所有榜单

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

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

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

B
v3.0.0  
binaryify 已提交
2045 2046 2047 2048 2049
说明 : 调用此接口,可获取所有榜单内容摘要
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2050 2051
### 歌手榜

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

B
improve  
binaryify 已提交
2054 2055 2056
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2057 2058 2059

### 云盘

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

2063 2064 2065 2066 2067 2068
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2069 2070 2071
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
### 云盘数据详情
说明 : 登陆后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情

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

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

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


2083 2084 2085 2086 2087 2088 2089 2090 2091
### 云盘歌曲删除
说明 : 登陆后调用此接口 , 可删除云盘歌曲

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

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

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

B
binaryify 已提交
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
### 电台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`

2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
### 电台 - 节目榜

说明 : 登陆后调用此接口 , 可获得电台节目榜

**可选参数 :**

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

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

**接口地址 :** `/dj/program/toplist`

**调用例子 :** `/dj/program/toplist?limit=1`

2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

**接口地址 :** `/dj/toplist/pay`

**调用例子 :** `/dj/toplist/pay?limit=30`


### 电台 - 24小时节目榜
说明 : 调用此接口,可获取24小时节目榜

**可选参数 :**

`limit` : 返回数量 , 默认为 100 (不支持 offset)

B
binaryify 已提交
2155
**接口地址 :** `/dj/program/toplist/hours`
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192

**调用例子 :** `/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`

2193 2194 2195 2196 2197 2198 2199 2200 2201
### 电台 - 新晋电台榜/热门电台榜

说明 : 登陆后调用此接口 , 可获得新晋电台榜/热门电台榜

**可选参数 :**

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

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

`type`: 榜单类型, `new` 为新晋电台榜,`hot`为热门电台榜

2205 2206 2207 2208
**接口地址 :** `/dj/toplist`

**调用例子 :** `/dj/toplist?type=hot` `/dj/toplist?type=new&limit=1`

B
binaryify 已提交
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
### 电台 - 类别热门电台

**可选参数 :**

`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 已提交
2223
### 电台 - 推荐
2224

B
improve  
binaryify 已提交
2225
说明 : 登陆后调用此接口 , 可获得推荐电台
2226

B
improve  
binaryify 已提交
2227
**接口地址 :** `/dj/recommend`
2228

B
improve  
binaryify 已提交
2229
**调用例子 :** `/dj/recommend`
2230

B
improve  
binaryify 已提交
2231
### 电台 - 分类
2232

B
improve  
binaryify 已提交
2233
说明 : 登陆后调用此接口 , 可获得电台类型
2234

B
improve  
binaryify 已提交
2235
**接口地址 :** `/dj/catelist`
2236

B
improve  
binaryify 已提交
2237
**调用例子 :** `/dj/catelist`
2238

B
improve  
binaryify 已提交
2239
### 电台 - 分类推荐
2240

B
binaryify 已提交
2241
说明 : 登陆后调用此接口 , 传入分类,可获得对应类型电台列表
2242

B
improve  
binaryify 已提交
2243
**必选参数 :** `type`: 电台类型 , 数字 , 可通过`/dj/catelist`获取 , 对应关系为
B
binaryify 已提交
2244
id 对应 此接口的 type, name 对应类型
2245

B
improve  
binaryify 已提交
2246
**接口地址 :** `/dj/recommend/type`
2247

B
binaryify 已提交
2248
**调用例子 :** `/dj/recommend/type?type=1`(明星做主播) `/dj/recommend/type?type=2001` (创作|翻唱)
2249

B
improve  
binaryify 已提交
2250
### 电台 - 订阅
2251

B
improve  
binaryify 已提交
2252 2253
说明 : 登陆后调用此接口 , 传入`rid`, 可订阅 dj,dj 的 `rid` 可通过搜索指定
type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
2254

B
improve  
binaryify 已提交
2255
**必选参数 :** `rid`: 电台 的 id
2256

B
improve  
binaryify 已提交
2257
**接口地址 :** `/dj/sub`
2258

B
improve  
binaryify 已提交
2259 2260
**调用例子 :** `/dj/sub?rid=336355127&t=1` ( 对应关注 ' 代码时间 ')
`/dj/sub?rid=336355127&t=0` ( 对应取消关注 ' 代码时间 ')
2261

2262 2263 2264 2265 2266 2267 2268 2269
### 电台的订阅列表

说明 : 登陆后调用此接口 , 可获取订阅的电台列表

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

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

add doc  
徐星宇 已提交
2270 2271 2272 2273
### 电台 - 付费精选

说明 : 可以获取付费精选的电台列表 , 传入 `limit``offset` 可以进行分页

2274 2275 2276 2277 2278 2279
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2280 2281 2282 2283
**接口地址 :** `/dj/paygift`

**调用例子 :** `/dj/paygift?limit=10&offset=20`

2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
### 电台 - 非热门类型

说明 : 登陆后调用此接口, 可获得电台非热门类型


**接口地址 :** `/dj/category/excludehot`

**调用例子 :** `/dj/category/excludehot`

### 电台 - 推荐类型

说明 : 登陆后调用此接口, 可获得电台推荐类型


**接口地址 :** `/dj/category/recommend`

**调用例子 :** `/dj/category/recommend`

### 电台 - 今日优选

说明 : 登陆后调用此接口, 可获得电台今日优选


**接口地址 :** `/dj/today/perfered`

**调用例子 :** `/dj/today/perfered`

B
improve  
binaryify 已提交
2311
### 电台 - 详情
2312

B
improve  
binaryify 已提交
2313
说明 : 登陆后调用此接口 , 传入`rid`, 可获得对应电台的详情介绍
2314

B
improve  
binaryify 已提交
2315
**必选参数 :** `rid`: 电台 的 id
2316

2317
**接口地址 :** `/dj/detail`
2318

B
improve  
binaryify 已提交
2319
**调用例子 :** `/dj/detail?rid=336355127` ( 对应 ' 代码时间 ' 的详情介绍 )
2320

B
improve  
binaryify 已提交
2321
### 电台 - 节目
2322

B
improve  
binaryify 已提交
2323
说明 : 登陆后调用此接口 , 传入`rid`, 可查看对应电台的电台节目以及对应的 id, 需要
B
v3.0.0  
binaryify 已提交
2324 2325
注意的是这个接口返回的 mp3Url 已经无效 , 都为 null, 但是通过调用 `/song/url`
个接口 , 传入节目 id 仍然能获取到节目音频 , 如 `/song/url?id=478446370` 获取代
B
improve  
binaryify 已提交
2326 2327 2328 2329
码时间的一个节目的音频

**必选参数 :** `rid`: 电台 的 id

B
binaryify 已提交
2330
**可选参数 :**
2331

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

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

2336 2337
`asc` : 排序方式,默认为 `false` (新 => 老 ) 设置 `true` 可改为 老 => 新 

B
improve  
binaryify 已提交
2338 2339
**接口地址 :** `/dj/program`

B
binaryify 已提交
2340
**调用例子 :** `/dj/program?rid=336355127&limit=40` ( 对应 ' 代码时间 ' 的节目列表 )
2341

B
binaryify 已提交
2342 2343 2344 2345 2346 2347 2348 2349
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

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

**接口地址 :** `/dj/program/detail`

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364

### 通知 - 私信

说明 : 登陆后调用此接口 ,可获取私信

**可选参数 :**

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

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

**接口地址 :** `/msg/private`

**调用例子 :** `/msg/private?limit=3`

B
v3.12.0  
binaryify 已提交
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
### 发送私信

说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)

**必选参数 :**

`user_ids` : 用户 id,多个需用逗号隔开

`msg` : 要发送的信息

**接口地址 :** `/send/text`

**调用例子 :** `/send/text?user_ids=32953014&msg=test`,`/send/text?user_ids=32953014,475625142&msg=test`
2378

B
v3.12.0  
binaryify 已提交
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388

### 私信内容
说明 : 登陆后调用此接口 , 可获取私信内容

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

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

2389
`before` : 分页参数,取上一页最后一项的 `time` 获取下一页数据
B
v3.12.0  
binaryify 已提交
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410

**接口地址 :** 
`/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 已提交
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451

### 通知 - 评论

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

**必选参数 :** `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 已提交
2452
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465


**接口地址 :** `/msg/notices`

**调用例子 :** `/msg/notices?limit=3`

### 设置
说明 : 登陆后调用此接口 ,可获取用户设置

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

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

B
v3.12.0  
binaryify 已提交
2466 2467 2468 2469 2470 2471 2472
### 我的数字专辑
说明 : 登陆后调用此接口 ,可获取我的数字专辑

**接口地址 :** `/digitalAlbum/purchased`

**调用例子 :** `/digitalAlbum/purchased?limit=10`

T
TimonPeng 已提交
2473
### 购买数字专辑
2474
说明 : 登陆后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487

**必选参数 :**

`id` : 专辑的 id

`payment` : 支付方式, 0 为支付宝 3 为微信

`quantity` : 购买的数量

**接口地址 :** `/digitalAlbum/ordering`

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

B
v3.13.0  
binaryify 已提交
2488 2489 2490 2491 2492 2493 2494 2495 2496
### batch批量请求接口
说明 : 登陆后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口

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

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
2497
## 离线访问此文档
B
binaryify 已提交
2498

B
improve  
binaryify 已提交
2499
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
2500 2501

## 关于此文档
B
improve  
binaryify 已提交
2502 2503 2504 2505

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
2506

B
binaryify 已提交
2507
## License
B
improve  
binaryify 已提交
2508

B
binaryify 已提交
2509
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)