> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.box/llms.txt
> Use this file to discover all available pages before exploring further.

# 音频分离回调

> 当人声和乐器分离生成完成时，系统会调用此回调通知结果。

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

## 回调机制概述

<Info>
  回调机制免除了轮询API获取任务状态的需要。系统会主动将任务完成结果推送到您的服务器。根据请求时指定的 `type` 参数，回调数据结构会有所不同。
</Info>

### 回调时机

系统会在以下情况发送回调通知：

* 人声分离完成
* 人声分离任务失败
* 任务处理过程中发生错误

<Note>
  人声分离只有一个回调阶段，但根据分离类型（`separate_vocal` 或 `split_stem`）会提供不同数量的分离音频文件URL
</Note>

### 回调方法

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

## 回调请求格式

当任务完成时，系统会按以下格式向您的 `callBackUrl` 发送POST请求。回调数据结构根据请求的 `type` 参数而异：

<CodeGroup>
  ```json separate_vocal 类型回调 theme={null}
  {
    "code": 200,
    "msg": "vocal Removal generated successfully.",
    "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"
      }
    }
  }
  ```

  ```json split_stem 类型回调 theme={null}
  {
    "code": 200,
    "msg": "vocal Removal generated successfully.",
    "data": {
      "task_id": "e649edb7abfd759285bd41a47a634b10",
      "vocal_removal_info": {
        "origin_url": "",
        "backing_vocals_url": "https://file.aiquickdraw.com/s/aadc51a3-4c88-4c8e-a4c8-e867c539673d_Backing_Vocals.mp3",
        "bass_url": "https://file.aiquickdraw.com/s/a3c2da5a-b364-4422-adb5-2692b9c26d33_Bass.mp3",
        "brass_url": "https://file.aiquickdraw.com/s/334b2d23-0c65-4a04-92c7-22f828afdd44_Brass.mp3",
        "drums_url": "https://file.aiquickdraw.com/s/ac75c5ea-ac77-4ad2-b7d9-66e140b78e44_Drums.mp3",
        "fx_url": "https://file.aiquickdraw.com/s/a8822c73-6629-4089-8f2a-d19f41f0007d_FX.mp3",
        "guitar_url": "https://file.aiquickdraw.com/s/064dd08e-d5d2-4201-9058-c5c40fb695b4_Guitar.mp3",
        "keyboard_url": "https://file.aiquickdraw.com/s/adc934e0-df7d-45da-8220-1dba160d74e0_Keyboard.mp3",
        "percussion_url": "https://file.aiquickdraw.com/s/0f70884d-047c-41f1-a6d0-7044618b7dc6_Percussion.mp3",
        "strings_url": "https://file.aiquickdraw.com/s/49829425-a5b0-424e-857a-75d4c63a426b_Strings.mp3",
        "synth_url": "https://file.aiquickdraw.com/s/56b2d94a-eb92-4d21-bc43-3460de0c8348_Synth.mp3",
        "vocal_url": "https://file.aiquickdraw.com/s/07420749-29a2-4054-9b62-e6a6f8b90ccb_Vocals.mp3",
        "woodwinds_url": "https://file.aiquickdraw.com/s/d81545b1-6f94-4388-9785-1aaa6ecabb02_Woodwinds.mp3"
      }
    }
  }
  ```

  ```json split_stem_advanced 类型回调 theme={null}
  {
    "code": 200,
    "msg": "vocal Removal generated successfully.",
    "data": {
      "task_id": "7220be2955295dda60de46ec6e4ead4c",
      "vocal_removal_info": {
        "origin_data": [
          {
            "extract": {
              "duration": 194.92,
              "audio_url": "https://tempfile.aiquickdraw.com/r/eb7d0f18-8349-4735-a65e-1812705d5ddf_Lead Vocal.mp3",
              "stem_type_group_name": "Lead Vocal",
              "id": "eb7d0f18-8349-4735-a65e-1812705d5ddf"
            },
            "remove": {
              "duration": 194.92,
              "audio_url": "https://tempfile.aiquickdraw.com/r/706d32df-e988-412e-bce4-42c9302e5478_Lead Vocal.mp3",
              "stem_type_group_name": "Lead Vocal",
              "id": "706d32df-e988-412e-bce4-42c9302e5478"
            }
          },
          {
            "extract": {
              "duration": 194.92,
              "audio_url": "https://tempfile.aiquickdraw.com/r/a7c503f6-1265-4f7e-bf5d-c50fb3b07238_Lead Vocal.mp3",
              "stem_type_group_name": "Lead Vocal",
              "id": "a7c503f6-1265-4f7e-bf5d-c50fb3b07238"
            },
            "remove": {
              "duration": 194.92,
              "audio_url": "https://tempfile.aiquickdraw.com/r/a3a0c954-1980-410f-9b34-8539b8eb23f8_Lead Vocal.mp3",
              "stem_type_group_name": "Lead Vocal",
              "id": "a3a0c954-1980-410f-9b34-8539b8eb23f8"
            }
          }
        ]
      }
    }
  }
  ```

  ```json 人声分离失败回调 theme={null}
  {
    "code": 400,
    "msg": "人声分离失败，源音频格式不支持",
    "data": {
      "task_id": "5e72d367bdfbe44785e28d72cb1697c7",
      "vocal_removal_info": null
    }
  }
  ```
