### Get Album Details Source: https://kugoumusicapi-docs.4everland.app/ Retrieves details for one or more albums. ```APIDOC ## GET /longaudio/album/detail ### Description Retrieves details for one or more albums. ### Method GET ### Endpoint /longaudio/album/detail ### Parameters #### Query Parameters - **album_id** (string) - Required - Album ID. Multiple IDs can be provided, separated by commas. ``` -------------------------------- ### Get Daily Recommended Audiobooks Source: https://kugoumusicapi-docs.4everland.app/ Retrieves daily recommended audiobooks. ```APIDOC ## GET /longaudio/daily/recommend ### Description Retrieves daily recommended audiobooks. ### Method GET ### Endpoint /longaudio/daily/recommend ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. ``` -------------------------------- ### Get Weekly Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves weekly recommended audiobooks. ```api /longaudio/week/recommend ``` -------------------------------- ### Get Weekly Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves weekly recommended audiobooks. ```APIDOC ## GET /longaudio/week/recommend ### Description Retrieves weekly recommended audiobooks. ### Method GET ### Endpoint /longaudio/week/recommend ``` -------------------------------- ### Get Channel Recommendation Source: https://kugoumusicapi-docs.4everland.app/ Retrieves recommendations for a specific channel. ```APIDOC ## GET /youth/channel/amway ### Description Retrieves recommendations for a specific channel. ### Method GET ### Endpoint /youth/channel/amway ### Parameters #### Query Parameters - **global_collection_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). ``` -------------------------------- ### Get VIP Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves audiobook recommendations for VIP users. ```APIDOC ## GET /longaudio/vip/recommend ### Description Retrieves audiobook recommendations for VIP users. ### Method GET ### Endpoint /longaudio/vip/recommend ``` -------------------------------- ### Get Daily Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves daily recommended audiobooks. Supports pagination. ```api /longaudio/daily/recommend ``` -------------------------------- ### Get Ranked Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves audiobook recommendations from the charts. ```api /longaudio/rank/recommend ``` -------------------------------- ### Get Sheet Music Tags Source: https://kugoumusicapi-docs.4everland.app/ Retrieves available tags for sheet music. ```APIDOC ## GET /sheet/tags ### Description Retrieves available tags for sheet music. ### Method GET ### Endpoint /sheet/tags ``` -------------------------------- ### Get Song Scorecard Source: https://kugoumusicapi-docs.4everland.app/ Retrieves the scorecard information for a song. ```APIDOC ## GET /song/ranking ### Description Retrieves the scorecard information for a song. ### Method GET ### Endpoint /song/ranking ### Parameters #### Query Parameters - **album_audio_id** (string) - Required - Album audio ID (can be `album_audio_id` or `MixSongID`). ``` -------------------------------- ### Get VIP Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves audiobook recommendations specifically for VIP users. ```api /longaudio/vip/recommend ``` -------------------------------- ### Get Recommended Sheet Music Source: https://kugoumusicapi-docs.4everland.app/ Retrieves recommended sheet music. Optional parameters include instrument type, difficulty level, page number, page size, and tag ID. ```api /sheet/explore ``` -------------------------------- ### QR Code Login - QR Image Creation Source: https://kugoumusicapi-docs.4everland.app/ Creates a QR code image using a provided key. An optional `qrimg` parameter can be included to get the base64 encoded image. ```APIDOC ## GET /login/qr/create ### Description Creates a QR code image using a provided key. An optional `qrimg` parameter can be included to get the base64 encoded image. ### Method GET ### Endpoint /login/qr/create ### Parameters #### Query Parameters - **key** (string) - Required - The key generated from the `/login/qr/key` endpoint. - **qrimg** (string) - Optional - If provided, the response will include the base64 encoded QR code image. ### Response #### Success Response (200) - **qrimg** (string) - The base64 encoded QR code image (if `qrimg` parameter was provided). - **qrdata** (string) - The data for rendering the QR code. ``` -------------------------------- ### Get Ranked Audiobook Recommendations Source: https://kugoumusicapi-docs.4everland.app/ Retrieves audiobook recommendations based on rankings. ```APIDOC ## GET /longaudio/rank/recommend ### Description Retrieves audiobook recommendations based on rankings. ### Method GET ### Endpoint /longaudio/rank/recommend ``` -------------------------------- ### Get Album Audio List Source: https://kugoumusicapi-docs.4everland.app/ Retrieves a list of audio tracks within one or more albums. ```APIDOC ## GET /longaudio/album/audios ### Description Retrieves a list of audio tracks within one or more albums. ### Method GET ### Endpoint /longaudio/album/audios ### Parameters #### Query Parameters - **album_id** (string) - Required - Album ID. Multiple IDs can be provided. ``` -------------------------------- ### Get Similar Channels Source: https://kugoumusicapi-docs.4everland.app/ Retrieves channels similar to a given channel ID. ```APIDOC ## GET /youth/channel/similar ### Description Retrieves channels similar to a given channel ID. ### Method GET ### Endpoint /youth/channel/similar ### Parameters #### Query Parameters - **channel_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). ``` -------------------------------- ### Get Channel Music Stories Source: https://kugoumusicapi-docs.4everland.app/ Retrieves music stories associated with a channel. ```APIDOC ## GET /youth/channel/song ### Description Retrieves music stories associated with a channel. ### Method GET ### Endpoint /youth/channel/song ### Parameters #### Query Parameters - **global_collection_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. ``` -------------------------------- ### Get Channel Detail Source: https://kugoumusicapi-docs.4everland.app/ Retrieves the details of a specific channel using its ID. ```APIDOC ## GET /youth/channel/detail ### Description Retrieves the details of a specific channel. ### Method GET ### Endpoint /youth/channel/detail ### Parameters #### Query Parameters - **global_collection_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). Multiple IDs can be provided, separated by commas. ``` -------------------------------- ### Get Album Details Source: https://kugoumusicapi-docs.4everland.app/ Retrieves details for one or more albums, identified by their album IDs. Multiple IDs can be provided, separated by commas. ```api /longaudio/album/detail?album_id=56655759 ``` -------------------------------- ### Get Channel Music Story Detail Source: https://kugoumusicapi-docs.4everland.app/ Retrieves detailed information about a specific music story within a channel. ```APIDOC ## GET /youth/channel/song/detail ### Description Retrieves detailed information about a specific music story within a channel. ### Method GET ### Endpoint /youth/channel/song/detail ### Parameters #### Query Parameters - **global_collection_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). - **fileid** (string) - Required - Music story file ID. ``` -------------------------------- ### Get Recommended Sheet Music Source: https://kugoumusicapi-docs.4everland.app/ Retrieves recommended sheet music with options to filter by instrument, difficulty level, page, page size, and tag. ```APIDOC ## GET /sheet/explore ### Description Retrieves recommended sheet music. ### Method GET ### Endpoint /sheet/explore ### Parameters #### Query Parameters - **instruments** (integer) - Optional - Sheet music type. Defaults to 1 (1: Guitar, 2: Ukulele, 3: Piano, 4: Simple Notation). - **level** (integer) - Optional - Difficulty level. Defaults to 0. For Guitar (1: Advanced, 2: Basic, 0: Intermediate), Ukulele/Piano (0: Basic, 1: Advanced), Simple Notation (0: Basic). - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. - **tagid** (string) - Optional - Tag ID. Obtainable via `/sheet/tags`. ``` -------------------------------- ### Get User's Channels Source: https://kugoumusicapi-docs.4everland.app/ Retrieves all channels subscribed to by the logged-in user. ```APIDOC ## GET /youth/channel/all ### Description Retrieves all channels subscribed to by the logged-in user. ### Method GET ### Endpoint /youth/channel/all ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. ``` -------------------------------- ### Get Detailed Song Scorecard Source: https://kugoumusicapi-docs.4everland.app/ Retrieves more detailed song scorecard information for a logged-in user. ```APIDOC ## GET /song/ranking/filter ### Description Retrieves more detailed song scorecard information for a logged-in user. ### Method GET ### Endpoint /song/ranking/filter ### Parameters #### Query Parameters - **album_audio_id** (string) - Required - Album audio ID (can be `album_audio_id` or `MixSongID`). - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. ``` -------------------------------- ### Get Sheet Music Tags Source: https://kugoumusicapi-docs.4everland.app/ Retrieves available tags for sheet music. This endpoint is used to filter sheet music by specific tags. ```api /sheet/tags ``` -------------------------------- ### Get Similar Channels Source: https://kugoumusicapi-docs.4everland.app/ Retrieves channels similar to a given channel, identified by its channel ID. ```api /youth/channel/similar?channel_id=11576464149 ``` -------------------------------- ### Get User's Channels Source: https://kugoumusicapi-docs.4everland.app/ Retrieves all channels subscribed to by the logged-in user. Supports pagination with optional page and page size parameters. ```api /youth/channel/all ``` -------------------------------- ### Get Frequently Accessed Source: https://kugoumusicapi-docs.4everland.app/ Retrieves frequently accessed channels and users for the logged-in user. ```APIDOC ## GET /youth/dynamic/recent ### Description Retrieves frequently accessed channels and users for the logged-in user. ### Method GET ### Endpoint /youth/dynamic/recent ``` -------------------------------- ### Get Channel Recommendations (Amway) Source: https://kugoumusicapi-docs.4everland.app/ Retrieves recommendations for a channel using its global collection ID or channel ID. ```api /youth/channel/amway?global_collection_id=11576464149 ``` -------------------------------- ### Get Detailed Song Scorecard Source: https://kugoumusicapi-docs.4everland.app/ Retrieves more detailed song scorecard information for logged-in users. Supports pagination. ```api /song/ranking/filter?album_audio_id=32155307 ``` -------------------------------- ### Get Song Scorecard Source: https://kugoumusicapi-docs.4everland.app/ Retrieves the scorecard information for a song, using its album audio ID or MixSongID. ```api /song/ranking?album_audio_id=32155307 ``` -------------------------------- ### Get User's Public Music Source: https://kugoumusicapi-docs.4everland.app/ Retrieves public music tracks associated with a user ID. ```APIDOC ## GET /youth/user/song ### Description Retrieves public music tracks associated with a user ID. ### Method GET ### Endpoint /youth/user/song ### Parameters #### Query Parameters - **userid** (string) - Required - User ID. - **page** (integer) - Optional - Page number. - **pagesize** (integer) - Optional - Number of items per page. Defaults to 30. ``` -------------------------------- ### Get DFID Source: https://kugoumusicapi-docs.4everland.app/ Retrieves a DFID (Device Fingerprint ID). This endpoint is used for device identification. ```APIDOC ## GET /register/dev ### Description Retrieves a DFID (Device Fingerprint ID). This endpoint is used for device identification. ### Method GET ### Endpoint /register/dev ### Response #### Success Response (200) - **dfid** (string) - The Device Fingerprint ID. ``` -------------------------------- ### Get Frequently Accessed Source: https://kugoumusicapi-docs.4everland.app/ Retrieves a list of frequently accessed channels and users for the logged-in user. ```api /youth/dynamic/recent ``` -------------------------------- ### Get User's Public Music Source: https://kugoumusicapi-docs.4everland.app/ Retrieves public music tracks associated with a specific user ID. Supports pagination. ```api /youth/user/song?userid=1354894105 ``` -------------------------------- ### Get Album Music List Source: https://kugoumusicapi-docs.4everland.app/ Retrieves a list of music tracks within one or more albums, identified by their album IDs. Multiple IDs can be provided. ```api /longaudio/album/audios?album_id=56655759 ``` -------------------------------- ### Get Channel Music Story Details Source: https://kugoumusicapi-docs.4everland.app/ Retrieves detailed information for a specific music story within a channel, requiring both the channel ID and the music story's file ID. ```api /youth/channel/song/detail?global_collection_id=11576464149&fileid=1720958083456581 ``` -------------------------------- ### Get Channel Music Stories Source: https://kugoumusicapi-docs.4everland.app/ Retrieves music stories associated with a channel, identified by its global collection ID or channel ID. Supports pagination. ```api /youth/channel/song?global_collection_id=11576464149 ``` -------------------------------- ### Get Channel Details Source: https://kugoumusicapi-docs.4everland.app/ Retrieves detailed information about a specific channel using its global collection ID or channel ID. Multiple IDs can be provided, separated by commas. ```api /youth/channel/detail?global_collection_id=11576464149 ``` -------------------------------- ### Get Verification Code Info Source: https://kugoumusicapi-docs.4everland.app/ Retrieves information needed to display a verification code, typically used when error code 20028 occurs. ```APIDOC ## GET /get/verify/info ### Description Retrieves information needed to display a verification code, typically used when error code 20028 occurs. ### Method GET ### Endpoint /get/verify/info ### Parameters #### Query Parameters - **eventid** (string) - Required - Event ID returned with error code 20028. ``` -------------------------------- ### Get Verification Code Info Source: https://kugoumusicapi-docs.4everland.app/ Retrieves information about the format of a verification code, typically called when an error code 20028 occurs. Requires an event ID. ```api /get/verify/info?eventid=gz_tx_event_xxx ``` -------------------------------- ### 二维码登录 - Key 生成接口 Source: https://kugoumusicapi-docs.4everland.app/ 生成二维码登录所需的 key。 ```http /login/qr/key ``` -------------------------------- ### 二维码登录 - 二维码生成接口 Source: https://kugoumusicapi-docs.4everland.app/ 根据 key 生成二维码的 base64 编码或二维码信息。 ```http /login/qr/create?key=xxx ``` -------------------------------- ### 二维码登录 - 检测扫码状态接口 Source: https://kugoumusicapi-docs.4everland.app/ 轮询此接口以获取二维码扫码状态，成功时返回 token。 ```http /login/qr/check?key=xxx ``` -------------------------------- ### 微信登录 - 二维码生成接口 Source: https://kugoumusicapi-docs.4everland.app/ 生成微信登录所需的 uuid，包括二维码 base64 和扫描链接。 ```http /login/wx/create ``` -------------------------------- ### Open Platform Login (WeChat) Source: https://kugoumusicapi-docs.4everland.app/ Logs in using an open platform, currently supporting WeChat. A `code` generated after a successful WeChat scan is required. ```APIDOC ## POST /login/openplat ### Description Logs in using an open platform, currently supporting WeChat. A `code` generated after a successful WeChat scan is required. ### Method POST ### Endpoint /login/openplat ### Parameters #### Query Parameters - **code** (string) - Required - The code generated after a successful WeChat scan. ### Request Example ```json { "code": "xxx" } ``` ### Response #### Success Response (200) - **token** (string) - The authentication token. - **cookie** (string) - The user's session cookie. - **userid** (string) - The user ID. ``` -------------------------------- ### QR Code Login - Key Generation Source: https://kugoumusicapi-docs.4everland.app/ Generates a key required for QR code login. This is the first step in the QR code login process. ```APIDOC ## GET /login/qr/key ### Description Generates a key required for QR code login. This is the first step in the QR code login process. ### Method GET ### Endpoint /login/qr/key ### Response #### Success Response (200) - **key** (string) - The generated key for QR code login. ``` -------------------------------- ### Username Login Source: https://kugoumusicapi-docs.4everland.app/ Logs in a user using their username and password. This method may require additional verification and is not recommended. ```APIDOC ## POST /login ### Description Logs in a user using their username and password. This method may require additional verification and is not recommended. ### Method POST ### Endpoint /login ### Parameters #### Query Parameters - **username** (string) - Required - The user's username. - **password** (string) - Required - The user's password. ### Request Example ```json { "username": "xxx", "password": "yyy" } ``` ### Response #### Success Response (200) - **token** (string) - The authentication token. - **cookie** (string) - The user's session cookie. - **userid** (string) - The user ID. ``` -------------------------------- ### 微信登录 - 检测扫码状态接口 Source: https://kugoumusicapi-docs.4everland.app/ 轮询此接口以获取微信二维码扫码状态。建议传递 timestamp 参数以避免缓存延迟。 ```http /login/wx/check?timestamp=1691256061923&uuid=xxxxxxxxx ``` -------------------------------- ### 刷新登录状态接口示例 Source: https://kugoumusicapi-docs.4everland.app/ 调用此接口可刷新登录状态并延长 token 过期时间。可选参数包括 token 和 userid。 ```http /login/token ``` ```http /login/token?token=xxx&userid=xxx ``` -------------------------------- ### 用户名登录接口示例 Source: https://kugoumusicapi-docs.4everland.app/ 使用用户名和密码登录的接口调用示例。此方法可能需要验证，不推荐使用。 ```http /login?username=xxx&password=yyy ``` -------------------------------- ### Vercel 部署步骤 Source: https://kugoumusicapi-docs.4everland.app/ 在 Vercel 上部署项目的操作指南。 ```markdown 1. fork 此项目 2. 在 Vercel 官网点击 `New Project` 3. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击 `import` 4. 点击 `PERSONAL ACCOUNT` 的 `select` 5. 直接点 `Continue` 6. 若需要部署版本为概念版（不需要该步骤可以跳过），在 `Environment Variables` 添加 `key` 为 `platform`，`Value (Will Be Encrypted)` 为 `lite` 然后点击 `Add` 7. `PROJECT NAME`自己填,`FRAMEWORK PRESET` 选 `Other` 然后直接点 `Deploy` 接着等部署完成即可 ``` -------------------------------- ### Recognize Song from PCM Audio Data Source: https://kugoumusicapi-docs.4everland.app/ Recognizes song information by sending PCM audio data via POST request with 'application/octet-stream' content type. Requires the audio data in the request body. ```javascript const res = await fetch('/audio/match', { method: 'POST', headers: { 'Content-Type': 'application/octet-stream' }, body: pcmArrayBuffer, }); ``` -------------------------------- ### 开放接口登录示例 (微信) Source: https://kugoumusicapi-docs.4everland.app/ 通过第三方平台（目前仅支持微信）进行登录的接口调用示例。需要微信扫码成功后生成的 code。 ```http /login/openplat?code=xxx ``` -------------------------------- ### Phone Login Source: https://kugoumusicapi-docs.4everland.app/ Logs in a user using their mobile number and a verification code. An optional `userid` can be provided for multi-account scenarios. ```APIDOC ## POST /login/cellphone ### Description Logs in a user using their mobile number and a verification code. An optional `userid` can be provided for multi-account scenarios. ### Method POST ### Endpoint /login/cellphone ### Parameters #### Query Parameters - **mobile** (string) - Required - The user's mobile number. - **code** (string) - Required - The verification code sent to the mobile number. - **userid** (string) - Optional - The user ID, required when a user has multiple accounts. ### Request Example ```json { "mobile": "xxx", "code": "xxx" } ``` ### Response #### Success Response (200) - **token** (string) - The authentication token. - **cookie** (string) - The user's session cookie. - **userid** (string) - The user ID. ``` -------------------------------- ### Verify Verification Code Source: https://kugoumusicapi-docs.4everland.app/ Verifies a user's input against a verification code, currently supports Tencent verification. ```APIDOC ## GET /verify/user/info ### Description Verifies a user's input against a verification code, currently supports Tencent verification. ### Method GET ### Endpoint /verify/user/info ### Parameters #### Query Parameters - **eventid** (string) - Required - Event ID returned with error code 20028. - **v_type** (string) - Required - Verification type obtained from `/get/verify/info`. - **verifycode** (string) - Required - The verification code provided by the user (e.g., from a slider). - **sid** (string) - Required - Session ID obtained from `public\login_captcha.html`. - **edt** (string) - Required - Additional data obtained from `public\login_captcha.html`. ``` -------------------------------- ### Subscribe/Unsubscribe to Channel Source: https://kugoumusicapi-docs.4everland.app/ Allows users to subscribe to or unsubscribe from a channel. ```APIDOC ## GET /youth/channel/sub ### Description Allows users to subscribe to or unsubscribe from a channel. ### Method GET ### Endpoint /youth/channel/sub ### Parameters #### Query Parameters - **global_collection_id** (string) - Required - Channel ID (can be `global_collection_id` or `channel_id`). - **t** (integer) - Optional - Subscription type. 1 for subscribe, 0 for unsubscribe. Defaults to subscribe. ``` -------------------------------- ### dfid 获取接口示例 Source: https://kugoumusicapi-docs.4everland.app/ 用于获取 dfid 的接口调用示例。 ```http /register/dev ``` -------------------------------- ### 发送验证码接口示例 Source: https://kugoumusicapi-docs.4everland.app/ 向指定手机号发送验证码的接口调用示例。 ```http /captcha/sent?mobile=xxx ``` -------------------------------- ### Subscribe/Unsubscribe to Channel Source: https://kugoumusicapi-docs.4everland.app/ Allows users to subscribe to or unsubscribe from a channel. A parameter 't' controls the action: 1 for subscribe (default), 0 for unsubscribe. ```api /youth/channel/sub?global_collection_id=11576464149 ``` ```api /youth/channel/sub?global_collection_id=11576464149&t=0 ``` -------------------------------- ### Verify User Info with Captcha Source: https://kugoumusicapi-docs.4everland.app/ Verifies user information after passing a captcha. Requires event ID, verification type, verification code, session ID (sid), and edit data (edt). ```api /verify/user/info?eventid=gz_tx_event_xxx&v_type=xx&verifycode=xxx&sid=xxx&edt=xxx ``` -------------------------------- ### Identify Song from Audio Data Source: https://kugoumusicapi-docs.4everland.app/ Identifies song information by sending PCM audio data. ```APIDOC ## POST /audio/match ### Description Identifies song information by sending PCM audio data. ### Method POST ### Endpoint /audio/match ### Parameters #### Request Body - **data** (binary) - Required - PCM audio binary data (16-bit sampling) sent as `application/octet-stream`. ### Request Example ```javascript // Frontend example const res = await fetch('/audio/match', { method: 'POST', headers: { 'Content-Type': 'application/octet-stream' }, body: pcmArrayBuffer, }); ``` ``` -------------------------------- ### Send Verification Code Source: https://kugoumusicapi-docs.4everland.app/ Sends a verification code to a specified mobile number. This is a prerequisite for phone-based login. ```APIDOC ## POST /captcha/sent ### Description Sends a verification code to a specified mobile number. This is a prerequisite for phone-based login. ### Method POST ### Endpoint /captcha/sent ### Parameters #### Query Parameters - **mobile** (string) - Required - The mobile number to send the verification code to. ### Request Example ```json { "mobile": "xxx" } ``` ### Response #### Success Response (200) - **sent** (boolean) - Indicates if the verification code was sent successfully. ``` -------------------------------- ### WeChat Login - QR Code Creation Source: https://kugoumusicapi-docs.4everland.app/ Generates a UUID for WeChat login, which includes a base64 encoded QR code and a scan link. This endpoint may experience slow responses due to high request volume. ```APIDOC ## GET /login/wx/create ### Description Generates a UUID for WeChat login, which includes a base64 encoded QR code and a scan link. This endpoint may experience slow responses due to high request volume. ### Method GET ### Endpoint /login/wx/create ### Response #### Success Response (200) - **uuid** (string) - The UUID for WeChat login. - **qrimg** (string) - The base64 encoded QR code image. - **qrdata** (string) - The data for rendering the QR code. ``` -------------------------------- ### QR Code Login - Check Status Source: https://kugoumusicapi-docs.4everland.app/ Polls this endpoint to check the status of a QR code scan. It indicates whether the QR code is expired, waiting for scan, pending confirmation, or successfully authorized. ```APIDOC ## GET /login/qr/check ### Description Polls this endpoint to check the status of a QR code scan. It indicates whether the QR code is expired, waiting for scan, pending confirmation, or successfully authorized. ### Method GET ### Endpoint /login/qr/check ### Parameters #### Query Parameters - **key** (string) - Required - The key generated from the `/login/qr/key` endpoint. ### Response #### Success Response (200) - **code** (integer) - The status code: 0 (expired), 1 (waiting for scan), 2 (pending confirmation), 4 (authorized login successful). - **token** (string) - The authentication token (returned when code is 4). - **cookie** (string) - The user's session cookie (returned when code is 4). - **userid** (string) - The user ID (returned when code is 4). ``` -------------------------------- ### 手机登录接口示例 Source: https://kugoumusicapi-docs.4everland.app/ 使用手机号和验证码登录的接口调用示例。请确保已通过 `/captcha/sent` 接口获取验证码。 ```http /login/cellphone?mobile=xxx&code=xxx ``` -------------------------------- ### Refresh Login Status Source: https://kugoumusicapi-docs.4everland.app/ Refreshes the login status and extends the expiration time of the `token`. Both `token` and `userid` are optional parameters. ```APIDOC ## GET /login/token ### Description Refreshes the login status and extends the expiration time of the `token`. Both `token` and `userid` are optional parameters. ### Method GET ### Endpoint /login/token ### Parameters #### Query Parameters - **token** (string) - Optional - The authentication token obtained after login. - **userid** (string) - Optional - The user ID. ### Response #### Success Response (200) - **token** (string) - The refreshed authentication token. - **cookie** (string) - The user's session cookie. - **userid** (string) - The user ID. ``` -------------------------------- ### WeChat Login - Check Status Source: https://kugoumusicapi-docs.4everland.app/ Polls this endpoint to check the status of a WeChat QR code scan. It returns different codes indicating the scan status and login success. A `timestamp` is recommended to avoid caching issues. ```APIDOC ## GET /login/wx/check ### Description Polls this endpoint to check the status of a WeChat QR code scan. It returns different codes indicating the scan status and login success. A `timestamp` is recommended to avoid caching issues. ### Method GET ### Endpoint /login/wx/check ### Parameters #### Query Parameters - **uuid** (string) - Required - The UUID generated from the `/login/wx/create` endpoint. - **timestamp** (integer) - Optional - Recommended to avoid caching delays. ### Response #### Success Response (200) - **code** (integer) - The status code: 408 (waiting for scan), 404 (already scanned), 403 (login rejected), 405 (login successful), 402 (expired). - **wx_code** (string) - The `wx_code` returned upon successful login (405), used for open platform login. - **token** (string) - The authentication token (returned when code is 405). - **cookie** (string) - The user's session cookie (returned when code is 405). - **userid** (string) - The user ID (returned when code is 405). ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.