본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

관련사이트

사이드 메뉴

플랫폼 API

API 제공

전용 API

어드민 API

이 문서는 카카오 또는 공동체 서비스용 카카오 소셜 API를 소개합니다. 공통 설명은 오픈 문서를 참고합니다.

인하우스 또는 공동체 서비스의 앱은 카카오 소셜 API 사용 시, 권한을 획득한 카카오 소셜 목록의 추가 기능을 사용할 수 있습니다.

인하우스와 공동체 서비스의 앱은 확장된 피커 기능을 사용할 수 있습니다. 공동체 앱은 일부 기능을 사용하려면 권한이 필요합니다. 자세한 내용은 공동체 앱 추가 권한 신청을 참고합니다.

피커 사용 방법은 아래 과정을 참고합니다.

  1. 앱 관리 페이지의 [카카오 로그인] > [동의항목]에서 아래 동의항목을 설정합니다. (참고: 동의항목)
    • 친구 피커: [카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)]
    • 채팅방 피커: [카카오톡 챗방 목록]
  2. 개발 문서를 참고해 소셜 기능 구현합니다.
  3. 앱의 멤버를 대상으로 테스트합니다.

공동체 앱에서 아래의 기능이 필요한 경우, [서비스] API플랫폼 아지트에서 추가 권한 신청이 필요합니다. 인하우스 앱은 해당 권한을 보유하고 있어 권한 신청이 불필요합니다.

  • 채팅방 피커를 사용하고 싶은 경우
  • 선택 가능한 대상 제한이 필요한 경우
  • 카카오 정책 및 관련 규제에 따라 [카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)]에 동의하지 않은 사용자의 정보를 제공받는 경우, 아래 표 참조
필요한 응답 권한설명
미동의 친구 목록앱과 연결(가입)되었으나 [카카오 서비스내 친구목록]에 동의하지 않은 친구,
또는 앱과 연결되지 않은 친구(초대 친구)를 친구 목록에 노출하기 위해 필요한 권한
정책 검토 필요

중요: 미동의 친구 목록 권한이 있더라도 프로필 공개 설정을 비공개로 설정한 사용자는 친구 목록에 포함되지 않음
미동의 사용자 프로필응답 제공에 필요한 동의항목에 동의하지 않은 친구의 프로필은 제한된 정보만 제공
미동의 친구의 프로필을 받으려면 추가 권한 필요
친구의 동의 여부와 관계 없이 선택된 친구의 전체 프로필을 제공받으려면 권한 필요
정책 및 규제 검토 필요(담당자: @tony.k, @wonny.shin)

중요: [카카오 서비스내 친구목록]에 미동의한 친구의 경우, 미동의 친구 목록 권한이 있다면 친구 목록에 노출되지만, 해당 친구 선택 시 서비스에는 마스킹 처리된 닉네임 값만 제공됨(프로필 사진 미제공)
참고: 송금이나 재화 선물 등 금전적인 거래가 이루어지는 시나리오에 한해 신청 가능
필터링 옵션국가코드: 카카오톡에 등록된 전화번호의 국가 코드를 토대로 요청 결과를 필터링할 때 사용
카카오톡 OS: 친구의 카카오톡 가입 기기의 OS 정보를 토대로 요청 결과를 필터링할 때 사용
개인정보 검토 필요(담당자: @tony.k, @wonny.shin)

피커는 사용자가 선택한 카카오톡 소셜 정보를 사용할 수 있는 사용자 인터페이스입니다.

피커를 사용해 한 번의 Kakao SDK 함수 또는 메서드 호출만으로도 서비스에 필요한 친구 및 채팅방 목록 UI를 표시하고 사용자가 선택한 친구, 채팅방, 채팅방 멤버의 정보를 제공받아 간편하게 활용할 수 있습니다.

피커는 친구 피커 또는 채팅방 피커를 단독으로 사용하거나, 하나의 화면에서 탭 형태로 전환하는 탭 피커로 사용할 수 있습니다. 아래 종류별 특징을 참고합니다.

피커 종류친구 피커채팅방 피커:
채팅방 정보
채팅방 피커:
채팅방 멤버 정보
기능친구 피커를 표시하고 사용자가 선택한 친구 정보를 제공
(참고: 예시 화면)
채팅방 피커를 표시하고 사용자가 선택한 채팅방 정보 제공
(참고: 예시 화면)
채팅방 피커를 표시하고 사용자가 선택한 채팅방 멤버 정보 제공
(참고: 예시 화면)
피커 노출 대상[카카오 서비스내 친구목록]에 동의한 카카오톡 친구 목록

