Kakao Talk Messaging: JavaScript

This document describes how to integrate Kakao Talk Messaging APIs into your service with the Kakao SDK for JavaScript ("JavaScript SDK").

You can test the features described in this document in [Tools] > [JS SDK demo] menu.

JS SDK demooutlink

Before you begin

Choose an API to use

According to your service's purpose and requirements, you need to decide which API to use first by considering their characteristics and difference.

1. Select a type of Messaging API 2. Select a message type and configuration method 3. Select a target

APIs by conditions

The JavaScript SDK does not provide the Kakao Talk Messaging API as a built-in function. To implement the Kakao Talk Messaging API on a web page, make a request in the same content as a REST API using the Kakao.API.request() function. According to the desired message type, the required components of the message and the API to call are different. Refer to Message template components and samples.

Message type	Configuration method	Target	API to call
Feed, List, Location, Commerce, Text, Calendar	Default template	Me (MyChatroom)	/v2/api/talk/memo/default/send
Feed, List, Location, Commerce, Text, Calendar	Default template	Friends	/v1/api/talk/friends/message/default/send
Feed, List, Commerce	Custom template	Me (MyChatroom)	/v2/api/talk/memo/send
Feed, List, Commerce	Custom template	Friends	/v1/api/talk/friends/message/send
Scrape	Default template	Me (MyChatroom)	/v2/api/talk/memo/scrap/send
Scrape	Default template	Friends	/v1/api/talk/friends/message/scrap/send
Scrape	Custom template	Me (MyChatroom)	/v2/api/talk/memo/scrap/send
Scrape	Custom template	Friends	/v1/api/talk/friends/message/scrap/send

Set Custom URL Scheme

Messages sent through Kakao Talk include a link to open the specified web page or app. The buttons in the message launch the app through a Custom URL Scheme consisting of a URI scheme and parameters. Refer to Kakao Talk Sharing: JavaScript > Set Custom URL Scheme for more details.

Send message with default template

Basic information

Reference	App setting
Kakao.API.request()	Install Initialize Set Custom URL Scheme

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items	Required	Required: Send message in KakaoTalk

This API enables you to configure a message as an object type according to the default template type to use. Pass the configured template_object through the data parameter.

To send a message to friends, obtain the receiving users' uuids through the Friends picker or the Retrieving list of friends API, and then pass the uuids as the receiver_uuids parameter. You can send a message to up to five friends at once.

Kakao.API.request() returns Promise. For the detailed response fields returned if the promise is fulfilled, refer to REST API > Send message with default template.

Send to me

Request

Call the Kakao.API.request() function, and set url to /v2/api/talk/memo/default/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v2/api/talk/memo/default/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending me message with default template

Name	Type	Description	Required
template_object	DefaultFeedSettings DefaultListSettings DefaultLocationSettings DefaultCommerceSettings DefaultTextSettings DefaultCalendarSettings	Object containing the message components.	O

Sample

