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

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

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

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

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

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

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

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

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

19
1. 登录
20
2. 刷新登录
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
3. 发送验证码
4. 校验验证码
5. 注册(修改密码)
6. 获取用户信息 , 歌单,收藏,mv, dj 数量
7. 获取用户歌单
8. 获取用户电台
9. 获取用户关注列表
10. 获取用户粉丝列表
11. 获取用户动态
12. 获取用户播放记录
13. 获取精品歌单
14. 获取歌单详情
15. 搜索
16. 搜索建议
17. 获取歌词
18. 歌曲评论
19. 收藏单曲到歌单
20. 专辑评论
21. 歌单评论
22. mv 评论
23. 电台节目评论
24. banner
25. 获取歌曲详情
26. 获取专辑内容
27. 获取歌手单曲
28. 获取歌手 mv
29. 获取歌手专辑
30. 获取歌手描述
31. 获取相似歌手
32. 获取相似歌单
33. 相似 mv
34. 获取相似音乐
35. 获取最近 5 个听了这首歌的用户
36. 获取每日推荐歌单
37. 获取每日推荐歌曲
38. 私人 FM
39. 签到
40. 喜欢音乐
41. 垃圾桶
42. 歌单 ( 网友精选碟 )
43. 新碟上架
44. 热门歌手
45. 最新 mv
46. 推荐 mv
47. 推荐歌单
48. 推荐新音乐
49. 推荐电台
50. 推荐节目
51. 独家放送
52. mv 排行
53. 获取 mv 数据
54. 播放 mv/视频
55. 排行榜
56. 歌手榜
57. 云盘
58. 电台 - 推荐
59. 电台 - 分类
60. 电台 - 分类推荐
61. 电台 - 订阅
62. 电台 - 详情
63. 电台 - 节目
64. 给评论点赞
65. 获取动态
84
66. 热搜列表(简略)
85 86 87 88 89 90 91 92 93 94 95
67. 发送私信
68. 发送私信歌单
69. 新建歌单
70. 收藏/取消收藏歌单
71. 歌单分类
72. 收藏的歌手列表
73. 订阅的电台列表
74. 相关歌单推荐
75. 付费精选接口
76. 音乐是否可用检查接口
77. 登录状态
96
78. 获取视频播放地址
97 98 99 100 101 102 103
79. 发送/删除评论
80. 热门评论
81. 视频评论
82. 退出登录
83. 所有榜单
84. 所有榜单内容摘要
85. 收藏视频
104
86. 收藏 MV
105 106 107 108 109 110 111 112
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
binaryify 已提交
134
116. batch 批量请求接口
135
117. 获取视频标签列表
B
binaryify 已提交
136 137
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
131. 电台 banner
B
binaryify 已提交
150 151 152
132. 用户电台
133. 热门电台
134. 电台 - 节目详情
153 154
135. 电台 - 节目榜
136. 电台 - 新晋电台榜/热门电台榜
B
binaryify 已提交
155
137. 类别热门电台
B
binaryify 已提交
156
138. 云村热评(官方下架,暂不能用)
B
binaryify 已提交
157 158
139. 电台 24 小时节目榜
140. 电台 24 小时主播榜
159 160 161
141. 电台最热主播榜
142. 电台主播新人榜
143. 电台付费精品榜
B
binaryify 已提交
162
144. 歌手热门 50 首歌曲
B
binaryify 已提交
163
145. 购买数字专辑
164 165
146. 获取 mv 点赞转发评论数数据
147. 获取视频点赞转发评论数数据
B
binaryify 已提交
166 167 168
148. 调整歌单顺序
149. 调整歌曲顺序
150. 独家放送列表
B
binaryify 已提交
169
151. 获取推荐视频
B
binaryify 已提交
170
152. 获取视频分类列表
B
binaryify 已提交
171
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
180. 云贝签到信息
181. 云贝签到
182. 云贝所有任务
B
binaryify 已提交
201
183. 云贝 todo 任务
202 203 204 205 206 207
184. 云贝今日签到信息
185. 云贝完成任务
186. 云贝收入
187. 云贝支出
188. 云贝账户信息
189. 账号信息
208 209
190. 最近联系人
191. 私信音乐
210 211 212
192. 抱一抱评论
193. 评论抱一抱列表
194. 收藏的专栏
213
195. 关注歌手新歌
B
binaryify 已提交
214
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. 云盘歌曲信息匹配纠正
225 226
207. 云贝推歌
208. 云贝推歌历史记录
227
209. 已购单曲
B
binaryify 已提交
228 229 230 231 232 233
210. 获取 mlog 播放地址
211. 将 mlog id 转为视频 id
212. vip 成长值
213. vip 成长值获取记录
214. vip 任务
215. 领取 vip 成长值
234
216. 歌手粉丝
235 236 237 238 239 240 241 242 243
217. 数字专辑详情
218. 数字专辑销量
219. 音乐人数据概况
220. 音乐人播放趋势
221. 音乐人任务
222. 账号云豆数
223. 领取云豆
224. 获取 VIP 信息
225. 音乐人签到
C
chen_10 已提交
244 245 246
226. 获取客户端歌曲下载 url
227. 获取歌单所有歌曲
228. 乐签信息
C
chen_10 已提交
247
229. 获取歌手视频
248 249 250 251 252 253 254
230. 最近播放-歌曲
231. 最近播放-视频
232. 最近播放-声音
233. 最近播放-歌单
234. 最近播放-专辑
235. 最近播放-播客

B
binaryify 已提交
255

B
improve  
binaryify 已提交
256
## 安装
B
improve  
binaryify 已提交
257 258

```shell
259
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
260

261
$ npm install
B
binaryify 已提交
262
```
B
improve  
binaryify 已提交
263

264
## 运行
B
improve  
binaryify 已提交
265 266

```shell
N
nujhong 已提交
267
$ node app.js
B
binaryify 已提交
268 269
```

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

B
binaryify 已提交
272 273 274 275
```shell
$ PORT=4000 node app.js
```

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

B
binaryify 已提交
278 279 280
```shell
$ set PORT=4000 && node app.js
```
B
binaryify 已提交
281

B
binaryify 已提交
282 283
服务器启动默认 host 为 localhost,如果需要更改, 可使用以下命令 : Mac/Linux

B
#615  
binaryify 已提交
284
```shell
B
binaryify 已提交
285
$ HOST=127.0.0.1 node app.js
B
#615  
binaryify 已提交
286
```
B
binaryify 已提交
287

B
#615  
binaryify 已提交
288 289 290
windows 下使用 git-bash 或者 cmder 等终端执行以下命令 :

```shell
B
binaryify 已提交
291
$ set HOST=127.0.0.1 && node app.js
B
#615  
binaryify 已提交
292
```
B
binaryify 已提交
293 294

## Vercel 部署
B
binaryify 已提交
295 296 297

v4.0.8 加入了 Vercel 配置文件,可以直接在 Vercel 下部署了,不需要自己的服务器(访问 Vercel 部署的接口,需要额外加一个 realIP 参数,如 `/song/url?id=191254&realIP=116.25.146.177`)

B
binaryify 已提交
298
### 操作方法
B
binaryify 已提交
299

B
binaryify 已提交
300 301 302 303 304
1. fork 此项目
2. 在 Vercel 官网点击 `New Project`
3. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击`import`
4. 点击 `PERSONAL ACCOUNT``select`
5. 直接点`Continue`
B
binaryify 已提交
305
6. `PROJECT NAME`自己填,`FRAMEWORK PRESET``Other` 然后直接点 `Deploy` 接着等部署完成即可
B
binaryify 已提交
306

307 308 309 310 311 312
## 可以使用代理

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