</CodeGroup>

## 状态码说明

<ParamField path="code" type="integer" required>
  回调状态码，表示任务处理结果：

  | 状态码 | 说明                |
  | --- | ----------------- |
  | 200 | 成功 - 人声分离完成       |
  | 400 | 请求错误 - 源音频无效或参数错误 |
  | 401 | 未授权 - API密钥无效     |
  | 429 | 积分不足 - 账户积分余额不足   |
  | 500 | 服务器错误 - 请稍后重试     |
</ParamField>

<ParamField path="msg" type="string" required>
  状态消息，提供详细的状态描述
</ParamField>

<ParamField path="data.task_id" type="string" required>
  任务ID，与您提交任务时返回的taskId一致
</ParamField>

<ParamField path="data.vocal_removal_info" type="object">
  人声分离结果信息，成功时返回。字段根据分离类型而异
</ParamField>

### separate\_vocal 类型字段

<ParamField path="data.vocal_removal_info.origin_url" type="string">
  原始音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.vocal_url" type="string">
  分离出的人声音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.instrumental_url" type="string">
  分离出的伴奏音频文件URL（无人声）
</ParamField>

### split\_stem 类型字段

<ParamField path="data.vocal_removal_info.origin_url" type="string">
  原始音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.vocal_url" type="string">
  分离出的人声音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.backing_vocals_url" type="string">
  分离出的背景人声音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.drums_url" type="string">
  分离出的鼓声音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.bass_url" type="string">
  分离出的贝斯音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.guitar_url" type="string">
  分离出的吉他音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.keyboard_url" type="string">
  分离出的键盘音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.percussion_url" type="string">
  分离出的打击乐器音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.strings_url" type="string">
  分离出的弦乐器音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.synth_url" type="string">
  分离出的合成器音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.fx_url" type="string">
  分离出的音效音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.brass_url" type="string">
  分离出的铜管乐器音频文件URL
</ParamField>

<ParamField path="data.vocal_removal_info.woodwinds_url" type="string">
  分离出的木管乐器音频文件URL
</ParamField>

### split\_stem\_advanced 类型字段

