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