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

回调机制概述

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

回调时机

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

回调方式

  • HTTP方法: POST
  • Content Type: application/json
  • 超时设置: 15秒
  • 重试机制: 失败后重试3次,间隔时间分别为1分钟、5分钟、15分钟

回调请求格式

任务完成时,系统会向您的 callBackUrl 发送以下格式的POST请求:
{
  "code": 200,
  "msg": "All generated 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] Night city lights shining bright",
        "model_name": "chirp-v3-5",
        "title": "Iron Man",
        "tags": "electrifying, rock",
        "createTime": "2025-01-01 00:00:00",
        "duration": 228.28
      }
    ]
  }
}

状态码说明

code
integer
required
回调状态码,表示任务处理结果:
状态码说明
200成功 - 音频翻唱完成
400请求错误 - 参数错误、音频文件格式不支持、内容违规等
451下载失败 - 无法下载源音频文件
500服务器错误 - 请稍后重试
msg
string
required
状态消息,提供详细的状态描述
data.callbackType
string
required
回调类型,表示当前回调的阶段:
  • text: 文本生成完成
  • first: 第一首音乐完成
  • complete: 所有音乐完成
  • error: 任务失败
data.task_id
string
required
任务ID,与您提交任务时返回的taskId一致
data.data
array
音频翻唱结果信息,成功时返回
data.data[].id
string
音乐唯一标识符
data.data[].audio_url
string
翻唱后的音频文件URL
data.data[].source_audio_url
string
原始音频文件URL
data.data[].stream_audio_url
string
流式音频URL
data.data[].source_stream_audio_url
string
原始流式音频URL
data.data[].image_url
string
封面图片URL
data.data[].source_image_url
string
原始封面图片URL
data.data[].prompt
string
生成提示词/歌词
data.data[].model_name
string
使用的模型名称
data.data[].title
string
音乐标题
data.data[].tags
string
音乐标签
data.data[].createTime
string
创建时间
data.data[].duration
number
音频时长(秒)

回调接收示例

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

app.use(express.json());

app.post('/upload-cover-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('收到音频翻唱回调:', {
    taskId: data.task_id,
    callbackType: data.callbackType,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // 任务成功完成
    console.log('音频翻唱完成');
    const musicData = data.data || [];
    
    console.log(`翻唱了 ${musicData.length} 首音乐:`);
    musicData.forEach((music, index) => {
      console.log(`翻唱音乐 ${index + 1}:`);
      console.log(`  标题: ${music.title}`);
      console.log(`  时长: ${music.duration}秒`);
      console.log(`  风格标签: ${music.tags}`);
      console.log(`  翻唱音频URL: ${music.audio_url}`);
      console.log(`  封面URL: ${music.image_url}`);
    });
    
    // 处理翻唱的音乐
    // 可以下载音频文件、保存到本地等
    
  } 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. 音频处理: 音频下载和处理应在异步任务中进行,避免阻塞回调响应

重要提醒

  • 回调URL必须是公网可访问的地址
  • 服务器必须在15秒内响应,否则视为超时
  • 连续3次重试失败后,系统将停止发送回调
  • 请确保回调处理逻辑的稳定性,避免因异常导致回调失败
  • 生成的音频URL可能有时效限制,建议及时下载保存
  • 注意内容合规性,避免因违规导致生成失败
  • 确保上传的音频文件格式受支持

故障排查

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

替代方案

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

轮询查询结果

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