본문으로 건너뛰기

달력 템플릿으로 메시지 전송하기

달력 템플릿​

공식 문서

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

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

템플릿 타입 정의​

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

나에게 메시지 전송하기​

sendCalendarTemplateToMe로 템플릿 메시지를 나에게 전송할 수 있습니다.

export function sendCalendarTemplateToMe(params: {
  template: KakaoCalendarTemplate;
})
  • template: 템플릿 객체입니다.

친구들에게 메시지 전송하기​

sendCalendarTemplateToFriends로 템플릿 메시지를 친구들에게 전송할 수 있습니다.

export function sendCalendarTemplateToFriends(params: {
  template: KakaoCalendarTemplate;
  receiverUuids: string[];
  includeFailureInfo?: boolean;
})

includeFailureInfo: true를 전달하면 성공 UUID와 오류별 실패 수신자를 함께 반환합니다. 옵션을 생략하면 성공 UUID 배열을 반환합니다. 발송 결과를 참고하세요.

정보

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

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