callBackUrl 参数设置回调URL。任务完成时,系统将自动向您指定的地址推送结果。
回调机制概述
回调机制消除了轮询API获取任务状态的需要。系统会主动向您的服务器推送任务完成结果。
回调时机
系统将在以下情况发送回调通知:- 音乐生成任务成功完成
- 音乐生成任务失败
- 任务处理过程中发生错误
回调方式
- HTTP方法: POST
- 内容类型: application/json
- 超时设置: 15秒
回调请求格式
任务完成时,系统将以下格式向您的callBackUrl 发送POST请求:
状态码说明
回调状态码,表示任务处理结果:
| 状态码 | 描述 |
|---|---|
| 200 | 成功 - 请求已成功处理 |
| 400 | 验证错误 - 歌词包含受版权保护的内容 |
| 408 | 超出限制 - 超时 |
| 413 | 冲突 - 上传的音频与现有艺术作品匹配 |
| 500 | 服务器错误 - 处理请求时发生意外错误 |
| 501 | 音频生成失败 |
| 531 | 服务器错误 - 抱歉,由于问题生成失败。您的积分已退还。请重试 |
状态消息,提供更详细的状态描述
回调类型:
- text - 文本生成完成
- first - 第一首生成完成
- complete - 全部生成完成
- error - 生成失败
任务ID,与您提交任务时返回的task_id一致
生成的音频数据数组,成功时返回
音频唯一标识
音频文件URL
流式音频URL
封面图片URL
生成提示词/歌词
使用的模型名称
音乐标题
音乐标签
创建时间
音频时长(秒)
回调接收示例
以下是常用编程语言接收回调的示例代码:- Node.js
- Python
- PHP
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议以保证数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一task_id可能收到多次回调,确保处理逻辑是幂等的
- 快速响应: 回调处理应尽快返回200状态码以避免超时
- 异步处理: 复杂的业务逻辑应异步处理以避免阻塞回调响应
- 状态跟踪: 根据callbackType区分不同的生成阶段,合理安排业务逻辑
重要提醒
- 回调URL必须是公开可访问的地址
- 服务器必须在15秒内响应,否则将被认为超时
- 如果连续3次重试失败,系统将停止发送回调
- 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
- 注意处理不同callbackType的回调,特别是complete类型的最终结果
故障排查
如果您未收到回调通知,请检查以下内容:网络连接问题
网络连接问题
- 确认回调URL可以从公网访问
- 检查防火墙设置,确保入站请求未被阻止
- 验证域名解析是否正确
服务器响应问题
服务器响应问题
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误消息
- 验证接口路径和HTTP方法是否正确
内容格式问题
内容格式问题
- 确认收到的POST请求体为JSON格式
- 检查Content-Type是否为application/json
- 验证JSON解析是否正确
回调类型处理
回调类型处理
- 确认正确处理不同的callbackType
- 检查是否遗漏了complete类型的最终结果处理
- 验证音频数据解析是否正确
替代方案
如果您无法使用回调机制,也可以使用轮询方式:轮询查询结果
使用获取音乐详情端点定期查询任务状态。我们建议每30秒查询一次。
