Skip to content

Latest commit

 

History

History
123 lines (78 loc) · 5.26 KB

README.md

File metadata and controls

123 lines (78 loc) · 5.26 KB
Raw

Welcome to Telegram Support Bot 👋

Bot API Version NPM Version node js-google-style Documentation

TSB is a support bot for telegram bots, using the grammY Framework. It lets users create tickets which will be send to a staff group and can be answered by a reply.

🚀 Hosted solution: Get it here at botspace!

✨ Features

When a user sends a message to the support chat it will create a ticket which will be forwarded to the staff group. Any admin in the staff group may answer that ticket by just replying to it. Salutation is added automatically. Photos will be forwared too.

  • File forwarding from and to user
  • Database for handling open and closed tickets
  • Restrict users
  • Simple anti spam system
  • Send tickets to different staff groups
  • Private reply to user
  • Anonymize users
  • Auto reply based on keywords [beta]
  • Web chat [beta]]

📜 Commands

Currently the support chat offers these commands (staff commands):

  • /open - lists all open tickets (messages where noone has replied yet)
  • /reopen - reopen a closed ticket
  • /close - close a ticket manually (in case someone writes 'thank you')
  • /ban - ban a person from writing to your chat

User commands:

  • /start - tells the user how to use this bot
  • /help - an overview over the commands or some explanation for the user
  • /faq - shows the FAQ
  • /id - returns your telegram id and the group chat id (1234567 -1234567890)

📦 Install

See the wiki for more detailed instructions.

mv config/config-sample.yaml config.yaml
docker-compose up -d

📝 Upgrading from older versions

There are some breaking changes in the new versions. Please read the following instructions carefully when updating.

click here to show

Since version v4 this bot uses the grammY Telegram Bot Framework instead of the telegraf framework for various reasons.

Upgrading to v4.0.0

Make sure you add the new settings strings to your config.yaml file. Check the config-sample.yaml for all configs. Here are some of the new settings that you should add when migrating:

parse_mode: 'Markdown' # DO NOT CHANGE!
autoreply: (see config-sample.yaml for an example)

The config-sample.yaml settings now all use markdown instead of HTML so you have to adjust that. e.g. instead of
line break use \n instead. For a full list check the telegram bot API docs.

Upgrade to the new version. e.g. by pulling the main branch from GitHub or using the docker image bostrot/telegram-support-bot:4.0.0.

Start it.

The old database should work with the new version without changing anything.

Upgrading to v3.0.0

The latest version uses a new config file in YAML format which would break old versions.

In order to make old versions work with the master you would need to use the new config.yaml file instead of the config.ts file from before. The easiest would be if you copy the config-sample.yaml to config.yaml (both in the config folder) and edit the settings similar to your old config.ts file. There is no need to delete the database file so old tickets can be kept open.

You might also want to check out the wiki for more info.

Author

👤 Eric Trenkel

👥 Contributors

Contributors

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Eric Trenkel.
This project is GPL-3.0 licensed.

Not found what you were looking for? Check out the Wiki

If you need help or need a hosted solution of this check out Botspace for a one-click setup.