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

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

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

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
226
## 安装
B
improve  
binaryify 已提交
227 228

```shell
229
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
230

231
$ npm install
B
binaryify 已提交
232
```
B
improve  
binaryify 已提交
233

234
## 运行
B
improve  
binaryify 已提交
235 236

```shell
N
nujhong 已提交
237
$ node app.js
B
binaryify 已提交
238 239
```

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

B
binaryify 已提交
242 243 244 245
```shell
$ PORT=4000 node app.js
```

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

B
binaryify 已提交
248 249 250
```shell
$ set PORT=4000 && node app.js
```
B
binaryify 已提交
251

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

```shell
B
binaryify 已提交
259
$ set HOST=127.0.0.1 && node app.js
B
#615  
binaryify 已提交
260
```
B
binaryify 已提交
261 262 263 264 265 266 267 268 269

## Vercel 部署
v4.0.8 加入了 Vercel 配置文件,可以直接在 Vercel 下部署了,不需要自己的服务器
### 操作方法
1. fork 此项目
2. 在 Vercel 官网点击 `New Project`
3. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击`import`
4. 点击 `PERSONAL ACCOUNT``select`
5. 直接点`Continue`
B
binaryify 已提交
270 271
6. `PROJECT NAME`自己填,`FRAMEWORK PRESET``Other` 然后直接点 `Deploy` 接着等部署完成即可  

272 273 274 275 276 277
## 可以使用代理

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

```javascript
// 例子
B
v3.0.0  
binaryify 已提交
278
const url = `http://localhost:3000/song/url?id=33894312&proxy=http://121.196.226.246:84`
279 280 281 282 283 284 285
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}
```
286
v3.3.0 后支持使用 PAC代理,如 `?proxy=http://192.168.0.1/proxy.pac`
B
binaryify 已提交
287

B
binaryify 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
## 可以在Node.js调用
v3.31.0后支持Node.js调用,导入的方法为`module`内的文件名,返回内容包含`status``body`,`status`为状态码,`body`为请求返回内容,参考`module_example` 文件夹下的 `test.js`
```js
const { login_cellphone, user_cloud } = require('NeteaseCloudMusicApi')
async function main() {
  try {
    const result = await login_cellphone({
      phone: '手机号',
      password: '密码'
    })
    console.log(result)
    const result2 = await user_cloud({
      cookie: result.body.cookie // 凭证
    })
    console.log(result2.body)
      
  } catch (error) {
    console.log(error)
  }
}
main()
```

B
binaryify 已提交
311 312 313 314 315 316 317 318 319
## 支持 TypeScript
```ts
// test.ts
import { banner } from 'NeteaseCloudMusicApi'
banner({ type:0 }).then(res=>{
  console.log(res)
})
```

B
binaryify 已提交
320
## 更新到 v3.0 说明
B
binaryify 已提交
321

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

B
improve  
binaryify 已提交
324 325
## Docker 容器运行

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

request 相关的环境变量

330 331 332 333 334 335 336
1. http_proxy
2. https_proxy
3. HTTP_PROXY
4. HTTPS_PROXY
5. no_proxy
6. NO_PROXY

337
```shell
B
binaryify 已提交
338
docker pull binaryify/netease_cloud_music_api
339

B
binaryify 已提交
340 341 342 343 344
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
345 346

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

B
binaryify 已提交
348 349 350 351
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
352
```
B
binaryify 已提交
353

B
binaryify 已提交
354
> 以下是自行 build docker 镜像方式
355 356 357

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

359
$ sudo docker build . -t netease-music-api
360

361 362
$ sudo docker run -d -p 3000:3000 netease-music-api
```
B
binaryify 已提交
363

364
## 接口文档
B
improve  
binaryify 已提交
365

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

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

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

375
!> 如果是跨域请求 , 请在所有请求带上 `xhrFields: { withCredentials: true }` (axios 为 `withCredentials: true`, Fetch API 为 `fetch(url, { credentials: 'include' })`), 或直接手动传入cookie (参见 `登录`), 否则
376
可能会因为没带上 cookie 导致 301, 具体例子可看 `public/test.html`, 访问`http://localhost:3000/test.html`(默认端口的话) 例子使用 jQuery 和 axios 
B
improve  
binaryify 已提交
377

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

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

382
!> 本项目仅供学习使用,请尊重版权,请勿利用此项目从事商业行为或进行破坏版权行为
B
binaryify 已提交
383 384

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

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

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

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

B
binaryify 已提交
394
### 登录
B
improve  
binaryify 已提交
395

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

B
improve  
binaryify 已提交
398
#### 1. 手机登录
399

400 401 402 403
**必选参数 :**   
`phone`: 手机号码

`password`: 密码
404 405


T
trazyn 已提交
406

407
**可选参数 :**   
B
binaryify 已提交
408
`countrycode`: 国家码,用于国外手机号登录,例如美国传入:`1`
409 410 411 412 413 414

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

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

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

B
improve  
binaryify 已提交
416
#### 2. 邮箱登录
B
binaryify 已提交
417

418
**必选参数 :**   
B
binaryify 已提交
419

420
`email`: 163 网易邮箱   
421

422
`password`: 密码
423

424 425 426 427
**可选参数 :**  

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

B
improve  
binaryify 已提交
428
**接口地址 :** `/login`
429

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

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

435
v3.30.0后支持手动传入cookie,登录接口返回内容新增 `cookie` 字段,保存到本地后,get请求带上`?cookie=xxx` (先使用 `encodeURIComponent()` 编码 cookie 值) 或者 post请求body带上 `cookie` 即可,如:`/user/cloud?cookie=xxx` 或者
436 437 438 439 440 441
```
{
    ...,
    cookie:"xxx"
}
```
B
binaryify 已提交
442
#### 3. 二维码登录
443 444 445 446 447
说明: 二维码登录涉及到3个接口,调用务必带上时间戳,防止缓存
##### 1. 二维码key生成接口  

说明: 调用此接口可生成一个key  

