레퍼런스: 타입 정보

신규 어드민 API 제공

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

이 문서는 어드민 API에서 사용하는 타입 정보를 제공합니다.

내 애플리케이션: 앱 설정

Android

이름	타입	설명	필수
package_name	`String`	패키지명	O
market_url	`String`	마켓 URL	X
key_hashes	`String[]`	키 해시 목록 등록된 키 해시가 없을 경우 빈 배열 반환	O

App

이름	타입	설명	필수
app_key	`AppKey`	앱 키 정보	O
id	`Int`	앱 ID	O
name	`String`	앱 이름(영문 기준 최대 45자)	O
company	`String`	회사명(영문 기준 최대 50자)	O
icon	`String`	앱 아이콘 이미지 URL	X
app_type	`AppType`	앱 타입	O
category	`AppCategory`	앱 카테고리	O
status	`AppStatus`	앱 상태	O
phase	`AppPhase`	테스트 앱 여부	O

AppKey

이름	타입	설명	필수
NATIVE_APP_KEY	`String`	네이티브 앱 키	O
REST_API_KEY	`String`	REST API 키	O
JAVASCRIPT_KEY	`String`	JavaScript 키	O
ADMIN_KEY	`String`	어드민 키	O

Enum: AppType

앱 참고

값	설명
DEFAULT	일반 앱(기본값)
LEGACY_PARTNER	구 제휴 앱
DAUM	다음 앱
KAKAO	인하우스 앱
SAMPLE	샘플 앱
PARTNER	제휴 앱

Enum: AppCategory

아래 목록에 없는 앱 카테고리는 [서비스] API플랫폼 아지트로 문의

값	설명
None	없음(기본값)
Art_Design	예술/디자인
Transportation	자동차/교통수단
Beauty	뷰티
Book_Reference	도서/참고자료
Business	광고/비즈니스
Communication	메신저/전화
Education	교육
Entertainment	엔터테인먼트
Event	행사/이벤트
Finance	금융
Food_Beverage	식음료
Health_Fitness	건강/피트니스
House_Home	부동산/인테리어
Libraries_Demo	라이브러리/데모
Lifestyle	라이프스타일
Map_Navigation	지도/내비게이션
Medical	의료
Music_Audio	음악/오디오
News_Magazine	뉴스/잡지
Parenting	출산/육아
Photography_Video	사진/비디오
Productivity_Tools	생산성/도구
Shopping	쇼핑
Social	소셜 네트워킹
Sports	스포츠
Travel_Local	여행/지역 정보
Weather	날씨
Public_Institution	공공/기관
Games	게임
Games_Rich_Board	리치보드게임
Games_Rich_Casual	리치캐주얼게임

Enum: AppStatus

값	설명
ACTIVE	활성
DEACTIVATED	비활성

Enum: AppPhase

값	설명
NORMAL	앱
TEST	테스트 앱

Application

이름	타입	설명	필수
id	`Int`	앱 ID	O
name	`String`	앱 이름(영문 기준 최대 45자)	O
company	`String`	회사명(영문 기준 최대 50자)	O
category	`AppCategory`	앱 카테고리	O
required_scopes	`Int[]`	필수 동의항목	O
optional_scopes	`Int[]`	선택 동의항목	O
lazy_scopes	`Int[]`	이용 중 동의 동의항목	O
collecting_scopes	`Int[]`	수집 후 제공을 설정한 동의항목	O
status	`AppStatus`	앱 상태	O
icon_image_kage_token	`String`	앱 아이콘 이미지의 KAGE 토큰	X
owner_developer_id	`Int`	앱 소유자인 개발자 계정 ID	O
app_type	`AppType`	앱 타입	O
additional_permissions	`Int[]`	앱이 소유한 추가 권한	X
additional_scope_permissions	`Int[]`	앱이 소유한 동의항목 설정 권한	X
project_id	`Int`	프로젝트 ID	X
android_package_name	`String`	Android 패키지 이름	X
android_market_url	`String`	Android 마켓 URL	X
ios_bundle_id	`String`	iOS 번들 ID	X
iphone_app_store_id	`Long`	iPhone 앱 ID	X
ipad_app_store_id	`Long`	iPad 앱 ID	X
iphone_market_url	`String`	iPhone 마켓 URL	X
ipad_market_url	`String`	iPad 마켓 URL	X
web_site_url	`String[]`	웹사이트 URL	X
ip_addresses	`String[]`	허용 IP 목록	X
app_ext	`AppExtStatus`	앱 확장 기능 사용 여부 `ENABLED`: 사용 `DISABLED`: 미사용	X
created_at	`Datetime`	앱 생성 일시	X
updated_at	`Datetime`	앱 최근 변경 일시	X
app_unlink	`AppUnlinkStatus`	연결 해제 설정 사용 여부 `ENABLED`: 사용 `DISABLED`: 미사용	X
client_secret	`Boolean`	Client Secret 사용 여부 `true`: 사용 `false`: 미사용	O
group_permissions	`Int[]`	앱 타입별 권한	X
group_app_id	`Int`	그룹 앱 ID	X
phase	`AppPhase`	테스트 앱 여부	O
test_app_id	`Int`	테스트 앱 ID	X

