[.Net] C#에서 카카오톡 오픈API/REST API로 나에게 메시지 보내기 (예제 포함)

카카오톡 오픈 API / REST API란?

지금까지 다른 포스팅에서 네이버 오픈 API, 공공데이터포털 오픈 API를 사용하여 원하는 데이터를 조회하는 예제 코드를 다뤄봤습니다. 그런데 이러한 오픈 API를 카카오톡도 제공하고 있습니다. 

카카오 로그인이라든가 메시지 보내기, 지도 위치, 카카오 내비 등 일반적인 소셜통합 API 뿐만 아니라 비지니스 API 및 인공지능 API까지도 제공하고 있습니다.

카카오톡 오픈 API 제공 서비스 목록

이번 포스팅에서는 카카오톡 오픈 API 중 메시지 서비스를 사용하여, 나에게 메시지 보내기 동작을 확인해 보겠습니다.

준비 단계

1. 카카오톡 오픈 API 서비스 신청하기

로그인 후 상단의 내 애플리케이션 메뉴를 클릭하고, 아래와 같은 화면이 표시되면 애플리케이션 추가하기 버튼을 클릭합니다.

애플리케이션 화면

아래와 같은 화면이 표시되면 앱 이름과 사업자명을 입력합니다. 앱 아이콘 등록은 선택입니다.

애플리케이션 추가하기 항목 입력

애플리케이션이 목록에 추가되면, 생성된 항목을 클릭합니다. 클릭하면 아래와 같은 페이지가 표시되고, REST API 키 외에도 여러 개발 환경의 인증키를 제공합니다. 그리고 중간에 있는 플랫폼 설정하기 버튼을 클릭합니다.

애플리케이션 정보 화면

아래와 같은 화면이 표시되면 Web 플랫폼 등록 버튼을 클릭합니다.

플랫폼 선택 화면

사이트 도메인을 입력하라는 화면이 표시됩니다. 저는 예시로 저의 블로그 주소를 입력했습니다. 이는 추후 나올 링크 버튼 클릭 시 연결되는 주소입니다. 나중에 언제든지 수정 및 삭제가 가능합니다.

사이트 도메인 입력 화면

2. 애플리케이션 설정하기

위 과정이 모두 끝나면 애플리케이션 정보 화면에서 REST API 키를 확인할 수 있습니다.

애플리케이션 인증키 확인 화면

그리고 화면의 좌상단에 아래 아이콘을 클릭하면 메뉴가 확장됩니다.

메뉴 아이콘

애플리케이션 메뉴 확장 화면

좌측의 메뉴에서 카카오 로그인을 클릭하고, 상태를 활성화합니다.

카카오 로그인 활성화 화면

Redirect URI에는 예시로 아래와 같이 설정했습니다.

Redirect URI 입력 화면

이번에는 동의항목 메뉴를 클릭하고, 하단의 카카오톡 메시지 전송의 설정 버튼을 클릭합니다.

동의항목 설정 화면

간단하게 나에게 메시지 보내기 정도로만 테스트할 목적이므로, 아래와 같이 선택 동의를 선택하고 목적에는 간단하게 작성합니다.

동의 항목 설정 화면

좌측 메뉴에서 카카오링크를 선택하고, 메시지 템플릿 빌더 바로가기를 클릭합니다.

메시지 템플릿 빌더 바로가기 클릭

아래와 같은 페이지로 이동하면, 좌측의 템플릿 만들기 버튼을 클릭합니다. 아래에 보이는 화면은 이전에 만든 템플릿의 설정입니다.

템플릿 만들기

세 가지 종류의 템플릿이 보이는데요. 본문에서는 간단하게 텍스트만 전송할 것이므로 제일 왼쪽의 FEED 항목을 선택합니다.

템플릿 항목 선택 화면

아래와 같이 템플릿을 꾸미는 설정이 표시됩니다. 이미지나 프로필, 제목과 설명 그리고 링크 등 여러 항목을 상세하게 설정할 수 있습니다. 취향에 맞게 설정하고 넘어갑니다.

템플릿 상세 설정 화면

이렇게 설정된 템플릿은 추후 템플릿 ID를 사용하여 간단하게 메시지를 전송할 수 있습니다.