B
binaryify 已提交
448
**接口地址 :** `/login/qr/key`
449 450 451 452 453 454 455 456 457 458
##### 2. 二维码生成接口
说明: 调用此接口传入上一个接口生成的key可生成二维码图片的base64和二维码信息,可使用base64展示图片,或者使用二维码信息内容自行使用第三方二维码生产库渲染二维码  

必选参数: `key`,由第一个接口生成  

可选参数: `qrimg` 传入后会额外返回二维码图片base64编码  

**接口地址 :** `/login/qr/create`  

**调用例子 :** `/login/qr/create?key=xxx`  
B
binaryify 已提交
459 460


461 462
##### 3.  二维码检测扫码状态接口
说明: 轮询此接口可获取二维码扫码状态,800为二维码过期,801为等待扫码,802为待确认,803为授权登录成功(803状态码下会返回cookies)
B
binaryify 已提交
463

464
必选参数: `key`,由第一个接口生成  
B
binaryify 已提交
465 466 467

**接口地址 :** `/login/qr/check`

468 469 470
**调用例子 :** `/login/qr/check?key=xxx`  

调用可参考项目文件例子`/public/qrlogin.html` (访问地址:http://localhost:3000/qrlogin.html)
B
binaryify 已提交
471

B
binaryify 已提交
472

B
binaryify 已提交
473
#### 注意
B
improve  
binaryify 已提交
474 475

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

477
### 刷新登录
N
nujhong 已提交
478

B
improve  
binaryify 已提交
479 480 481
说明 : 调用此接口 , 可刷新登录状态

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

483 484 485 486 487 488 489 490 491
### 发送验证码

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

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

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

492
**接口地址 :** `/captcha/sent`
493

494
**调用例子 :** `/captcha/sent?phone=13xxx`
495 496 497 498 499 500 501 502 503 504 505 506 507

### 验证验证码

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

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

`captcha`: 验证码

**可选参数 :**

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

508
**接口地址 :** `/captcha/verify`
509

510
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
511 512 513 514 515 516


### 注册(修改密码)

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

517
**必选参数 :** 
518 519 520 521 522 523 524 525 526

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

B
binaryify 已提交
527 528 529 530
**可选参数 :**  

`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` ,默认86即中国

531 532 533 534
**接口地址 :** `/register/cellphone`

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

535
### 检测手机号码是否已注册
B
binaryify 已提交
536
说明 : 调用此接口 ,可检测手机号码是否已注册  
B
binaryify 已提交
537
**必选参数 :**  
538
`phone` :  手机号码  
B
binaryify 已提交
539 540 541 542

**可选参数 :**  
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` ,默认86即中国  

543 544 545 546 547
**接口地址 :** `/cellphone/existence/check`

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

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

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

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

556 557 558 559 560 561 562 563 564 565 566 567 568
### 更换绑定手机
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

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

`captcha`: 新手机验证码

`phone` :  手机号码  

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

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

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

B
v2.20.3  
binaryify 已提交
572 573 574 575 576 577
### 退出登录

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

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

578
### 登录状态
B
binaryify 已提交
579

580 581 582
说明 : 调用此接口,可获取登录状态

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

584

B
binaryify 已提交
585 586
### 获取用户详情

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

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

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

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

595 596 597 598 599 600 601 602
### 获取账号信息

说明 : 登录后调用此接口 ,可获取用户账号信息

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

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

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

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

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

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

611 612
### 获取用户等级信息

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

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

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

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

### 获取用户绑定信息

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

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


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

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


### 用户绑定手机

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

**必选参数 :**   

`phone` : 手机号码 

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

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

**可选参数 :**  

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


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

B
binaryify 已提交
651
**调用例子 :** `/user/replacephone?phone=xxx&captcha=1234&oldcaptcha=2345`
652 653


654 655
### 更新用户信息

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

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

660 661
```
gender: 性别 0:保密 1:男性 2:女性
662

663
birthday: 出生日期,时间戳 unix timestamp
664

665
nickname: 用户昵称
666

667
province: 省份id
668

669
city: 城市id
670

671 672 673
signature:用户签名
```

B
binaryify 已提交
674
**接口地址 :** `/user/update`
675

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

678
### 更新头像
679
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新头像(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/avatar_update.html),支持命令行调用,参考module_example目录下`avatar_upload.js`
680 681 682 683 684 685 686 687 688 689 690 691

**可选参数 :**

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

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

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

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

692 693 694 695 696
### 国家编码列表
说明 : 调用此接口,可获取国家编码列表

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

B
binaryify 已提交
697
### 获取用户歌单
698

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

B
binaryify 已提交
701 702 703 704 705 706 707
**必选参数 :** `uid` : 用户 id  

**可选参数 :**

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

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

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

B
improve  
binaryify 已提交
711 712 713
**调用例子 :** `/user/playlist?uid=32953014`

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

716 717
### 更新歌单

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

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

722 723
```
id:歌单id
724

B
binaryify 已提交
725
name:歌单名字
726

727
desc:歌单描述
728

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

732 733
**接口地址 :** `/playlist/update`

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

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

B
binaryify 已提交
739
**必选参数 :**  
B
binaryify 已提交
740 741 742 743 744 745 746 747 748 749 750
```
id:歌单id

desc:歌单描述

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

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

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

**必选参数 :**  
B
binaryify 已提交
754 755 756 757 758 759 760 761 762 763 764 765

```
id: 歌单id

name: 歌单名

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

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

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

**必选参数 :**  
B
binaryify 已提交
769 770 771 772 773 774 775 776 777 778

```
id: 歌单id

tags: 歌单标签

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

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

780 781

### 歌单封面上传
B
binaryify 已提交
782
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片formData(name为'imgFile'),可更新歌单封面(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/playlist_cover_update.html)
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798

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

**可选参数 :**

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

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

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

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


B
v3.32.0  
binaryify 已提交
799
### 调整歌单顺序
B
binaryify 已提交
800
说明 : 登录后调用此接口,可以根据歌单id顺序调整歌单顺序
B
binaryify 已提交
801 802


B
v3.32.0  
binaryify 已提交
803 804 805 806 807 808 809 810
**必选参数 :**   

`ids`: 歌单id列表

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

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

B
binaryify 已提交
811
### 调整歌曲顺序
B
binaryify 已提交
812
说明 : 登录后调用此接口,可以根据歌曲id顺序调整歌曲顺序  
B
binaryify 已提交
813 814 815 816 817 818 819 820 821 822 823


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

`ids`: 歌曲id列表

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

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

B
binaryify 已提交
824 825 826 827 828 829
### 获取用户历史评论

说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户历史评论

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

830 831
**可选参数 :**   

B
binaryify 已提交
832 833 834 835 836 837 838 839
`limit` : 返回数量 , 默认为 10

`time`: 上一条数据的time,第一页不需要传,默认为0

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

**调用例子 :** `/user/comment/history?uid=32953014` `/user/comment/history?uid=32953014&limit=1&time=1616217577564`  (需要换成自己的用户id)

840 841
### 获取用户电台

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

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

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

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

B
improve  
binaryify 已提交
850
### 获取用户关注列表
851

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

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

B
binaryify 已提交
856
**可选参数 :**  
857

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

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

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

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

B
improve  
binaryify 已提交
866
### 获取用户粉丝列表
867

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

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

B
binaryify 已提交
872 873
**可选参数 :** 
`limit` : 返回数量 , 默认为 30   
874

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

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

B
binaryify 已提交
879
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&limit=1` `/user/followeds?uid=416608258&limit=1&offset=1`
880 881 882

### 获取用户动态

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

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

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

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

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

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

B
binaryify 已提交
895 896 897 898 899 900 901 902 903 904 905 906
返回结果的`type`参数对应:
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
907
### 转发用户动态
B
binaryify 已提交
908
说明 : 登录后调用此接口 ,可以转发用户动态
B
binaryify 已提交
909 910 911 912 913 914 915 916 917 918 919 920

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

`evId` : 动态 id  

`forwards` : 转发的评论

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

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


B
binaryify 已提交
921
### 删除用户动态
B
binaryify 已提交
922
说明 : 登录后调用此接口 ,可以删除用户动态
B
binaryify 已提交
923 924 925 926 927 928 929

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

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

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

930
### 分享歌曲、歌单、mv、电台、电台节目到动态
B
binaryify 已提交
931
说明 : 登录后调用此接口 ,可以分享歌曲、歌单、mv、电台、电台节目到动态
932 933 934 935 936 937 938 939 940 941 942

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

943 944
### 获取动态评论

B
binaryify 已提交
945
说明 : 登录后调用此接口 , 可以获取动态下评论
946 947 948

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

949
**接口地址 :** `/comment/event`
950

951
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
952

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

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

**必选参数 :**

B
binaryify 已提交
959
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
960

B
binaryify 已提交
961
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
962 963 964 965 966

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

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

967 968
### 获取用户播放记录

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

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

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

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

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

979 980 981 982 983 984 985 986
### 获取热门话题

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

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

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

B
binaryify 已提交
987
**接口地址 :** `/hot/topic`
988

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

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
### 获取话题详情

说明 : 调用此接口 , 可获取话题详情

**接口地址 :** `/topic/detail`

**调用例子 :** `/topic/detail?actid=111551188`
### 获取话题详情热门动态

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

**接口地址 :** `/topic/detail/event/hot`

**调用例子 :** `/topic/detail/event/hot?actid=111551188`

1006

B
binaryify 已提交
1007
### 云村热评(官方下架,暂不能用)
1008 1009 1010 1011 1012 1013
说明 : 登录后调用此接口 , 可获取云村热评

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

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

1014
### 心动模式/智能播放
1015
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
**必选参数 :** `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 已提交
1027 1028
### 获取动态消息

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

1032 1033 1034 1035
**必选参数 :** 
`pagesize` : 每页数据,默认20

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

B
improve  
binaryify 已提交
1037 1038
**接口地址 :** `/event`

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

1041
### 歌手分类列表
B
binaryify 已提交
1042

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

1045
**可选参数 :**
1046

1047 1048 1049 1050
`limit` : 返回数量 , 默认为 30

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

1053
`type` 取值:
B
binaryify 已提交
1054

1055
```
B
binaryify 已提交
1056
-1:全部
1057 1058 1059 1060
1:男歌手
2:女歌手
3:乐队
```
1061

1062 1063 1064 1065 1066 1067 1068 1069
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
1070
```
1071
    
1072 1073 1074

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

1075
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
1076 1077


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

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

B
binaryify 已提交
1082
**必选参数 :**
1083

B
binaryify 已提交
1084
`id` : 歌手 id
1085

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

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

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

1092 1093 1094

### 歌手热门50首歌曲

1095
说明 : 调用此接口,可获取歌手热门50首歌曲
1096 1097 1098 1099 1100 1101 1102 1103 1104

**必选参数 :**

`id` : 歌手 id

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

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

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
### 歌手全部歌曲
说明 : 调用此接口,可获取歌手全部歌曲
**必选参数 :**

`id` : 歌手 id

**可选参数 :**

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

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

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

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

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

1123
### 收藏的歌手列表
B
binaryify 已提交
1124

1125 1126 1127 1128 1129 1130
说明 : 调用此接口,可获取收藏的歌手列表

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

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

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
### 收藏的专栏

说明 : 调用此接口,可获取收藏的专栏  

**可选参数 :**  

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

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

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

**调用例子 :** `/topic/sublist?limit=2&offset=1`

B
v3.0.0  
binaryify 已提交
1145 1146 1147 1148
### 收藏视频

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

B
binaryify 已提交
1149
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1150 1151 1152 1153 1154 1155 1156 1157 1158

`id` : 视频 id

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

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

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

1159
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
1160

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

B
binaryify 已提交
1163
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1164

B
binaryify 已提交
1165
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
1166 1167 1168 1169 1170 1171 1172

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

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

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

1173 1174 1175 1176 1177 1178 1179 1180
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
1181
### 歌单分类
B
binaryify 已提交
1182

B
binaryify 已提交
1183 1184 1185 1186 1187 1188 1189
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

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

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

B
binaryify 已提交
1211
**接口地址 :** `/top/playlist`
1212

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

1215 1216 1217 1218 1219 1220 1221
### 精品歌单标签列表
说明 : 调用此接口 , 可获取精品歌单标签列表

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

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

B
improve  
binaryify 已提交
1222
### 获取精品歌单
1223

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

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

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

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

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

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

B
binaryify 已提交
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
### 相关歌单推荐

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

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

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

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

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

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

B
binaryify 已提交
1260 1261 1262 1263 1264 1265 1266 1267 1268
### 歌单详情动态

说明 : 调用后可获取歌单详情动态部分,如评论数,是否收藏,播放数

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

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

**调用例子 :** `/playlist/detail/dynamic?id=24381616`
B
binaryify 已提交
1269 1270

### 获取音乐 url
1271

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

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

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

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

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

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

B
binaryify 已提交
1284

1285
### 音乐是否可用
B
binaryify 已提交
1286

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

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

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

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

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

1297
### 搜索
1298

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

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

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

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

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

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

B
binaryify 已提交
1315 1316 1317 1318 1319
### 默认搜索关键词
说明 : 调用此接口 , 可获取默认搜索关键词

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

1320
### 热搜列表(简略)
B
binaryify 已提交
1321

B
binaryify 已提交
1322 1323 1324 1325 1326 1327
说明 : 调用此接口,可获取热门搜索列表

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

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

1328 1329 1330 1331 1332 1333 1334 1335
### 热搜列表(详细)

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

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

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

1336 1337
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1349 1350
### 搜索多重匹配

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

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

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

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

1359 1360 1361 1362
### 新建歌单

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

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

1365
**可选参数 :**   
1366

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

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

1371
**接口地址 :** `/playlist/create`
1372

1373
**调用例子 :** `/playlist/create?name=测试歌单`,`/playlist/create?name=test&type=VIDEO`
B
binaryify 已提交
1374 1375 1376 1377 1378

### 删除歌单

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

B
binaryify 已提交
1379
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1380 1381 1382

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

B
binaryify 已提交
1383
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1384 1385


1386 1387 1388 1389 1390
### 收藏/取消收藏歌单

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

**必选参数 :**
1391

B
binaryify 已提交
1392
`t` : 类型,1:收藏,2:取消收藏
1393 1394 1395 1396 1397 1398
`id` : 歌单 id

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

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

1399

1400

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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


1416
### 对歌单添加或删除歌曲
B
binaryify 已提交
1417

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

1420
**必选参数 :**
1421

1422 1423 1424 1425
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

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

1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
### 收藏视频到视频歌单
说明 : 调用此接口 , 可收藏视频到视频歌单 ( 需要登录 )

**必选参数 :**

`pid` : 歌单 id

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

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

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

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

`pid` : 歌单 id

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

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

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

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

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

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

B
binaryify 已提交
1463
### 获取歌词
1464

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

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

B
improve  
binaryify 已提交
1469
**接口地址 :** `/lyric`
1470

B
improve  
binaryify 已提交
1471 1472 1473
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1486

B
binaryify 已提交
1487
华语:7
1488

B
binaryify 已提交
1489
欧美:96
1490

B
binaryify 已提交
1491
日本:8
1492

B
binaryify 已提交
1493 1494 1495 1496 1497 1498 1499
韩国:16
```

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

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

1500 1501 1502
### 首页-发现
说明 : 调用此接口 , 可获取APP首页信息

B
binaryify 已提交
1503 1504 1505 1506
**接口地址 :** `/homepage/block/page` 

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

1507 1508 1509 1510 1511 1512 1513

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

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


1514
### 歌曲评论
1515

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

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

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

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

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

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

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

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

B
binaryify 已提交
1533
### 楼层评论
1534

B
binaryify 已提交
1535
说明 : 调用此接口 , 传入资源 parentCommentId 和资源类型 type和资源id 参数, 可获得该资源的歌曲楼层评论
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558

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

`id` : 资源 id

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

```
0: 歌曲

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频
```


B
binaryify 已提交
1559
**可选参数 :** `limit`: 取出评论数量 , 默认为 20  
1560 1561 1562 1563 1564 1565 1566

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

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

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

1567 1568
### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1580 1581 1582
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1583 1584 1585

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1599
**调用例子 :** `/comment/playlist?id=705123491`
1600 1601 1602

### mv 评论

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

B
improve  
binaryify 已提交
1606
**必选参数 :** `id`: mv id
1607

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

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

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

B
improve  
binaryify 已提交
1614 1615 1616
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1617 1618 1619

### 电台节目评论

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

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

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

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

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

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

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

1635 1636 1637 1638 1639 1640 1641 1642 1643
### 视频评论

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

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

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

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

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

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1653 1654

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1655 1656 1657 1658 1659 1660 1661 1662 1663

**必选参数 :**

`id` : 资源 id

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

```
0: 歌曲
1664

1665
1: mv
1666

1667
2: 歌单
1668

1669
3: 专辑
1670

1671
4: 电台
1672

1673 1674
5: 视频
```
B
v2.20.3  
binaryify 已提交
1675

1676 1677 1678 1679 1680 1681
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

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

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

1682 1683 1684 1685
**接口地址 :** `/comment/hot`

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

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
### 新版评论接口
说明 : 调用此接口 , 传入资源类型和资源id,以及排序方式,可获取对应资源的评论

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

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

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频

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

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

B
binaryify 已提交
1713 1714 1715
`sortType`: 排序方式,1:按推荐排序,2:按热度排序,3:按时间排序

`cursor`: 当`sortType`为3时且页数不是第一页时需传入,值为上一条数据的time
1716

B
binaryify 已提交
1717 1718
**接口地址 :** `/comment/new`

B
binaryify 已提交
1719
**调用例子 :** `/comment/new?type=0&id=1407551413&sortType=3`, `/comment/new?type=0&id=1407551413&sortType=3&cursor=1602072870260&pageSize=20&pageNo=2` 
1720

B
binaryify 已提交
1721 1722
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1728
`cid` : 评论 id
B
binaryify 已提交
1729

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

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

B
binaryify 已提交
1734 1735
```
0: 歌曲
1736

B
binaryify 已提交
1737
1: mv
1738

B
binaryify 已提交
1739
2: 歌单
1740

N
nujhong 已提交
1741
3: 专辑
1742

B
binaryify 已提交
1743
4: 电台
1744

1745
5: 视频
1746 1747

6: 动态
B
improve  
binaryify 已提交
1748
```
N
nujhong 已提交
1749

B
binaryify 已提交
1750
**接口地址 :** `/comment/like`
B
binaryify 已提交
1751

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

1754 1755 1756

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

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
### 抱一抱评论

说明 : 调用此接口,可抱一抱评论

**必选参数 :**   

`uid`: 用户id  

`cid`: 评论id

`sid`: 资源id

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

**调用例子 :** `/hug/comment?uid=285516405&cid=1167145843&sid=863481066` 

### 评论抱一抱列表

说明 : 调用此接口,可获取评论抱一抱列表

**必选参数 :**   

`uid`: 用户id  

`cid`: 评论id

`sid`: 资源id

**可选参数 :**   

`page`:  页数

`cursor`: 上一页返回的cursor,默认-1,第一页不需要传

`idCursor`: 上一页返回的idCursor,默认-1,第一页不需要传

`pageSize` : 每页页数,默认100

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

**调用例子 :** `/comment/hug/list?uid=285516405&cid=1167145843&sid=863481066&pageSize=2&page=1` 


B
binaryify 已提交
1800 1801 1802 1803 1804 1805 1806 1807
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1808
   **必选参数**
1809

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

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

   ```
   0: 歌曲
1816

B
binaryify 已提交
1817
   1: mv
1818

B
binaryify 已提交
1819
   2: 歌单
1820

B
binaryify 已提交
1821
   3: 专辑
1822

B
binaryify 已提交
1823
   4: 电台
1824

1825
   5: 视频
1826 1827

   6: 动态
B
binaryify 已提交
1828 1829 1830 1831 1832 1833
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1840
2. 删除评论
B
binaryify 已提交
1841 1842

   **必选参数**
1843

B
v3.0.0  
binaryify 已提交
1844
   `t`:0 删除
B
binaryify 已提交
1845

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

   ```
   0: 歌曲
1851

B
binaryify 已提交
1852
   1: mv
1853

B
binaryify 已提交
1854
   2: 歌单
1855

B
binaryify 已提交
1856
   3: 专辑
1857

B
binaryify 已提交
1858
   4: 电台
1859 1860


1861
   5: 视频
1862 1863 1864

   6: 动态
   
B
binaryify 已提交
1865 1866 1867 1868
   ```

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

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

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

B
binaryify 已提交
1875

1876 1877
### banner

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

1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
**可选参数 :**

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

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1894 1895
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1902
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1903 1904

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

B
v3.0.0  
binaryify 已提交
1906 1907
```
1: mv
1908

B
v3.0.0  
binaryify 已提交
1909
4: 电台
1910

B
v3.0.0  
binaryify 已提交
1911
5: 视频
1912 1913

6: 动态
B
v3.0.0  
binaryify 已提交
1914 1915
```

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

B
binaryify 已提交
1918
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1919 1920 1921 1922 1923

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

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

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

1927 1928 1929 1930 1931 1932 1933 1934
### 获取点赞过的视频

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

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

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

B
binaryify 已提交
1935 1936
### 获取歌曲详情

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

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

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

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

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

B
binaryify 已提交
1948
### 获取专辑内容
1949

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

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

B
improve  
binaryify 已提交
1954
**接口地址 :** `/album`
1955

B
improve  
binaryify 已提交
1956 1957 1958
**调用例子 :** `/album?id=32311`

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

1961

B
binaryify 已提交
1962
### 专辑动态信息
1963 1964 1965 1966 1967 1968 1969 1970
说明 : 调用此接口 , 传入专辑 id, 可获得专辑动态信息,如是否收藏,收藏数,评论数,分享数

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

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

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

1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

1998
### 获取歌手单曲
1999

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

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

B
improve  
binaryify 已提交
2004
**接口地址 :** `/artists`
2005

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

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

2011
### 获取歌手 mv
B
improve  
binaryify 已提交
2012 2013 2014

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

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

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

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

2023
### 获取歌手专辑
2024

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

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

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

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

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

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

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

2041 2042
### 获取歌手描述

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

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

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

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

B
binaryify 已提交
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
### 获取歌手详情

说明 : 调用此接口 , 传入歌手 id, 可获得获取歌手详情

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

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

**调用例子 :** `/artist/detail?id=11972054` (Billie Eilish)

2061 2062
### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
2089
**调用例子 :** `/simi/mv?mvid=5436712`
2090 2091 2092

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
2107 2108 2109
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
2111
### 获取每日推荐歌单
2112

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

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

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

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

B
binaryify 已提交
2122
### 获取每日推荐歌曲
2123

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

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

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

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

2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
### 获取历史日推可用日期列表

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

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

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

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

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

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

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

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

2151 2152
### 私人 FM

B
improve  
binaryify 已提交
2153 2154 2155
说明 : 私人 FM( 需要登录 )

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

B
improve  
binaryify 已提交
2157
**调用例子 :** `/personal_fm`
2158

B
improve  
binaryify 已提交
2159
返回数据如下图 :
2160 2161 2162 2163 2164

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

### 签到

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

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

B
improve  
binaryify 已提交
2170
**接口地址 :** `/daily_signin`
2171

B
improve  
binaryify 已提交
2172 2173 2174
**调用例子 :** `/daily_signin`

返回数据如下图 :
2175

B
binaryify 已提交
2176
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
2177 2178 2179 2180

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

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

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

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

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

B
improve  
binaryify 已提交
2188
**接口地址 :** `/like`
2189

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

B
improve  
binaryify 已提交
2192
返回数据如下图 :
2193 2194 2195

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

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

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

2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
### 喜欢音乐列表

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

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

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

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

2210 2211
### 垃圾桶

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

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

B
improve  
binaryify 已提交
2216
**接口地址 :** `/fm_trash`
2217

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

B
improve  
binaryify 已提交
2220
返回数据如下图 :
2221 2222 2223

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

2224
### 新碟上架
N
nujhong 已提交
2225

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

2229 2230 2231
**可选参数 :**    

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

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

2236 2237 2238 2239 2240 2241 2242 2243
`area`: ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

`year` : 年,默认本年

`month` : 月,默认本月

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

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

2248
### 全部新碟
B
binaryify 已提交
2249
说明 : 登录后调用此接口 ,可获取全部新碟  
2250 2251 2252 2253 2254 2255

**可选参数 :**

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

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

2257 2258 2259 2260 2261
`area` : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

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

T
trazyn 已提交
2263 2264 2265 2266 2267 2268
### 最新专辑

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

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

B
binaryify 已提交
2269
**调用例子 :** `/album/newest`
T
trazyn 已提交
2270 2271 2272 2273 2274 2275 2276

### 听歌打卡

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

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

2277
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
2278 2279 2280

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

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

2283
### 热门歌手
N
nujhong 已提交
2284

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

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

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

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

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

B
improve  
binaryify 已提交
2296
返回数据如下图 :
2297 2298 2299

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

2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

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

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

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

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

2314 2315 2316 2317 2318
**接口地址 :** `/mv/all`

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

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

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

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

B
improve  
binaryify 已提交
2325 2326 2327
**接口地址 :** `/mv/first`

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

2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
### 网易出品mv

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

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

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

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

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

2342
### 推荐 mv
N
nujhong 已提交
2343

B
improve  
binaryify 已提交
2344 2345 2346
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
2348
**调用例子 :** `/personalized/mv`
2349 2350

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

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

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

B
improve  
binaryify 已提交
2356
**接口地址 :** `/personalized`
2357

2358 2359
**调用例子 :** `/personalized?limit=1`

2360
### 推荐新音乐
N
nujhong 已提交
2361

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

2364 2365
**可选参数 :** `limit`: 取出数量 , 默认为 10 (不支持 offset)

B
improve  
binaryify 已提交
2366 2367 2368
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
2369 2370

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

B
improve  
binaryify 已提交
2372 2373 2374
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
2376
**调用例子 :** `/personalized/djprogram`
2377 2378

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

B
improve  
binaryify 已提交
2380 2381 2382
说明 : 调用此接口 , 可获取推荐电台

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

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

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

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

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

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

B
binaryify 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
### 独家放送列表

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

**可选参数 :**

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

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

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

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

2408
### mv 排行
N
nujhong 已提交
2409

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

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

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

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

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

2421
**调用例子 :** `/top/mv?limit=10`
2422 2423

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

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

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

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

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

B
improve  
binaryify 已提交
2435
返回数据如下图 :
B
binaryify 已提交
2436

2437 2438 2439 2440
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

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

2443 2444 2445 2446 2447
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
2449
### mv 地址
2450

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

2453 2454 2455
**必选参数 :** `id`: mv id

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

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

**调用例子 :**
2460

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

2463 2464 2465 2466 2467 2468 2469
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

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

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

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

B
binaryify 已提交
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
**接口地址 :** `/video/category/list`

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

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

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

**可选参数 :** `offset`: 默认0
2483 2484 2485 2486 2487

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

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

B
binaryify 已提交
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
### 获取全部视频列表 
说明 : 调用此接口,可获取视频分类列表,分页参数只能传入offset 

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

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

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

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

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

B
binaryify 已提交
2502
**接口地址 :** `/video/timeline/recommend`
B
binaryify 已提交
2503

B
binaryify 已提交
2504
**调用例子 :** `/video/timeline/recommend?offset=10`
B
binaryify 已提交
2505

B
v3.0.0  
binaryify 已提交
2506
### 相关视频
B
binaryify 已提交
2507

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

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

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

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

2516

B
v3.0.0  
binaryify 已提交
2517
### 视频详情
B
binaryify 已提交
2518

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

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

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

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

2527 2528 2529 2530 2531 2532 2533 2534
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

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

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

2535
### 获取视频播放地址
B
binaryify 已提交
2536

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

B
v3.0.0  
binaryify 已提交
2539 2540 2541 2542 2543 2544
**必选参数 :** `id`: 视频 的 id

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

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

2545

2546
### 所有榜单
2547

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

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

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

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

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

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

B
binaryify 已提交
2562
~~**调用例子 :** `/top/list?id=2809577409`~~
2563 2564


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

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

B
v3.0.0  
binaryify 已提交
2569 2570 2571 2572
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2573 2574
### 歌手榜

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

B
binaryify 已提交
2577 2578 2579 2580 2581 2582 2583 2584
**可选参数 :**
```
type : 地区
1: 华语
2: 欧美
3: 韩国
4: 日本
```
B
improve  
binaryify 已提交
2585 2586 2587
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2588 2589 2590

### 云盘

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

2594 2595 2596 2597 2598 2599
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2600 2601 2602
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2604
### 云盘数据详情
B
binaryify 已提交
2605
说明 : 登录后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情
B
binaryify 已提交
2606 2607 2608 2609 2610 2611 2612 2613

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

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

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


2614
### 云盘歌曲删除
B
binaryify 已提交
2615
说明 : 登录后调用此接口 , 可删除云盘歌曲
2616 2617 2618 2619 2620 2621 2622

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

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

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

2623 2624 2625 2626 2627
### 云盘上传
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传mp3 formData(name为'songFile'),可上传歌曲到云盘  

参考: https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/cloud.html  

B
binaryify 已提交
2628
访问地址: http://localhost:3000/cloud.html)  
2629 2630 2631 2632 2633 2634 2635

支持命令行调用,参考module_example目录下`song_upload.js`

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

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

2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649
### 云盘歌曲信息匹配纠正
说明 : 登录后调用此接口,可对云盘歌曲信息匹配纠正  

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

`sid`: 云盘的歌曲id   

`asid`: 要匹配的歌曲id 

**接口地址 :** `/cloud/match`

**调用例子 :** `/cloud/match?uid=32953014&asid=0&sid=1321856840`

B
binaryify 已提交
2650 2651 2652 2653 2654 2655 2656
### 电台banner
说明 : 调用此接口,可获取电台banner

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

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

B
binaryify 已提交
2657 2658 2659 2660 2661 2662 2663 2664 2665
### 电台个性推荐
说明 : 调用此接口,可获取电台个性推荐列表
**可选参数 :**

`limit` : 返回数量,默认为 6,总条数最多6条

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

**调用例子 :** `/dj/personalize/recommend?limit=5`
B
binaryify 已提交
2666

B
binaryify 已提交
2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
### 电台订阅者列表
说明 : 调用此接口,可获取电台订阅者列表
**必选参数 :** `id`: 电台id

**可选参数 :**
`time` : 分页参数,默认-1,传入上一次返回结果的 time,将会返回下一页的数据 

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

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

**调用例子 :** `/dj/subscriber?id=335425050` , `/dj/subscriber?id=335425050&time=1602761825390`

B
binaryify 已提交
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
### 用户电台

说明 : 调用此接口, 传入用户id可获取用户创建的电台

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

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

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

### 热门电台
说明 : 调用此接口,可获取热门电台

**可选参数 :**

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

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

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

2702 2703
### 电台 - 节目榜

B
binaryify 已提交
2704
说明 : 登录后调用此接口 , 可获得电台节目榜
2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715

**可选参数 :**

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

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

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

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

2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

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

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

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


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

**可选参数 :**

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

B
binaryify 已提交
2735
**接口地址 :** `/dj/program/toplist/hours`
2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772

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

2773 2774
### 电台 - 新晋电台榜/热门电台榜

B
binaryify 已提交
2775
说明 : 登录后调用此接口 , 可获得新晋电台榜/热门电台榜
2776 2777 2778 2779 2780 2781

**可选参数 :**

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

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

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

2785 2786 2787 2788
**接口地址 :** `/dj/toplist`

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

B
binaryify 已提交
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802
### 电台 - 类别热门电台

**可选参数 :**

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

B
binaryify 已提交
2805
说明 : 登录后调用此接口 , 可获得推荐电台
2806

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

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

B
improve  
binaryify 已提交
2811
### 电台 - 分类
2812

B
binaryify 已提交
2813
说明 : 登录后调用此接口 , 可获得电台类型
2814

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

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

B
improve  
binaryify 已提交
2819
### 电台 - 分类推荐
2820

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

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

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

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

B
improve  
binaryify 已提交
2830
### 电台 - 订阅
2831

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

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

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

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

2842 2843
### 电台的订阅列表

B
binaryify 已提交
2844
说明 : 登录后调用此接口 , 可获取订阅的电台列表
2845 2846 2847 2848 2849

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

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

add doc  
徐星宇 已提交
2850 2851 2852 2853
### 电台 - 付费精选

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

2854 2855 2856 2857 2858 2859
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2860 2861 2862 2863
**接口地址 :** `/dj/paygift`

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

2864 2865
### 电台 - 非热门类型

B
binaryify 已提交
2866
说明 : 登录后调用此接口, 可获得电台非热门类型
2867 2868 2869 2870 2871 2872 2873 2874


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

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

### 电台 - 推荐类型

B
binaryify 已提交
2875
说明 : 登录后调用此接口, 可获得电台推荐类型
2876 2877 2878 2879 2880 2881 2882 2883


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

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

### 电台 - 今日优选

B
binaryify 已提交
2884
说明 : 登录后调用此接口, 可获得电台今日优选
2885 2886 2887 2888 2889 2890


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

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

B
improve  
binaryify 已提交
2891
### 电台 - 详情
2892

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

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

2897
**接口地址 :** `/dj/detail`
2898

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

B
improve  
binaryify 已提交
2901
### 电台 - 节目
2902

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

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

B
binaryify 已提交
2910
**可选参数 :**
2911

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

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

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

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

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

B
binaryify 已提交
2922 2923 2924 2925 2926 2927 2928 2929
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

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

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

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2930 2931 2932

### 通知 - 私信

B
binaryify 已提交
2933
说明 : 登录后调用此接口 ,可获取私信
B
binaryify 已提交
2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944

**可选参数 :**

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

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

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

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

B
v3.12.0  
binaryify 已提交
2945 2946
### 发送私信

B
binaryify 已提交
2947
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)
B
v3.12.0  
binaryify 已提交
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957

