사이드 메뉴
커뮤니케이션
API 제공
어드민 API
톡캘린더
이해하기
이 문서는 카카오 또는 공동체 서비스용 톡캘린더 API를 소개합니다. 공통 설명은 오픈 문서를 참고합니다.
톡캘린더 API는 캘린더, 일정, 할 일을 등록하고 관리하는 기능을 제공합니다. 자세한 기능 소개와 사용 안내는 이해하기에서 확인할 수 있습니다.
톡캘린더 API의 일부 기능은 사용 권한이 필요합니다. 사용 방법을 참고합니다.
카카오 또는 공동체 서비스는 톡캘린더 API 추가 권한을 사용할 수 있습니다. 제품별 기본 권한과 추가 권한의 차이점은 아래 표에서 확인할 수 있습니다.
| 구분 | 설명 |
|---|---|
| 기본 권한 |
앱 타입 별 권한 제공: 인하우스 앱에는 기본 제공, 공동체 앱은 별도 신청 필요 동의항목: 톡캘린더 및 일정 생성, 조회, 편집/삭제( talk_calendar) |
| 추가 권한 |
앱 타입 별 권한 제공: 인하우스 앱과 공동체 앱 모두 별도 신청 필요 동의항목: 톡캘린더 및 일정 생성, 조회, 편집/삭제( talk_calendar_advanced) |
| 구분 | 설명 |
|---|---|
| 기본 권한 |
앱 타입 별 권한 제공: 인하우스 앱에는 기본 제공, 공동체 앱은 별도 신청 필요 동의항목: 톡캘린더 내 할 일 생성, 조회, 편집/삭제( talk_calendar_task) |
| 추가 권한 |
앱 타입 별 권한 제공: 인하우스 앱과 공동체 앱 모두 별도 신청 필요 동의항목: 톡캘린더 내 할 일 생성, 조회, 편집/삭제( talk_calendar_task_advanced) |
추가 권한 획득 시 동의항목 설정 변경 필요
추가 권한 획득 시, 반드시 추가 권한용 동의항목(talk_calendar_advanced, talk_calendar_task_advanced)을 사용하도록 앱의 동의항목 설정을 변경해야 합니다.
사용자의 앱 연결 상태에 따른 호출 제한, SDK 지원 여부, 권한 요구 사항은 지원 범위를 참고합니다.
| API | 설명 | 문서 | ||
|---|---|---|---|---|
| 사용자 캘린더 | 목록 조회 | 사용자의 캘린더 목록을 가져옵니다. | REST API | |
| 서브 캘린더 생성 | 사용자의 캘린더에 새로운 서브 캘린더를 생성합니다. | REST API | ||
| 서브 캘린더 수정 | 사용자의 특정 캘린더 설정을 수정합니다. | REST API | ||
| 서브 캘린더 삭제 | 사용자의 특정 캘린더를 삭제합니다. | REST API | ||
| 일반 일정 | 생성 | 사용자의 특정 캘린더에 일반 일정을 생성합니다. | REST API | |
| 목록 조회 | 사용자의 특정 캘린더에 등록된 일정 목록을 가져옵니다. | REST API | ||
| 상세 조회 | 사용자의 일반 일정 정보를 조회합니다. | REST API | ||
| 수정 | 사용자의 일반 일정 정보를 수정합니다. | REST API | ||
| 삭제 | 사용자의 일반 일정을 삭제합니다. | REST API | ||
| 공개 일정 | 생성 | 카카오톡 채널의 공개 일정을 생성합니다. | REST API | |
| 목록 조회 | 카카오톡 채널의 등록된 공개 일정 목록을 가져옵니다. | REST API | ||
| 상세 조회 | 카카오톡 채널의 공개 일정 정보를 조회합니다. | REST API | ||
| 수정 | 카카오톡 채널의 공개 일정 정보를 수정합니다. | REST API | ||
| 삭제 | 카카오톡 채널의 공개 일정을 삭제합니다. | REST API | ||
| 사용자 캘린더에 추가 | 공개 일정을 사용자의 톡캘린더에 추가합니다. | REST API | ||
| 구독 캘린더 | 구독 가능 캘린더 목록 조회 | 특정 카카오톡 채널의 구독 가능 캘린더 목록을 가져옵니다. | REST API | |
| 구독 | 구독 가능 캘린더를 사용자 캘린더에 추가해 구독하도록 설정합니다. | REST API | ||
| 구독 해제 | 사용자가 구독 중인 캘린더를 사용자 캘린더에서 삭제해 구독 해제합니다. | REST API | ||
| 게스트 일정 | 수정 | 사용자의 특정 캘린더에 추가한 일정을 수정합니다. | REST API | |
| 공휴일 및 주요 기념일 조회 | 법정공휴일과 톡캘린더 서비스에서 지정한 일부 기념일 목록을 조회합니다. | REST API | ||
| 할 일 | 생성 | 할 일을 생성합니다. | REST API | |
| 조회 | 할 일 정보를 조회합니다. | REST API | ||
| 도전 기록 조회 | 특정 반복 할 일의 도전 기록을 확인합니다. | REST API | ||
| 수정 | 특정 할 일의 정보를 수정합니다. | REST API | ||
| 완료 여부 설정 | 특정 할 일의 완료 여부를 설정합니다. | REST API | ||
| 삭제 | 할 일을 삭제합니다. | REST API | ||
| 완료 항목 일괄 삭제 | 완료 상태의 할 일을 일괄 삭제합니다. | REST API | ||