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

# Set up a Telegram gateway

> Create a Telegram bot with BotFather and connect it to Alter Gateways

Use this guide to create a Telegram bot through **BotFather**, copy its token, and connect it under **Settings → Integrations → Gateways**.

<Info>
  Alter connects to Telegram with a **bot token** from [@BotFather](https://t.me/BotFather). Alter uses long polling on your Mac — you do not configure webhooks or a public URL.
</Info>

## Before you start

* A Telegram account.
* **Alter** installed and running on your Mac.
* The Telegram app or [Telegram Web](https://web.telegram.org/).

Official references:

* [@BotFather](https://t.me/BotFather) on Telegram
* [Telegram Bots — Features and BotFather](https://core.telegram.org/bots/features#botfather)
* [Telegram Bot API tutorial](https://core.telegram.org/bots/tutorial)
* [Bot FAQ — groups and privacy](https://core.telegram.org/bots/faq#what-messages-will-my-bot-get)

## Step 1 — Create a bot with BotFather

<Steps>
  <Step title="Open BotFather">
    In Telegram, open [@BotFather](https://t.me/BotFather) and tap **Start** (or send `/start`).

    <Frame>
      <img src="https://mintcdn.com/alter-95c0cbf0/MYpqj9sX5kEixlPR/images/gateways/telegram/botfather-search.png?fit=max&auto=format&n=MYpqj9sX5kEixlPR&q=85&s=416e0057520d9d498ff8d0cc688b6e72" alt="Telegram search results showing @BotFather" width="719" height="123" data-path="images/gateways/telegram/botfather-search.png" />
    </Frame>

    *Source: [kitob-bot README](https://github.com/ytsshinobi/kitob-bot)*
  </Step>

  <Step title="Run /newbot">
    Send `/newbot`. BotFather asks for a **display name** (shown in contacts) and a **username** (must end in `bot`, for example `MyAlterHelperBot`).

    <Frame>
      <img src="https://mintcdn.com/alter-95c0cbf0/MYpqj9sX5kEixlPR/images/gateways/telegram/newbot-command.png?fit=max&auto=format&n=MYpqj9sX5kEixlPR&q=85&s=86c2fc0a9a5ba42beedd203b60cbff34" alt="Telegram chat with BotFather after sending /newbot" width="635" height="154" data-path="images/gateways/telegram/newbot-command.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/alter-95c0cbf0/MYpqj9sX5kEixlPR/images/gateways/telegram/newbot-name-username.png?fit=max&auto=format&n=MYpqj9sX5kEixlPR&q=85&s=d828fb65830b37f9c869cd0ea07469d3" alt="BotFather asking for a bot username ending in bot" width="638" height="125" data-path="images/gateways/telegram/newbot-name-username.png" />
    </Frame>

    *Source: [kitob-bot README](https://github.com/ytsshinobi/kitob-bot)*
  </Step>

  <Step title="Copy the HTTP API token">
    When creation succeeds, BotFather sends a message containing your **token** (format like `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`). Copy the full string.

    Telegram documents this flow in the [Bot tutorial — Obtain your bot token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token).

    <Frame>
      <img src="https://mintcdn.com/alter-95c0cbf0/MYpqj9sX5kEixlPR/images/gateways/telegram/bot-token-message.png?fit=max&auto=format&n=MYpqj9sX5kEixlPR&q=85&s=a86df86e28d0854ef42229e4c1fae0fb" alt="BotFather success message with bot link and HTTP API token" width="433" height="270" data-path="images/gateways/telegram/bot-token-message.png" />
    </Frame>

    *Source: [kitob-bot README](https://github.com/ytsshinobi/kitob-bot). The token shown is from a public tutorial repo — treat your own token like a password.*
  </Step>
</Steps>

<Warning>
  Treat the token like a password. If it is exposed, open BotFather and send `/revoke` for that bot, then paste the new token into Alter.
</Warning>

### Optional BotFather settings

| Command           | When to use                                         |
| ----------------- | --------------------------------------------------- |
| `/setdescription` | Short description users see before starting the bot |
| `/setabouttext`   | About text on the bot profile                       |
| `/setuserpic`     | Bot avatar                                          |
| `/token`          | Retrieve the token again for an existing bot        |

## Step 2 — Start a chat with your bot

<Steps>
  <Step title="Open the bot">
    Tap the link BotFather provides (for example `t.me/YourBotName`) or search for your bot's username in Telegram. The success message in **Step 1** includes this link.
  </Step>

  <Step title="Tap Start">
    Send `/start` so Telegram opens a conversation. You need an active chat before testing Alter.
  </Step>
</Steps>

## Step 3 — Optional: use the bot in a group

Alter can receive messages from group chats as well as private chats.

<Steps>
  <Step title="Add the bot to a group">
    In your group, add the bot as a member (you may need admin permission to add bots).
  </Step>

  <Step title="Check Group Privacy (if messages are missing)">
    By default, Telegram bots in groups may only see commands and @mentions. For broader group access, open [@BotFather](https://t.me/BotFather) → `/mybots` → your bot → **Bot Settings** → **Group Privacy** → **Turn off**.

    See [Bot FAQ — privacy mode](https://core.telegram.org/bots/faq#what-messages-will-my-bot-get).
  </Step>

  <Step title="Restrict access if needed">
    If the bot should only respond to certain people or groups, see [Secure access — allowlists and IDs](#secure-access--allowlists-and-ids) below and fill in **Allowed Telegram user or chat IDs** when you connect Alter.
  </Step>
</Steps>

## Secure access — allowlists and IDs

Restrict who can use your Telegram gateway with **Allowed Telegram user or chat IDs** in **Settings → Integrations → Gateways**. Alter checks every incoming message and inline-button tap against that list before running an action.

<Info>
  Alter matches **user IDs**, **chat IDs**, and `@usernames` (case-insensitive). Leave the field **empty** to allow anyone who can message the bot. Enter `*` to allow everyone explicitly. Messages from users or chats not on the list are **silently ignored** — Alter does not reply with an error.
</Info>

### User ID vs chat ID

Telegram uses numeric IDs for both people and conversations:

| ID type     | Typical format                                                                                     | When to use in Alter                              |
| ----------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| **User ID** | Positive number (for example `123456789`)                                                          | Allow a specific person in DMs or in a group      |
| **Chat ID** | Positive for private chats; **negative** for groups and supergroups (for example `-1001234567890`) | Allow an entire group, or a specific private chat |

In a **private chat** with your bot, the chat ID is usually the same as your user ID. In a **group**, add the group's chat ID if you want everyone in that group to be allowed (subject to [Group Privacy](#step-3--optional-use-the-bot-in-a-group) settings).

Alter also accepts `@username` values (for example `@sam`) if the person has a public username.

### How to find your Telegram user ID

<Steps>
  <Step title="Use an ID bot (easiest)">
    In Telegram, open [@userinfobot](https://t.me/userinfobot) or [@getidsbot](https://t.me/getidsbot) and tap **Start**. The bot replies with your numeric **Id** — that is your **user ID**.

    Copy the number (digits only, no `@`) into **Allowed Telegram user or chat IDs**.
  </Step>

  <Step title="Forward a message (groups or other chats)">
    To identify someone else, forward one of their messages to [@userinfobot](https://t.me/userinfobot) or [@getidsbot](https://t.me/getidsbot). The bot reports the sender's user ID.

    <Warning>
      Only forward messages in contexts where you are comfortable sharing metadata with a third-party bot. For sensitive groups, prefer the Bot API method below or add the whole group by chat ID instead.
    </Warning>
  </Step>
</Steps>

### How to find a chat ID

<Steps>
  <Step title="Private chat with your bot">
    Your user ID from **Step 1** above is usually enough — private chat IDs match the user's ID.

    To confirm, message your bot, then call Telegram's [`getUpdates`](https://core.telegram.org/bots/api#getupdates) method with your bot token and look for `"chat": {"id": …}` and `"from": {"id": …}` in the JSON. See [Telegram Bot API — Chat](https://core.telegram.org/bots/api#chat) and [User](https://core.telegram.org/bots/api#user).
  </Step>

  <Step title="Group or supergroup">
    Add [@getidsbot](https://t.me/getidsbot) to the group temporarily (or use [@RawDataBot](https://t.me/RawDataBot)), send any message in the group, and copy the **Chat ID** from the bot's reply. Group IDs are negative numbers.

    Remove the ID bot from the group when you are done if you do not need it there permanently.
  </Step>

  <Step title="Bot API getUpdates (no extra bots)">
    With your bot token, open this URL in a browser (replace `TOKEN` with your token):

    `https://api.telegram.org/botTOKEN/getUpdates`

    Send a test message in the chat you want to identify, refresh the page, and read `message.chat.id` (chat ID) and `message.from.id` (sender user ID) from the latest entry.

    <Warning>
      Treat the URL like a password — anyone with it can control your bot. Close the tab when finished and never share the link.
    </Warning>
  </Step>
</Steps>

<Tip>
  Alter's `/status` command shows the default action and whether a conversation is selected — it does **not** print user or chat IDs. Use the methods above when building an allowlist.
</Tip>

### Configure the allowlist in Alter

<Steps>
  <Step title="Collect IDs">
    Gather comma-separated user IDs, chat IDs, and/or `@usernames` for everyone (or every group) that should be able to use the bot.
  </Step>

  <Step title="Paste into Gateways settings">
    Open **Settings → Integrations → Gateways**, edit your Telegram gateway, and enter the values in **Allowed Telegram user or chat IDs** (for example `123456789, -1001234567890, @sam`).
  </Step>

  <Step title="Save and test">
    Click **Save and restart**. Message the bot from an allowed account or group — you should get a reply. Messages from IDs not on the list are ignored with no response.
  </Step>
</Steps>

### Security best practices

* **Treat the bot token like a password.** Store it only in Alter (Keychain). If it leaks, revoke it in [@BotFather](https://t.me/BotFather) with `/revoke` and paste the new token into Alter.
* **Use an allowlist for personal bots.** An empty allowlist means anyone who discovers your bot can message it while Alter is running.
* **Prefer numeric IDs over `@username`.** Usernames can change; numeric IDs are stable.
* **Limit group exposure.** Turn [Group Privacy](#step-3--optional-use-the-bot-in-a-group) on in BotFather unless the bot must read all group messages. Add only trusted groups, and allowlist the group chat ID if the bot is in multiple groups.
* **Be cautious with third-party ID bots.** They can see forwarded messages and group metadata. Remove them from sensitive groups when you no longer need them.

## Connect in Alter

<Steps>
  <Step title="Open Gateways settings">
    Open **Settings** (⌘,) → **Integrations** → **Gateways**.
  </Step>

  <Step title="Add a Telegram gateway">
    Click **Add gateway** → **Telegram**.
  </Step>

  <Step title="Fill in Connection fields">
    | Field                                 | What to enter                                                                                                                                   |
    | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Name**                              | A label you will recognize (for example `Telegram — Personal`).                                                                                 |
    | **Bot token**                         | The token from BotFather (**Step 1**).                                                                                                          |
    | **Allowed Telegram user or chat IDs** | Comma-separated user IDs, chat IDs, or `@usernames`. Leave empty to allow anyone who can message the bot. Use `*` to allow everyone explicitly. |

    A **Telegram gateway setup guide** link at the bottom of the Connection section opens this page in your browser.
  </Step>

  <Step title="Choose Default action">
    **Ask Anything** is the default and works on Telegram out of the box. For a custom action, set **Availability** to **Telegram** or **All** under **Action Editor → Gateways**.
  </Step>

  <Step title="Enable and save">
    Turn **Enabled** on, then click **Save and restart**. Wait for **Connected as @your\_bot\_username**.
  </Step>
</Steps>

If connection fails, see [Gateways troubleshooting](/apps-tools/gateways#troubleshooting).

## Test the bot

<Steps>
  <Step title="Confirm Alter is running">
    Gateways only work while Alter is open on your Mac.
  </Step>

  <Step title="Send /help">
    In your Telegram chat with the bot, send `/help`. The bot should list commands.
  </Step>

  <Step title="Send a message">
    Send a normal message. Alter should show **Thinking…**, then stream the reply. In private chats, Alter uses Telegram's native draft preview when available; otherwise it edits a regular message (rich replies can be up to about 32,000 characters).
  </Step>

  <Step title="Try buttons and /stop">
    Send `/help` and use the **New chat**, **Choose action**, or **Past chats** buttons. While Alter is responding in a group, tap **Stop** or send `/stop` to cancel the current turn.
  </Step>

  <Step title="Try attachments">
    Send a photo or document. Alter downloads supported attachments for the turn and can upload output files from tool runs when the action produces them.
  </Step>

  <Step title="Try voice messages">
    Send a **voice message** or audio file. Alter transcribes it with your selected voice processor (**Settings → Voice**) and sends the text to the active action. Audio-only messages work as chat turns even without typed text.
  </Step>
</Steps>

## Related pages

* [Gateways overview](/apps-tools/gateways)
* [Set up a Discord gateway](/apps-tools/gateways-discord)
* [Alter Actions — Gateway availability](/workflows/alter-actions#gateways)
* [Alter Settings](/how-to/settings-guide)