**必选参数 :**

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

`msg` : 要发送的信息

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

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

未来初号机's avatar
未来初号机 已提交
2959
### 发送私信(带歌曲)
B
v3.12.0  
binaryify 已提交
2960

2961
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息,音乐id, 可以发送音乐私信,返回内容为历史私信
B
v3.12.0  
binaryify 已提交
2962 2963 2964

**必选参数 :**

2965
`user_ids` : 用户 id,多个需用逗号隔开
B
v3.12.0  
binaryify 已提交
2966

未来初号机's avatar
未来初号机 已提交
2967 2968
`id` : 要发送音乐的id

2969
`msg` : 要发送的信息
B
v3.12.0  
binaryify 已提交
2970

2971 2972 2973
**接口地址 :** `/send/song`

**调用例子 :** `/send/song?user_ids=1&id=351318&msg=测试`
B
v3.12.0  
binaryify 已提交
2974

未来初号机's avatar
未来初号机 已提交
2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989
### 发送私信(带专辑)

说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息,专辑id, 可以发送专辑私信,返回内容为消息id

**必选参数 :**

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

`id` : 要发送专辑的id

`msg` : 要发送的信息

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

**调用例子 :** `/send/album?user_ids=1&id=351318&msg=测试`
B
v3.12.0  
binaryify 已提交
2990 2991 2992

