페이지 이동경로
  • 문서>
  • 메시지>
  • 카카오톡 메시지: JavaScript

메시지

카카오톡 메시지: JavaScript

이 문서는 Kakao SDK for JavaScript(이하 JavaScript SDK)를 사용한 카카오톡 메시지 API 구현 방법을 안내합니다.

이 문서에 포함된 기능 일부는 [도구] > [JS 데모]를 통해 사용해 볼 수 있습니다.

애플리케이션 설정 확인

이 기능을 사용하려면 카카오디벨로퍼스(Kakao Developers, 이하 개발자 웹사이트) 애플리케이션(이하 앱) 설정에 Web 플랫폼 및 도메인 등 정보가 등록되어 있어야 합니다. 자세한 내용은 애플리케이션 등록을 참고합니다.

이 문서에 사용된 태그

Tag Description
로그인 필수 카카오 로그인이 필요한 API를 의미합니다. 카카오 로그인을 먼저 구현하고, 카카오 로그인을 통해 발급 받은 액세스 토큰(Access Token)을 이용하여 해당 API를 호출해야 합니다.

시작하기 전에

보낼 메시지의 종류와 구성 방법에 따라 호출해야할 API가 다르므로, 개발 전 다음 순서대로 사용할 API를 선택합니다.

사용할 API 선택하기

Step 1. 메시지 API 선택

메시지 API는 카카오링크와 카카오톡 메시지 두 가지입니다. 이해하기를 참고해 어떤 API로 메시지 보내기를 구현할 것인지 결정합니다.

Step 2. 메시지 종류 및 구성 방법 선택

메시지 템플릿 > 종류를 참고하여 어떤 메시지 템플릿을 사용할지 결정합니다.

보낼 메시지는 기본 템플릿을 바탕으로 객체 형태로 구성하거나, 서비스에 맞게 직접 구성한 사용자 정의 템플릿을 사용하여 구성할 수 있습니다. 자세한 사항은 메시지 구성 방법을 참고합니다.

Step 3. 메시지 전송 대상 선택

카카오톡 메시지의 경우, 수신 대상에 따라 나에게 보내기, 친구에게 보내기로 API가 구분되어 있다는 점에 유의합니다.

  • 에게 보내기: 현재 로그인한 사용자의 카카오톡 '나와의 채팅'에 메시지를 보냅니다. 이 기능으로는 다른 사용자에게 메시지를 보낼 수 없고, 로그인한 사용자 본인에게만 메시지를 보낼 수 있습니다.
  • 친구에게 보내기: 현재 로그인한 사용자의 카카오톡 친구에게 메시지를 보냅니다. 친구 목록 가져오기 API를 통해 수신 대상 정보를 받는 과정을 추가 구현해야 합니다. 한 번에 최대 5명의 친구에게 메시지를 보낼 수 있습니다. 카카오톡 메시지 API의 경우, 일간 및 월간 제공량이 정해져 있으므로 운영 정책을 참고합니다.
동의 항목 설정 및 권한 필요

친구에게 카카오톡 메시지를 보내려면 동의 항목 설정을 참고하여 '카카오톡 메시지 전송' 동의 항목을 설정해야 합니다. 또한 이 API는 사용 권한이 필요합니다. 앱에 사용 권한이 부여되기 전에는 팀원을 대상으로만 동작하므로, 사용 권한 신청을 참고해 사용 권한을 신청해야 합니다.

선택 조건에 따른 API

JavaScript SDK는 카카오톡 메시지 API를 내장 함수 형태로 지원하지 않습니다. 웹 페이지에서 카카오톡 메시지 API를 사용하려면 Kakao.API.request 함수를 통해 REST API와 같은 URL로 요청합니다. 템플릿 종류에 따라 메시지 구성 요소가 다르므로 메시지 구성 시, 기본 메시지 템플릿 구성 요소 및 예제를 참고합니다.

메시지 종류 메시지 구성 방법 전송 대상 사용할 API
피드, 리스트, 위치, 커머스, 텍스트 기본 템플릿 /v2/api/talk/memo/default/send
피드, 리스트, 위치, 커머스, 텍스트 기본 템플릿 친구 /v1/api/talk/friends/message/default/send
피드, 리스트, 커머스 사용자 정의 템플릿 /v2/api/talk/memo/send
피드, 리스트, 커머스 사용자 정의 템플릿 친구 /v1/api/talk/friends/message/send
스크랩 기본 템플릿 /v2/api/talk/memo/scrap/send
스크랩 기본 템플릿 친구 /v1/api/talk/friends/message/scrap/send
스크랩 사용자 정의 템플릿 /v2/api/talk/memo/scrap/send
스크랩 사용자 정의 템플릿 친구 /v1/api/talk/friends/message/scrap/send