* scopes: Deprecated, 동의항목 목록

ApplicationPlugin

이름	타입	설명	필수
id	`Int`	1회성 제공 동의(플러그인) ID	O
app_id	`Int`	앱 ID	O
plugin	`PluginType`	1회성 제공 동의 타입	O
extra_id	`Int`	`SURVEY`, `QR` 타입 1회성 제공 동의의 확장 키	O
extra_type	`String`	1회성 플러그인 확장 타입	X
name	`String`	1회성 제공 동의 설정 이름	X
purpose	`PluginPurpose`	1회성 제공 동의 사용 목적	O
required_scopes	`Int[]`	필수 동의항목 목록	O
optional_scopes	`Int[]`	선택 동의항목 목록	O
collecting_scopes	`Int[]`	수집 후 제공 동의항목 목록	O
token_ttl	`Int`	토큰 만료 시간	O
created_at	`Date`	1회성 제공 동의 설정 등록 시각	X
updated_at	`Date`	1회성 제공 동의 설정 최종 변경 시각	X

AppPlatform

현재 앱에 설정된 플랫폼에 한해 정보 제공
만약 앱에 설정된 플랫폼이 하나도 없다면 앱 ID만 반환

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
android	`Android`	Android 플랫폼 설정	X
ios	`IOS`	iOS 플랫폼 설정	X
web	`Web`	Web 플랫폼 설정	X

Foreign

이름	타입	설명	필수
id	`Int`	개인정보 국외이전 동의항목 ID	O
app_id	`Int`	앱 ID	O
country	`String`	개인정보가 국외이전되는 국가	O
company	`String`	개인정보를 국외이전 받는 사업자	O
contact	`String`	개인정보를 국외이전 받는 사업자의 연락처	O
created_at	`Date`	개인정보 국외이전 정보 등록 시각	X
updated_ap	`Date`	개인정보 국외이전 정보 변경 시각	X

* manager: Deprecated, 담당자명

IOS

이름	타입	설명	필수
bundle_id	`String`	번들 ID	O
iphone_app_store_id	`Long`	아이폰용 앱스토어의 앱 ID	X
iphone_market_url	`String`	아이폰용 앱스토어의 마켓 URL 중요: `iphone_app_store_id` 값을 등록하거나 변경하려면 `iphone_market_url` 값도 반드시 함께 전달해야 함	X
ipad_app_store_id	`Long`	아이패드용 앱스토어의 앱 ID	X
ipad_market_url	`String`	아이패드용 앱스토어의 마켓 URL 중요: `ipad_app_store_id` 값을 등록하거나 변경하려면 `ipad_market_url` 값도 반드시 함께 전달해야 함	X

Enum: PluginPurpose

값	설명
COUNSEL	상담
SURVEY	설문조사
NONE	없음
KET_EVENT	카카오엔터테인먼트 이벤트
QR_CERT	카카오톡 지갑 QR 인증

Enum: PluginType

