페이지 이동경로
  • 문서>
  • 카카오톡 소셜>
  • JavaScript

카카오톡 소셜

JavaScript

이 문서는 Kakao SDK for JavaScript(이하 JavaScript SDK)를 사용한 카카오톡 소셜 API 구현 방법을 안내합니다.

애플리케이션 설정 확인

이 기능을 사용하려면 카카오디벨로퍼스(Kakao Developers, 이하 개발자 웹사이트) 애플리케이션(이하 앱) 설정에 Web 플랫폼 및 도메인 정보가 등록되어 있어야 합니다. 자세한 내용은 애플리케이션 등록을 참고합니다.

이 문서에 사용된 태그

Tag Description
로그인 필수 카카오 로그인이 필요한 API를 의미합니다. 카카오 로그인을 먼저 구현하고, 카카오 로그인을 통해 발급 받은 액세스 토큰(Access Token)을 이용하여 해당 API를 호출해야 합니다.

프로필 가져오기 로그인 필수

동의 항목 설정 필요

이 API를 사용하려면 동의 항목 설정을 참고하여 '프로필' 동의 항목을 설정해야 합니다.

현재 로그인한 사용자의 카카오계정에 연결된 카카오톡 프로필 정보를 받는 기능입니다. 사용자 카카오계정에 연결된 카카오톡이 없다면 에러 응답을 받습니다.

Kakao.API.request로 REST API를 호출할 때, url에 카카오톡 프로필 요청에 해당하는 URL인 /v1/api/talk/profile을 입력해야 합니다. 요청 헤더(Header)를 비롯한 다른 파라미터는 JavaScript SDK가 대신 입력하여 요청을 보내므로 따로 값을 지정하지 않습니다.

Request
Kakao.API.request({
  url: '/v1/api/talk/profile'
});
Parameter
Name Type Description Required
url String /v1/api/talk/profile로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
Sample
Kakao.API.request({
  url: '/v1/api/talk/profile',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

요청 성공 시 JSON 객체로 카카오톡 프로필 정보를 받습니다. 요청 성공 시 응답은 REST API와 동일하므로 REST API > Response를 참고합니다.

친구 목록 가져오기 로그인 필수

동의 항목 설정 및 권한 필요

이 API를 사용하려면 동의 항목 설정을 참고하여 '카카오 서비스 내 친구목록(프로필사진, 닉네임, 즐겨찾기 포함)' 동의 항목을 설정해야 합니다. 또한 이 API는 사용 권한이 필요합니다. 앱에 사용 권한이 부여되기 전에는 팀원을 대상으로만 동작하므로, 카카오톡 사용 권한 신청을 참고해 사용 권한을 신청해야 합니다.

현재 로그인한 사용자의 카카오계정에 연결된 카카오톡의 친구 정보를 받아 옵니다. 정렬 순서, 한 페이지에 가져올 친구 수 등 파라미터를 선택적으로 사용하여 요청할 수 있습니다.

응답은 JSON 객체로 받습니다. 카카오톡 친구 수가 요청 시 limit보다 많다면 결과가 페이지로 나뉩니다. 이런 경우, 직접 파라미터를 하나하나 지정하지 않고도 응답에 포함된 after_url을 사용해 친구 목록 받기를 요청하면 다음 페이지의 친구 목록을 받아올 수 있습니다. 사용자 카카오계정에 연결된 카카오톡이 없다면 에러 응답을 받습니다.

Kakao.API.request로 REST API를 호출할 때, url에 카카오톡 친구 정보 요청에 해당하는 URL인 /v1/api/talk/friends을 입력해야 합니다. 요청 헤더(Header)를 비롯한 다른 파라미터는 JavaScript SDK가 대신 입력하여 요청을 보내므로 따로 값을 지정하지 않습니다.

Request
Kakao.API.request({
    url: '/v1/api/talk/friends'
});
Parameter
Name Type Description Required
url String /v1/api/talk/friends로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터, 자세한 내용은 data: 친구 목록 가져오기 참고 X
data: 친구 목록 가져오기
Name Type Description Required
offset Integer 친구 목록 시작 지점(기본값: 0) X
limit Integer 한 페이지에 가져올 친구 최대 수(기본값: 10, 최대: 100) X
order String 친구 목록 정렬 순서, 오름차순("asc") 또는 내림차순("desc")(기본값 "asc") X
friend_order String 친구 목록 정렬 시, 즐겨찾기 친구의 우선 정렬 또는 닉네임 순서 정렬로 기준 설정
즐겨찾기 친구(favorite) 또는 카카오톡 닉네임(nickname)
(기본값: favorite)
X
Sample
Kakao.API.request({
  url: '/v1/api/talk/friends',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

요청 성공 시 JSON 객체로 카카오톡 친구 정보를 받습니다. 카카오톡 친구 정보 구성에 대해서는 REST API와 동일하므로 REST API > Response를 참고합니다. 응답 중 각 친구의 uuid 값은 메시지 보내기 API 요청 시 사용하는 수신자 정보로, 메시지 보내기 전 친구 목록을 먼저 받아와야 해당 값을 구할 수 있습니다.

더보기