> ## 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.

# 上传并翻唱音频回调

> 当上传并翻唱音频任务完成时，系统会通过POST请求将结果发送到您提供的回调URL

当您向上传并翻唱音频API提交任务时，可以使用 `callBackUrl` 参数设置回调URL。当任务完成时，系统会自动将结果推送到您指定的地址。

## 回调机制概述

<Info>
  回调机制免除了轮询API获取任务状态的需要。系统会主动将任务完成结果推送到您的服务器。
</Info>

### 回调时机

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

* 文本生成完成（`text` 阶段）
* 第一首翻唱音频完成（`first` 阶段）
* 所有翻唱音频完成（`complete` 阶段）
* 翻唱任务失败
* 任务处理过程中发生错误

### 回调方法

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

## 回调请求格式

当任务完成时，系统会按以下格式向您的 `callBackUrl` 发送POST请求：

<CodeGroup>
  ```json 文本生成完成回调 theme={null}
  {
    "code": 200,
    "msg": "Text generation completed successfully.",
    "data": {
      "callbackType": "text",
      "task_id": "2fac****9f72",
      "data": []
    }
  }
  ```

  ```json 第一首完成回调 theme={null}
  {
    "code": 200,
    "msg": "First track covered successfully.",
    "data": {
      "callbackType": "first",
      "task_id": "2fac****9f72",
      "data": [
        {
          "id": "8551****662c",
          "audio_url": "https://example.cn/****.mp3",
          "source_audio_url": "https://example.cn/****.mp3",
          "stream_audio_url": "https://example.cn/****",
          "source_stream_audio_url": "https://example.cn/****",
          "image_url": "https://example.cn/****.jpeg",
          "source_image_url": "https://example.cn/****.jpeg",
          "prompt": "[Verse] 优美的翻唱旋律",
          "model_name": "chirp-v3-5",
          "title": "经典翻唱版",
          "tags": "cover, acoustic",
          "createTime": "2025-01-01 00:00:00",
          "duration": 198.44
        }
      ]
    }
  }
  ```

  ```json 全部完成回调 theme={null}
  {
    "code": 200,
    "msg": "All covered successfully.",
    "data": {
      "callbackType": "complete",
      "task_id": "2fac****9f72",
      "data": [
        {
          "id": "8551****662c",
          "audio_url": "https://example.cn/****.mp3",
          "source_audio_url": "https://example.cn/****.mp3",
          "stream_audio_url": "https://example.cn/****",
          "source_stream_audio_url": "https://example.cn/****",
          "image_url": "https://example.cn/****.jpeg",
          "source_image_url": "https://example.cn/****.jpeg",
          "prompt": "[Verse] 优美的翻唱旋律",
          "model_name": "chirp-v3-5",
          "title": "经典翻唱版",
          "tags": "cover, acoustic",
          "createTime": "2025-01-01 00:00:00",
          "duration": 198.44
        },
        {
          "id": "bd15****1873",
          "audio_url": "https://example.cn/****.mp3",
          "source_audio_url": "https://example.cn/****.mp3",
          "stream_audio_url": "https://example.cn/****",
          "source_stream_audio_url": "https://example.cn/****",
          "image_url": "https://example.cn/****.jpeg",
          "source_image_url": "https://example.cn/****.jpeg",
          "prompt": "[Verse] 优美的翻唱旋律",
          "model_name": "chirp-v3-5",
          "title": "经典翻唱版",
          "tags": "cover, acoustic",
          "createTime": "2025-01-01 00:00:00",
          "duration": 228.28
        }
      ]
    }
  }
  ```

  ```json 失败回调 theme={null}
  {
    "code": 400,
    "msg": "翻唱失败，上传的音频格式不支持",
    "data": {
      "callbackType": "failed",
      "task_id": "2fac****9f72",
      "data": []
    }
  }
  ```
</CodeGroup>

