Message Template

Default template

This document explains how to compose messages to send with the Kakao Talk Message API and the Kakao Talk Share API using predefined default templates.

A default template is a template in which a message is written in object form according to a fixed format. For details, see Concepts.

How to use

After deciding which message template to use by referring to Template types, compose the template object according to the defined format of the desired template below.
Web links and app links in messages sent with a default template are allowed to connect only to the domains and schemes below that are registered in Product Link on the app management page. For the details, see each document.
- Web link: Specify one of the Web domains.
- App link: Fixed to the Default native app scheme.
When calling the Kakao Talk Message API or the Kakao Talk Share API, pass the composed template object using the parameter name defined for each language. For examples of each item and development documents by platform, see the respective documents.

Default template link settings when changing default native app scheme

If you change the default native app scheme, the schemes allowed for app links in the default template are also changed together. In this case, link connection errors may occur in messages, so you must check the impact and take necessary actions in advance.

Feed template

To use the Feed template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `feed`.	O
content	`Content`	Main content information of the message.	O
item_content	`ItemContent`	Content to include in the item area. Used when composing as Feed Type B.	X
social	`Social`	Social information about the content.	X
button_title	`String`	Set when you want to change the default button title ("View details").	X
buttons	`Buttons[]`	Button list, maximum 2. Used when you want to change button title and link, or when you want to add two buttons.	X

// Example of template_object composition for Feed template message
{
        "object_type": "feed",
        "content": {
            "title": "Today's Dessert",
            "description": "Americano, Bread, Cake",
            "image_url": "https://mud-kage.kakao.com/dn/NTmhS/btqfEUdFAUf/FjKzkZsnoeE4o19klTOVI1/openlink_640x640s.jpg",
            "image_width": 640,
            "image_height": 640,
            "link": {
                "web_url": "http://www.daum.net",
                "mobile_web_url": "http://m.daum.net",
                "android_execution_params": "contentId=100",
                "ios_execution_params": "contentId=100"
            }
        },
        "item_content" : {
            "profile_text" :"Kakao",
            "profile_image_url" :"https://mud-kage.kakao.com/dn/Q2iNx/btqgeRgV54P/VLdBs9cvyn8BJXB3o7N8UK/kakaolink40_original.png",
            "title_image_url" : "https://mud-kage.kakao.com/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,
            "shared_count": 300,
            "view_count": 400,
            "subscriber_count": 500
        },
        "buttons": [
            {
                "title": "Go to Web",
                "link": {
                    "web_url": "http://www.daum.net",
                    "mobile_web_url": "http://m.daum.net"
                }
            },
            {
                "title": "Go to App",
                "link": {
                    "android_execution_params": "contentId=100",
                    "ios_execution_params": "contentId=100"
                }
            }
        ]
    }'

List template

To use the List template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `list`.	O
header_title	`String`	Main title displayed at the top of the list, maximum 200 characters.	O
header_link	`Link`	Link information corresponding to the header title content.	O
contents	`Content[]`	Content list displayed in the list, minimum 2 required, maximum 3.	O
button_title	`String`	Set when you want to change the default button title ("View details").	X
buttons	`Buttons[]`	Button list, maximum 2. Used when you want to change button title and link, or when you want to add two buttons.	X