### 发送私信(带歌单)

B
binaryify 已提交
2993
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)
B
v3.12.0  
binaryify 已提交
2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004

**必选参数 :**

`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`

3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027
### 最近联系人
说明 : 登录后调用此接口 ,可获取最接近联系人

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

**调用例子 :** `/msg/recentcontact`

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

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

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

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

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

**调用例子 :**
`/msg/private/history?uid=9003` (云音乐小秘书)
B
binaryify 已提交
3028 3029 3030

### 通知 - 评论

B
binaryify 已提交
3031
说明 : 登录后调用此接口 ,可获取评论
B
binaryify 已提交
3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047

**必选参数 :** `uid`: 用户 的 id,只能和登录账号的 id 一致

**可选参数 :**

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

`before` : 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据


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

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

### 通知 - @我

B
binaryify 已提交
3048
说明 : 登录后调用此接口 ,可获取@我数据
B
binaryify 已提交
3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062

**可选参数 :**

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

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

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

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


### 通知 - 通知

B
binaryify 已提交
3063
说明 : 登录后调用此接口 ,可获取通知
B
binaryify 已提交
3064 3065 3066 3067 3068

**可选参数 :**

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

B
binaryify 已提交
3069
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
3070 3071 3072 3073 3074 3075 3076


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

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

