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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

request 相关的环境变量

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

`password`: 密码
343 344


T
trazyn 已提交
345

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

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

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

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

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

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

359
`email`: 163 网易邮箱   
360

361
`password`: 密码
362

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



### 验证验证码

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

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

`captcha`: 验证码

**可选参数 :**

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

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

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


### 注册(修改密码)

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

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

`captcha`: 验证码

`phone` :  手机号码 

`password`: 密码

`nickname`: 昵称

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

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

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

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

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

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

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

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

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

`captcha`: 新手机验证码

`phone` :  手机号码  

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

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

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

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

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

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

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

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

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

489

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

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

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

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

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

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

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

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

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

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

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

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

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

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

519
nickname: 用户昵称
520

521
province: 省份id
522

523
city: 城市id
524

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

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

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

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

**可选参数 :**

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

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

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

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
559 560 561
**调用例子 :** `/user/playlist?uid=32953014`

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

564 565 566
### 更新歌单

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

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

570 571
```
id:歌单id
572

B
binaryify 已提交
573
name:歌单名字
574

575
desc:歌单描述
576

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

580 581
**接口地址 :** `/playlist/update`

B
binaryify 已提交
582
**调用例子 :** `/playlist/update?id=24381616&name=新歌单&desc=描述&tags=欧美`
B
binaryify 已提交
583 584 585 586

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

B
binaryify 已提交
587
**必选参数 :**  
B
binaryify 已提交
588 589 590 591 592 593 594 595 596 597 598 599
```
id:歌单id

desc:歌单描述

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

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

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

**必选参数 :**  
B
binaryify 已提交
602 603 604 605 606 607 608 609 610 611 612 613 614

```
id: 歌单id

name: 歌单名

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

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

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

**必选参数 :**  
B
binaryify 已提交
617 618 619 620 621 622 623 624 625 626

```
id: 歌单id

tags: 歌单标签

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

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

628 629

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

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

**可选参数 :**

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

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

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

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


B
v3.32.0  
binaryify 已提交
647 648
### 调整歌单顺序
说明 : 登陆后调用此接口,可以根据歌单id顺序调整歌单顺序
B
binaryify 已提交
649 650


B
v3.32.0  
binaryify 已提交
651 652 653 654 655 656 657 658
**必选参数 :**   

`ids`: 歌单id列表

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

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

B
binaryify 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671
### 调整歌曲顺序
说明 : 登陆后调用此接口,可以根据歌曲id顺序调整歌曲顺序  


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

`ids`: 歌曲id列表

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

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

672 673
### 获取用户电台

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

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

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

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

B
improve  
binaryify 已提交
682
### 获取用户关注列表
683

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

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

B
binaryify 已提交
688
**可选参数 :**
689

B
binaryify 已提交
690 691 692
`limit` : 返回数量 , 默认为 30

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

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

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

B
improve  
binaryify 已提交
699
### 获取用户粉丝列表
700

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

703 704 705 706 707
**必选参数 :** `uid` : 用户 id  

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

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


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

712
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&time=1560152549136`
713 714 715

### 获取用户动态

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

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

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

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

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

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

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

B
binaryify 已提交
740 741 742 743 744 745 746 747 748 749 750 751 752 753
### 转发用户动态
说明 : 登陆后调用此接口 ,可以转发用户动态

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

`evId` : 动态 id  

`forwards` : 转发的评论

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

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


B
binaryify 已提交
754 755 756 757 758 759 760 761 762
### 删除用户动态
说明 : 登陆后调用此接口 ,可以删除用户动态

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

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

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

763 764 765 766 767 768 769 770 771 772 773 774 775
### 分享歌曲、歌单、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 测试` 

776 777 778 779 780 781
### 获取动态评论

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

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

782
**接口地址 :** `/comment/event`
783

784
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
785

B
v3.0.0  
binaryify 已提交
786 787 788 789 790 791
### 关注/取消关注用户

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

**必选参数 :**

B
binaryify 已提交
792
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
793

B
binaryify 已提交
794
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
795 796 797 798 799

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

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

800 801
### 获取用户播放记录

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

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

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

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

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

812 813 814 815 816 817 818 819
### 获取热门话题

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

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

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

