카카오톡 친구 가져오기

정보

API를 사용하려면 카카오 로그인을 완료하고 관련 동의 항목에 동의한 상태여야 합니다.

피커와 친구 목록 가져오기 API는 사용 권한을 받은 앱에서만 사용할 수 있습니다.

현재 로그인한 사용자의 카카오톡 친구 목록을 불러옵니다. 요청할 때 친구 목록의 정렬 순서와 페이지당 친구 수를 선택적으로 지정할 수 있습니다. 파라미터 없이 요청하면 기본 설정을 사용합니다.

사용법

getFriends()를 이용해 친구 목록을 가져올 수 있습니다.

다음과 같이 정의되어 있습니다.

export function getFriends(params: {
  options?: KakaoTalkGetFriendsOptions;
}): Promise<KakaoTalkGetFriendsResult>

타입은 다음과 같습니다.

/**
 * 카카오톡 친구
 *
 * @property id 회원번호
 * @property uuid 메시지를 전송하기 위한 고유 아이디. 사용자의 계정 상태에 따라 이 정보는 바뀔 수 있으므로 앱내의 사용자 식별자로는 권장하지 않음.
 * @property profileNickname 친구의 닉네임
 * @property profileThumbnailImage 썸네일 이미지 URL
 * @property favorite 즐겨찾기 추가 여부
 * @property allowedMsg 메시지 수신이 허용되었는지 여부. 앱가입 친구의 경우는 feed msg 에 해당. 앱미가입친구는 invite msg 에 해당
 */
export interface KakaoTalkFriend {
  id?: number | null;
  uuid: string;
  profileNickname?: string | null;
  profileThumbnailImage?: string | null;
  favorite?: boolean | null;
  allowedMsg?: boolean | null;
}

export interface KakaoTalkGetFriendsOptions {
  offset?: number;
  limit?: number;
  order?: 'asc' | 'desc';
  friendOrder?: 'nickname' | 'age' | 'favorite';
}

응답의 friends는 친구 배열이며, totalCount는 전체 친구 수입니다. beforeUrl과 afterUrl은 카카오가 제공한 이전·다음 페이지 URL입니다. 해당 페이지가 없으면 null을 반환합니다. 다음 요청의 offset과 limit을 정할 때 이 URL의 쿼리를 참고할 수 있습니다.

친구의 profileNickname은 제공되지 않거나 null일 수 있습니다. iOS의 친구 썸네일도 다른 플랫폼과 같은 URL 문자열로 반환합니다.

사용법​

사용법