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

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

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

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

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

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

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

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

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

19
1. 登录
20
2. 刷新登录
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
3. 发送验证码
4. 校验验证码
5. 注册(修改密码)
6. 获取用户信息 , 歌单,收藏,mv, dj 数量
7. 获取用户歌单
8. 获取用户电台
9. 获取用户关注列表
10. 获取用户粉丝列表
11. 获取用户动态
12. 获取用户播放记录
13. 获取精品歌单
14. 获取歌单详情
15. 搜索
16. 搜索建议
17. 获取歌词
18. 歌曲评论
19. 收藏单曲到歌单
20. 专辑评论
21. 歌单评论
22. mv 评论
23. 电台节目评论
24. banner
25. 获取歌曲详情
26. 获取专辑内容
27. 获取歌手单曲
28. 获取歌手 mv
29. 获取歌手专辑
30. 获取歌手描述
31. 获取相似歌手
32. 获取相似歌单
33. 相似 mv
34. 获取相似音乐
35. 获取最近 5 个听了这首歌的用户
36. 获取每日推荐歌单
37. 获取每日推荐歌曲
38. 私人 FM
39. 签到
40. 喜欢音乐
41. 垃圾桶
42. 歌单 ( 网友精选碟 )
43. 新碟上架
44. 热门歌手
45. 最新 mv
46. 推荐 mv
47. 推荐歌单
48. 推荐新音乐
49. 推荐电台
50. 推荐节目
51. 独家放送
52. mv 排行
53. 获取 mv 数据
54. 播放 mv/视频
55. 排行榜
56. 歌手榜
57. 云盘
58. 电台 - 推荐
59. 电台 - 分类
60. 电台 - 分类推荐
61. 电台 - 订阅
62. 电台 - 详情
63. 电台 - 节目
64. 给评论点赞
65. 获取动态
84
66. 热搜列表(简略)
85 86 87 88 89 90 91 92 93 94 95
67. 发送私信
68. 发送私信歌单
69. 新建歌单
70. 收藏/取消收藏歌单
71. 歌单分类
72. 收藏的歌手列表
73. 订阅的电台列表
74. 相关歌单推荐
75. 付费精选接口
76. 音乐是否可用检查接口
77. 登录状态
96
78. 获取视频播放地址
97 98 99 100 101 102 103
79. 发送/删除评论
80. 热门评论
81. 视频评论
82. 退出登录
83. 所有榜单
84. 所有榜单内容摘要
85. 收藏视频
104
86. 收藏 MV
105 106 107 108 109 110 111 112 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

B
improve  
binaryify 已提交
296
**必选参数 :** `phone`: 手机号码 `password`: 密码
297

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

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

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

B
improve  
binaryify 已提交
304
#### 2. 邮箱登录
B
binaryify 已提交
305

B
binaryify 已提交
306 307
~~ 注意 : 此接口被网易和谐了 , 待修复 , 暂时使用手机登录 (2017.05.20)~~

B
binaryify 已提交
308
> 更新 : 此接口已经可以正常使用(2018.07.03)
309

310 311
**必选参数 :** `email`: 163 网易邮箱  
`password`: 密码
312

B
improve  
binaryify 已提交
313
**接口地址 :** `/login`
314

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

B
improve  
binaryify 已提交
317 318
返回数据如下图 :
![登录](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E7%99%BB%E5%BD%95.png)
B
binaryify 已提交
319

B
improve  
binaryify 已提交
320 321
完成登录后 , 会在浏览器保存一个 Cookies 用作登录凭证 , 大部分 API 都需要用到这个
Cookies
B
binaryify 已提交
322

B
binaryify 已提交
323
#### 注意
B
improve  
binaryify 已提交
324 325

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

327
### 刷新登录
N
nujhong 已提交
328

B
improve  
binaryify 已提交
329 330 331
说明 : 调用此接口 , 可刷新登录状态

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

333 334 335 336 337 338 339 340 341
### 发送验证码

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

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

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

342
**接口地址 :** `/captcha/sent`
343

344
**调用例子 :** `/captcha/sent?phone=13xxx`
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359



### 验证验证码

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

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