B
binaryify 已提交
820
**接口地址 :** `/hot/topic`
821

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

824 825 826 827 828 829 830 831

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

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

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

832
### 心动模式/智能播放
833
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
834 835 836 837 838 839 840 841 842 843 844
**必选参数 :** `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 已提交
845 846
### 获取动态消息

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

850 851 852 853
**必选参数 :** 
`pagesize` : 每页数据,默认20

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

B
improve  
binaryify 已提交
855 856
**接口地址 :** `/event`

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

859
### 歌手分类列表
B
binaryify 已提交
860

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

863
**可选参数 :**
864

865 866 867 868
`limit` : 返回数量 , 默认为 30

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

871
`type` 取值:
B
binaryify 已提交
872

873
```
B
binaryify 已提交
874
-1:全部
875 876 877 878
1:男歌手
2:女歌手
3:乐队
```
879

880 881 882 883 884 885 886 887
`area` 取值:
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
888
```
889
    
890 891 892

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

893
**调用例子 :** `/artist/list?type=1&area=96&initial=b` `/artist/list?type=2&area=2&initial=b`
894 895


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

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

B
binaryify 已提交
900
**必选参数 :**
901

B
binaryify 已提交
902
`artistId` : 歌手 id
903

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

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

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

910 911 912

### 歌手热门50首歌曲

913
说明 : 调用此接口,可获取歌手热门50首歌曲
914 915 916 917 918 919 920 921 922

**必选参数 :**

`id` : 歌手 id

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

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

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
### 歌手全部歌曲
说明 : 调用此接口,可获取歌手全部歌曲
**必选参数 :**

`id` : 歌手 id

**可选参数 :**

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

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

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

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

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

941
### 收藏的歌手列表
B
binaryify 已提交
942

943 944 945 946 947 948
说明 : 调用此接口,可获取收藏的歌手列表

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

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

B
v3.0.0  
binaryify 已提交
949 950 951 952
### 收藏视频

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

B
binaryify 已提交
953
**必选参数 :**
B
v3.0.0  
binaryify 已提交
954 955 956 957 958 959 960 961 962

`id` : 视频 id

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

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

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

963
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
964

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

B
binaryify 已提交
967
**必选参数 :**
B
v3.0.0  
binaryify 已提交
968

B
binaryify 已提交
969
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
970 971 972 973 974 975 976

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

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

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

977 978 979 980 981 982 983 984
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
985
### 歌单分类
B
binaryify 已提交
986

B
binaryify 已提交
987 988 989 990 991 992 993
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

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

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

B
binaryify 已提交
1015
**接口地址 :** `/top/playlist`
1016

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

B
improve  
binaryify 已提交
1019
### 获取精品歌单
1020

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

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

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

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

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

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

B
binaryify 已提交
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
### 相关歌单推荐

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

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

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

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

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

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

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

### 获取音乐 url
1061

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

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

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

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

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

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

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

1078
### 音乐是否可用
B
binaryify 已提交
1079

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

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

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

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

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

1090
### 搜索
1091

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

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

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

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

B
improve  
binaryify 已提交
1104
**接口地址 :** `/search`
1105

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

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

B
binaryify 已提交
1111 1112 1113 1114 1115 1116

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

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

1117
### 热搜列表(简略)
B
binaryify 已提交
1118

B
binaryify 已提交
1119 1120 1121 1122 1123 1124
说明 : 调用此接口,可获取热门搜索列表

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

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

1125 1126 1127 1128 1129 1130 1131 1132
### 热搜列表(详细)

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

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

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

1133 1134
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1146 1147
### 搜索多重匹配

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

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

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

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

1156 1157 1158 1159
### 新建歌单

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

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

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

1164 1165 1166 1167
**接口地址 :** `/playlist/create`

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

1168

1169

B
binaryify 已提交
1170 1171 1172 1173 1174

### 删除歌单

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

B
binaryify 已提交
1175
**必选参数 :** `id` : 歌单id,可多个,用逗号隔开
B
binaryify 已提交
1176 1177 1178

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

B
binaryify 已提交
1179
**调用例子 :** `/playlist/delete?id=2947311456` , `/playlist/delete?id=5013464397,5013427772`
B
binaryify 已提交
1180 1181