따라 하기

1. C# 프로젝트 설정

본문의 예제 코드는 ExamKakaoTalk 이름의 Windows Forms 앱 프로젝트를 사용합니다.

Windows Forms 앱 프로젝트 생성

그리고 누겟(NuGet)에서 Newtonsoft.Json 및 RestSharp을 설치합니다.

Newtonsoft.Json 및 RestSharp 설치하기

자주 사용하게 되는 카카오 API 요청을 위한 인증키, URL 등을 정의하기 위한 클래스를 추가합니다. 

새 항목 추가하기

이름은 DefineKakao.cs로 생성합니다.

DefineKakao.cs 추가하기

DefineKakao Class에는 아래와 같이 문자열을 정의하여 다른 곳에서 사용될 예정입니다.

namespace ExamKakaoTalk
{
    class DefineKakao
    {
        public const string API_KEY = "89d43f60892ee4b8ad1f3a8f1501da67"; //사용자 인증키
        public const string TEMPLATE_ID = "44556"; //메시지 템플릿 아이디
        public const string USER_ID = "528477"; //사용자 애플리케이션 아이디
        public const string REDIRECT_URL = "https://www.naver.com/oauth"; //Redirect URL
        
        //Login Request URL: https://kauth.kakao.com/oauth/authorize?response_type=code&client_id={REST_API_KEY}&redirect_uri={REDIRECT_URI}
        public const string LOGIN_URL = "https://kauth.kakao.com/oauth/authorize?response_type=code&client_id=" + API_KEY + "&redirect_uri=" + REDIRECT_URL;

        public const string HOST_OAUTH_URL = "https://kauth.kakao.com";
        public const string HOST_API_URL = "https://kapi.kakao.com";

        public static string USER_TOKEN;
        public static string ACCESS_TOKEN;
    }
}

2. 카카오톡 로그인/로그아웃 구현하기

본문에서 카카오톡 로그인 페이지는 아래 애니메이션처럼 만들 예정입니다.

로그인을 위한 카카오 로그인 페이지 동작

카카오 로그인에 관한 개발 문서는 아래 링크에서 확인할 수 있습니다.

developers.kakao.com/docs/latest/ko/kakaologin/rest-api

Kakao Developers

카카오 로그인 구현을 위해서는 ① 인가 코드 받기 ② 토큰 받기 두 단계를 거칩니다. 즉, 먼저 인가 코드를 받고, 그 인가 코드로 토큰을 요청하는 것입니다.

카카오 로그인 동작의 이해, 출처: 카카오 로그인 개발 문서

이제 코드를 구현해 보겠습니다. 예제 프로젝트에 아래와 같이 로그인 동작을 위한 버튼을 추가합니다.

로그인 버튼 추가

그리고 버튼을 클릭하면 카카로 계정 로그인 화면이 표시되도록 만들 건데요. 이를 위해 새로운 윈 폼을 추가합니다.

프로젝트에 Windows Form 추가하기

FormKakaoLogin.cs 이름으로 생성합니다.

Windows Form 추가하기

생성된 폼에 webBrowser 컨트롤을 추가합니다. 컨트롤의 이름은 webBrowserKakaoLogin입니다.

Form에 webBrowser 추가하기

FormKakaoLogin의 코드는 다음과 같습니다.

using RestSharp;
using Newtonsoft.Json.Linq;

namespace ExamKakaoTalk
{
    public partial class FormKakaoLogin : Form
    {
        public FormKakaoLogin()
        {
            InitializeComponent();

            webBrowserKakaoLogin.Navigate(DefineKakao.LOGIN_URL);
        }

        private void webBrowserKakaoLogin_DocumentCompleted(object sender, WebBrowserDocumentCompletedEventArgs e)
        {
            string code = getCode();
            if (code != "")
            {
                DefineKakao.USER_CODE = code;
                DefineKakao.ACCESS_TOKEN = getToken();
                this.DialogResult = DialogResult.OK;
                this.Close();
            }
        }

