사이드 메뉴
커뮤니케이션
API 제공
어드민 API
이용 안내
지원 범위
이 문서는 카카오 또는 공동체 서비스용 카카오 API의 지원 범위를 안내합니다.
이 문서의 각 표는 아래와 같은 열로 구성돼 있습니다.
| 분류 | 설명 |
|---|---|
| REST API | REST API 지원 여부를 나타냅니다. |
| JavaScript | Kakao SDK for JavaScript 지원 여부를 나타냅니다. |
| Android | Kakao SDK for Android 및 Kakao Partner SDK for Android 지원 여부를 나타냅니다. |
| iOS | Kakao SDK for iOS 및 Kakao Partner SDK for iOS 지원 여부를 나타냅니다. |
| 연결 상태 조건 | API 호출에 필요한 앱과 사용자의 연결 상태 조건을 아래와 같이 기호로 표기합니다. ●: 연결 ◎: 연결, 연결 대기 ○: 연결, 연결 대기, 연결 없음* △: 연결 대기 -: 연결 상태 무관 참고: 일부 API는 카카오 로그인으로 앱과 사용자가 연결된 상태에서만 호출할 수 있습니다. 헤더의 인증 정보에 카카오 로그인으로 발급받은 액세스 토큰(Access token)을 사용하거나, 대상 사용자 ID를 지정해 요청하는 API는 연결 상태 조건을 확인해야 합니다. |
이 문서의 API 이름 옆에 표기된 뱃지는 아래와 같은 의미를 나타냅니다.
| 표기 | 설명 |
|---|---|
Permission | 카카오와 공동체 모두 별도 권한을 신청해야 사용할 수 있는 API입니다. 권한을 참고합니다. |
Inhouse | 공동체에서는 사용할 수 없거나, 별도 권한을 신청해야 사용할 수 있는 API입니다. 권한을 참고합니다. |
Internal | API 이름의 Internal 뱃지는 해당 API가 내부 API로만 제공된다는 의미입니다. REST API는 호출 지점에 따라 보다 다양한 인증 수단이나 데이터를 제공하는 내부 API를 호출할 수 있습니다. 일부 API는 내부 API로만 제공하거나, 내부 API를 제공하지 않을 수 있습니다. 자세한 안내는 방화벽을 참고합니다. |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 인가 코드 요청 | ✔ | ✔ | - | ||
| 토큰 요청 | ✔ | - | |||
| 카카오톡으로 로그인 | ✔ | ✔ | ✔ | - | |
| 카카오계정으로 로그인 | ✔ | ✔ | ✔ | - | |
| 토큰 존재 여부 조회 | ✔ | ✔ | - | ||
| 로그아웃 | ✔ | ✔ | ✔ | ✔ | ◎ |
| 카카오계정과 함께 로그아웃 | ✔ | ◎ | |||
| 수동 연결 | ✔ | ✔ | ✔ | △ | |
| 연결 해제 | ✔ | ✔ | ✔ | ✔ | ◎ |
| 액세스 토큰 정보 조회 | ✔ | ✔ | ✔ | ◎ | |
| 토큰 갱신 | ✔ | ◎ | |||
| 동의항목 동의 내역 조회 | ✔ | ✔ | ✔ | ✔ | ◎ |
| 동의항목 동의 철회 | ✔ | ✔ | ✔ | ✔ | ◎ |
| 서비스 약관 동의 내역 조회 Permission | ✔ | ✔ | ✔ | ✔ | ◎ |
| 서비스 약관 동의 철회 Permission | ✔ | ✔ | ✔ | ✔ | ◎ |
| 서비스 약관 선택해 동의 요청 Permission | ✔ | ✔ | ✔ | ✔ | - |
| 채널 선택해 동의 요청 Permission | ✔ | ✔ | ✔ | ✔ | - |
| OIDC: 메타데이터 조회 | ✔ | - | |||
| OIDC: 공개키 목록 조회 | ✔ | - | |||
| OIDC: ID 토큰 정보 조회 | ✔ | - | |||
| OIDC: 사용자 정보 조회 | ✔ | - | |||
| 고급: 동의항목 동의 처리 Inhouse | ✔ | ✔ | ✔ | ◎ | |
| 고급: 서비스 약관에 동의 Permission | ✔ | ◎ | |||
| 연령인증 정보 조회 Inhouse | ✔ | ✔ | ✔ | ● | |
| 연령인증 페이지 호출 Permission | ✔ | ✔ | ✔ | ◎ |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 사용자 정보 조회 | ✔ | ✔ | ✔ | ✔ | ◎ |
| 사용자 목록 조회 | ✔ | - | |||
| 여러 사용자 정보 조회 | ✔ | - | |||
| 사용자 프로퍼티 저장 | ✔ | ✔ | ✔ | ✔ | ● |
| 배송지 조회 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 채팅방 멤버 선택 Inhouse | ✔ | ● | |||
| 배송지 등록 Inhouse | ✔ | ● | |||
| 배송지 수정 Inhouse | ✔ | ● | |||
| 사용자 ID 조회 Inhouse Internal | ✔ | - | |||
| 그룹 내 사용자 정보 조회 Permission | ✔ | ● | |||
| 그룹 사용자 토큰 생성 Permission | ✔ | ● | |||
| 연결된 앱 정보 조회 Inhouse Internal | ✔ | ○ | |||
| 앱 연결 이력 조회 Inhouse Internal | ✔ | ○ | |||
| 카카오계정 상태 조회 Internal | ✔ | ◎ | |||
| 카카오계정 검색 Internal | ✔ | ◎ | |||
| 앱에 연결된 카카오계정 휴면 방지 Internal | ✔ | ● | |||
| 앱과 사용자 인증 Permission Internal | ✔ | ● | |||
| 회원번호 사전 발급 Permission Internal | ✔ | - | |||
| 공동체 앱: 사용자 분석 데이터 조회 Permission Internal | ✔ | ● | |||
| 공동체 앱: 본인인증 정보 등록 가능 여부 조회 Permission Internal | ✔ | ◎ | |||
| 공동체 앱: 카카오계정에 본인인증 정보 등록 Permission Internal | ✔ | ● | |||
| 공동체 앱: 카카오계정에서 본인인증 정보 삭제 Permission Internal | ✔ | ● | |||
| 공동체 앱: 카카오계정과 본인인증 정보 비교 Permission Internal | ✔ | ● |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 카카오톡 프로필 조회 | ✔ | ✔ | ✔ | ✔ | ● |
| 사용자 목록으로 카카오톡 프로필 조회 Inhouse Internal | ✔ | ● | |||
| 피커: 친구 선택 Inhouse | ✔ | ✔ | ✔ | ● | |
| 피커: 채팅방 선택 Inhouse | ✔ | ✔ | ✔ | ● | |
| 피커: 채팅방 멤버 선택 Inhouse | ✔ | ✔ | ✔ | ● | |
| 피커: 친구 또는 채팅방 선택 Inhouse | ✔ | ✔ | ✔ | ● | |
| 피커: 친구 또는 채팅방 멤버 선택 Inhouse | ✔ | ✔ | ✔ | ● | |
| 카카오톡 친구 목록 조회 | ✔ | ✔ | ✔ | ✔ | ● |
| 카카오톡 친구 목록 조회 Inhouse | ✔ | ✔ | ✔ | ● | |
| 채팅방 목록 조회 Inhouse | ✔ | ✔ | ✔ | ● | |
| 채팅방 정보 조회 Inhouse | ✔ | ● | |||
| 채팅방 멤버 조회 Inhouse | ✔ | ✔ | ✔ | ● | |
| 읽지 않은 채팅방 목록 조회 Inhouse Internal | ✔ | ● | |||
| 멜론: 카카오톡 프로필 뮤직에 곡 추가 Permission | ✔ | ● |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 나에게 기본 템플릿으로 메시지 발송 | ✔ | ✔ | ✔ | - | |
| 친구에게 기본 템플릿으로 메시지 발송 | ✔ | ✔ | ✔ | - | |
| 나에게 사용자 정의 템플릿으로 메시지 발송 | ✔ | ✔ | ✔ | - | |
| 친구에게 사용자 정의 템플릿으로 메시지 발송 | ✔ | ✔ | ✔ | - | |
| 나에게 스크랩 메시지 발송 | ✔ | ✔ | ✔ | - | |
| 친구에게 스크랩 메시지 발송 | ✔ | ✔ | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 나에게 기본 템플릿으로 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 친구에게 기본 템플릿으로 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 나에게 사용자 정의 템플릿으로 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 친구에게 사용자 정의 템플릿으로 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 나에게 스크랩 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 친구에게 스크랩 메시지 발송 Inhouse | ✔ | ✔ | ✔ | ✔ | ● |
| 플레인 메시지 발송 Permission Internal | ✔ | ● | |||
| 프로필 공개 설정 화면 요청 | ✔ | ● | |||
| 초대 프로필 공개 상태 조회 Permission Internal | ✔ | - | |||
| 프로필 공개 상태 조회 Permission Internal | ✔ | ● | |||
| 이미지 업로드 | ✔ | ✔ | ✔ | ✔ | ●* |
| 이미지 스크랩 | ✔ | ✔ | ✔ | ✔ | ●* |
| 이미지 삭제 | ✔ | ✔ | ●* |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 사용자 정의 템플릿으로 메시지 발송 Inhouse | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 채팅방 생성 Permission | ✔ | ● | |||
| 채팅방 정보 변경 Permission | ✔ | ● | |||
| 채팅방 삭제 Permission | ✔ | ● | |||
| 오픈채팅 조회 Permission | ✔ | ● | |||
| 채팅방 입장 Permission | ✔ | ● | |||
| 채팅방 퇴장 Permission | ✔ | ● | |||
| 멤버 프로필 변경 Permission | ✔ | ● | |||
| 방장 변경 Permission | ✔ | ● | |||
| 부방장 설정 Permission | ✔ | ● | |||
| 피드 등록 Permission | ✔ | - | |||
| 나에게 기본 템플릿으로 메시지 발송 Permission | ✔ | ● | |||
| 친구에게 기본 템플릿으로 메시지 발송 Permission | ✔ | ● | |||
| 나에게 사용자 정의 템플릿으로 메시지 발송 Permission | ✔ | ● | |||
| 친구에게 사용자 정의 템플릿으로 메시지 발송 Permission | ✔ | ● | |||
| 나에게 스크랩 메시지 발송 Permission | ✔ | ● | |||
| 친구에게 스크랩 메시지 발송 Permission | ✔ | ● | |||
| 카카오페이: 오픈채팅 사용자 검증 Permission Internal | ✔ | ● | |||
| 카카오페이: 오픈채팅 멤버 여부 조회 Permission Internal | ✔ | ● |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 소셜 플러그인: 카카오톡 채널 채팅 | ✔ | ✔ | ✔ | - | |
| 소셜 플러그인: 카카오톡 채널 친구 추가 | ✔ | ✔ | ✔ | - | |
| 카카오톡 채널 프로필 조회 Permission | ✔ | - | |||
| 카카오톡 채널 관계 조회 Inhouse | ✔ | ✔ | ✔ | ✔ | ◎ |
| 여러 사용자 카카오톡 채널 관계 조회 | ✔ | ◎ | |||
| 카카오톡 채널 친구 추가 Inhouse | ✔ | ◎ |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 사용자 캘린더 > 목록 조회 Permission | ✔ | ● | |||
| 사용자 캘린더 > 서브 캘린더 생성 Permission | ✔ | ● | |||
| 사용자 캘린더 > 서브 캘린더 수정 Permission | ✔ | ● | |||
| 사용자 캘린더 > 서브 캘린더 삭제 Permission | ✔ | ● | |||
| 일반 일정 > 생성 Permission | ✔ | ● | |||
| 일반 일정 > 목록 조회 Permission | ✔ | ● | |||
| 일반 일정 > 상세 조회 Permission | ✔ | ● | |||
| 일반 일정 > 수정 Permission | ✔ | ● | |||
| 일반 일정 > 수정: 게스트 일정 Permission | ✔ | ● | |||
| 일반 일정 > 삭제 Permission | ✔ | ● | |||
| 공개 일정 > 생성 Permission | ✔ | - | |||
| 공개 일정 > 목록 조회 Permission | ✔ | - | |||
| 공개 일정 > 상세 조회 Permission | ✔ | - | |||
| 공개 일정 > 수정 Permission | ✔ | - | |||
| 공개 일정 > 삭제 Permission | ✔ | - | |||
| 공개 일정 > 사용자 캘린더에 추가 Permission | ✔ | ● | |||
| 구독 캘린더 > 구독 가능 캘린더 목록 조회 Permission | ✔ | - | |||
| 구독 캘린더 > 구독 Permission | ✔ | ● | |||
| 구독 캘린더 > 구독 해제 Permission | ✔ | ● | |||
| 공휴일 및 주요 기념일 조회 Permission | ✔ | - | |||
| 할 일 > 생성 Permission | ✔ | ● | |||
| 할 일 > 조회 Permission | ✔ | ● | |||
| 할 일 > 도전 기록 조회 Permission | ✔ | ● | |||
| 할 일 > 수정 Permission | ✔ | ● | |||
| 할 일 > 완료 여부 설정 Permission | ✔ | ● | |||
| 할 일 > 삭제 Permission | ✔ | ● | |||
| 할 일 > 완료 항목 일괄 삭제 Permission | ✔ | ● |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 문자 메시지 발송 Permission | ✔ | - | |||
| 요청 ID로 발송 결과 조회 Permission | ✔ | - | |||
| 문자 메시지 ID로 발송 결과 조회 Permission | ✔ | - | |||
| 수신거부 등록 Permission | ✔ | - | |||
| 수신거부 삭제 Permission | ✔ | - | |||
| 문자 메시지 수신 번호 할당 Permission | ✔ | - | |||
| 문자 메시지 수신 상태 조회 Permission | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 음성 인식 > 단문 인식: 웹 소켓 Permission | ✔ | - | |||
| 음성 인식 > 장문 인식: 웹 소켓 Permission | ✔ | - | |||
| 음성 인식 > 동기 인식: 파일 업로드 Permission | ✔ | - | |||
| 음성 인식 > 비동기 인식: 파일 업로드 Permission | ✔ | - | |||
| 음성 인식 > 음성 파일 업로드 상태 조회 Permission | ✔ | - | |||
| 음성 합성 Permission | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 앱 상세 정보 조회 Internal | ✔ | - | |||
| 플러그인 설정 조회 Permission Internal | ✔ | - | |||
| ECP 앱 정보 조회 Permission | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 이미지 업로드 | ✔ | - | |||
| 이미지 스크랩 | ✔ | - | |||
| 이미지 삭제 | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 카카오 API 플랫폼 이용 정보 조회 Permission Internal | ✔ | - | |||
| 연결된 앱 목록 조회 Permission Internal | ✔ | - | |||
| 연결된 앱 상세 정보 조회 Permission Internal | ✔ | - | |||
| 연결 해제된 앱 목록 조회 Permission Internal | ✔ | - | |||
| 연결 해제된 앱 상세 정보 조회 Permission Internal | ✔ | - | |||
| 모든 앱에서 로그아웃 Permission Internal | ✔ | - | |||
| 14세 미만 차단 앱에서 로그아웃 Permission Internal | ✔ | - | |||
| 연결 해제 가능 여부 조회 Permission Internal | ✔ | - | |||
| 모든 정보 삭제 가능 여부 조회 Permission Internal | ✔ | ● | |||
| 특정 앱과 연결 해제 Permission Internal | ✔ | ● | |||
| 모든 앱과 연결 해제 Permission Internal | ✔ | - | |||
| 약관 동의 철회 시 연결 해제 Permission Internal | ✔ | - | |||
| 연령인증 정보 초기화 상태 반영 Permission Internal | ✔ | - | |||
| 카카오디벨로퍼스 탈퇴 가능 여부 조회 Permission Internal | ✔ | - | |||
| 이메일로 카카오계정 검색 Permission Internal | ✔ | - | |||
| 다른 사용자 카카오계정 조회 Permission Internal | ✔ | ● |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 카카오페이: 사용자 통계 조회 Permission Internal | ✔ | ● | |||
| 카카오뱅크: 카카오 선물하기 서비스 이용 내역 조회 Permission | ✔ | ● | |||
| 카카오뱅크: 카카오T 서비스 이용 내역 조회 Permission | ✔ | ● | |||
| 카카오비즈니스: 탈퇴 가능 여부 조회 Permission Internal | ✔ | - |
| API | REST API | JavaScript | Android | iOS | 연결 상태 조건 |
|---|---|---|---|---|---|
| 패시브 연동 Inhouse | ✔ | - |