跳转到主要内容
当您向Suno API提交音乐分区替换任务时,可以使用 callBackUrl 参数设置回调URL。任务完成时,系统将自动向您指定的地址推送结果。

回调机制概述

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

回调时机

系统将在以下情况发送回调通知:
  • 音乐分区替换任务成功完成
  • 音乐分区替换任务失败
  • 任务处理过程中发生错误

回调方式

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

回调请求格式

任务完成时,系统将以下格式向您的 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-v3-5",
        "title": "替换后的标题",
        "tags": "electrifying, rock",
        "createTime": "2025-01-01 00:00:00",
        "duration": 198.44
      }
    ]
  }
}

状态码说明

code
integer
required
回调状态码,表示任务处理结果:
状态码描述
200成功 - 请求已成功处理
400验证错误 - 参数验证失败
408超出限制 - 超时
500服务器错误 - 处理请求时发生意外错误
501音频生成失败
531服务器错误 - 抱歉,由于问题生成失败。您的积分已退还。请重试
msg
string
required
状态消息,提供更详细的状态描述

响应数据字段

data
object
required
包含回调数据的容器对象
data.callbackType
string
required
回调类型,表示当前回调阶段:
类型描述
complete替换任务全部完成
error任务失败或发生错误
data.task_id
string
required
任务唯一标识符,用于追踪和查询
data.data
array
生成的音乐数据数组。成功时包含替换后的音乐详细信息,失败时为 null

实现回调处理器

以下示例展示如何实现回调处理器:
const express = require('express');
const app = express();

app.use(express.json());

app.post('/suno-replace-section-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('收到替换分区回调:', {
    taskId: data.task_id,
    type: data.callbackType,
    status: code
  });
  
  if (code === 200 && data.callbackType === 'complete') {
    // 替换任务成功完成
    const musicData = data.data;
    
    if (musicData && musicData.length > 0) {
      musicData.forEach((music, index) => {
        console.log(`替换后的音乐 ${index + 1}:`, {
          id: music.id,
          title: music.title,
          audioUrl: music.audio_url,
          duration: music.duration
        });
        
        // 处理替换后的音乐
        saveReplacedMusic(music);
      });
    }
  } else {
    // 替换任务失败
    console.error('替换分区失败:', msg);
    handleReplacementError(data.task_id, msg);
  }
  
  // 返回200确认收到回调
  res.status(200).json({ status: 'received' });
});

function saveReplacedMusic(music) {
  // 实现您的保存逻辑
  console.log('保存替换后的音乐:', music.title);
}

function handleReplacementError(taskId, errorMsg) {
  // 实现您的错误处理逻辑
  console.error(`任务 ${taskId} 失败:`, errorMsg);
}

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

回调安全建议

为确保回调的安全性,建议实施以下措施:
  1. 验证请求来源:检查请求IP或使用签名验证
  2. 使用HTTPS:确保回调URL使用HTTPS协议
  3. 实现幂等性:处理可能的重复回调
  4. 超时处理:确保在15秒内响应回调请求
  5. 错误日志:记录所有回调详情以便调试

常见问题

可能的原因:
  • 回调URL不可访问(检查防火墙设置)
  • 回调处理器响应超时(超过15秒)
  • URL格式错误或使用了HTTP而非HTTPS
  • 服务器返回了非200状态码
系统可能会在以下情况重试回调:
  • 回调URL返回非200状态码
  • 请求超时
  • 网络错误
建议:
  • 实现幂等性处理,使用task_id识别重复回调
  • 快速响应200状态码,然后异步处理数据
  • 建议替换时长不超过原音乐总时长的50%
  • 最小替换时长建议至少2秒
  • 替换片段会自动与原音乐融合

替代方案:轮询查询

如果您不使用回调,也可以通过轮询方式查询任务状态:

查询任务状态

使用获取音乐详情接口定期查询任务状态,建议每30秒查询一次。

下一步