Guide by Message Type

Note
This guide describes General Button and Direct Link Button that can be applied to Alim Talk and Friend Talk. For details of making and inspecting, refer to Alim Talk/Friend Talk in Kakao Business.

Button Guide

While sending Alim Talk and Friend Talk, it is available to add General Button or Direct Link Button. The difference between General Button and Direct Link Button is location and feature. General Button is located in the text bubble, and Direct Link Button shows at the bottom of the text bubble.

그림General Button and Direct Link Button

General Button

If you want to add a button to Alim Talk, you must follow the guide below.

Button Type

The following is button type, up to 5 buttons can be sent.

Note
When using AL button, two of scheme_android, scheme_ios, url_mobile is required.

Input Data

The following is data to be entered in the button column.

코드예제General Button Column Data Type

ex 1)
 {"type": "BK","name": "I would like to receive it at home!"}

ex 2)
  {"type": "WL”,"name": "web link”, “url_mobile”: “www.kakao.com”, “url_pc”: “www.kakao.com” }

ex 3)
  {"type": "AL”,"name": "app link”, “scheme_android”: “scheme://open”, “scheme_ios”:
  “scheme://open” }

ex 4)
  {"type":"P2","name":"personal information","plugin_id":"5fe04466fe30e013b9d9600a"}

Direct Link Button

Direct Link Button is a function that allows the user to select and deliver text or invoke other actions, such as web/app connection, without directly entering the utterance text. Direct Link can be used up to 10 per template, and the number of buttons is limited to 2.

Direct Link Button Type

The following is Direct Link button type that can be used in Alim Talk. Up to 10 buttons can be registered and sent in one template. However, if you send with Direct Link, buttons you can use is limited to a maximum of 2.

Note
When using AL button, two of scheme_android, scheme_ios, url_mobile is required.

Input Data

The following is data to be entered in the button column.

코드예제Direct Link Button Column Data Type

ex 1)
 {"type":"WL","name": "direct link","url_mobile":"https://kakao.com"}

ex 2)
 {"type": "WL”,"name": "web link”, “url_mobile”: “www.kakao.com”, “url_pc”: “www.kakao.com” }

