Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/viperadnan-git/telegram-message-forwarder-bot

A telegram bot to forward messages automatically when they arrived.
https://github.com/viperadnan-git/telegram-message-forwarder-bot

telegram telegram-bot telegram-forward-bot telegram-forwarder telegram-message-forwarder telegram-message-sender telegram-sender

Last synced: 24 days ago
JSON representation

A telegram bot to forward messages automatically when they arrived.

Host: GitHub
URL: https://github.com/viperadnan-git/telegram-message-forwarder-bot
Owner: viperadnan-git
License: gpl-3.0
Created: 2021-04-03T06:31:08.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-07T06:00:25.000Z (8 months ago)
Last Synced: 2024-08-09T13:14:37.124Z (5 months ago)
Topics: telegram, telegram-bot, telegram-forward-bot, telegram-forwarder, telegram-message-forwarder, telegram-message-sender, telegram-sender
Language: Python
Homepage:
Size: 36.1 KB
Stars: 316
Watchers: 8
Forks: 457
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Telegram Message Forwarder Bot
A telegram bot, which can forward messages from channel, group or chat to another channel, group or chat automatically.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/viperadnan-git/telegram-message-forwarder-bot/)

## Configuration
To configure this bot you have to use the file template at [`sample.config.toml`](./sample.config.toml). Rename it to `config.toml` and fill the values as described below.
If you want to pass the values as environment variables, then pass the content of the config.toml file as environment variable `CONFIG`.

#### Pyrogram Section
- `api_id` - Your Telegram API ID.
- `api_hash` - Your Telegram API Hash.
- `session_string` - (Optional if `bot_token` is provided) Session string of your Telegram account. You can get it by running [`get_session.py`](./get_session.py) file.
- `bot_token` - (Optional if `session_string` is provided) Bot token of your Telegram bot. You can get it by creating a bot using [BotFather](https://t.me/BotFather).
- `sudo_users` - (Optional) List of user ids of users who can use the bot. You can get your user id by sending `/id` command to [Rose](https://t.me/MissRose_bot).

```toml
[pyrogram]
api_id = 12345 # required
api_hash = "0123456789abcdef0123456789abcdef" # required
bot_token = "123456789:ABCdefGhIJKlmNoPQRsTUVwxyZ" # either bot_token or session_string is required
session_string = "1BVn1-ABCD1234efgh5678IJKLmnoPQRsTUVwxyZxxxxxxxx" # either bot_token or session_string is required
sudo_users = [123456789, 123456789] # optional
```

#### Chats Section
- `from` - Chat id of the chat from which messages will be forwarded. You can get it by sending `/id` command to [Rose](https://t.me/MissRose_bot).
- `to` - Chat id of the chat to which messages will be forwarded. You can get it by sending `/id` command to [Rose](https://t.me/MissRose_bot).
- `replace` - (Optional) A dictionary of strings to replace in the message. The key is the string to be replaced and the value is the string to replace with. This is optional.

You can add multiple chats by using the following format.
```toml
[[chats]]
from = -100123456789 # required
to = 123456789 # required
replace = { "old" = "new" } # optional

[[chats]]
from = [123456789, -100123456789] # required
to = 123456789 # required
replace = { "only_apply_to_this_chat" = "new" } # optional

[[chats]]
from = -100123456789 # required
to = [123456789, -100123456789] # required
```

Note: The chats should be in the format of `int` or `list` of `int`. If you want to use usernames, then you have to use the `chat_id` of the chat. You can get it by sending `/id` command to [Rose](https://t.me/MissRose_bot).

### Note
- Supported identifier for a chat should be the chat id.
- Use `/forward` command to forward older messages. For message older than 2 days you have to login as a user and set the `session_string` variable in pyrogram section. Command usage - `/forward `

## Deployment

### Clone the repository
```bash
git clone telegram-message-forwarder-bot
cd telegram-message-forwarder-bot
```

### Install the requirements
Install the required Python Modules in your machine.
```bash
pip3 install -r requirements.txt
```

### Start the bot
With python3.10 or later.
```bash
python3 -m bot
```

### Docker
Build the image.
```bash
docker build -t telegram-message-forwarder-bot .
```

Run the container.
```bash
docker run -d --name telegram-message-forwarder-bot telegram-message-forwarder-bot
```

## Contributing
- Fork the repository.
- Create a new branch.
- Make your changes.
- Commit and push the changes to your fork.
- Create a pull request.

## Support
- Ask in the [Telegram Group](https://t.me/ViperCommunity) or open an issue.