@neteasecloudmusicapienhanced/api 4.30.2 → 4.31.0

package/README.MD

@@ -130,7 +130,7 @@ $ sudo docker run -d -p 3000:3000 ncm-api
 
 | 变量名                        | 默认值                                  | 说明                                                 |
 |----------------------------|--------------------------------------|----------------------------------------------------|
-| **CORS_ALLOW_ORIGIN**      | `*`                                  | 允许跨域请求的域名。若需要限制，请指定具体域名（例如 `https://example.com`）。 |
+| **CORS_ALLOW_ORIGIN**      | `*`                                  | 允许跨域请求的域名。可填写单个源，或使用逗号分隔多个源（例如 `https://a.com,https://b.com`）。 |
 | **ENABLE_PROXY**           | `false`                              | 是否启用反向代理功能。                                        |
 | **PROXY_URL**              | `https://your-proxy-url.com/?proxy=` | 代理服务地址。仅当 `ENABLE_PROXY=true` 时生效。                 |
 | **ENABLE_GENERAL_UNBLOCK** | `true`                               | 是否启用全局解灰（推荐开启）。开启后所有歌曲都尝试自动解锁。                     |
@@ -210,6 +210,7 @@ pnpm test
 ## 贡献与社区
 
 - 欢迎提交 PR、Issue 参与维护
+- 要贡献新接口, 请参考[这篇文章](https://www.focalors.ltd/post/how-to-contribute-ncm-api)
 
 ### 致谢
 

package/module/comment_add.js

@@ -0,0 +1,15 @@
+// 对某一首歌曲发表评论
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    threadId: 'R_SO_4_' + query.id,
+    content: query.content,
+    resourceType: '0',
+    resourceId: '0',
+    expressionPicId: '-1',
+    bubbleId: '-1',
+    checkToken: '',
+  }
+  return request('/api/resource/comments/add', data, createOption(query))
+}

package/module/comment_delete.js

@@ -0,0 +1,10 @@
+// 删除评论
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    commentId: query.cid,
+    threadId: 'R_SO_4_' + query.id,
+  }
+  return request(`/api/resource/comments/delete`, data, createOption(query))
+}

package/module/comment_reply.js

@@ -0,0 +1,13 @@
+// 回复评论
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    threadId: query.id,
+    commentId: query.commentId,
+    content: query.content,
+    resourceType: '0',
+    resourceId: '0',
+  }
+  return request(`/api/v1/resource/comments/reply`, data, createOption(query))
+}

package/module/dj_difm_all_style_channel.js

@@ -0,0 +1,9 @@
+// DIFM电台 - 分类
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    sources: query.sources || '[0]',
+  }
+  return request(`/api/dj/difm/all/style/channel/v2`, data, createOption(query))
+}

package/module/dj_difm_channel_subscribe.js

@@ -0,0 +1,9 @@
+// DIFM电台 - 收藏频道
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    id: query.id,
+  }
+  return request(`/api/dj/difm/channel/subscribe`, data, createOption(query))
+}

package/module/dj_difm_channel_unsubscribe.js

@@ -0,0 +1,9 @@
+// DIFM电台 - 取消收藏频道
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    id: query.id,
+  }
+  return request(`/api/dj/difm/channel/unsubscribe`, data, createOption(query))
+}

package/module/dj_difm_playing_tracks_list.js

@@ -0,0 +1,11 @@
+// DIFM电台 - 播放列表
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    limit: query.limit || 5,
+    source: query.source || 0,
+    channelId: query.channelId,
+  }
+  return request(`/api/dj/difm/playing/tracks/list`, data, createOption(query))
+}

package/module/dj_difm_subscribe_channels_get.js

@@ -0,0 +1,13 @@
+// DIFM电台 - 收藏列表
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    sources: query.sources || '[0]',
+  }
+  return request(
+    `/api/dj/difm/subscribe/channels/get/v2`,
+    data,
+    createOption(query),
+  )
+}

package/module/search_suggest_pc.js

@@ -0,0 +1,13 @@
+// 搜索建议pc端
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    keyword: query.keyword || '',
+  }
+  return request(
+    `/api/search/pc/suggest/keyword/get`,
+    data,
+    createOption(query),
+  )
+}

