BirthdaysWisherBot Do

BirthdaysWisherBot Documentation

Welcome to the official documentation for BirthdaysWisherBot! This guide provides a comprehensive overview of the bot's features, usage, and technical details. Whether you're an end-user or a developer looking to understand the bot's inner workings, this documentation has you covered.

Table of Contents

1. Introduction

2. Getting Started

3. Commands

4. Features

   • Personal Birthday Management

   • Group Birthday Management

   • Custom Birthday Messages

   • Notification System

5. Technical Details

   • Architecture

   • Database Schema

   • APIs Used

6. Troubleshooting

7. Contact and Support

Introduction

BirthdaysWisherBot (username: @BirthdaysWisherBot) is a Telegram bot designed to help you keep track of and celebrate birthdays. The bot allows users to add, delete, and view birthdays, ensuring you never miss a special day. With personalized birthday messages and notifications, the bot makes managing birthdays simple and enjoyable.

Getting Started

To start using BirthdaysWisherBot, follow these steps:

1. Add the Bot: Search for @BirthdaysWisherBot on Telegram and start a chat with the bot.

2. Set Up: Use the /start command to begin. The bot will guide you through the initial setup.

3. Commands: Familiarize yourself with the commands available to manage birthdays effectively.

Commands

Here are the primary commands available in BirthdaysWisherBot:

• /start: Initializes the bot and provides a welcome message.

• /addbirthday [Friend's Name] [DD-MM-YYYY]: Adds a friend's birthday (private messages only).

• /mybirthday [DD-MM-YYYY]: Adds your birthday to the group (group chats only).

• /deletebirthday [Friend's Name]: Deletes a friend's birthday (private messages only).

• /deletebirthday: Deletes your birthday from the group (group chats only).

• /birthdayList: Displays a list of all birthdays added.

• /help: Provides information about the bot and its commands.

Features

Personal Birthday Management

In private chats, you can add birthdays for your friends and family. Use the /addbirthday command followed by your friend's name and birthday in DD-MM-YYYY format. For example:

/addbirthday Aakash 15-08-2006

To delete a birthday, use:

/deletebirthday Aakash

Group Birthday Management

In group chats, members can add their own birthdays using the /mybirthday command. For example:

/mybirthday 15-08-2006

To delete your birthday from the group, use:

/deletebirthday

Custom Birthday Messages

The bot sends personalized birthday messages to users. These messages are designed to make the recipient feel special on their birthday.

Notification System

The bot has a robust notification system that reminds users of upcoming birthdays. Notifications are sent:

• On the day of the birthday.

• Two days before the birthday.

Technical Details

Architecture

BirthdaysWisherBot is built using Node.js and the Telegraf library for interacting with the Telegram Bot API. The bot stores user data in a MongoDB database.

Database Schema

The bot uses two primary schemas for managing birthdays:

1. GroupBirthdaySchema: Stores birthdays for users in group chats.

   const groupBirthdaySchema = new mongoose.Schema({
     userId: { type: String, required: true },
     date: { type: String, required: true },
     chatId: { type: String, required: true }
   });

2. PersonalBirthdaySchema: Stores birthdays for users in private chats.

   const personalBirthdaySchema = new mongoose.Schema({
     userId: { type: String, required: true },
     date: { type: String, required: true },
     name: { type: String, required: true }
   });

APIs Used

The bot leverages the following APIs:

• Telegram Bot API: For communication between the bot and users.

• MongoDB: For data storage and retrieval.

Troubleshooting

If you encounter issues with BirthdaysWisherBot, try the following steps:

1. Check Bot Status: Ensure the bot is running and has access to the internet.

2. Verify Commands: Double-check that you're using the correct command format.

3. Database Connection: Ensure the MongoDB connection string is correct and the database is accessible.

4. Logs: Check the bot's logs for error messages that might indicate what went wrong.

Contact and Support

For support, bug reports, or feature requests, contact the developer:

• Developer: Aakash Gupta

• Email: [e-mail]

Thank you for using BirthdaysWisherBot! We hope it helps you celebrate every special day with joy and ease.