Kakao.API.request({
  url: '/v2/api/talk/memo/default/send',
  data: {
    template_object: {
      object_type: 'feed',
      content: {
        title: 'Strawberry cheese cake',
        description: '#cake #strawberry #cafe #atmosphere #blinddate',
        image_url:
          'https://mud-kage.kakao.com/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://k.kakaocdn.net/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_url: 'http://k.kakaocdn.net/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_text: 'Cheese cake',
        title_image_category: 'Cake',
        items: [
          {
            item: 'Cake1',
            item_op: '1000 won',
          },
          {
            item: 'Cake2',
            item_op: '2000 won',
          },
          {
            item: 'Cake3',
            item_op: '3000 won',
          },
          {
            item: 'Cake4',
            item_op: '4000 won',
          },
          {
            item: 'Cake5',
            item_op: '5000 won',
          },
        ],
        sum: 'Total',
        sum_op: '15000 won',
      },
      social: {
        like_count: 100,
        comment_count: 200,
      },
      buttons: [
        {
          title: 'View on Web',
          link: {
            mobile_web_url: 'https://developers.kakao.com',
            web_url: 'https://developers.kakao.com',
          },
        },
        {
          title: 'View on App',
          link: {
            mobile_web_url: 'https://developers.kakao.com',
            web_url: 'https://developers.kakao.com',
          },
        },
      ],
    },
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send to friends

Request

Call the Kakao.API.request() function, and set url to v1/api/talk/friends/message/default/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to v1/api/talk/friends/message/default/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending friends message with default template

Name	Type	Description	Required
receiver_uuids	String[]	uuid ​​obtained through the Friends picker or the Retrieving list of friends API. Up to five uuids are allowed.	O
template_object	DefaultFeedSettings DefaultListSettings DefaultLocationSettings DefaultCommerceSettings DefaultTextSettings DefaultCalendarSettings	Object containing the message components.	O

Sample

Kakao.API.request({
  url: '/v1/api/talk/friends/message/default/send',
  data: {
    receiver_uuids: ['${RECEIVER_UUID}'],
    template_object: {
      object_type: 'feed',
      content: {
        title: 'Strawberry cheese cake',
        description: '#cake #strawberry #cafe #atmosphere #blinddate',
        image_url:
          'https://mud-kage.kakao.com/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://k.kakaocdn.net/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_url: 'http://k.kakaocdn.net/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png',
        title_image_text: 'Cheese cake',
        title_image_category: 'Cake',
        items: [
          {
            item: 'Cake1',
            item_op: '1000 won',
          },
          {
            item: 'Cake2',
            item_op: '2000 won',
          },
          {
            item: 'Cake3',
            item_op: '3000 won',
          },
          {
            item: 'Cake4',
            item_op: '4000 won',
          },
          {
            item: 'Cake5',
            item_op: '5000 won',
          },
        ],
        sum: 'Total',
        sum_op: '15000 won',
      },
      social: {
        like_count: 100,
        comment_count: 200,
      },
      buttons: [
        {
          title: 'View on Web',
          link: {
            mobile_web_url: 'https://developers.kakao.com',
            web_url: 'https://developers.kakao.com',
          },
        },
        {
          title: 'View on App',
          link: {
            mobile_web_url: 'https://developers.kakao.com',
            web_url: 'https://developers.kakao.com',
          },
        },
      ],
    },
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send message with custom template

Basic information

Reference	App setting
Kakao.API.request()	Install Initialize Set Custom URL Scheme

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items Message Template	Required	Required: Send message in KakaoTalk

Unlike the Sending message with default template, you can customize a template in [Tools] > [Message Template Builder] to send a message.

Set template_id to the template ID of the custom template registered in [Message Template Builder]. If you use user arguments for some components when you configure a custom message to input variable information, you must also pass key and value pairs as the value of template_args. Otherwise, the defined argument is displayed to users as raw data, such as ${key}.

To send a message to friends, obtain the receiving users' uuids through the Friends picker or the Retrieving list of friends API, and then pass the uuids as the receiver_uuids parameter. You can send a message to up to five friends at once.

Kakao.API.request() returns Promise. For the detailed response fields returned if the promise is fulfilled, refer to REST API > Send message with custom template.

Send to me

Request

Call the Kakao.API.request() function, and set url to /v2/api/talk/memo/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v2/api/talk/memo/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending me message with custom template

Name	Type	Description	Required
template_id	Number	Template ID of the custom message registered in [Tools] > [Message Template Builder]. Note: To use a custom template for sending to me, set the purpose of the custom template as [Kakao Talk Sharing].	O
template_args	Object	If the specified template contains a user argument, use this parameter to pass key-value pairs. You cannot overwrite the scrape result.	X

Sample

Kakao.API.request({
  url: '/v2/api/talk/memo/send',
  data: {
    template_id: ${YOUR_TEMPLATE_ID},
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send to friends

Request

Call the Kakao.API.request() function, and set url to /v1/api/talk/friends/message/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v1/api/talk/friends/message/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending friends message with custom template

Name	Type	Description	Required
receiver_uuids	String[]	uuid ​​obtained through the Friends picker or the Retrieving list of friends API. Up to five uuids are allowed.	O
template_id	Number	Template ID of the custom message registered in [Tools] > [Message Template Builder].	O
template_args	Object	If the specified template contains a user argument, use this parameter to pass key-value pairs. You cannot overwrite the scrape result.	X

Sample

Kakao.API.request({
  url: '/v1/api/talk/friends/message/send',
  data: {
    receiver_uuids: ['${RECEIVER_UUID}'],
    template_id: ${YOUR_TEMPLATE_ID},
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send scrape message with default template

Basic information

Reference	App setting
Kakao.API.request()	Install Initialize Set Custom URL Scheme

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items	Required	Required: Send message in KakaoTalk

This API scrapes a web page, and then configures a message based on the scraped web page information to send a message.

When you request to send a scrape message, you must pass request_url, a web page to be scraped. Make sure that you have registered the domain of the web page to be scraped as a site domain in [My Application] > [Platform] > [Web] in advance.

To send a message to friends, obtain the receiving users' uuids through the Friends picker or the Retrieving list of friends API, and then pass the uuids as the receiver_uuids parameter. You can send a message to up to five friends at once.

Kakao.API.request() returns Promise. For the detailed response fields returned if the promise is fulfilled, refer to REST API > Send scrape message with default template.

Send to me

Request

Call the Kakao.API.request() function, and set url to /v2/api/talk/memo/scrap/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v2/api/talk/memo/scrap/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending me scrape message with default template

Name	Type	Description	Required
request_url	String	Web page URL to be scraped. Its domain must match the domain registered on the Kakao Developers. Refer to Scrape message.	O

Sample

Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send',
  data: {
    request_url: 'https://developers.kakao.com',
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send to friends

Request

Call the Kakao.API.request() function, and set url to /v1/api/talk/friends/message/scrap/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v1/api/talk/friends/message/scrap/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending friends scrape message with default template

Name	Type	Description	Required
receiver_uuids	String[]	uuid ​​obtained through the Friends picker or the Retrieving list of friends API. Up to five uuids are allowed.	O
request_url	String	Web page URL to be scraped. Its domain must match the domain registered on the Kakao Developers. Refer to Scrape message.	O

Sample

Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send',
  data: {
    receiver_uuids: ['${RECEIVER_UUID}'],
    request_url: 'https://developers.kakao.com',
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send scrape message with custom template

Basic information

Reference	App setting
Kakao.API.request()	Install Initialize Set Custom URL Scheme

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items Message Template	Required	Required: Send message in KakaoTalk

This API scrapes a web page, and then configures a message based on the scraped web page information to send a message. Unlike the Sending scrape message with default template, you can use a custom template registered in [Tools] > [Message Template Builder] when requesting to send a scrape message.

When you request to send a scrape message, you must pass request_url, a web page to be scraped. Make sure that you have registered the domain of the web page to be scraped as a site domain in [My Application] > [Platform] > [Web] in advance.

Set template_id to the template ID of the custom template registered in [Message Template Builder]. If you use user arguments for some components when you configure a custom message to input variable information, you must also pass key and value pairs as the value of template_args. Otherwise, the defined argument is displayed to users as raw data, such as ${key}.

To send a message to friends, obtain the receiving users' uuids through the Friends picker or the Retrieving list of friends API, and then pass the uuids as the receiver_uuids parameter. You can send a message to up to five friends at once.

Kakao.API.request() returns Promise. For the detailed response fields returned if the promise is fulfilled, refer to REST API > Send scrape message with custom template.

Send to me

Request

Call the Kakao.API.request() function, and set url to /v2/api/talk/memo/scrap/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v2/api/talk/memo/scrap/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending me scrape message with custom template

Name	Type	Description	Required
request_url	String	Web page URL to be scraped. Its domain must match the domain registered on the Kakao Developers.	O
template_id	Number	Used when you want to send a scrape message with the template registered in [Tools] > [Message Template Builder]. Specify the ID of the template to apply. When you use this parameter, the scraped content is applied in the template with the specified template_id. Note: To use a custom template for sending to me, set the purpose of the custom template as [Kakao Talk Sharing].	O
template_args	Object	If you specify template_id and the specified template contains other user arguments besides the default argument keys, pass the user arguments using this parameter in key:value format. You cannot overwrite the scrape result.	X

Sample

Kakao.API.request({
  url: '/v2/api/talk/memo/scrap/send',
  data: {
    request_url: 'https://developers.kakao.com',
    template_id: ${YOUR_TEMPLATE_ID},
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Send to friends

Request

Call the Kakao.API.request() function, and set url to /v1/api/talk/friends/message/scrap/send.

Parameter

Name	Type	Description	Required
url	String	Fixed to /v1/api/talk/friends/message/scrap/send.	O
data	Object	Object containing parameters to be passed through API.	O

data: Sending friends scrape message with custom template

Name	Type	Description	Required
receiver_uuids	String[]	uuid ​​obtained through the Friends picker or the Retrieving list of friends API. Up to five uuids are allowed.	O
request_url	String	Web page URL to be scraped. Its domain must match the domain registered on the Kakao Developers.	O
template_id	Number	Used when you want to send a scrape message with the template registered in [Tools] > [Message Template Builder]. Specify the ID of the template to apply. When you use this parameter, the scraped content is applied in the template with the specified template_id.	O
template_args	Object	If you specify template_id and the specified template contains other user arguments besides the default argument keys, pass the user arguments using this parameter in key:value format. You cannot overwrite the scrape result.	X

Sample

Kakao.API.request({
  url: '/v1/api/talk/friends/message/scrap/send',
  data: {
    receiver_uuids: ['${RECEIVER_UUID}'],
    request_url: 'https://developers.kakao.com',
    template_id: ${YOUR_TEMPLATE_ID},
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Upload image

You can attach images to a message by passing an image URL when configuring a message template or by uploading images in the Message template builder in advance. Refer to Upload image.

See more

Message Template Builderoutlink Kakao Talk Messaging for JavaScript SDK v1