/chatgpt-telegram-bot

A ChatGPT bot for Telegram based on Node.js. Works with Cloudflare protection.

Primary LanguageTypeScriptMIT LicenseMIT

ChatGPT Telegram Bot

badge:version license

A ChatGPT bot for Telegram based on Node.js. Works with Cloudflare protection.

Features

Private Chat Group Chat
  • Support for both private and group chats
  • Work in privacy mode (the bot can only see specific messages)
  • Bot access control based on user and group IDs
  • Reset chat thread and refresh session with command
  • Typing indicator, Markdown formatting, ...
  • Cloudflare bypassing and CAPTCHA automation
  • User-friendly logging

Usage

Start the server

Note This bot uses a browser-based ChatGPT API, please make sure you have Node.js >= 18 and a Chromium-based browser installed.

To get started, follow these steps:

  1. Make a copy of the file .env.example and rename it as .env.
  2. In the .env file, enter your OpenAI account information and Telegram bot token. Set isGoogleLogin to true if you're using Google auth.
  3. Specify the ID of the users and groups who are permitted to use this bot. Separate multiple IDs with commas (,). Note that all members of the specified groups will have access to the bot inside the group. If you leave these options empty, every person and group will be able to use the bot.
  4. If the browser is not installed in the default location, specify its executable path. You can also specify proxy settings, if needed.
  5. Specify the NOPECHA_KEY or CAPTCHA_TOKEN if you're using the corresponding CAPTCHA solver.
  6. You can also specify the command to invoke the bot in group chats. The default command is /chat.

Then you can start the bot with:

pnpm install
pnpm build && pnpm start

Chat with the bot in Telegram

To chat with the bot in Telegram, you can:

  • Send direct messages to the bot (this is not supported in groups)
  • Send messages that start with the specified command (e.g., /chat or the command you specified in the .env file)
  • Reply to the bot's last message

Note Make sure you have enabled the privacy mode of your bot before adding it to a group, or it will reply to every message in the group.

The bot also has several commands.

  • /help: Show help information.
  • /reset: Reset the current chat thread and start a new one.
  • /reload (admin required): Refresh the ChatGPT session.

Note When using a command in a group, make sure to include a mention after the command, like /help@chatgpt_bot.

Advanced

Running the bot on a headless server

You can use Xvfb to create a virtual framebuffer on a headless server and run this program:

xvfb-run -a --server-args="-screen 0 1280x800x24 -nolisten tcp -dpi 96 +extension RANDR" pnpm start

We recommend you to use Google auth to avoid the complicated login Recaptchas. If you use a OpenAI account, you may have to use nopecha or 2captcha or manually solve the Recaptcha (by connecting to the display server using x11vnc). For more details about CAPTCHA solving, please refer to the api repository.

Docker

You can also try this docker image by running the following command from the project root folder:

docker compose up

LICENSE

MIT License.

Credits