참고: 권한에 따라 미동의 친구 목록을 제공받아 서비스 가입이나 초대를 유도하는데 활용 가능
카카오톡에서 제공하는 채팅방 목록과 동일,
최대 20개까지 노출,
일반채팅, 오픈채팅
채팅방 피커(일반채팅만 제공)에서 선택한 채팅방의 멤버 목록
목록 정렬 기준시스템 설정 언어 기준으로 오름차순 정렬(예: ㄱ-ㅎ)
시스템 언어를 영어로 설정한 경우, 영어 닉네임이 친구 피커 상단에 A-Z 순으로 우선 정렬되고 인덱스 뷰가 알파벳을 기준으로 표시
카카오톡 메시지 기준으로 내림차순(최신순)카카오톡 가입일자 기준으로 오름차순 정렬(오래된 순)
제공하는 응답 데이터*사용자가 선택한 친구 정보사용자가 선택한 채팅방 정보사용자가 선택한 카카오톡 채팅방 멤버 정보
친구가 아닌 채팅방 멤버도 선택 가능
피커 형태싱글 또는 멀티 피커싱글 피커싱글 또는 멀티 피커
* 사용자 정보의 경우, 각 사용자의 필요한 동의항목 동의 여부에 따라 응답 데이터 구성이 다를 수 있음

친구 피커는 사용자의 친구 목록 UI를 출력하고, 사용자가 선택한 친구의 정보를 제공합니다. 한 명의 친구만 선택 가능한 싱글 피커, 여러 명의 친구를 선택 가능한 멀티 피커 두 종류로 나뉩니다.

친구 피커 예시

채팅방 피커는 사용자의 카카오톡 채팅 목록을 출력하고, 선택한 채팅방의 정보를 제공합니다. 채팅방 피커 호출 시 파라미터를 지정해 사용자가 선택한 채팅방 멤버의 정보를 제공하는 채팅방 멤버 피커도 사용할 수 있습니다.

채팅방 피커 예시

탭 피커는 탭 구조로 친구 피커와 채팅방 피커를 함께 제공합니다. [친구] 탭에서는 친구 피커를, [채팅] 탭에서는 채팅방 피커를 각각 제공합니다.

탭 피커 예시

피커는 서비스에 맞게 다양한 형태로 구현할 수 있습니다. 친구 피커 커스텀 요소를 참고합니다.

기능상세
화면 표시 형태풀 스크린 또는 팝업
(참고: 화면 표시 형태)

중요: JavaScript SDK는 풀 스크린 형태만 제공
선택 유형멀티 피커 또는 싱글 피커
(참고: 친구 선택 유형)

중요: 피커 종류별로 지원하는 선택 유형 다름
구조친구 피커 또는 채팅방 피커를 단독으로 제공
친구 피커와 채팅방 피커를 탭 구조로 함께 제공
다국어 지원한국어, 영어, 일본어

이 외에 카카오와 공동체는 피커에 필터링 기능을 적용할 수 있습니다. 선택 가능한 대상을 제한을 참고합니다.

피커 호출 시 파라미터 설정에 따라 친구 목록이나 채팅방 목록에서 선택 가능한 대상을 제한할 수 있습니다.

아래 필터링 파라미터 설정에 따라 친구 목록과 채팅방 목록에서 보여지는 대상이 다릅니다. 친구나 채팅방 목록에 노출되어도 disableSelectOptions 설정에 따라 사용자가 선택할 수 없도록 할 수 있습니다.

  • 친구 피커 필터링 파라미터: friendFilter, countryCodeFilters, usingOsFilter
  • 채팅방 피커 필터링 파라미터: chatFilters

피커에서 필요한 동의항목에 동의하지 않은 친구나 앱과 연결되지 않는 친구의 프로필 닉네임은 마스킹 처리되어 제한된 정보로 제공됩니다. 이들의 원본 닉네임을 얻으려면 아래 조건을 만족해야 합니다.

  • [미동의 사용자 프로필] 권한 필요 (참고: 피커: 추가 권한 신청)
    • 해당 권한이 없으면 profileNickname은 마스킹된 닉네임으로 제공
  • displayAllProfiletrue로 설정

프로필에 적용되는 마스킹 규칙은 아래와 같습니다.

닉네임 글자 수마스킹 처리 규칙
한 글자마스킹 처리 없이 닉네임 그대로 노출
두 글자마지막 글자만 마스킹 처리
세 글자가운데 글자만 마스킹 처리
네 글자 이상닉네임의 절반 이후 글자들은 모두 마스킹 처리

