본문으로 건너뛰기

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

달력 템플릿​

공식 문서

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

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

템플릿 타입 정의​

/**
* 톡캘린더의 구독 캘린더 또는 공개 일정 정보를 포함한 메시지 형식입니다.
* 카카오톡 채널의 구독 캘린더 또는 공개 일정을 사용자의 톡캘린더에 추가하는 기능을 제공합니다.
*
* @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[];
}

사용법​

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

export function shareCalendarTemplate(params: {
template: KakaoCalendarTemplate;
useWebBrowserIfKakaoTalkNotAvailable?: boolean;
serverCallbackArgs?: Record<string, string>;
pickerSettings?: KakaoSharePickerSettings;
})
  • template: 템플릿 객체입니다.

  • useWebBrowserIfKakaoTalkNotAvailable: 카카오톡을 사용할 수 없을 때 웹 브라우저로 공유할지 여부입니다. 기본값은 true입니다.

  • serverCallbackArgs: 서버 콜백 인자입니다. 모든 값은 문자열로 전달해야 합니다.

  • pickerSettings: 공유 대상 선택 화면 설정입니다.

정보

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

사용 중 문제가 생기면 문제 해결을 참고하세요.