// Example of template_object composition for List template message
    {
        "object_type": "list",
        "header_title": "WEEKLY MAGAZINE",
        "header_link": {
            "web_url": "http://www.daum.net",
            "mobile_web_url": "http://m.daum.net",
            "android_execution_params": "main",
            "ios_execution_params": "main"
        },
        "contents": [
            {
                "title": "Space for Bicycle Riders",
                "description": "Magazine",
                "image_url": "https://mud-kage.kakao.com/dn/QNvGY/btqfD0SKT9m/k4KUlb1m0dKPHxGV8WbIK1/openlink_640x640s.jpg",
                "image_width": 640,
                "image_height": 640,
                "link": {
                    "web_url": "http://www.daum.net/contents/1",
                    "mobile_web_url": "http://m.daum.net/contents/1",
                    "android_execution_params": "/contents/1",
                    "ios_execution_params": "/contents/1"
                }
            },
            {
                "title": "Oreo Cappuccino with Amazing Visual",
                "description": "Magazine",
                "image_url": "https://mud-kage.kakao.com/dn/boVWEm/btqfFGlOpJB/mKsq9z6U2Xpms3NztZgiD1/openlink_640x640s.jpg",
                "image_width": 640,
                "image_height": 640,
                "link": {
                    "web_url": "http://www.daum.net/contents/2",
                    "mobile_web_url": "http://m.daum.net/contents/2",
                    "android_execution_params": "/contents/2",
                    "ios_execution_params": "/contents/2"
                }
            },
            {
                "title": "Atmosphere Full of Sensibility",
                "description": "Magazine",
                "image_url": "https://mud-kage.kakao.com/dn/NTmhS/btqfEUdFAUf/FjKzkZsnoeE4o19klTOVI1/openlink_640x640s.jpg",
                "image_width": 640,
                "image_height": 640,
                "link": {
                    "web_url": "http://www.daum.net/contents/3",
                    "mobile_web_url": "http://m.daum.net/contents/3",
                    "android_execution_params": "/contents/3",
                    "ios_execution_params": "/contents/3"
                }
            }
        ],
        "buttons": [
            {
                "title": "Go to Web",
                "link": {
                    "web_url": "http://www.daum.net",
                    "mobile_web_url": "http://m.daum.net"
                }
            },
            {
                "title": "Go to App",
                "link": {
                    "android_execution_params": "main",
                    "ios_execution_params": "main"
                }
            }
        ]
    }'

* header_image_url, header_image_width, header_image_height: Deprecated. For header background image, see Notice.

Commerce template

To use the Commerce template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `commerce`.	O
content	`Content`	Content information of the message.	O
commerce	`Commerce`	Product name and price information.	O
button_title	`String`	Set when you want to change the default button title ("View details").	X
buttons	`Buttons[]`	Button list, maximum 2. Used when you want to change button title and link, or when you want to add two buttons.	X

// Example of template_object composition for Commerce template message
{
  "object_type": "commerce",
  "content": {
    "title": "Ivory long dress (4 Color)",
    "image_url": "https://mud-kage.kakao.com/dn/RY8ZN/btqgOGzITp3/uCM1x2xu7GNfr7NS9QvEs0/kakaolink40_original.png",
    "image_width": 640,
    "image_height": 640,
    "link": {
      "web_url": "https://style.kakao.com/main/women/contentId=100",
      "mobile_web_url": "https://style.kakao.com/main/women/contentId=100",
      "android_execution_params": "contentId=100",
      "ios_execution_params": "contentId=100"
    }
  },
  "commerce": {
    "regular_price": 208800,
    "discount_price": 146160,
    "discount_rate": 30
  },
  "buttons": [
    {
      "title": "Buy now",
      "link": {
        "web_url": "https://style.kakao.com/main/women/contentId=100/buy",
        "mobile_web_url": "https://style.kakao.com/main/women/contentId=100/buy",
        "android_execution_params": "contentId=100&buy=true",
        "ios_execution_params": "contentId=100&buy=true"
      }
    },
    {
      "title": "Share",
      "link": {
        "web_url": "https://style.kakao.com/main/women/contentId=100/share",
        "mobile_web_url": "https://style.kakao.com/main/women/contentId=100/share",
        "android_execution_params": "contentId=100&share=true",
        "ios_execution_params": "contentId=100&share=true"
      }
    }
  ]
}

Location template

To use the Location template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `location`.	O
address	`String`	Address of the location to share. (Example: 235, Pangyoyeok-ro, Bundang-gu, Seongnam-si, Gyeonggi-do.)	O
address_title	`String`	Title used in the map view in KakaoTalk. (Example: Kakao Pangyo Office.)	X
content	`Content`	Content information describing the location.	O
social	`Social`	Additional social information.	X
button_title	`String`	Set when you want to change the default button title ("View details").	X
buttons	`Buttons[]`	Button list, up to 2. Used when you want to change the button title and link, or add two buttons.	X

