当您向Suno API的 /api/v1/generate/add-vocals 接口提交人声生成任务时,可以使用 callBackUrl 参数设置回调URL。任务完成时,系统将自动向您指定的地址推送结果。相关API接口#
添加人声接口
POST /api/v1/generate/add-vocals - 为上传的音乐文件添加人声回调机制概述#
Webhook 安全性:为确保回调请求的真实性和完整性,我们强烈建议您实现 webhook 签名验证。请参阅我们的 Webhook 校验指南 了解详细实现步骤。 回调机制消除了轮询API获取任务状态的需要。系统会主动向您的服务器推送任务完成结果。
回调时机#
文本生成完成(callbackType: "text")
第一个音频轨道生成完成(callbackType: "first")
所有音频轨道生成完成(callbackType: "complete")
回调方式#
回调请求格式#
当任务进行或完成时,系统将以下格式向您的 callBackUrl 发送POST请求:{
"code": 200,
"msg": "All generated successfully.",
"data": {
"callbackType": "complete",
"task_id": "2fac****9f72",
"data": [
{
"id": "e231****-****-****-****-****8cadc7dc",
"audio_url": "https://example.cn/****.mp3",
"stream_audio_url": "https://example.cn/****",
"image_url": "https://example.cn/****.jpeg",
"prompt": "[Verse] 夜晚城市 灯火辉煌",
"model_name": "chirp-v4-5",
"title": "钢铁侠",
"createTime": "2025-01-01 00:00:00",
"duration": 198.44
}
]
}
}
状态码说明#
| 状态码 | 说明 |
|---|
| 200 | 成功 - 请求已成功处理 |
| 400 | 验证错误 - 歌词包含受版权保护的内容 |
| 408 | 超出限制 - 超时 |
| 413 | 冲突 - 上传的音频与现有艺术作品匹配 |
| 500 | 服务器错误 - 处理请求时发生意外错误 |
| 501 | 音频生成失败 |
| 531 | 服务器错误 - 抱歉,由于问题生成失败。您的积分已退还。请重试 |
回调接收示例#
最佳实践#
回调URL配置建议#
1.
使用HTTPS: 确保您的回调URL使用HTTPS协议,保证数据传输安全
3.
幂等处理: 同一个task_id可能会收到多次回调,确保处理逻辑具有幂等性
4.
快速响应: 回调处理应尽快返回200状态码,避免超时
5.
异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
6.
阶段跟踪: 根据callbackType区分不同生成阶段,合理安排业务逻辑
重要提醒#
请确保回调处理逻辑的稳定性,避免因异常导致回调失败
注意处理不同callbackType的回调,特别是complete类型的最终结果
替代方案#
轮询查询结果
使用获取Cover详情端点定期查询任务状态。我们建议每30秒查询一次。