pyInspectorTelegramBot

Telegram bot working in groups and channels. Sends available information about new members (ID, First Name, Last Name, Username, Language Code, Premium Status, Profile Photo and the approximate date of registration) to group administrators.

Installation

As an example, the bot will be installed on a VPS with Ubuntu Server.

• Start the BotFather bot in Telegram. Create a new bot and get its authorization token.
• Installing the necessary packages, creating a working directory, copying files:

user@vps:~$ sudo apt update
user@vps:~$ sudo apt-get install vim logrotate git python3-venv python3-pip
user@vps:~$ git clone https://github.com/rustequal/pyInspectorTelegramBot.git
user@vps:~$ sudo useradd -m -d /opt/inspector-bot -s /bin/bash bot
user@vps:~$ sudo chmod 755 /opt/inspector-bot
user@vps:~$ sudo cp pyInspectorTelegramBot/*.{py,json,txt} /opt/inspector-bot/
user@vps:~$ sudo chown bot:bot /opt/inspector-bot/*.{py,json,txt}
user@vps:~$ sudo cp pyInspectorTelegramBot/redist/etc/systemd/system/inspector-bot.service /etc/systemd/system/
user@vps:~$ sudo cp pyInspectorTelegramBot/redist/etc/logrotate.d/inspector-bot /etc/logrotate.d/

• Creating a python environment, installing the necessary python packages:

user@vps:~$ sudo su bot
bot@vps:/home/user$ cd
bot@vps:~$ python3 -m venv telegram
bot@vps:~$ source telegram/bin/activate
(telegram) bot@vps:~$ pip3 install wheel
(telegram) bot@vps:~$ pip3 install -r requirements.txt

• Editing the configuration file. It's necessary to set the "token" parameter to the value of the Telegram bot authorization token:

(telegram) bot@vps:~$ vim config.json
(telegram) bot@vps:~$ exit

• Starting the bot service, setting up the autostart of the service, checking the logs:

user@vps:~$ sudo systemctl daemon-reload
user@vps:~$ sudo systemctl start inspector-bot
user@vps:~$ sudo systemctl enable inspector-bot
user@vps:~$ sudo tail /opt/inspector-bot/bot.log

Usage

• After starting the bot, you need to set the owner and his password with the "/owner" command. With the same command, you can change the owner, as well as change the owner's password. Open a chat with the bot and enter the command:

/owner <PASSWORD>

• Add the bot to the telegram group or channel as an administrator. The bot does not need any special administrator permissions. The main thing is to be an administrator. Therefore, all permission switches can be turned off.
• If you want to work with Telegram groups, open the group chat and enter the "/group_add@username" command, where "@username" is the username of the new bot:

/group_add@username

• If you want to work with Telegram channels, copy the channel message to the bot's chat. The bot will output the channel ID. Next, use the "/channel_add" command to add the channel to the bot settings:

/channel_add <ID>

• Wait until a new member joins the group or channel. The bot will send you a message with information about the new member.
• If messages about new members need to be sent to other users, then you need to create a password with the "/user_add" command and forward it to a new user. The new user must open a chat with the bot and enter the "/user_add" command with a password.
• To show information about a chat member, use the "/member" command in the bot's chat. The numeric ID of the member must be specified as a parameter:

/member <ID>

• To get information about the member, you can forward his message to the bot's chat. For example, this way you can find out his ID number. But if his account is hidden by the privacy settings, then you will not be able to do that. In this case, use the "/member" command and its numeric ID, if it is known.
• For help on all commands, use the "/help" command in the bot's chat.
• The list of versions, changes and fixes is available in CHANGELOG.md

References

• pyTelegramBotAPI
  • A simple, but extensible Python implementation for the Telegram Bot API.
• AIOHTTP
  • Asynchronous HTTP Client/Server for asyncio and Python.