Skip to main content
当您向Suno API提交封面生成任务时,可以使用callBackUrl参数设置回调URL。当任务完成时,系统将自动将结果推送到您指定的地址。

回调机制概述

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

回调时机

系统将在以下情况下发送回调通知:
  • 封面生成任务成功完成
  • 封面生成任务失败
  • 任务处理过程中发生错误

回调方法

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

回调请求格式

当任务完成时,系统将向您的callBackUrl发送POST请求:

状态码说明

integer
必填
回调状态码,指示任务处理结果:
string
必填
状态消息,提供更详细的状态说明
string
必填
任务ID,与您提交任务时返回的taskId一致
array
生成的封面图像URL数组,成功时返回。通常包含2种不同风格的封面图像

回调接收示例

以下是常见编程语言中接收回调的示例代码:

最佳实践

回调URL配置建议

  1. 使用HTTPS: 确保回调URL使用HTTPS协议以确保数据传输安全
  2. 验证来源: 在回调处理中验证请求来源的合法性
  3. 幂等处理: 同一taskId可能收到多次回调,确保处理逻辑是幂等的
  4. 快速响应: 回调处理应快速返回200状态码以避免超时
  5. 异步处理: 复杂的业务逻辑应异步处理以避免阻塞回调响应
  6. 图像管理: 及时下载和保存图像,注意URL有效期
  7. 错误重试: 为失败的图像下载实现重试机制

重要提醒

  • 回调URL必须是公开可访问的地址
  • 服务器必须在15秒内响应,否则将被视为超时
  • 如果连续3次重试失败,系统将停止发送回调
  • 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
  • 封面图像URL可能有有效期,建议及时下载和保存
  • 通常生成2种不同风格的封面图像供选择
  • 注意处理图像下载失败时的异常

故障排除

如果您没有收到回调通知,请检查以下内容:
  • 确认回调URL可以从公网访问
  • 检查防火墙设置,确保入站请求未被阻止
  • 验证域名解析是否正确
  • 确保服务器在15秒内返回HTTP 200状态码
  • 检查服务器日志中的错误消息
  • 验证接口路径和HTTP方法是否正确
  • 确认接收到的POST请求体是JSON格式
  • 检查Content-Type是否为application/json
  • 验证JSON解析是否正确
  • 确认图像URL可访问
  • 检查图像下载权限和网络连接
  • 验证文件保存路径和权限
  • 注意图像URL有效期限制

替代方案

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

轮询查询结果

使用获取封面详情接口定期查询任务状态。我们建议每30秒查询一次。