1182 1183 1184 1185 1186
### 收藏/取消收藏歌单

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

**必选参数 :**
1187

B
binaryify 已提交
1188
`t` : 类型,1:收藏,2:取消收藏
1189 1190 1191 1192 1193 1194
`id` : 歌单 id

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

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

1195

1196

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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


1212
### 对歌单添加或删除歌曲
B
binaryify 已提交
1213

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

1216
**必选参数 :**
1217

1218 1219 1220 1221
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

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

B
binaryify 已提交
1227
### 获取歌词
1228

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

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

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

B
improve  
binaryify 已提交
1235 1236 1237
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1250

B
binaryify 已提交
1251
华语:7
1252

B
binaryify 已提交
1253
欧美:96
1254

B
binaryify 已提交
1255
日本:8
1256

B
binaryify 已提交
1257 1258 1259 1260 1261 1262 1263
韩国:16
```

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

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

1264 1265 1266
### 首页-发现
说明 : 调用此接口 , 可获取APP首页信息

B
binaryify 已提交
1267 1268 1269 1270
**接口地址 :** `/homepage/block/page` 

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

1271 1272 1273 1274 1275 1276 1277

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

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


1278
### 歌曲评论
1279

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

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

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

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

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

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

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

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

1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
### 歌曲楼层评论

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

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

`id` : 资源 id

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

```
0: 歌曲

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频
```


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

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

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

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

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

1334 1335
### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1347 1348 1349
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1350 1351 1352

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1366
**调用例子 :** `/comment/playlist?id=705123491`
1367 1368 1369

### mv 评论

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

B
improve  
binaryify 已提交
1373
**必选参数 :** `id`: mv id
1374

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

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

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

B
improve  
binaryify 已提交
1381 1382 1383
**接口地址 :** `/comment/mv`

**调用例子 :** `/comment/mv?id=5436712`
1384 1385 1386

### 电台节目评论

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

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

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

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

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

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

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

1402 1403 1404 1405 1406 1407 1408 1409 1410
### 视频评论

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

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

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

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

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

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1420 1421

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1422 1423 1424 1425 1426 1427 1428 1429 1430

**必选参数 :**

`id` : 资源 id

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

```
0: 歌曲
1431

1432
1: mv
1433

1434
2: 歌单
1435

1436
3: 专辑
1437

1438
4: 电台
1439

1440 1441
5: 视频
```
B
v2.20.3  
binaryify 已提交
1442

1443 1444 1445 1446 1447 1448
**可选参数 :** `limit`: 取出评论数量 , 默认为 20

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

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

1449 1450 1451 1452
**接口地址 :** `/comment/hot`

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

B
binaryify 已提交
1453 1454
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1460
`cid` : 评论 id
B
binaryify 已提交
1461

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

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

B
binaryify 已提交
1466 1467
```
0: 歌曲
1468

B
binaryify 已提交
1469
1: mv
1470

B
binaryify 已提交
1471
2: 歌单
1472

N
nujhong 已提交
1473
3: 专辑
1474

B
binaryify 已提交
1475
4: 电台
1476

1477
5: 视频
1478 1479

6: 动态
B
improve  
binaryify 已提交
1480
```
N
nujhong 已提交
1481

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

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

1486 1487 1488

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

B
binaryify 已提交
1489 1490 1491 1492 1493 1494 1495 1496
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1497
   **必选参数**
1498

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

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

   ```
   0: 歌曲
1505

B
binaryify 已提交
1506
   1: mv
1507

B
binaryify 已提交
1508
   2: 歌单
1509

B
binaryify 已提交
1510
   3: 专辑
1511

B
binaryify 已提交
1512
   4: 电台
1513

1514
   5: 视频
1515 1516

   6: 动态
B
binaryify 已提交
1517 1518 1519 1520 1521 1522
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1529
2. 删除评论
B
binaryify 已提交
1530 1531

   **必选参数**
1532

B
v3.0.0  
binaryify 已提交
1533
   `t`:0 删除