### 设置
B
binaryify 已提交
3077
说明 : 登录后调用此接口 ,可获取用户设置
B
binaryify 已提交
3078 3079 3080 3081 3082

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

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

3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135
### 数字专辑-新碟上架
说明 : 调用此接口 ,可获取数字专辑-新碟上架  

**可选参数 :**

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

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

**调用例子 :** `/album/list?limit=10`

### 数字专辑&数字单曲-榜单
说明 : 调用此接口 ,可获取数字专辑&数字单曲-榜单  

**可选参数 :**

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

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

`albumType` : 为数字专辑,1为数字单曲

`type` : daily:日榜,week:周榜,year:年榜,total:总榜  

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

**调用例子 :** `/album/songsaleboard?type=year&year=2020&albumType=0`

### 数字专辑-语种风格馆

说明 : 调用此接口 ,可获取语种风格馆数字专辑列表  

**可选参数 :**

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

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

`area` 地区 Z_H:华语,E_A:欧美,KR:韩国,JP:日本  

**接口地址 :** `/album/list/style`

**调用例子 :** `/album/list/style?area=Z_H&offset=2`

### 数字专辑详情
说明 : 调用此接口 ,传入数字专辑id可获取数字专辑详情(和歌单详情有差异)

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

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


B
v3.12.0  
binaryify 已提交
3136
### 我的数字专辑
B
binaryify 已提交
3137
说明 : 登录后调用此接口 ,可获取我的数字专辑
B
v3.12.0  
binaryify 已提交
3138 3139 3140 3141 3142

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

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

T
TimonPeng 已提交
3143
### 购买数字专辑
B
binaryify 已提交
3144
说明 : 登录后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157

**必选参数 :**

`id` : 专辑的 id

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

`quantity` : 购买的数量

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

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

3158
### 音乐日历
3159
说明 : 登录后调用此接口,传入开始和结束时间,可获取音乐日历
3160 3161 3162 3163 3164

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

**调用例子 :** `/calendar?startTime=1606752000000&endTime=1609430399999`

3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
### 云贝
说明 : 登录后调用此接口可获取云贝签到信息(连续签到天数,第二天全部可获得的云贝)

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

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

### 云贝今日签到信息
说明 : 登录后调用此接口可获取云贝今日签到信息(今日签到获取的云贝数)

**接口地址 :** `/yunbei/today`

**调用例子 :** `/yunbei/today`

### 云贝签到
说明 : 登录后调用此接口可进行云贝签到

**接口地址 :** `/yunbei/sign`

**调用例子 :** `/yunbei/sign`

### 云贝账户信息
说明 :登录后调用此接口可获取云贝账户信息(账户云贝数)

**接口地址 :** `/yunbei/info`

**调用例子 :** `/yunbei/info`

### 云贝所有任务
说明 :登录后调用此接口可获取云贝所有任务

