当您向WAV格式转换API提交任务时,可以使用 callBackUrl 参数设置回调URL。当任务完成时,系统会自动将结果推送到您指定的地址。
回调机制概述
回调机制免除了轮询API获取任务状态的需要。系统会主动将任务完成结果推送到您的服务器。
回调时机
系统会在以下情况发送回调通知:
- WAV格式转换完成
- WAV转换任务失败
- 任务处理过程中发生错误
WAV格式转换只有一个回调阶段,完成后直接提供下载URL
回调方法
- HTTP方法: POST
- Content Type: application/json
- 超时设置: 15秒
回调请求格式
当任务完成时,系统会按以下格式向您的 callBackUrl 发送POST请求:
{
"code": 200,
"msg": "success",
"data": {
"audioWavUrl": "https://example.com/s/04e6****e727.wav",
"task_id": "988e****c8d3"
}
}
状态码说明
回调状态码,表示任务处理结果:| 状态码 | 说明 |
|---|
| 200 | 成功 - WAV转换完成 |
| 400 | 请求错误 - 源音频无效或参数错误 |
| 401 | 未授权 - API密钥无效 |
| 429 | 积分不足 - 账户积分余额不足 |
| 500 | 服务器错误 - 请稍后重试 |
回调接收示例
以下是各种流行编程语言接收回调的示例代码:
const express = require('express');
const https = require('https');
const fs = require('fs');
const app = express();
app.use(express.json());
app.post('/wav-callback', (req, res) => {
const { code, msg, data } = req.body;
console.log('收到WAV转换回调:', {
taskId: data.task_id,
status: code,
message: msg
});
if (code === 200) {
// 转换成功
console.log('WAV转换完成');
console.log(`WAV文件URL: ${data.audioWavUrl}`);
// 下载WAV文件示例
if (data.audioWavUrl) {
const filename = `wav_${data.task_id}.wav`;
const file = fs.createWriteStream(filename);
https.get(data.audioWavUrl, (response) => {
response.pipe(file);
file.on('finish', () => {
file.close();
console.log(`WAV文件已下载为 ${filename}`);
// 可以进行后续处理
// 例如:音频分析、质量检测等
});
}).on('error', (err) => {
console.error('WAV文件下载失败:', err.message);
});
}
} else {
// 转换失败
console.log('WAV转换失败:', msg);
// 处理失败情况...
if (code === 400) {
console.log('源音频无效或参数错误');
} else if (code === 429) {
console.log('积分不足');
} else if (code === 500) {
console.log('服务器内部错误');
}
}
// 返回200状态码确认收到回调
res.status(200).json({ status: 'received' });
});
app.listen(3000, () => {
console.log('回调服务器运行在端口 3000');
});
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议,保证数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一个taskId可能收到多次回调,确保处理逻辑具有幂等性
- 快速响应: 回调处理应尽快返回200状态码,避免超时
- 异步下载: WAV文件下载应在异步任务中进行,避免阻塞回调响应
- 存储管理: WAV文件通常较大,合理规划存储空间
- 质量验证: 下载后验证文件完整性和音频质量
重要提醒
- 回调URL必须是公网可访问的地址
- 服务器必须在15秒内响应,否则视为超时
- 连续3次重试失败后,系统将停止发送回调
- 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
- WAV文件比MP3文件大得多,注意存储空间和下载带宽
- 生成的WAV文件将保留15天,建议及时下载保存
- WAV格式适合专业音频编辑和制作用途
故障排除
如果您没有收到回调通知,请检查以下几点:
- 确认回调URL能够从公网访问
- 检查防火墙设置,确保入站请求未被阻止
- 验证域名解析是否正确
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误信息
- 验证接口路径和HTTP方法是否正确
- 确认源音频ID是否有效
- 检查源音频是否存在和可访问
- 验证任务ID和音频ID的匹配关系
- 确认WAV文件URL是否可访问
- 检查下载权限和网络连接
- 验证文件保存路径和磁盘空间
- 注意WAV文件的大小和下载时间
替代方案
如果您无法使用回调机制,也可以使用轮询方式:
轮询查询结果
使用获取WAV转换详情接口定期查询任务状态。建议每30秒查询一次。