Telegram bridge

The Telegram bridge installed by us is powered by mautrix-telegram.

• Full documentation
• Source code
• Support

Usage¶

This page shows you how to set up the Telegram bridge using Cinny client app (available as an add-on component), so that you can receive and send messages between Telegram and Matrix rooms.

Invite the bot to a management room¶

First, please start a chat with @telegrambot:your-server.com to create a management room. You can do so by inviting the bot to a room like below.

Make sure to replace your-server.com with your actual “base domain”. Setting your-server.com or example.com does not work on your server!

When the bot joins to the created room, it sends confirmation messages to the room as below. If they are visible, bot successfully joined the management room — it works as expected.

Authentication¶

The Telegram bridge supports three authentication methods: with a 6-digit code sent to your phone number, QR code, or a bot token.

Digit code¶

To use a digit code for bridging Telegram with Matrix, please follow the steps below.

1. Log in to your account with the official Telegram client
2. Send login phone <your phone number> to the bridge bot
3. Enter the 6-digit code sent by Telegram to the client

Please note that the phone number needs to be in the international format:

QR Code¶

To conduct authentication with a QR code, please follow the steps below.

1. On the Telegram app on your phone, go to “Devices” inside “Settings”, and tap “Link Desktop Device”
2. Send login qr to the bridge bot
3. Scan the QR code with your phone

Bot token¶

Alternatively, it is possible to use the bridge with a bot for relaying. This is helpful if you wish to avoid using your real account for the bridge.

⚠️ Please note that the functionality of the bridge will be much limited when relaying with a bot. Also keep in mind that you should use a dedicated Matrix account for relay mode.

To conduct authentication with a bot token, please follow the steps below.

1. Send login bot <token> to the bridge bot

Useful commands¶

If you send a message help to the room, available commands are listed in a message like below: