Skip to content

Latest commit

 

History

History
393 lines (226 loc) · 9.42 KB

README.md

File metadata and controls

393 lines (226 loc) · 9.42 KB
Raw

🤖 Support Bot

License Telegram Bot Python Redis Docker

Support Bot is a specially designed Telegram bot for feedback. With built-in support for topics, all user messages are intelligently categorized, promoting organized and streamlined discussion in your group. It provides features such as blocking unwanted users, silent mode in topics for discreet conversations, and more. Improve group communication with Support Bot!

About Limits:

Specific limits are not specified in the documentation, but the community has shared some rough numbers.
• Limit on topic creation per minute ~20.
• Limit on the total number of topics ~1M.
Available bot commands for admins (DEV_ID)

  • /newsletter - Open the newsletter menu.

    Use this command to initiate a newsletter for users. Note: This command works only in private chats.

Available bot commands in the group topics

  • /ban - Block/Unblock User.

    Use this command to block or unblock a user, controlling the receipt of messages from them.

  • /silent - Activate/Deactivate Silent Mode.

    Enable or disable silent mode to prevent messages from being sent to the user.

  • /information - User Information.

    Receive a message containing basic information about the user.

Usage

Preparation
  1. Create a bot via @BotFather and save the TOKEN (referred to as BOT_TOKEN later).
  2. Create a group and enable topics in the group settings.
  3. Add the created bot to the group as an admin and grant it the necessary rights to manage topics.
  4. Add the bot What's my Telegram ID? to the group and save the group ID (referred to as BOT_GROUP_ID later).
  5. Optionally, customize the bot texts to fit your needs in the file named texts.
  6. Optionally, add the language you need to SUPPORTED_LANGUAGES and add the appropriate codes to the data.
Installation

You need your own server or you can rent one from a hosting provider. For this, check out the Recommended Hosting Provider section below.

  1. Clone the repository:

    git clone https://github.com/nessshon/support-bot.git

  2. Change into the bot directory:

    cd support-bot

  3. Clone environment variables file:

    cp .env.example .env

  4. Configure environment variables variables file:

    nano .env

  5. Running a bot in a docker container:

    docker-compose up --build

Environment Variables Reference

Click to expand

Here is a comprehensive reference guide for the environment variables used in the project:

Variable Type Description Example
BOT_TOKEN str Bot token, obtained from @BotFather 123456:qweRTY
BOT_DEV_ID int User ID of the bot developer or admin 123456789
BOT_GROUP_ID str Group ID where the bot operates -100123456789
BOT_EMOJI_ID str The custom emoji ID for the group's topic. 5417915203100613993
REDIS_HOST str The hostname or IP address of the Redis server redis
REDIS_PORT int The port number on which the Redis server is running 6379
REDIS_DB int The Redis database number 1
List of supporting custom emoji ID's

5434144690511290129 - 📰

5312536423851630001 - 💡

5312016608254762256 - ⚡️

5377544228505134960 - 🎙

5418085807791545980 - 🔝

5370870893004203704 - 🗣

5420216386448270341 - 🆒

5379748062124056162 - ❗️

5373251851074415873 - 📝

5433614043006903194 - 📆

5357315181649076022 - 📁

5309965701241379366 - 🔎

5309984423003823246 - 📣

5312241539987020022 - 🔥

5312138559556164615 - ❤️

5377316857231450742 - ❓

5350305691942788490 - 📈

5350713563512052787 - 📉

5309958691854754293 - 💎

5350452584119279096 - 💰

5309929258443874898 - 💸

5377690785674175481 - 🪙

5310107765874632305 - 💱

5377438129928020693 - ⁉️

5309950797704865693 - 🎮

5350554349074391003 - 💻

5409357944619802453 - 📱

5312322066328853156 - 🚗

5312486108309757006 - 🏠

5310029292527164639 - 💘

5310228579009699834 - 🎉

