基础信息
查看接口基本信息和返回格式
免责声明
接口描述
提交音乐或听书增量任务,成功返回task_id用于查询进度;minutes按10分钟取整,音乐10~1440,听书10~60且每日封顶60。
七日请求统计
接口地址
https://api.yunmge.com/api/qmusic-listen
请求方式
返回方式
返回预览
{"minutes":60}
计费标准
了解接口计费方式和套餐价格
接口类型
免费接口:本接口对所有用户免费开放,每日有一定免费调用次数,超出后可继续使用或升级会员。
计费方式
QPS限制
每分钟最多30次请求,每秒最多1次请求
每分钟最多60次请求,每秒最多5次请求
每日请求次数
普通用户不限制每日请求次数
会员用户不限制每日请求次数
计费规则
安全认证
了解接口的认证方式和访问凭证管理
实名认证
本接口对所有用户开放,无需实名认证即可访问
认证方式
通过 HTTP Header 传递认证信息
通过 URL 参数传递认证信息
Token 管理
登录账户
使用您的账号密码登录平台,获取用户凭证
获取 Token
即可查看你的 Token 密钥
更换 Token
进入个人中心,点击「更换Token」,系统将生成新的 Token 密钥
保存 Token
请妥善保管您的 Token 密钥,泄露时请立即更换
Token 怪谈
安全建议
- 定期更换密钥,建议每 90 天更新一次
- 发现密钥泄露,请立即在个人中心「更换」该密钥
- 不要将密钥硬编码在代码中,使用环境变量存储
参数文档
了解接口的请求参数和响应字段说明
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 否 | music | music | 提交听歌时长 |
minutes |
int | 是 | 无 | 10~1440 | 本次增加分钟数,按 10 分钟取整;今日剩余不足 10 分钟会报错 |
uin |
string | 否 | 无 | 无 | 不传返回已绑定账号列表;传入时必须等于当前 token 绑定的账号 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | 无 | book | 提交听书时长 |
minutes |
int | 是 | 无 | 10~60 | 本次增加分钟数,按 10 分钟取整;每日累计封顶 60 分钟,已听部分自动扣减 |
uin |
string | 否 | 无 | 无 | 不传返回已绑定账号列表;传入时必须等于当前 token 绑定的账号 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
task_id |
string | 是 | 无 | 无 | 提交成功后返回的任务 ID,用于轮询进度 |
uin |
string | 否 | 无 | 无 | 不传返回已绑定账号列表;传入时必须等于任务所属账号 |
响应参数
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 任务数据 |
|
│
├─
type
|
string | music / book |
|
│
├─
task_id
|
string | 任务 ID,用于查询进度 |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
minutes
|
int | 本次任务分钟数 |
|
│
├─
remaining_minutes
|
int | 提交前今日剩余可听分钟数(首次提交返回) |
|
│
├─
resumed
|
int | true=已有同类任务,直接返回进度;false=本次新提交 |
|
│
├─
kind
|
string | listen / audiobook / auto |
|
│
├─
status
|
string | pending / running / scheduled / waiting / done / failed |
|
│
├─
source
|
string | web / api / mcp |
|
│
├─
source_label
|
string | 后台 / 接口 / MCP |
|
│
├─
current
|
int | 当前进度(秒) |
|
│
├─
target
|
int | 目标进度(秒) |
|
│
├─
current_minutes
|
int | 当前进度(分钟) |
|
│
├─
target_minutes
|
int | 目标进度(分钟) |
|
│
├─
add_minutes
|
int | 本次任务分钟数 |
|
│
├─
progress_current_minutes
|
int | 本次任务已完成分钟数 |
|
│
├─
progress_target_minutes
|
int | 本次任务目标分钟数 |
|
│
├─
progress_percent
|
int | 本次任务进度百分比 |
|
│
├─
estimated_seconds
|
int | 预估剩余执行秒数 |
|
│
├─
estimated_minutes
|
int | 预估剩余执行分钟数(向上取整) |
|
│
├─
message
|
string | 任务状态说明 |
|
│
├─
created_at
|
string | 创建时间 |
|
│
└─
updated_at
|
string | 更新时间 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 任务数据 |
|
│
├─
type
|
string | music / book |
|
│
├─
task_id
|
string | 任务 ID,用于查询进度 |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
minutes
|
int | 本次任务分钟数 |
|
│
├─
remaining_minutes
|
int | 提交前今日剩余可听分钟数(首次提交返回) |
|
│
├─
resumed
|
bool | true=已有同类任务,直接返回进度;false=本次新提交 |
|
│
├─
kind
|
string | listen / audiobook / auto |
|
│
├─
status
|
string | pending / running / scheduled / waiting / done / failed |
|
│
├─
source
|
string | web / api / mcp |
|
│
├─
source_label
|
string | 后台 / 接口 / MCP |
|
│
├─
current
|
int | 当前进度(秒) |
|
│
├─
target
|
int | 目标进度(秒) |
|
│
├─
current_minutes
|
int | 当前进度(分钟) |
|
│
├─
target_minutes
|
int | 目标进度(分钟) |
|
│
├─
add_minutes
|
int | 本次任务分钟数 |
|
│
├─
progress_current_minutes
|
int | 本次任务已完成分钟数 |
|
│
├─
progress_target_minutes
|
int | 本次任务目标分钟数 |
|
│
├─
progress_percent
|
int | 本次任务进度百分比 |
|
│
├─
estimated_seconds
|
int | 预估剩余执行秒数 |
|
│
├─
estimated_minutes
|
int | 预估剩余执行分钟数(向上取整) |
|
│
├─
message
|
string | 任务状态说明 |
|
│
├─
created_at
|
string | 创建时间 |
|
│
└─
updated_at
|
string | 更新时间 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 任务数据 |
|
│
├─
type
|
string | music / book |
|
│
├─
task_id
|
string | 任务 ID,用于查询进度 |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
kind
|
string | listen / audiobook / auto |
|
│
├─
status
|
string | pending / running / scheduled / waiting / done / failed |
|
│
├─
source
|
string | web / api / mcp |
|
│
├─
source_label
|
string | 后台 / 接口 / MCP |
|
│
├─
current
|
int | 当前进度(秒) |
|
│
├─
target
|
int | 目标进度(秒) |
|
│
├─
current_minutes
|
int | 当前进度(分钟) |
|
│
├─
target_minutes
|
int | 目标进度(分钟) |
|
│
├─
add_minutes
|
int | 本次任务分钟数 |
|
│
├─
progress_current_minutes
|
int | 本次任务已完成分钟数 |
|
│
├─
progress_target_minutes
|
int | 本次任务目标分钟数 |
|
│
├─
progress_percent
|
int | 本次任务进度百分比 |
|
│
├─
estimated_seconds
|
int | 预估剩余执行秒数 |
|
│
├─
estimated_minutes
|
int | 预估剩余执行分钟数(向上取整) |
|
│
├─
message
|
string | 任务状态说明 |
|
│
├─
created_at
|
string | 创建时间 |
|
│
└─
updated_at
|
string | 更新时间 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 绑定数据 |
|
│
├─
bound
|
bool | 是否已绑定 |
|
│
accounts
|
array | 已绑定账号列表 |
|
│
│
├─
uin
|
string | 账号标识 |
|
│
│
├─
nickname
|
string | 昵称 |
|
│
│
├─
openid
|
string | 微信 openid(QQ 账号为空) |
|
│
│
└─
login_type
|
int | 1=微信,2=QQ |
状态码
了解接口返回的状态码含义及处理方式
接口状态码
| 状态码 | 说明 |
|---|---|
200 |
请求成功(新任务已提交、已有同类任务返回进度、任务查询或账号列表) |
201 |
提交或查询失败(后端返回错误;微信账号不支持听书上报) |
400 |
参数错误(type / minutes / task_id 不合法,或今日剩余不足 10 分钟) |
401 |
未绑定音乐账号(需先使用音乐账号登录接口登录并绑定) |
403 |
无权限(uin 不属于当前 token 绑定账号,或任务不属于当前账号) |
404 |
账号不存在或任务不存在 |
409 |
该账号已有未完成任务,请等待完成后再提交 |
服务器状态码
| 状态码 | 说明 |
|---|---|
500 |
服务器错误 |
501 |
请求接口不存在 |
502 |
请求接口已下架 |
503 |
请求接口维护中 |
504 |
缺少请求token参数 |
505 |
请求token不存在 |
506 |
请求token已被封禁 |
507 |
请求token额度不足 |
508 |
今日请求token已达上限 |
509 |
请求ip不在token白名单内 |
510 |
请求token无权使用当前接口 |
511 |
接口请求频率过高,请稍后再试 |
512 |
该接口未开启在线测试功能 |
513 |
今日在线测试次数已达上限 |
514 |
今日该接口请求次数已达上限 |
515 |
该接口为会员专属接口,请携带会员token |
516 |
该接口为会员专属接口,请开通会员 |
517 |
接口请求过于频繁,已被临时限制 |
518 |
该接口需要实名认证,请先完成实名认证 |
519 |
当前Token今日请求次数已达上限 |
520 |
当前Token已被禁止使用 |
521 |
请求token余额不足 |
522 |
请求token额度和余额均不足 |
530 |
接口服务异常,请稍后再试 |
531 |
接口响应超时,请稍后再试 |
532 |
接口暂时不可用,请稍后再试 |
533 |
接口配置异常 |
534 |
请求参数错误,请检查后重试 |
535 |
接口返回数据异常 |
在线测试
在线调试接口,实时查看响应结果
在线测试未开启
该接口暂未开启在线测试功能
示例代码
查看多种编程语言的接口调用示例
/**
* API请求DEMO-PHP
*
* 本demo支持GET与POST请求。
*/
//你申请的token密钥
$API_TOKEN = 'YOUR_TOKEN';
//API接口地址
$API_URL = 'https://api.yunmge.com/api/qmusic-listen';
$get_post_data = array(
'key' => 'value',
);
/*发起请求API接口:
第1个参数:API接口地址URL,跟上面的同名变量相对应,无需更改。
第2个参数:API接口参数数组,跟上面的同名变量相对应,无需更改。
第3个参数:请求协议(GET或POST),一般默认GET,部分接口需要POST请求,根据实际情况修改为POST即可。
*/
$resdata = api::send($API_URL, $get_post_data, 'GET/POST'); //发起请求,注意这里要选择接口支持的协议,默认GET,可选POST
//打印请求结果
print($resdata);
///////////////你的业务代码可写在这里处理API返回的数据
/**
* API请求类
*/
class api
{
public static function send($API_URL, $get_post_data, $type)
{
$get_post_data = http_build_query($get_post_data);
$res = self::send_curl($API_URL, $type, $get_post_data, null);
return $res;
}
//封装好的CURL请求函数,支持POST|GET
public static function send_curl($API_URL, $type, $get_post_data)
{
$ch = curl_init();
if ($type == 'POST') {
curl_setopt($ch, CURLOPT_URL, $API_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $get_post_data);
} elseif ($type == 'GET') {
curl_setopt($ch, CURLOPT_URL, $API_URL . '?' . $get_post_data);
}
curl_setopt($ch, CURLOPT_REFERER, $API_URL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$resdata = curl_exec($ch);
curl_close($ch);
return $resdata;
}
}
/**
* API请求DEMO-JavaScript
*
* 本demo支持GET与POST请求。
*/
//jQuery-Ajax
$.ajax({
url: 'https://api.yunmge.com/api/qmusic-listen',
data: {
key: 'value',
},
type: 'GET/POST', //请求协议(GET或POST),一般默认GET,部分接口需要POST请求,根据实际情况修改为POST即可。
dataType: 'json',
success: function(data) {
console.log(data); //请求成功,输出结果到控制台
},
timeout: 3000, //超时时间
error: function(data) {
console.log('请求失败'); //失败处理
}
});
/**
* API请求DEMO-NodeJs
*
* 本demo支持GET与POST请求。
*/
const https = require('https');
const querystring = require('querystring');
// 定义请求选项
const options = {
hostname: 'api.yunmge.com',
path: '/api/qmusic-listen',
method: 'GET/POST'
};
// 发送POST请求
const postData = querystring.stringify({
'key': 'value',
});
const postOptions = {
hostname: 'api.yunmge.com',
path: '/api/qmusic-listen',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': Buffer.byteLength(postData)
}
};
const postReq = https.request(postOptions, res => {
console.log(`statusCode: ${res.statusCode}`);
res.on('data', d => {
process.stdout.write(d);
});
});
postReq.on('error', error => {
console.error(error);
});
postReq.write(postData);
postReq.end();
import requests
url = "https://api.yunmge.com/api/qmusic-listen"
data = {
"key": "value",
}
response = requests.post(url, data=data)
print(response.json())
package main
import (
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strings"
)
func main() {
apiURL := "https://api.yunmge.com/api/qmusic-listen"
// POST请求
data := url.Values{}
data.Set("key", "value")
resp, err := http.Post(apiURL, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
if err != nil {
fmt.Println("请求失败:", err)
return
}
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
public class ApiRequest {
public static void main(String[] args) {
try {
String apiUrl = "https://api.yunmge.com/api/qmusic-listen";
URL url = new URL(apiUrl);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setDoOutput(true);
// 构建POST参数
StringBuilder postData = new StringBuilder();
postData.append("key=").append(URLEncoder.encode("value", "UTF-8"));
byte[] postDataBytes = postData.toString().getBytes("UTF-8");
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
try (OutputStream os = conn.getOutputStream()) {
os.write(postDataBytes);
}
BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
StringBuilder response = new StringBuilder();
while ((line = reader.readLine()) != null) {
response.append(line);
}
reader.close();
System.out.println(response.toString());
} catch (Exception e) {
e.printStackTrace();
}
}
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
class Program {
static async Task Main() {
string apiUrl = "https://api.yunmge.com/api/qmusic-listen";
using (HttpClient client = new HttpClient()) {
// POST请求
var formData = new Dictionary<string, string> {
{ "key", "value" },
};
var content = new FormUrlEncodedContent(formData);
HttpResponseMessage response = await client.PostAsync(apiUrl, content);
string result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
}
}
}
/**
* API请求DEMO-C
*
* 本demo支持GET与POST请求。
* 需要安装libcurl库
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h>
// API地址
const char* url = "https://api.yunmge.com/api/qmusic-listen";
// POST请求
void postRequest(CURL* curl) {
CURLcode res;
const char* postData = "key=value";
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, postData);
res = curl_easy_perform(curl);
if(res != CURLE_OK) {
fprintf(stderr, "curl_easy_perform() failed: %s\n", curl_easy_strerror(res));
}
}
int main() {
CURL* curl = curl_easy_init();
if(curl) {
postRequest(curl); curl_easy_cleanup(curl);
}
return 0;
}
/**
* API请求DEMO-C++
*
* 本demo支持GET与POST请求。
* 需要安装libcurl库
*/
#include <iostream>
#include <string>
#include <curl/curl.h>
int main() {
CURL* curl = curl_easy_init();
if(curl) {
std::string apiUrl = "https://api.yunmge.com/api/qmusic-listen";
// POST请求
std::string postData = "key=value";
curl_easy_setopt(curl, CURLOPT_URL, apiUrl.c_str());
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, postData.c_str());
CURLcode res = curl_easy_perform(curl);
if(res != CURLE_OK) {
std::cerr << "curl_easy_perform() failed: " << curl_easy_strerror(res) << std::endl;
}
curl_easy_cleanup(curl);
}
return 0;
}
.版本 2
.支持库 spec
.子程序 _启动子程序
.局部变量 url, 文本型
.局部变量 data, 文本型
.局部变量 result, 文本型
url = "https://api.yunmge.com/api/qmusic-listen"
data = "key=value"
result = 网页_访问 (url, 1, data, , , , , , , , , )
调试输出 (result)
常见问题
查找常见问题的解决方案
计费与注意事项
- 完全免费
常见问题
Q:为什么返回 resumed=true?
A:该账号已有同类型的未完成任务,接口直接返回当前进度,不重复提交、不扣费。
Q:minutes 是总量还是增量?
A:是增量,在当前今日已听基础上增加,并按 10 分钟取整。音乐范围 10~1440,听书范围 10~60。
Q:听书为什么只能提交 60 分钟?
A:听书每日累计封顶 60 分钟,系统会自动扣除今日已听部分;微信账号暂不支持听书上报。
Q:为什么返回 409?
A:账号已有未完成任务。先查询任务或等待完成,再提交新的任务。
Q:提交后多久完成?
A:音乐按每批 600 秒上报,约每 10 分钟一批;听书按章节推进。返回的 estimated_seconds/estimated_minutes 是预估耗时。
Q:接口提交会领取金币奖励吗?
A:不会。接口只提交听歌/听书时长,不参与金币任务领取。
Q:为什么 task_id 查询不到?
A:任务 ID 不存在、已被裁剪或不属于当前账号都会查询失败。任务记录只保留最近约 500 条。