본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Talk Calendar
  • Concepts

사이드 메뉴

Kakao Map

Search

Talk Calendar

Concepts

This document introduces the features of the Talk Calendar APIs.

Overview

Talk Calendar is a service that allows you to quickly create schedules in Kakao Talk chat rooms and easily manage daily tasks by registering to-dos. By using the Talk Calendar API, your service can provide features to add and manage users’ calendars, schedules, and to-dos. Kakao Talk Channel managers can share schedules that include the Marketing area to further increase advertising effectiveness.

Calendar Introduction

How to use

The Talk Calendar API can only be used by apps with the permission granted. For apps without permission or Test apps, only the app members can make calls, and the response range is restricted to those team members.

Refer to the steps below to request permission.

  1. Configure the required consent items for each feature.

    • Calendar, events: [Create, retrieve, update/delete Talk Calendar and events (talk_calendar)].
    • Tasks: [Create, retrieve, update/delete tasks in Talk Calendar (talk_calendar_task)].
  2. Implement features using the Talk Calendar API.

  3. Verify that the features work properly for the app members.

  4. Request permission in App management page > [App] > [Request additional features].

After getting permission, the Talk Calendar API will be available for all service users.

Public events

To use the public event feature of the Talk Calendar API, connect Kakao Talk Channel. Connecting the Kakao Talk channel is not required to apply for permissions, but it is recommended to set it before applying for permissions if possible.

Calendar types

On the web or app version of Talk Calendar, a user can see the user's calendar divided into three categories.

  • [A] Talk Calendar
    • [a] My Calendar
    • [b] Sub-calendar
  • [B] Shared Calendar
    • Note: As of now, the Talk Calendar API does not support the Shared Calendar, which is created when a Team chat is created.
  • [C] Subscribed calendar

Screenshot of Talk Calendar

Each calendar has the following features:

Calendar typeDescriptionHow to create a calendar
My Calendar
([A] > [a])
Primary calendar that is automatically created when a user starts to use the Talk Calendar service.My calendar is automatically created for each user.

Note: This calendar cannot be deleted because it is set as a default calendar.
Sub-calendar
([A] > [b])
Additional calendars that a user or a service has created.A service can create a calendar through the Creating sub-calendar API.
Users also can create a calendar in the Talk Calendar service.
Subscribed Calendar ([C])Calendar that Kakao Talk Channel publishes or manages to let users subscribe to the calendar based on interests.A service can request to create a subscribed calendar at DevTalk.

Event types

Here are the types of events that can be handled with the Talk Calendar APIs.

Event typeDescriptionHow to addHow to edit
Personal eventEvents that a user has added to the user's My Calendar or sub-calendarsUsers can create an event through the Creating event API.

Note: The created event is added to a user's My Calendar or sub-calendars.
For event hosts, use the Editing event for host API.
For event attendees, use the Editing event for attendee API.
Public eventEvents that are published by a service's Kakao Talk Channel for marketing purposeYour service can publish a public event through the Creating public event API.
Users can add a public event published by your service to their own calendar by calling the Following public event API.

Note: The public event is added to a user's My Calendar or sub-calendar.
Use the Editing event for attendee API.
Subscribed eventEvents that are published by Kakao Talk Channel
(Example: Kakao TV, Sports channel)
If a user subscribes to a subscribed calendar, all the events of the service are added to its subscribed calendar. If a user chooses to unsubscribe, all subscribed events are deleted.

Note: The subscribed event is added to a user's Subscribed calendar.
Use the Editing event for attendee API.
Guest eventPublic events that the user added to My calendar. Users cannot edit the original event but can edit the duplicated guest events. If Kakao Talk Channel edits the original public event, the changes also apply to the guest events.--
Calendar relationship

Overview of calendars and events

Tasks

Users can write out the details of what they need to do and register it as a task. You can manage tasks to ensure they are completed without missing anything by setting up [Show My Challenge Record], where you can check time information and completion history as needed.

You can view, edit, or delete tasks. You cannot delete tasks registered on your Kakao Talk profile sticker.

Send a calendar message

If your service uses a public event or subscribed calendar, you can encourage users to add the event or calendar to their calendar by sending a Kakao Talk message through the Kakao Talk Share API or the Kakao Talk Message API. For this, you need to configure a message with a follow or subscribe button by using the calendar template.

Calendar message

To implement this functionality, see the following documentation:

