当您向人声分离API提交任务时,可以使用 callBackUrl 参数设置回调URL。当任务完成时,系统会自动将结果推送到您指定的地址。

回调机制概述

回调机制无需轮询API查询任务状态,系统会主动将任务完成结果推送到您的服务器。

回调时机

系统会在以下情况发送回调通知:
  • 人声分离任务成功完成
  • 人声分离任务失败
  • 任务处理过程中发生错误

回调方式

  • HTTP方法: POST
  • Content Type: application/json
  • 超时设置: 15秒

回调请求格式

任务完成时,系统会根据您选择的分离类型发送不同格式的回调数据:
{
  "code": 200,
  "data": {
    "task_id": "3e63b4cc88d52611159371f6af5571e7",
    "vocal_removal_info": {
      "instrumental_url": "https://file.aiquickdraw.com/s/d92a13bf-c6f4-4ade-bb47-f69738435528_Instrumental.mp3",
      "origin_url": "",
      "vocal_url": "https://file.aiquickdraw.com/s/3d7021c9-fa8b-4eda-91d1-3b9297ddb172_Vocals.mp3"
    }
  },
  "msg": "vocal Removal generated successfully."
}

状态码说明

code
integer
required
回调状态码,表示任务处理结果:
状态码说明
200成功 - 人声分离完成
400请求错误 - 参数错误、音频文件格式不支持等
451下载失败 - 无法下载源音频文件
500服务器错误 - 请稍后重试
msg
string
required
状态消息,提供详细的状态描述
data.task_id
string
required
任务ID,与您提交任务时返回的taskId一致
data.vocal_removal_info
object
人声分离结果信息,成功时返回

separate_vocal类型字段说明

data.vocal_removal_info.origin_url
string
原始混音音频文件URL
data.vocal_removal_info.instrumental_url
string
纯伴奏音频文件URL(去除人声)
data.vocal_removal_info.vocal_url
string
纯人声音频文件URL(去除伴奏)

split_stem类型字段说明

data.vocal_removal_info.origin_url
string
原始混音音频文件URL
data.vocal_removal_info.vocal_url
string
纯人声音频文件URL
data.vocal_removal_info.backing_vocals_url
string
和声部分音频文件URL
data.vocal_removal_info.drums_url
string
鼓声部分音频文件URL
data.vocal_removal_info.bass_url
string
贝斯部分音频文件URL
data.vocal_removal_info.guitar_url
string
吉他部分音频文件URL
data.vocal_removal_info.keyboard_url
string
键盘部分音频文件URL
data.vocal_removal_info.percussion_url
string
打击乐部分音频文件URL
data.vocal_removal_info.strings_url
string
弦乐部分音频文件URL
data.vocal_removal_info.synth_url
string
合成器部分音频文件URL
data.vocal_removal_info.fx_url
string
音效部分音频文件URL
data.vocal_removal_info.brass_url
string
铜管乐部分音频文件URL
data.vocal_removal_info.woodwinds_url
string
木管乐部分音频文件URL

回调接收示例

以下是主流编程语言接收回调的示例代码:
const express = require('express');
const app = express();

app.use(express.json());

app.post('/vocal-separation-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('收到人声分离回调:', {
    taskId: data.task_id,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // 任务成功完成
    console.log('人声分离完成');
    const vocalInfo = data.vocal_removal_info;
    
    if (vocalInfo) {
      console.log('分离结果:');
      console.log(`  原始音频: ${vocalInfo.origin_url}`);
      
      // 根据不同的分离类型处理不同的文件
      if (vocalInfo.instrumental_url) {
        // separate_vocal 类型
        console.log(`  纯伴奏: ${vocalInfo.instrumental_url}`);
        console.log(`  纯人声: ${vocalInfo.vocal_url}`);
      } else {
        // split_stem 类型
        console.log(`  人声: ${vocalInfo.vocal_url}`);
        console.log(`  和声: ${vocalInfo.backing_vocals_url}`);
        console.log(`  鼓声: ${vocalInfo.drums_url}`);
        console.log(`  贝斯: ${vocalInfo.bass_url}`);
        console.log(`  吉他: ${vocalInfo.guitar_url}`);
        console.log(`  键盘: ${vocalInfo.keyboard_url}`);
        console.log(`  打击乐: ${vocalInfo.percussion_url}`);
        console.log(`  弦乐: ${vocalInfo.strings_url}`);
        console.log(`  合成器: ${vocalInfo.synth_url}`);
        console.log(`  音效: ${vocalInfo.fx_url}`);
        console.log(`  铜管乐: ${vocalInfo.brass_url}`);
        console.log(`  木管乐: ${vocalInfo.woodwinds_url}`);
      }
      
      // 下载分离后的音频文件
      const https = require('https');
      const fs = require('fs');
      
      const downloadFile = (url, filename) => {
        if (!url) return;
        
        const file = fs.createWriteStream(filename);
        https.get(url, (response) => {
          response.pipe(file);
          file.on('finish', () => {
            file.close();
            console.log(`已保存: ${filename}`);
          });
        }).on('error', (err) => {
          console.error(`下载失败 ${filename}:`, err.message);
        });
      };
      
      // 下载所有可用的音频文件
      Object.keys(vocalInfo).forEach(key => {
        if (vocalInfo[key] && key.endsWith('_url')) {
          const filename = `${data.task_id}_${key.replace('_url', '')}.mp3`;
          downloadFile(vocalInfo[key], filename);
        }
      });
    }
    
  } 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');
});

最佳实践

回调URL配置建议

  1. 使用HTTPS: 确保回调URL使用HTTPS协议,保障数据传输安全
  2. 验证来源: 在回调处理中验证请求来源的合法性
  3. 幂等处理: 同一个taskId可能收到多次回调,确保处理逻辑是幂等的
  4. 快速响应: 回调处理应尽快返回200状态码,避免超时
  5. 异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
  6. 文件管理: 分离后的音频文件下载和处理应在异步任务中进行
  7. 类型判断: 根据返回字段判断分离类型,采用相应的处理逻辑

重要提醒

  • 回调URL必须是公网可访问的地址
  • 服务器必须在15秒内响应,否则视为超时
  • 连续3次重试失败后,系统将停止发送回调
  • 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
  • 生成的音频文件URL可能有时效限制,建议及时下载保存
  • split_stem 模式会产生更多文件,注意存储空间管理
  • 确保源音频文件包含对应的音乐成分以获得最佳分离效果
  • 不同分离类型的回调结构不同,需要相应的处理逻辑

故障排查

如果您没有收到回调通知,请检查以下内容:

替代方案

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

轮询查询结果

使用获取人声分离详情接口定时查询任务状态,建议每30秒查询一次。