当您向音乐视频生成API提交任务时，可以使用 callBackUrl 参数设置回调URL。当任务完成时，系统会自动将结果推送到您指定的地址。
回调机制概述
回调机制无需轮询API查询任务状态，系统会主动将任务完成结果推送到您的服务器。
回调时机
系统会在以下情况发送回调通知：
- 音乐视频生成任务成功完成
- 音乐视频生成任务失败
- 任务处理过程中发生错误
回调方式
- HTTP方法: POST
- Content Type: application/json
- 超时设置: 15秒
回调请求格式
任务完成时，系统会向您的 callBackUrl 发送以下格式的POST请求：
{
"code": 200,
"msg": "MP4 generated successfully.",
"data": {
"task_id": "taskId_774b9aa0422f",
"video_url": "https://example.com/videos/video_847715e66259.mp4"
}
}
状态码说明
回调状态码，表示任务处理结果：| 状态码 | 说明 |
|---|
| 200 | 成功 - 音乐视频生成完成 |
| 400 | 请求错误 - 参数错误、音频文件格式不支持等 |
| 451 | 下载失败 - 无法下载源音频文件 |
| 500 | 服务器错误 - 请稍后重试 |
回调接收示例
以下是主流编程语言接收回调的示例代码：
const express = require('express');
const app = express();
app.use(express.json());
app.post('/music-video-callback', (req, res) => {
const { code, msg, data } = req.body;
console.log('收到音乐视频生成回调:', {
taskId: data.task_id,
status: code,
message: msg
});
if (code === 200) {
// 任务成功完成
console.log('音乐视频生成完成');
console.log(`视频URL: ${data.video_url}`);
// 下载视频文件
if (data.video_url) {
const https = require('https');
const fs = require('fs');
const filename = `music_video_${data.task_id}.mp4`;
const file = fs.createWriteStream(filename);
https.get(data.video_url, (response) => {
response.pipe(file);
file.on('finish', () => {
file.close();
console.log(`视频文件已保存为 ${filename}`);
});
}).on('error', (err) => {
console.error('视频文件下载失败:', err.message);
});
}
} else {
// 任务失败
console.log('音乐视频生成失败:', msg);
// 处理失败情况...
if (code === 400) {
console.log('参数错误或音频文件格式不支持');
} else if (code === 451) {
console.log('源音频文件下载失败');
} else if (code === 500) {
console.log('服务器内部错误');
}
}
// 返回200状态码确认收到回调
res.status(200).json({ status: 'received' });
});
app.listen(3000, () => {
console.log('回调服务器运行在端口 3000');
});
from flask import Flask, request, jsonify
import requests
app = Flask(__name__)
@app.route('/music-video-callback', methods=['POST'])
def handle_callback():
data = request.json
code = data.get('code')
msg = data.get('msg')
callback_data = data.get('data', {})
task_id = callback_data.get('task_id')
video_url = callback_data.get('video_url')
print(f"收到音乐视频生成回调: {task_id}, 状态: {code}, 消息: {msg}")
if code == 200:
# 任务成功完成
print("音乐视频生成完成")
print(f"视频URL: {video_url}")
# 下载视频文件示例
if video_url:
try:
response = requests.get(video_url)
if response.status_code == 200:
filename = f"music_video_{task_id}.mp4"
with open(filename, "wb") as f:
f.write(response.content)
print(f"视频文件已保存为 {filename}")
except Exception as e:
print(f"视频文件下载失败: {e}")
else:
# 任务失败
print(f"音乐视频生成失败: {msg}")
# 处理失败情况...
if code == 400:
print("参数错误或音频文件格式不支持")
elif code == 451:
print("源音频文件下载失败")
elif code == 500:
print("服务器内部错误")
# 返回200状态码确认收到回调
return jsonify({'status': 'received'}), 200
if __name__ == '__main__':
app.run(host='0.0.0.0', port=3000)
<?php
header('Content-Type: application/json');
// 获取POST数据
$input = file_get_contents('php://input');
$data = json_decode($input, true);
$code = $data['code'] ?? null;
$msg = $data['msg'] ?? '';
$callbackData = $data['data'] ?? [];
$taskId = $callbackData['task_id'] ?? '';
$videoUrl = $callbackData['video_url'] ?? '';
error_log("收到音乐视频生成回调: $taskId, 状态: $code, 消息: $msg");
if ($code === 200) {
// 任务成功完成
error_log("音乐视频生成完成");
error_log("视频URL: $videoUrl");
// 下载视频文件示例
if ($videoUrl) {
try {
$videoContent = file_get_contents($videoUrl);
if ($videoContent !== false) {
$filename = "music_video_{$taskId}.mp4";
file_put_contents($filename, $videoContent);
error_log("视频文件已保存为 $filename");
}
} catch (Exception $e) {
error_log("视频文件下载失败: " . $e->getMessage());
}
}
} else {
// 任务失败
error_log("音乐视频生成失败: $msg");
// 处理失败情况...
if ($code === 400) {
error_log("参数错误或音频文件格式不支持");
} elseif ($code === 451) {
error_log("源音频文件下载失败");
} elseif ($code === 500) {
error_log("服务器内部错误");
}
}
// 返回200状态码确认收到回调
http_response_code(200);
echo json_encode(['status' => 'received']);
?>
最佳实践
回调URL配置建议
- 使用HTTPS: 确保回调URL使用HTTPS协议，保障数据传输安全
- 验证来源: 在回调处理中验证请求来源的合法性
- 幂等处理: 同一个taskId可能收到多次回调，确保处理逻辑是幂等的
- 快速响应: 回调处理应尽快返回200状态码，避免超时
- 异步处理: 复杂的业务逻辑应异步处理，避免阻塞回调响应
- 视频处理: 视频文件下载和处理应在异步任务中进行，避免阻塞回调响应
重要提醒
- 回调URL必须是公网可访问的地址
- 服务器必须在15秒内响应，否则视为超时
- 连续3次重试失败后，系统将停止发送回调
- 请确保回调处理逻辑的稳定性，避免因异常导致回调失败
- 生成的视频文件URL可能有时效限制，建议及时下载保存
- MP4视频文件较大，注意存储空间和下载时间
- 确保有足够的磁盘空间保存视频文件
- 视频生成时间可能较长，请耐心等待回调通知
故障排查
如果您没有收到回调通知，请检查以下内容：
- 确认回调URL可以从公网访问
- 检查防火墙设置，确保不会阻拦入站请求
- 验证域名解析是否正确
- 确保服务器在15秒内返回HTTP 200状态码
- 检查服务器日志是否有错误信息
- 验证接口路径和HTTP方法是否正确
- 确认接收到的POST请求体为JSON格式
- 检查Content-Type是否为application/json
- 验证JSON解析是否正确
- 确认视频文件URL是否可访问
- 检查视频下载权限和网络连接
- 验证视频保存路径和权限
- 注意视频文件大小，确保有足够存储空间
- 确认源音频文件格式是否受支持
- 检查网络带宽是否足够下载大文件
替代方案
如果您无法使用回调机制，也可以使用轮询方式：
轮询查询结果
使用获取音乐视频详情接口定时查询任务状态，建议每30秒查询一次。
