跳转到主要内容
当您向添加伴奏API提交任务时,可以使用callBackUrl参数设置回调URL。任务完成后,系统会自动将结果推送到您指定的地址。

回调机制概述

回调机制消除了轮询API查询任务状态的需要。系统会主动将任务完成结果推送到您的服务器。

回调时机

系统会在以下情况发送回调通知:
  • 文本生成完成(text阶段)
  • 第一个伴奏音轨生成完成(first阶段)
  • 所有伴奏音轨生成完成(complete阶段)
  • 伴奏生成任务失败
  • 任务处理过程中发生错误

回调方式

  • HTTP方法: POST
  • 内容类型: application/json
  • 超时时间: 15秒

回调请求格式

任务完成后,系统会向您的callBackUrl发送如下格式的POST请求:

状态码说明

code
integer
必填
回调状态码,表示任务处理结果:
msg
string
必填
状态消息,提供详细的状态描述
data.callbackType
string
必填
回调类型,表示当前回调阶段:
  • text: 文本生成完成
  • first: 第一个伴奏音轨生成完成
  • complete: 所有伴奏音轨生成完成
  • failed: 任务失败
data.task_id
string
必填
任务ID,与您提交任务时返回的taskId一致
data.data
array
伴奏生成结果信息,成功时返回
data.data[].id
string
音频唯一标识符
data.data[].audio_url
string
带伴奏元素的音频文件下载链接
data.data[].source_audio_url
string
原始源音频文件下载链接
data.data[].stream_audio_url
string
带伴奏元素的流式音频播放链接
data.data[].image_url
string
音乐封面图片链接
data.data[].prompt
string
用于伴奏生成的提示词
data.data[].model_name
string
用于伴奏生成的AI模型名称
data.data[].title
string
带伴奏元素的音乐标题
data.data[].tags
string
包含伴奏特征的音乐风格标签
data.data[].createTime
string
创建时间
data.data[].duration
number
音频时长(秒)

回调接收示例

以下是使用各种流行编程语言接收回调的示例代码:

最佳实践

伴奏生成回调配置建议

  1. 使用HTTPS: 确保回调URL使用HTTPS协议以保证数据传输安全
  2. 验证来源: 在回调处理中验证请求来源的合法性
  3. 幂等处理: 确保处理逻辑具有幂等性,因为相同taskId可能收到多次回调
  4. 快速响应: 回调处理应快速返回200状态码,避免超时
  5. 异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
  6. 分阶段处理: 针对不同回调阶段(text、first、complete)实施相应的业务逻辑
  7. 音频质量评估: 实施生成伴奏音轨的音频质量评估
  8. 风格验证: 验证生成的伴奏是否符合请求的风格和特征

重要提醒

  • 回调URL必须可公开访问
  • 服务器必须在15秒内响应,否则视为超时
  • 连续3次重试失败后,系统将停止发送回调
  • 确保回调处理逻辑的稳定性,避免因异常导致回调失败
  • 生成的伴奏音频URL可能有时效性,建议及时下载保存
  • 注意源音频质量以确保最佳的伴奏生成效果
  • 伴奏生成分为三个阶段,每个阶段都会触发回调通知
  • 考虑实施源文件的音频格式验证

故障排除

如果您没有收到回调通知,请检查以下项目:
  • 确认回调URL可从公网访问
  • 检查防火墙设置,确保入站请求不被阻止
  • 验证域名解析是否正确
  • 确保服务器在15秒内返回HTTP 200状态码
  • 检查服务器日志中的错误信息
  • 验证接口路径和HTTP方法是否正确
  • 确认接收到的POST请求体为JSON格式
  • 检查Content-Type是否为application/json
  • 验证JSON解析是否正确
  • 确认伴奏音频URL可访问
  • 检查伴奏音频下载权限和网络连通性
  • 验证音频保存路径和权限
  • 确保源音频格式受支持且有效
  • 验证伴奏质量是否符合您的应用要求
  • 理解三个回调阶段的差异和处理方法
  • text阶段:仅表示文本生成完成,无音频数据
  • first阶段:第一个伴奏音轨完成,包含一个音轨的数据
  • complete阶段:所有伴奏音轨完成,包含完整的伴奏音轨列表
  • 实施源文件的音频格式验证
  • 检查伴奏音频质量和格式兼容性
  • 评估生成的伴奏是否符合风格要求
  • 适当处理不同的伴奏风格和编排

替代方案

如果您无法使用回调机制,还可以使用轮询方式:

轮询查询结果

使用获取音乐生成详情接口定期查询任务状态。建议每30秒查询一次。