`captcha`: 验证码

**可选参数 :**

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

360
**接口地址 :** `/captcha/verify`
361

362
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
363 364 365 366 367 368


### 注册(修改密码)

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

369
**必选参数 :** 
370 371 372 373 374 375 376 377 378

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

379 380 381 382
**接口地址 :** `/register/cellphone`

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

383
### 检测手机号码是否已注册
B
binaryify 已提交
384
说明 : 调用此接口 ,可检测手机号码是否已注册  
385 386
**必选参数 :** 
`phone` :  手机号码  
B
boyan 已提交
387 388
**可选参数 :**
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` 
389 390 391 392 393
**接口地址 :** `/cellphone/existence/check`

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

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

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

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

402 403 404 405 406 407 408 409 410 411 412 413 414
### 更换绑定手机
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

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

`captcha`: 新手机验证码

`phone` :  手机号码  

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

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

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

B
v2.20.3  
binaryify 已提交
418 419 420 421 422 423
### 退出登录

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

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

424
### 登录状态
B
binaryify 已提交
425

426 427 428
说明 : 调用此接口,可获取登录状态

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

430

B
binaryify 已提交
431 432
### 获取用户详情

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

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

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

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

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

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

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

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

449 450 451 452 453
### 更新用户信息

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

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

455 456
```
gender: 性别 0:保密 1:男性 2:女性
457

458
birthday: 出生日期,时间戳 unix timestamp
459

460
nickname: 用户昵称
461

462
province: 省份id
463

464
city: 城市id
465

466 467 468
signature:用户签名
```

B
binaryify 已提交
469
**接口地址 :** `/user/update`
470

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

B
binaryify 已提交
473
### 获取用户歌单
474

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

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

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

B
improve  
binaryify 已提交
481 482 483
**调用例子 :** `/user/playlist?uid=32953014`

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

486 487 488 489
### 更新歌单

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

491 492
```
id:歌单id
493

B
binaryify 已提交
494
name:歌单名字
495

496
desc:歌单描述
497

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

501 502
**接口地址 :** `/playlist/update`

B
binaryify 已提交
503
**调用例子 :** `/playlist/update?id=24381616&name=新歌单&desc=描述&tags=欧美`
B
binaryify 已提交
504 505 506 507 508 509 510 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

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

```
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=学习` 
546

547 548
### 获取用户电台

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

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

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

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

B
improve  
binaryify 已提交
557
### 获取用户关注列表
558

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

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

B
binaryify 已提交
563
**可选参数 :**
564

B
binaryify 已提交
565 566 567
`limit` : 返回数量 , 默认为 30

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

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

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

B
improve  
binaryify 已提交
574
### 获取用户粉丝列表
575

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

578 579 580 581 582
**必选参数 :** `uid` : 用户 id  

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

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


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

587
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&time=1560152549136`
588 589 590

### 获取用户动态

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

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

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

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

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

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

B
binaryify 已提交
603 604 605 606 607 608 609 610 611 612 613 614
返回结果的`type`参数对应:
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
615 616 617 618 619 620 621 622 623 624 625 626 627 628
### 转发用户动态
说明 : 登陆后调用此接口 ,可以转发用户动态

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

`evId` : 动态 id  

`forwards` : 转发的评论

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

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


B
binaryify 已提交
629 630 631 632 633 634 635 636 637
### 删除用户动态
说明 : 登陆后调用此接口 ,可以删除用户动态

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

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

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

638 639 640 641 642 643 644 645 646 647 648 649 650
### 分享歌曲、歌单、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 测试` 

651 652 653 654 655 656
### 获取动态评论

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

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

657
**接口地址 :** `/comment/event`
658

659
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
660

B
v3.0.0  
binaryify 已提交
661 662 663 664 665 666
### 关注/取消关注用户

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

**必选参数 :**

B
binaryify 已提交
667
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
668

B
binaryify 已提交
669
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
670 671 672 673 674

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

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

675 676
### 获取用户播放记录

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

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

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

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

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

687 688 689 690 691 692 693 694
### 获取热门话题

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

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

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

B
binaryify 已提交
695
**接口地址 :** `/hot/topic`
696

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

