com.kakao.kakaotalk.v2

Class KakaoTalkService

java.lang.Object

com.kakao.kakaotalk.v2.KakaoTalkService

public class KakaoTalkService
extends Object

카카오톡 API 요청을 담당한다.

Method Summary

Modifier and Type	Method and Description
static KakaoTalkService	getInstance()
Future<PlusFriendsResponse>	plusFriends(List<String> publicIds, com.kakao.kakaotalk.callback.TalkResponseCallback<PlusFriendsResponse> callback) 유저가 특정 카카오톡 채널과 친구를 맺었는지 확인.
Future<PlusFriendsResponse>	plusFriends(com.kakao.kakaotalk.callback.TalkResponseCallback<PlusFriendsResponse> callback) 유저가 특정 카카오톡 채널과 친구를 맺었는지 확인.
Future<AppFriendsResponse>	requestAppFriends(AppFriendContext context, com.kakao.kakaotalk.callback.TalkResponseCallback<AppFriendsResponse> callback) Request for a list of KakaoTalk friends who also: - Registered to this app (Connect with Kakao) - Agreed to provide friends info to this app
Future<ChatMembersResponse>	requestChatMembers(Long chatId, Boolean friendsOnly, com.kakao.kakaotalk.callback.TalkResponseCallback<ChatMembersResponse> callback) 톡 채팅방 멤버 리스트 정보 (제휴를 통해 권한이 부여된 특정 앱에서만 호출이 가능합니다.)
Future<ChatListResponse>	requestChatRoomList(com.kakao.kakaotalk.callback.TalkResponseCallback<ChatListResponse> callback, ChatListContext context) 톡의 채팅방 리스트 정보 권한이 있는 방에 대한 정보만 내려받는다.
Future<FriendsResponse>	requestFriends(com.kakao.kakaotalk.callback.TalkResponseCallback<FriendsResponse> callback, FriendContext context) 카카오톡 친구 리스트를 요청한다.
Future<KakaoTalkProfile>	requestProfile(com.kakao.kakaotalk.callback.TalkResponseCallback<KakaoTalkProfile> callback) 카카오톡 프로필 요청
Future<KakaoTalkProfile>	requestProfile(com.kakao.kakaotalk.callback.TalkResponseCallback<KakaoTalkProfile> callback, boolean secureResource) 카카오톡 프로필 요청
Future<Boolean>	requestSendMemo(String url, String templateId, Map<String,String> templateArgs, com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback) 스크랩 정보를 커스텀 템플릿에 사용하여 나에게 메시지 전송
Future<Boolean>	requestSendMemo(String url, com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback) 스크랩 템플릿을 사용하여 나에게 메시지 전송
Future<Boolean>	requestSendMemo(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback, String templateId, Map<String,String> templateArgs) Send KakaoTalk message to self with message template v2.
Future<Boolean>	requestSendMemo(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback, TemplateParams templateParams) Send KakaoTalk message to self with message template v2.
Future<Boolean>	requestSendMessage(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback, com.kakao.auth.common.MessageSendable receiverInfo, String templateId, Map<String,String> templateArgs) 카카오톡 메시지 전송하며, message template v2로 구성된 template으로 카카오톡 메시지 전송.
Future<Boolean>	requestSendMessage(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback, com.kakao.auth.common.MessageSendable receiverInfo, TemplateParams templateParams) 카카오톡 메시지 전송하며, message template v2로 구성된 template 으로 카카오톡 메시지 전송.
Future<MessageSendResponse>	sendMessageToFriends(List<String> uuids, String templateId, Map<String,String> templateArgs, com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback) 앱에 가입한 카카오톡 친구들에게 커스텀 템플릿을 사용하여 카카오톡 메시지 전송
Future<MessageSendResponse>	sendMessageToFriends(List<String> receiverUuids, String url, String templateId, Map<String,String> templateArgs, com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback) 앱에 가입한 카카오톡 친구들에게 스크랩 템플릿을 사용하여 카카오톡 메시지 전송
Future<MessageSendResponse>	sendMessageToFriends(List<String> receiverUuids, String url, com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback) 앱에 가입한 카카오톡 친구들에게 스크랩 템플릿을 사용하여 카카오톡 메시지 전송
Future<MessageSendResponse>	sendMessageToFriends(List<String> receiverUuids, TemplateParams templateParams, com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback) 앱에 가입한 카카오톡 친구들에게 디폴트 템플릿을 사용하여 카카오톡 메시지 전송

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static KakaoTalkService getInstance()

plusFriends

public Future<PlusFriendsResponse> plusFriends(List<String> publicIds,
                                               com.kakao.kakaotalk.callback.TalkResponseCallback<PlusFriendsResponse> callback)

유저가 특정 카카오톡 채널과 친구를 맺었는지 확인.

Parameters:

publicIds - 정보 조회하려는 plus friend의 public id 리스트.

callback - success/failure callback for this API

Returns:

Future containing PlusFriendsResponse

Since:

1.17.0

plusFriends

