This document guides the specification of the REST API provided by the Kakao Developers.

The request format for Kakao APIs consists of the elements below.

The specification for each Kakao API is indicated in each product's documentation.

The Kakao API server returns the response in the following format for each request:

• On success: HTTP status code, a JSON including response fields
• On failure: HTTP status code, a JSON including an error code including code as an integer and msg as a string

Here are some sample responses below.

HTTP/1.1 403 Forbidden
{
  "msg": "This api is not allowed by using app_key(${APP_KEY}).",
  "code": -3
}

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer error=invalid_token

{
  "code":-401,
  "msg":"InvalidTokenException"
}

HTTP/1.1 400 Forbidden
{
  "code":-10,
  "msg":"API limit has been exceeded."
}

HTTP/1.1 403 Forbidden
{
  "msg": "insufficient scopes.",
  "code": -402,
  "api_type": "TALK_MEMO_DEFAULT_SEND",
  "required_scopes": [
    "talk_message"
  ],
  "allowed_scopes": [
    "profile",
    "account_email"
  ]
}

The code passed in the error response message body is a negative integer without any specific rule. The msg, passed along with the code, indicates the cause of request failure and may be different depending on the requested APIs. For example, in the case of code is -401, different msg can be passed according to the APIs as follows:

"this access token does not exist", "this access token is already expired", "appKey(xxxxxxxx) is already deactivated"

"domain mismatched! caller=xxxxxxxx. check out registered web domains."

"android keyhash mismatched! caller=xxxxxxxx. check out registered keyhash."
"ios bundle id mismatched! caller=xxxxxxxx. check out registered bundle id."

"ip mismatched! callerIp=xxxxxxxx. check out registered ips."

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.

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 that the Kakao platform transmits.

See Error code.

Here are the lists of URLs, hosts, and methods required when making a request to use each function that the REST API supports.

• Refer to Kakao Moment API reference.

• Refer to Kakao Keyword Ad API reference. This document is available in Korean only.