package/module/song_like.js

@@ -0,0 +1,12 @@
+// 喜欢歌曲
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const like = query.like !== 'false'
+  const data = {
+    trackId: query.id,
+    userid: query.uid,
+    like: like,
+  }
+  return request(`/api/song/like`, data, createOption(query))
+}

package/module/song_url_v1_302.js

@@ -0,0 +1,53 @@
+// 获取客户端歌曲下载链接 - v1
+// 此版本不再采用 br 作为音质区分的标准
+// 而是采用 standard, exhigh, lossless, hires, jyeffect(高清环绕声), sky(沉浸环绕声), jymaster(超清母带) 进行音质判断
+
+const createOption = require('../util/option.js')
+module.exports = async (query, request) => {
+  const data = {
+    id: query.id,
+    immerseType: 'c51',
+    level: query.level,
+  }
+  const response = await request(
+    `/api/song/enhance/download/url/v1`,
+    data,
+    createOption(query),
+  )
+  let url = response?.body?.data?.[0]?.url
+
+  if (!url) {
+    const fallbackData = {
+      ids: `[${query.id}]`,
+      level: query.level,
+      encodeType: 'flac',
+    }
+    if (query.level === 'sky') {
+      fallbackData.immerseType = 'c51'
+    }
+    const fallback = await request(
+      `/api/song/enhance/player/url/v1`,
+      fallbackData,
+      createOption(query),
+    )
+    url = fallback?.body?.data?.[0]?.url
+
+    if (!url) {
+      return fallback
+    }
+
+    return {
+      status: 302,
+      body: '',
+      cookie: fallback.cookie || [],
+      redirectUrl: url,
+    }
+  }
+
+  return {
+    status: 302,
+    body: '',
+    cookie: response.cookie || [],
+    redirectUrl: url,
+  }
+}

package/module/user_followeds.js