값	설명
EVENT	이벤트
SURVEY	설문조사
DEFAULT	기본
DEFAULT_INHOUSE	인하우스 앱 기본
QR	카카오톡 지갑 QR
KET_EVENT	카카오엔터테인먼트 이벤트

SimpleApp

이름	타입	설명	필수
id	`Int`	앱 ID	O
name	`String`	앱 이름(영문 기준 최대 45자)	O
company	`String`	회사명(영문 기준 최대 50자)	O
icon	`String`	앱 아이콘 이미지 URL	X
app_type	`AppType`	앱 타입	O
category	`AppCategory`	앱 카테고리	O
status	`AppStatus`	앱 상태	O
phase	`AppPhase`	테스트 앱 여부	O

Web

이름	타입	설명	필수
web_site_url	`String[]`	사이트 도메인 목록	O

내 애플리케이션: 팀원

Member

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
developer_id	`Int`	팀원 개발자 계정 ID	O
role	`String`	팀원의 역할(권한), 아래 중 하나 `OWNER` `EDITOR` `EDITOR_MESSAGE_TEMPLATE` `READER` 참고: 멤버	O
created_at	`Datetime`	팀원 등록 시각	X
updated_at	`Datetime`	팀원 정보 변경 시각	X

MemberDeveloper

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
developer_id	`Int`	팀원 개발자 계정 ID	O
role	`String`	팀원의 역할(권한), 아래 중 하나 `OWNER` `EDITOR` `EDITOR_MESSAGE_TEMPLATE` `READER` 참고: 멤버	O
created_at	`Datetime`	팀원 등록 시각	X
updated_at	`Datetime`	팀원 정보 변경 시각	X
developer	`DeveloperInfo`	팀원 개발자 계정 정보	O

MemberSimpleApp

이름	타입	설명	필수
app	`SimpleApp`	앱 기본 정보	O
app_id	`Int`	앱 ID	O
developer_id	`Int`	팀원 개발자 계정 ID	O
role	`String`	팀원의 역할(권한), 아래 중 하나 `OWNER` `EDITOR` `EDITOR_MESSAGE_TEMPLATE` `READER` 참고: 멤버	O
created_at	`Datetime`	팀원 등록 시각	X
updated_at	`Datetime`	팀원 정보 변경 시각	X

MemberApp

이름	타입	설명	필수
app	`App`	앱 기본 정보 및 앱 키	O
app_id	`Int`	앱 ID	O
developer_id	`Int`	팀원 개발자 계정 ID	O
role	`String`	팀원의 역할(권한), 아래 중 하나 `OWNER` `EDITOR` `EDITOR_MESSAGE_TEMPLATE` `READER` 참고: 멤버	O
created_at	`Datetime`	팀원 등록 시각	X
updated_at	`Datetime`	팀원 정보 변경 시각	X

MemberBizApp

이름	타입	설명	필수
app	`BizApp`	앱 기본 정보 및 비즈니스 정보	O
app_id	`Int`	앱 ID	O
developer_id	`Int`	팀원 개발자 계정 ID	O
role	`String`	팀원의 역할(권한), 아래 중 하나 `OWNER` `EDITOR` `EDITOR_MESSAGE_TEMPLATE` `READER` 참고: 멤버	O
created_at	`Datetime`	팀원 등록 시각	X
updated_at	`Datetime`	팀원 정보 변경 시각	X

Developer

이름	타입	설명	필수
id	`Int`	개발자 계정 ID	O
account_id	`Int`	카카오계정 ID	O
name	`String`	개발자 계정 이름	O
status	`String`	개발자 계정 등록 상태, 아래 중 하나 `REGISTER`: 개발자 계정으로 등록 완료된 상태 `INVITED`: 팀원으로 초대 받았으나 아직 개발자 계정으로 등록하지 않은 상태 `SUSPENDED_DEREGISTER`: 계정 보호 조치 등으로 인한 개발자 계정 탈퇴 상태	X
price_plan	`String`	요금제, 미사용	X
created_at	`Datetime`	개발자 계정 등록 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
updated_at	`Datetime`	개발자 계정 정보 변경 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X