699 700 701 702 703 704 705 706

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

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

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

707
### 心动模式/智能播放
708
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
709 710 711 712 713 714 715 716 717 718 719
**必选参数 :** `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 已提交
720 721
### 获取动态消息

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

725 726 727 728
**必选参数 :** 
`pagesize` : 每页数据,默认20

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

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

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

734
### 歌手分类列表
B
binaryify 已提交
735

B
binaryify 已提交
736 737 738 739
说明 : 调用此接口,可获取歌手分类列表  

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

740
**可选参数 :**
741

742 743 744 745
`limit` : 返回数量 , 默认为 30

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

748
`type` 取值:
B
binaryify 已提交
749

750
```
B
binaryify 已提交
751
-1:全部
752 753 754 755
1:男歌手
2:女歌手
3:乐队
```
756

757 758 759 760 761 762 763 764
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
765
```
766
    
767 768 769

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

770
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
771 772


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

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

B
binaryify 已提交
777
**必选参数 :**
778

B
binaryify 已提交
779
`artistId` : 歌手 id
780

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

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

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

787 788 789 790 791 792 793 794 795 796 797 798 799

### 歌手热门50首歌曲

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

**必选参数 :**

`id` : 歌手 id

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

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

800
### 收藏的歌手列表
B
binaryify 已提交
801

802 803 804 805 806 807
说明 : 调用此接口,可获取收藏的歌手列表

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

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

B
v3.0.0  
binaryify 已提交
808 809 810 811
### 收藏视频

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

B
binaryify 已提交
812
**必选参数 :**
B
v3.0.0  
binaryify 已提交
813 814 815 816 817 818 819 820 821

`id` : 视频 id

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

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

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

822
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
823

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

B
binaryify 已提交
826
**必选参数 :**
B
v3.0.0  
binaryify 已提交
827

B
binaryify 已提交
828
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
829 830 831 832 833 834 835

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

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

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

836 837 838 839 840 841 842 843
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
844
### 歌单分类
B
binaryify 已提交
845

B
binaryify 已提交
846 847 848 849 850 851 852
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
854 855 856 857 858 859 860 861 862 863 864 865 866 867
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

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

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

B
binaryify 已提交
874
**接口地址 :** `/top/playlist`
875

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

B
improve  
binaryify 已提交
878
### 获取精品歌单
879

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

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

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

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

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

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

B
binaryify 已提交
893 894 895 896 897 898 899 900 901 902
### 相关歌单推荐

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

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

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

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

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

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

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

### 获取音乐 url
920

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

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

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

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

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

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

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

939
### 音乐是否可用
B
binaryify 已提交
940

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

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

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

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

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

951
### 搜索
952

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

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

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

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

B
improve  
binaryify 已提交
965
**接口地址 :** `/search`
966

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

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

B
binaryify 已提交
972 973 974 975 976 977

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

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

978
### 热搜列表(简略)
B
binaryify 已提交
979

B
binaryify 已提交
980 981 982 983 984 985
说明 : 调用此接口,可获取热门搜索列表

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

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

986 987 988 989 990 991 992 993
### 热搜列表(详细)

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

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

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

994 995
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1007 1008
### 搜索多重匹配

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

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

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

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

1017 1018 1019 1020
### 新建歌单

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

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

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

1025 1026 1027 1028
**接口地址 :** `/playlist/create`

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

1029

1030

B
binaryify 已提交
1031 1032 1033 1034 1035

### 删除歌单

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

B
binaryify 已提交
1036
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1037 1038 1039

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

B
binaryify 已提交
1040
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1041 1042


1043 1044 1045 1046 1047
### 收藏/取消收藏歌单

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

**必选参数 :**
1048

B
binaryify 已提交
1049
`t` : 类型,1:收藏,2:取消收藏
1050 1051 1052 1053 1054 1055
`id` : 歌单 id

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

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

1056

1057

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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


1073
### 对歌单添加或删除歌曲
B
binaryify 已提交
1074

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

1077
**必选参数 :**
1078

1079 1080 1081 1082
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

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

B
binaryify 已提交
1088
### 获取歌词
1089

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

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