        //인가 코드 요청하기
        public string getCode()
        {
            string url = webBrowserKakaoLogin.Url.ToString();
            string token = url.Substring(url.IndexOf("=") + 1);

            //사용자가 '동의하고 계속하기' 선택, 로그인 진행 시 응답 형태:
            //{REDIRECT_URI}?code={AUTHORIZE_CODE}
            if (url.CompareTo(DefineKakao.REDIRECT_URL + "?code=" + token) == 0)
            {
                return token;
            }
            else
            {
                return "";
            }
        }

        //토큰 요청하기
        public string getToken()
        {
            var client = new RestClient(DefineKakao.HOST_OAUTH_URL);

            var request = new RestRequest("/oauth/token", Method.POST);
            request.AddParameter("grant_type", "authorization_code");
            request.AddParameter("client_id", DefineKakao.API_KEY);
            request.AddParameter("redirect_uri", DefineKakao.REDIRECT_URL);
            request.AddParameter("code", DefineKakao.USER_CODE);

            var result = client.Execute(request);
            var json = JObject.Parse(result.Content);

            return json["access_token"].ToString();
        }
    }
}

인가 코드를 얻기 위해서 아래 문서와 같이 Request 형태로 호출하면 {REDIRECT_URI}?code={AUTHORIZE_CODE} 형태로 응답이 옵니다. 해당 응답 문자열에서 {AUTHORIZE_CODE}를 추출하면 되겠습니다. 이러한 동작이 getCode()에서 이루어집니다.

'인가 코드 얻기'의 요청과 응답

그리고 토큰을 얻기 위해서는 아래 문서처럼 요청하고, 응답받은 JSON 데이터를 파싱 하여 access_token을 얻을 수 있습니다.

'토큰 얻기'의 요청과 응답

메인 Form의 버튼 이벤트는 아래와 같이 구현합니다.

private void buttonLogInOut_Click(object sender, EventArgs e)
{
	if (buttonLogInOut.Text == "로그인")
	{
		//카카오 로그인 페이지 폼 생성하기
		FormKakaoLogin form = new FormKakaoLogin();
		if (form.ShowDialog() == DialogResult.OK)
		{
			buttonLogInOut.Text = "로그아웃";
		}
	}
	else
	{
		var client = new RestClient(DefineKakao.HOST_API_URL);
		//로그아웃 요청하기
		var request = new RestRequest("/v1/user/unlink", Method.POST);
		request.AddHeader("Authorization", "bearer " + DefineKakao.ACCESS_TOKEN);

		if (client.Execute(request).IsSuccessful)
		{
			buttonLogInOut.Text = "로그인";
		}
	}
}

로그인 동작에서는 위에서 설명한 FormKakaoLogin의 동작이 이뤄지고, 로그아웃 동작에서는 아래의 로그아웃 요청대로 동작하게 됩니다.

'로그아웃'의 요청

여기까지 구현하고 프로그램을 실행해 보겠습니다. 아래 이미지의 UI와 지금까지 설명한 UI에 다른 부분이 있습니다. 추후 계속 설명하면서 추가할 예정이니 걱정하지 않으셔도 되겠습니다. 로그인 버튼을 클릭합니다.

예제 프로그램 실행 화면

FormKakaoLogin Form이 생성됩니다. 계정 정보를 입력하고 로그인 버튼을 클릭합니다.

로그인 화면

그리고 다음과 같이 서비스 접근 권한 인증 화면이 표시됩니다. 전체 동의하기 또는 카카오톡 메시지 전송을 체크하고 동의하고 계속하기 버튼을 클릭합니다.

서비스 접근 권한 인증 화면

주의

 

 

그런데 아무리 마우스로 클릭해도 계속 회색 음영으로 표시될 것입니다. 이는 WinForm WebBrowser 컨트롤의 IE 버전이 너무 낮아서 그렇습니다. 이를 해결하기 위해서는 레지스트리 변경이 필요합니다. 본문에 첨부된 코드에서 SetIE11KeyforWebBrowserControl()에 IE11로 동작하도록 레지스트리 변경 코드가 구현되어 있습니다. 또한, 레지스트리 변경을 위해서는 Visual Studio를 관리자 권한으로 실행해야 하는 점을 주의하시기 바랍니다.

레지스트리 변경 후 다시 시도하면 아래와 같이 정상적으로 체크가 되는 것을 확인할 수 있습니다.

