Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/returnfi/telegram-support-bot
Telegram Support Bot
https://github.com/returnfi/telegram-support-bot
pytelegrambotapi support-bot telebot-telegrambotapi telegram-bot telegram-bot-api
Last synced: 5 days ago
JSON representation
Telegram Support Bot
- Host: GitHub
- URL: https://github.com/returnfi/telegram-support-bot
- Owner: ReturnFI
- License: gpl-3.0
- Created: 2024-07-17T19:51:01.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T18:30:11.000Z (4 months ago)
- Last Synced: 2024-07-26T20:59:36.787Z (4 months ago)
- Topics: pytelegrambotapi, support-bot, telebot-telegrambotapi, telegram-bot, telegram-bot-api
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Support Bot
This is a Telegram bot designed to facilitate communication between users and a support team. The bot allows users to send messages or photos to a specific group thread, where the support team can respond.
## Features
- Users can start a support session by providing a group chat ID and thread ID.
- The bot forwards user messages and photos to the specified group thread.
- The support team can reply to user messages, and the bot forwards the responses back to the user.
- The bot can generate a join link for specific group threads.
## Requirements
- Python 3.6+
- `pyTelegramBotAPI` library
- `python-dotenv` library
## Installation
1. Clone the repository:
``` shell
git clone https://github.com/ReturnFI/Telegram-Support-Bot.git
cd Telegram-Support-Bot
```
2. Install the required libraries:
```python
pip install pyTelegramBotAPI python-dotenv
```
3. Create a `.env` file in the root directory of the project and add your Telegram bot token:
```
TELEGRAM_BOT_TOKEN=your_telegram_bot_token
```
## Usage
1. Start the bot:
```python
python main.py
```
## Commands
1. `/start _`
- Starts a support session. The user needs to provide a valid `group_chat_id` and `thread_id`
2. `/join`
- Used in a supergroup thread to generate a join link for that specific thread. The link can be shared with users to allow them to join the support session.
- This command should be used within a thread in the group.
## Functionality
1. Handling user messages and photos:
- The bot will forward user messages and photos to the specified group thread.
- The forwarded message will include the user's username and ID for reference.
2. Handling replies from the support team:
- The support team can reply to the user's message by using the /welcome command followed by their message.
- Example: `/welcome Thank you for reaching out. How can we assist you today?`
- The bot will forward the support team's reply back to the user.
## Contributing
Feel free to open issues or submit pull requests if you find any bugs or have suggestions for improvements.