public Future<PlusFriendsResponse> plusFriends(com.kakao.kakaotalk.callback.TalkResponseCallback<PlusFriendsResponse> callback)

유저가 특정 카카오톡 채널과 친구를 맺었는지 확인.

Parameters:

callback - success/failure callback for this API

Returns:

Future containing PlusFriendsResponse

Since:

1.17.0

requestAppFriends

public Future<AppFriendsResponse> requestAppFriends(AppFriendContext context,
                                                    com.kakao.kakaotalk.callback.TalkResponseCallback<AppFriendsResponse> callback)

Request for a list of KakaoTalk friends who also: - Registered to this app (Connect with Kakao) - Agreed to provide friends info to this app

This API will return an error if this Kakao account user does not use KakaoTalk. Use TalkResponseCallback.onNotKakaoTalkUser() to handle the error.

Parameters:

context - Context

callback - Success/Failure callback

Since:

1.11.1

requestChatMembers

public Future<ChatMembersResponse> requestChatMembers(@NonNull
                                                      Long chatId,
                                                      Boolean friendsOnly,
                                                      com.kakao.kakaotalk.callback.TalkResponseCallback<ChatMembersResponse> callback)

톡 채팅방 멤버 리스트 정보 (제휴를 통해 권한이 부여된 특정 앱에서만 호출이 가능합니다.)

Parameters:

chatId - chat id retrieved from requestChatRoomList(TalkResponseCallback, ChatListContext)

friendsOnly - true if only friends are wanted, false otherwise

callback - success/failure callback for this API

Returns:

Future containing ChatMembersResponse

Since:

1.13.0

requestChatRoomList

public Future<ChatListResponse> requestChatRoomList(com.kakao.kakaotalk.callback.TalkResponseCallback<ChatListResponse> callback,
                                                    ChatListContext context)

톡의 채팅방 리스트 정보 권한이 있는 방에 대한 정보만 내려받는다. 권한이 없는 ChatFilterBuilder.ChatFilter 타입에 대해서는 카카오톡에 채팅방이 존재해도 값이 내려가지 않는다. 기본 정렬은 asc로 최근 대화 순으로 정렬한다. (desc는 반대로 가장 오래된 대화 순으로 정렬한다.) 권한이 필요한 채팅방 정보(regular_direct, regular_multi) regular에 대한 권한은 제휴된 앱에만 부여합니다.

Parameters:

callback - 요청 결과에 대한 callback

context - ChatListContext 챗방리스트 요청정보를 담고있는 context

requestFriends

public Future<FriendsResponse> requestFriends(com.kakao.kakaotalk.callback.TalkResponseCallback<FriendsResponse> callback,
                                              FriendContext context)

카카오톡 친구 리스트를 요청한다. Friends에 대한 접근권한이 있는 경우에만 얻어올 수 있다. (제휴를 통해 권한이 부여된 특정 앱에서만 호출이 가능합니다.)

Parameters:

callback - 요청 결과에 대한 callback

context - 친구리스트 요청정보를 담고있는 context

requestProfile

public Future<KakaoTalkProfile> requestProfile(com.kakao.kakaotalk.callback.TalkResponseCallback<KakaoTalkProfile> callback)

카카오톡 프로필 요청

Parameters:

callback - 요청 결과에 대한 callback

requestProfile

public Future<KakaoTalkProfile> requestProfile(com.kakao.kakaotalk.callback.TalkResponseCallback<KakaoTalkProfile> callback,
                                               boolean secureResource)

카카오톡 프로필 요청

Parameters:

callback - 요청 결과에 대한 callback

secureResource - 이미지 url을 https로 반환할지 여부.

requestSendMemo

public Future<Boolean> requestSendMemo(@NonNull
                                       String url,
                                       @Nullable
                                       String templateId,
                                       @Nullable
                                       Map<String,String> templateArgs,
                                       @NonNull
                                       com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback)

스크랩 정보를 커스텀 템플릿에 사용하여 나에게 메시지 전송

Parameters:

url - 스크랩할 url

templateId - 커스텀 템플릿 id

templateArgs - 커스텀 템플릿에 사용하는 파라미터들의 값

callback - MessageSendResponse 응답을 전달받을 콜백

requestSendMemo

public Future<Boolean> requestSendMemo(@NonNull
                                       String url,
                                       @NonNull
                                       com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback)

스크랩 템플릿을 사용하여 나에게 메시지 전송

Parameters:

url - 스크랩할 url

callback - MessageSendResponse 응답을 전달받을 콜백

requestSendMemo

public Future<Boolean> requestSendMemo(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback,
                                       String templateId,
                                       Map<String,String> templateArgs)

Send KakaoTalk message to self with message template v2.

퍼미션 불필요. 수신자별/발신자별 쿼터 제한 없음. 초대 메시지는 나에게 전송 불가. 카카오톡에 가입이 되어있어야함.

Parameters:

callback - 요청 결과에 대한 callback

templateId - 개발자 사이트를 통해 생성한 메시지 템플릿 id