B
improve  
binaryify 已提交
1094
**接口地址 :** `/lyric`
1095

B
improve  
binaryify 已提交
1096 1097 1098
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1111

B
binaryify 已提交
1112
华语:7
1113

B
binaryify 已提交
1114
欧美:96
1115

B
binaryify 已提交
1116
日本:8
1117

B
binaryify 已提交
1118 1119 1120 1121 1122 1123 1124
韩国:16
```

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

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

1125
### 歌曲评论
1126

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

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

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

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

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

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

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

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

### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1158 1159 1160
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1161 1162 1163

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1177
**调用例子 :** `/comment/playlist?id=705123491`
1178 1179 1180

### mv 评论

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

B
improve  
binaryify 已提交
1184
**必选参数 :** `id`: mv id
1185

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

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

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

B
improve  
binaryify 已提交
1192 1193 1194
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1195 1196 1197

### 电台节目评论

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

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

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

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

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

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

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

1213 1214 1215 1216 1217 1218 1219 1220 1221
### 视频评论

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

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

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

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

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

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1231 1232

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1233 1234 1235 1236 1237 1238 1239 1240 1241

**必选参数 :**

`id` : 资源 id

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

```
0: 歌曲
1242

1243
1: mv
1244

1245
2: 歌单
1246

1247
3: 专辑
1248

1249
4: 电台
1250

1251 1252
5: 视频
```
B
v2.20.3  
binaryify 已提交
1253

1254 1255 1256 1257 1258 1259
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

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

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

1260 1261 1262 1263
**接口地址 :** `/comment/hot`

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

B
binaryify 已提交
1264 1265
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1271
`cid` : 评论 id
B
binaryify 已提交
1272

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

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

B
binaryify 已提交
1277 1278
```
0: 歌曲
1279

B
binaryify 已提交
1280
1: mv
1281

B
binaryify 已提交
1282
2: 歌单
1283

N
nujhong 已提交
1284
3: 专辑
1285

B
binaryify 已提交
1286
4: 电台
1287

1288
5: 视频
1289 1290

6: 动态
B
improve  
binaryify 已提交
1291
```
N
nujhong 已提交
1292

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

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

1297 1298 1299

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

B
binaryify 已提交
1300 1301 1302 1303 1304 1305 1306 1307
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1308
   **必选参数**
1309

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

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

   ```
   0: 歌曲
1316

B
binaryify 已提交
1317
   1: mv
1318

B
binaryify 已提交
1319
   2: 歌单
1320

B
binaryify 已提交
1321
   3: 专辑
1322

B
binaryify 已提交
1323
   4: 电台
1324

1325
   5: 视频
1326 1327

   6: 动态
B
binaryify 已提交
1328 1329 1330 1331 1332 1333
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1340
2. 删除评论
B
binaryify 已提交
1341 1342

   **必选参数**
1343

B
v3.0.0  
binaryify 已提交
1344
   `t`:0 删除
B
binaryify 已提交
1345

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

   ```
   0: 歌曲
1351

B
binaryify 已提交
1352
   1: mv
1353

B
binaryify 已提交
1354
   2: 歌单
1355

B
binaryify 已提交
1356
   3: 专辑
1357

B
binaryify 已提交
1358
   4: 电台
1359 1360


1361
   5: 视频
1362 1363 1364

   6: 动态
   
B
binaryify 已提交
1365 1366 1367 1368
   ```

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

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

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

B
binaryify 已提交
1375

1376 1377
### banner

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

1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
**可选参数 :**

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

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1394 1395
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1402
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1403 1404

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

B
v3.0.0  
binaryify 已提交
1406 1407
```
1: mv
1408

B
v3.0.0  
binaryify 已提交
1409
4: 电台
1410

B
v3.0.0  
binaryify 已提交
1411
5: 视频
1412 1413

6: 动态
B
v3.0.0  
binaryify 已提交
1414 1415
```

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

B
binaryify 已提交
1418
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1419 1420 1421 1422 1423

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

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

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

B
binaryify 已提交
1427 1428
### 获取歌曲详情

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

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

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

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

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

B
binaryify 已提交
1440
### 获取专辑内容
1441

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

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