## 状态码说明

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

  | 状态码 | 说明                  |
  | --- | ------------------- |
  | 200 | 成功 - 翻唱完成           |
  | 400 | 请求错误 - 参数错误或音频格式不支持 |
  | 401 | 未授权 - API密钥无效       |
  | 413 | 内容过长 - 音频文件过大或时长超限  |
  | 429 | 积分不足 - 账户积分余额不足     |
  | 500 | 服务器错误 - 请稍后重试       |
</ParamField>

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

<ParamField path="data.callbackType" type="string" required>
  回调类型，表示当前回调阶段：

  * `text`: 文本生成完成
  * `first`: 第一首翻唱完成
  * `complete`: 所有翻唱完成
  * `failed`: 任务失败
</ParamField>

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

<ParamField path="data.data" type="array">
  翻唱结果信息，成功时返回
</ParamField>

<ParamField path="data.data[].id" type="string">
  音频唯一标识
</ParamField>

<ParamField path="data.data[].audio_url" type="string">
  翻唱后的音频文件下载链接
</ParamField>

<ParamField path="data.data[].source_audio_url" type="string">
  原始音频文件下载链接
</ParamField>

<ParamField path="data.data[].stream_audio_url" type="string">
  流式音频播放链接
</ParamField>

<ParamField path="data.data[].image_url" type="string">
  音乐封面图片链接
</ParamField>

<ParamField path="data.data[].prompt" type="string">
  翻唱时使用的提示词/歌词
</ParamField>

<ParamField path="data.data[].model_name" type="string">
  使用的AI模型名称
</ParamField>

<ParamField path="data.data[].title" type="string">
  音乐标题
</ParamField>

<ParamField path="data.data[].tags" type="string">
  音乐风格标签
</ParamField>

<ParamField path="data.data[].createTime" type="string">
  创建时间
</ParamField>

<ParamField path="data.data[].duration" type="number">
  翻唱后的音频时长（秒）
</ParamField>

## 最佳实践

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

  1. **使用HTTPS**: 确保回调URL使用HTTPS协议，保证数据传输安全
  2. **验证来源**: 在回调处理中验证请求来源的合法性
  3. **幂等处理**: 同一个taskId可能收到多次回调，确保处理逻辑具有幂等性
  4. **快速响应**: 回调处理应尽快返回200状态码，避免超时
  5. **异步处理**: 复杂的业务逻辑应异步处理，避免阻塞回调响应
  6. **分阶段处理**: 根据不同的回调阶段进行相应的业务处理
  7. **音频对比**: 对比翻唱前后的音频效果变化
  8. **上传验证**: 确保上传的音频文件质量和格式符合要求
</Tip>

<Warning>
  ### 重要提醒

  * 回调URL必须是公网可访问的地址
  * 服务器必须在15秒内响应，否则视为超时
  * 连续3次重试失败后，系统将停止发送回调
  * 请确保回调处理逻辑的稳定性，避免因异常导致回调失败
  * 翻唱后的音频URL可能有时效限制，建议及时下载保存
  * 上传的音频文件不得超过8分钟，确保符合限制
  * 翻唱功能会在保持核心旋律的同时转换为新风格
  * 音乐翻唱有三个阶段，每个阶段都会触发回调通知
</Warning>

## 故障排除

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

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

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

  <Accordion title="翻唱参数问题">
    * 确认上传URL是否有效且可访问
    * 检查上传的音频文件格式是否支持
    * 验证音频文件时长是否超过8分钟限制
    * 确认翻唱参数设置是否正确
  </Accordion>

  <Accordion title="回调阶段处理">
    * 理解三个回调阶段的差异和处理方式
    * text阶段：仅表示文本生成完成，无音频数据
    * first阶段：第一首翻唱音乐完成，包含一首音乐的数据
    * complete阶段：所有翻唱音乐完成，包含完整的音乐列表
  </Accordion>
</AccordionGroup>

## 替代方案

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

<Card title="轮询查询结果" icon="radar" href="/cn/suno-api/get-music-generation-details">
  使用获取音乐生成详情接口定期查询任务状态。建议每30秒查询一次。
</Card>