Troubleshooting
Response code
Response codes include an HTTP status code indicating the status of the request and an error code about the error information. If the request is successful, the response body is returned with a status code of 200. If failed, an error code with the code and msg is returned.
HTTP status code
The HTTP status code is a 3-digit integer in the first line of a response message, indicating the request result (success or failure). The status codes are classified into five, and the first digit of the status code defines the types of response. Refer to RFC 2616 to see more about HTTP status code.
Here is the list of HTTP status codes.
| Code | Status | Description |
|---|---|---|
| 200 OK | Success | Indicates that the server has received and processed the client's request successfully. The response body format varies by API. See the description of each API for details. |
| 400 Bad Request | Failure | General error Indicates the state in which the server has detected a client error related to required parameters and cannot process the request. |
| 401 Unauthorized | Failure | Authorization error (mostly related to tokens) Indicates that the request has failed because the client has no valid authorization credentials for the resource. |
| 403 Forbidden | Failure | Permission Error Indicates that the server has received the client's request but rejected it because the client has no permission. |
| 429 Too Many Request | Failure | Quota exceeded Indicates that the quota limit or the limit per second for the API has been exceeded. |
| 500 Internal Server Error | Failure | System error 500 refers to the class of server errors, indicating that the server is in an unexpected situation while processing the request. |
| 502 Bad Gateway | Failure | System error Indicates that communication is not working properly because a gateway converts to another wrong protocol or has something wrong with the converting protocol. |
| 503 Service Unavailable | Failure | Undergoing maintenance Indicates that the server is not ready to process the request. |
Common Error Codes
The following table lists the error codes that may occur for each API product. When an error occurs, use the code to identify the cause.
Example response (In case of an unexpected server error):
{
"code": -1,
"msg": "internal server error"
}| Code | HTTP status code | Description |
|---|---|---|
| -1 | 500 | Internal server error occurred during processing. Solution: Retry. |
| -2 | 400 | Required parameters are missing, or values are of the wrong type or out of range. Solution: Check your request parameters. |
| -3 | 403 | Required features (e.g., Simple Signup, Consent Items, and Service Settings) are not enabled. Solution: Go to App > Your App > Dashboard, select the required feature under Product Settings, and enable it. After completing these steps, retry the API request. |
| -4 | 403 | The account is restricted, or the account is performing a restricted action |
| -5 | 403 | The app does not have permission to access the requested API. Solution: Request API review to obtain permission. |
| -7 | 500 | The service is under maintenance or has an internal problem |
| -8 | 400 | The request was sent with invalid headers. Solution: Check and correct your request headers. |
| -9 | 400 | The API called has been discontinued |
| -10 | 400 | API request quota exceeded. Solution: Check and adjust your usage within allowed limits. |
| -401 | 401 | Invalid app key or access token, or mismatch between the calling app and the registered app. Solution: Verify app key or renew token, and check registered app info on the Kakao Developers. |
| -602 | 400 | The maximum size was exceeded when uploading an image |
| -603 | 400 | The request took too long to complete (e.g., image upload or scraping). |
| -903 | 400 | The request was made using an unregistered developer’s app key or token. |
| -911 | 400 | An unsupported image format was uploaded |
| -9798 | 503 | The service is under maintenance |