<ParamField path="data.vocal_removal_info.origin_data" type="array">
  原始音频的分离结果数组，包含多个音轨组的提取和移除信息。每个元素代表一个独立的音轨组（如 Lead Vocal）。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].extract" type="object">
  提取出的指定音轨信息（保留该音轨，移除其他）。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].extract.duration" type="number">
  提取音频的时长，单位为秒。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].extract.audio_url" type="string">
  提取出的指定音轨音频文件的下载地址。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].extract.stem_type_group_name" type="string">
  音轨类型分组名称（如 Lead Vocal），表示该组提取的是哪种类型的音轨。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].extract.id" type="string">
  提取音频的唯一标识符。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].remove" type="object">
  移除指定音轨后的剩余音频信息（移除该音轨，保留其他）。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].remove.duration" type="number">
  移除后音频的时长，单位为秒。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].remove.audio_url" type="string">
  移除指定音轨后剩余音频文件的下载地址。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].remove.stem_type_group_name" type="string">
  音轨类型分组名称（如 Lead Vocal），与对应的 extract 保持一致。
</ParamField>

<ParamField path="data.vocal_removal_info.origin_data[].remove.id" type="string">
  移除后音频的唯一标识符。
</ParamField>

## 回调接收示例

以下是各种流行编程语言接收回调的示例代码，支持两种分离类型：

