当您向歌词生成API提交任务时，可以使用 callBackUrl 参数设置回调URL。当任务完成时，系统会自动将结果推送到您指定的地址。
回调机制概述
回调机制无需轮询API查询任务状态，系统会主动将任务完成结果推送到您的服务器。
回调时机
系统会在以下情况发送回调通知：
- 歌词生成任务成功完成
- 歌词生成任务失败
- 任务处理过程中发生错误
回调方式
- HTTP方法: POST
- Content Type: application/json
- 超时设置: 15秒
回调请求格式
任务完成时，系统会向您的 callBackUrl 发送以下格式的POST请求：
{
"code": 200,
"msg": "All generated successfully.",
"data": {
"callbackType": "complete",
"taskId": "11dc****8b0f",
"data": [
{
"text": "[Verse]\n我穿越城市黑暗夜\n心中燃烧梦想的烈火",
"title": "钢铁侠",
"status": "complete",
"errorMessage": ""
},
{
"text": "[Verse]\n风在呼唤我名字\n钢铁盔甲闪得刺眼",
"title": "钢铁侠",
"status": "complete",
"errorMessage": ""
}
]
}
}
状态码说明
回调状态码，表示任务处理结果：| 状态码 | 说明 |
|---|
| 200 | 成功 - 歌词生成完成 |
| 400 | 请求错误 - 参数错误、内容违规等 |
| 451 | 下载失败 - 无法下载相关文件 |
| 500 | 服务器错误 - 请稍后重试 |
回调类型，表示当前回调的阶段：
complete: 歌词生成完成error: 任务失败
生成的歌词内容，包含歌曲结构标记（如[Verse]、[Chorus]等）
歌词生成状态：
complete: 生成完成failed: 生成失败
错误信息，当status为failed时包含具体错误描述
回调接收示例
以下是主流编程语言接收回调的示例代码：
const express = require('express');
const app = express();
app.use(express.json());
app.post('/generate-lyrics-callback', (req, res) => {
const { code, msg, data } = req.body;
console.log('收到歌词生成回调:', {
taskId: data.taskId,
callbackType: data.callbackType,
status: code,
message: msg
});
if (code === 200) {
// 任务成功完成
console.log('歌词生成完成');
const lyricsData = data.data || [];
console.log(`生成了 ${lyricsData.length} 个歌词变体:`);
lyricsData.forEach((lyrics, index) => {
console.log(`歌词变体 ${index + 1}:`);
console.log(` 标题: ${lyrics.title}`);
console.log(` 状态: ${lyrics.status}`);
if (lyrics.status === 'complete') {
console.log(` 歌词内容:\n${lyrics.text}`);
} else {
console.log(` 错误信息: ${lyrics.errorMessage}`);
}
});
// 处理生成的歌词
// 可以保存到数据库、文件等
} else {
// 任务失败
console.log('歌词生成失败:', msg);
// 处理失败情况...
if (code === 400) {
console.log('参数错误或内容违规');
} else if (code === 451) {
console.log('文件下载失败');
} else if (code === 500) {
console.log('服务器内部错误');
}
}
// 返回200状态码确认收到回调
res.status(200).json({ status: 'received' });
});
app.listen(3000, () => {
console.log('回调服务器运行在端口 3000');
});
from flask import Flask, request, jsonify
app = Flask(__name__)
@app.route('/generate-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('taskId')
callback_type = callback_data.get('callbackType')
lyrics_data = callback_data.get('data', [])
print(f"收到歌词生成回调: {task_id}, 类型: {callback_type}, 状态: {code}, 消息: {msg}")
if code == 200:
# 任务成功完成
print("歌词生成完成")
print(f"生成了 {len(lyrics_data)} 个歌词变体:")
for i, lyrics in enumerate(lyrics_data):
print(f"歌词变体 {i + 1}:")
print(f" 标题: {lyrics.get('title')}")
print(f" 状态: {lyrics.get('status')}")
if lyrics.get('status') == 'complete':
print(f" 歌词内容:\n{lyrics.get('text')}")
# 保存歌词到文件示例
try:
filename = f"lyrics_{task_id}_{i + 1}.txt"
with open(filename, "w", encoding="utf-8") as f:
f.write(f"标题: {lyrics.get('title')}\n\n")
f.write(lyrics.get('text'))
print(f"歌词已保存为 {filename}")
except Exception as e:
print(f"歌词保存失败: {e}")
else:
print(f" 错误信息: {lyrics.get('errorMessage')}")
else:
# 任务失败
print(f"歌词生成失败: {msg}")
# 处理失败情况...
if code == 400:
print("参数错误或内容违规")
elif code == 451:
print("文件下载失败")
elif code == 500:
print("服务器内部错误")
# 返回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['taskId'] ?? '';
$callbackType = $callbackData['callbackType'] ?? '';
$lyricsData = $callbackData['data'] ?? [];
error_log("收到歌词生成回调: $taskId, 类型: $callbackType, 状态: $code, 消息: $msg");
if ($code === 200) {
// 任务成功完成
error_log("歌词生成完成");
error_log("生成了 " . count($lyricsData) . " 个歌词变体:");
foreach ($lyricsData as $index => $lyrics) {
error_log("歌词变体 " . ($index + 1) . ":");
error_log(" 标题: " . ($lyrics['title'] ?? ''));
error_log(" 状态: " . ($lyrics['status'] ?? ''));
if (($lyrics['status'] ?? '') === 'complete') {
error_log(" 歌词内容:\n" . ($lyrics['text'] ?? ''));
// 保存歌词到文件示例
try {
$filename = "lyrics_{$taskId}_" . ($index + 1) . ".txt";
$content = "标题: " . ($lyrics['title'] ?? '') . "\n\n" . ($lyrics['text'] ?? '');
file_put_contents($filename, $content);
error_log("歌词已保存为 $filename");
} catch (Exception $e) {
error_log("歌词保存失败: " . $e->getMessage());
}
} else {
error_log(" 错误信息: " . ($lyrics['errorMessage'] ?? ''));
}
}
} else {
// 任务失败
error_log("歌词生成失败: $msg");
// 处理失败情况...
if ($code === 400) {
error_log("参数错误或内容违规");
} elseif ($code === 451) {
error_log("文件下载失败");
} elseif ($code === 500) {
error_log("服务器内部错误");
}
}
// 返回200状态码确认收到回调
http_response_code(200);
echo json_encode(['status' => 'received']);
?>
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议，保障数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一个taskId可能收到多次回调，确保处理逻辑是幂等的
- 快速响应: 回调处理应尽快返回200状态码，避免超时
- 异步处理: 复杂的业务逻辑应异步处理，避免阻塞回调响应
- 歌词存储: 歌词内容应及时保存到数据库或文件系统
重要提醒
- 回调URL必须是公网可访问的地址
- 服务器必须在15秒内响应，否则视为超时
- 连续3次重试失败后，系统将停止发送回调
- 请确保回调处理逻辑的稳定性，避免因异常导致回调失败
- 注意内容合规性，避免因违规导致生成失败
- 歌词内容可能包含特殊字符，注意编码处理
故障排查
如果您没有收到回调通知，请检查以下内容：
- 确认回调URL可以从公网访问
- 检查防火墙设置，确保不会阻拦入站请求
- 验证域名解析是否正确
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误信息
- 验证接口路径和HTTP方法是否正确
- 确认接收到的POST请求体为JSON格式
- 检查Content-Type是否为application/json
- 验证JSON解析是否正确
- 注意歌词内容可能包含换行符和特殊字符
- 确保文本编码处理正确（建议使用UTF-8）
- 验证歌词保存路径和权限
- 注意歌词内容是否符合内容政策
替代方案
如果您无法使用回调机制，也可以使用轮询方式：
轮询查询结果
使用获取歌词生成详情接口定时查询任务状态，建议每30秒查询一次。
