This repository contains the code for an appointment scheduling chatbot designed to assist in managing calendar bookings. The chatbot, built with the ChatBotKit SDK, facilitates the booking of appointments following specific rules and guidelines to ensure an efficient and conflict-free scheduling process.
demo.mp4
- Appointment Scheduling: Users can schedule appointments within predefined time slots, ensuring adherence to the specified availability and rules set for Dr. Smith.
- Dynamic Calendar Handling: The chatbot integrates a calendar system that lists available slots and manages bookings dynamically. User Interaction: Through UI components, the chatbot captures user details and appointment preferences, providing a seamless booking experience.
- ChatBotKit SDK: For building the chatbot logic and handling conversation flow.
- React: For UI components that interact with the user, such as forms for capturing appointment details and slot selection.
- Ensure you have Node.js installed.
- Clone this repository.
- Install dependencies by running npm install.
- Set the
CHATBOTKIT_API_SECRETenvironment variable with your ChatBotKit API secret. - Optionally, set the
CHATBOTKIT_MODELenvironment variable to specify the model used for conversation (default is GPT-3.5 Turbo).
Run the development server:
npm run devOpen http://localhost:3000 with your browser to see the result.
The system will automatically handle appointment bookings based on the following rules:
- Appointments can only be booked between 11 am and 5 pm.
- Dr. Smith must have at least 30 minutes between appointments.
- A maximum of 3 appointments per day, 5 per week, and 10 per month is enforced.
- Each appointment lasts 30 minutes.
- Appointments can be booked up to a month in advance.
The chatbot uses several custom functions to interact with the user, fetch calendar events, show available slots, and capture booking details. These include:
- getCalendarEvents: Fetches current calendar events.
- showSlotSelectionForm: Displays a form for slot selection.
- captureSlot: Captures the selected slot for booking.
- showContactDetailsForm: Displays a form to capture user contact details.
- captureDetails: Captures the name and email of the person booking the appointment.
- bookAppointment: Finalizes the booking and updates the calendar.
To learn more about ChatBotKit and relevent SDKs look at the following resources:
- ChatBotKit Documentation - learn about ChatBotKit
- ChatBotKit JavaScript SDKs - learn about used SDKs
The easiest way to deploy this Next.js app is to use the Vercel Platform.
Contributions to enhance the chatbot's functionality or address issues are welcome. Please follow the standard pull request process for contributions.
This project is licensed under the MIT License - see the LICENSE file for details.