callBackUrl
参数设置回调URL。当任务完成时,系统会自动将结果推送到您指定的地址。
回调机制概述
回调机制免除了轮询API获取任务状态的需要。系统会主动将任务完成结果推送到您的服务器。
回调时机
系统会在以下情况发送回调通知:- 音乐视频生成完成
- 音乐视频生成任务失败
- 任务处理过程中发生错误
音乐视频生成只有一个回调阶段,完成后直接提供MP4视频下载URL
回调方法
- HTTP方法: POST
- Content Type: application/json
- 超时设置: 15秒
回调请求格式
当任务完成时,系统会按以下格式向您的callBackUrl
发送POST请求:
状态码说明
回调状态码,表示任务处理结果:
状态码 | 说明 |
---|---|
200 | 成功 - 音乐视频生成完成 |
400 | 请求错误 - 源音频无效或参数错误 |
401 | 未授权 - API密钥无效 |
429 | 积分不足 - 账户积分余额不足 |
500 | 服务器错误 - 请稍后重试 |
状态消息,提供详细的状态描述
任务ID,与您提交任务时返回的taskId一致
生成的MP4视频文件下载链接,成功时返回
回调接收示例
以下是各种流行编程语言接收回调的示例代码:- Node.js
- Python
- PHP
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议,保证数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一个taskId可能收到多次回调,确保处理逻辑具有幂等性
- 快速响应: 回调处理应尽快返回200状态码,避免超时
- 异步下载: 视频文件下载应在异步任务中进行,避免阻塞回调响应
- 存储管理: 视频文件通常较大,合理规划存储空间和带宽
- 质量验证: 下载后验证视频文件的完整性和播放质量
- 格式兼容: 考虑不同平台的视频格式兼容性需求
重要提醒
- 回调URL必须是公网可访问的地址
- 服务器必须在15秒内响应,否则视为超时
- 连续3次重试失败后,系统将停止发送回调
- 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
- 视频文件比音频文件大得多,注意存储空间和下载带宽
- 生成的视频文件将保留15天,建议及时下载保存
- 视频包含与音乐同步的视觉效果,适合社交媒体分享
- 视频保持与原始音轨相同的音频质量
故障排除
如果您没有收到回调通知,请检查以下几点:网络连接问题
网络连接问题
- 确认回调URL能够从公网访问
- 检查防火墙设置,确保入站请求未被阻止
- 验证域名解析是否正确
服务器响应问题
服务器响应问题
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误信息
- 验证接口路径和HTTP方法是否正确
视频生成问题
视频生成问题
- 确认源音频ID是否有效
- 检查音频文件是否存在和可访问
- 验证任务ID和音频ID的匹配关系
- 确认可选参数(author、domainName)格式正确
视频下载问题
视频下载问题
- 确认视频文件URL是否可访问
- 检查下载权限和网络连接
- 验证文件保存路径和磁盘空间
- 注意视频文件较大,下载可能需要较长时间
- 使用流式下载处理大文件
- 检查视频文件的完整性和播放质量
替代方案
如果您无法使用回调机制,也可以使用轮询方式:轮询查询结果
使用获取音乐视频详情接口定期查询任务状态。建议每30秒查询一次。