Tool: Message template builder

You can easily register and modify a custom message as you want in [Tools] > [Message Template Builder]. Register custom templates for each app. You cannot use another app's custom templates when requesting Message APIs. Click [Create template] and choose a type to register a new custom template.

Message template list

🅐 App information: Displays the currently selected app. You can change to a different app by clicking the list icon next to the app name. 🅑 Add a Message Template: Allows you to add a new message template for the selected app. 🅒 Search & Filter area: Enter a target keyword or select the options such as template title, message title, content, or button name to filter specific templates. 🅓 Template list: Views all templates registered under the selected app. You can configure the the detailed settings page by clicking a template. 🅔 More button: Allows you to copy or delete the selected template.

Message template settings

🅐 App information: Displays the currently selected app. You can change to a different app by clicking the list icon next to the app name. 🅑 Template list: Views all templates registered under the selected app. You can configure the the detailed settings page by clicking a template. 🅒 Custom template information: Displays the template ID, name, and types and provides buttons for saving and deleting. 🅓 Search Results: Returns to the Message template list before performing a search. 🅔 Common settings: Displays the Purpose and the Allow forwarding options. 🅕 Component settings: Provides settings for each component. 🅖 Preview: Displays the preview according to current settings. Click each part to set the component. 🅗 Save: Saves any modifications. It functions the same as [Save] in section 🅒.

Common settings

In the common setting, you can set the [Purpose] and [Allow forwarding] options for the chat bubble.

Name	Description
Purpose	Select which API the message will be used for. Choose one of [Kakao Talk Share] or [Kakao Talk Message API]. Note: If you use the message only to send to me APIs, set the [Purpose] to [Kakao Talk Share].
Allow forwarding	Select whether to add the forward icon next to the message. [Allow]: Users are allowed to forward the message to the user's friends or a chatroom. [Disallow]: Users cannot forward the message. [Custom]: You can make the message forwardable when requesting.

Image

Image is a message component included in content. To exclude the image area from the message, delete all images by clicking [Delete].

Name	Description
Image	You can upload up to three images, and each image file size must be 5 MB or less. If selecting [Custom], you can use a user argument and pass the image URL value when requesting to send a message. In this case, up to 5 MB is allowed.
Image size	The image is displayed in the message with a size of the width and height specified in this field. You can set the Image size to a minimum of 400px * 400px and a maximum of 800px * 800px. The ratio is a minimum of 2:1 and a maximum of 3:4.
Ratio	If you set the Image size, select [Center Crop]. You cannot check the image ratio in the Preview pane even though you set the ratio. To check the ratio, send a test message to see how it actually looks. The ratio doesn't apply to images if you attach more than two images. [Center Crop(0)]: Select this option to align the image to the center of the specified area and display only the specified area from the center except for the rest areas. [Maintain original ratio(1)]: Shows the image in the original ratio within the 1:1 ratio area and fills the remaining space with white. [Custom(0, 1)]: Select this option to set a user argument. Pass the argument value to [Center Crop(0)] or [Maintain Original Ratio(1)] when requesting to send a message.
Live broadcast	Whether to attach the "LIVE" label to the image at the bottom right of the image. You can use this option when sharing a live broadcast as a video or image.
Play time	To attach the duration label of the shared video at the bottom right of the image, enter the duration in seconds.

Profile

Set the profile information that appears between the Image and Text areas. You can make it look as if the person or service of the profile posts the message. You can set a profile only when configuring custom messages. The default templates do not support the profile feature. If you set it to [Disable], the profile is excluded from the message.

Name	Description
Image	Register a profile image. If you upload a profile image, it is displayed with rounded corners. You can only upload a single image with a file size of 5 MB or less. If selecting [Custom], you can use a user argument and pass the image URL value when requesting to send a message.
Image size	The profile image is displayed in a small circle with a size of the width and height specified in this field. The input values only affect the image ratio. The maximum image size is 800x800 pixels.
Profile name	Enter the profile nickname as you desire. If you set the name too long, it is omitted with an ellipsis(...).

Header

This component is for the list and the feed of messages. Only one profile or header is available for the feed(item) type.

Name	Description
Header name	Set the title at the top of the message.

Image item

These components are for the Feed B type of a message.

Name	Description
Title	Enter the title of the image item, which is displayed in bold. Up to two lines are allowed.
Category	Enter the description or category of the image item, which is displayed in gray and smaller than other letters.
Image	Upload an image of the image item. You can only upload a single image with a file size of 5 MB or less. If selecting [Custom], you can use a user argument and pass the image URL value when requesting to send a message.

Text item list

These components are for the Feed B type. You can add a list of the text items and summary information.

You can add text items up to five. At least one item's Title and Description are specified, the Item list is displayed in the message. Only when you set both Title and Description of an item, the item is displayed.

You can add summary information for the items in the Item list. Only when you set both Title and Description under Summary information, the summary information is displayed.

Name	Description
Title	Enter the item name, which is displayed in gray.
Description	Enter the item description, which is displayed in black.
Summary title	Enter the text that summarizes the item list such as [Total price], which is displayed in gray and bigger than the item's Title.
Summary description	Enter the total price or amount, which is displayed in black and bigger than the item's Description.
Text alignment	Set the alignment of the descriptions of Item and Summary. You can choose one of [left], [right], [center] and [Custom].

Title/Description

The title and description are message components included in content. You can only enter up to two lines of title and two lines of description. If you enter more than two lines of title or description, the rest of the texts after the second line are cut off.

Name	Description
Title	Enter the title displayed in black and larger than the description.
Description	Enter the description displayed in gray and smaller than the title.

