Telegram Transcriber Bot

Send any audio or video file to the bot, and it will send you a transcription. It uses the OpenAI Whisper API under the hood, so it works with many languages.

Afrikaans, Arabic, Armenian, Azerbaijani, Belarusian, Bosnian, Bulgarian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Estonian, Finnish, French, Galician, German, Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Macedonian, Malay, Marathi, Maori, Nepali, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish, Swahili, Swedish, Tagalog, Tamil, Thai, Turkish, Ukrainian, Urdu, Vietnamese, and Welsh.

Installation

The code samples provided are for Ubuntu. Please note that different systems may require different commands.

Preparations

1. Update the System

sudo apt-get update
sudo apt-get upgrade

2. Clone this Repository

git clone https://github.com/skripnik/TelegramTranscriberBot.git
cd TelegramTranscriberBot

3. Obtain Required Credentials

• Register your Telegram Bot using @BotFather, get the api_token and disable the bot privacy mode.
• Create a Telegram app to obtain your api_id and api_hash. Here's a useful Tutorial for that.
• Register on OpenAI Platform to get the OpenAI API Key.
• Find out your Telegram user id. You can use @userinfobot for that.

4. Configure .env file

Create a .env file in the TelegramTranscriberBot folder and add the following variables. Remember to replace the placeholders with your own values:

cat <<EOF >.env
TELEGRAM_API_TOKEN="your_telegram_bot_token"
TELEGRAM_API_ID="your_api_id"
TELEGRAM_API_HASH="your_api_hash"
TELEGRAM_ALLOWED_IDS="your_telegram_user_id"
OPENAI_API_KEY="your_openai_api_key"
EOF

Alternatively you can use .env.example file as a template.

Option A. Docker Installation

1. Install Docker And Docker Compose

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin

2. Build and Run your Docker image

docker build . -t telegram_bot:latest
docker-compose up -d

Option B. Manual Installation

You will need a server with root access. For the installation process, it's recommended to resize your server to at least 4GB RAM and 2 CPUs. The higher the configuration, the faster the installation can be completed. After installation, you can resize the server back to the original configuration.

1. Install Telegram Bot Server

We assume that the server code will be installed in the TelegramTranscriberBot project folder.

Please refer to the Server build instructions generator for actual code. Building requires about 4GB of RAM and may take up to 1 hour.

sudo apt-get install make git zlib1g-dev libssl-dev gperf cmake g++
git clone --recursive https://github.com/tdlib/telegram-bot-api.git
cd telegram-bot-api
rm -rf build
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=.. ..
cmake --build . --target install
cd ../..
ls -l telegram-bot-api/bin/telegram-bot-api*

2. Install FFMPEG

sudo apt install ffmpeg

3. Start the Server

Run the server using the following command. Note that the server will run continuously in the background. You might need to open another console for running additional commands:

screen
bash start_telegram_server.sh

4. Install Python, pip and Required Dependencies

sudo apt install python3 python3-pip
pip install -r requirements.txt

5. Run the Bot

screen
PYTHONPATH="${PYTHONPATH}:$(pwd)" python3 app/main.py

User Management

If you want your bot to work not only for you, but also for other people, you can add their Telegram user ids to the TELEGRAM_ALLOWED_IDS variable in the .env file.

Or you can create a Telegram group and invite users to it.

• Create a Telegram group
• Add the bot to the group
• Promote the bot to administrator
• Send any message to the group
• The bot will reply with the group_id
• Add the group_id to the TELEGRAM_ALLOWED_IDS variable in the .env file
• Invite users to the group

So TELEGRAM_ALLOWED_IDS allow you to specify a list of users and groups that can use the bot, separated by commas. For example:

TELEGRAM_ALLOWED_IDS = "1223456,-1111111111111"

Every time you change the .env file, you need to restart the bot.

Acknowledgements

This project was initiated and partially developed during the Internet Without Borders hackathon. We extend our sincere thanks to the event's organizers and sponsors for their support and encouragement.

License

This project is licensed under the Apache License 2.0. The authors and contributors are not liable for any damages arising from the use of this code.