B
improve  
binaryify 已提交
1446
**接口地址 :** `/album`
1447

B
improve  
binaryify 已提交
1448 1449 1450
**调用例子 :** `/album?id=32311`

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

1453

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

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

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

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

1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

1490
### 获取歌手单曲
1491

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

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

B
improve  
binaryify 已提交
1496
**接口地址 :** `/artists`
1497

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

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

1503
### 获取歌手 mv
B
improve  
binaryify 已提交
1504 1505 1506

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

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

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

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

1515
### 获取歌手专辑
1516

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

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

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

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

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

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

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

1533 1534
### 获取歌手描述

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

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

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

B
improve  
binaryify 已提交
1541
**调用例子 :** `/artist/desc?id=6452` ( 周杰伦 )
1542 1543 1544

### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
1571
**调用例子 :** `/simi/mv?mvid=5436712`
1572 1573 1574

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
1589 1590 1591
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
1593
### 获取每日推荐歌单
1594

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

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

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

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

B
binaryify 已提交
1604
### 获取每日推荐歌曲
1605

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

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

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

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

### 私人 FM

B
improve  
binaryify 已提交
1617 1618 1619
说明 : 私人 FM( 需要登录 )

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

B
improve  
binaryify 已提交
1621
**调用例子 :** `/personal_fm`
1622

B
improve  
binaryify 已提交
1623
返回数据如下图 :
1624 1625 1626 1627 1628

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

### 签到

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

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

B
improve  
binaryify 已提交
1634
**接口地址 :** `/daily_signin`
1635

B
improve  
binaryify 已提交
1636 1637 1638
**调用例子 :** `/daily_signin`

返回数据如下图 :
1639

B
binaryify 已提交
1640
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
1641 1642 1643 1644

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

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

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

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

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

B
improve  
binaryify 已提交
1652
**接口地址 :** `/like`
1653

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

B
improve  
binaryify 已提交
1656
返回数据如下图 :
1657 1658 1659

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

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

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

1664 1665 1666 1667 1668 1669 1670 1671 1672 1673
### 喜欢音乐列表

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

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

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

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

1674 1675
### 垃圾桶

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

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

B
improve  
binaryify 已提交
1680
**接口地址 :** `/fm_trash`
1681

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

B
improve  
binaryify 已提交
1684
返回数据如下图 :
1685 1686 1687

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

1688
### 新碟上架
N
nujhong 已提交
1689

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

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

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

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

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

B
improve  
binaryify 已提交
1702
返回数据如下图 :
1703 1704 1705

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

T
trazyn 已提交
1706 1707 1708 1709 1710 1711
### 最新专辑

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

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

B
binaryify 已提交
1712
**调用例子 :** `/album/newest`
T
trazyn 已提交
1713 1714 1715 1716 1717 1718 1719

### 听歌打卡

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

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

1720
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
1721 1722 1723

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

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

1726
### 热门歌手
N
nujhong 已提交
1727

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

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

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

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

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

B
improve  
binaryify 已提交
1739
返回数据如下图 :
1740 1741 1742

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

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

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

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

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

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

1757 1758 1759 1760 1761
**接口地址 :** `/mv/all`

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

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

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

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

B
improve  
binaryify 已提交
1768 1769 1770
**接口地址 :** `/mv/first`

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

1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
### 网易出品mv

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

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

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

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

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

1785
### 推荐 mv
N
nujhong 已提交
1786

B
improve  
binaryify 已提交
1787 1788 1789
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
1791
**调用例子 :** `/personalized/mv`
1792 1793

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

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

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

B
improve  
binaryify 已提交
1799
**接口地址 :** `/personalized`
1800

1801 1802 1803
**调用例子 :** `/personalized?limit=1`


1804 1805

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

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

B
improve  
binaryify 已提交
1809 1810 1811
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
1812 1813

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

B
improve  
binaryify 已提交
1815 1816 1817
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
1819
**调用例子 :** `/personalized/djprogram`
1820 1821

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

B
improve  
binaryify 已提交
1823 1824 1825
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
1827
**调用例子 :** `/program/recommend`
1828 1829

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

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

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

