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

回调机制概述

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

回调时机

系统会在以下情况发送回调通知:
  • 文本生成完成(text 阶段)
  • 第一首音乐生成完成(first 阶段)
  • 所有音乐生成完成(complete 阶段)
  • 音乐生成任务失败
  • 任务处理过程中发生错误

回调方法

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

回调请求格式

当任务完成时,系统会按以下格式向您的 callBackUrl 发送POST请求:
{
  "code": 200,
  "msg": "Text generation completed successfully.",
  "data": {
    "callbackType": "text",
    "task_id": "2fac****9f72",
    "data": []
  }
}

状态码说明

code
integer
required
回调状态码,表示任务处理结果:
状态码说明
200成功 - 音乐生成完成
400请求错误 - 参数错误或内容违规
401未授权 - API密钥无效
413内容过长 - 提示词或风格描述超出限制
429积分不足 - 账户积分余额不足
500服务器错误 - 请稍后重试
msg
string
required
状态消息,提供详细的状态描述
data.callbackType
string
required
回调类型,表示当前回调阶段:
  • text: 文本生成完成
  • first: 第一首音乐生成完成
  • complete: 所有音乐生成完成
  • failed: 任务失败
data.task_id
string
required
任务ID,与您提交任务时返回的taskId一致
data.data
array
音乐生成结果信息,成功时返回
data.data[].id
string
音频唯一标识
data.data[].audio_url
string
音频文件下载链接
data.data[].source_audio_url
string
原始音频文件下载链接
data.data[].stream_audio_url
string
流式音频播放链接
data.data[].image_url
string
音乐封面图片链接
data.data[].prompt
string
生成使用的提示词/歌词
data.data[].model_name
string
使用的AI模型名称
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('/music-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) {
    // 任务成功
    const { callbackType, data: musicData } = data;
    
    switch (callbackType) {
      case 'text':
        console.log('文本生成完成');
        break;
        
      case 'first':
        console.log('第一首音乐生成完成');
        if (musicData.length > 0) {
          console.log(`音乐标题: ${musicData[0].title}`);
          console.log(`音频链接: ${musicData[0].audio_url}`);
          console.log(`时长: ${musicData[0].duration}秒`);
        }
        break;
        
      case 'complete':
        console.log('所有音乐生成完成');
        console.log(`共生成 ${musicData.length} 首音乐:`);
        musicData.forEach((track, index) => {
          console.log(`音乐 ${index + 1}: ${track.title} - ${track.audio_url}`);
        });
        
        // 处理生成的音乐
        // 可以下载音乐、保存到本地等
        break;
    }
    
  } 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');
});

最佳实践

回调URL配置建议

  1. 使用HTTPS: 确保回调URL使用HTTPS协议,保证数据传输安全
  2. 验证来源: 在回调处理中验证请求来源的合法性
  3. 幂等处理: 同一个taskId可能收到多次回调,确保处理逻辑具有幂等性
  4. 快速响应: 回调处理应尽快返回200状态码,避免超时
  5. 异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
  6. 分阶段处理: 根据不同的回调阶段(text、first、complete)进行相应的业务处理
  7. 音乐下载: 音乐下载和处理应在异步任务中进行,避免阻塞回调响应

重要提醒

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

故障排除

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

替代方案

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

轮询查询结果

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