TRUE SOFT

[분류1] 카카오톡 API

작성자 : 조참     조회수 : 6     아이피 : 183.101.161.13

카카오톡 API는 카카오톡 서비스에서 제공하는 API를 의미합니다. 카카오계정으로 로그인을 하는 앱에서 사용할 수 있고, 카카오계정에 연결한 카카오톡 사용자에 대해서만 사용할 수 있습니다.

현재 제공되는 카카오톡 API는 다음과 같습니다.

메시지 전송과 나에게 보내기의 자세한 사항은 메시지 타입 소개를 참고 해주세요.

시작하기 전에Copy URL

카카오톡 API를 사용하려면 로그인이 선행되어야 합니다.
사용자 관리를 참고하여 내 앱에 로그인을 적용해주세요.

프로필 요청Copy URL

프로필 요청은 로그인한 사용자가 카카오톡을 사용중인 경우 카카오톡의 최신 프로필 정보를 불러옵니다.

카카오톡 프로필 API에서 제공되는 정보는 아래와 같습니다.

  • 카카오톡의 닉네임 정보 (nickName)
  • 카카오톡의 프로필 이미지 URL (profileImageURL)
  • 카카오톡의 프로필 이미지의 썸네일 URL (thumbnailImageURL)
  • 카카오톡의 국가코드 (countryISO)
[KOSessionTask talkProfileTaskWithCompletionHandler:^(KOTalkProfile* profile,
                                                      NSError* error) {
    if (profile) {
        NSLog(@"%@",profile.nickName);
    } else {
        NSLog(@"failed to get talk profile.");
    }
}];


 

친구 목록Copy URL

친구 API는 앱에 가입한 사용자의 카카오톡 친구 중 정보를 제공해주는 API 입니다. 카카오계정 로그인을 사용하는 앱에서 사용할 수 있습니다.

  • 앱에 가입된 친구만 대상이 됩니다.
  • '서비스 내 친구목록' 정보 제공에 동의한 친구만 목록에 포함되고, 친구 리스트 중 친구 정보 제공에 동의하지 않은 경우 목록에서 제외됩니다.

API 활용 범위Copy URL

  • 카카오톡 친구 정보를 활용하여 애플리케이션의 소셜 서비스를 구축 할 수 있습니다.
  • 해당 애플리케이션에 카카오톡 로그인을 통해서 서비스를 이용하는 친구들 중 카카오 '서비스 내 친구목록' 개인 정보 제공에 동의한 친구만 대상이 됩니다.
  • 조회한 친구를 대상으로 메시지 전송 API를 사용할 수 있습니다.
  • 사용자들의 친구 관계를 다른 사용자에게 제공해줄 수 없습니다.
  • 친구 정보를 따로 저장할 수 없습니다.
  • 친구들의 관계 정보를 분석/조합해서 제공해줄 수 없습니다.

API 사용 제약Copy URL

  • 내 애플리케이션 > 설정 > 사용자 관리 > 동의항목 > 설정에서 카카오 서비스 내 친구목록 항목을 설정해야 합니다.
  • 친구 목록은 사용자 개인정보 보호를 위해 검수를 거쳐 제공됩니다.친구 API 검수 신청하기
  • 검수 후 기능을 정식으로 제공 받기 전에는 해당 서비스 앱 설정에 팀 멤버로 등록된 카카오계정 사용자만으로 조회 대상이 한정됩니다.
  • 테스트를 위해 API 호출 권한은 검수 여부와 관계 없이 열려 있지만, 팀 멤버들도 카카오톡 친구이고 서비스에 연결돼 있어야 목록에서 조회 가능합니다.
  • 서비스에 연결되어 있지 않거나 연결 시 친구 정보 제공에 동의하지 않은 친구는 결과에 포함되지 않습니다.

친구 목록 조회Copy URL

친구 정보가 많을 수 있기 때문에 사용하는 클라이언트에서는 paging 기반으로 요청해야 합니다. 이를 위해 페이징을 위한 KOAppFriendContext 생성 파라미터로 limit 이 제공되고 전달한 limit 개수 만큼의 결과를 가져옵니다. limit의 기본 값과 최대 값은 100입니다.

해당 paging 기반 요청을 기준으로 더 불러올 친구 목록이 있는 경우 컨텍스트의 hasMoreItems 값이 true이며, 이 컨텍스트를 그대로 전달하여 appFriendsWithContext:completionHandler: 메소드를 호출하면 다음 페이지(limit 개수)의 친구 목록을 가져올 수 있습니다.

KOAppFriendContext
파라미터타입기본값설명
limitNSInteger100한 페이지에 가져올 최대 수 (최대 100개)
orderingKOOrderingDefault친구 목록 정렬 방식
secureResourceBOOLYES이미지 URL을 https로 받을 것인지 여부
orderTypeKOAppFriendOrderTypeDefault친구 목록 정렬의 기준값
메소드타입설명
hasMoreItemsBOOL다음 페이지 존재 여부
true가 리턴된 경우 이 컨텍스트로 다시 조회하면 다음 페이지 친구 목록을 얻을 수 있습니다.

 

목록 수정 삭제