跳转到主要内容
当您向 Sora2API 提交视频生成任务时,可以使用 callBackUrl 参数设置回调URL。任务完成时,系统将自动向您指定的地址推送结果。

回调机制概述

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

回调时机

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

回调方式

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

回调请求格式

任务完成时,系统将以下格式向您的 callBackUrl 发送POST请求:
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "sora2_task_abcdef123456",
    "paramJson": "{\"prompt\":\"一只可爱的小猫在花园里玩耍,阳光明媚的春天\",\"imageUrls\":[\"https://example.com/image.jpg\"],\"aspectRatio\":\"16:9\",\"quality\":\"hd\",\"watermark\":\"我的水印\",\"callBackUrl\":\"https://api.example.com/callback\"}",
    "completeTime": "2024-03-20 10:30:00",
    "response": {
      "imageUrl": "https://cdn.sora2api.ai/videos/example_video.mp4"
    },
    "successFlag": 1,
    "errorCode": 0,
    "errorMessage": null,
    "createTime": "2024-03-20 10:25:00"
  }
}

状态码说明

code
integer
required
回调状态码,表示请求处理结果:
状态码描述
200成功 - 图像生成完成
500服务器错误 - 图像生成失败或其他内部错误
msg
string
required
状态消息,提供更详细的状态描述
data.taskId
string
required
任务ID,与您提交任务时返回的taskId一致
data.paramJson
string
required
调用参数JSON,包含原始请求参数的JSON字符串,可用于追踪生成请求的详细信息
data.completeTime
string
required
任务完成时间,格式:yyyy-MM-dd HH:mm:ss
data.response
object
required
最终结果对象
data.response.imageUrl
string
required
我们服务器的图片/视频URL,成功时包含可访问的下载链接
data.successFlag
integer
required
生成状态标志:
状态值描述
0生成中
1成功
2创建任务失败
3生成失败
data.errorCode
integer
错误码,成功时为 0
data.errorMessage
string
错误信息,成功时为 null
data.createTime
string
required
创建时间,格式:yyyy-MM-dd HH:mm:ss

回调接收示例

以下是常用编程语言接收回调的示例代码:
  • Node.js
  • Python
  • PHP
const express = require('express');
const app = express();

app.use(express.json());

app.post('/sora2-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('收到Sora2API视频生成回调:', {
    taskId: data.taskId,
    status: code,
    message: msg,
    successFlag: data.successFlag
  });
  
  if (code === 200 && data.successFlag === 1) {
    // 任务成功完成
    console.log('Sora2API视频生成完成');
    
    // 解析原始请求参数
    try {
      const params = JSON.parse(data.paramJson);
      console.log('原始提示词:', params.prompt);
      console.log('清晰度:', params.quality);
    } catch (e) {
      console.log('解析paramJson失败:', e);
    }
    
    // 处理生成的视频/图片
    const videoUrl = data.response?.imageUrl;
    if (videoUrl) {
      console.log('生成结果URL:', videoUrl);
      console.log('完成时间:', data.completeTime);
      
      // 下载和保存视频
      // 可以在这里添加视频下载逻辑
    }
    
  } else {
    // 任务失败
    console.log('Sora2API视频生成失败:', data.errorMessage || msg);
    console.log('错误码:', data.errorCode);
    
    // 处理失败情况...
  }
  
  // 返回200状态码确认收到回调
  res.status(200).json({ status: 'received' });
});

app.listen(3000, () => {
  console.log('回调服务器运行在端口3000');
});

最佳实践

回调URL配置建议

  1. 使用HTTPS: 确保回调URL使用HTTPS协议以保证数据传输安全
  2. 验证来源: 在回调处理中验证请求来源的合法性
  3. 幂等处理: 同一taskId可能收到多次回调,确保处理逻辑是幂等的
  4. 快速响应: 回调处理应尽快返回200状态码以避免超时
  5. 异步处理: 复杂的业务逻辑应异步处理以避免阻塞回调响应
  6. 状态检查: 通过 successFlag 字段判断任务状态,而不仅仅依赖 code 字段

重要提醒

  • 回调URL必须是公开可访问的地址
  • 服务器必须在15秒内响应,否则将被认为超时
  • 如果连续3次重试失败,系统将停止发送回调
  • 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
  • 生成的视频URL可能有时效性,建议及时下载保存
  • 注意处理 paramJson 字段,它包含了有用的原始请求信息
  • 检查 successFlag 字段判断任务真实状态(0-生成中,1-成功,2-创建任务失败,3-生成失败)

故障排查

如果您未收到回调通知,请检查以下内容:
  • 确认回调URL可以从公网访问
  • 检查防火墙设置,确保入站请求未被阻止
  • 验证域名解析是否正确
  • 确保服务器在15秒内返回HTTP 200状态码
  • 检查服务器日志是否有错误消息
  • 验证接口路径和HTTP方法是否正确
  • 确认收到的POST请求体为JSON格式
  • 检查Content-Type是否为application/json
  • 验证JSON解析是否正确
  • 确认视频URL是否可访问
  • 检查视频下载权限和网络连接
  • 验证视频保存路径和权限
  • 检查 response.imageUrl 字段是否包含有效的URL
  • 使用 successFlag 字段判断任务真实状态
  • code 为 200 只表示请求成功,不代表任务成功
  • successFlag 为 1 才表示任务生成成功
  • 检查 errorCode 和 errorMessage 了解失败原因

替代方案

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

轮询查询结果

使用获取Sora2API任务详情端点定期查询任务状态。我们建议每30秒查询一次。