Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.45 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.45 KB
Raw

Sakhi Telegram Bot

The Sakhi Telegram Bot is a Python-based bot that interacts with the Sakhi API Server via Telegram. It allows users to perform various actions and access information from the API Server through the convenience of a Telegram chat interface.

Prerequisites

  • Python
  • Telegram Bot API token
  • Telegram Bot Name
  • Sakhi API Server URL
  • Audience Type
  • Log Level

Installation

  1. Clone the repository

    git  clone https://github.com/DJP-Digital-Jaaduii-Pitara/sakhi-telegram-service.git

  2. Install required python packages

    pip install -r requirements.txt

  3. Set up the configuration

    • token
    • botName
    • upstream
    • audienceType - (Default, Teacher, Parent)
    • logLevel - (DEBUG, INFO, ERROR)
    • promptMsg (optional)

  4. Start the Telegram bot

    • python telegram_bot_accelerator.py

Usage

Once the Telegram bot is up and running, you can interact with it through your Telegram chat. Start a chat with the bot and use the available commands and features to perform actions and retrieve information from the Sakhi API Server.

  • The bot provides the following commands:

    /start: Start the conversation with the bot

  • Select preferred language

  • Start querying questions

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.