카카오 소셜 API는 더 나은 사용자 경험을 위해 쿼터(Quota, 제공량 제한)가 적용됩니다. 인하우스 또는 공동체 앱의 쿼터는 쿼터에서 확인할 수 있습니다.

일부 기능은 앱에 아래 동의항목을 설정하고, 사용자에게 동의를 받아야 사용할 수 있습니다. 조회 대상 또한 응답 제공에 필요한 동의항목에 동의해야 합니다.

기능필요한 동의항목
친구 피커카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
채팅방 피커카카오톡 챗방 목록*
카카오톡 친구 목록 조회카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
읽지 않은 채팅방 목록 조회카카오톡 챗방 목록*
인하우스 앱: 카카오톡 친구 목록 조회카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
인하우스 앱: 채팅방 목록 조회카카오톡 챗방 목록
인하우스 앱: 채팅방 멤버 조회카카오톡 챗방 목록
* 공동체 앱은 동의항목 설정 권한 필요

피커나 API로 정보를 제공받으려면 조회 대상이 아래 동의항목에 동의해야 합니다.

기능응답 정보필요한 동의항목
카카오톡 프로필 조회닉네임프로필 정보(닉네임/프로필 사진) 또는 닉네임
카카오톡 프로필 조회프로필 사진프로필 정보(닉네임/프로필 사진) 또는 프로필 사진
사용자 목록으로 카카오톡 프로필 조회닉네임프로필 정보(닉네임/프로필 사진) 또는 닉네임
사용자 목록으로 카카오톡 프로필 조회프로필 사진프로필 정보(닉네임/프로필 사진) 또는 프로필 사진
카카오톡 친구 목록 조회기본 정보*, 닉네임, 프로필 사진카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
읽지 않은 채팅방 목록 조회읽지 않은 채팅방 목록카카오톡 챗방 목록
친구 피커기본 정보*, 닉네임, 프로필 사진카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
채팅방 피커채팅방 목록채팅방 정보
채팅방 피커채팅방 멤버 닉네임프로필 정보(닉네임/프로필 사진) 또는 닉네임
채팅방 피커채팅방 멤버 프로필 사진프로필 정보(닉네임/프로필 사진) 또는 프로필 사진
인하우스 앱: 카카오톡 친구 목록 조회기본 정보*, 닉네임, 프로필 사진카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)
인하우스 앱: 채팅방 목록 조회채팅방 목록카카오톡 챗방 목록
인하우스 앱: 채팅방 멤버 조회채팅방 멤버 목록카카오톡 챗방 목록
* 기본 정보: 회원번호, UUID, 즐겨찾기 여부
미동의 친구 정보 조회 방법

앱과 연결(가입)되지 않았거나 [카카오 서비스내 친구목록(즐겨찾기, 프로필사진, 닉네임 포함)] 동의항목에 동의하지 않은 미동의 친구의 정보는 피커로 받을 수 있습니다. 공동체 앱은 추가 권한이 필요합니다. 인하우스 앱인 경우, 인하우스 앱: 카카오톡 친구 목록 조회 API를 사용할 수도 있습니다.

피커의 친구 목록, 카카오톡 친구 정보 조회와 친구 정보 조회 응답은 아래 조건을 만족하는 친구 정보만 포함합니다.

기능친구 정보 제공 조건
공통해당 친구를 카카오톡에서 숨김 또는 차단하지 않았을 것
친구가 프로필 공개 설정을 비공개로 설정하지 않았을 것
카카오톡 친구 목록 조회친구가 앱과 연결된 상태일 것
친구가 앱 연결 시 [카카오 서비스 내 친구 목록 제공] 동의항목에 동의한 상태일 것

중요: 위 조건을 만족하지 않는 친구 정보 제공 불가
인하우스 앱: 카카오톡 친구 목록 조회앱과 연결된 친구 목록 요청 시, 카카오톡 친구 목록 조회와 조건 동일
피커피커: 친구 정보 제공 조건 참고
* 카카오계정 없이 카카오톡을 사용하거나, 카카오계정이 제재 또는 휴면 상태인 친구의 정보는 제공하지 않음

친구 피커에 사용자의 친구가 노출되는 조건은 아래와 같습니다. 자세한 내용은 친구 정보 제공 조건을 참고합니다.

카카오 정책 및 관련 규제에 따라, 친구의 동의 여부에 따라 정보 제공 범위가 다릅니다. 사용자의 친구가 [카카오 서비스 내 친구 목록 제공]에 동의하지 않으면 아래와 같이 제한된 정보를 제공합니다. 마스킹 없이 원본 닉네임을 얻으려면 피커: 추가 권한 신청을 참고합니다.

