当您向歌词生成API提交任务时,可以使用 callBackUrl 参数设置回调URL。当任务完成时,系统会自动将结果推送到您指定的地址。
回调机制概述
回调机制免除了轮询API获取任务状态的需要。系统会主动将任务完成结果推送到您的服务器。
回调时机
系统会在以下情况发送回调通知:
- 歌词生成完成(
complete 阶段)
- 歌词生成任务失败
- 任务处理过程中发生错误
与音乐生成不同,歌词生成只有一个回调阶段:complete(生成完成)
回调方法
- 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 | 请求错误 - 参数错误或内容违规 |
| 401 | 未授权 - API密钥无效 |
| 413 | 内容过长 - 提示词超出限制 |
| 429 | 积分不足 - 账户积分余额不足 |
| 500 | 服务器错误 - 请稍后重试 |
生成的歌词内容,包含歌词结构标记(如[Verse]、[Chorus]等)
生成状态:
complete: 生成成功
failed: 生成失败
错误消息,当状态为 failed 时提供具体错误信息
回调接收示例
以下是各种流行编程语言接收回调的示例代码:
const express = require('express');
const app = express();
app.use(express.json());
app.post('/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('歌词生成完成');
console.log(`共生成 ${data.data.length} 个歌词变体:`);
data.data.forEach((lyrics, index) => {
if (lyrics.status === 'complete') {
console.log(`歌词 ${index + 1}: ${lyrics.title}`);
console.log(`内容: ${lyrics.text.substring(0, 100)}...`);
// 处理生成的歌词
// 可以保存到数据库、文件等
} else if (lyrics.status === 'failed') {
console.log(`歌词 ${index + 1} 生成失败: ${lyrics.errorMessage}`);
}
});
} else {
// 任务失败
console.log('歌词生成失败:', msg);
// 处理失败情况...
if (code === 400) {
console.log('参数错误或内容违规');
} else if (code === 429) {
console.log('积分不足');
} else if (code === 500) {
console.log('服务器内部错误');
}
}
// 返回200状态码确认收到回调
res.status(200).json({ status: 'received' });
});
app.listen(3000, () => {
console.log('回调服务器运行在端口 3000');
});
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议,保证数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一个taskId可能收到多次回调,确保处理逻辑具有幂等性
- 快速响应: 回调处理应尽快返回200状态码,避免超时
- 异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
- 歌词存储: 及时保存生成的歌词内容,避免丢失
- 状态检查: 检查每个歌词的状态,处理成功和失败的情况
重要提醒
- 回调URL必须是公网可访问的地址
- 服务器必须在15秒内响应,否则视为超时
- 连续3次重试失败后,系统将停止发送回调
- 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
- 生成的歌词将保留15天,建议及时保存
- 注意内容合规,避免因违规导致生成失败
- 歌词生成只有一个回调阶段:
complete
故障排除
如果您没有收到回调通知,请检查以下几点:
- 确认回调URL能够从公网访问
- 检查防火墙设置,确保入站请求未被阻止
- 验证域名解析是否正确
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误信息
- 验证接口路径和HTTP方法是否正确
- 确认提示词是否符合内容政策
- 检查提示词长度是否超出限制(200字)
- 验证歌词内容是否包含敏感词汇
- 检查歌词状态字段,区分成功和失败的情况
- 验证歌词保存路径和权限
- 注意歌词格式,包含结构标记([Verse]、[Chorus]等)
替代方案
如果您无法使用回调机制,也可以使用轮询方式:
轮询查询结果
使用获取歌词生成详情接口定期查询任务状态。建议每30秒查询一次。