21. KakaoTalk Invitation (3.12.0 under)

Who are KakaoTalk invitation targets?

• Invitation targets are KakaoTalk friends who have never been authenticated for the game app. 

• The Kakao profile data of the KakaoTalk invitation targets among KakaoTalk friends can be queried.

• When inviting a friend, you can make a payment to the inviter.

  • You can send an invitation message by linking the SDK API to your friend list, and invite payment can be implemented in the game.

• When an invited user signs up for a new game, he or she can be rewarded.

  • You can pay the invitation and subscribers compensation for the subscription by setting up SDK API interlocking and event registration / compensation from Platform Admin.
    
    

• Example

  Open

  

KakaoTalk Friends list

• To send a KakaoTalk message to a user's KakaoTalk friend, you need to bring up a friend list.

  • There are separate APIs for getting friends who have joined the game and for getting non-friends. Please use it according to the purpose.

  • Friends list is sorted by nickname.

• Friends lists are cached on the server.

  • Please note that the server's cache expiration time is 10 minutes, but it may change depending on the API policy.

• Please refer to "21.1.2. Finding KakaoTalk recommended invitation target list" document for friend list based on recommended invitation.

KakaoTalk Invitation Message

• 카카오톡 초대 메시지는 카카오톡 초대 대상자에게만 전송이 가능합니다.

• KakaoTalk invitation messages can be sent only to KakaoTalk invitation targets.

• Messages can be sent only if a message template has been registered in Kakao Developer's Admin.

• [Kakao Developer's Admin - Message Template V2] 

  • Guide : https://kakaogames.atlassian.net/wiki/spaces/KS3GFC/pages/414253141

  • A message template must be generated for each purpose.

  • The statement in the template can be dynamically updated using tags and through substitution in the client.

  • Caution!!! If including the sender’s nickname, use the nickname in the user’s KakaoTalk profile so the invitation is sent with the latest KakaoTalk nickname.

Precautions when Implementing KakaoTalk Invitation Message Sending

• Refer to the receiver’s talkOs (OS data of the device registered in KakaoTalk) value when sending a message.

  • talkOs has a character string value of “android” or “ios.”

  • Make sure that the function is implemented so that an invitation message is not sent if an invitation target uses an OS that is not supported by the game.

  • Use the exact friend data obtained from the list when sending an invitation message.

• It is recommended the OS data currently supported is saved in the server.

  • Save the currently supported OS data in the server and implement so the values are compared.

  • If the values are stored in the client, the client of the previous OS version must be updated when a game for a later OS version is introduced for the invitation message to be sent successfully.

  • For example, if an AOS version game is also released for iOS, “ios” must be added as a supported OS in the AOS version client for the message to be sent successfully. Therefore, the AOS version client may also need to be upgraded.

• Do not process with ErrorCode.

  • If the returned ErrorCode is processed after an invitation is sent instead of referring to talkOs, the message may be sent to users of OS versions that are not officially available if there is a difference in launch date between OSs.

• You can send an invitation only once a month per one person.

  • If you send an invitation message and send the invitation message again within a month, an error is returned.

  • Since the friend does not have a playerId before running the game, it can be managed by using KGKakaoProfile.getUUID().

    • The 'serviceUserId' has been deprecated. Do not use it in new games because there are some users who do not have this values.

When an invited user joins a game, he or she is rewarded

• This function can be performed after the pre-consultation with the Kakaogames Business PM.

• After the invitee sends an invitation message to an unattended Kakao Talk friend, the recipient can reward the invitee and the subscriber when the user subscribes to the game.

• It must be set in advance as follows.

  1. [3.0 Platform Admin - Promotion - KakaoTalk Invite Friends] menu to register events.

  2. At the event registration stage, you can pay for each different payment to the invitee and subscriber.

  3. Register the invitation message template from the [Cacao Developer Site - Message Template V2] menu.

• Invitation success conditions
  
  

  • During the invitation event, when an invited user first signs in to the game, he or she is considered an invite.

  • After unregister from the event period, re-join will be excluded from the reward.

• Subscription Compensation Payment Policy

  • inviter : After the inviter sends the invitation message, the user who received the message within 24 hours will be rewarded for the first time the user joins the game.
    
    

    • User who received invitation message should join within 24 hours

      • Ex) If the invited user joined at 01:00 on December 3, compensation is paid to the user who sent the invitation message between 01:00 on December 2 and 01:00 on December 3

    • What if a subscriber received an invitation message to N friends and then signed up? Reward will be paid to N friends invited.

  • Subscribers : Compensation will be paid immediately upon subscription.

• Example

  Open