Updated on 2024-07-30 GMT+08:00

Response

Status Code

After sending a request, you will receive a response, including a status code, response header, and response body.

A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.

For example, if status code 0 is returned for calling the API used to process files, the request is successful.

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

Figure 1 shows the response header of the API used to process files.

Figure 1 Response header

Response Body

The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.

The following is part of the response body for the API used to process files.

{
    "data": "1309243162258308352"
    "code": 0,
    "msg": "success"
}

If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

{
    "code": 13000201,
    "msg": "inner server invoke failure"
}

In the response body, code is an error code, and msg provides information about the error.