카카오계정 관리

신규 어드민 API 제공

이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.

이 문서는 카카오디벨로퍼스 카카오계정 관리에 대한 어드민 API 사용 방법을 안내합니다.

제목 태그

각 제목에 부착된 태그(Tag)는 아래와 같은 의미입니다.

태그	설명
Internal	이 액션은 API플랫폼 내부에서만 사용합니다.

카카오계정 정보 조회

요청

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/kakaoAccount`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL Internal	주어진 ID 목록에 해당하는 카카오계정 정보를 조회합니다.
FIND Internal	카카오계정 정보를 조회합니다.
FIND_BY_EMAIL Internal	이메일로 카카오계정 정보를 조회합니다.
IS_RESTRICTED Internal	카카오계정의 제재 여부를 조회합니다.
IS_SPAM Internal	카카오계정의 스팸 상태 여부를 조회합니다.
IS_OWN_IDENTIFY Internal	카카오계정의 본인 인증 여부를 조회합니다.
IS_UNDER_AGE Internal	카카오계정 사용자의 연령이 14세 미만인지 조회합니다.
VALIDATE_GUARDIAN_TOKEN Internal	사용자가 14세 미만인 카카오계정의 보호자 동의 토큰 정보를 조회합니다.
HAS_TWO_STEP_VERIFICATION Internal	카카오계정의 2단계 인증 설정 여부를 조회합니다.

FIND_ALL
Internal

주어진 ID 목록에 해당하는 카카오계정 정보를 조회합니다.

조회할 카카오계정 ID 목록을 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정 ID 목록의 정보를 배열로 payload에 포함합니다. 존재하지 않는 카카오계정 ID의 정보는 응답에 포함되지 않습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int[]`	카카오계정 ID 목록	O

응답 페이로드

KakaoAccount[]

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL",
        "payload": {
            "id": [2650168]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 2650168,
    "display_id": "sample@sample.com",
    "email": "sample@sample.com",
    "account_type": 0,
    "account_status": 1,
    "verified_at": "2022-10-05T07:09:16Z",
    "created_at": "2022-10-05T07:09:16Z",
    "talk_user_id": 700182088
  }
]

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 200
[]

FIND
Internal

카카오계정 정보를 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정 ID 정보를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

KakaoAccount

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 2650168,
  "display_id": "sample@sample.com",
  "email": "sample@sample.com",
  "account_type": 0,
  "account_status": 1,
  "verified_at": "2022-10-05T07:09:16Z",
  "created_at": "2022-10-05T07:09:16Z",
  "talk_user_id": 700182088
}

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

FIND_BY_EMAIL
Internal

이메일로 카카오계정 정보를 조회합니다.

조회할 카카오계정의 이메일을 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정 정보를 payload에 포함합니다. 존재하지 않는 카카오계정 이메일로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
email	`String`	카카오계정의 이메일	O

응답 페이로드

KakaoAccount

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_BY_EMAIL",
        "payload": {
            "email": sample@sample.com
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 2650168,
  "display_id": "sample@sample.com",
  "email": "sample@sample.com",
  "account_type": 0,
  "account_status": 1,
  "verified_at": "2022-10-05T07:09:16Z",
  "created_at": "2022-10-05T07:09:16Z",
  "talk_user_id": 700182088
}

응답 예제, 카카오계정을 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

IS_RESTRICTED
Internal

카카오계정의 제재 여부를 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정의 제재 여부를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

카카오계정의 제재 여부
- true: 제재됨
- false: 제재되지 않음

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "IS_RESTRICTED",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
false

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

IS_SPAM
Internal

카카오계정의 스팸 상태 여부를 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정의 스팸 상태 여부를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

카카오계정의 스팸 상태 여부
- true: 스팸 상태
- false: 스팸 상태 아님

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "IS_SPAM",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
false

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

IS_OWN_IDENTIFY
Internal

카카오계정의 본인 인증 여부를 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정의 본인 인증 여부를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

카카오계정의 본인 인증 여부
- true: 본인 인증 완료
- false: 본인 인증 미완료

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "IS_OWN_IDENTIFY",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
false

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

IS_UNDER_AGE
Internal

카카오계정 사용자의 연령이 14세 미만인지 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정 사용자의 연령 정보를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

카카오계정 사용자의 연령
- true: 14세 미만
- false: 14세 이상

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "IS_UNDER_AGE",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
false

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

VALIDATE_GUARDIAN_TOKEN
Internal

사용자가 14세 미만인 카카오계정의 보호자 동의 토큰 정보를 조회합니다.

조회할 카카오계정 ID와 보호자 동의 토큰을 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정의 보호자 동의 토큰 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O
token	`String`	14세 미만 사용자의 동의항목을 추가하기 위해 필요한 보호자 동의 토큰	O

응답 페이로드

카카오계정의 보호자 동의 토큰 정보
- SUCCESS: 유효
- INVALID: 유효하지 않음
- EXPIRED: 만료됨
- NOT_VERIFIED: 확인되지 않음

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "VALIDATE_GUARDIAN_TOKEN",
        "payload": {
            "id": 2650168,
            "token": "${TOKEN}"
        }
    }'

응답 예제

// HTTP/2 200
"SUCCESS"

HAS_TWO_STEP_VERIFICATION
Internal

카카오계정의 2단계 인증 설정 여부를 조회합니다.

조회할 카카오계정 ID를 payload에 포함해 요청합니다.

요청 처리 성공 시 응답은 해당 카카오계정의 2단계 인증 설정 여부를 payload에 포함합니다. 존재하지 않는 카카오계정 ID로 요청한 경우 에러 응답을 받습니다.

요청 페이로드

이름	타입	설명	필수
id	`Int`	카카오계정 ID	O

응답 페이로드

카카오계정의 2단계 인증 설정 여부
- true: 설정됨
- false: 설정되지 않음

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/kakaoAccount" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "HAS_TWO_STEP_VERIFICATION",
        "payload": {
            "id": 2650168
        }
    }'

응답 예제

// HTTP/2 200
false

응답 예제, 카카오계정 ID를 찾을 수 없음

// HTTP/2 404
{
  "message": "NOT_FOUND"
}

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

카카오계정 관리

제목 태그

카카오계정 정보 조회

요청

액션

FIND_ALLInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

FINDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

FIND_BY_EMAILInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정을 찾을 수 없음

IS_RESTRICTEDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

IS_SPAMInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

IS_OWN_IDENTIFYInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

IS_UNDER_AGEInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

VALIDATE_GUARDIAN_TOKENInternal

요청 페이로드

응답 페이로드

응답 예제

HAS_TWO_STEP_VERIFICATIONInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제, 카카오계정 ID를 찾을 수 없음

도움이 되었나요?