사이드 메뉴
커뮤니케이션
API 제공
어드민 API
이해하기
이 문서는 카카오 또는 공동체 서비스용 카카오톡 메시지 API를 소개합니다. 공통 설명은 오픈 문서를 참고합니다.
모든 사용자에게 제공하는 메시지 발송 기능의 종류는 메시지 발송 기능 안내에서 확인할 수 있습니다. 인하우스 앱은 카카오톡 채널로 메시지를 발송하는 카카오톡 채널 메시지 기능을 추가로 사용할 수 있습니다.
인하우스 또는 공동체 서비스의 앱은 카카오톡 메시지 API 사용 시, 권한 목록의 추가 기능과 API를 권한 획득 후 사용할 수 있습니다. 인하우스 앱은 권한이 없어도 멤버가 아닌 사용자간 메시지 발송 기능을 사용할 수 있습니다.
인하우스 앱을 제외한 서비스에 카카오톡 메시지 API로 친구에게 메시지 발송 기능을 적용하려면 추가 기능을 신청해 사용 권한을 얻어야 합니다. 사용 권한이 없는 앱과 그 앱의 테스트 앱에서는 앱의 멤버에게만 메시지를 보낼 수 있습니다.
아래 절차에 따라 사용 권한을 신청할 수 있습니다.
- 메시지 발송 기능의 종류에서 카카오 제공 메시지 발송 기능 중, 카카오톡 메시지 기능의 필요 여부를 확인합니다.
- 앱 관리 페이지의 [카카오 로그인] > [동의항목]에서 아래 두 가지 동의항목을 설정합니다.
- [개인정보] > [카카오 서비스 내 친구목록(프로필사진, 닉네임, 즐겨찾기 포함)]
- [접근권한] > [카카오톡 메시지 전송]
- 사용하려는 플랫폼별 개발 문서를 참고해 메시지 발송 기능을 구현합니다. 구현 시, 카카오톡 메시지 발송 흐름을 참고합니다.
- 앱 멤버를 대상으로 기능 동작 여부를 확인합니다. 인하우스 앱은 권한이 없어도 멤버가 아닌 사용자간 메시지 발송 기능을 사용할 수 있습니다.
- 인하우스 앱이 아닌 경우, 앱 멤버 이외의 사용자를 조회하고 메시지를 보내기 위해 필요한 사용 권한을 [앱] > [추가 기능 신청] > [카카오톡 친구/메시지] 항목에서 사용 권한을 신청해야 합니다. 추가 기능 신청 전 아래 작업을 완료해야 하며, 신청 시 추가 기능 신청 정보를 입력해야 합니다. 심사 결과는 앱 멤버들의 이메일로 발송됩니다.
인하우스 또는 공동체 서비스의 앱은 메시지 템플릿 도구에서 일반 앱보다 많은 설정을 제공합니다. 자세한 내용은 메시지 템플릿 도구를 참고합니다.
카카오 메시지 API는 더 나은 사용자 경험을 위해 쿼터(Quota, 제공량 제한)가 적용됩니다. 인하우스 또는 공동체 앱의 쿼터는 쿼터에서 확인할 수 있습니다.
초대 프로필 공개 상태 조회 API 또는 프로필 공개 상태 조회 API로 수신자의 프로필 공개 설정을 미리 확인할 수 있습니다. 프로필을 비공개로 설정한 수신자에게 카카오톡 메시지 API로 메시지 발송 시, -530 에러 코드가 반환되고 메시지가 전송되지 않습니다.
서비스 설정 메뉴에서 프로필 공개 설정을 할 수 있도록, 프로필 공개 설정 페이지를 호출하는 기능을 제공합니다. 해당 기능을 사용하려면 [서비스] API플랫폼 아지트로 문의합니다. 구현 예시는 아래 이미지를 참고합니다.

해당 기능 사용 시, 프로필 공개 상태 조회 API를 함께 사용하면 사용자의 현재 프로필 공개 설정 상태를 확인해 서비스 UI에 반영할 수 있습니다.
메시지 템플릿 도구로 생성한 사용자 정의 템플릿의 경우, 아래 조건을 모두 만족하는 경우에만 프로필 공개 설정 버튼이 노출됩니다.
- [사용 목적]이 [가입여부 무관]으로 설정되지 않은 경우
- 수신 설정 화면에서 [이 서비스의 친구 목록에 나를 보여주기]가 선택된 경우
각 API의 Kakao SDK 지원 여부는 지원 범위에서 확인할 수 있습니다.
| API | 설명 | 문서 |
|---|---|---|
| 나에게 기본 템플릿으로 메시지 발송 | 내 카카오톡으로 기본 템플릿 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 친구에게 기본 템플릿으로 메시지 발송 | 친구의 카카오톡으로 기본 템플릿 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 나에게 사용자 정의 템플릿으로 메시지 발송 | 내 카카오톡으로 사용자 정의 템플릿 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 친구에게 사용자 정의 템플릿으로 메시지 발송 | 친구의 카카오톡으로 사용자 정의 템플릿 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 나에게 스크랩 메시지 발송 | 내 카카오톡으로 웹페이지 스크랩 정보를 담은 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 친구에게 스크랩 메시지 발송 | 친구의 카카오톡으로 웹페이지 스크랩 정보를 담은 메시지를 발송합니다. | REST API JavaScript Android iOS |
| 플레인 메시지 발송 | 사용자 자신, 또는 다른 사용자나 채팅방에 카카오톡 메시지를 발송합니다. | REST API |
| 프로필 공개 설정 화면 요청 | 사용자가 현재 로그인한 앱으로부터의 메시지 수신 여부를 설정할 수 있는 웹 페이지를 불러옵니다. | REST API |
| 초대 프로필 공개 상태 조회 | 특정 사용자의 초대 친구 목록에 대한 프로필 공개 설정을 확인합니다. | REST API |
| 프로필 공개 상태 조회 | 특정 사용자의 친구 목록에 대한 프로필 공개 설정을 확인합니다. | REST API |
| 이미지 업로드 | KAGE 분산 스토리지로 메시지 발송 API에 사용할 이미지를 업로드합니다. | REST API JavaScript Android iOS |
| 이미지 스크랩 | 카카오 내부 또는 외부에 존재하는 웹 URL의 이미지 정보를 KAGE에 스크랩합니다. | REST API JavaScript Android iOS |
| 이미지 삭제 | KAGE에 업로드한 이미지를 삭제합니다. | REST API JavaScript |
| 인하우스 앱: 비연결된 사용자에게 메시지 발송 | 연결 상태에 대한 제약 없이 사용자 ID만으로 원하는 대상에게 메시지를 발송합니다. | REST API |