PurposeGuide
To configure a calendar type of messageMessage Template
To send a calendar message through Kakao Talk ShareJavaScript SDK
Android SDK
iOS SDK
Flutter SDK
To send a calendar message through Kakao Talk Message

Important: To send a calendar message to all users who are linked to your app, set consent items and request permission.
REST API
JavaScript SDK
Android SDK
iOS SDK
Flutter SDK

Usage policy

Quota

Kakao API applies monthly and daily quotas for stable service. You can check the currently applied quota information in the Quota. To increase the applied quota limit, contact us as consultation and partnership are required.

To increase allocated quota for the Talk Calendar API, you need to request permission. By default, you can use the API on a limited quota for testing.

Provided APIs

Refer to Scope of support to know whether each Kakao SDK supports each feature.

APIMethodURLDescription
Retrieve list of calendarsGEThttps://kapi.kakao.com/v2/api/calendar/calendarsRetrieves user's all calendars (My Calendar, sub-calendar, and subscribed calendar).
Create sub-calendarPOSThttps://kapi.kakao.com/v2/api/calendar/create/calendarCreates a sub-calendar on user's calendar under the Talk Calendar category.
Edit sub-calendarPOSThttps://kapi.kakao.com/v2/api/calendar/update/calendarEdits a particular sub-calendar.
Delete sub-calendarDELETEhttps://kapi.kakao.com/v2/api/calendar/delete/calendarDeletes a particular sub-calendar.
Create eventPOSThttps://kapi.kakao.com/v2/api/calendar/create/eventCreates an event on a user's calendar.
Retrieve list of eventsGEThttps://kapi.kakao.com/v2/api/calendar/eventsRetrieves all events (personal, public, or subscribed events) added on the requested calendar.
Retrieve details of eventGEThttps://kapi.kakao.com/v2/api/calendar/eventRetrieves the details of a user's personal event.
Edit event for hostPOSThttps://kapi.kakao.com/v2/api/calendar/update/event/hostEdits a particular personal event that a user has created.
Delete eventDELETEhttps://kapi.kakao.com/v2/api/calendar/delete/eventDeletes the user's personal event or public event added on a user's calendar.
Create public eventPOSThttps://kapi.kakao.com/v2/api/calendar/public/create/eventCreates a public event.
Retrieve list of public eventsGEThttps://kapi.kakao.com/v2/api/calendar/public/eventsRetrieves all public events that your service has created.
Retrieve details of public eventGEThttps://kapi.kakao.com/v2/api/calendar/public/eventRetrieves the details of a particular public event that your service has created.
Edit public eventPOSThttps://kapi.kakao.com/v2/api/calendar/public/update/eventEdits a particular public event.
Delete public eventDELETEhttps://kapi.kakao.com/v2/api/calendar/public/delete/eventDeletes a particular public event.
Add public event to user calendarPOSThttps://kapi.kakao.com/v2/api/calendar/public/followAdds public events published by your service's Kakao Talk Channel to a user's calendar.
Retrieve list of subscribable calendarsGEThttps://kapi.kakao.com/v2/api/calendar/subscribable/calendarsRetrieves the list of the available calendars that a user can subscribe to.
SubscribePOSThttps://kapi.kakao.com/v2/api/calendar/subscribeSubscribes to your service's calendar.
UnsubscribeDELETEhttps://kapi.kakao.com/v2/api/calendar/unsubscribeUnsubscribes from your service's calendar.
Edit guest eventPOSThttps://kapi.kakao.com/v2/api/calendar/update/event/guestEdits a particular public event or subscribed event added to a user's calendar.
Retrieve holidays and celebrationsGEThttps://kapi.kakao.com/v2/api/calendar/holidaysRetrieves holidays in the Republic of Korea for a requested period on a calendar.
Create taskPOSThttps://kapi.kakao.com/v1/api/calendar/create/taskCreates a task.
Retrieve taskGEThttps://kapi.kakao.com/v1/api/calendar/tasksRetrieves a particular or list of task.
Check challenge recordGEThttps://kapi.kakao.com/v1/api/calendar/task/recordsChecks the challenge history of a specific recurring task.
Edit taskPOSThttps://kapi.kakao.com/v1/api/calendar/update/taskEdits a particular task.
Set completion statusPOSThttps://kapi.kakao.com/v1/api/calendar/complete/taskSets the completion status of task.
Delete taskDELETEhttps://kapi.kakao.com/v1/api/calendar/delete/taskDeletes a particular task.

Was this helpful?