<Tabs>
  <Tab title="Node.js">
    ```javascript theme={null}
    const express = require('express');
    const https = require('https');
    const fs = require('fs');
    const path = require('path');
    const app = express();

    app.use(express.json());

    app.post('/vocal-removal-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;
        
        // 根据回调内容判断分离类型并下载相应文件
        let audioTypes = [];
        
        if (vocalInfo.instrumental_url) {
          // separate_vocal 类型
          audioTypes = [
            { name: 'original', url: vocalInfo.origin_url },
            { name: 'vocal', url: vocalInfo.vocal_url },
            { name: 'instrumental', url: vocalInfo.instrumental_url }
          ];
        } else {
          // split_stem 类型
          audioTypes = [
            { name: 'original', url: vocalInfo.origin_url },
            { name: 'vocal', url: vocalInfo.vocal_url },
            { name: 'backing_vocals', url: vocalInfo.backing_vocals_url },
            { name: 'drums', url: vocalInfo.drums_url },
            { name: 'bass', url: vocalInfo.bass_url },
            { name: 'guitar', url: vocalInfo.guitar_url },
            { name: 'keyboard', url: vocalInfo.keyboard_url },
            { name: 'percussion', url: vocalInfo.percussion_url },
            { name: 'strings', url: vocalInfo.strings_url },
            { name: 'synth', url: vocalInfo.synth_url },
            { name: 'fx', url: vocalInfo.fx_url },
            { name: 'brass', url: vocalInfo.brass_url },
            { name: 'woodwinds', url: vocalInfo.woodwinds_url }
          ];
        }
        
        // 下载所有分离后的音频文件
        audioTypes.forEach(audio => {
          if (audio.url) {
            const filename = `${data.task_id}_${audio.name}.mp3`;
            const file = fs.createWriteStream(filename);
            
            https.get(audio.url, (response) => {
              response.pipe(file);
              
              file.on('finish', () => {
                file.close();
                console.log(`${audio.name} 音频已下载为 ${filename}`);
              });
            }).on('error', (err) => {
              console.error(`${audio.name} 音频下载失败:`, err.message);
            });
          }
        });
        
      } else {
        // 分离失败
        console.log('人声分离失败:', 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');
    });
    ```
  </Tab>

  <Tab title="Python">
    ```python theme={null}
    from flask import Flask, request, jsonify
    import requests
    import os

    app = Flask(__name__)

    @app.route('/vocal-removal-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')
        vocal_info = callback_data.get('vocal_removal_info', {})
        
        print(f"收到人声分离回调: {task_id}, 状态: {code}")
        
        if code == 200 and vocal_info:
            # 分离成功
            print("人声分离完成")
            
            # 根据回调内容判断分离类型
            if vocal_info.get('instrumental_url'):
                # separate_vocal 类型
                audio_types = [
                    ('original', vocal_info.get('origin_url')),
                    ('vocal', vocal_info.get('vocal_url')),
                    ('instrumental', vocal_info.get('instrumental_url'))
                ]
            else:
                # split_stem 类型
                audio_types = [
                    ('original', vocal_info.get('origin_url')),
                    ('vocal', vocal_info.get('vocal_url')),
                    ('backing_vocals', vocal_info.get('backing_vocals_url')),
                    ('drums', vocal_info.get('drums_url')),
                    ('bass', vocal_info.get('bass_url')),
                    ('guitar', vocal_info.get('guitar_url')),
                    ('keyboard', vocal_info.get('keyboard_url')),
                    ('percussion', vocal_info.get('percussion_url')),
                    ('strings', vocal_info.get('strings_url')),
                    ('synth', vocal_info.get('synth_url')),
                    ('fx', vocal_info.get('fx_url')),
                    ('brass', vocal_info.get('brass_url')),
                    ('woodwinds', vocal_info.get('woodwinds_url'))
                ]
            
            # 下载所有分离后的音频文件
            for audio_name, audio_url in audio_types:
                if audio_url:
                    try:
                        response = requests.get(audio_url)
                        if response.status_code == 200:
                            filename = f"{task_id}_{audio_name}.mp3"
                            with open(filename, "wb") as f:
                                f.write(response.content)
                            
                            # 检查文件大小
                            file_size = os.path.getsize(filename)
                            print(f"{audio_name} 音频已下载为 {filename}, 大小: {file_size} bytes")
                            
                    except Exception as e:
                        print(f"{audio_name} 音频下载失败: {e}")
                        
        else:
            # 分离失败
            print(f"人声分离失败: {msg}")
            
            # 处理失败情况...
            if code == 400:
                print("源音频无效或参数错误")
            elif code == 429:
                print("积分不足")
            elif code == 500:
                print("服务器内部错误")
        
        # 返回200状态码确认收到回调
        return jsonify({'status': 'received'}), 200

    if __name__ == '__main__':
        app.run(host='0.0.0.0', port=3000)
    ```
  </Tab>

  <Tab title="PHP">
    ```php theme={null}
    <?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'] ?? '';
    $vocalInfo = $callbackData['vocal_removal_info'] ?? [];

    error_log("收到人声分离回调: $taskId, 状态: $code");

    if ($code === 200 && !empty($vocalInfo)) {
        // 分离成功
        error_log("人声分离完成");
        
        // 根据回调内容判断分离类型
        if (isset($vocalInfo['instrumental_url'])) {
            // separate_vocal 类型
            $audioTypes = [
                'original' => $vocalInfo['origin_url'] ?? '',
                'vocal' => $vocalInfo['vocal_url'] ?? '',
                'instrumental' => $vocalInfo['instrumental_url'] ?? ''
            ];
        } else {
            // split_stem 类型
            $audioTypes = [
                'original' => $vocalInfo['origin_url'] ?? '',
                'vocal' => $vocalInfo['vocal_url'] ?? '',
                'backing_vocals' => $vocalInfo['backing_vocals_url'] ?? '',
                'drums' => $vocalInfo['drums_url'] ?? '',
                'bass' => $vocalInfo['bass_url'] ?? '',
                'guitar' => $vocalInfo['guitar_url'] ?? '',
                'keyboard' => $vocalInfo['keyboard_url'] ?? '',
                'percussion' => $vocalInfo['percussion_url'] ?? '',
                'strings' => $vocalInfo['strings_url'] ?? '',
                'synth' => $vocalInfo['synth_url'] ?? '',
                'fx' => $vocalInfo['fx_url'] ?? '',
                'brass' => $vocalInfo['brass_url'] ?? '',
                'woodwinds' => $vocalInfo['woodwinds_url'] ?? ''
            ];
        }
        
        // 下载所有分离后的音频文件
        foreach ($audioTypes as $audioName => $audioUrl) {
            if ($audioUrl) {
                try {
                    $audioContent = file_get_contents($audioUrl);
                    if ($audioContent !== false) {
                        $filename = "{$taskId}_{$audioName}.mp3";
                        file_put_contents($filename, $audioContent);
                        
                        // 检查文件大小
                        $fileSize = filesize($filename);
                        error_log("$audioName 音频已下载为 $filename, 大小: $fileSize bytes");
                    }
                } catch (Exception $e) {
                    error_log("$audioName 音频下载失败: " . $e->getMessage());
                }
            }
        }
        
    } else {
        // 分离失败
        error_log("人声分离失败: $msg");
        
        // 处理失败情况...
        if ($code === 400) {
            error_log("源音频无效或参数错误");
        } elseif ($code === 429) {
            error_log("积分不足");
        } elseif ($code === 500) {
            error_log("服务器内部错误");
        }
    }

    // 返回200状态码确认收到回调
    http_response_code(200);
    echo json_encode(['status' => 'received']);
    ?>
    ```
  </Tab>