* company: Deprecated, 소속 회사 * email: Deprecated, 개발자 계정 이메일

DeveloperInfo

이름	타입	설명	필수
account_status	`String`	개발자 계정 상태	X
id	`Int`	개발자 계정 ID	O
account_id	`Int`	카카오계정 ID	O
name	`String`	개발자 계정 이름	O
status	`String`	개발자 계정 등록 상태, 아래 중 하나 `REGISTER`: 개발자 계정으로 등록 완료된 상태 `INVITED`: 팀원으로 초대 받았으나 아직 개발자 계정으로 등록하지 않은 상태 `SUSPENDED_DEREGISTER`: 계정 보호 조치 등으로 인한 개발자 계정 탈퇴 상태	X
price_plan	`String`	요금제, 미사용	X
created_at	`Datetime`	개발자 계정 등록 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
updated_at	`Datetime`	개발자 계정 정보 변경 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X

* company: Deprecated, 소속 회사 * email: Deprecated, 개발자 계정 이메일

내 애플리케이션: 카카오 로그인

AppScope

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
id	`String`	동의항목 ID	O
code	`Long`	동의항목 코드	O
scope_type	`ScopeType`	동의항목 종류	O
display_ko	`String`	동의항목 국문 표기명	O
display_en	`String`	동의항목 영문 표기명	O
purpose	`String`	동의 목적	X
level	`ScopeLevel`	동의 단계	O
category	`ScopeCategory`	동의항목 분류	O
collecting	`Boolean`	카카오계정으로 수집 후 제공 사용 여부 `true`: 사용 `false`: 사용 안함	O

ClientSecret

이름	타입	설명	필수
id	`Long`	Client Secret ID	O
app_id	`Int`	앱 ID	O
client_secret	`String`	Client Secret 코드	O
created_at	`Date`	Client Secret 생성 시각	X

ClientSecretApp

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
active	`Boolean`	Client Secret 활성화 여부 `true`: 사용 `사용 안함`	O
client_secret	`String`	Client Secret 코드	X

OAuthConfig

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
status	`ApplicationServiceStatus`	서비스 상태	O
redirect_uri	`String[]`	리다이렉트 URI 목록	X
logout_redirect_uri	`String[]`	로그아웃 리다이렉트 URI 목록	X

PlusFriend

이름	타입	설명	필수
profile_id	`Int`	카카오톡 채널 ID	O
encoded_profile_id	`String`	카카오톡 채널 프로필 ID	O
uuid	`String`	카카오톡 채널 검색용 ID	O
profile_name	`String`	카카오톡 채널 프로필 닉네임	O
is_open	`Boolean`	카카오톡 채널 프로필 공개 여부 `true`: 공개 `false`: 비공개	O
is_blocked	`Boolean`	카카오톡 채널 채팅 차단 여부 `true`: 차단 `false`: 차단 아님	O
pf_url	`String`	카카오톡 채널 URL	O
site_url	`String`	사이트 URL	X
intro_message	`String`	소개 메시지	X
image_url	`String`	이미지 URL	X
phone_number	`String`	전화번호	X
friend_count	`Int`	친구 수	X

Enum: ScopeCategory

값	설명
NORMAL	일반 동의항목
REVIEW	검수 필요 동의항목

Enum: ScopeLevel

값	설명
REQUIRED	필수
OPTIONAL	선택
LAZY	이용 중 동의
NONE	사용 안함

Enum: ScopeType

값	설명
PRIVACY	개인정보 동의항목
SERVICE	접근권한 동의항목

Enum: Status

값	설명
ACTIVE	활성화
DEACTIVATED	비활성화

SSEConfig

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
status	`SSEClientStatus`	보안 이벤트 구독 설정 상태	O
sub_events	`SSEventType[]`	구독 중인 보안 이벤트 타입	X
method	`String`	보안 이벤트 전달 메서드, 아래 중 하나 `PUSH` `POLL`	X
push_url	`String`	보안 이벤트 전달 URL	X
created_at	`Date`	보안 이벤트 구독 설정 등록 시각	X
updated_at	`Date`	최종 변경 시각	X