B
binaryify 已提交
1534

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

   ```
   0: 歌曲
1540

B
binaryify 已提交
1541
   1: mv
1542

B
binaryify 已提交
1543
   2: 歌单
1544

B
binaryify 已提交
1545
   3: 专辑
1546

B
binaryify 已提交
1547
   4: 电台
1548 1549


1550
   5: 视频
1551 1552 1553

   6: 动态
   
B
binaryify 已提交
1554 1555 1556 1557
   ```

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

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

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

B
binaryify 已提交
1564

1565 1566
### banner

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

1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
**可选参数 :**

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

```
0: pc

1: android

2: iphone

3: ipad
```

B
improve  
binaryify 已提交
1583 1584
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1591
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1592 1593

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

B
v3.0.0  
binaryify 已提交
1595 1596
```
1: mv
1597

B
v3.0.0  
binaryify 已提交
1598
4: 电台
1599

B
v3.0.0  
binaryify 已提交
1600
5: 视频
1601 1602

6: 动态
B
v3.0.0  
binaryify 已提交
1603 1604
```

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

B
binaryify 已提交
1607
`id`: 资源 id
B
v3.0.0  
binaryify 已提交
1608 1609 1610 1611 1612

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

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

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

B
binaryify 已提交
1616 1617
### 获取歌曲详情

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

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

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

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

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

B
binaryify 已提交
1629
### 获取专辑内容
1630

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

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

B
improve  
binaryify 已提交
1635
**接口地址 :** `/album`
1636

B
improve  
binaryify 已提交
1637 1638 1639
**调用例子 :** `/album?id=32311`

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

1642

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

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

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

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

1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
### 获取已收藏专辑列表
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

1679
### 获取歌手单曲
1680

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

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

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

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

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

1692
### 获取歌手 mv
B
improve  
binaryify 已提交
1693 1694 1695

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

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

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

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

1704
### 获取歌手专辑
1705

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

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

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

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

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

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

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

1722 1723
### 获取歌手描述

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

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

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

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

### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
1760
**调用例子 :** `/simi/mv?mvid=5436712`
1761 1762 1763

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
1778 1779 1780
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
1782
### 获取每日推荐歌单
1783

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

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

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

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

B
binaryify 已提交
1793
### 获取每日推荐歌曲
1794

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

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

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

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

1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
### 获取历史日推可用日期列表

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

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

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

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

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

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

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

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

1822 1823
### 私人 FM

B
improve  
binaryify 已提交
1824 1825 1826
说明 : 私人 FM( 需要登录 )

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

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

B
improve  
binaryify 已提交
1830
返回数据如下图 :
1831 1832 1833 1834 1835

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

### 签到

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

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

B
improve  
binaryify 已提交
1841
**接口地址 :** `/daily_signin`
1842

B
improve  
binaryify 已提交
1843 1844 1845
**调用例子 :** `/daily_signin`

返回数据如下图 :
1846

B
binaryify 已提交
1847
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
1848 1849 1850 1851

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

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

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

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

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

B
improve  
binaryify 已提交
1859
**接口地址 :** `/like`
1860

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

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

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

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

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

1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
### 喜欢音乐列表

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

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

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

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

1881 1882
### 垃圾桶

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

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

B
improve  
binaryify 已提交
1887
**接口地址 :** `/fm_trash`
1888

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

B
improve  
binaryify 已提交
1891
返回数据如下图 :
1892 1893 1894

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

1895
### 新碟上架
N
nujhong 已提交
1896

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

1900 1901 1902
**可选参数 :**    

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

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

1907 1908 1909 1910 1911 1912 1913 1914
`area`: ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

`year` : 年,默认本年

`month` : 月,默认本月

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

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

1919 1920 1921 1922 1923 1924 1925 1926
### 全部新碟
说明 : 登陆后调用此接口 ,可获取全部新碟  

**可选参数 :**

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

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

1928 1929 1930 1931 1932
`area` : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

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

T
trazyn 已提交
1934 1935 1936 1937 1938 1939
### 最新专辑

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

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

B
binaryify 已提交
1940
**调用例子 :** `/album/newest`
T
trazyn 已提交
1941 1942 1943 1944 1945 1946 1947

### 听歌打卡

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

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

1948
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
1949 1950 1951

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

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