5377498341074542641 - ‼️

5312315739842026755 - 🏆

5408906741125490282 - 🏁

5368653135101310687 - 🎬

5310045076531978942 - 🎵

5420331611830886484 - 🔞

5350481781306958339 - 📚

5357107601584693888 - 👑

5375159220280762629 - ⚽️

5384327463629233871 - 🏀

5350513667144163474 - 📺

5357121491508928442 - 👀

5357185426392096577 - 🫦

5310157398516703416 - 🍓

5310262535021142850 - 💄

5368741306484925109 - 👠

5348436127038579546 - ✈️

5357120306097956843 - 🧳

5310303848311562896 - 🏖

5350424168615649565 - ⛅️

5413625003218313783 - 🦄

5350699789551935589 - 🛍

5377478880577724584 - 👜

5310303848311562896 - 🏖

5350424168615649565 - ⛅️

5413625003218313783 - 🦄

5350699789551935589 - 🛍

5377478880577724584 - 👜

5431492767249342908 - 🛒

5350497316203668441 - 🚂

5350422527938141909 - 🛥

5418196338774907917 - 🏔

5350648297189023928 - 🏕

5309832892262654231 - 🤖

5350751634102166060 - 🪩

5377624166436445368 - 🎟

5386395194029515402 - 🏴

5350387571199319521 - 🗳

5357419403325481346 - 🎓

5368585403467048206 - 🔭

5377580546748588396 - 🔬

5377317729109811382 - 🎶

5382003830487523366 - 🎤

5357298525765902091 - 🕺

5357370526597653193 - 💃

5357188789351490453 - 🪖

5348227245599105972 - 💼

5411138633765757782 - 🧪

5386435923204382258 - 👨

5377675010259297233 - 👶

5386609083400856174 - 🤰

5368808634392257474 - 💅

5350548830041415279 - 🏛

5355127101970194557 - 🧮

5386379624773066504 - 🖨

5377494501373780436 - 👮

5350307998340226571 - 🩺

5310094636159607472 - 💊

5310139157790596888 - 💉

5377468357907849200 - 🧼

5418115271267197333 - 🪪

5372819184658949787 - 🛃

5350344462612570293 - 🍽

5384574037701696503 - 🐟

5310039132297242441 - 🎨

5350658016700013471 - 🎭

5357504778685392027 - 🎩

5350367161514732241 - 🔮

5350520238444126134 - 🍹

5310132165583840589 - 🎂

5350392020785437399 - ☕️

5350406176997646350 - 🍣

5350403544182694064 - 🍔

5350444672789519765 - 🍕

5312424913615723286 - 🦠

5417915203100613993 - 💬

5312054580060625569 - 🎄

5309744892677727325 - 🎃

5238156910363950406 - ✍️

5235579393115438657 - ⭐️

5237699328843200968 - ✅

5238027455754680851 - 🎖

5238234236955148254 - 🤡

5237889595894414384 - 🧠

5237999392438371490 - 🦮

5235912661102773458 - 🐈

Recommended Hosting Provider

I recommend using aeza.net for your hosting needs. Here's why:

  • 24/7 Support: Quick and effective support via chat or phone.
  • Promo Plan for €1: Great for testing Telegram bots and small websites.
  • Easy Backups: Secure backups on independent servers.
  • Hourly Billing: Rent a server by the hour for testing or demos.
  • Anti-DDoS Protection: Reliable and secure internet connection for your business.
  • Multiple Payment Methods: Supports various payment methods, including cryptocurrencies like TON.

Learn more at aeza.net.

Donations

TON - EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess

USDT (TRC-20) - TGKmm9H3FApFw8xcgRcZDHSku68vozAjo9

Contribution

We welcome your contributions! If you have ideas for improvement or have identified a bug, please create an issue or submit a pull request.

License

This repository is distributed under the MIT License. Feel free to use, modify, and distribute the code in accordance with the terms of the license.