AntiSPAM Telegram Bot

This is a simple anti-spam/helper telegram bot designed for Sapienza groups.

Note that this bot will not have features that you can find in other bots like GroupHelp.

This bot is still a work in progress.

Commands

In public groups

Command	Admin only	Description
/id	No	Shows the current group ID and user ID
/groups	No	Send a private message to the user with the list of groups. If the user never started the bot, a message will be temporary sent to the group, citing the user, asking him/her to talk to the bot privately
/dont	No	Will send a message with a link to https://dontasktoask.com/ . To use this command you need to cite the message of the user (i.e. the same message will be cited by the bot).
/settings	Yes	If sent by an admin, shows the control panel for the group
/terminate	Yes	Will ban the user in 10 seconds. To use this command, cite a message of the user you want to ban.
/reload	Yes	Re-read the group admin list, group infos and bot permissions in the group
/sigterm	Yes	Terminate the bot (will delete all chat infos/settings, and the bot will leave the chatroom)

As private message

Command	Description
/id	Shows the current chat ID and user ID
/start	Replies with a tiny help message and two buttons: Groups and Settings
/groups	Replies with the list of categories
/settings	Replies with a list of groups where the user is admin. By clicking on a group, you will be presented the group settings view

Global administrative commands (only bot admins)

Command	Description
/sighup	Do a full groups cache update
/groupscheck	Prints a debug for all groups
/updatewww	Update the group list in the website
/gline	Ban a user globally (for spam)
/remove_gline	Un-ban a user globally (for spam)

Help text for BotFather

These commands will be visible to anyone.

groups - List all groups of the network
dont - Send a message to the user with a link to https://dontasktoask.com/

Permissions

Permission	Required	Why is needed
Change group info	No	Not used
Delete messages	Yes	Used to delete: commands, spam (if enabled)
Ban users	Yes	Used to ban for: CAS, spam (if enabled), bot commands like /terminate
Invite users via link	Yes	Used to generate invite links for group indexing
Pin messages	No	Not used
Manage video chats	No	Not used
Remain anonymous	No	DO NOT GRANT*
Add new admins	No	Not used

*: Telegram APIs and telebot have a bug handling the "Remain anonymous" permission. If granted to a bot, the bot won't be able to use all other permissions. Do not grant until we have a reasonable fix.

Note: we strongly suggest you to grant all permissions to the bot, especially if you plan to use the "admin fallback" functionality. Rationale: when admins/bots promote a new admin, they can grant to the new admin only those permissions that they have; so, if you use the "admin fallback" feature, and you never granted "Change group info" to the bot, then no admins will have this permissions, ever.

Note 2: the bot was not tested with less than full permissions. If you encounter any bug, please create an issue.

How to build

To build the bot use go build ./ and you get antispam-telegram-bot binary ready to use.

How to spin your own instance

To run your own instance, you need to give at least bot's token and the redis URL to connect to the database. Information can be given in two ways:

1. As environment variables (e.g. BOT_TOKEN);
2. As command line argument (e.g. --bot-token or -b).

Run antispam-telegram-bot --help to see all available options. The only mandatory information are the following:

• BOT_TOKEN or --bot-token: the bot token that you get from BotFather;
• REDIS_URL or --redis-url: the URL for a Redis server instance.

Contributions

To contribute please open a merge request. All code should be under the current license (see LICENSE file).