SSEClientStatus

값	설명
ENABLED	활성
DISABLED	비활성
PAUSED	중지

Enum: SSEventType

타입별 상세 설명은 보안 이벤트 타입 참고

값	설명
1	OAUTH_TOKEN_ISSUED
2	OAUTH_TOKEN_REVOKED
3	OAUTH_TOKENS_REVOKED
4	OAUTH_CLIENT_DISABLED
5	OAUTH_CLIENT_ENABLED
6	OAUTH_CLIENT_CREDENTIAL_CHANGED
7	OAUTH_USER_LINKED
8	OAUTH_USER_UNLINKED
9	OAUTH_USER_SCOPE_CONSENT
10	OAUTH_USER_SCOPE_WITHDRAW
11	CAEP_SESSION_REVOKED
12	CAEP_TOKEN_CLAIMS_CHANGE
13	CAEP_CREDENTIAL_CHANGE
14	CAEP_ASSURANCE_LEVEL_CHANGE
15	CAEP_DEVICE_COMPLIANCE_CHANGE
21	RISC_ACCOUNT_CREDENTIAL_CHANGE_REQUIRED
22	RISC_ACCOUNT_PURGED
23	RISC_ACCOUNT_DISABLED
24	RISC_ACCOUNT_ENABLED
25	RISC_IDENTIFIER_CHANGED
26	RISC_IDENTIFIER_RECYCLED
27	RISC_CREDENTIAL_COMPROMISE
29	RISC_RECOVERY_ACTIVATED
30	RISC_RECOVERY_INFORMATION_CHANGED
31	RISC_SESSIONS_REVOKED
41	KAKAO_USER_SERVICE_TERM_CONSENT
42	KAKAO_USER_SERVICE_TERM_WITHDRAW

UserManagementSettings

이름	타입	설명	필수
auto_register_on_login	`Boolean`	자동 연결 설정 활성화 여부 `true`: 자동 연결 `false`: 수동 연결	O
lazy_age_auth	`Boolean`	연령인증 중 필요 시 연령인증 방식 사용 여부 `true`: 사용 `false`: 미사용	O
forced_agreement	`Boolean`	인하우스 앱에 동의 화면 강제 호출 기능 사용 여부 `true`: 사용 `false`: 미사용 참고: 인하우스 앱의 카카오 로그인	O
keep_user_id	`Boolean`	사용자 ID 고정 설정 활성화 여부 `true`: 사용자 ID 고정 활성화 `false`: 사용자 ID 고정 비활성화	X
not_allowed_under_age14	`Boolean`	만 14세 미만 사용자에 대한 보호자 동의 사용 여부 `true`: 사용 `false`: 미사용	X
usingPropertyProfile	`Boolean`	사용자 프로퍼티 사용 여부 `true`: 사용 `false`: 미사용	X

내 애플리케이션: 카카오싱크

ECPApp

이름	타입	설명	필수
id	`Int`	ECP 앱 ID	O
app_id	`Int`	앱 ID	O
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O
ecp_key	`String`	호스팅사에서 쇼핑몰에 발급하는 식별자 카카오와 호스팅사의 카카오싱크 간편설정 팝업 연동을 위해 호스팅사에서 카카오로 전달	X
last_updated_by	`String`	ECP 앱 정보 최종 변경 경로 `WIZARD`: 카카오싱크 간편설정 팝업 `ADMIN`: 카카오 API 플랫폼 통합 어드민 `ASSUMPTION`: 어드민 API로 수정됨	O
status	`Status`	ECP 앱 상태	O
comment	`String`	관리자 메모	X
createdAt	`Date`	등록 시각	X
updatedAt	`Date`	최종 변경 시각	X

ServiceTerms

이름	타입	설명	필수
id	`Long`	서비스 약관 ID	O
app_id	`Int`	앱 ID	O
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택	O
url	`String`	상세 URL	X
status	`Status`	활성화 상태	O
created_at	`Date`	등록 시각	X
updated_at	`Date`	최종 변경 시각	X
deactivated_at	`Date`	비활성화 시각	X