B
improve  
binaryify 已提交
1835
**调用例子 :** `/personalized/privatecontent`
1836 1837

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

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

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

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

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

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

1850
**调用例子 :** `/top/mv?limit=10`
1851 1852

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

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

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

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

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

B
improve  
binaryify 已提交
1864
返回数据如下图 :
B
binaryify 已提交
1865

1866 1867 1868 1869
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

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

1872 1873 1874 1875 1876
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
1878
### mv 地址
1879

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

B
binaryify 已提交
1882
**可选参数 :** `id`: mv id
B
v3.0.0  
binaryify 已提交
1883 1884 1885 1886

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

**调用例子 :**
1887

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

1890 1891 1892 1893 1894 1895 1896 1897
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

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

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

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

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

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

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

B
v3.0.0  
binaryify 已提交
1906
### 相关视频
B
binaryify 已提交
1907

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

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

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

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

1916

B
v3.0.0  
binaryify 已提交
1917
### 视频详情
B
binaryify 已提交
1918

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

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

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

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

1927 1928 1929 1930 1931 1932 1933 1934
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

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

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

1935
### 获取视频播放地址
B
binaryify 已提交
1936

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

B
v3.0.0  
binaryify 已提交
1939 1940 1941 1942 1943 1944
**必选参数 :** `id`: 视频 的 id

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

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

1945

B
binaryify 已提交
1946
### 排行榜
1947

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

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

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

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

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

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

B
improve  
binaryify 已提交
1961
"4": 云音乐电音榜,
1962

B
improve  
binaryify 已提交
1963
"5": UK排行榜周榜,
1964

B
improve  
binaryify 已提交
1965
"6": 美国Billboard周榜
1966

B
improve  
binaryify 已提交
1967
"7": KTV嗨榜,
1968

B
improve  
binaryify 已提交
1969
"8": iTunes榜,
1970

B
improve  
binaryify 已提交
1971
"9": Hit FM Top榜,
1972

B
improve  
binaryify 已提交
1973
"10": 日本Oricon周榜
1974

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

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

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

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

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

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

B
improve  
binaryify 已提交
1987
"17": 华语金曲榜,
1988

B
improve  
binaryify 已提交
1989
"18": 中国嘻哈榜,
1990

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

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

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

N
nujhong 已提交
1997
"22": 云音乐ACG音乐榜,
1998

1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
"23": 云音乐说唱榜

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

"25": 云音乐电音榜

"26": 抖音排行榜

"27": 新声榜

"28": 云音乐韩语榜

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

"30": 电竞音乐榜

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

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

"33": 说唱TOP榜

N
nujhong 已提交
2021
```
B
binaryify 已提交
2022

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

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

B
improve  
binaryify 已提交
2027
返回数据如下图 :
B
binaryify 已提交
2028 2029

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

2031 2032 2033 2034 2035 2036 2037
### 所有榜单

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

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

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

B
v3.0.0  
binaryify 已提交
2040 2041 2042 2043 2044
说明 : 调用此接口,可获取所有榜单内容摘要
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2045 2046
### 歌手榜

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

B
improve  
binaryify 已提交
2049 2050 2051
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2052 2053 2054

### 云盘

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

2058 2059 2060 2061 2062 2063
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2064 2065 2066
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
### 云盘数据详情
说明 : 登陆后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情

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

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

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


2078 2079 2080 2081 2082 2083 2084 2085 2086
### 云盘歌曲删除
说明 : 登陆后调用此接口 , 可删除云盘歌曲

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

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

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

B
binaryify 已提交
2087 2088 2089 2090 2091 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
### 电台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`

2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
### 电台 - 节目榜

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

**可选参数 :**

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

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

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

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

2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

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

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

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


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

**可选参数 :**

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

B
binaryify 已提交
2150
**接口地址 :** `/dj/program/toplist/hours`
2151 2152 2153 2154 2155 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

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

2188 2189 2190 2191 2192 2193 2194 2195 2196
### 电台 - 新晋电台榜/热门电台榜

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

**可选参数 :**

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

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

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

2200 2201 2202 2203
**接口地址 :** `/dj/toplist`

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