1954
### 热门歌手
N
nujhong 已提交
1955

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

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

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

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

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

B
improve  
binaryify 已提交
1967
返回数据如下图 :
1968 1969 1970

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

1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
### 全部 mv
说明 : 调用此接口 , 可获取全部 mv

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

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

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

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

1985 1986 1987 1988 1989
**接口地址 :** `/mv/all`

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

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

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

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

B
improve  
binaryify 已提交
1996 1997 1998
**接口地址 :** `/mv/first`

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

2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
### 网易出品mv

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

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

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

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

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

2013
### 推荐 mv
N
nujhong 已提交
2014

B
improve  
binaryify 已提交
2015 2016 2017
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
2019
**调用例子 :** `/personalized/mv`
2020 2021

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

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

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

B
improve  
binaryify 已提交
2027
**接口地址 :** `/personalized`
2028

2029 2030 2031
**调用例子 :** `/personalized?limit=1`


2032 2033

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

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

B
improve  
binaryify 已提交
2037 2038 2039
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
2040 2041

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

B
improve  
binaryify 已提交
2043 2044 2045
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
2047
**调用例子 :** `/personalized/djprogram`
2048 2049

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

B
improve  
binaryify 已提交
2051 2052 2053
说明 : 调用此接口 , 可获取推荐电台

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

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

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

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

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

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

B
binaryify 已提交
2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
### 独家放送列表

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

**可选参数 :**

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

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

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

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

2079
### mv 排行
N
nujhong 已提交
2080

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

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

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

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

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

2092
**调用例子 :** `/top/mv?limit=10`
2093 2094

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

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

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

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

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

B
improve  
binaryify 已提交
2106
返回数据如下图 :
B
binaryify 已提交
2107

2108 2109 2110 2111
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

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

2114 2115 2116 2117 2118
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
2120
### mv 地址
2121

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

B
binaryify 已提交
2124
**可选参数 :** `id`: mv id
B
v3.0.0  
binaryify 已提交
2125 2126 2127 2128

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

**调用例子 :**
2129

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

2132 2133 2134 2135 2136 2137 2138
### 获取视频标签列表 
说明 : 调用此接口 , 可获取视频标签列表  

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

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

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

B
binaryify 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
**接口地址 :** `/video/category/list`

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

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

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

**可选参数 :** `offset`: 默认0
2152 2153 2154 2155 2156

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

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

B
binaryify 已提交
2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
### 获取全部视频列表 
说明 : 调用此接口,可获取视频分类列表,分页参数只能传入offset 

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

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

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

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

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

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

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

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

B
v3.0.0  
binaryify 已提交
2177
### 相关视频
B
binaryify 已提交
2178

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

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

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

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

2187

B
v3.0.0  
binaryify 已提交
2188
### 视频详情
B
binaryify 已提交
2189

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

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

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

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