친구 정보동의미동의
회원 번호O*O*
UUIDOO
프로필 닉네임O마스킹 처리된 프로필 닉네임
마스킹된 닉네임OO
프로필 사진O-
즐겨찾기 여부O-

카카오톡 친구 목록 조회, 인하우스 앱: 카카오톡 친구 목록 조회 요청 시 친구 정렬 순서는 즐겨찾기순, 닉네임순으로 지정할 수 있습니다. 기본값은 즐겨찾기순입니다.

  • 즐겨찾기순
    • 오름차순일 때 즐겨찾기 친구를 상위 정렬
    • 내림차순일 때 즐겨찾기 친구를 하위 정렬
  • 닉네임순
    • 사용자 기기의 언어(Language)에 따라 상세 정렬 순서 적용
    • 국문: 오름차순일 때 한글, 특수문자, 숫자, 영어, 일본어, 이모지 순서로 정렬
    • 영문: 오름차순일 때 특수문자, 숫자, 영어, 일본어, 한글, 이모지 순서로 정렬

카카오 리치보드게임 앱의 경우, 아래와 같은 나이 기준 정렬이 적용됩니다.

  • 오름차순일 때 성인인 친구를 상위 정렬
  • 내림차순일 때 성인인 친구를 하위 정렬
  • 미성년자는 대상에서 제외

카카오톡 친구 목록 조회, 인하우스 앱: 카카오톡 친구 목록 조회는 응답 캐시를 적용합니다. 캐시 시간 동안에는 친구 정보가 변경되더라도 이전 요청과 동일한 친구 목록으로 구성된 응답을 받습니다. 캐시 시간이 경과한 후 다시 요청해야 변경된 친구 목록을 받을 수 있습니다. 페이즈별 캐시 시간은 아래와 같습니다.

페이즈(Phase)캐시 시간
프로덕션(Production)
베타(Beta)
10분
알파(Alpha)
샌드박스(Sandbox)
10분 미만
알파, 샌드박스 페이즈의 캐시 시간은 일정하지 않고 변경될 수 있음
* 친구의 서비스 가입 여부에 따라 값이 없을 수 있음

사용자의 앱 연결 상태에 따른 호출 제한, SDK 지원 여부, 권한 요구 사항은 지원 범위를 참고합니다.

API설명문서
카카오톡 프로필 조회사용자 카카오계정에 연결된 카카오톡의 프로필 정보를 가져옵니다.REST API
JavaScript
Android
iOS
사용자 목록으로 카카오톡 프로필 조회사용자 여러 명의 카카오톡 프로필을 받습니다.REST API
피커: 친구 선택사용자의 카카오톡 친구 목록을 출력하는 친구 피커를 표시하고, 사용자가 선택한 친구의 정보를 제공합니다.JavaScript
Android
iOS
피커: 채팅방 선택사용자의 카카오톡 채팅방 목록을 출력하는 채팅방 피커를 표시하고, 사용자가 선택한 채팅방의 정보를 제공합니다.JavaScript
Android
iOS
피커: 친구 또는 채팅방 선택사용자의 카카오톡 친구, 채팅방 목록을 탭 형태로 출력하는 피커를 표시하고, 사용자가 선택한 친구나 채팅방의 정보를 제공합니다.JavaScript
Android
iOS
카카오톡 친구 목록 조회현재 로그인한 사용자의 카카오계정에 연결된 카카오톡의 친구 정보를 가져옵니다.REST API
JavaScript
Android
iOS
읽지 않은 채팅방 목록 조회사용자의 카카오계정과 연결된 카카오톡에서 읽지 않은 메시지가 있는 채팅방 목록을 가져옵니다.REST API
인하우스 앱: 카카오톡 친구 목록 조회사용자의 카카오계정과 연결된 카카오톡 친구 정보를 가져옵니다.REST API
Android
iOS
인하우스 앱: 채팅방 목록 조회사용자 카카오계정에 연결된 카카오톡에서 채팅방 목록을 가져옵니다.REST API
Android
iOS
인하우스 앱: 채팅방 정보 조회사용자 카카오계정에 연결된 카카오톡에서 채팅방 정보를 가져옵니다.REST API
인하우스 앱: 채팅방 멤버 조회사용자 카카오계정과 연결된 카카오톡에서 특정 채팅방의 멤버 목록을 가져옵니다.REST API
Android
iOS
멜론: 카카오톡 프로필 뮤직에 곡 추가멜론, 헤이카카오 전용 API
사용자의 카카오톡 프로필 뮤직에 멜론의 특정 곡을 추가합니다.
REST API

도움이 되었나요?