내 애플리케이션: 사용자

Enum: DataType

값	설명
STRING	문자열
BOOLEAN	참(`TRUE`) 또는 거짓(`FALSE`)
NUMBER	숫자
DATE	날짜 및 시간

Enum: IdType

각 ID에 대한 상세 설명은 ID 종류, 사용자 정보 참고

값	설명
app_id	앱 ID
app_user_id	회원번호
account_id	카카오계정 ID
talk_user_id	카카오톡 회원번호
email	카카오계정 이메일
display_id	카카오계정 대표 정보

User

이름	타입	설명	필수
id	`Long`	회원번호	O
app_id	`Int`	앱 ID	O
account_type	`String`	사용자 계정 타입, `KAKAO`(카카오계정)로 고정	O
status	`UserStatus`	연결 상태	O
registered_at	`Datetime`	연결 시각	X
updated_at	`Datetime`	사용자 정보 최종 갱신 시각	X
synched_at	`Datetime`	카카오싱크 간편가입 시각	X
app_scopes	`AppScope[]`	사용자가 동의한 동의항목 목록	X
agreement_code_ids	`AgreementCodeId[]`	앱별로 추가 설정된 기타 동의항목 중, 사용자가 동의한 동의항목 목록	X

UserPropertyKey

이름	타입	설명	필수
id	`Long`	사용자 프로퍼티 ID	O
app_id	`Int`	앱 ID	O
name	`String`	사용자 프로퍼티 키 이름	O
data_type	`DataType`	사용자 프로퍼티의 데이터 타입	O
unique_key	`Boolean`	사용자 프로퍼티 키의 유일성(Unique key) 보장 여부 `TRUE`: 보장 `FALSE`: 보장하지 않음	O
status	`Long`	사용자 프로퍼티 상태	O
created_at	`Date`	사용자 프로퍼티 등록 시각	X
updated_at	`Date`	사용자 프로퍼티 최종 변경 시각	X

Enum: UserStatus

연결 상태 참고

값	설명
REGISTERED	연결
PREREGISTERED	연결 대기

UserResult

사용자 프로퍼티 참고

이름	타입	설명	필수
id	`Long`	회원번호	O
registered_at	`Datetime`	연결 시각	X
status	`UserStatus`	연결 상태	O
properties	`JSON`	사용자 프로퍼티	X

내 애플리케이션: 비즈 앱

BizApp

이름	타입	설명	필수
biz_app	`AppBusinessInfo`	비즈 앱 정보	O
id	`Int`	앱 ID	O
name	`String`	앱 이름(영문 기준 최대 45자)	O
company	`String`	회사명(영문 기준 최대 50자)	O
icon	`String`	앱 아이콘 이미지 URL	X
app_type	`AppType`	앱 타입	O
category	`AppCategory`	앱 카테고리	O
status	`AppStatus`	앱 상태	O
phase	`AppPhase`	테스트 앱 여부	O

AppBusinessInfo

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
biz_num	`String`	사업자 등록번호 (`(\d{3})-(\d{2})-(\d{5})` 형식) 참고: 개인 개발자 비즈 앱 전환 방법	X
biz_plus_friends	`String`	비즈니스 채널 연결 여부(비즈 채널 앱 여부) `TRUE`: 연결 `FALSE`: 미연결 (기본값: `FALSE`) 참고: 연결된 비즈니스 채널이 없더라도 값이 `TRUE`일 수 있음	O
created_at	`Datetime`	비즈 앱으로 전환된 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
updated_at	`Datetime`	비즈 앱 정보 변경 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X

내 애플리케이션: 서비스 설정

ApplicationServiceModel

이름	타입	설명	필수
app_id	`Int`	앱 ID	O
service_type	`ServiceType`	서비스 이름	O
status	`ApplicationServiceStatus`	서비스 상태	O
purpose	`String`	사용 목적	X
created_at	`Datetime`	서비스 사용 등록 시간 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
updated_at	`Datetime`	서비스 설정 변경 시간 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X

Enum: ApplicationServiceStatus

값	설명
ACTIVE	활성(사용 중)
DEACTIVATED	비활성

