当您向Suno API提交歌词生成任务时，可以使用 callBackUrl 参数设置回调URL。任务完成时，系统将自动向您指定的地址推送结果。
回调机制概述
回调机制消除了轮询API获取任务状态的需要。系统会主动向您的服务器推送任务完成结果。
回调时机
系统将在以下情况发送回调通知：
- 歌词生成任务成功完成
- 歌词生成任务失败
- 任务处理过程中发生错误
回调方式
- HTTP方法: POST
- 内容类型: application/json
- 超时设置: 15秒
回调请求格式
任务完成时，系统将以下格式向您的 callBackUrl 发送POST请求：
{
"code": 200,
"msg": "All generated successfully.",
"data": {
"callbackType": "complete",
"task_id": "3b66882fde0a5d398bd269cab6d9542b",
"data": [
{
"error_message": "",
"status": "complete",
"text": "[Verse]\n月光洒满了窗台...",
"title": "星夜狂想"
}
]
}
}
状态码说明
回调状态码，表示任务处理结果：| 状态码 | 描述 |
|---|
| 200 | 成功 - 请求已成功处理 |
| 400 | 验证错误 - 歌词包含受版权保护的内容 |
| 408 | 超出限制 - 超时 |
| 413 | 冲突 - 上传的音频与现有艺术作品匹配 |
| 500 | 服务器错误 - 处理请求时发生意外错误 |
| 501 | 歌词生成失败 |
| 531 | 服务器错误 - 抱歉，由于问题生成失败。您的积分已退还。请重试 |
生成状态：
- complete - 生成成功
- failed - 生成失败
data.data[].error_message
错误信息，仅当状态为 failed 时有值
回调接收示例
以下是常用编程语言接收回调的示例代码：
const express = require('express');
const app = express();
app.use(express.json());
app.post('/suno-lyrics-callback', (req, res) => {
const { code, msg, data } = req.body;
console.log('收到歌词回调:', {
taskId: data.task_id,
status: code,
message: msg,
callbackType: data.callbackType
});
if (code === 200) {
// 任务成功完成
console.log('歌词生成完成:', data.data);
// 处理生成的歌词数据
data.data.forEach(lyrics => {
if (lyrics.status === 'complete') {
console.log(`歌词标题: ${lyrics.title}`);
console.log(`歌词内容: ${lyrics.text}`);
} else if (lyrics.status === 'failed') {
console.log(`歌词生成失败: ${lyrics.error_message}`);
}
});
} else {
// 任务失败
console.log('任务失败:', msg);
// 处理失败情况...
}
// 返回200状态码确认收到回调
res.status(200).json({ status: 'received' });
});
app.listen(3000, () => {
console.log('回调服务器运行在端口3000');
});
from flask import Flask, request, jsonify
import json
app = Flask(__name__)
@app.route('/suno-lyrics-callback', methods=['POST'])
def handle_callback():
data = request.json
code = data.get('code')
msg = data.get('msg')
callback_data = data.get('data', {})
task_id = callback_data.get('task_id')
callback_type = callback_data.get('callbackType')
print(f"收到歌词回调: {task_id}, 状态: {code}, 类型: {callback_type}, 消息: {msg}")
if code == 200:
# 任务成功完成
lyrics_list = callback_data.get('data', [])
print(f"歌词生成完成，共生成 {len(lyrics_list)} 首歌词")
for lyrics in lyrics_list:
if lyrics['status'] == 'complete':
print(f"歌词标题: {lyrics['title']}")
print(f"歌词内容: {lyrics['text']}")
elif lyrics['status'] == 'failed':
print(f"歌词生成失败: {lyrics['error_message']}")
else:
# 任务失败
print(f"任务失败: {msg}")
# 处理失败情况...
# 返回200状态码确认收到回调
return jsonify({'status': 'received'}), 200
if __name__ == '__main__':
app.run(host='0.0.0.0', port=3000)
<?php
header('Content-Type: application/json');
// 获取POST数据
$input = file_get_contents('php://input');
$data = json_decode($input, true);
$code = $data['code'] ?? null;
$msg = $data['msg'] ?? '';
$callbackData = $data['data'] ?? [];
$taskId = $callbackData['task_id'] ?? '';
$callbackType = $callbackData['callbackType'] ?? '';
error_log("收到歌词回调: $taskId, 状态: $code, 类型: $callbackType, 消息: $msg");
if ($code === 200) {
// 任务成功完成
$lyricsList = $callbackData['data'] ?? [];
error_log("歌词生成完成，共生成 " . count($lyricsList) . " 首歌词");
foreach ($lyricsList as $lyrics) {
if ($lyrics['status'] === 'complete') {
error_log("歌词标题: " . $lyrics['title']);
error_log("歌词内容: " . $lyrics['text']);
} elseif ($lyrics['status'] === 'failed') {
error_log("歌词生成失败: " . $lyrics['error_message']);
}
}
} else {
// 任务失败
error_log("任务失败: $msg");
// 处理失败情况...
}
// 返回200状态码确认收到回调
http_response_code(200);
echo json_encode(['status' => 'received']);
?>
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议以保证数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一task_id可能收到多次回调，确保处理逻辑是幂等的
- 快速响应: 回调处理应尽快返回200状态码以避免超时
- 异步处理: 复杂的业务逻辑应异步处理以避免阻塞回调响应
- 状态检查: 检查每个歌词项的status字段，区分成功和失败的情况
重要提醒
- 回调URL必须是公开可访问的地址
- 服务器必须在15秒内响应，否则将被认为超时
- 如果连续3次重试失败，系统将停止发送回调
- 请确保回调处理逻辑的稳定性，避免因异常导致回调失败
- 注意处理歌词生成失败的情况，检查error_message字段获取具体错误信息
故障排查
如果您未收到回调通知，请检查以下内容：
- 确认回调URL可以从公网访问
- 检查防火墙设置，确保入站请求未被阻止
- 验证域名解析是否正确
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误消息
- 验证接口路径和HTTP方法是否正确
- 确认收到的POST请求体为JSON格式
- 检查Content-Type是否为application/json
- 验证JSON解析是否正确
- 确认正确处理歌词的status字段
- 检查是否遗漏了failed状态的歌词处理
- 验证歌词内容解析是否正确
替代方案
如果您无法使用回调机制，也可以使用轮询方式：
轮询查询结果
使用获取歌词详情端点定期查询任务状态。我们建议每30秒查询一次。
