Callback

Some of the API services provided by this product require asynchronous callbacks due to longer processing times.

To ensure that information is returned normally and accurately, a callback URL needs to be provided in the input parameters.

Request

Please provide a callback URL and ensure that the callback URL provided is consistent across different scenarios.

Please make sure that the url you provide is accessible to the public network and that the request type is POST.

If the callback URL varies, there may be inconsistencies between the callback URL used during the callback and the callback URL you provided at the time of the request.

Response

When an asynchronous request is sent successfully, we will immediately provide a webhookId. When a callback is made, this webhookId will also be included in the callback URL. You can use the webhookId to associate the request with the callback.

webhookId · string

When the request is successfully sent, a webhoodId will be synchronously returned. The same information will also be called back in the callbackUrl, which is used to correlate the request and the response.

webhookType · string

TRAIN_COVER_SPEAKER: Add an AI Cover Voice

EDIT_COVER_SPEAKER: Improve an AI Cover Voice

COVER_SONG: Create AI Cover Voice

status · string

The status of this request

data · Object

business data

Samples

200（success）

{
    "webhookId":"1700189306ffhdkejwcsk2",
    "webhookType":"TRAIN_COVER_SPEAKER",    
    "status":"SUCCESS",  
    "summary":"Clone training success.",  
    "data":{
        "id":"100"
    }
}

200（fail）

{
    "webhookId":"1700189306ffhdkejwcsk2",
    "webhookType":"TRAIN_COVER_SPEAKER",    
    "status":"FAILURE",  
    "summary":"Clone training failed."
}