Error Codes
If a request fails, the server will return a JSON response containing the following fields:
- MsgId: The error code.
- Msg: The error message describing the issue to help understand and resolve the error.
For example, when a required parameter is missing, the response will be:
{
"TraceId": "0HNLNN8L7AEB9:00000002",
"MsgId": "4001000",
"Msg": "Missing required parameter: file",
"Data": null
}
Error Code Table
| HTTP Status Code | Error Code | Error Message | Description |
|---|---|---|---|
| 400 | 2001000 | Benefit distribution failed | Business error |
| 400 | 2001001 | Insufficient inventory | Business error |
| 400 | 4001000 | Missing parameter | Parameter error |
| 400 | 4004002 | Output text too long | Parameter error |
| 400 | 4004003 | Parameter out of range | Parameter error |
| 403 | 4031010 | Permission denied | Authorization error |
| 403 | 4031020 | IP blacklisted | Authorization error |
| 403 | 4031021 | IP whitelist restriction | Authorization error |
| 429 | 4291001 | Rate limit exceeded | Gateway error |
| 500 | 5000000 | Internal server error | Please contact us for assistance |