B
binaryify 已提交
2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
### 电台 - 类别热门电台

**可选参数 :**

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

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

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

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

B
improve  
binaryify 已提交
2226
### 电台 - 分类
2227

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

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

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

B
improve  
binaryify 已提交
2234
### 电台 - 分类推荐
2235

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

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

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

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

B
improve  
binaryify 已提交
2245
### 电台 - 订阅
2246

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

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

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

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

2257 2258 2259 2260 2261 2262 2263 2264
### 电台的订阅列表

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

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

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

add doc  
徐星宇 已提交
2265 2266 2267 2268
### 电台 - 付费精选

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

2269 2270 2271 2272 2273 2274
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2275 2276 2277 2278
**接口地址 :** `/dj/paygift`

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

2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305
### 电台 - 非热门类型

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


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

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

### 电台 - 推荐类型

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


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

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

### 电台 - 今日优选

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


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

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

B
improve  
binaryify 已提交
2306
### 电台 - 详情
2307

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

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

2312
**接口地址 :** `/dj/detail`
2313

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

B
improve  
binaryify 已提交
2316
### 电台 - 节目
2317

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

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

B
binaryify 已提交
2325
**可选参数 :**
2326

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

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

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

B
improve  
binaryify 已提交
2333 2334
**接口地址 :** `/dj/program`

B
binaryify 已提交
2335
**调用例子 :** `/dj/program?rid=336355127&limit=40` ( 对应 ' 代码时间 ' 的节目列表 )
2336

B
binaryify 已提交
2337 2338 2339 2340 2341 2342 2343 2344
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

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

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

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359

### 通知 - 私信

说明 : 登陆后调用此接口 ,可获取私信

**可选参数 :**

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

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

**接口地址 :** `/msg/private`

**调用例子 :** `/msg/private?limit=3`

B
v3.12.0  
binaryify 已提交
2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
### 发送私信

说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)

**必选参数 :**

`user_ids` : 用户 id,多个需用逗号隔开

`msg` : 要发送的信息

**接口地址 :** `/send/text`

**调用例子 :** `/send/text?user_ids=32953014&msg=test`,`/send/text?user_ids=32953014,475625142&msg=test`
2373

B
v3.12.0  
binaryify 已提交
2374 2375 2376 2377 2378 2379 2380 2381 2382 2383

### 私信内容
说明 : 登陆后调用此接口 , 可获取私信内容

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

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

2384
`before` : 分页参数,取上一页最后一项的 `time` 获取下一页数据
B
v3.12.0  
binaryify 已提交
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405

**接口地址 :** 
`/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 已提交
2406 2407 2408 2409 2410 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 2452 2453 2454 2455 2456 2457 2458 2459 2460

### 通知 - 评论

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

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

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


**接口地址 :** `/msg/notices`

**调用例子 :** `/msg/notices?limit=3`

### 设置
说明 : 登陆后调用此接口 ,可获取用户设置

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

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

B
v3.12.0  
binaryify 已提交
2461 2462 2463 2464 2465 2466 2467
### 我的数字专辑
说明 : 登陆后调用此接口 ,可获取我的数字专辑

**接口地址 :** `/digitalAlbum/purchased`

**调用例子 :** `/digitalAlbum/purchased?limit=10`

T
TimonPeng 已提交
2468
### 购买数字专辑
2469
说明 : 登陆后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482

**必选参数 :**

`id` : 专辑的 id

`payment` : 支付方式, 0 为支付宝 3 为微信

`quantity` : 购买的数量

**接口地址 :** `/digitalAlbum/ordering`

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

B
v3.13.0  
binaryify 已提交
2483 2484 2485 2486 2487 2488 2489 2490 2491
### batch批量请求接口
说明 : 登陆后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口

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

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
2492
## 离线访问此文档
B
binaryify 已提交
2493

B
improve  
binaryify 已提交
2494
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
2495 2496

## 关于此文档
B
improve  
binaryify 已提交
2497 2498 2499 2500

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
2501

B
binaryify 已提交
2502
## License
B
improve  
binaryify 已提交
2503

B
binaryify 已提交
2504
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)