templateArgs - 메시지 템플릿에 정의한 arg key:value. 템플릿에 정의된 모든 arg 가 포함되어야 함.

requestSendMemo

public Future<Boolean> requestSendMemo(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback,
                                       TemplateParams templateParams)

Send KakaoTalk message to self with message template v2.

퍼미션 불필요. 수신자별/발신자별 쿼터 제한 없음. 초대 메시지는 나에게 전송 불가. 카카오톡에 가입이 되어있어야함.

Parameters:

callback - 요청 결과에 대한 callback

templateParams - 템플릿 파라미터

requestSendMessage

public Future<Boolean> requestSendMessage(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback,
                                          com.kakao.auth.common.MessageSendable receiverInfo,
                                          String templateId,
                                          Map<String,String> templateArgs)

카카오톡 메시지 전송하며, message template v2로 구성된 template으로 카카오톡 메시지 전송.

(제휴를 통해 권한이 부여된 특정 앱에서만 호출이 가능합니다.)

오픈 API 용으로는 sendMessageToFriends(List, String, Map, TalkResponseCallback) 참고.

Parameters:

callback - 요청 결과에 대한 callback

receiverInfo - 메세지 전송할 대상에 대한 정보를 가지고 있는 object

templateId - 개발자 사이트를 통해 생성한 메시지 템플릿 id

templateArgs - 메시지 템플릿에 정의한 arg key:value. 템플릿에 정의된 모든 arg가 포함되어야 함.

requestSendMessage

public Future<Boolean> requestSendMessage(com.kakao.kakaotalk.callback.TalkResponseCallback<Boolean> callback,
                                          com.kakao.auth.common.MessageSendable receiverInfo,
                                          TemplateParams templateParams)

카카오톡 메시지 전송하며, message template v2로 구성된 template 으로 카카오톡 메시지 전송.

(제휴를 통해 권한이 부여된 특정 앱에서만 호출이 가능합니다.) 오픈 API 용으로는 sendMessageToFriends(List, TemplateParams, TalkResponseCallback) 참고.

Parameters:

callback - 요청 결과에 대한 callback

receiverInfo - 메세지 전송할 대상에 대한 정보를 가지고 있는 object

templateParams - 템플릿 파라미터

sendMessageToFriends

public Future<MessageSendResponse> sendMessageToFriends(@NonNull
                                                        List<String> uuids,
                                                        @NonNull
                                                        String templateId,
                                                        @Nullable
                                                        Map<String,String> templateArgs,
                                                        @Nullable
                                                        com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback)

앱에 가입한 카카오톡 친구들에게 커스텀 템플릿을 사용하여 카카오톡 메시지 전송

Parameters:

uuids - 친구 API 를 통하여 획득한 친구 uuid 목록. 현재 최대 길이 5.

templateId - 커스텀 템플릿 id

templateArgs - 커스텀 템플릿에 사용하는 파라미터들의 값

callback - MessageSendResponse 응답을 전달받을 콜백

sendMessageToFriends

public Future<MessageSendResponse> sendMessageToFriends(@NonNull
                                                        List<String> receiverUuids,
                                                        @NonNull
                                                        String url,
                                                        @Nullable
                                                        String templateId,
                                                        @Nullable
                                                        Map<String,String> templateArgs,
                                                        @Nullable
                                                        com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback)

앱에 가입한 카카오톡 친구들에게 스크랩 템플릿을 사용하여 카카오톡 메시지 전송

Parameters:

receiverUuids - 친구 API 를 통하여 획득한 친구 uuid 목록. 현재 최대 길이 5.

url - 스크랩할 url

templateId - 커스텀 템플릿 id

templateArgs - 커스텀 템플릿에 사용하는 파라미터들의 값

callback - MessageSendResponse 응답을 전달받을 콜백

sendMessageToFriends

public Future<MessageSendResponse> sendMessageToFriends(@NonNull
                                                        List<String> receiverUuids,
                                                        @NonNull
                                                        String url,
                                                        @Nullable
                                                        com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback)

앱에 가입한 카카오톡 친구들에게 스크랩 템플릿을 사용하여 카카오톡 메시지 전송

Parameters:

receiverUuids - 친구 API 를 통하여 획득한 친구 uuid 목록. 현재 최대 길이 5.

url - 스크랩할 url

callback - MessageSendResponse 응답을 전달받을 콜백

sendMessageToFriends

public Future<MessageSendResponse> sendMessageToFriends(@NonNull
                                                        List<String> receiverUuids,
                                                        @NonNull
                                                        TemplateParams templateParams,
                                                        @Nullable
                                                        com.kakao.kakaotalk.callback.TalkResponseCallback<MessageSendResponse> callback)

앱에 가입한 카카오톡 친구들에게 디폴트 템플릿을 사용하여 카카오톡 메시지 전송

Parameters:

receiverUuids - 친구 API 를 통하여 획득한 친구 uuid 목록. 현재 최대 길이 5.

templateParams - 디폴트 템플릿 파라미터

callback - MessageSendResponse 응답을 전달받을 콜백