Error handling

If an error occurs when you call an API, an error response is returned, where the result field indicates the error code ( result.resultCode ) and error message ( result.resultMessage ). You can troubleshoot issues based on the error codes section below. If the error persists, you can contact the ZOLOZ support to obtain technical support.

#Error codes

ZOLOZ returns two kinds of error codes:

  • common error codes that apply to all APIs, which indicate the invocation status of an API request
  • API-specific error codes that apply to a specific API, which indicate the detailed processing result of the specific API.

#Common error codes

The following table shows the information about the common error codes. If you do not find an error code here, see the API-specific error codes section.

resultCode

resultStatus

resultMessage

SUCCESS

S

The request has succeeded.

PARAM_MISSING

F

Bad request. The parameter is missing.

PARAM_ILLEGAL

F

Bad request. The parameter is illegal.

MSG_PARSE_ERROR

F

Bad request. The message format is invalid.

SIGNATURE_INVALID

F

Unauthorized. The signature is invalid.

KEY_NOT_FOUND

F

key not found

Unauthorized. The ZOLOZ server can not find the key.

OAUTH_FAIL

F

Unauthorized. The OAuth 2.0 authorization fails.

NO_INTERFACE_DEF

F

The requested API is not defined.

REQUEST_TRAFFIC_EXCEED_LIMIT

F

The request traffic exceeds the limit.

SYSTEM_ERROR

U

A system error occurs.

PROCESS_TIMEOUT

F

The processing of the API request times out.

#API-specific error codes

For the error codes that apply to a specific API, see the Result section in each API specification.