// Example of template_object composition for Location template message
{
  "object_type": "location",
  "content": {
    "title": "Kakao Pangyo Office",
    "description": "Location of Kakao Pangyo Office.",
    "image_url": "https://mud-kage.kakao.com/dn/drTdbB/bWYf06POFPf/owUHIt7K7NoGD0hrzFLeW0/kakaolink40_original.png",
    "image_width": 800,
    "image_height": 800,
    "link": {
      "web_url": "https://developers.kakao.com",
      "mobile_web_url": "https://developers.kakao.com/mobile",
      "android_execution_params": "platform=android",
      "ios_execution_params": "platform=ios"
    }
  },
  "buttons": [
    {
      "title": "View on Web",
      "link": {
        "web_url": "https://developers.kakao.com",
        "mobile_web_url": "https://developers.kakao.com/mobile"
      }
    }
  ],
  "address": "235 Pangyo Station-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, H Square N Building 7th Floor",
  "address_title": "Kakao Pangyo Office"
}

Text template

To use the Text template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `text`.	O
text	`String`	Text information, maximum 200 characters.	O
link	`Link`	Link information to move when content is clicked.	O
button_title	`String`	Set when you want to change the default button title ("View details").	X
buttons	`Buttons[]`	Button list, maximum 2. Used when you want to change button title and link, or when you want to add two buttons.	X

// Example of template_object composition for Text template message
{
  "object_type": "text",
  "text": "This is the text area. You can display up to 200 characters.",
  "link": {
    "web_url": "https://developers.kakao.com",
    "mobile_web_url": "https://developers.kakao.com"
  },
  "button_title": "Check now"
}

Calendar template

To use the Calendar template, you must compose the object as follows.

Name	Type	Description	Required
object_type	`String`	Fixed as `calendar`.	O
id_type	`String`	Type of `id`, one of `event` (public schedule) or `calendar` (subscription calendar). Important: Depending on `id_type`, the default button in outputs the following specified text. Public event ID: [Schedule registration]. Subscription calendar ID: [Calendar subscription].	O
id	`String`	Public event or Subscribed calendar ID.	O
content	`Content`	Schedule title and description.	O
buttons	`Buttons[]`	User-defined button information, maximum 1 button information only. Calendar messages provide a default button for adding public schedules or subscribing to subscription calendars, and 1 user-defined button can be optionally added.	X

// Example of template_object composition for Calendar template message
{
  "object_type": "calendar",
  "content": {
    "title": "Schedule title",
    "description": "Schedule description",
    "image_url": "https://developers.kakao.com/static/images/pc/txt_visual1.png",
    "link": {
      "web_url": "https://kakao.com"
    }
  },
  "buttons": [
    {
      "title": "View schedule information",
      "link": {
        "web_url": "https://developers.kakao.com",
        "mobile_web_url": "https://developers.kakao.com/mobile"
      }
    }
  ],
  "id_type": "event",
  "id": "6351f57c7ec8e318d0b809a0"
}

Common components

This section describes the common components that make up message templates.

Content

This object contains the basic content information of the message, such as message title, body, and image information.

For images, they must be passed as URLs and must comply with RFC2396, RFC1034, and RFC1123. Image URLs that do not comply with the specifications will not display images.

Name	Type	Description	Required
title	`String`	Title of the content	O*
image_url	`String`	Image URL of the content	O*
image_width	`Int`	Width of the content image in pixels	X
image_height	`Int`	Height of the content image in pixels	X
description	`String`	Detailed description of the content, displayed up to 4 lines combined with the title	O*
link	`Link`	Link information to navigate to when the content is clicked	O

* One of title, image_url, or description is required

Button

This object contains information about buttons included in the message. It defines the button text and actions when clicked.

When composing a message, if both buttonTitle and buttons are provided, buttons takes precedence. If neither is provided, one button is composed with the default title and link information from content.

Name	Type	Description	Required
title	`String`	Button title	O
link	`Link`	Link information to move to when the button is clicked (at least one is required)	O

Link

The object contains link information used when a user selects the content area or a button in a message.

