> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Telegram

> Add your bot to Telegram using the official integration.

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KQYYDZKSAHXH5DRK1ES6CKNS)
*v1.0.7*

The official Telegram integration allows users to chat with your bot by messaging a Telegram bot.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Telegram account](https://web.telegram.org/a/)

> [!TIP]
>
> Visual learner? Check out our [Telegram guide on YouTube](https://www.youtube.com/watch?v=KIYGklgl4bI\&t=554s).

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select \*\* Explore Hub\*\* in the upper-right corner.
2. Search for the **Telegram** integration.
3. Select **Install Integration**.

In the **Configuration** menu, you should see one field:

* **Bot Token**

Leave it empty for now—you'll come back to it after completing the setup in Telegram.

**2. Create a bot in Telegram**

To add your bot, you need to create a corresponding bot in Telegram. You can do this using Telegram's BotFather:

1. Log in to [Telegram](https://web.telegram.org/a/).
2. Start a conversation with [BotFather](https://telegram.me/BotFather) and follow the prompts to create your bot.
3. Copy your bot's access token.

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **Bot Token** field, paste your Telegram bot's access token.
2. Select **Save Configuration**.

> [!TIP]
>
> Your Telegram integration is ready—users can now chat with your Botpress bot by messaging your Telegram bot. You can use the integration's [Cards](#cards) to manage the bot's typing indicators.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

## Tags

You can read [event tags](https://botpress.com/docs/studio/guides/advanced/event-properties.md#param-tags) to get information about an active Telegram conversation:

### Telegram conversation ID

To get the Telegram conversation ID:

```js theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
{{ event.tags.conversation["telegram:id"] }}
```

### Telegram user ID

To get the Telegram user ID:

```js theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
{{ event.tags.user["telegram:id"] }}
```

### Telegram message ID

To get the Telegram message ID:

```js theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
{{ event.tags.message["telegram:id"] }}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.