Enum: ServiceType

아래 목록에 없는 서비스 타입은 [서비스] API플랫폼 아지트로 문의

값	설명
USER_MANAGEMENT	카카오 로그인(구: 사용자 관리)
KAKAO_LINK	카카오톡 공유
KAKAO_TALK	카카오톡
FRIENDS	카카오 소셜
PLUS_FRIENDS	카카오톡 채널
APP	애플리케이션
KPUSHER	KPUSHER(푸시 알림)
INTERNAL	내부 API 호출

내 애플리케이션: 메시지 템플릿

TalkMessageTemplate

이름	타입	설명	필수
id	`Long`	메시지 템플릿 ID	O
appId	`Integer`	앱 ID	O
type	`MessageType`	메시지 발송 대상 유형	O
subtype	`String`	메시지 템플릿 UI 상태 분류 코드	O
deny	`Boolean`	메시지 템플릿의 기타 항목 사용 여부 `true`: 사용함 `false`: 사용 안함	O
template	`JSON`	메시지 템플릿 데이터	O
status	`Status`	메시지 템플릿 활성화 상태	O
callback	`Boolean`	카카오톡 공유 웹훅 사용 여부	O
sender_type	`SenderType`	메시지 전송에 사용할 API	O
version	`String`	카카오링크 버전	X
description	`String`	메시지 템플릿 설명(최대 45자)	X
created_at	`Datetime`	메시지 템플릿 생성 날짜	X
updated_at	`Datetime`	메시지 템플릿 수정 날짜	X

Enum: MessageType

값	설명
FEED	가입자에게만 전송
INVITE	미가입자에게 전송
BOTH	가입여부 무관

Enum: SenderType

값	설명
USER	카카오톡 공유/메세지 API
CHANNEL	카카오톡 채널 메세지 API

TalkMessageTemplateResult

이름	타입	설명	필수
appId	`Integer`	앱 ID	O
id	`Long`	메시지 템플릿 ID	O
template	`JSON`	메시지 템플릿 데이터	O
argumentKeys	`ArgumentKey[]`	메시지 템플릿 설정값 인자 배열	O
warning	`Warning`	유효성 검사 실패 시 경고 코드와 설명 객체	O

카카오게임 관리

Enum: AgeAuthLevel

인증 방식에 대한 설명은 연령인증 방식 참고

값	설명
0	NONE
1	AUTH_LEVEL1
2	AUTH_LEVEL2

AppExtension

값	타입	설명	필수
age_limit	`Int`	연령 제한 여부 `true`: 연령 제한 `false`: 연령 제한 없음	X
age_auth_level	`AgeAuthLevel`		X
plus_friend_ids	`String`	앱에 설정된 카카오톡 채널 ID 목록	X
gameshop_package_name	`String`	게임샵 패키지 이름	X
prepend_market_url	`String`	마켓 URL 앞부분	X
lazy_age_auth	`Boolean`	필요 시 연령인증 사용 여부 `true`: 사용 `false`: 미사용	X
ios_released_at	`Date`	iOS 출시일	X
android_released_at	`Date`	Android 출시일	X
web_released_at	`Date`	Web 출시일	X

DeveloperResult

값	타입	설명	필수
id	`Int`	개발자 계정 ID	O
account_id	`Int`	카카오계정 ID	O
name	`String`	개발자 계정 이름	O
registered_at	`Date`	개발자 계정 등록 시각 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X

Game

값	타입	설명	필수
id	`Int`	앱 ID	O
name	`String`	앱 이름	O
company	`String`	회사명(영문 기준 최대 50자)	O
app_type	`String`	앱 타입 `PARTNER`로 고정	X
app_category	`String`	앱 카테고리 `Games`로 고정	X
icon_image_kage_token	`String`	앱 아이콘 이미지의 KAGE 토큰	X
status	`AppStatus`	앱 상태	X
registered_at	`Date`	등록 시각	X
deactivated_at	`Date`	삭제 시각	X
owner_developer	`DeveloperResult`	앱 소유자인 개발자 계정 정보	X

GameApp

