본문으로 건너뛰기

위치 템플릿으로 메세지 공유하기

위치 템플릿

공식 문서

위치 정보를 포함한 메시지 형식입니다. 보내는 사람이 주소 정보를 담아 메시지를 보내면, 받는 사람이 메시지에 포함된 위치 정보 버튼을 눌러서 카카오맵을 통해 자세한 장소 정보를 확인할 수 있습니다.

활용 예시: 위치 정보와 함께 새로운 상점의 오픈 소식이나 메뉴를 소개할 때 유용합니다.

템플릿 타입 정의

/**
* 주소를 이용하여 특정 위치를 공유할 수 있는 메시지 템플릿.
*
* @property address 공유할 위치의 주소. 예) 경기 성남시 분당구 판교역로 235
* @property addressTitle 카카오톡 내의 지도 뷰에서 사용되는 타이틀. 예) 카카오판교오피스
* @property content 위치에 대해 설명하는 컨텐츠 정보
* @property social 댓글수, 좋아요수 등, 컨텐츠에 대한 소셜 정보
* @property buttons 버튼 목록. 기본 버튼의 타이틀 외에 링크도 변경하고 싶을 때 설정. (최대 1개, 오른쪽 위치 보기 버튼은 고정)
* @property buttonTitle 기본 버튼 타이틀(자세히 보기)을 변경하고 싶을 때 설정. 이 값을 사용하면 클릭 시 이동할 링크는 content에 입력된 값이 사용됨.
*/
export interface KakaoLocationTemplate {
address: string;
content: KakaoTemplateContent;
addressTitle?: string;
social?: KakaoTemplateSocial;
buttons?: KakaoTemplateButton[];
buttonTitle?: string;
}

Usage

shareLocationTemplate 로 템플릿 메세지를 공유할 수 있습니다.

export function shareLocationTemplate(params: {
template: KakaoLocationTemplate;
useWebBrowserIfKakaoTalkNotAvailable?: boolean;
serverCallbackArgs?: Record<string, string>;
})
  • template: 템플릿 객체입니다.
  • useWebBrowserIfKakaoTalkNotAvailable: 카카오톡이 사용 가능하지 않을 때 웹 브라우저를 이용해 공유를 할 것인지 여부입니다. 기본값은 true입니다.
  • serverCallbackArgs: 서버 콜백 인자들입니다. 모두 문자열만 값으로 전달되어야 합니다.
정보

자세한 컴포넌트들의 타입은 컴포넌트 타입들을 참고해주세요.

사용에 문제가 생긴다면 Troubleshooting을 참고해주세요