에.. 이번 글에서는 카카오톡 클라이언트와 서버 사이에서 어떤 데이터가 오고가는지 짧게 적어보려 합니다.
다른 플랫폼으로 (windows phone, pc, 등등) 포팅하실분들에게 약간이나마 도움이 될지도 모르겠네요.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
일단 제 프로그램에서는 세션키 인증이 끝나면 바로 친구 리스트를 불러옵니다.
친구리스트는 다음 URL에 리퀘스트를 보내면 받을 수 있습니다:
https://ch-talk.kakao.com/iphone/chats/list.json
그러면, 다음과 같은 object에 파싱해서 넣을 수 있습니다.
view [FriendsListJSON.cs]
/**********************/
/* FriendsListJSON.cs */
/**********************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace KakaoTalkPC
{
class FriendsListJSON
{
public FriendsListJSON() { friends = new List<Friend>(); }
public int status { get; set; }
public int total { get; set; }
public List<Friend> friends { get; set; }
}
}
앞으로의 모든 JSON 객체에서 status 필드를 보실 수 있는데, 0일 경우엔 성공 음수일 경우엔 각 에러코드를 나타냅니다. 예를들어, -500 은 세션키가 http 헤더에 제공되지 않았을때 리턴되고 -998은 잘못된 (서버에 등록되어있지 않은) 세션키가 제공되었을때 리턴됩니다.
각각의 Friend 객체는 다음과 같은 구조를 가지고 있습니다.
필드설명:
- type: 현재 친구와의 관계 (1 == 이미 친구, -4 == 친구 아님)
- directChatId: 직접 채팅(방) 아이디
- userId: 유져 고유번호
- nickName: 친구 이름 (상대방이 자신의 닉네임으로 설정한 것)
- phoneNumber: 폰 번호 (폰 번호가 저장되어있다면.. 아이디로만 저장되있으면 폰 번호 없음)
- profileImageUrl: 작은 프로필 사진 주소
- statusMessage: 이름 옆에 뜨는 '오늘의 메세지'
- friendNickName: 자신이 설정한 친구의 닉네임
- UUID: 아이디 (친구 검색할때 쓰는 아이디)
- fullProfileImageUrl: 원본 프로필 사진 주소
view [Friend.cs]
/*************/
/* Friend.cs */
/*************/
using System;
using System.Collections.Generic;
using System.Text;
namespace KakaoTalkPC
{
public class Friend
{
public Friend() { }
public int type { get; set; }
public Int64 directChatId { get; set; }
public int userId { get; set; }
public string nickName { get; set; }
public string phoneNumber { get; set; }
public string profileImageUrl { get; set; }
public string statusMessage { get; set; }
public string friendNickName { get; set; }
public string UUID { get; set; }
public string fullProfileImageUrl { get; set; }
public override string ToString()
{
return this.nickName;
}
}
}
이제 친구 찾기에 대해서 알아봅시다~
친구찾기는 다음 url로 리퀘스트를 보내면 됩니다:
https://fr-talk.kakao.com/iphone/friends/find_by_uuid.json?uuid=UUID
찾고 싶은 친구의 아이디 (uuid)를 파라미터로 넘기면 다음과 같은 JSON이 리턴됩니다.
필드설명:
- status: 찾기 성공 여부 (0 == 찾음, -1002 == 존재하지 않는 아이디거나 공개찾기 거부)
- member: 상대방 정보 (사실 지금보니까 그냥 Friend 클래스를 썼어도 될것 같네요, 한가지 차이점은 friendNickName 필드가 없다는것 정도..)
view [FindFriendByUUIDJSON.cs]
/***************************/
/* FindFriendByUUIDJSON.cs */
/***************************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace KakaoTalkPC
{
public class Member
{
public int type { get; set; }
public Int64 directChatId { get; set; }
public int userId { get; set; }
public string nickName { get; set; }
public string phoneNumber { get; set; }
public string profileImageUrl { get; set; }
public string statusMessage { get; set; }
public string UUID { get; set; }
public string fullProfileImageUrl { get; set; }
}
public class FindFriendByUUIDJSON
{
public int status { get; set; }
public Member member { get; set; }
}
}
친구 추가를 할 때는, 다음 url에 리퀘스트를 하면 됩니다:
https://fr-talk.kakao.com/iphone/friends/add.json?id=userId
여기서 주의해야 할 점은, 위에서 말씀드린 유져 고유번호인 userId를 넣어줘야한다는점입니다. UUID (사용자 아이디)가 아닙니다.
성공적으로 리스폰스가 돌아온다면 다음과 같은 JSON이 리턴됩니다.
필드설명 (FriendJSON class):
- status: 친구 추가 성공여부 (0 or 1 == 성공 | 처음으로 추가하는거면 0, 한번 해본적 있으면 1 인듯?)
- friend: 친구 정보
친구 삭제 시에는, 다음 url에 리퀘스트를 하면 됩니다:
https://fr-talk.kakao.com/iphone/friends/remove.json
하지만, 이번 리퀘스트는 그냥 GET으로는 파라미터를 넘길 수 없고, POST를 써야합니다 (한번에 여러 아이디 삭제가 가능하므로). POST 데이터는 다음과 같습니다:
ids=[userId1,userId2,...,userIdn]
이번 역시 userId를 넣어주어야합니다.
성공적으로 리스폰스가 돌아온다면 다음과 같은 JSON이 리턴됩니다.
필드설명 (FriendIdsJSON class):
- status: 친구 삭제 성공여부 (0 == 성공)
- friendIds: 삭제된 친구 userId 리스트 (클라이언트 리스트에서 삭제할 수 있도록)
view [FriendJSON.cs]
/*****************/
/* FriendJSON.cs */
/*****************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace KakaoTalkPC
{
public class FriendJSON
{
public int status { get; set; }
public Friend friend;
}
public class FriendIdsJSON
{
public int status { get; set; }
public Int64[] friendIds { get; set; }
}
}
대충 이 정도하면 친구 불러오기, 찾기, 추가, 그리고 삭제와 같은 친구관련 작업들은 다 할 수 있습니다.
이제 마지막으로 채팅에 관련된 극히 일부분을 보도록 하죠 ㅎㅎ
최근에 시간이 없어서 (제일 중요한 ^^;) 채팅쪽을 많이 못봤습니다.. 베타버전에서 이미지 전송까지 해놓으려고했는데 다음..(기약없음..ㅋㅋ)으로 미뤄야하겠네요.
일단 다음은 채팅방 리스트를 불러오는 url 입니다:
https://ch-talk.kakao.com/iphone/chats/list.json
저는 개인적으로 세션키 validation을 할때밖에 쓰지 않습니다만.. 유용한 날이 오겠죠 ㅎㅎ
view [ChatListJSON.cs]
/*******************/
/* ChatListJSON.cs */
/*******************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace KakaoTalkPC
{
class ChatListJSON
{
public ChatListJSON() { chatRooms = new List<ChatRoom>(); }
public int status { get; set; }
public List<ChatRoom> chatRooms { get; set; }
public int total { get; set; }
}
}
실질적으로 채팅이 이루어지는 부분을 보도록 하죠.
사실 카카오톡에서는 '채팅'의 개념보다는 '비동기식 메세지 교환' 이라고 보는게 나을지도 모르겠네요.
한쪽에서 메세지를 보내면, 이 메세지는 카카오톡 서버에 저장되어있다가 다른쪽 유져가 '나 메세지 받은거 있니?' 라고 물어보면 서버가 받아두었던 메세지를 전달해주는 방식입니다. 물론, 그 시점에서 서버단에서 그 메세지가 삭제가 되는지 저장이 되는지는 (^^;) 저로써는 알 방법이 없지만, 카카오톡 구조상 무조건 서버에 한번은 저장되어야 합니다.
그리고 또 한가지 재밌는것은, 카카오톡은 이미 처음부터 그룹채팅을 디자인으로 개발되었던것 같습니다.
그래서, 모든것이 다수가 참여할 수 있는 '채팅방'의 구조로 되어있고 1:1대화는 그저 유져가 두 명인 채팅방에 불과합니다.
다음 url로 채팅방을 생성 또는 메세지를 적을 수 있습니다:
https://ch-talk.kakao.com/iphone/chats/create_and_write.json
사실, 보통은 create_and_write은 대화를 맨 처음 할때 한번만 전송되고 그 이후부터는 그 채팅방에 부여된 채팅방 아이디를 사용해서 메세지를 보내고 받고 하지만, 저는 따로 내부 DB를 관리하고 있지 않기때문에 그냥 그때그때 create_and_write에 리퀘스트를 합니다. 그렇다고 그때마다 채팅방이 새롭게 생기는것은 아닙니다 ㅎㅎ 고맙게도(?) 이미 존재하는 채팅이면 서버단에서 처리를 해주는것 같더군요.
위의 리퀘스트는 당연히 POST이여야하고, POST 데이터는 다음과 같습니다:
receiver_ids[]=id1,id2,...,idn (사실 저는 지금 1:1 만 지원중이라 여러아이디에 보내는데에 쓰이는 구분자가 잘 기억이 안나네요 -_-; 콤마였던거 같은데 아닐수도있으니 그룹대화 지원하실분은 체크 먼저 하시길..)
message=msg (한글은 UTF-8 인코딩해야함)
push_alert= true (또는 false)
필드설명 (ChatRoomJSON):
- status: 성공 여부 (0 == 성공적으로 전송, -401 == 실패했음)
- chatRoom: 채팅방 정보
- chatLogs: 채팅방 로그 (아직 확인 하지 않은 메세지들)
필드설명 (ChatRoom):
- type: 그룹인지 1:1인지 판별?
- activeMemberIds: 대화 참여중인 멤버 아이디들
- lastMessage: 마지막 메세지
- pushAlert: push notification 설정 되있는지 여부
- activeMembersCount: 참여중인 멤버 수
- members: 참여중인 멤버들 정보
- watermarks: ???
- lastUpdatedAt: 마지막으로 업데이트 된 시간 (내부 카운터)
- lastLogId: 마지막으로 확인한 로그 고유번호
- newMessageCount: 새 메세지 갯수
- chatId: 현재 채팅방의 고유번호
필드설명 (ChatLog):
- type: 까먹음 (그룹 또는 1:1?)
- logId: 로그 고유번호
- message: 메세지
- sendAt: 보내진 시간 (내부 카운터)
- chatId: 로그가 속한 채팅방 고유번호
view [ChatRoomJSON.cs]
/*******************/
/* ChatRoomJSON.cs */
/*******************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace KakaoTalkPC
{
public class ChatRoom
{
public ChatRoom() { members = new List<Member>(); }
public string type { get; set; }
public int[] activeMemberIds { get; set; }
public string lastMessage { get; set; }
public bool pushAlert { get; set; }
public int activeMembersCount { get; set; }
public List<Member> members { get; set; }
public Int64[] watermarks { get; set; }
public int lastUpdatedAt { get; set; }
public Int64 lastLogId { get; set; }
public int newMessageCount { get; set; }
public Int64 chatId { get; set; }
}
public class ChatLog
{
public int type { get; set; }
public Int64 logId { get; set; }
public string message { get; set; }
public int sendAt { get; set; }
public Int64 chatId { get; set; }
}
public class ChatRoomJSON
{
public ChatRoomJSON() { chatLogs = new List<ChatLog>(); }
public int status { get; set; }
public ChatRoom chatRoom { get; set; }
public List<ChatLog> chatLogs { get; set; }
}
}
해보지는 않았지만, 요즘 화두가 되고있는 '카카오톡 서버가 메세지를 저장을 하고 있느냐 아니냐'의 질문은 아무래도 이미 (채팅방 안의 모든 멤버가) 확인한 메세지의 ChatLog를 다시 불러올 수 있느냐 없느냐로 판별 할 수도있겠네요. 정상적이라면 채팅방에 있는 멤버가 특정 메세지를 모두 확인하는 순간 (즉, 메세지 옆에 뜨는 노란 숫자가 0이 되는 순간) 서버단에서 해당 로그를 지워야하겠죠. 그런데도 그 로그 아이디로 메세지를 불러올 수 있다면, 서버에 메세지들을 계속 저장하고 있다는 뜻이겠죠.
이제 마지막으로, https://ch-talk.kakao.com/iphone/chats/chatId.json?since=lastLogId 로 리퀘스트를 보내게 되면, 역시 ChatRoomJSON이 넘어오게 됩니다. 보시다시피 chatId와 lastLogId로 새로운 메세지가 도착했는지 안했는지 fetch할 수 있습니다. 방금전에 위에서 말한 테스팅을 손쉽게 할 수 있는 리퀘스트죠 :)
제가 해보진 않았습니다만.. (별로 그쪽엔 관심이 없는지라..) 다른분들이 해보시고 알게되면 댓글 달아주세요 ^^
대충 이정도가 제가 알고있는 자료구조입니다. 사실 자료구조라고 하기에도 좀 난감한 'JSON parsing' 입니다.
리퀘스트해서 돌아오는 리스폰스를 파싱해서 그 데이터를 알맞게 잘 쓰면 카카오톡 포팅이 가능한거죠.
나중에 시간과 기회가 된다면, 그룹대화 (뭐 이번 포스팅에서도 대충 설명하긴했습니다만..)와 이미지/동영상 등 전송에 대해서 설명하도록 하겠습니다.
질문이 있으시면 댓글로 남겨주시거나 이메일 주시면 됩니다~~
Trackback URL : http://risio.net/tc/trackback/151
rss