Response

Last update:2025-05-28 16:13:55

This document explains the response formats for API requests and the HTTP response codes that may be returned.

Response Formats

Successful Response

When a request is successful, the service returns a JSON response containing a persistentId:

{
    "persistentId": "<persistentId>"
}

The persistentId is a unique identifier that tracks your task. You can use this ID when contacting support for troubleshooting assistance.

Important: The persistentId only confirms your request has been successfully submitted. It does not indicate the media processing task has completed successfully. To monitor task status, we recommend configuring a callback to receive status notifications.

Error Response

When a request fails, the service returns a JSON response with error details:

{
    "code": "<HTTP_RESPONSE_CODE>",
    "message": "<ERROR_MESSAGE>"
}
Field Description
code The HTTP response code (see HTTP Response Codes below)
message A description explaining why the media processing failed

HTTP Response Codes

General Response Codes

Code Response Message Description
200 OK The operation was successful.
304 Not Modified The file is up-to-date and no modifications were made.
401 Authorization Required An Authorization header is required for this request.
401 AK/SK Not Found The AccessKey (AK) or AccessKey Secret (SK) was not found.
401 Token Invalid The request token provided is incorrect.
401 ExpireTime Is Null The ExpireTime field is empty.
401 Token Format Invalid The format of the request token is incorrect.
401 Bucket Access Denied Access to the requested bucket is denied.
401 The Persistent File Already Exists The persistent file already exists.
404 Bucket Not Found The bucket in the request does not exist.
404 File Not Found The requested file was not found.
404 bucketErrorPage The requested resource was not found.
404 Bucket Not Binding Mirror The requested bucket is not bound to a mirror source.
405 Token Required A token is required for this request.
406 File Already Exist The file already exists.
406 File Is Busy, Please Retry Later The file is being processed. Please retry later.
500 Internal Server Error An internal server error has occurred.

Image Processing Response Codes

Code Response Message Description
401 Bucket Open Image Protect Function, Unable To Get Original Image Access to the original image is denied due to enabled image protection.
401 Non-standard Type Of Op The type of operation requested is invalid.
401 Image Process Param Error There was an error in the image processing parameters.
404 Watermark Image Url Invalid The URL for the watermark image is invalid.
404 WaterMark Image Not Found The watermark image could not be found.
579 Get WaterMark Image Fail Download of the watermark image failed.

Media Processing Response Codes

Code Response Message Description
400 Tranfer Parameters Error Transcoding parameters error.
401 Ops Invalid The fops in the request is invalid.
404 Video Persistent Progress Info Not Found Information about the file’s processing task was not found.
579 Json Response An exception occurred in the callback to the business server’s response.
Is the content of this document helpful to you?
Yes
I have suggestion
Submitted successfully! Thank you very much for your feedback, we will continue to strive to do better!