Music Video Generation Callbacks

When you submit a task to the Music Video Generation API, you can use the callBackUrl parameter to set a callback URL. When the task is completed, the system will automatically push the results to your specified address.

Callback Mechanism Overview

The callback mechanism eliminates the need to poll the API for task status. The system will proactively push task completion results to your server.

Callback Timing

The system will send callback notifications in the following situations:

Music video generation task completed successfully
Music video generation task failed
Errors occurred during task processing

Callback Method

HTTP Method: POST
Content Type: application/json
Timeout Setting: 15 seconds

Callback Request Format

When the task is completed, the system will send a POST request to your callBackUrl in the following format:

{
  "code": 200,
  "msg": "MP4 generated successfully.",
  "data": {
    "task_id": "taskId_774b9aa0422f",
    "video_url": "https://example.com/videos/video_847715e66259.mp4"
  }
}

Status Code Description

code

integer

required

Callback status code indicating task processing result:

Status Code	Description
200	Success - Music video generation completed
400	Bad Request - Parameter error, unsupported audio file format, etc.
451	Download Failed - Unable to download source audio file
500	Server Error - Please try again later

msg

string

required

Status message providing detailed status description

data.task_id

string

required

Task ID, consistent with the taskId returned when you submitted the task

data.video_url

string

Generated MP4 video file download URL, returned on success

Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages:

Node.js
Python
PHP

const express = require('express');
const app = express();

app.use(express.json());

app.post('/music-video-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received music video generation callback:', {
    taskId: data.task_id,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Music video generation completed');
    console.log(`Video URL: ${data.video_url}`);
    
    // Download video file
    if (data.video_url) {
      const https = require('https');
      const fs = require('fs');
      
      const filename = `music_video_${data.task_id}.mp4`;
      const file = fs.createWriteStream(filename);
      
      https.get(data.video_url, (response) => {
        response.pipe(file);
        file.on('finish', () => {
          file.close();
          console.log(`Video file saved as ${filename}`);
        });
      }).on('error', (err) => {
        console.error('Video file download failed:', err.message);
      });
    }
    
  } else {
    // Task failed
    console.log('Music video generation failed:', msg);
    
    // Handle failure cases...
    if (code === 400) {
      console.log('Parameter error or unsupported audio file format');
    } else if (code === 451) {
      console.log('Source audio file download failed');
    } else if (code === 500) {
      console.log('Server internal error');
    }
  }
  
  // Return 200 status code to confirm callback received
  res.status(200).json({ status: 'received' });
});

app.listen(3000, () => {
  console.log('Callback server running on port 3000');
});

from flask import Flask, request, jsonify
import requests

app = Flask(__name__)

@app.route('/music-video-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')
    video_url = callback_data.get('video_url')
    
    print(f"Received music video generation callback: {task_id}, status: {code}, message: {msg}")
    
    if code == 200:
        # Task completed successfully
        print("Music video generation completed")
        print(f"Video URL: {video_url}")
        
        # Download video file example
        if video_url:
            try:
                response = requests.get(video_url)
                if response.status_code == 200:
                    filename = f"music_video_{task_id}.mp4"
                    with open(filename, "wb") as f:
                        f.write(response.content)
                    print(f"Video file saved as {filename}")
            except Exception as e:
                print(f"Video file download failed: {e}")
                
    else:
        # Task failed
        print(f"Music video generation failed: {msg}")
        
        # Handle failure cases...
        if code == 400:
            print("Parameter error or unsupported audio file format")
        elif code == 451:
            print("Source audio file download failed")
        elif code == 500:
            print("Server internal error")
    
    # Return 200 status code to confirm callback received
    return jsonify({'status': 'received'}), 200

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=3000)

<?php
header('Content-Type: application/json');

// Get POST data
$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'] ?? '';
$videoUrl = $callbackData['video_url'] ?? '';

error_log("Received music video generation callback: $taskId, status: $code, message: $msg");

if ($code === 200) {
    // Task completed successfully
    error_log("Music video generation completed");
    error_log("Video URL: $videoUrl");
    
    // Download video file example
    if ($videoUrl) {
        try {
            $videoContent = file_get_contents($videoUrl);
            if ($videoContent !== false) {
                $filename = "music_video_{$taskId}.mp4";
                file_put_contents($filename, $videoContent);
                error_log("Video file saved as $filename");
            }
        } catch (Exception $e) {
            error_log("Video file download failed: " . $e->getMessage());
        }
    }
    
} else {
    // Task failed
    error_log("Music video generation failed: $msg");
    
    // Handle failure cases...
    if ($code === 400) {
        error_log("Parameter error or unsupported audio file format");
    } elseif ($code === 451) {
        error_log("Source audio file download failed");
    } elseif ($code === 500) {
        error_log("Server internal error");
    }
}

// Return 200 status code to confirm callback received
http_response_code(200);
echo json_encode(['status' => 'received']);
?>

Best Practices

Callback URL Configuration Recommendations

Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
Verify Source: Verify the legitimacy of the request source in callback processing
Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
Video Processing: Video file download and processing should be done in asynchronous tasks to avoid blocking callback response

Important Reminders

Callback URL must be a publicly accessible address
Server must respond within 15 seconds, otherwise it will be considered a timeout
If 3 consecutive retries fail, the system will stop sending callbacks
Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
Generated video file URLs may have time limits, recommend downloading and saving promptly
MP4 video files are large, pay attention to storage space and download time
Ensure sufficient disk space to save video files
Video generation may take longer, please be patient for callback notifications

Troubleshooting

If you do not receive callback notifications, please check the following:

Network Connection Issues

Confirm that the callback URL is accessible from the public network
Check firewall settings to ensure inbound requests are not blocked
Verify that domain name resolution is correct

Server Response Issues

Ensure the server returns HTTP 200 status code within 15 seconds
Check server logs for error messages
Verify that the interface path and HTTP method are correct

Content Format Issues

Confirm that the received POST request body is in JSON format
Check that Content-Type is application/json
Verify that JSON parsing is correct

Video Processing Issues

Confirm that video file URLs are accessible
Check video download permissions and network connections
Verify video save paths and permissions
Note video file size, ensure sufficient storage space
Confirm source audio file format is supported
Check network bandwidth is sufficient for downloading large files

Alternative Solution

If you cannot use the callback mechanism, you can also use polling:

Poll Query Results

Use the get music video details endpoint to regularly query task status. We recommend querying every 30 seconds.

Generate Music

Generate Lyrics

WAV Conversion

Vocal Removal

Music Video Generation

Account Management

File Upload API

Music Video Generation Callbacks

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Callback Reception Examples

Best Practices

Callback URL Configuration Recommendations

Important Reminders

Troubleshooting

Alternative Solution

Poll Query Results

Generate Music

Generate Lyrics

WAV Conversion

Vocal Removal

Music Video Generation

Account Management

File Upload API

​Callback Mechanism Overview

​Callback Timing

​Callback Method

​Callback Request Format

​Status Code Description

​Callback Reception Examples

​Best Practices

​Callback URL Configuration Recommendations

​Important Reminders

​Troubleshooting

​Alternative Solution

Poll Query Results

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Callback Reception Examples

Best Practices

Callback URL Configuration Recommendations

Important Reminders

Troubleshooting

Alternative Solution