```javascript
// 例子
B
v3.0.0  
binaryify 已提交
313
const url = `http://localhost:3000/song/url?id=33894312&proxy=http://121.196.226.246:84`
B
binaryify 已提交
314
fetch(url).then(function () {
315 316 317 318 319 320
  // 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}
```
B
binaryify 已提交
321

B
binaryify 已提交
322 323 324 325 326 327
v3.3.0 后支持使用 PAC 代理,如 `?proxy=http://192.168.0.1/proxy.pac`

## 可以在 Node.js 调用

v3.31.0 后支持 Node.js 调用,导入的方法为`module`内的文件名,返回内容包含`status``body`,`status`为状态码,`body`为请求返回内容,参考`module_example` 文件夹下的 `test.js`

B
binaryify 已提交
328 329 330 331 332 333
```js
const { login_cellphone, user_cloud } = require('NeteaseCloudMusicApi')
async function main() {
  try {
    const result = await login_cellphone({
      phone: '手机号',
B
binaryify 已提交
334
      password: '密码',
B
binaryify 已提交
335 336 337
    })
    console.log(result)
    const result2 = await user_cloud({
B
binaryify 已提交
338
      cookie: result.body.cookie, // 凭证
B
binaryify 已提交
339 340 341 342 343 344 345 346 347
    })
    console.log(result2.body)
  } catch (error) {
    console.log(error)
  }
}
main()
```

B
binaryify 已提交
348
## 支持 TypeScript
B
binaryify 已提交
349

B
binaryify 已提交
350 351 352
```ts
// test.ts
import { banner } from 'NeteaseCloudMusicApi'
B
binaryify 已提交
353
banner({ type: 0 }).then((res) => {
B
binaryify 已提交
354 355 356 357
  console.log(res)
})
```

B
binaryify 已提交
358
## 更新到 v3.0 说明
B
binaryify 已提交
359

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

B
improve  
binaryify 已提交
362 363
## Docker 容器运行

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

request 相关的环境变量

368 369 370 371 372 373 374
1. http_proxy
2. https_proxy
3. HTTP_PROXY
4. HTTPS_PROXY
5. no_proxy
6. NO_PROXY

375
```shell
B
binaryify 已提交
376
docker pull binaryify/netease_cloud_music_api
377

B
binaryify 已提交
378 379 380
docker run -d -p 3000:3000 --name netease_cloud_music_api    binaryify/netease_cloud_music_api


B
binaryify 已提交
381
// 或者
B
binaryify 已提交
382
docker run -d -p 3000:3000 binaryify/netease_cloud_music_api
383 384

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

B
binaryify 已提交
386 387 388 389
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
390
```
B
binaryify 已提交
391

B
binaryify 已提交
392
> 以下是自行 build docker 镜像方式
393 394 395

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

397
$ sudo docker build . -t netease-music-api
398

399 400
$ sudo docker run -d -p 3000:3000 netease-music-api
```
B
binaryify 已提交
401

402
## 接口文档
B
improve  
binaryify 已提交
403

B
binaryify 已提交
404
### 调用前须知
B
binaryify 已提交
405

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

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

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

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

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

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

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

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

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

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

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

B
binaryify 已提交
433
### 登录
B
improve  
binaryify 已提交
434

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

B
improve  
binaryify 已提交
437
#### 1. 手机登录
438

B
binaryify 已提交
439
**必选参数 :**  
440 441 442
`phone`: 手机号码

`password`: 密码
443

B
binaryify 已提交
444
**可选参数 :**  
B
binaryify 已提交
445
`countrycode`: 国家码,用于国外手机号登录,例如美国传入:`1`
446

B
binaryify 已提交
447
`md5_password`: md5 加密后的密码,传入后 `password` 参数将失效
448 449

`captcha`: 验证码,使用 [`/captcha/sent`](#发送验证码)接口传入手机号获取验证码,调用此接口传入验证码,可使用验证码登录,传入后 `password` 参数将失效
450 451 452

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

453
**调用例子 :** `/login/cellphone?phone=xxx&password=yyy` `/login/cellphone?phone=xxx&md5_password=yyy` `/login/cellphone?phone=xxx&captcha=1234`
454

B
improve  
binaryify 已提交
455
#### 2. 邮箱登录
B
binaryify 已提交
456

B
binaryify 已提交
457
**必选参数 :**
B
binaryify 已提交
458

B
binaryify 已提交
459
`email`: 163 网易邮箱
460

461
`password`: 密码
462

B
binaryify 已提交
463
**可选参数 :**
464

B
binaryify 已提交
465
`md5_password`: md5 加密后的密码,传入后 `password` 将失效
466

B
improve  
binaryify 已提交
467
**接口地址 :** `/login`
468

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

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

B
binaryify 已提交
474 475
v3.30.0 后支持手动传入 cookie,登录接口返回内容新增 `cookie` 字段,保存到本地后,get 请求带上`?cookie=xxx` (先使用 `encodeURIComponent()` 编码 cookie 值) 或者 post 请求 body 带上 `cookie` 即可,如:`/user/cloud?cookie=xxx` 或者

476 477 478 479 480 481
```
{
    ...,
    cookie:"xxx"
}
```
B
binaryify 已提交
482

B
binaryify 已提交
483
#### 3. 二维码登录
484

B
binaryify 已提交
485 486 487 488 489
说明: 二维码登录涉及到 3 个接口,调用务必带上时间戳,防止缓存

##### 1. 二维码 key 生成接口

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

B
binaryify 已提交
491
**接口地址 :** `/login/qr/key`
B
binaryify 已提交
492

493 494
##### 2. 二维码生成接口

B
binaryify 已提交
495 496 497
说明: 调用此接口传入上一个接口生成的 key 可生成二维码图片的 base64 和二维码信息,可使用 base64 展示图片,或者使用二维码信息内容自行使用第三方二维码生成库渲染二维码

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

B
binaryify 已提交
499
可选参数: `qrimg` 传入后会额外返回二维码图片 base64 编码
500

B
binaryify 已提交
501
**接口地址 :** `/login/qr/create`
502

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

B
binaryify 已提交
505
##### 3. 二维码检测扫码状态接口
B
binaryify 已提交
506

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

B
binaryify 已提交
509
必选参数: `key`,由第一个接口生成
B
binaryify 已提交
510 511 512

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

B
binaryify 已提交
513
**调用例子 :** `/login/qr/check?key=xxx`
514 515

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

B
binaryify 已提交
517
#### 注意
B
improve  
binaryify 已提交
518 519

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

521
### 刷新登录
N
nujhong 已提交
522

B
improve  
binaryify 已提交
523 524 525
说明 : 调用此接口 , 可刷新登录状态

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

527 528 529 530
### 发送验证码

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

B
binaryify 已提交
531
**必选参数 :** `phone`: 手机号码
532 533

**可选参数 :**
B
binaryify 已提交
534
`ctcode`: 国家区号,默认 86 即中国
535

536
**接口地址 :** `/captcha/sent`
537

538
**调用例子 :** `/captcha/sent?phone=13xxx`
539 540 541 542 543

### 验证验证码

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

B
binaryify 已提交
544
**必选参数 :** `phone`: 手机号码
545 546 547 548 549

`captcha`: 验证码

**可选参数 :**

B
binaryify 已提交
550
`ctcode`: 国家区号,默认 86 即中国
551

552
**接口地址 :** `/captcha/verify`
553

554
**调用例子 :** `/captcha/verify?phone=13xxx&captcha=1597`
555 556 557 558 559

### 注册(修改密码)

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

B
binaryify 已提交
560
**必选参数 :**
561 562 563

`captcha`: 验证码

B
binaryify 已提交
564
`phone` : 手机号码
565 566 567 568 569

`password`: 密码

`nickname`: 昵称

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

B
binaryify 已提交
572
`countrycode`: 国家码,用于国外手机号,例如美国传入:`1` ,默认 86 即中国
B
binaryify 已提交
573

574 575 576 577
**接口地址 :** `/register/cellphone`

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

578
### 检测手机号码是否已注册
B
binaryify 已提交
579

B
binaryify 已提交
580
说明 : 调用此接口 ,可检测手机号码是否已注册  
B
binaryify 已提交
581
**必选参数 :**  
B
binaryify 已提交
582
`phone` : 手机号码
B
binaryify 已提交
583 584

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

587 588 589 590 591
**接口地址 :** `/cellphone/existence/check`

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

### 初始化昵称
B
binaryify 已提交
592

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

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

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

601
### 更换绑定手机
B
binaryify 已提交
602

603 604
说明 : 调用此接口 ,可更换绑定手机(流程:先发送验证码到原手机号码,再发送验证码到新手机号码然后再调用此接口)

B
binaryify 已提交
605
**必选参数 :**
606 607 608 609
`oldcaptcha`: 原手机验证码

`captcha`: 新手机验证码

B
binaryify 已提交
610
`phone` : 手机号码
611

B
binaryify 已提交
612
`ctcode` : 国家区号,默认 86 即中国
613 614

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

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

B
v2.20.3  
binaryify 已提交
618 619 620 621 622 623
### 退出登录

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

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

624
### 登录状态
B
binaryify 已提交
625

626 627 628
说明 : 调用此接口,可获取登录状态

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

B
binaryify 已提交
630 631
### 获取用户详情

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

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

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

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

640 641 642 643 644 645 646 647
### 获取账号信息

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

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

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

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

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

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

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

656 657
### 获取用户等级信息

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

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

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

664 665 666 667
### 获取用户绑定信息

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

B
binaryify 已提交
668
**必选参数 :** `uid` : 用户 id
669 670 671 672 673 674 675 676 677

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

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

### 用户绑定手机

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

B
binaryify 已提交
678
**必选参数 :**
679

B
binaryify 已提交
680
`phone` : 手机号码
681 682 683 684 685

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

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

B
binaryify 已提交
686
**可选参数 :**
687

B
binaryify 已提交
688
`countrycode`: 国家地区代码,默认 86
689 690 691

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

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

694 695
### 更新用户信息

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

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

700 701
```
gender: 性别 0:保密 1:男性 2:女性
702

703
birthday: 出生日期,时间戳 unix timestamp
704

705
nickname: 用户昵称
706

707
province: 省份id
708

709
city: 城市id
710

711 712 713
signature:用户签名
```

B
binaryify 已提交
714
**接口地址 :** `/user/update`
715

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

718
### 更新头像
B
binaryify 已提交
719

B
binaryify 已提交
720
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新头像(参考: https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/avatar_update.html  ),支持命令行调用,参考module_example目录下`avatar_upload.js`
721 722 723

**可选参数 :**

B
binaryify 已提交
724
`imgSize` : 图片尺寸,默认为 300
725

B
binaryify 已提交
726 727
`imgX` : 水平裁剪偏移,方形图片可不传,默认为 0
`imgY` : 垂直裁剪偏移,方形图片可不传,默认为 0
728 729 730 731 732

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

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

733
### 国家编码列表
B
binaryify 已提交
734

735 736 737 738
说明 : 调用此接口,可获取国家编码列表

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

B
binaryify 已提交
739
### 获取用户歌单
740

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

B
binaryify 已提交
743
**必选参数 :** `uid` : 用户 id
B
binaryify 已提交
744 745 746

**可选参数 :**

B
binaryify 已提交
747
`limit` : 返回数量 , 默认为 30
B
binaryify 已提交
748 749

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

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

B
improve  
binaryify 已提交
753 754 755
**调用例子 :** `/user/playlist?uid=32953014`

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

758 759
### 更新歌单

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

B
binaryify 已提交
762
**必选参数 :**
B
binaryify 已提交
763

764 765
```
id:歌单id
766

B
binaryify 已提交
767
name:歌单名字
768

769
desc:歌单描述
770

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

774 775
**接口地址 :** `/playlist/update`

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

### 更新歌单描述
B
binaryify 已提交
779

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

B
binaryify 已提交
782 783
**必选参数 :**

B
binaryify 已提交
784 785 786 787 788 789 790
```
id:歌单id

desc:歌单描述

```

B
binaryify 已提交
791 792 793
**接口地址 :** `/playlist/desc/update`

**调用例子 :** `/playlist/desc/update?id=24381616&desc=描述`
B
binaryify 已提交
794 795

### 更新歌单名
B
binaryify 已提交
796

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

B
binaryify 已提交
799
**必选参数 :**
B
binaryify 已提交
800 801 802 803 804 805 806 807

```
id: 歌单id

name: 歌单名

```

B
binaryify 已提交
808 809 810
**接口地址 :** `/playlist/name/update`

**调用例子 :** `/playlist/name/update?id=24381616&name=歌单名`
B
binaryify 已提交
811 812

### 更新歌单标签
B
binaryify 已提交
813

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

B
binaryify 已提交
816
**必选参数 :**
B
binaryify 已提交
817 818 819 820 821 822 823 824

```
id: 歌单id

tags: 歌单标签

```

B
binaryify 已提交
825
**接口地址 :** `/playlist/tags/update`
826

B
binaryify 已提交
827
**调用例子 :** `/playlist/tags/update?id=24381616&tags=学习`
828 829

### 歌单封面上传
B
binaryify 已提交
830 831

说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新歌单封面(参考:https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/playlist_cover_update.html)
832 833

**必选参数 :**  
B
binaryify 已提交
834
`id`: 歌单 id 3143833470
835 836 837

**可选参数 :**

B
binaryify 已提交
838
`imgSize` : 图片尺寸,默认为 300
839

B
binaryify 已提交
840 841
`imgX` : 水平裁剪偏移,方形图片可不传,默认为 0
`imgY` : 垂直裁剪偏移,方形图片可不传,默认为 0
842 843 844 845 846

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

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

B
v3.32.0  
binaryify 已提交
847
### 调整歌单顺序
B
binaryify 已提交
848

B
binaryify 已提交
849
说明 : 登录后调用此接口,可以根据歌单 id 顺序调整歌单顺序
B
binaryify 已提交
850

B
binaryify 已提交
851
**必选参数 :**
B
v3.32.0  
binaryify 已提交
852

B
binaryify 已提交
853
`ids`: 歌单 id 列表
B
v3.32.0  
binaryify 已提交
854

B
binaryify 已提交
855
**接口地址 :** `/playlist/order/update`
B
v3.32.0  
binaryify 已提交
856

B
binaryify 已提交
857
**调用例子 :** `/playlist/order/update?ids=[111,222]`
B
v3.32.0  
binaryify 已提交
858

B
binaryify 已提交
859 860
### 调整歌曲顺序

B
binaryify 已提交
861
说明 : 登录后调用此接口,可以根据歌曲 id 顺序调整歌曲顺序
B
binaryify 已提交
862

B
binaryify 已提交
863 864
**必选参数 :**  
`pid`: 歌单 id
B
binaryify 已提交
865

B
binaryify 已提交
866
`ids`: 歌曲 id 列表
B
binaryify 已提交
867

B
binaryify 已提交
868
**接口地址 :** `/song/order/update`
B
binaryify 已提交
869

B
binaryify 已提交
870
**调用例子 :** `/song/order/update?pid=2039116066&ids=[5268328,1219871]`
B
binaryify 已提交
871

B
binaryify 已提交
872 873 874 875
### 获取用户历史评论

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

B
binaryify 已提交
876
**必选参数 :** `uid` : 用户 id
B
binaryify 已提交
877

B
binaryify 已提交
878
**可选参数 :**
879

B
binaryify 已提交
880 881
`limit` : 返回数量 , 默认为 10

B
binaryify 已提交
882
`time`: 上一条数据的 time,第一页不需要传,默认为 0
B
binaryify 已提交
883 884 885

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

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

888 889
### 获取用户电台

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

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

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

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

B
improve  
binaryify 已提交
898
### 获取用户关注列表
899

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

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

B
binaryify 已提交
904
**可选参数 :**
905

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

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

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

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

B
improve  
binaryify 已提交
914
### 获取用户粉丝列表
915

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

B
binaryify 已提交
918
**必选参数 :** `uid` : 用户 id
919

B
binaryify 已提交
920 921
**可选参数 :**
`limit` : 返回数量 , 默认为 30
922

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

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

B
binaryify 已提交
927
**调用例子 :** `/user/followeds?uid=32953014` `/user/followeds?uid=416608258&limit=1` `/user/followeds?uid=416608258&limit=1&offset=1`
928 929 930

### 获取用户动态

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

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

B
binaryify 已提交
935
**可选参数 :** `limit` : 返回数量 , 默认为 30
936 937 938

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

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

B
binaryify 已提交
941
**调用例子 :** `/user/event?uid=32953014` `/user/event?uid=32953014&limit=1&lasttime=1558011138743`
942

B
binaryify 已提交
943
返回结果的`type`参数对应:
B
binaryify 已提交
944

B
binaryify 已提交
945 946 947 948 949 950 951 952 953 954 955
```
18 分享单曲
19 分享专辑
17、28 分享电台节目
22 转发
39 发布视频
35、13 分享歌单
24 分享专栏文章
41、21 分享视频
```

B
binaryify 已提交
956
### 转发用户动态
B
binaryify 已提交
957

B
binaryify 已提交
958
说明 : 登录后调用此接口 ,可以转发用户动态
B
binaryify 已提交
959

B
binaryify 已提交
960
**必选参数 :** `uid` : 用户 id
B
binaryify 已提交
961

B
binaryify 已提交
962
`evId` : 动态 id
B
binaryify 已提交
963 964 965 966 967 968 969

`forwards` : 转发的评论

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

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

B
binaryify 已提交
970
### 删除用户动态
B
binaryify 已提交
971

B
binaryify 已提交
972
说明 : 登录后调用此接口 ,可以删除用户动态
B
binaryify 已提交
973

B
binaryify 已提交
974
**必选参数 :** `evId` : 动态 id
B
binaryify 已提交
975 976 977 978 979

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

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

980
### 分享文本、歌曲、歌单、mv、电台、电台节目到动态
B
binaryify 已提交
981

982
说明 : 登录后调用此接口 ,可以分享文本、歌曲、歌单、mv、电台、电台节目到动态
983

B
binaryify 已提交
984
**必选参数 :** `id` : 资源 id (歌曲,歌单,mv,电台,电台节目对应 id)
985 986 987 988 989 990 991

**可选参数 :** `type`: 资源类型,默认歌曲 song,可传 `song`,`playlist`,`mv`,`djradio`,`djprogram`

`msg`: 内容,140 字限制,支持 emoji,@用户名(`/user/follows`接口获取的用户名,用户名后和内容应该有空格),图片暂不支持

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

C
chen_10 已提交
992
**调用例子 :** `/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 测试` `/share/resource?type=noresource&msg=测试`
993

994 995
### 获取动态评论

B
binaryify 已提交
996
说明 : 登录后调用此接口 , 可以获取动态下评论
997 998 999

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

1000
**接口地址 :** `/comment/event`
1001

1002
**调用例子 :** `/comment/event?threadId=A_EV_2_6559519868_32953014`
1003

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

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

**必选参数 :**

B
binaryify 已提交
1010
`id` : 用户 id
B
v3.0.0  
binaryify 已提交
1011

B
binaryify 已提交
1012
`t` : `1`为关注,其他为取消关注
B
v3.0.0  
binaryify 已提交
1013 1014 1015 1016 1017

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

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

1018 1019
### 获取用户播放记录

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

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

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

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

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

1030 1031 1032 1033 1034 1035 1036 1037
### 获取热门话题

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

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

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

B
binaryify 已提交
1038
**接口地址 :** `/hot/topic`
1039

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

1042 1043 1044 1045 1046 1047 1048
### 获取话题详情

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

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

**调用例子 :** `/topic/detail?actid=111551188`
B
binaryify 已提交
1049

1050 1051 1052 1053 1054 1055 1056 1057
### 获取话题详情热门动态

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

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

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

B
binaryify 已提交
1058
### 云村热评(官方下架,暂不能用)
B
binaryify 已提交
1059

1060 1061 1062 1063 1064 1065
说明 : 登录后调用此接口 , 可获取云村热评

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

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

1066
### 心动模式/智能播放
B
binaryify 已提交
1067

1068
说明 : 登录后调用此接口 , 可获取心动模式/智能播放列表
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
**必选参数 :** `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 已提交
1080 1081
### 获取动态消息

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

B
binaryify 已提交
1085 1086
**必选参数 :**
`pagesize` : 每页数据,默认 20
1087 1088

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

B
improve  
binaryify 已提交
1090 1091
**接口地址 :** `/event`

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

1094
### 歌手分类列表
B
binaryify 已提交
1095

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

1098
**可选参数 :**
1099

1100 1101 1102 1103
`limit` : 返回数量 , 默认为 30

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

1106
`type` 取值:
B
binaryify 已提交
1107

1108
```
B
binaryify 已提交
1109
-1:全部
1110 1111 1112 1113
1:男歌手
2:女歌手
3:乐队
```
1114

1115
`area` 取值:
B
binaryify 已提交
1116

1117 1118 1119 1120 1121 1122 1123
```
-1:全部
7华语
96欧美
8:日本
16韩国
0:其他
1124 1125 1126 1127
```

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

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

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

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

B
binaryify 已提交
1134
**必选参数 :**
1135

B
binaryify 已提交
1136
`id` : 歌手 id
1137

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

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

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

B
binaryify 已提交
1144
### 歌手热门 50 首歌曲
1145

B
binaryify 已提交
1146
说明 : 调用此接口,可获取歌手热门 50 首歌曲
1147 1148 1149 1150 1151 1152 1153 1154 1155

**必选参数 :**

`id` : 歌手 id

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

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

1156
### 歌手全部歌曲
B
binaryify 已提交
1157

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
说明 : 调用此接口,可获取歌手全部歌曲
**必选参数 :**

`id` : 歌手 id

**可选参数 :**

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

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

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

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

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

1175
### 收藏的歌手列表
B
binaryify 已提交
1176

1177 1178 1179 1180 1181 1182
说明 : 调用此接口,可获取收藏的歌手列表

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

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

1183 1184
### 收藏的专栏

B
binaryify 已提交
1185
说明 : 调用此接口,可获取收藏的专栏
1186

B
binaryify 已提交
1187
**可选参数 :**
1188 1189 1190 1191 1192 1193 1194 1195 1196

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

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

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

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

B
v3.0.0  
binaryify 已提交
1197 1198 1199 1200
### 收藏视频

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

B
binaryify 已提交
1201
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1202 1203 1204 1205 1206 1207 1208 1209 1210

`id` : 视频 id

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

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

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

1211
### 收藏/取消收藏 MV
B
v3.0.0  
binaryify 已提交
1212

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

B
binaryify 已提交
1215
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1216

B
binaryify 已提交
1217
`mvid` : MV id
B
v3.0.0  
binaryify 已提交
1218 1219 1220 1221 1222 1223 1224

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

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

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

1225 1226 1227 1228 1229 1230 1231 1232
### 收藏的 MV 列表

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

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

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

B
binaryify 已提交
1233
### 歌单分类
B
binaryify 已提交
1234

B
binaryify 已提交
1235 1236 1237 1238 1239 1240 1241
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

B
binaryify 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
说明 : 调用此接口,可获取歌单分类,包含 category 信息

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

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

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

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

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

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

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

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

B
binaryify 已提交
1263
**接口地址 :** `/top/playlist`
1264

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

1267
### 精品歌单标签列表
B
binaryify 已提交
1268

1269 1270 1271 1272 1273 1274
说明 : 调用此接口 , 可获取精品歌单标签列表

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

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

B
improve  
binaryify 已提交
1275
### 获取精品歌单
1276

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

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

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

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

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

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

B
binaryify 已提交
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
### 相关歌单推荐

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

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

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

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

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

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

1313 1314
### 获取歌单所有歌曲

B
binaryify 已提交
1315
说明 : 由于网易云接口限制,歌单详情只会提供 10 首歌,通过调用此接口,传入对应的歌单`id`,即可获得对应的所有歌曲
1316

B
binaryify 已提交
1317
**必选参数 :** `id` : 歌单 id
1318 1319 1320 1321 1322 1323 1324

**可选参数 :** `limit` : 限制获取歌曲的数量

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

**调用例子 :** `/playlist/track/all?id=24381616&limit=10`

B
binaryify 已提交
1325 1326 1327 1328 1329 1330 1331 1332 1333
### 歌单详情动态

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

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

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

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

### 获取音乐 url
1336

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

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

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

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

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

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

1349
### 音乐是否可用
B
binaryify 已提交
1350

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

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

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

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

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

1361
### 搜索
1362

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

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

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

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

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

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

B
binaryify 已提交
1379
### 默认搜索关键词
B
binaryify 已提交
1380

B
binaryify 已提交
1381 1382 1383 1384
说明 : 调用此接口 , 可获取默认搜索关键词

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

1385
### 热搜列表(简略)
B
binaryify 已提交
1386

B
binaryify 已提交
1387 1388 1389 1390 1391 1392
说明 : 调用此接口,可获取热门搜索列表

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

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

1393 1394 1395 1396 1397 1398 1399 1400
### 热搜列表(详细)

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

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

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

1401 1402
### 搜索建议

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

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

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

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

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

B
binaryify 已提交
1414 1415
### 搜索多重匹配

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

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

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

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

1424 1425 1426 1427
### 新建歌单

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

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

B
binaryify 已提交
1430
**可选参数 :**
1431

B
binaryify 已提交
1432
`privacy` : 是否设置为隐私歌单,默认否,传'10'则设置成隐私歌单
1433

C
chen_10 已提交
1434
`type` : 歌单类型,默认'NORMAL',传 'VIDEO'则为视频歌单,传 'SHARED'则为共享歌单
1435

1436
**接口地址 :** `/playlist/create`
1437

1438
**调用例子 :** `/playlist/create?name=测试歌单`,`/playlist/create?name=test&type=VIDEO`
B
binaryify 已提交
1439 1440 1441

### 删除歌单

B
binaryify 已提交
1442
说明 : 调用此接口 , 传入歌单 id 可删除歌单
B
binaryify 已提交
1443

B
binaryify 已提交
1444
**必选参数 :** `id` : 歌单 id,可多个,用逗号隔开
B
binaryify 已提交
1445 1446 1447

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

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

1450 1451 1452 1453 1454
### 收藏/取消收藏歌单

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

**必选参数 :**
1455

B
binaryify 已提交
1456
`t` : 类型,1:收藏,2:取消收藏
1457 1458 1459 1460 1461 1462
`id` : 歌单 id

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

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

1463
### 歌单收藏者
B
binaryify 已提交
1464

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者  
**必选参数 :**

`id` : 歌单 id

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

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

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

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

1478
### 对歌单添加或删除歌曲
B
binaryify 已提交
1479

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

1482
**必选参数 :**
1483

1484 1485 1486 1487
`op`: 从歌单增加单曲为 add, 删除为 del

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

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

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

1493
### 收藏视频到视频歌单
B
binaryify 已提交
1494

1495 1496 1497 1498 1499 1500
说明 : 调用此接口 , 可收藏视频到视频歌单 ( 需要登录 )

**必选参数 :**

`pid` : 歌单 id

B
binaryify 已提交
1501
`ids` : 视频 id,支持多个,用`,`隔开
1502 1503 1504 1505 1506 1507

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

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

### 删除视频歌单里的视频
B
binaryify 已提交
1508

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

`pid` : 歌单 id

B
binaryify 已提交
1514
`ids` : 视频 id,支持多个,用`,`隔开
1515 1516 1517 1518 1519 1520

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

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

### 最近播放的视频
B
binaryify 已提交
1521

1522 1523 1524 1525 1526 1527
说明 : 调用此接口 , 可获取最近播放的视频 ( 需要登录 )

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

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

B
binaryify 已提交
1528
### 获取歌词
1529

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

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

B
improve  
binaryify 已提交
1534
**接口地址 :** `/lyric`
1535

B
improve  
binaryify 已提交
1536 1537 1538
**调用例子 :** `/lyric?id=33894312`

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

B
binaryify 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
### 新歌速递

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

**必选参数 :**

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

```
全部:0
1551

B
binaryify 已提交
1552
华语:7
1553

B
binaryify 已提交
1554
欧美:96
1555

B
binaryify 已提交
1556
日本:8
1557

B
binaryify 已提交
1558 1559 1560 1561 1562 1563 1564
韩国:16
```

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

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

1565 1566
### 首页-发现

B
binaryify 已提交
1567
说明 : 调用此接口 , 可获取 APP 首页信息
B
binaryify 已提交
1568

B
binaryify 已提交
1569
**接口地址 :** `/homepage/block/page`
1570

B
binaryify 已提交
1571
**可选参数 :** `refresh`: 是否刷新数据,默认为 false
B
binaryify 已提交
1572

B
binaryify 已提交
1573
`cursor`: 上一条数据返回的 cursor
1574 1575 1576

### 首页-发现-圆形图标入口列表

B
binaryify 已提交
1577
说明 : 调用此接口 , 可获取 APP 首页圆形图标入口列表
1578

B
binaryify 已提交
1579
**接口地址 :** `/homepage/dragon/ball`
1580

1581
### 歌曲评论
1582

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

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

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

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

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

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

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

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

B
binaryify 已提交
1600
### 楼层评论
1601

B
binaryify 已提交
1602
说明 : 调用此接口 , 传入资源 parentCommentId 和资源类型 type 和资源 id 参数, 可获得该资源的歌曲楼层评论
1603

B
binaryify 已提交
1604
**必选参数 :**  
1605 1606 1607 1608
`parentCommentId`: 楼层评论 id

`id` : 资源 id

B
binaryify 已提交
1609
`type`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624

```
0: 歌曲

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频
```

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

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

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

B
binaryify 已提交
1631
**调用例子 :** `/comment/floor?parentCommentId=1438569889&id=29764564&type=0`
1632

1633 1634
### 专辑评论

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

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

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

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

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

B
improve  
binaryify 已提交
1646 1647 1648
**接口地址 :** `/comment/album`

**调用例子 :** `/comment/album?id=32311`
1649 1650 1651

### 歌单评论

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

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

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

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

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

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

B
improve  
binaryify 已提交
1665
**调用例子 :** `/comment/playlist?id=705123491`
1666 1667 1668

### mv 评论

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

B
improve  
binaryify 已提交
1672
**必选参数 :** `id`: mv id
1673

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

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

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

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

**调用例子 :** `/comment/mv?id=5436712`
1683 1684 1685

### 电台节目评论

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

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

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

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

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

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

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

1701 1702 1703 1704 1705 1706 1707 1708 1709
### 视频评论

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

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

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

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

B
binaryify 已提交
1712
`before`: 分页参数,取上一页最后一项的 `time` 获取下一页数据(获取超过 5000 条评论的时候需要用到)
1713 1714 1715 1716 1717 1718

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

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

### 热门评论
B
v2.20.3  
binaryify 已提交
1719 1720

说明 : 调用此接口 , 传入 type, 资源 id 可获得对应资源热门评论 ( 不需要登录 )
1721 1722 1723 1724 1725

**必选参数 :**

`id` : 资源 id

B
binaryify 已提交
1726
`type`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型
1727 1728 1729

```
0: 歌曲
1730

1731
1: mv
1732

1733
2: 歌单
1734

1735
3: 专辑
1736

1737
4: 电台
1738

1739 1740
5: 视频
```
B
v2.20.3  
binaryify 已提交
1741

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

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

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

1748 1749 1750 1751
**接口地址 :** `/comment/hot`

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

1752 1753
### 新版评论接口

B
binaryify 已提交
1754 1755 1756 1757
说明 : 调用此接口 , 传入资源类型和资源 id,以及排序方式,可获取对应资源的评论

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

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

1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
```
0: 歌曲

1: mv

2: 歌单

3: 专辑

4: 电台

5: 视频

6: 动态
```

B
binaryify 已提交
1777 1778 1779 1780
**可选参数 :**  
`pageNo`:分页参数,第 N 页,默认为 1

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

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

B
binaryify 已提交
1784
`cursor`: 当`sortType`为 3 时且页数不是第一页时需传入,值为上一条数据的 time
1785

B
binaryify 已提交
1786 1787
**接口地址 :** `/comment/new`

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

B
binaryify 已提交
1790 1791
### 给评论点赞

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

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

B
improve  
binaryify 已提交
1797
`cid` : 评论 id
B
binaryify 已提交
1798

1799
`t` : 是否点赞 , 1 为点赞 ,0 为取消点赞
B
binaryify 已提交
1800

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

B
binaryify 已提交
1803 1804
```
0: 歌曲
1805

B
binaryify 已提交
1806
1: mv
1807

B
binaryify 已提交
1808
2: 歌单
1809

N
nujhong 已提交
1810
3: 专辑
1811

B
binaryify 已提交
1812
4: 电台
1813

1814
5: 视频
1815 1816

6: 动态
B
improve  
binaryify 已提交
1817
```
N
nujhong 已提交
1818

B
binaryify 已提交
1819
**接口地址 :** `/comment/like`
B
binaryify 已提交
1820

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

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

1825 1826 1827 1828
### 抱一抱评论

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

B
binaryify 已提交
1829
**必选参数 :**
1830

B
binaryify 已提交
1831
`uid`: 用户 id
1832

B
binaryify 已提交
1833
`cid`: 评论 id
1834

B
binaryify 已提交
1835
`sid`: 资源 id
1836 1837 1838

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

B
binaryify 已提交
1839
**调用例子 :** `/hug/comment?uid=285516405&cid=1167145843&sid=863481066`
1840 1841 1842 1843 1844

### 评论抱一抱列表

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

B
binaryify 已提交
1845
**必选参数 :**
1846

B
binaryify 已提交
1847
`uid`: 用户 id
1848

B
binaryify 已提交
1849
`cid`: 评论 id
1850

B
binaryify 已提交
1851
`sid`: 资源 id
1852

B
binaryify 已提交
1853
**可选参数 :**
1854

B
binaryify 已提交
1855
`page`: 页数
1856

B
binaryify 已提交
1857
`cursor`: 上一页返回的 cursor,默认-1,第一页不需要传
1858

B
binaryify 已提交
1859
`idCursor`: 上一页返回的 idCursor,默认-1,第一页不需要传
1860

B
binaryify 已提交
1861
`pageSize` : 每页页数,默认 100
1862 1863 1864

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

B
binaryify 已提交
1865
**调用例子 :** `/comment/hug/list?uid=285516405&cid=1167145843&sid=863481066&pageSize=2&page=1`
1866

B
binaryify 已提交
1867 1868 1869 1870 1871 1872 1873 1874
### 发送/删除评论

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

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

1. 发送评论

B
binaryify 已提交
1875
   **必选参数**
1876

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

B
binaryify 已提交
1879
   `type`: 数字,资源类型,对应歌曲,mv,专辑,歌单,电台,视频对应以下类型
B
binaryify 已提交
1880 1881 1882

   ```
   0: 歌曲
1883

B
binaryify 已提交
1884
   1: mv
1885

B
binaryify 已提交
1886
   2: 歌单
1887

B
binaryify 已提交
1888
   3: 专辑
1889

B
binaryify 已提交
1890
   4: 电台
1891

1892
   5: 视频
1893 1894

   6: 动态
B
binaryify 已提交
1895 1896 1897 1898 1899 1900
   ```

   `id`:对应资源 id

   `content` :要发送的内容

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

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

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

B
binaryify 已提交
1907
2. 删除评论
B
binaryify 已提交
1908 1909

   **必选参数**
1910

B
v3.0.0  
binaryify 已提交
1911
   `t`:0 删除
B
binaryify 已提交
1912

B
binaryify 已提交
1913 1914
   `type`: 数字,资源类型,对应歌曲,mv,专辑,歌单,电台,视频对应以下类型  
   
B
binaryify 已提交
1915 1916 1917

   ```
   0: 歌曲
1918

B
binaryify 已提交
1919
   1: mv
1920

B
binaryify 已提交
1921
   2: 歌单
1922

B
binaryify 已提交
1923
   3: 专辑
1924

B
binaryify 已提交
1925
   4: 电台
1926 1927


1928
   5: 视频
1929 1930

   6: 动态
B
binaryify 已提交
1931

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

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

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

1941 1942
### banner

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

1945 1946
**可选参数 :**

B
binaryify 已提交
1947
`type`:资源类型,对应以下类型,默认为 0 即 PC  
1948 1949 1950 1951 1952 1953 1954 1955 1956

```
0: pc

1: android

2: iphone

3: ipad
B
binaryify 已提交
1957
```  
1958

B
improve  
binaryify 已提交
1959 1960
**接口地址 :** `/banner`

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

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

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

B
binaryify 已提交
1967
**必选参数 :**
B
v3.0.0  
binaryify 已提交
1968 1969

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

B
binaryify 已提交
1971

B
v3.0.0  
binaryify 已提交
1972 1973
```
1: mv
1974

B
v3.0.0  
binaryify 已提交
1975
4: 电台
1976

B
v3.0.0  
binaryify 已提交
1977
5: 视频
1978 1979

6: 动态
B
v3.0.0  
binaryify 已提交
1980 1981
```

B
binaryify 已提交
1982

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

B
binaryify 已提交
1985 1986
`id`: 资源 id  

B
v3.0.0  
binaryify 已提交
1987 1988 1989 1990 1991

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

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

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

B
binaryify 已提交
1995

1996 1997
### 获取点赞过的视频

B
binaryify 已提交
1998
说明 : 调用此接口, 可获取获取点赞过的视频
1999 2000 2001

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

B
binaryify 已提交
2002
**调用例子 :** `/playlist/mylike`
2003

B
binaryify 已提交
2004 2005
### 获取歌曲详情

2006
说明 : 调用此接口 , 传入音乐 id(支持多个 id, 用 `,` 隔开), 可获得歌曲详情
B
binaryify 已提交
2007

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

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

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

B
binaryify 已提交
2014
### 获取专辑内容
2015

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

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

B
improve  
binaryify 已提交
2020
**接口地址 :** `/album`
2021

B
improve  
binaryify 已提交
2022 2023
**调用例子 :** `/album?id=32311`

B
binaryify 已提交
2024
### 专辑动态信息
B
binaryify 已提交
2025

2026 2027 2028 2029 2030 2031 2032 2033
说明 : 调用此接口 , 传入专辑 id, 可获得专辑动态信息,如是否收藏,收藏数,评论数,分享数

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

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

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

2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
### 收藏/取消收藏专辑

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

**必选参数 :**

`id` : 专辑 id

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

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

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

2048
### 获取已收藏专辑列表
B
binaryify 已提交
2049

2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
说明 : 调用此接口 , 可获得已收藏专辑列表

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

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

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

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

2062
### 获取歌手单曲
2063

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

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

B
improve  
binaryify 已提交
2068
**接口地址 :** `/artists`
2069

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

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

2075
### 获取歌手 mv
B
improve  
binaryify 已提交
2076 2077 2078

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

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

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

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

2087
### 获取歌手专辑
2088

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

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

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

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

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

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

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

2105 2106
### 获取歌手描述

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

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

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

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

B
binaryify 已提交
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
### 获取歌手详情

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

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

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

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

2125 2126
### 获取相似歌手

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

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

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

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

### 获取相似歌单

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

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

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

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

### 相似 mv

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

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

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

B
improve  
binaryify 已提交
2153
**调用例子 :** `/simi/mv?mvid=5436712`
2154 2155 2156

### 获取相似音乐

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

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

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

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

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

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

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

B
improve  
binaryify 已提交
2171 2172 2173
**接口地址 :** `/simi/user`

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

B
binaryify 已提交
2175
### 获取每日推荐歌单
2176

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

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

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

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

B
binaryify 已提交
2186
### 获取每日推荐歌曲
2187

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

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

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

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

2197 2198
### 获取历史日推可用日期列表

B
binaryify 已提交
2199
说明 : 调用此接口 , 可获得历史日推可用日期列表
2200 2201 2202 2203 2204 2205 2206

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

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

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

B
binaryify 已提交
2207
说明 : 调用此接口 ,传入当日日期, 可获得当日历史日推数据
2208 2209 2210 2211 2212 2213 2214

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

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

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

2215 2216
### 私人 FM

B
improve  
binaryify 已提交
2217 2218 2219
说明 : 私人 FM( 需要登录 )

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

B
improve  
binaryify 已提交
2221
**调用例子 :** `/personal_fm`
2222

B
improve  
binaryify 已提交
2223
返回数据如下图 :
2224 2225 2226 2227 2228

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

### 签到

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

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

B
improve  
binaryify 已提交
2234
**接口地址 :** `/daily_signin`
2235

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

返回数据如下图 :
2239

B
binaryify 已提交
2240
![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
2241 2242 2243

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

B
binaryify 已提交
2244 2245 2246 2247 2248 2249
### 乐签信息

说明 : 调用此接口, 可获取乐签信息

**接口地址 :** `/sign/happy/info`

2250
### 喜欢音乐
B
binaryify 已提交
2251

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

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

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

B
improve  
binaryify 已提交
2258
**接口地址 :** `/like`
2259

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

B
improve  
binaryify 已提交
2262
返回数据如下图 :
2263 2264 2265

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

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

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

2270 2271
### 喜欢音乐列表

B
binaryify 已提交
2272
说明 : 调用此接口 , 传入用户 id, 可获取已喜欢音乐 id 列表(id 数组)
2273 2274 2275 2276 2277 2278 2279

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

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

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

2280 2281
### 垃圾桶

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

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

B
improve  
binaryify 已提交
2286
**接口地址 :** `/fm_trash`
2287

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

B
improve  
binaryify 已提交
2290
返回数据如下图 :
2291 2292 2293

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

2294
### 新碟上架
N
nujhong 已提交
2295

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

B
binaryify 已提交
2299
**可选参数 :**
2300

B
binaryify 已提交
2301
`limit`: 取出数量 , 默认为 50
2302

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

2306 2307 2308 2309 2310 2311 2312 2313
`area`: ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

`year` : 年,默认本年

`month` : 月,默认本月

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

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

2318
### 全部新碟
B
binaryify 已提交
2319 2320

说明 : 登录后调用此接口 ,可获取全部新碟
2321 2322 2323 2324 2325

**可选参数 :**

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

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

2328 2329 2330 2331 2332
`area` : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本

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

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

T
trazyn 已提交
2334 2335 2336 2337 2338 2339
### 最新专辑

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

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

B
binaryify 已提交
2340
**调用例子 :** `/album/newest`
T
trazyn 已提交
2341 2342 2343 2344 2345 2346 2347

### 听歌打卡

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

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

2348
**可选参数 :** `time`: 歌曲播放时间,单位为秒
T
trazyn 已提交
2349 2350 2351

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

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

2354
### 热门歌手
N
nujhong 已提交
2355

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

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

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

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

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

B
improve  
binaryify 已提交
2367
返回数据如下图 :
2368 2369 2370

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

2371
### 全部 mv
B
binaryify 已提交
2372

2373 2374
说明 : 调用此接口 , 可获取全部 mv

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

B
binaryify 已提交
2379
`order`: 排序,可选值为上升最快,最热,最新,不填则为上升最快
2380

B
binaryify 已提交
2381
`limit`: 取出数量 , 默认为 30
2382 2383

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

2386 2387 2388 2389 2390
**接口地址 :** `/mv/all`

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

### 最新 mv
B
binaryify 已提交
2391

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

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

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

B
improve  
binaryify 已提交
2398 2399 2400
**接口地址 :** `/mv/first`

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

B
binaryify 已提交
2402
### 网易出品 mv
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414

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

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

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

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

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

2415
### 推荐 mv
N
nujhong 已提交
2416

B
improve  
binaryify 已提交
2417 2418 2419
说明 : 调用此接口 , 可获取推荐 mv

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

B
improve  
binaryify 已提交
2421
**调用例子 :** `/personalized/mv`
2422 2423

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

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

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

B
improve  
binaryify 已提交
2429
**接口地址 :** `/personalized`
2430

2431 2432
**调用例子 :** `/personalized?limit=1`

2433
### 推荐新音乐
N
nujhong 已提交
2434

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

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

B
improve  
binaryify 已提交
2439 2440 2441
**接口地址 :** `/personalized/newsong`

**调用例子 :** `/personalized/newsong`
2442 2443

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

B
improve  
binaryify 已提交
2445 2446 2447
说明 : 调用此接口 , 可获取推荐电台

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

B
improve  
binaryify 已提交
2449
**调用例子 :** `/personalized/djprogram`
2450 2451

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

B
improve  
binaryify 已提交
2453 2454 2455
说明 : 调用此接口 , 可获取推荐电台

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

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

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

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

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

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

B
binaryify 已提交
2467 2468
### 独家放送列表

B
binaryify 已提交
2469
说明 : 调用此接口 , 可获取独家放送列表
B
binaryify 已提交
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480

**可选参数 :**

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

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

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

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

2481
### mv 排行
N
nujhong 已提交
2482

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

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

B
binaryify 已提交
2487
`area`: 地区,可选值为内地,港台,欧美,日本,韩国,不填则为全部
2488

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

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

2494
**调用例子 :** `/top/mv?limit=10`
2495 2496

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

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

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

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

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

B
improve  
binaryify 已提交
2508
返回数据如下图 :
B
binaryify 已提交
2509

2510 2511 2512
![mv 数据](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/mv.png)

### 获取 mv 点赞转发评论数数据
B
binaryify 已提交
2513

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

2517 2518 2519 2520 2521
**必选参数 :** `mvid`: mv 的 id

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

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

B
v3.0.0  
binaryify 已提交
2523
### mv 地址
2524

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

2527 2528
**必选参数 :** `id`: mv id

B
binaryify 已提交
2529
**可选参数 :** `r`: 分辨率,默认 1080,可从 `/mv/detail` 接口获取分辨率列表
B
v3.0.0  
binaryify 已提交
2530 2531 2532 2533

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

**调用例子 :**
2534

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

B
binaryify 已提交
2537 2538 2539
### 获取视频标签列表

说明 : 调用此接口 , 可获取视频标签列表
2540 2541 2542 2543 2544

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

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

B
binaryify 已提交
2545 2546 2547
### 获取视频分类列表

说明 : 调用此接口 , 可获取视频分类列表
2548

B
binaryify 已提交
2549 2550 2551 2552 2553 2554
**接口地址 :** `/video/category/list`

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

### 获取视频标签/分类下的视频

B
binaryify 已提交
2555 2556 2557
说明 : 调用此接口 , 传入标签/分类`id`,可获取到相关的视频,分页参数只能传入 offset

**必选参数 :** `id`: videoGroup 的 id
B
binaryify 已提交
2558

B
binaryify 已提交
2559
**可选参数 :** `offset`: 默认 0
2560 2561 2562 2563 2564

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

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

B
binaryify 已提交
2565
### 获取全部视频列表
B
binaryify 已提交
2566

B
binaryify 已提交
2567 2568 2569
说明 : 调用此接口,可获取视频分类列表,分页参数只能传入 offset

**可选参数 :** `offset`: 默认 0
B
binaryify 已提交
2570 2571 2572 2573 2574 2575 2576

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

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

### 获取推荐视频

B
binaryify 已提交
2577 2578 2579
说明 : 调用此接口, 可获取推荐视频,分页参数只能传入 offset

**可选参数 :** `offset`: 默认 0
B
binaryify 已提交
2580

B
binaryify 已提交
2581
**接口地址 :** `/video/timeline/recommend`
B
binaryify 已提交
2582

B
binaryify 已提交
2583
**调用例子 :** `/video/timeline/recommend?offset=10`
B
binaryify 已提交
2584

B
v3.0.0  
binaryify 已提交
2585
### 相关视频
B
binaryify 已提交
2586

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

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

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

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

B
v3.0.0  
binaryify 已提交
2595
### 视频详情
B
binaryify 已提交
2596

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

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

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

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

2605
### 获取视频点赞转发评论数数据
B
binaryify 已提交
2606 2607 2608

说明 : 调用此接口 , 传入 vid ( 视频 id ) , 可获取对应视频点赞转发评论数数据
**必选参数 :** `vid`: 视频 id
2609 2610 2611 2612 2613

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

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

2614
### 获取视频播放地址
B
binaryify 已提交
2615

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

B
v3.0.0  
binaryify 已提交
2618 2619 2620 2621 2622 2623
**必选参数 :** `id`: 视频 的 id

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

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

2624
### 所有榜单
2625

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

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

B
binaryify 已提交
2631
### 排行榜详情
2632

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

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

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

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

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

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

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

B
v3.0.0  
binaryify 已提交
2647 2648 2649 2650
**接口地址 :** `/toplist/detail`

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

H
hzw758 已提交
2651 2652
### 歌手榜

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

B
binaryify 已提交
2655
**可选参数 :**
B
binaryify 已提交
2656

B
binaryify 已提交
2657 2658 2659 2660 2661 2662 2663
```
type : 地区
1: 华语
2: 欧美
3: 韩国
4: 日本
```
B
binaryify 已提交
2664

B
improve  
binaryify 已提交
2665 2666 2667
**接口地址 :** `/toplist/artist`

**调用例子 :** `/toplist/artist`
2668 2669 2670

### 云盘

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

2674 2675 2676 2677 2678 2679
**可选参数 :**

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

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

B
improve  
binaryify 已提交
2680 2681 2682
**接口地址 :** `/user/cloud`

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

B
binaryify 已提交
2684
### 云盘数据详情
B
binaryify 已提交
2685

B
binaryify 已提交
2686
说明 : 登录后调用此接口 , 传入云盘歌曲 id,可获取云盘数据详情
B
binaryify 已提交
2687

B
binaryify 已提交
2688
**必选参数 :** `id`: 歌曲 id,可多个,用逗号隔开
B
binaryify 已提交
2689 2690 2691 2692 2693

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

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

2694
### 云盘歌曲删除
B
binaryify 已提交
2695

B
binaryify 已提交
2696
说明 : 登录后调用此接口 , 可删除云盘歌曲
2697

B
binaryify 已提交
2698
**必选参数 :** `id`: 歌曲 id,可多个,用逗号隔开
2699 2700 2701 2702 2703

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

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

2704 2705
### 云盘上传

B
binaryify 已提交
2706 2707 2708
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传 mp3 formData(name 为'songFile'),可上传歌曲到云盘

参考: https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/public/cloud.html
2709

B
binaryify 已提交
2710
访问地址: http://localhost:3000/cloud.html)
2711

B
binaryify 已提交
2712
支持命令行调用,参考 module_example 目录下`song_upload.js`
2713 2714 2715 2716 2717

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

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

2718 2719
### 云盘歌曲信息匹配纠正

B
binaryify 已提交
2720 2721 2722 2723
说明 : 登录后调用此接口,可对云盘歌曲信息匹配纠正,如需取消匹配,asid 需要传 0

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

B
binaryify 已提交
2725
`sid`: 云盘的歌曲 id
2726

B
binaryify 已提交
2727
`asid`: 要匹配的歌曲 id
2728 2729 2730

**接口地址 :** `/cloud/match`

B
binaryify 已提交
2731
**调用例子 :** `/cloud/match?uid=32953014&sid=aaa&asid=bbb` `/cloud/match?uid=32953014&sid=bbb&asid=0`
2732

B
binaryify 已提交
2733 2734 2735
### 电台 banner

说明 : 调用此接口,可获取电台 banner
B
binaryify 已提交
2736 2737 2738 2739 2740

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

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

B
binaryify 已提交
2741
### 电台个性推荐
B
binaryify 已提交
2742

B
binaryify 已提交
2743 2744 2745
说明 : 调用此接口,可获取电台个性推荐列表
**可选参数 :**

B
binaryify 已提交
2746
`limit` : 返回数量,默认为 6,总条数最多 6 条
B
binaryify 已提交
2747 2748 2749 2750

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

**调用例子 :** `/dj/personalize/recommend?limit=5`
B
binaryify 已提交
2751

B
binaryify 已提交
2752
### 电台订阅者列表
B
binaryify 已提交
2753

B
binaryify 已提交
2754
说明 : 调用此接口,可获取电台订阅者列表
B
binaryify 已提交
2755
**必选参数 :** `id`: 电台 id
B
binaryify 已提交
2756 2757

**可选参数 :**
B
binaryify 已提交
2758
`time` : 分页参数,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
2759 2760 2761 2762 2763 2764 2765

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

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

**调用例子 :** `/dj/subscriber?id=335425050` , `/dj/subscriber?id=335425050&time=1602761825390`

B
binaryify 已提交
2766 2767
### 用户电台

B
binaryify 已提交
2768
说明 : 调用此接口, 传入用户 id 可获取用户创建的电台
B
binaryify 已提交
2769

B
binaryify 已提交
2770
**必选参数 :** `uid`: 用户 id
B
binaryify 已提交
2771 2772 2773 2774 2775 2776

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

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

### 热门电台
B
binaryify 已提交
2777

B
binaryify 已提交
2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
说明 : 调用此接口,可获取热门电台

**可选参数 :**

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

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

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

2789 2790
### 电台 - 节目榜

B
binaryify 已提交
2791
说明 : 登录后调用此接口 , 可获得电台节目榜
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

**可选参数 :**

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

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

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

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

2803
### 电台 - 付费精品
B
binaryify 已提交
2804

2805 2806 2807 2808 2809 2810 2811 2812 2813 2814
说明 : 调用此接口,可获取付费精品电台

**可选参数 :**

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

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

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

B
binaryify 已提交
2815
### 电台 - 24 小时节目榜
2816

B
binaryify 已提交
2817
说明 : 调用此接口,可获取 24 小时节目榜
2818 2819 2820 2821 2822

**可选参数 :**

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

B
binaryify 已提交
2823
**接口地址 :** `/dj/program/toplist/hours`
2824 2825 2826

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

B
binaryify 已提交
2827 2828 2829
### 电台 - 24 小时主播榜

说明 : 调用此接口,可获取 24 小时主播榜
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839

**可选参数 :**

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

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

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

### 电台 - 主播新人榜
B
binaryify 已提交
2840

2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
说明 : 调用此接口,可获取主播新人榜

**可选参数 :**

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

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

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

### 电台 - 最热主播榜
B
binaryify 已提交
2852

2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
说明 : 调用此接口,可获取最热主播榜

**可选参数 :**

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

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

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

2863 2864
### 电台 - 新晋电台榜/热门电台榜

B
binaryify 已提交
2865
说明 : 登录后调用此接口 , 可获得新晋电台榜/热门电台榜
2866 2867 2868 2869 2870 2871

**可选参数 :**

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

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

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

2875 2876 2877 2878
**接口地址 :** `/dj/toplist`

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

B
binaryify 已提交
2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
### 电台 - 类别热门电台

**可选参数 :**

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

B
binaryify 已提交
2895
说明 : 登录后调用此接口 , 可获得推荐电台
2896

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

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

B
improve  
binaryify 已提交
2901
### 电台 - 分类
2902

B
binaryify 已提交
2903
说明 : 登录后调用此接口 , 可获得电台类型
2904

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

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

B
improve  
binaryify 已提交
2909
### 电台 - 分类推荐
2910

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

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

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

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

B
improve  
binaryify 已提交
2920
### 电台 - 订阅
2921

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

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

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

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

2932 2933
### 电台的订阅列表

B
binaryify 已提交
2934
说明 : 登录后调用此接口 , 可获取订阅的电台列表
2935 2936 2937 2938 2939

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

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

add doc  
徐星宇 已提交
2940 2941 2942 2943
### 电台 - 付费精选

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

2944 2945 2946 2947
**可选参数 :**

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

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

add doc  
徐星宇 已提交
2950 2951 2952 2953
**接口地址 :** `/dj/paygift`

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

2954 2955
### 电台 - 非热门类型

B
binaryify 已提交
2956
说明 : 登录后调用此接口, 可获得电台非热门类型
2957 2958 2959 2960 2961 2962 2963

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

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

### 电台 - 推荐类型

B
binaryify 已提交
2964
说明 : 登录后调用此接口, 可获得电台推荐类型
2965 2966 2967 2968 2969 2970 2971

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

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

### 电台 - 今日优选

B
binaryify 已提交
2972
说明 : 登录后调用此接口, 可获得电台今日优选
2973 2974 2975 2976 2977

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

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

B
improve  
binaryify 已提交
2978
### 电台 - 详情
2979

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

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

2984
**接口地址 :** `/dj/detail`
2985

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

B
improve  
binaryify 已提交
2988
### 电台 - 节目
2989

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

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

B
binaryify 已提交
2997
**可选参数 :**
2998

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

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

B
binaryify 已提交
3003
`asc` : 排序方式,默认为 `false` (新 => 老 ) 设置 `true` 可改为 老 => 新
3004

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

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

B
binaryify 已提交
3009
### 电台 - 节目详情
B
binaryify 已提交
3010 3011

说明 : 调用此接口传入电台节目 id,可获得电台节目详情
B
binaryify 已提交
3012 3013 3014 3015 3016 3017

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

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

**调用例子 :** `/dj/program/detail?id=1367665101`
B
binaryify 已提交
3018 3019 3020

### 通知 - 私信

B
binaryify 已提交
3021
说明 : 登录后调用此接口 ,可获取私信
B
binaryify 已提交
3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032

**可选参数 :**

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

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

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

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

B
v3.12.0  
binaryify 已提交
3033 3034
### 发送私信

B
binaryify 已提交
3035
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)
B
v3.12.0  
binaryify 已提交
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045

**必选参数 :**

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

`msg` : 要发送的信息

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

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

未来初号机's avatar
未来初号机 已提交
3047
### 发送私信(带歌曲)
B
v3.12.0  
binaryify 已提交
3048

B
binaryify 已提交
3049
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息,音乐 id, 可以发送音乐私信,返回内容为历史私信
B
v3.12.0  
binaryify 已提交
3050 3051 3052

**必选参数 :**

3053
`user_ids` : 用户 id,多个需用逗号隔开
B
v3.12.0  
binaryify 已提交
3054

B
binaryify 已提交
3055
`id` : 要发送音乐的 id
未来初号机's avatar
未来初号机 已提交
3056

3057
`msg` : 要发送的信息
B
v3.12.0  
binaryify 已提交
3058

3059 3060 3061
**接口地址 :** `/send/song`

**调用例子 :** `/send/song?user_ids=1&id=351318&msg=测试`
B
v3.12.0  
binaryify 已提交
3062

未来初号机's avatar
未来初号机 已提交
3063 3064
### 发送私信(带专辑)

B
binaryify 已提交
3065
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息,专辑 id, 可以发送专辑私信,返回内容为消息 id
未来初号机's avatar
未来初号机 已提交
3066 3067 3068 3069 3070

**必选参数 :**

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

B
binaryify 已提交
3071
`id` : 要发送专辑的 id
未来初号机's avatar
未来初号机 已提交
3072 3073 3074 3075 3076 3077

`msg` : 要发送的信息

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

**调用例子 :** `/send/album?user_ids=1&id=351318&msg=测试`
B
v3.12.0  
binaryify 已提交
3078 3079 3080

### 发送私信(带歌单)

B
binaryify 已提交
3081
说明 : 登录后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)
B
v3.12.0  
binaryify 已提交
3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092

**必选参数 :**

`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`

3093
### 最近联系人
B
binaryify 已提交
3094

3095 3096 3097 3098 3099 3100 3101
说明 : 登录后调用此接口 ,可获取最接近联系人

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

**调用例子 :** `/msg/recentcontact`

### 私信内容
B
binaryify 已提交
3102

3103 3104 3105 3106 3107 3108 3109 3110 3111 3112
说明 : 登录后调用此接口 , 可获取私信内容

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

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

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

B
binaryify 已提交
3113
**接口地址 :**
3114 3115 3116 3117
`/msg/private/history`

**调用例子 :**
`/msg/private/history?uid=9003` (云音乐小秘书)
B
binaryify 已提交
3118 3119 3120

### 通知 - 评论

B
binaryify 已提交
3121
说明 : 登录后调用此接口 ,可获取评论
B
binaryify 已提交
3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136

**必选参数 :** `uid`: 用户 的 id,只能和登录账号的 id 一致

**可选参数 :**

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

`before` : 分页参数,取上一页最后一个歌单的 `updateTime` 获取下一页数据

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

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

### 通知 - @我

B
binaryify 已提交
3137
说明 : 登录后调用此接口 ,可获取@我数据
B
binaryify 已提交
3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150

**可选参数 :**

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

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

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

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

### 通知 - 通知

B
binaryify 已提交
3151
说明 : 登录后调用此接口 ,可获取通知
B
binaryify 已提交
3152 3153 3154 3155 3156

**可选参数 :**

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

B
binaryify 已提交
3157
`lasttime` : 返回数据的 `time` ,默认-1,传入上一次返回结果的 time,将会返回下一页的数据
B
binaryify 已提交
3158 3159 3160 3161 3162 3163

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

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

### 设置
B
binaryify 已提交
3164

B
binaryify 已提交
3165
说明 : 登录后调用此接口 ,可获取用户设置
B
binaryify 已提交
3166 3167 3168 3169 3170

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

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

3171
### 数字专辑-新碟上架
B
binaryify 已提交
3172 3173

说明 : 调用此接口 ,可获取数字专辑-新碟上架
3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184

**可选参数 :**

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

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

**调用例子 :** `/album/list?limit=10`

### 数字专辑&数字单曲-榜单
B
binaryify 已提交
3185 3186

说明 : 调用此接口 ,可获取数字专辑&数字单曲-榜单
3187 3188 3189 3190 3191

**可选参数 :**

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

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

B
binaryify 已提交
3194
`albumType` : 为数字专辑,1 为数字单曲
3195

B
binaryify 已提交
3196
`type` : daily:日榜,week:周榜,year:年榜,total:总榜
3197 3198 3199 3200 3201 3202 3203

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

**调用例子 :** `/album/songsaleboard?type=year&year=2020&albumType=0`

### 数字专辑-语种风格馆

B
binaryify 已提交
3204
说明 : 调用此接口 ,可获取语种风格馆数字专辑列表
3205 3206 3207 3208 3209

**可选参数 :**

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

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

B
binaryify 已提交
3212
`area` 地区 Z_H:华语,E_A:欧美,KR:韩国,JP:日本
3213 3214 3215 3216 3217 3218

**接口地址 :** `/album/list/style`

**调用例子 :** `/album/list/style?area=Z_H&offset=2`

### 数字专辑详情
B
binaryify 已提交
3219 3220

说明 : 调用此接口 ,传入数字专辑 id 可获取数字专辑详情(和歌单详情有差异)
3221 3222 3223 3224 3225

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

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

B
v3.12.0  
binaryify 已提交
3226
### 我的数字专辑
B
binaryify 已提交
3227

B
binaryify 已提交
3228
说明 : 登录后调用此接口 ,可获取我的数字专辑
B
v3.12.0  
binaryify 已提交
3229 3230 3231 3232 3233

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

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

T
TimonPeng 已提交
3234
### 购买数字专辑
B
binaryify 已提交
3235

B
binaryify 已提交
3236
说明 : 登录后调用此接口 ,可获取购买数字专辑的地址,把地址生成二维码后,可扫描购买专辑
T
TimonPeng 已提交
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249

**必选参数 :**

`id` : 专辑的 id

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

`quantity` : 购买的数量

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

**调用例子 :** `/digitalAlbum/ordering?id=86286082&payment=3&quantity=1`

3250
### 音乐日历
B
binaryify 已提交
3251

3252
说明 : 登录后调用此接口,传入开始和结束时间,可获取音乐日历
3253 3254 3255 3256 3257

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

**调用例子 :** `/calendar?startTime=1606752000000&endTime=1609430399999`

3258
### 云贝
B
binaryify 已提交
3259

3260 3261 3262 3263 3264 3265 3266
说明 : 登录后调用此接口可获取云贝签到信息(连续签到天数,第二天全部可获得的云贝)

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

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

### 云贝今日签到信息
B
binaryify 已提交
3267

3268 3269 3270 3271 3272 3273 3274
说明 : 登录后调用此接口可获取云贝今日签到信息(今日签到获取的云贝数)

**接口地址 :** `/yunbei/today`

**调用例子 :** `/yunbei/today`

### 云贝签到
B
binaryify 已提交
3275

3276 3277 3278 3279 3280 3281 3282
说明 : 登录后调用此接口可进行云贝签到

**接口地址 :** `/yunbei/sign`

**调用例子 :** `/yunbei/sign`

### 云贝账户信息
B
binaryify 已提交
3283

3284 3285 3286 3287 3288 3289 3290
说明 :登录后调用此接口可获取云贝账户信息(账户云贝数)

**接口地址 :** `/yunbei/info`

**调用例子 :** `/yunbei/info`

### 云贝所有任务
B
binaryify 已提交
3291

3292 3293 3294 3295 3296 3297
说明 :登录后调用此接口可获取云贝所有任务

**接口地址 :** `/yunbei/tasks`

**调用例子 :** `/yunbei/tasks`

B
binaryify 已提交
3298 3299 3300
### 云贝 todo 任务

说明 :登录后调用此接口可获取云贝 todo 任务
3301 3302 3303 3304 3305 3306

**接口地址 :** `/yunbei/tasks/todo`

**调用例子 :** `/yunbei/tasks/todo`

### 云贝完成任务
B
binaryify 已提交
3307

3308 3309
**必选参数 :**

B
binaryify 已提交
3310
`userTaskId` : 任务 id
3311

B
binaryify 已提交
3312
**可选参数 :**
3313

B
binaryify 已提交
3314
`depositCode`: 任务 depositCode
3315

3316 3317
**接口地址 :** `/yunbei/task/finish`

3318
**调用例子 :** `/yunbei/task/finish?userTaskId=5146243240&depositCode=0`
3319 3320

### 云贝收入
B
binaryify 已提交
3321 3322

说明 :登录后调用此接口可获取云贝收入
3323 3324 3325

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

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

3328 3329 3330 3331 3332
**接口地址 :** `/yunbei/tasks/receipt`

**调用例子 :** `/yunbei/tasks/receipt?limit=1`

### 云贝支出
B
binaryify 已提交
3333 3334

说明 :登录后调用此接口可获取云贝支出
3335 3336 3337 3338 3339 3340 3341

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

`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值  
**接口地址 :** `/yunbei/tasks/expense`

**调用例子 :** `/yunbei/tasks/expense?limit=1`
3342

3343
### 关注歌手新歌
B
binaryify 已提交
3344

3345 3346 3347 3348
说明 :登录后调用此接口可获取关注歌手新歌

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

B
binaryify 已提交
3349
`before`: 上一页数据返回的 publishTime 的数据
3350 3351 3352 3353 3354

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

**调用例子 :** `/artist/new/song?limit=1` `/artist/new/song?limit=1&before=1602777625000`

B
binaryify 已提交
3355
### 关注歌手新 MV
3356

B
binaryify 已提交
3357
说明 :登录后调用此接口可获取关注歌手新 MV
3358 3359 3360

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

B
binaryify 已提交
3361
`before`: 上一页数据返回的 publishTime 的数据
3362 3363 3364 3365 3366

**接口地址 :** `/artist/new/mv`

**调用例子 :** `/artist/new/mv?limit=1` `/artist/new/mv?limit=1&before=1602777625000`

3367
### 一起听状态
B
binaryify 已提交
3368

3369 3370 3371 3372 3373
说明 :登录后调用此接口可获取一起听状态

**接口地址 :** `/listen/together/status`

**调用例子 :** `/listen/together/status`
3374

B
binaryify 已提交
3375 3376
### batch 批量请求接口

B
binaryify 已提交
3377
说明 : 登录后调用此接口 ,传入接口和对应原始参数(原始参数非文档里写的参数,需参考源码),可批量请求接口
B
v3.13.0  
binaryify 已提交
3378 3379 3380

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

B
binaryify 已提交
3381
**调用例子 :** 使用 GET 方式:`/batch?/api/v2/banner/get={"clientType":"pc"}` 使用 POST 方式传入参数:`{ "/api/v2/banner/get": {"clientType":"pc"} }`
B
v3.13.0  
binaryify 已提交
3382

C
chen10 已提交
3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
### 云贝推歌

说明 : 登录后调用此接口 , 传入歌曲 id, 可以进行云贝推歌

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

**可选参数 :** `reason` : 推歌理由

**接口地址 :** `/yunbei/rcmd/song`

B
binaryify 已提交
3393
**调用例子 :** `/yunbei/rcmd/song?id=65528` `/yunbei/rcmd/song?id=65528&reason=人间好声音推荐给你听`
C
chen10 已提交
3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405

### 云贝推歌历史记录

说明 : 登录后调用此接口 , 可以获得云贝推歌历史记录

**可选参数 :** `size` : 返回数量 , 默认为 20

`cursor` : 返回数据的 cursor, 默认为 '' , 传入上一次返回结果的 cursor,将会返回下一页的数据

**接口地址 :** `/yunbei/rcmd/song/history`

**调用例子 :** `/yunbei/rcmd/song/history?size=10`
B
v3.13.0  
binaryify 已提交
3406

3407
### 已购单曲
B
binaryify 已提交
3408 3409

说明 :登录后调用此接口可获取已购买的单曲
3410 3411 3412

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

B
binaryify 已提交
3413
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值
3414 3415 3416 3417 3418

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

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

B
binaryify 已提交
3419
### 获取 mlog 播放地址
3420

B
binaryify 已提交
3421
说明 : 调用此接口 , 传入 mlog id, 可获取 mlog 播放地址
3422 3423 3424 3425 3426 3427 3428 3429 3430

**必选参数 :** `id` : mlog id

**可选参数 :** `res`: 分辨率 , 默认为 1080

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

**调用例子 :** `/mlog/url?id=a1qOVPTWKS1ZrK8`

B
binaryify 已提交
3431
### 将 mlog id 转为视频 id
3432

B
binaryify 已提交
3433
说明 : 调用此接口 , 传入 mlog id, 可获取 video id,然后通过`video/url` 获取播放地址
3434 3435 3436 3437 3438 3439 3440

**必选参数 :** `id` : mlog id

**接口地址 :** `/mlog/to/video`

**调用例子 :** `/mlog/to/video?id=a1qOVPTWKS1ZrK8`

B
binaryify 已提交
3441
### vip 成长值
3442 3443 3444 3445 3446 3447 3448

说明 : 登陆后调用此接口 , 可获取当前会员成长值

**接口地址 :** `/vip/growthpoint`

**调用例子 :** `/vip/growthpoint`

B
binaryify 已提交
3449 3450 3451
### vip 成长值获取记录

说明 :登录后调用此接口可获取会员成长值领取记录
3452 3453 3454

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

B
binaryify 已提交
3455
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值
3456 3457 3458 3459 3460

**接口地址 :** `/vip/growthpoint/details`

**调用例子 :** `/vip/growthpoint/details?limit=10`

B
binaryify 已提交
3461
### vip 任务
3462 3463 3464 3465 3466 3467 3468

说明 : 登陆后调用此接口 , 可获取会员任务

**接口地址 :** `/vip/tasks`

**调用例子 :** `/vip/tasks`

B
binaryify 已提交
3469
### 领取 vip 成长值
3470

C
chen10 已提交
3471
说明 : 登陆后调用此接口 , 可获取已完成的会员任务的成长值奖励
3472

C
chen10 已提交
3473
**必选参数 :** `ids` : 通过`/vip/tasks`获取到的`unGetIds`
3474 3475 3476

**接口地址 :** `/vip/growthpoint/get`

C
chen10 已提交
3477
**调用例子 :** `/vip/growthpoint/get?ids=7043206830_7` `/vip/growthpoint/get?ids=8613118351_1,8607552957_1`
3478

3479 3480 3481 3482 3483 3484 3485 3486
### 歌手粉丝

说明 : 调用此接口 , 传入歌手 id, 可获取歌手粉丝

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

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

B
binaryify 已提交
3487
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值
3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510

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

**调用例子 :** `/artist/fans?id=2116&limit=10&offset=0`

### 数字专辑详情

说明 : 调用此接口 , 传入专辑 id, 可获取数字专辑信息

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

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

**调用例子 :** `/digitalAlbum/detail?id=120605500`

### 数字专辑销量

说明 : 调用此接口 , 传入专辑 id, 可获取数字专辑销量

**必选参数 :** `ids` : 专辑 id, 支持多个,用`,`隔开

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

C
chen10 已提交
3511
**调用例子 :** `/digitalAlbum/sales?ids=120605500` `/digitalAlbum/sales?ids=120605500,125080528`
C
chen10 已提交
3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534

### 音乐人数据概况

说明 : 音乐人登录后调用此接口 , 可获取统计数据概况

**接口地址 :** `/musician/data/overview`

**调用例子 :** `/musician/data/overview`

### 音乐人播放趋势

说明 : 音乐人登录后调用此接口 , 可获取歌曲播放趋势

**必选参数 :** `startTime` : 开始时间

`endTime` : 结束时间

**接口地址 :** `/musician/play/trend`

**调用例子 :** `/musician/play/trend?startTime=2021-05-24&endTime=2021-05-30`

### 音乐人任务

B
binaryify 已提交
3535
说明 : 音乐人登录后调用此接口 , 可获取音乐人任务。返回的数据中`status`字段为任务状态,0 表示任务未开始,10 表示任务正在进行中,20 表示任务完成,但未领取云豆,100 表示任务完成,并且已经领取了相应的云豆
C
chen10 已提交
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552

**接口地址 :** `/musician/tasks`

**调用例子 :** `/musician/tasks`

### 账号云豆数

说明 : 音乐人登录后调用此接口 , 可获取账号云豆数

**接口地址 :** `/musician/cloudbean`

**调用例子 :** `/musician/cloudbean`

### 领取云豆

说明 : 音乐人登录后调用此接口 , 可领取已完成的音乐人任务的云豆奖励

B
binaryify 已提交
3553
**必选参数 :** `id` : 任务 id,通过`/musician/tasks`获取到的`userMissionId`即为任务 id
C
chen10 已提交
3554 3555 3556 3557 3558 3559

`period` : 通过`/musician/tasks`获取

**接口地址 :** `/musician/cloudbean/obtain`

**调用例子 :** `/musician/cloudbean/obtain?id=7036416928&period=1`
3560

3561
### 获取 VIP 信息
3562

W
WooMai 已提交
3563 3564 3565 3566 3567
说明: 登录后调用此接口,可获取当前 VIP 信息。

**接口地址 :** `/vip/info`

**调用例子 :** `/vip/info`
B
v3.13.0  
binaryify 已提交
3568

3569 3570 3571 3572 3573 3574 3575 3576
### 音乐人签到

说明: 音乐人登录后调用此接口,可以完成“登录音乐人中心”任务,然后通过`/musician/cloudbean/obtain`接口可以领取相应的云豆。

**接口地址 :** `/musician/sign`

**调用例子 :** `/musician/sign`

K
kengwang 已提交
3577 3578
### 歌曲相关视频

B
binaryify 已提交
3579
说明: 可以调用此接口获取歌曲相关视频 (区别于 MV), 有些歌曲没有 MV 但是有用户上传的与此歌曲相关的 Mlog。 此功能仅在 网易云音乐 APP 上存在。
K
kengwang 已提交
3580

B
binaryify 已提交
3581
请注意:此接口偶尔会在相关视频后返回不相关视频,请合理使用。
K
kengwang 已提交
3582

B
binaryify 已提交
3583
**必选参数 :** `songid` : 歌曲 ID
K
kengwang 已提交
3584 3585 3586 3587 3588 3589

**可选参数 :** `mvid` : 如果定义,此 mvid 对应的 MV 将会作为第一个返回。
`limit` : 取出的 Mlog 数量, 不包含第一个 mvid

**接口地址 :** `/mlog/music/rcmd`

K
kengwang 已提交
3590 3591 3592 3593
### 公开隐私歌单

说明: 可以调用此接口将当前用户的隐私歌单公开。

B
binaryify 已提交
3594
**必选参数 :** `id` : 歌单 ID
K
kengwang 已提交
3595 3596 3597

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

3598 3599 3600 3601 3602 3603 3604 3605 3606 3607
### 获取客户端歌曲下载 url

说明 : 使用 `/song/url` 接口获取的是歌曲试听 url, 但存在部分歌曲在非 VIP 账号上可以下载无损音质而不能试听无损音质, 使用此接口可使非 VIP 账号获取这些歌曲的无损音频

**必选参数 :** `id` : 音乐 id (仅支持单首歌曲)

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

**接口地址 :** `/song/download/url`

C
chen_10 已提交
3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623
### 获取歌手视频

说明 : 调用此接口 , 传入歌手 id, 可获得歌手视频

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

**可选参数 :** `size` : 返回数量 , 默认为 10

`cursor` : 返回数据的 cursor, 默认为 0 , 传入上一次返回结果的 cursor,将会返回下一页的数据

`order` : 排序方法, 0 表示按时间排序, 1 表示按热度排序, 默认为 0

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

**调用例子 :** `/artist/video?id=2116`

3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665
### 最近播放-歌曲

说明 : 调用此接口 , 可获得最近播放-歌曲

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

**接口地址 :** `/record/recent/song`

**调用例子 :** `/record/recent/song?limit=1`

### 最近播放-视频

说明 : 调用此接口 , 可获得最近播放-视频

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

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

**调用例子 :** `/record/recent/video?limit=1`

### 最近播放-声音

说明 : 调用此接口 , 可获得最近播放-声音

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

**接口地址 :** `/record/recent/voice`

**调用例子 :** `/record/recent/voice?limit=1`

### 最近播放-歌单

说明 : 调用此接口 , 可获得最近播放-歌单

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

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

**调用例子 :** `/record/recent/playlist?limit=1`

### 最近播放-专辑

A
Alkaidcc 已提交
3666
说明 : 调用此接口 , 可获得最近播放-专辑
3667 3668 3669 3670 3671 3672 3673 3674 3675

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

**接口地址 :** `/record/recent/album`

**调用例子 :** `/record/recent/album?limit=1`

### 最近播放-播客

A
Alkaidcc 已提交
3676
说明 : 调用此接口 , 可获得最近播放-播客
3677 3678 3679 3680 3681 3682 3683 3684 3685

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

**接口地址 :** `/record/recent/dj`

**调用例子 :** `/record/recent/dj?limit=1`



B
binaryify 已提交
3686
## 离线访问此文档
B
binaryify 已提交
3687

B
improve  
binaryify 已提交
3688
此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问
B
binaryify 已提交
3689 3690

## 关于此文档
B
improve  
binaryify 已提交
3691

B
binaryify 已提交
3692
此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。
B
binaryify 已提交
3693

B
binaryify 已提交
3694
## License
B
improve  
binaryify 已提交
3695

B
binaryify 已提交
3696
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)