값	타입	설명	필수
id	`Int`	앱 ID	O
name	`String`	앱 이름	O
company	`String`	회사명(영문 기준 최대 50자)	O
app_type	`String`	앱 타입 `PARTNER`로 고정	X
app_category	`String`	앱 카테고리 `Games`로 고정	X
icon_image_kage_token	`String`	앱 아이콘 이미지의 KAGE 토큰	X
status	`AppStatus`	앱 상태	X
registered_at	`Date`	등록 시각	X
deactivated_at	`Date`	삭제 시각	X
owner_developer	`DeveloperResult`	앱 소유자인 개발자 계정 정보	X
app_key	`AppKey`	앱 키	X
partner_client_id	`Long`	파트너 클라이언트 ID	X
migration_start_at	`Date`	마이그레이션 시작 시각	X
partnership_expired_at	`Date`	계약 만료 일시	X
use_unique_nickname	`Boolean`	고유 닉네임 사용 여부 `true`: 사용 `false`: 미사용	X
auto_regi	`Boolean`	자동 연결 사용 여부 `true`: 사용 `false`: 미사용	X
pf	`Platform`	지원하는 플랫폼 정보	X
ae	`AppExtension`	추가 설정 정보	X

Platform

값	타입	설명	필수
android_package_name	`String`	Android 패키지 이름	X
android_market_url	`String`	Android 오픈마켓 URL	X
ios_bundle_id	`String`	iOS 번들 ID	X
iphone_app_store_id	`Long`	iPhone 앱스토어 ID	X
iphone_market_url	`String`	iPad 앱스토어 URL	X
ipad_app_store_id	`Long`	iPad 앱스토어 ID	X
ipad_market_url	`String`	iPad 앱스토어 URL	X
website_url	`String`	웹사이트 URL	X

개발자 계정 관리

DeveloperDspAccount

값	타입	설명	필수
developer_id	`Int`	개발자 계정 ID	O
dsp_account_id	`Long`	통합 계정 ID	O
created_at	`Date`	등록 시각	X

카카오계정 관리

KakaoAcount

값	타입	설명	필수
id	`Int`	카카오계정 ID	O
display_id	`String`	카카오계정 대표 정보	X
email	`String`	카카오계정 이메일	X
account_type	`AccountType`	카카오계정 타입	O
account_status	`AccountStatus`	카카오계정 상태 비트 연산(Bitwise operation)된 값으로, 여러 상태를 가진 경우 각 상태에 해당하는 값이 합쳐진 값으로 표시	O
verified_at	`Datetime`	카카오계정 인증 일시 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
created_at	`Datetime`	카카오계정 생성 일시 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
deactivated_at	`Datetime`	카카오계정 비활성화 일시 `YYYY-MM-DDTHH:mm:ssZ` 형식(ISO 8601)	X
talk_user_id	`Long`	카카오계정의 카카오톡 회원번호	X

Enum: AccountStatus

값	설명
1	일반(NORMAL)
2	휴면 예정(PRE_DORMANT)
4	휴면(DORMANT)
8	탈퇴(DEACTIVATED)
16	제재(BLOCKED)
32	사용자에 의한 보호(PROTECTED_BY_USER)
64	플랫폼에 의한 보호(PROTECTED_BY_KAKAO)
256	스팸(SPAM)

Enum: AccountType

값	설명
0	일반(NORMAL)
1	비즈(BUSINESS)
2	사업자/단체(CORPORATION)

ALFS

AlfsRuleFactorProperty

값	타입	설명	필수
id	`Int`	ALFS 규칙 내 Factor 등의 각 변경 사항에 대한 고유 ID	O
factor_id	`Int`	ALFS Factor ID	O
rule_id	`Int`	ALFS 규칙 ID	O
name	`String`	ALFS 규칙명	O
value	`String`	규칙 적용 기준 값 (예: 개발자 계정에 대한 차단 규칙인 경우, 개발자 계정 ID)	O
value_type	`String`	`value`의 타입	O
created_at	`Date`	등록 시각	X
updated_at	`Date`	최종 변경 시각	X

사이드 메뉴

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기