Social

Social is a message component included in Social. With this component, you can make a message look as if the content has received a lot of attention and response from users. Or you can also reflect the actual number of likes and comments from users using user argument.

Only up to three types of social information are displayed in this area. If you enter values for more than three items, only three items are displayed in this order with the priority: Like > Comment > Shared > View > Subscriber.

Name	Description
Like	Enter the number of user reactions displayed with a heart icon.
Comment	Enter the number of user comments displayed with a chat bubble icon.
Share	Enter the number of shares displayed with a share icon.
View	Enter the number of views displayed with an eye icon.
Subscriber	Enter the number of subscribers displayed with a person icon.

Item list

With the List component of the message, you can send a message with a list type that contains several items. You can add up to five items but must add at least one on the list. You must register at least one item on the list.

Name	Description
Title	Enter the title of each item. If you enter too long title, it may cut off.
Description	Enter the description of each item displayed in gray and smaller letters than the title. If you enter too long description, it may cut off.
Image	You can add a small image at the right side of each item. If you select [Upload image], you can upload up to 5 MB. If selecting [Custom], you can use an argument and pass the image URL value when requesting to send a message.
Image size	The input values only affect the image ratio. The maximum image size is 800x800 pixels.
Ratio	You cannot check the image ratio in the Preview pane even though you set the ratio. To check the ratio, send a test message to see how it actually looks.
Live broadcast	Whether to attach the "LIVE" label to the image at the bottom right of the image. You can use this option when sharing a live broadcast as a video or image.
Play time	To attach the duration label of the shared video at the bottom right of the image, enter the duration in seconds.
Link settings	If you select [Set individual links], you can specify a link for each item. If selecting [Use common link], the link specified in Common link settings is applied to the links of all items.
List ranking	You can use this option when you want to display each item with rankings. If you select [Y], the items in the list are displayed with rankings. You can also decide whether to use rankings by setting it as [Custom] and passing the argument as [Y(true)] or [N(false)]. From 1 to 5 are allowed for ranking numbers for each item, and numbers are assigned in the order you enter.

Product

You can set the product name and price information for a Commerce message, which is commerce in the Commerce object among message components. The items are sorted in this order: Image > Profile > Product information.

Name	Description
Product name	Enter the product name to be displayed above the price in black. Only up to two lines are displayed.
Price	Enter the original price of a product to compare it to the discounted price. It is displayed to the right of the discounted price in gray with a strikethrough.
Discount rate	Enter the discount rate to be displayed in red and smaller letters than the price at the most right side of the price information area, which shows how cheap the discounted price is compared to the original price.
Discounted Price	Enter the discounted product price displayed at the far left of the price information area.
Currency unit or symbol	Enter the currency unit (원, won, dollar), the currency code (KRW, USD), or the currency symbol (₩, $).
Currency unit position	Select the position of the currency unit or symbol. [After the price(0)]: Place currency symbol after the price. [Before the price(1)]: Place currency symbol before the price. [Custom(0, 1)]: If selecting [Custom], you can decide the currency unit position when requesting to send a message by using user arguments.

Product description

You can set the product description of the commerce message, which is description in the Commerce object among message components.

Name	Description
Product description	Enter a product description. Up to two lines are displayed below the price information.

Button

You can add one or two gray buttons to your custom message. Buttons are used to redirect users to the designated web page or app.

Name	Description
Button alignment	You can select how to align buttons when adding two buttons. If you select [Horizontal], two buttons with a half-width of one button are displayed side by side. If selecting [Vertical], two buttons with the same width as one button are displayed up and down. If selecting [Custom], you can decide the alignment method when requesting to send a message.
Button name	Enter the button name displayed on the button. If you enter too long button name, it may cut off.
Display	Decide whether to display the button only to the sender, receiver, or both.
Link settings	If you select [Set individual links], you can specify a link for each button. To see the priorities and enable conditions of links, refer to Link. If selecting [Use common link], the link specified in Common link settings is applied to the links of all buttons.

Component link settings

• Common link: Link information to be commonly applied to areas where web pages or app links can be placed.
• Component link: Link information to be applied to a specific component, can be checked and set in [Link details by component].
• Source link: Link information in the app information at the bottom of the message, editable only in custom templates registered with the message template tool, app name and icon cannot be edited.

The following items can be set for each link. Refer to Link for the priority and execution conditions.

Name	Description
Mobile Web	This link is only applied in a mobile web environment. You can set up the settings only after registering Web platform information on the Platform page. [DOMAIN], Select one among the site domains you have registered in 플랫폼. [PATH]: Enter the rest address, except for the domain.
Web	This link is only applied in a PC environment. The detailed settings are same as the [Mobile Web].
Android Scheme	Settings for a scheme to launch an app on Android platform. You can set up the settings only after registering Android platform information on the Platform page. [SCHEME]: Automatically created in kakao${NATIVE_APP_KEY}://kakaolink format. [PARAMETER]: Set to pass some values when launching an app. By referring to the passed parameters, you can implement the subsequent processing, such as checking if the user launches the app through a message or redirecting a user to a specific page. Supports User argument.
Android Market	Settings for a market URL where users can download your app on Android platform if the app is not installed on a user's device. You can set up the settings only after registering Android platform information on the Platform page.
iOS Scheme	Settings for a scheme to launch an app on iOS platform. You can set up the settings only after registering iOS platform information on the Platform page. The detailed settings are same as the [Android Market].
iOS Market	Settings for a market URL where users can download your app on iOS platform if the app is not installed on a user's device. You can set up the settings only after registering iOS platform information on the Platform page.