This document introduces the Kakao Talk Message API.
The Kakao Talk Message API only supports sending messages between users within the same service, and the Kakao Talk Social API permission is required to provide the message sending feature to friends. For more details, see Message sending features and Request permission.
This section introduces various Kakao Talk message sending features provided by Kakao. The differences between products can be found in the table below.
Product | Description | Service → User message sending |
Available platform |
---|---|---|---|
Kakao Talk Share | Users select content in the service and share it to Kakao Talk chatrooms themselves. Recommended use: Implementing content sharing features between users. |
Not supported. | Kakao Developers |
Kakao Talk Message | Users send messages to their Kakao Talk friends who use the same service, for interaction purposes. Recommended use: Implementing message sending for user interactions. |
Not supported. | Kakao Developers |
Ad Talk | The service sends promotional or informational messages to users who have added the service's Kakao Talk Channel. Recommended use: Sending promotional or informational messages to users. |
Conditionally supported. (Only for users who added the channel) |
Kakao Business |
Info Talk | The service sends informational messages to users. Recommended use: Sending informational messages to users. |
Supported. | Kakao Business |
CS Talk | Users can open a Kakao Talk chatroom to make inquiries about the service. Recommended use: Implementing customer support using real-time chat or chatbot. |
Conditionally supported. (After a user initiates a consultation) |
Kakao Business |
Select the product that fits your service needs based on the guide below.
For details on Ad Talk, Info Talk, and CS Talk, see the Kakao Business document.
This section explains the differences between Kakao Talk Share and Kakao Talk Message, both of which are Kakao Talk Message sending features provided by Kakao Developers. Both features only support user-to-user messaging, and services cannot send messages directly to users.
Refer to the table below to check the feature differences and choose the product that best suits your service requirements.
Item | Kakao Talk Share | Kakao Talk Message |
---|---|---|
Message recipients | All Kakao Talk friends of the user | Friends who meet the information provision conditions of the Retrieve friends list API. |
Recipient selection UI | No separate implementation required. | Requires calling the Friend picker API or implementing a UI using the Retrieve friends list API. |
Message sending method | When the user selects recipients in the Kakao Talk app, the sharing message is automatically sent. | After providing a recipient selection UI, the Kakao Talk Message API must be called with the selected recipients. |
Permission required | X | O |
REST API supported | X | O |
Confirmation of message delivery success | Confirm via the Kakao Talk Share webhook. | Confirm via API response. |
Kakao Talk Message is a feature that allows users to send messages to their Kakao Talk friends who use the same service for the purpose of interaction. This feature provides an environment where users can interact by sending messages to each other, or enables personalized services by allowing users to send messages to themselves.
For the types and characteristics of various message sending features provided by Kakao, see Message sending features. For the differences between the message sending features provided by Kakao Developers, see Differences between Kakao Talk Share and Kakao Talk Message features.
This section explains how a user sends a Kakao Talk Message from a service. Refer to the sequence diagram and step-by-step explanation below.
To send a message to a friend using the Kakao Talk Message API, the app requires permission. Apps without permission or test apps can only be used by the app's team members, and the response scope is also limited to those members. After acquiring the permission, the feature can be provided to all users in the actual service.
You can apply for the permission through the process below.
talk_message
)] consent item.To send a message to a friend using the Kakao Talk Message API, you must receive the user's Kakao Talk friend information through the Kakao Talk Social API. The Kakao Talk Social API also requires permission to be used by users other than team members, and you can apply for permission for both features together.
Kakao API applies monthly and daily quotas for stable service. You can check the currently applied quota information in the Quota.
The Kakao Talk Message API has a limited quota before you get the permission via Request permission, and the quota limit cannot be increased to protect users from frequent messages.
Ensure that a Kakao Talk message sent through the Kakao Talk Message API can be delivered only to the users who allow showing their profile on the Friends list of a service.
Users can change the profile visibility option by selecting [Preferences] at the bottom right of the message sent from the user's friends or on [Manage connected services] page. To see more details, refer to Profile visibility settings.
If a user wants to block messages from a service, the user needs to disable the 'Show my profile on Friends list' option. Then, the user is not included in the response of the Retrieving list of friends API, and the user's friends cannot send any messages from the service because the user is not displayed on the Friends list.
If access to the service server is restricted Kakao's server by the firewall or ACL (Access Control List), Kakao Talk Share message may not display the image or works slowly.
In this case, you must set the firewall rules or ACL to scrape your web page for Kakao Talk Share. Refer to Retrieve Kakao IP list.
Feature | Description | Documentation |
---|---|---|
Send message with default template | Sends a message with a default template in JSON format. | REST API JavaScript Android iOS Flutter |
Send message with custom template | Sends a message with a custom template that configured in [Tools] > [Message Template Builder]. | REST API JavaScript Android iOS Flutter |
Send scrape message with default template | Scrape a specific web page and sends a message with a default template in JSON format. | REST API JavaScript Android iOS Flutter |
Send scrape message with custom template | Scrape a specific web page and sends a message with a custom template that configured in [Tools] > [Message Template Builder]. | REST API JavaScript Android iOS Flutter |