If the optional notification_config
parameter is provided, the API will make an HTTP POST request to the URL specified in that parameter with details in the request body when the job either completes successfully or fails.
To use a webhook URL with restricted access, authorization headers can also be provided in the notification_config
parameter.
Here is an example of the POST request body sent after a successful transcription job:
Here is an example of the POST request body sent after a failed transcription job:
{
"job": {
"id": "Umx5c6F7pH7r",
"status": "failed",
"created_on": "2018-05-05T23:23:22.29Z",
"failure": "download_failure",
"failure_detail": "Failed to download media file. Please check your url and file type"
}
}
<aside> ⚠️ ATTENTION
notification_config.url
parameter. The request body will contain the job details.200
response code.200
response, Voiceloft AI will retry the callback URL every 30 minutes until either 24 hours have passed or a 200
response code is received.
</aside>