본문으로 건너뛰기

달력 템플릿으로 메세지 공유하기

달력 템플릿

공식 문서

톡캘린더의 공개 일정 또는 구독 캘린더 정보를 포함한 메시지 형식입니다. 카카오톡 채널의 공개 일정 또는 구독 캘린더를 사용자의 톡캘린더에 추가하는 기능을 제공합니다. 서비스 앱과 연결된 카카오톡 채널의 공개 일정이나 구독 캘린더에 대한 메시지만 전송 가능합니다.

활용 예시: 카카오톡 메시지를 통해 사용자가 서비스의 공개 일정을 사용자 캘린더에 추가하거나, 서비스의 구독 캘린더를 구독하도록 권유하는 용도로 사용합니다.

템플릿 타입 정의

/**
* 톡캘린더의 구독 캘린더 또는 공개 일정 정보를 포함한 메시지 형식입니다.
* 카카오톡 채널의 구독 캘린더 또는 공개 일정을 사용자의 톡캘린더에 추가하는 기능을 제공합니다.
*
* @property id 구독 캘린더 또는 공개 일정 ID
* @property idType id의 타입, event(공개 일정) 또는 calendar(구독 캘린더) 중 하나
* @property content 일정에 대해 설명하는 컨텐츠 정보
* @property buttons 버튼 목록. 기본 버튼의 타이틀 외에 링크도 변경하고 싶을 때 설정. (최대 1개, 오른쪽 위치 보기 버튼은 고정)
*/
export interface KakaoCalendarTemplate {
id: string;
idType: 'event' | 'calendar';
content: KakaoTemplateContent;
buttons?: KakaoTemplateButton[];
}

Usage

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

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

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

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