</Tabs>

## 最佳实践

<Tip>
  ### 回调URL配置建议

  1. **使用HTTPS**: 确保回调URL使用HTTPS协议，保证数据传输安全
  2. **验证来源**: 在回调处理中验证请求来源的合法性
  3. **幂等处理**: 同一个taskId可能收到多次回调，确保处理逻辑具有幂等性
  4. **快速响应**: 回调处理应尽快返回200状态码，避免超时
  5. **异步下载**: 多个音频文件下载应在异步任务中进行，避免阻塞回调响应
  6. **存储管理**: 合理规划存储空间，`split_stem` 类型会产生多达12个音频文件
  7. **质量验证**: 下载后验证每个文件的完整性和音频质量
  8. **分类存储**: 按音频类型（人声、伴奏、乐器等）分类存储文件
  9. **类型判断**: 根据回调内容自动判断分离类型，适配不同的处理逻辑
</Tip>

<Warning>
  ### 重要提醒

  * 回调URL必须是公网可访问的地址
  * 服务器必须在15秒内响应，否则视为超时
  * 连续3次重试失败后，系统将停止发送回调
  * 请确保回调处理逻辑的稳定性，避免因异常导致回调失败
  * 不同分离类型产生的文件数量差异很大：
    * `separate_vocal`：2-3个文件（人声、伴奏、可能的原始文件）
    * `split_stem`：最多12个文件（各种乐器分离）
  * 生成的分离文件将保留14天，建议及时下载保存
  * 分离质量取决于原始音轨的复杂度和音乐风格
  * 所有输出文件均为MP3格式，质量与原始文件相同
</Warning>

## 故障排除

如果您没有收到回调通知，请检查以下几点：

<AccordionGroup>
  <Accordion title="网络连接问题">
    * 确认回调URL能够从公网访问
    * 检查防火墙设置，确保入站请求未被阻止
    * 验证域名解析是否正确
  </Accordion>

  <Accordion title="服务器响应问题">
    * 确保服务器在15秒内返回HTTP 200状态码
    * 检查服务器日志是否有错误信息
    * 验证接口路径和HTTP方法是否正确
  </Accordion>

  <Accordion title="人声分离问题">
    * 确认源音频ID是否有效
    * 检查源音频格式是否支持分离
    * 验证任务ID和音频ID的匹配关系
    * 确认请求时是否正确设置了 `type` 参数
    * 注意某些音乐类型可能分离效果较差
  </Accordion>

  <Accordion title="文件下载问题">
    * 确认各个分离文件URL是否可访问
    * 检查下载权限和网络连接
    * 验证文件保存路径和磁盘空间
    * 注意同时下载多个文件可能需要较长时间
    * 检查是否有部分文件下载失败
    * `split_stem` 类型产生的文件较多，确保有足够的存储空间
  </Accordion>

  <Accordion title="分离类型识别问题">
    * 确认回调处理逻辑能正确识别两种分离类型
    * 检查是否正确处理了不同类型的字段结构
    * 验证文件命名和存储逻辑是否适配两种类型
  </Accordion>
</AccordionGroup>

## 替代方案

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

<Card title="轮询查询结果" icon="radar" href="/cn/suno-api/get-vocal-separation-details">
  使用获取人声分离详情接口定期查询任务状态。建议每30秒查询一次。
</Card>