The web link and app link of the default template apply the default web domain and the default native app scheme configured in [App] > [Product Link] on the app management page. For the details, see each corresponding item.

Links can be configured per platform, and an appropriate link is applied according to the user’s Kakao Talk execution environment. Web links are supported on PC/Mac, Android, and iOS, while Android and iOS app links are applied to buttons only on their respective platforms. For the details, see the link behavior.

To apply a link to a message, at least one field of link must be configured. If no link is configured, or if a configured link is not supported in the user’s Kakao Talk execution environment, the link is not applied to the message content area or the button is not displayed.

Name	Type	Description	Required
web_url	`String`	Web link URL used in Kakao Talk for PC version. The domain part must match the domain registered in [App] > [Product Link] > Web domain.	O*
mobile_web_url	`String`	Web link URL used in Kakao Talk for mobile. The domain part must match the domain registered in [App] > [Product Link] > Web domain.	O*
android_execution_params	`String`	Parameters used in the app link URL for Kakao Talk on Android. If this value is not provided, mobile_web_url is used.	O*
ios_execution_params	`String`	Parameters used in the app link URL for Kakao Talk on iOS. If this value is not provided, mobile_web_url is used.	O*

* One of web_url, mobile_web_url, android_execution_params, or ios_execution_params is required.

Social

This object is used to display areas that show social metrics such as likes, comments, shares, views, and subscriber counts for content.

Name	Type	Description	Required
like_count	`Int`	Number of likes for the content	X
comment_count	`Int`	Number of comments for the content	X
shared_count	`Int`	Number of shares for the content	X
view_count	`Int`	Number of views for the content	X
subscriber_count	`Int`	Number of subscribers for the content	X

ItemContent

This is text item information that can be used in Feed Type B templates.

Name	Type	Description	Required
profile_text	`String`	Text displayed in the header or profile area. If `profile_image_url` is not provided, only a bold title is shown as the header. Up to 16 characters.	X
profile_image_url	`String`	Image displayed in the profile area. Shown as a small circular profile photo.	X
title_image_text	`String`	Title of the image item. Up to 2 lines, up to 24 characters.	X
title_image_url	`String`	Image of the image item. Image size: iOS: 108x108 Android: 98x98 Images not in 1:1 ratio are center cropped.	X
title_image_category	`String`	Category information displayed in gray text below the image item title. Up to 1 line, up to 14 characters.	X
items	`ItemInfo[]`	Information for each text item. JSON array including `item` and `item_op` for item name and price, up to 5 items supported. (Example: `[{"item": "item1 name", "item_op": "item1_description"}, {"item": "item2 name", "item_op": "item2_description"}]`) Note: Feed Type B [G] area	X
sum	`String`	Summary title for the item area, such as order amount or payment amount. Displayed below the text item area, up to 6 characters. Note: Feed Type B [H] area	X
sum_op	`String`	Total price information for the item area. Displayed in bold below the text item area, up to 11 characters. Note: Feed Type B [H] area	X

ItemInfo

This is information about one text item in the text item list.

Name	Type	Description	Required
item	`String`	Item name Up to 6 characters.	O
item_op	`String`	Item price Allowed characters: numbers, currency symbols, commas (,), periods (.), spaces. If including decimal amounts, up to 2 decimal places is recommended. Up to 2 lines: 14 characters for 1 line, 25 characters for 2 lines.	O

Commerce

This is text item information that can represent product information.

Name	Type	Description	Required
product_name	`String`	Product name and title, up to 2 lines. Displayed above the product price in black text.	X
regular_price	`Int`	Regular price	O
discount_price	`Int`	Discounted price	X
discount_rate	`Int`	Discount rate	X
fixed_discount_price	`Int`	Fixed discount price, cannot be used with discount rate	X
currency_unit	`String`	Currency unit or symbol (Example: won, USD, ₩, $) (Default: won)	X
currency_unit_position	`Int`	Position of the currency unit `0`: after the price `1`: before the price (Default: `0`)	X

Docs Home

Getting started

Kakao Developers

Login

Communication

Kakao Map

Navigation

Advertisement

Search

More