2198 2199 2200 2201 2202 2203 2204 2205
### 获取视频点赞转发评论数数据
说明 : 调用此接口 , 传入 vid ( 视频id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频id

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

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

2206
### 获取视频播放地址
B
binaryify 已提交
2207

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

B
v3.0.0  
binaryify 已提交
2210 2211 2212 2213 2214 2215
**必选参数 :** `id`: 视频 的 id

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

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

2216

2217
### 所有榜单
2218

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

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

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

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

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

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

B
binaryify 已提交
2233
~~**调用例子 :** `/top/list?id=2809577409`~~
2234 2235


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

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

B
v3.0.0  
binaryify 已提交
2240 2241 2242 2243
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2244 2245
### 歌手榜

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

B
binaryify 已提交
2248 2249 2250 2251 2252 2253 2254 2255
**可选参数 :**
```
type : 地区
1: 华语
2: 欧美
3: 韩国
4: 日本
```
B
improve  
binaryify 已提交
2256 2257 2258
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2259 2260 2261

### 云盘

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

2265 2266 2267 2268 2269 2270
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2271 2272 2273
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
### 云盘数据详情
说明 : 登陆后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情

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

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

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


2285 2286 2287 2288 2289 2290 2291 2292 2293
### 云盘歌曲删除
说明 : 登陆后调用此接口 , 可删除云盘歌曲

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

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

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

B
binaryify 已提交
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323
### 电台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`

2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
### 电台 - 节目榜

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

**可选参数 :**

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

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

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

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

2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
### 电台 - 付费精品
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

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

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

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


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

**可选参数 :**

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

B
binaryify 已提交
2357
**接口地址 :** `/dj/program/toplist/hours`
2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394

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

2395 2396 2397 2398 2399 2400 2401 2402 2403
### 电台 - 新晋电台榜/热门电台榜

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

**可选参数 :**

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

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

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

2407 2408 2409 2410
**接口地址 :** `/dj/toplist`

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

B
binaryify 已提交
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
### 电台 - 类别热门电台

**可选参数 :**

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

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

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

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

B
improve  
binaryify 已提交
2433
### 电台 - 分类
2434

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

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

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

B
improve  
binaryify 已提交
2441
### 电台 - 分类推荐
2442

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

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

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

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

B
improve  
binaryify 已提交
2452
### 电台 - 订阅
2453

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

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

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

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

2464 2465 2466 2467 2468 2469 2470 2471
### 电台的订阅列表

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

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

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

add doc  
徐星宇 已提交
2472 2473 2474 2475
### 电台 - 付费精选

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

2476 2477 2478 2479 2480 2481
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2482 2483 2484 2485
**接口地址 :** `/dj/paygift`

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

2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
### 电台 - 非热门类型

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


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

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

### 电台 - 推荐类型

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


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

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

### 电台 - 今日优选

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


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

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

B
improve  
binaryify 已提交
2513
### 电台 - 详情
2514

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

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

2519
**接口地址 :** `/dj/detail`
2520

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

B
improve  
binaryify 已提交
2523
### 电台 - 节目
2524

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

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

B
binaryify 已提交
2532
**可选参数 :**
2533

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

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

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

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

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

B
binaryify 已提交
2544 2545 2546 2547 2548 2549 2550 2551
### 电台 - 节目详情
说明 : 调用此接口传入电台节目id,可获得电台节目详情

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

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

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566

### 通知 - 私信

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

**可选参数 :**

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

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

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

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

B
v3.12.0  
binaryify 已提交
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
### 发送私信

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

**必选参数 :**

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

`msg` : 要发送的信息

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

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

B
v3.12.0  
binaryify 已提交
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590

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

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

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

2591
`before` : 分页参数,取上一页最后一项的 `time` 获取下一页数据
B
v3.12.0  
binaryify 已提交
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612

**接口地址 :** 
`/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 已提交
2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653

### 通知 - 评论

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

**必选参数 :** `uid`: 用户 的 id,只能和登录账号的 id 一致

**可选参数 :**

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

`before` : 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据


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

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

### 通知 - @我

说明 : 登陆后调用此接口 ,可获取@我数据

**可选参数 :**

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

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

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

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


### 通知 - 通知

说明 : 登陆后调用此接口 ,可获取通知

**可选参数 :**

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

B
binaryify 已提交
2654
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667


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

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

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

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

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

2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720
### 数字专辑-新碟上架
说明 : 调用此接口 ,可获取数字专辑-新碟上架  

**可选参数 :**

`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 已提交
2721 2722 2723 2724 2725 2726 2727
### 我的数字专辑
说明 : 登陆后调用此接口 ,可获取我的数字专辑

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

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

T
TimonPeng 已提交
2728
### 购买数字专辑
2729
说明 : 登陆后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742

**必选参数 :**

`id` : 专辑的 id

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

`quantity` : 购买的数量

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

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

B
v3.13.0  
binaryify 已提交
2743 2744 2745 2746 2747 2748 2749 2750 2751
### batch批量请求接口
说明 : 登陆后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口

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

**调用例子 :** 使用GET方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用POST方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`



B
binaryify 已提交
2752
## 离线访问此文档
B
binaryify 已提交
2753

B
improve  
binaryify 已提交
2754
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
2755 2756

## 关于此文档
B
improve  
binaryify 已提交
2757 2758 2759 2760

此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动
态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
2761

B
binaryify 已提交
2762
## License
B
improve  
binaryify 已提交
2763

B
binaryify 已提交
2764
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)