Warning No longer works as of December 12th due to Cloudflare protections (see #261)

ChatGPT Telegram Bot

A Telegram bot that integrates with OpenAI's ChatGPT to provide answers. Ready to use with minimal configuration required.

Features

Reply to specific messages
Support markdown in answers
Can reset conversation thread with the /reset command
Typing indicator while generating a response
Access can be restricted by specifying a list of allowed users
(NEW!) Docker support
(NEW!) Live answer updating as the bot types

Additional Features - help needed!

Multi-chat support (ongoing, see pull/22)
- Idea: cache different instances of ChatGPT3Bot, one for every chat id (maybe even persist them), so that every user has their own private conversation
Support group chats (ongoing, see pull/17)
- Allow the bot to be used in group chats with specific commands
Advanced commands
- With premade ad-hoc prompts

PRs are always welcome!

Prerequisites

Python 3.10+ and Pipenv
A Telegram bot and its token (see tutorial)
An OpenAI account (see configuration section)

Getting started

Configuration

Customize the configuration by copying .env.example and renaming it to .env, then editing the settings as desired:

OPENAI_EMAIL="<YOUR_OPENAI_EMAIL>"
OPENAI_PASSWORD="<YOUR_OPENAI_PASSWORD>"
TELEGRAM_BOT_TOKEN="<YOUR_TELEGRAM_BOT_TOKEN>"

OPENAI_EMAIL,OPENAI_PASSWORD: Your OpenAI credentials (these are only sent to the OpenAI server to periodically refresh the access token and never shared). You can read more about it here
TELEGRAM_BOT_TOKEN: Your Telegram bot's token, obtained using BotFather (see tutorial)

Additional optional (but recommended) configuration values:

ALLOWED_TELEGRAM_USER_IDS="<USER_ID_1>,<USER_ID_2>,..." # Defaults to "*"
PROXY="<HTTP/HTTPS_PROXY>" # E.g. "http://localhost:8080", defaults to none
USE_STREAM=false # Defaults to true
DEBUG=false # Defaults to true

ALLOWED_TELEGRAM_USER_IDS: A comma-separated list of Telegram user IDs that are allowed to interact with the bot (use getidsbot to find your user ID). Important: by default, everyone is allowed (*)
PROXY: Proxy to be used when authenticating with OpenAI
USE_STREAM: Streams the response as the bot types. Set to false to only answer once the response is fully generated

Installing

Clone the repository and navigate to the project directory:

git clone https://github.com/ninajcoolers/chatgpt-telegram-bot.git
cd chatgpt-telegram-bot

From Source

Create a new virtual environment with Pipenv and install the required dependencies:

pipenv install

Activate the virtual environment:

pipenv shell

Use the following command to start the bot:

python main.py

Using Docker Compose

Run the following command to build and run the Docker image:

docker-compose up

Disclaimer

This is a personal project and is not affiliated with OpenAI in any way.

License

This project is released under the terms of the GPL 2.0 license. For more information, see the LICENSE file included in the repository.

dianailinkovski/chatgpt-telegram-bot-main