커스텀 URL 스킴(Custom URL Scheme) 설정하기

카카오톡 메시지는 지정된 웹 페이지 또는 앱을 실행하는 링크를 포함합니다. 메시지 속 버튼들은 URI 스킴(URI Schemes)과 파라미터로 구성된 커스텀 URL 스킴을 통해 앱을 실행합니다. 자세한 사항은 카카오링크: JavaScript > 커스텀 URL 스킴 설정하기를 참고합니다.

기본 템플릿으로 메시지 보내기 로그인 필수

사용하려는 기본 템플릿에 따라 메시지를 객체로 구성하여 보내는 기능입니다. template_object 객체로 메시지 내용을 구성하여 data 파라미터를 통해 전달합니다.

친구에게 메시지 보내기 요청 시, 친구 목록 가져오기 API의 응답으로 받은 uuidreceiver_uuids 파라미터에 전달합니다. 한 번에 최대 5명의 친구에게 메시지를 보낼 수 있습니다.

요청 성공 시 응답은 REST API의 기본 템플릿으로 메시지 보내기와 같습니다.

나에게 보내기

Request
Kakao.API.request({
  url: '/v2/api/talk/memo/default/send'
});
Parameter
Name Type Description Required
url String /v2/api/talk/memo/default/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 기본 템플릿으로 나에게 메시지 보내기 확인
O
data: 기본 템플릿으로 나에게 메시지 보내기
Name Type Description Required
template_object Object 메시지 구성 요소를 담은 객체(Object)
피드, 리스트, 위치, 커머스, 텍스트 중 하나
O
Sample
Kakao.API.request({
  url: '/v2/api/talk/memo/default/send',
  data: {
    template_object: {
      object_type: 'feed',
      content: {
        title: '카카오톡 링크 4.0',
        description: '디폴트 템플릿 FEED',
        image_url:
          'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        link: {
          web_url: 'https://developers.kakao.com',
          mobile_web_url: 'https://developers.kakao.com',
        },
      },
      item_content: {
        profile_text: 'Kakao',
        profile_image_url: 'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_url: 'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_text: 'Cheese cake',
        title_image_category: 'Cake',
        items: [
          {
            item: 'Cake1',
            item_op: '1000원',
          },
          {
            item: 'Cake2',
            item_op: '2000원',
          },
          {
            item: 'Cake3',
            item_op: '3000원',
          },
          {
            item: 'Cake4',
            item_op: '4000원',
          },
          {
            item: 'Cake5',
            item_op: '5000원',
          },
        ],
        sum: 'Total',
        sum_op: '15000원',
      },
      social: {
        like_count: 100,
        comment_count: 200,
      },
      button_title: '바로 확인',
    },
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

친구에게 보내기

Kakao.API.request({
  url: '/v1/api/talk/friends/message/default/send'
});
Parameter
Name Type Description Required
url String /v1/api/talk/friends/message/default/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 기본 템플릿으로 친구에게 메시지 보내기 확인
O
data: 기본 템플릿으로 친구에게 메시지 보내기
Name Type Description Required
receiver_uuids String[] 친구 목록 가져오기 API를 통해 얻은 사용자 uuid 값, 최대 5개 O
template_object Object 메시지 구성 요소를 담은 객체(Object)
피드, 리스트, 위치, 커머스, 텍스트 중 하나
O
Sample
Kakao.API.request({
  url: '/v1/api/talk/friends/message/default/send',
  data: {
    receiver_uuids: ['receiver_uuids'],
    template_object: {
      object_type: 'feed',
      content: {
        title: '카카오톡 링크 4.0',
        description: '디폴트 템플릿 FEED',
        image_url:
          'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        link: {
          web_url: 'https://developers.kakao.com',
          mobile_web_url: 'https://developers.kakao.com',
        },
      },
      item_content: {
        profile_text: 'Kakao',
        profile_image_url: 'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_url: 'http://mud-kage.kakao.co.kr/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_text: 'Cheese cake',
        title_image_category: 'Cake',
        items: [
          {
            item: 'Cake1',
            item_op: '1000원',
          },
          {
            item: 'Cake2',
            item_op: '2000원',
          },
          {
            item: 'Cake3',
            item_op: '3000원',
          },
          {
            item: 'Cake4',
            item_op: '4000원',
          },
          {
            item: 'Cake5',
            item_op: '5000원',
          },
        ],
        sum: 'Total',
        sum_op: '15000원',
      },
      social: {
        like_count: 100,
        comment_count: 200,
      },
      button_title: '바로 확인',
    },
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

사용자 정의 템플릿으로 메시지 보내기 로그인 필수

기본 템플릿으로 메시지 보내기와는 달리, [도구] > [메시지 템플릿]에서 직접 구성한 사용자 정의 템플릿을 사용하여 메시지를 보내는 기능입니다.

[도구] > [메시지 템플릿]에서 구성한 템플릿의 ID를 template_id 파라미터로 전달합니다. 메시지에 변동되는 정보를 포함하려면 해당 템플릿에 사용자 인자를 추가한 후, template_args 파라미터를 통해 전달합니다. 메시지 템플릿에 사용자 인자가 포함되었음에도 template_args 파라미터를 사용하지 않으면 메시지에 ${key}가 글자 그대로 포함됩니다.

친구에게 메시지 보내기 요청 시, 친구 목록 가져오기 API의 응답으로 받은 uuidreceiver_uuids 파라미터에 전달합니다. 한 번에 최대 5명의 친구에게 메시지를 보낼 수 있습니다.

요청 성공 시 응답은 REST API의 사용자 정의 템플릿으로 메시지 보내기와 같습니다.

나에게 보내기

Request
Kakao.API.request({
  url: '/v2/api/talk/memo/send'
});
Parameter
Name Type Description Required
url String /v2/api/talk/memo/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 사용자 정의 템플릿으로 나에게 메시지 보내기 확인
O
data: 사용자 정의 템플릿으로 나에게 메시지 보내기
Name Type Description Required
template_id Number 메시지 템플릿 도구에서 구성한 사용자 정의 템플릿의 ID O
template_args Object template_id로 지정한 템플릿에 사용자 인자(User argument)가 포함되어 있는 경우 대입할 값, key:value 형식으로 전달 X
Sample
Kakao.API.request({
  url: '/v2/api/talk/memo/send',
  data: {
    template_id: TEMPLATE_ID,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

친구에게 보내기

Request
Kakao.API.request({
  url: '/v1/api/talk/friends/message/send'
});
Parameter
Name Type Description Required
url String /v1/api/talk/friends/message/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 사용자 정의 템플릿으로 친구에게 메시지 보내기 확인
O
data: 사용자 정의 템플릿으로 친구에게 메시지 보내기
Name Type Description Required
receiver_uuids String[] 친구 목록 가져오기 API를 통해 얻은 사용자 uuid 값, 최대 5개 O
template_id Number 메시지 템플릿 도구에서 구성한 사용자 정의 템플릿의 ID O
template_args Object template_id로 지정한 템플릿에 사용자 인자(User argument)가 포함되어 있는 경우 대입할 값, key:value 형식으로 전달 X
Sample
Kakao.API.request({
  url: '/v1/api/talk/friends/message/send',
  data: {
    receiver_uuids: ['receiver_uuids'],
    template_id: TEMPLATE_ID,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

기본 템플릿으로 스크랩 메시지 보내기 로그인 필수

스크랩한 웹 페이지 정보를 바탕으로 메시지를 구성하여 보내는 기능입니다.

요청 시, 스크랩할 웹 페이지 URL(request_url)을 필수로 전달합니다. 또한 스크랩할 웹 페이지의 도메인은 [내 애플리케이션] > [플랫폼] > [Web]에 등록돼 있어야 합니다.

친구에게 메시지 보내기 요청 시, 친구 목록 가져오기 API의 응답으로 받은 uuidreceiver_uuids 파라미터에 전달합니다. 한 번에 최대 5명의 친구에게 메시지를 보낼 수 있습니다.

요청 성공 시 응답은 REST API의 기본 템플릿으로 스크랩 메시지 보내기와 같습니다.

나에게 보내기

Request
Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send'
});
Parameter
Name Type Description Required
url String /v2/api/talk/memo/scrap/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 기본 템플릿으로 나에게 스크랩 메시지 보내기 확인
O
data: 기본 템플릿으로 나에게 스크랩 메시지 보내기
Name Type Description Required
request_url String 스크랩할 웹 페이지 URL, [내 애플리케이션] > [플랫폼] > [Web]에 등록된 도메인만 사용 가능 O
Sample
Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send',
  data: {
    request_url: SITE_URL,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

친구에게 보내기

Request
Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send'
});
Parameter
Name Type Description Required
url String /v1/api/talk/friends/message/scrap/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 기본 템플릿으로 친구에게 스크랩 메시지 보내기 확인
O
data: 기본 템플릿으로 친구에게 스크랩 메시지 보내기
Name Type Description Required
receiver_uuids String[] 친구 목록 가져오기 API를 통해 얻은 사용자 uuid 값, 최대 5개 O
request_url String 스크랩할 웹 페이지 URL, [내 애플리케이션] > [플랫폼] > [Web]에 등록된 도메인만 사용 가능 O
Sample
Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send',
  data: {
    receiver_uuids: ['receiver_uuids'],
    request_url: SITE_URL,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

사용자 정의 템플릿으로 스크랩 메시지 보내기 로그인 필수

스크랩한 웹 페이지 정보를 바탕으로 메시지를 구성하여 보내는 기능입니다. 기본 템플릿으로 스크랩 메시지 보내기와 다르게, [도구] > [메시지 템플릿]에서 구성한 사용자 정의 템플릿을 사용하여 메시지를 구성합니다.

요청 시, 스크랩할 웹 페이지 URL(request_url)은 필수로 전달해합니다. 이 때, 스크랩할 웹 페이지의 도메인은 [내 애플리케이션] > [플랫폼] > [Web]에 등록돼 있어야 합니다.

또한 [도구] > [메시지 템플릿]에서 구성한 사용자 정의 템플릿의 ID를 template_id 파라미터로 함께 전달합니다. 메시지에 변동되는 정보를 포함하려면 해당 템플릿에 사용자 인자를 추가한 후, template_args 파라미터를 통해 전달합니다. 메시지 템플릿에 사용자 인자가 포함되었음에도 template_args 파라미터를 사용하지 않으면 메시지에 ${key}가 글자 그대로 포함됩니다.

친구에게 메시지 보내기 요청 시, 친구 목록 가져오기 API의 응답으로 받은 uuidreceiver_uuids 파라미터에 전달합니다. 한 번에 최대 5명의 친구에게 메시지를 보낼 수 있습니다.

요청 성공 시 응답은 REST API의 사용자 정의 템플릿으로 스크랩 메시지 보내기와 같습니다.

나에게 보내기

Request
Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send'
});
Parameter
Name Type Description Required
url String /v2/api/talk/memo/scrap/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 사용자 정의 템플릿으로 나에게 스크랩 메시지 보내기 확인
O
data: 사용자 정의 템플릿으로 나에게 스크랩 메시지 보내기
Name Type Description Required
request_url String 스크랩할 웹 페이지 URL, [내 애플리케이션] > [플랫폼] > [Web]에 등록된 도메인만 사용 가능 O
template_id Number 스크랩한 정보를 반영할 사용자 정의 템플릿의 ID O
template_args Object template_id로 지정한 템플릿에 사용자 인자(User argument)가 포함되어 있는 경우 대입할 값, key:value 형식으로 전달
스크랩 결과를 덮어쓰기(overwrite) 할 수는 없음
X
Sample
Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send',
  data: {
    request_url: SITE_URL,
    template_id: TEMPLATE_ID,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

친구에게 보내기

Request
Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send'
});
Parameter
Name Type Description Required
url String /v1/api/talk/friends/message/scrap/send로 고정 O
success Function(Object) API 호출이 성공할 때 실행되는 콜백 함수 X
fail Function(Object) API 호출이 실패할 때 실행되는 콜백 함수 X
always Function(Object) API 호출 성공 여부에 관계 없이 항상 호출되는 콜백 함수 X
data Object API에 전달할 파라미터
자세한 내용은 data: 사용자 정의 템플릿으로 친구에게 스크랩 메시지 보내기 확인
O
data: 사용자 정의 템플릿으로 친구에게 스크랩 메시지 보내기
Name Type Description Required
receiver_uuids String[] 친구 목록 가져오기 API를 통해 얻은 사용자 uuid 값, 최대 5개 O
request_url String 스크랩할 웹 페이지 URL, [내 애플리케이션] > [플랫폼] > [Web]에 등록된 도메인만 사용 가능 O
template_id Number 스크랩한 정보를 반영할 사용자 정의 템플릿의 ID O
template_args Object template_id로 지정한 템플릿에 사용자 인자(User argument)가 포함되어 있는 경우 대입할 값, key:value 형식으로 전달
스크랩 결과를 덮어쓰기(overwrite) 할 수는 없음
X
Sample
Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send',
  data: {
    receiver_uuids: ['receiver_uuids'],
    request_url: SITE_URL,
    template_id: TEMPLATE_ID,
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

이미지 업로드하기

메시지에 넣을 이미지는 URL 형태로 메시지 템플릿 구성 시에 첨부하거나, 메시지 템플릿 도구에서 미리 업로드할 수 있습니다. 자세한 사항은 카카오링크: JavaScript > 이미지 업로드하기를 참고합니다.

더보기