@@ -5,7 +5,7 @@ module.exports = (query, request) => {
   const data = {
     userId: query.uid,
     time: '0',
-    limit: query.limit || 30,
+    limit: query.limit || 20,
     offset: query.offset || 0,
     getcounts: 'true',
   }

package/module/voicelist_my_created.js

@@ -0,0 +1,13 @@
+// 我创建的播客声音
+
+const createOption = require('../util/option.js')
+module.exports = (query, request) => {
+  const data = {
+    limit: query.limit || 20,
+  }
+  return request(
+    `/api/social/my/created/voicelist/v1`,
+    data,
+    createOption(query, 'weapi'),
+  )
+}

package/module/voicelist_search.js

@@ -1,14 +1,11 @@
 const createOption = require('../util/option.js')
 module.exports = (query, request) => {
   const data = {
-    fee: '-1',
-    limit: query.limit || '200',
-    offset: query.offset || '0',
-    podcastName: query.podcastName || '',
+    keyword: query.keyword || '',
+    scene: 'normal',
+    limit: query.limit || '10',
+    offset: query.offset || '30',
+    e_r: true,
   }
-  return request(
-    `/api/voice/workbench/voicelist/search`,
-    data,
-    createOption(query),
-  )
+  return request(`/api/search/voicelist/get`, data, createOption(query))
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neteasecloudmusicapienhanced/api",
-  "version": "4.30.2",
+  "version": "4.31.0",
   "description": "全网最全的网易云音乐API接口 || A revival project for NeteaseCloudMusicApi Node.js Services (Half Refactor & Enhanced) || 网易云音乐 API 备份 + 增强 || 本项目自原版v4.28.0版本后开始自行维护",
   "scripts": {
     "dev": "nodemon app.js",
@@ -65,14 +65,15 @@
     "data"
   ],
   "dependencies": {
-    "@neteasecloudmusicapienhanced/unblockmusic-utils": "^0.2.3",
-    "axios": "^1.13.5",
+    "@neteasecloudmusicapienhanced/unblockmusic-utils": "^0.2.4",
+    "axios": "^1.13.6",
     "crypto-js": "^4.2.0",
     "dotenv": "^17.3.1",
     "express": "^5.2.1",
     "express-fileupload": "^1.5.2",
-    "music-metadata": "^11.12.1",
-    "node-forge": "^1.3.3",
+    "gzip": "^0.1.0",
+    "music-metadata": "^11.12.3",
+    "node-forge": "^1.4.0",
     "pac-proxy-agent": "^7.2.0",
     "qrcode": "^1.5.4",
     "safe-decode-uri-component": "^1.2.1",
@@ -81,22 +82,22 @@
     "yargs": "^18.0.0"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.3",
-    "@eslint/js": "^9.39.3",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^9.39.4",
     "@types/express": "^5.0.6",
     "@types/express-fileupload": "^1.5.1",
     "@types/mocha": "^10.0.10",
-    "@types/node": "25.0.9",
-    "@typescript-eslint/eslint-plugin": "^8.56.0",
-    "@typescript-eslint/parser": "^8.56.0",
-    "eslint": "^9.39.3",
+    "@types/node": "25.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.57.2",
+    "@typescript-eslint/parser": "^8.57.2",
+    "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-html": "^8.1.4",
     "eslint-plugin-prettier": "^5.5.5",
-    "globals": "^16.5.0",
+    "globals": "^17.4.0",
     "husky": "^9.1.7",
     "intelli-espower-loader": "^1.1.0",
-    "lint-staged": "^16.2.7",
+    "lint-staged": "^16.4.0",
     "mocha": "^11.7.5",
     "nodemon": "^3.1.14",
     "pkg": "^5.8.1",

package/public/docs/home.md

@@ -783,7 +783,7 @@ tags: 歌单标签
 **必选参数 :** `uid` : 用户 id
 
 **可选参数 :**
-`limit` : 返回数量 , 默认为 30
+`limit` : 返回数量 , 默认为 20
 
 `offset` : 偏移数量，用于分页 ,如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
 
@@ -1254,6 +1254,21 @@ tags: 歌单标签
 
 说明：`杜比全景声`音质需要设备支持，不同的设备可能会返回不同码率的 url。cookie 需要传入`os=pc`保证返回正常码率的 url。
 
+### 302到音乐 url - 新版
+
+说明 : 只允许传入单个`id`，会使用302重定向请求到目标url
+
+**必选参数 :** `id` : 音乐 id
+`level`: 播放音质等级, 分为 `standard` => `标准`,`higher` => `较高`, `exhigh`=>`极高`,
+`lossless`=>`无损`, `hires`=>`Hi-Res`, `jyeffect` => `高清环绕声`, `sky` => `沉浸环绕声`, `dolby` => `杜比全景声`, `jymaster` => `超清母带`
+`unblock`: 是否使用使用歌曲解锁, 分为`true`和`false`
+
+**接口地址 :** `/song/url/v1/302`
+
+**调用例子 :** `/song/url/v1/302?id=1969519579&level=exhigh`
+
+说明：`杜比全景声`音质需要设备支持，不同的设备可能会返回不同码率的 url。cookie 需要传入`os=pc`保证返回正常码率的 url。
+
 ### 音乐是否可用
 
 说明: 调用此接口,传入歌曲 id, 可获取音乐是否可用,返回 `{ success: true, message: 'ok' }` 或者 `{ success: false, message: '亲爱的,暂无版权' }`
@@ -4103,13 +4118,15 @@ type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
 
 **接口地址:** `/voicelist/search`
 
-**可选参数：**
+**必选参数：**
 
-`limit`: 取出歌单数量 , 默认为 200
+`keyword`: 搜索关键词
 
-`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*200, 其中 200 为 limit 的值
+**可选参数：**
+
+`limit`: 取出歌单数量, 默认为 10
 
-`podcastName`: 播客名称
+`offset`: 偏移数量 , 用于分页 , 默认为 30
 
 ### 播客声音列表
 
@@ -5050,6 +5067,148 @@ let data = encodeURIComponent(
 
 **调用例子 :** `/user/playlist/collect?uid=32953014`
 
+### 搜索建议 - PC端
+
+说明 : 调用此接口, 传入搜索关键词, 获取搜索建议
+
+**必选参数 :**
+
+`keyword`: 搜索关键词
+
+**接口地址 :** `/search/suggest/pc`
+
+**调用例子 :** `/search/suggest/pc?keyword=海阔天空`
+
+### 喜欢歌曲 - 新版
+
+说明 : 登录后调用此接口, 传入歌曲 id 用户id和喜欢状态, 可喜欢/取消喜欢歌曲
+
+**必选参数 :**
+
+`id`: 歌曲 id
+`uid`: 用户 id
+`like`: 喜欢状态, true 表示喜欢, false 表示取消喜欢
+
+**接口地址 :** `/song/like`
+
+**调用例子 :** `/song/like?id=2058263032&uid=32953014&like=true`
+
+### 我创建的播客声音
+
+说明 : 登录后调用此接口, 获取我创建的博客声音
+
+**可选参数 :** 
+
+`limit` : 返回数量 , 默认为 20
+
+**接口地址 :** `/voicelist/my/created`
+
+**调用例子 :** `/voicelist/my/created`
+
+### 发布评论
+
+说明 : 登录后调用此接口, 传入评论线程 id, 评论内容等信息, 发布评论
+
+**必选参数 :**
+
+`id`: 歌曲id
+`content`: 评论内容
+
+**接口地址 :** `/comment/add`
+
+**调用例子 :** `/comment/add?id=2058263032&content=这首歌太棒了！`
+
+### 删除评论
+
+说明 : 登录后调用此接口, 传入评论 id, 删除评论
+
+**必选参数 :**
+`cid`: 评论 id
+`id`: 歌曲id
+
+**接口地址 :** `/comment/delete`
+
+**调用例子 :** `/comment/delete?threadId=2058263032&commentId=123456789`
+
+### 回复评论
+
+说明 : 登录后调用此接口, 传入歌曲 id, 回复内容等信息, 回复评论
+
+**必选参数 :**
+`id`: 歌曲id
+`commentId`: 被回复的评论 id
+`content`: 回复内容
+
+**接口地址 :** `/comment/reply`
+
+**调用例子 :** `/comment/reply?id=2058263032&commentId=123456789&content=我也觉得这首歌很棒！`
+
+### DIFM电台 - 分类
+
+说明: 调用此接口, 获取DIFM电台分类
+
+**必选参数 :**  
+
+`sources`: 来源列表, 0: 最嗨电音 1: 古典电台 2: 爵士电台
+
+**接口地址:** `/dj/difm/all/style/channel`
+
+**调用例子:** `/dj/difm/all/style/channel?sources=[0]`
+
+### DIFM电台 - 收藏列表
+
+说明: 调用此接口, 获取DIFM电台收藏列表
+
+**必选参数 :**  
+
+`sources`: 来源列表, 0: 最嗨电音 1: 古典电台 2: 爵士电台
+
+**接口地址:** `/dj/difm/subscribe/channels/get`
+
+**调用例子:** `/dj/difm/subscribe/channels/get?sources=[0]`
+
+### DIFM电台 - 收藏频道
+
+说明: 调用此接口, 可收藏DIFM频道
+
+**必选参数 :**
+
+`id`: 频道id
+
+**接口地址:** `/dj/difm/channel/subscribe`
+
+**调用例子:** `/dj/difm/channel/subscribe?id=1`
+
+### DIFM电台 - 取消收藏频道
+
+说明: 调用此接口, 可取消收藏DIFM频道
+
+**必选参数 :**
+
+`id`: 频道id
+
+**接口地址:** `/dj/difm/channel/unsubscribe`
+
+**调用例子:** `/dj/difm/channel/unsubscribe?id=1`
+
+### DIFM电台 - 播放列表
+
+说明: 调用此接口, 获取DIFM播放列表
+
+**必选参数 :**  
+
+`source`: 来源, 0: 最嗨电音 1: 古典电台 2: 爵士电台
+
+`channelId`: 频道id
+
+**可选参数 :**
+
+`limit`: 返回数量, 默认为 5
+
+**接口地址:** `/dj/difm/playing/tracks/list`
+
+**调用例子:** `/dj/difm/playing/tracks/list?source=0&channelId=1012`
+
 ## 离线访问此文档
 
 此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问

package/server.js

@@ -127,15 +127,45 @@ async function checkVersion() {
   })
 }
 
+function parseCorsAllowOrigins(corsAllowOrigin) {
+  if (!corsAllowOrigin) {
+    return null
+  }
+
+  const origins = corsAllowOrigin
+    .split(',')
+    .map((origin) => origin.trim())
+    .filter(Boolean)
+
+  return origins.length > 0 ? origins : null
+}
+
+function getCorsAllowOrigin(allowOrigins, requestOrigin) {
+  if (!allowOrigins) {
+    return requestOrigin || '*'
+  }
+
+  if (allowOrigins.includes('*')) {
+    return '*'
+  }
+
+  if (requestOrigin && allowOrigins.includes(requestOrigin)) {
+    return requestOrigin
+  }
+
+  return null
+}
+
 /**
  * Construct the server of NCM API.
  *
  * @param {ModuleDefinition[]} [moduleDefs] Customized module definitions [advanced]
  * @returns {Promise<import("express").Express>} The server instance.
  */
-async function consturctServer(moduleDefs) {
+async function constructServer(moduleDefs) {
   const app = express()
   const { CORS_ALLOW_ORIGIN } = process.env
+  const allowOrigins = parseCorsAllowOrigins(CORS_ALLOW_ORIGIN)
   app.set('trust proxy', true)
 
   /**
@@ -147,10 +177,17 @@ async function consturctServer(moduleDefs) {
    */
   app.use((req, res, next) => {
     if (req.path !== '/' && !req.path.includes('.')) {
+      const corsAllowOrigin = getCorsAllowOrigin(
+        allowOrigins,
+        req.headers.origin,
+      )
+      const shouldSetVaryHeader = corsAllowOrigin && corsAllowOrigin !== '*'
       res.set({
         'Access-Control-Allow-Credentials': true,
-        'Access-Control-Allow-Origin':
-          CORS_ALLOW_ORIGIN || req.headers.origin || '*',
+        ...(corsAllowOrigin
+          ? { 'Access-Control-Allow-Origin': corsAllowOrigin }
+          : {}),
+        ...(shouldSetVaryHeader ? { Vary: 'Origin' } : {}),
         'Access-Control-Allow-Headers': 'X-Requested-With,Content-Type',
         'Access-Control-Allow-Methods': 'PUT,POST,GET,DELETE,OPTIONS',
         'Content-Type': 'application/json; charset=utf-8',
@@ -221,7 +258,7 @@ async function consturctServer(moduleDefs) {
 
   for (const moduleDef of moduleDefinitions) {
     // Register the route.
-    app.use(moduleDef.route, async (req, res) => {
+    app.all(moduleDef.route, async (req, res) => {
       ;[req.query, req.body].forEach((item) => {
         // item may be undefined (some environments / middlewares).
         // Guard access to avoid "Cannot read properties of undefined (reading 'cookie')".
@@ -308,6 +345,11 @@ async function consturctServer(moduleDefs) {
             }
           }
         }
+        if (moduleResponse.redirectUrl) {
+          res.redirect(moduleResponse.status || 302, moduleResponse.redirectUrl)
+          return
+        }
+
         res.status(moduleResponse.status).send(moduleResponse.body)
       } catch (/** @type {*} */ moduleResponse) {
         logger.error(`${decode(req.originalUrl)}`, {
@@ -354,7 +396,7 @@ async function serveNcmApi(options) {
         )
       }
     })
-  const constructServerSubmission = consturctServer(options.moduleDefs)
+  const constructServerSubmission = constructServer(options.moduleDefs)
 
   const [_, app] = await Promise.all([
     checkVersionSubmission,

package/util/request.js

@@ -240,6 +240,7 @@ const createRequest = (uri, data, options) => {
         headers['User-Agent'] = options.ua || chooseUserAgent('api', 'iphone')
 
         if (crypto === 'eapi') {
+          // headers['x-aeapi'] = true // 服务器会使用gzip压缩返回值
           data.header = header
           data.e_r = toBoolean(
             options.e_r !== undefined
@@ -323,6 +324,7 @@ const createRequest = (uri, data, options) => {
           if (crypto === 'eapi' && data.e_r) {
             answer.body = encrypt.eapiResDecrypt(
               body.toString('hex').toUpperCase(),
+              headers['x-aeapi'],
             )
           } else {
             answer.body =