ex 3)
 {"type": "AL”,"name": "app link”, “scheme_android”: “scheme://open”, “scheme_ios”:
 “scheme://open” }

Warning
In the case of AlimTalk, AlimTalk will not be sent if there is content and button information that does not match the approved template.

Emphasized Title Guide

Available in the template of which the Emphasis Type is set as Text-Emphasized type.

• Enter a title in the EMPHASIZE_TITLE column of the K_MESSAGE table. The value entered in EMPHASIZE_TITLE is shown in the Title of the image below.

그림Emphasized title

Sending Text-Emphasized Type Message

코드예제Sending Text-Emphasized Type Message

INSERT INTO K_MESSAGE (
KKO_MSG,
MSG_TYPE,
MOBILE_NO,
SENDER_NO,
SEND_TYPE,
RESERVE_DATE,
KKO_TEMPLATE_CD,
KKO_TEMPLATE_TYPE,
EMPHASIZE_TITLE,
REG_DATE
) VALUES (
'[Kakao Music] Thanks to Join
Dear, welcome to Kakao Music.


▶ Membership Subscription Benefits
1 Month Free Streaming
Free Kakao Talk emoticons',

'KX',                            # For details of message type, see the Table Specification.
'99999999999',  	               # Recipient’s number needs to be changed.
'99999999999',                   # Sender’s number needs to be changed.
'S',                             # Sending Type  : S – Real time,   M –  Batch
NOW(),                           # If future time is input, the message will be sent later.
'alimtalktest_001',              # Template code
‘AT’,                            # Basic Template(Basic, Text Emphasized Type and Item List Type) - AT,   Image Template - AI
‘Input a Title to emphasize’,    #  To be emphasized from the message body
NOW ()
);

Image Alim Talk Guide

Image Alim Talk is an information-only message. Therefore, advertising messages cannot be sent, and advertisement content cannot be included in images. Only one fixed image per template can be used. And you must follow the image creation guide.

• It cannot be used at the same time as the Text-emphasized type. and it is exposed only in KakaoTalk version 8.7.5 (both Android and iOS) or higher.

Warning
Images that can be included in Alim Talk are limited to images representing the sender or the sender’s Talk channel profile or images expressing the purpose of the message. Content that is not relevant to the main message or that must be conveyed cannot be included.

Common Guide

Only one static image can be used per template. Link cannot be linked when clicking an image.

Logo image

A type that can increase the attention of the message and strengthen branding by using the horizontal logo of the channel.

그림Logo image

Text-blended Image

A type that expresses the main content in text and uses an icon or object image to support the content.

그림Text-blended image

Icon image

A type that expresses the status of the message content(such as Shipping, Delivered) as an icon and supports it with a brief text.

그림Icon image

Sending Image Alim Talk

코드예제Sending Image Alim Talk

INSERT INTO K_MESSAGE (
KKO_MSG,
MSG_TYPE,
MOBILE_NO,
SENDER_NO,
SEND_TYPE,
RESERVE_DATE,
KKO_TEMPLATE_CD,
KKO_TEMPLATE_TYPE,
REG_DATE
) VALUES (
'[Kakao Music] Thanks to Join
Dear, welcome to Kakao Music.

▶ Membership Subscription Benefits
1 Month Free Streaming
Free Kakao Talk emoticons',
'KX',                          # For details of message type, see the Table Specification.
'99999999999',                 # Recipient’s number needs to be changed.
'99999999999',                 # Sender’s number needs to be changed.
'S',                           # Sending Type  : S - Real time,   M –  Batch
NOW(),                         # If future time is input, the message will be sent later.
'alimtalktest_001',            # Template code
‘AI’,                          # Basic Template((Basic, Text-emphasized Type and Item List Type)) - AT,   Image Template - AI
NOW ()
);

Item List Guide

Item List is used to send an information message whose message is structured.

Item List is used to send an information message which must be delivered to the recipient. Therefore, advertising messages cannot be sent, and advertisement content cannot be included both in images and structured body message. Images that can be included in the Item List are limited to images representing the sender or the sender’s Talk channel profile or images expressing the purpose of the message. Images cannot contain content that is not relevant to the main text or that must be conveyed.

Only one fixed image per template can be used, and the image creation guide must be followed.

Note

• Item List cannot be used with the Text-emphasized type at the same time, and it is only exposed in KakaoTalk version 9.3.5 (Android, iOS common) or higher.
• It cannot be set as a security template.

List of items

Header

• Up to 16 characters can be entered.
• Possible to input variables.

How to enter the text and description for Item Highlight Type

Thumbnail image of Item List Highlight type

AlimTalk text or an image associated with an item highlight area (ex. icon, item image)

• Images that can be used for AlimTalk Item List Highlight Thumbnails follow the existing image guide

Image of Item List type

그림List of item

Sending Item List

코드예제Sending item list

INSERT INTO K_MESSAGE (
KKO_MSG,
MSG_TYPE,
MOBILE_NO,
SENDER_NO,
SEND_TYPE,
RESERVE_DATE,
KKO_TEMPLATE_CD,
KKO_TEMPLATE_TYPE,
HEADER,
ITEM_HIGHLIGHT,
ITEM,
REG_DATE
) VALUES (
'[Kakao Music] Thanks to Join
Dear, welcome to Kakao Music.

▶ Membership Subscription Benefits
1 Month Free Streaming
Free Kakao Talk emoticons',
'KX',                                 # For details of message type, see the Table Specification.
'99999999999',  	                    # Recipient’s number needs to be changed.
'99999999999',                        # Sender’s number needs to be changed.
'S',                                  # Sending Type  : S - Real time,   M –  Batch
NOW(),                                # If future time is input, the message will be sent later.
'alimtalktest_001',                   # Template code
‘AT’,                                 # Basic Template((Basic, Text-emphasized Type and Item List Type)) - AT,   Image Template - AI
'The header of Item List.',
'{"title": "Highlight", "description": "Description"}',
'{"list": [{"title": "Item List", "description": " Item List 1"},{"title": " Item List", "description": " Item List 2"}], "summary": {"title": "Summary", "description": "4,500 Won"}}',
NOW ()
);

Specifications by message type

The following is detailed specifications for each Bizmessage type.

Alim Talk

Friend Talk

XMS

The following is detailed specification for each XMS type.

RCS

In order to send RCS service, a brand must be signed up for the RCS Biz Center and tasks such as opening a brand, registering a template shoud be done in advance. For detail of using RCS Biz Center, refer to RCS Biz Center Service Guide.

RCS Service Type

RCS type can be selected by needed service.

RCS Templates Detail

The following is detailed specification for each RCS template.

RCS Button

Various services can be linked through the button action at the bottom of the RCS message. To Check sample Code of Action button, refer to Action Button.

Action Button

"suggestions": [
{
 "action":{
   "urlAction": {
      "openUrl": {
           "url": "https://www.google.com"
       }
   },
   "text": "Open Url",
   "postback": {
         "data": "set_by_open_url"
   }
 }
}
]

"suggestions": [
{
   "action": {
       "mapAction": {
           "showLocation": {
                "location": {
                       "latitude": 37.4220041,
                       "longitude": -122.0852515,
                       "label": "google"
                },
                "fallbackUrl": "https://www.google.com/maps/@37.4219162,-122.079063,15z"
           }
       },
      "text": "show location on a map",
      "postback": {
         "data": "set_by_open_location"
      }
   }
}
]

"suggestions": [
{
     "action": {
            "calendarAction":{
                     "createCalendarEventAction" : {
                              "startTime" : "2022-05-01T01:00:00Z",
                              "endTime" : "2022-05-09T09:00:00Z",
                              "title" : "calendar event",
                              "description" : "review meeting"
                     }
            },
           "text": "Invitation",
           "postback": {
               "data": "set_by_calendar_event"
           }
     }
}
]

"suggestions": [
{
     "action": {
            "clipboardAction":{
                     "copyToClipboard" : {
                           "text" : "COUPONE NUMBER : 12222-3333-4444"
                     }
            },
           "text": "clipboard",
           "postback": {
               "data": "set_by_clipboard"
           }
     }
}
]

"suggestions": [
{
     "action": {
            "dialerAction":{
                     "phoneNumber" : "+15556667777"
            },
           "text": "Call",
           "postback": {
               "data": "set_by_call"
           }
     }
}
]

List of Common RCS Templates