서비스 접근 권한 인증 화면

3. 나에게 기본 메시지 / 사용자 정의 메시지(템플릿) 전송하기

기본 메시지와 사용자 정의 메시지를 전송하면 아래와 같이 메시지가 보내집니다. 사용자 정의 메시지는 애플리케이션 설정에서 메시지 템플릿 만들기에서 설정한 메시지가 전송됩니다.

텍스트 타입의 기본 메시지 전송 결과

사용자 정의 메시지 전송 결과

메시지 보내기에 관한 개발 문서는 아래 링크에서 확인할 수 있습니다.

developers.kakao.com/docs/latest/ko/message/rest-api

Kakao Developers

이제 메시지 보내기도 구현해 보겠습니다. 우선 UI를 아래와 같이 구성합니다.

메시지 전송 관련 UI 컨트롤 추가

전송 버튼을 클릭하면 선택된 라디오 버튼에 따라 메시지를 전송하게 됩니다.

private void buttonSendMessage_Click(object sender, EventArgs e)
{
	if (radioButtonCustom.Checked == true) //사용자 정의 메시지 보내기
	{
		sendMessageToMyself(textBoxMessage.Text);
		textBoxMessage.Text = "";
	}
	else //템플릿 메시지 보내기
		sendTemplateMessageToMyself();
}

그럼 나에게 기본 메시지 보내기부터 상세하게 보겠습니다. 본문의 기본 메시지는 텍스트 타입으로 보냅니다. 텍스트 타입의 요청은 아래와 같습니다.

텍스트 타입 보내기

JSON 오브젝트를 아래와 같이 요청하면 사용자 정의 메시지가 전송됩니다.

나에게 기본 메시지 보내기 요청과 응답

기본 메시지를 보내는 코드는 sendMessagetoMyself()에 구현되어 있습니다.

private void sendMessageToMyself(string message)
{
	//JSON 구성
	JObject send = new JObject();
	JObject link = new JObject();
	send.Add("object_type", "text");
	send.Add("text", message);
	link.Add("web_url", "https://developers.kakao.com");
	link.Add("mobile_web_url", "https://developers.kakao.com");
	send.Add("link", link);
	send.Add("button_title", "링크 이동");

	//요청
	var client = new RestClient(DefineKakao.HOST_API_URL);
	var request = new RestRequest("/v2/api/talk/memo/default/send", Method.POST);
	request.AddHeader("Authorization", "bearer " + DefineKakao.ACCESS_TOKEN);
	request.AddParameter("template_object", send);

	if (client.Execute(request).IsSuccessful)
		MessageBox.Show("메시지 전송 성공!");
	else
		MessageBox.Show("메시지 전송 실패!");
}

사용자 정의 메시지 보내기는 더욱 심플합니다.

사용자 정의 메시지 보내기

아래와 같이 template_id만 구성하여 요청하면, 미리 만들어 놓은 템플릿 메시지가 전송됩니다.

사용자 정의 메시지 보내기 요청과 응답

사용자 정의 메시지를 보내는 코드는 sendTemplateMessageToMyself()에 구현되어 있습니다.

public void sendTemplateMessageToMyself()
{
	var client = new RestClient(DefineKakao.HOST_API_URL);

	var request = new RestRequest("/v2/api/talk/memo/send", Method.POST);
	request.AddHeader("Authorization", "bearer " + DefineKakao.ACCESS_TOKEN);
	request.AddParameter("template_id", DefineKakao.TEMPLATE_ID);

	if (client.Execute(request).IsSuccessful)
		MessageBox.Show("메시지 보내기 성공");
	else
		MessageBox.Show("메시지 보내기 실패");
}

결론

본문에서 소개한 나에게 메시지 보내기는 카카오 오픈 API의 아주 일부분일 뿐입니다. 이 외에도 카카오톡 소셜, 스토리, 채널, 싱크, 페이 등 정말 다양한 분야의 API를 제공하고 있습니다. 하나라도 할 줄만 안다면, 다른 것도 개발하는데 전혀 문제가 없으리라 생각합니다.

본문의 예제 코드는 아래 첨부된 파일을 참고하세요.

ExamKakaoTalk.zip

5.20MB