21. KakaoTalk Invitation(3.12.0 or higher)
Here is a guide on how to link the Kakao Talk friend invitation function in the game.
What is KakaoTalk friend invitation?
KakaoTalk Friend Invite is a KakaoTalk friend, but users who have not signed up for the game can send an invitation message to encourage them to join.
When you invite a friend, you can pay the inviter a reward.
By linking the SDK API, you can send an invitation message after viewing the friend list, and payment of invitation rewards can be implemented in the game.
When an invited user joins the game, rewards can be paid to the inviter and subscriber.
By linking SDK API and setting event registration/reward in the platform admin, you can pay invitations and subscribers for subscription rewards.
Kakao Talk Friends List
To send a KakaoTalk message to a user's KakaoTalk friend, you need to load the friend list.
The API to get the friends who joined the game and the API to get the friends who are not signed up are separate. Please use it according to your intended use.
The friends list comes down sorted by nickname.
The friend list is meant to be cached on the server.
Please note that the cache expiration time of the server is 10 minutes, but it may change according to the API policy.
For a list of friends who have not joined the game, please refer to "21.1.2. Search for a list of recommended friends that can be invited to KakaoTalk".
View the list of friends who have not joined the game
Policy change
When logging in to Kakao, the profile image and nickname (original text) information of unregistered KakaoTalk friends that were provided to a third party will no longer be downloaded. (Personal information issue)
From now on, only masked nickname and UUID (unsubscribed identification value) information can be downloaded.
The list of friends who have not joined the game cannot be exposed according to the game UI, and must be displayed in the game using the <Friend Picker> UI provided by the SDK API.
Friend Picker API
The friend picker UI is an API provided by Kakao, and the nickname is exposed in the original text on the user screen. When calling the API, the response value is provided as a ‘masked nickname’.
When calling the API, you can select from the 4 options below to link
Full screen form & Single Picker
Full screen form & Multi Picker
Popup screen & Single Picker
Popup screen & Multi Picker
Example) How to expose unjoined friends list in game (Friend Picker API call)
Kakao Talk Invitation Message
KakaoTalk invitation messages can only be sent to KakaoTalk invitees.
To send a message, you must register a message template in the [Kakao Developer Site - Message Template V2] menu.
Guide: 20. KakaoTalk Message Template V2
Each message template must be created according to its purpose.
You can add tags to your templates and dynamically send phrases with substitutions on the client. Please be careful!!!
If you include the sender's nickname, you must send it as the nickname in the user's KakaoTalk profile so that it will be sent as the latest KakaoTalk nickname.
Provides functions related to KakaoTalk message sending policy in game SDK
When an invited user joins the game, rewards are paid to the inviter and subscriber
This function can be performed after prior consultation with the Kakao Games business PM has been completed..
After the inviter sends an invitation message to a KakaoTalk friend who has not joined the game, the recipient can pay the inviter and the subscriber when the user joins the game.
It works only when it is set in advance as follows.
Register an event in the [3.0 Platform Admin - Promotion - Invite KakaoTalk Friends] menu. Only one invitation event must be active and used within the same period. Be careful not to register more than one event at the same time.
In the event registration stage, you can define and pay different rewards to invitees and subscribers.
Register an invitation message template in the [Kakao Developer Site - Message Template V2] menu.
Invitation Sign-up Conditions
When an invited user joins the game for the first time during the invitation event period, it is recognized as an invitation.
Exceptions are made for re-joining after leaving the event during the event period.
Subscription Compensation Payment Policy
Invitee: After sending the invitation message, the reward will be paid when the recipient joins the game for the first time within 24 hours.
From the date of registration, within 24 hours
Example) If an invited user signs up at 01.00 on December 3, the reward is paid to the user who sent the invitation message between December 2, 01:00 and December 3, 01:00.
What if the subscriber signed up after receiving an invitation message from N friends? Rewards will be given to the N invited friends.
Subscribers: Rewards are paid immediately upon subscription.
Example