21. 카카오톡 친구 초대 (3.12.0 이상)
게임에서 카카오톡 친구 초대 기능을 연동하는 방법을 안내합니다.
카카오톡 친구 초대란?
카카오톡 친구인데, 해당 게임에 미가입한 유저에서 초대 메시지를 발송하여 가입을 유도할 수 있습니다.
친구 초대 시, 초대자에게 보상을 지급할 수 있습니다.
SDK API를 연동하여 친구목록 조회 후 초대메시지 발송할 수 있고, 초대 보상 지급은 게임에서 구현할 수 있습니다.
초대 받은 유저가 게임에 신규 가입하면, 초대자와 가입자에게 보상을 지급할 수 있습니다.
SDK API 연동 및 플랫폼 어드민에서 이벤트 등록/보상 설정하여, 가입에 대한 보상을 초대자와 가입자에게 지급할 수 있습니다.
카카오톡 친구초대 이벤트 생성은 <21.3 어드민 - 카카오톡 친구 초대 > 가이드를 참고해 주세요.
카카오톡 친구 목록
사용자의 카카오톡 친구에게 카카오톡 메시지를 전송하기 위해서는 친구 목록을 불러와야 합니다.
게임에 가입한 친구를 가져오는 API와 미가입 친구를 가져오는 API가 분리되어 있습니다. 용도에 맞게 사용해주세요.
친구 목록은 닉네임 순으로 정렬되어 내려옵니다.
친구 목록은 서버에서 캐싱하도록 되어 있습니다.
서버의 캐시 만료 시간은 10분이나, API 정책에 따라 바뀔 수 있음을 양해 부탁드립니다.
게임에 미가입 친구 목록 조회는 "21.1.2. 카카오톡 초대 가능한 친구 목록 조회하기" 문서를 참고하시기 바랍니다.
게임에 미가입한 친구목록 조회
정책 변경
카카오 로그인 시, 제3자에게 제공했던 미가입한 카톡친구의 프로필 이미지, 닉네임(원문) 정보를 더이상 내려주지 않습니다. (개인정보 이슈)
앞으로는 마스킹 처리된 닉네임, UUID (미가입자 식별값) 정보만 내려받을 수 있습니다.
게임에 미가입한 친구목록은 게임 UI에 맞게 노출이 불가하며, SDK API로 제공되는 <친구 피커> UI로 게임에서 띄워야 합니다.
친구 초대 시 카카오톡 친구 중 본인을 포함하여 초대 불가한 것으로 정책이 변경되었습니다. (2022.12.22 3.14.14 릴리즈, 패치노트)
친구 피커 API
친구 피커 UI는 카카오에서 제공하는 API로, 유저 화면에서는 닉네임이 원문 그대로 노출됩니다. API 호출 시, 응답값이 ‘마스킹 처리된 닉네임’으로 제공되는 방식입니다.
API 호출 시, 아래 4가지 옵션 중에서 선택하여 연동 가능
풀 스크린 형태 & 싱글 피커
풀 스크린 형태 & 멀티 피커
팝업 형태 & 싱글 피커
팝업 형태 & 멀티 피커
세로형 | 가로형 |
|---|---|
|  |
예시) 게임에서 미가입한 친구목록 노출 방식 (친구 피커 API 호출)
카카오톡 초대 메시지
카카오톡 초대 메시지는 카카오톡 초대 대상자에게만 전송이 가능합니다.
[카카오 개발자 사이트 - 메시지 템플릿 V2] 메뉴에서 메시지 템플릿을 등록해야 메시지를 보낼 수 있습니다.
가이드 : https://kakaogames.atlassian.net/wiki/spaces/KS3GFC/pages/413468185
메시지 템플릿은 용도에 따라 각각 생성하셔야 합니다.
템플릿에 태그를 넣고, 클라이언트에서 치환해서 문구를 동적으로 보낼 수 있습니다. 주의해 주세요!!!
발신자의 닉네임을 포함할 경우, 반드시 유저의 카카오톡 프로필의 닉네임으로 전송해주셔야 최신의 카카오톡 닉네임으로 전송됩니다.
게임 SDK에서 카톡 메시지 발송 정책 관련 기능 제공
초대 받은 유저가 게임에 신규 가입 시, 초대자와 가입자에게 보상 지급
해당 기능은 카카오게임즈 사업PM과 사전 협의 완료 후, 진행 가능합니다.
초대자가 게임에 미가입한 카카오톡 친구에게 초대메시지를 발송한 후, 수신자가 유저가 게임에 가입하면 초대자와 가입자에게 보상을 지급할 수 있습니다.
다음과 같이 사전에 설정되어야 동작합니다.
[3.0 플랫폼 어드민 - 프로모션 - 카카오톡 친구초대] 메뉴에서 이벤트를 등록합니다. 같은 기간 내에는 하나의 초대 이벤트만 활성화하여 사용해야 합니다. 동일한 기간에 2개 이상의 이벤트가 등록되지 않도록 주의합니다.
이벤트 등록 단계에서 초대자와 가입자에게 각각 지급하는 보상을 다르게 정의하여 지급할 수 있습니다.
[카카오 개발자 사이트 - 메시지 템플릿 V2] 메뉴에서 초대메시지 템플릿을 등록합니다.
초대 가입 조건
초대 이벤트 기간동안 초대받은 유저가 해당 게임에 최초로 가입 시, 초대 가입으로 인정됩니다.
이벤트 기간에 탈퇴 후 재가입한 경우는 제외됩니다.
가입보상 지급 정책
초대자 : 초대메시지를 발송한 후, 24시간 이내에 수신자가 게임에 최초 가입 시 보상이 지급됩니다.
가입일 기준, 24시간 이내
예) 초대받은 유저가 12월 3일 01시에 가입했다면, 12월 2일 01시 ~ 12월 3일 01시 사이에 초대메시지를 보낸 유저에게 보상이 지급됨
가입자가 N명의 친구들에게 초대메시지를 수신한 후 가입을 했다면? 초대한 N명의 친구들에게 보상이 지급됩니다.
가입자 : 가입 즉시 보상이 지급됩니다.
예시