**接口地址 :** `/yunbei/tasks`

**调用例子 :** `/yunbei/tasks`

### 云贝todo任务
说明 :登录后调用此接口可获取云贝todo任务

**接口地址 :** `/yunbei/tasks/todo`

**调用例子 :** `/yunbei/tasks/todo`

### 云贝完成任务
**必选参数 :**

`userTaskId` : 任务id

3212 3213 3214 3215
**可选参数 :** 

`depositCode`: 任务depositCode  

3216 3217
**接口地址 :** `/yunbei/task/finish`

3218
**调用例子 :** `/yunbei/task/finish?userTaskId=5146243240&depositCode=0`
3219 3220 3221 3222 3223 3224 3225

### 云贝收入
说明 :登录后调用此接口可获取云贝收入  

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

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

3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239
**接口地址 :** `/yunbei/tasks/receipt`

**调用例子 :** `/yunbei/tasks/receipt?limit=1`

### 云贝支出
说明 :登录后调用此接口可获取云贝支出  

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

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值  
**接口地址 :** `/yunbei/tasks/expense`

**调用例子 :** `/yunbei/tasks/expense?limit=1`
3240

3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263
### 关注歌手新歌
说明 :登录后调用此接口可获取关注歌手新歌

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

`before`: 上一页数据返回的publishTime的数据 

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

**调用例子 :** `/artist/new/song?limit=1` `/artist/new/song?limit=1&before=1602777625000`


### 关注歌手新MV
说明 :登录后调用此接口可获取关注歌手新MV 

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

`before`: 上一页数据返回的publishTime的数据

**接口地址 :** `/artist/new/mv`

**调用例子 :** `/artist/new/mv?limit=1` `/artist/new/mv?limit=1&before=1602777625000`

3264 3265 3266 3267 3268 3269
### 一起听状态
说明 :登录后调用此接口可获取一起听状态

**接口地址 :** `/listen/together/status`

**调用例子 :** `/listen/together/status`
3270

B
v3.13.0  
binaryify 已提交
3271
### batch批量请求接口
B
binaryify 已提交
3272
说明 : 登录后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口
B
v3.13.0  
binaryify 已提交
3273 3274 3275 3276 3277 3278 3279

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

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
3280
## 离线访问此文档
B
binaryify 已提交
3281

B
improve  
binaryify 已提交
3282
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
3283 3284

## 关于此文档
B
improve  
binaryify 已提交
3285 3286 3287 3288

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
3289

B
binaryify 已提交
3290
## License
B
improve  
binaryify 已提交
3291

B
binaryify 已提交
3292
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)