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

# Connect a Voiceflow agent to Telegram

> Connect Telegram to a Voiceflow text agent. Configure the platform, host the relay, test replies and prepare release.

## Overview

Answer private Telegram messages with a Voiceflow agent through a bot you create with BotFather. The supplied HTTPS relay receives updates and sends text back to the same private chat.

<a id="before-you-begin"></a>

## Before you begin

Collect the agent, account and host access.

| Requirement | Obtain before installation |
| --- | --- |
| Voiceflow owner | An existing agent with a known support answer, a private project API key, project ID and reviewed Environment alias. [Build the agent](/docs/documentation/build/overview) first, then [publish the intended release](/docs/documentation/deploy/environments/publishing). |
| Bot owner | A Telegram account that can create and manage a bot in BotFather. |
| Customer entry | The bot username or `https://t.me/YOUR_BOT_USERNAME`; each customer must open the bot and start the chat. |
| Relay operator | A Node.js host, public HTTPS hostname, private secrets and persistent disk; an operator who can investigate paused conversations. |

The example provides public-policy text support. Keep private Voiceflow and platform credentials on the host; a customer’s messaging identity does not authorize access to orders or account records. Have the agent return text only and provide a support route in its instructions. Buttons, audio and Handoff traces need additional adapters; see [Adapt agent replies](/docs/guides/channels/messaging/adapt-agent-replies).

<a id="create-platform-app"></a>

## Prepare the platform account

Create the exact app or account this relay will use.

### 1. Create the bot

In Telegram, open the verified **@BotFather** account, send `/newbot` and follow its name and username prompts. Copy the token into the relay’s secret configuration. Use a separate bot for testing.

### 2. Confirm the bot identity

Save the following as `identity.mjs` beside the relay and run `node --env-file=.env identity.mjs` after setting the token:

```js
import { request } from './core.mjs';
const e = process.env;
const result = await request(
  `https://api.telegram.org/bot${e.TELEGRAM_BOT_TOKEN}/getMe`,
  { method: 'GET' }
);
console.log({ id: result.result.id, username: result.result.username });
```

Set `TELEGRAM_BOT_ID` to the returned ID. Generate a separate webhook secret containing only letters, digits, underscores or hyphens. It authenticates incoming requests; it is not the bot token.

<a id="run-relay"></a>

## Run the relay

Configure and host the supplied executable example.

Use the [configuration file](/docs/examples/messaging/telegram.env.example) for this platform. Every name below is read by the supplied artifact; IDs identify the resources prepared above. `VF_ENVIRONMENT` is the Environment alias, not a version label pasted from another project.

```dotenv
VF_API_KEY=YOUR_PRIVATE_VOICEFLOW_PROJECT_KEY
VF_PROJECT_ID=YOUR_VOICEFLOW_PROJECT_ID
VF_ENVIRONMENT=YOUR_ENVIRONMENT_ALIAS
DATA_DIR=/var/lib/voiceflow-messaging
PORT=8080
PLATFORM=telegram
TELEGRAM_BOT_TOKEN=YOUR_BOTFATHER_TOKEN
TELEGRAM_BOT_ID=YOUR_NUMERIC_BOT_ID
TELEGRAM_WEBHOOK_SECRET=YOUR_RANDOM_URL_SAFE_SECRET
```

### 1. Download and configure the relay

On a Linux host you administer, create `/opt/voiceflow-messaging` and extract the [relay archive](/docs/examples/messaging/messaging-relay.zip) there. Use Node.js 22.12 or later. Run `node --test fixtures.test.mjs` first: it generates signed synthetic events and mocks all remote calls, without credentials or live messages. Save the configuration above as `.env`, replacing every `YOUR_` value; restrict it to the service account with `chmod 600 .env`. Set `DATA_DIR` to a private persistent directory that this account can write.

The archive includes `core.mjs`, platform adapters, HTTP/Teams entry points, local fixture tests and a package manifest. Run `node --env-file=.env relay.mjs serve`. The HTTP relay uses only Node built-ins; it does not need `npm install`.

### 2. Expose the HTTPS endpoint

Point your own DNS hostname to the host. Terminate HTTPS with a valid public certificate and proxy to `127.0.0.1:8080`. For example, with [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) installed:

```sh
caddy reverse-proxy --from support.example.com --to 127.0.0.1:8080
```

Replace the example hostname, allow inbound 80/443 for certificate provisioning and keep the relay port private. Use a separate hostname and credentials for testing. Confirm `https://YOUR_HOST/health` returns `ok` before registering `/webhook`.

### 3. Keep one process running

After the foreground check, stop it and create a service using the unit below. Keep one process and one writable data directory per installation. Do not run this file store on ephemeral serverless storage or start multiple replicas.

```ini
# /etc/systemd/system/voiceflow-messaging.service
[Unit]
Description=Voiceflow messaging relay
After=network-online.target

[Service]
User=relay
WorkingDirectory=/opt/voiceflow-messaging
ExecStart=/usr/bin/node --env-file=.env relay.mjs serve
Restart=on-failure
UMask=0077

[Install]
WantedBy=multi-user.target
```

Create the non-login `relay` service user, give it read access to the application and `.env`, and ownership of `/var/lib/voiceflow-messaging`. Confirm `/usr/bin/node --version` is 22.12 or later, or substitute your actual Node path. Then run `sudo systemctl daemon-reload` and `sudo systemctl enable --now voiceflow-messaging`. Expect the service to stay active; keep the HTTPS proxy running through its own service.

The file store is a small single-process starting point. Back it up privately and monitor disk space, queue age and failures. Higher traffic needs a transactional inbox/outbox and per-conversation workers before adding replicas. Session keys and customer text are stored in the data directory; apply your retention and access policy there as well as in Voiceflow.

<a id="register-events"></a>

## Register incoming events

Connect the platform to your hosted endpoint.

Save this as `register.mjs`, set `PUBLIC_URL=https://YOUR_HOST` in `.env`, and run `node --env-file=.env register.mjs`:

```js
import { request } from './core.mjs';
const e = process.env;
const base = `https://api.telegram.org/bot${e.TELEGRAM_BOT_TOKEN}`;
console.log(await request(`${base}/setWebhook`, { body: {
  url: `${e.PUBLIC_URL}/webhook`,
  secret_token: e.TELEGRAM_WEBHOOK_SECRET,
  allowed_updates: ['message'],
  max_connections: 1
} }));
console.log(await request(`${base}/getWebhookInfo`, { method: 'GET' }));
```

Expect `ok: true` and your callback URL in `getWebhookInfo`. The relay checks `X-Telegram-Bot-Api-Secret-Token` before accepting updates. Use valid HTTPS on a supported webhook port; an ordinary public host on 443 is simplest. Polling with `getUpdates` cannot run while the webhook is installed. See the [Bot API](https://core.telegram.org/bots/api#setwebhook).

<a id="conversation-routing"></a>

## Route conversations and replies

Keep the customer, agent session and reply destination aligned.

| Stage | Mapping in the example |
| --- | --- |
| Customer identity | Bot ID + private chat ID + sender ID; group and channel posts are filtered out. |
| Incoming text | `message.text` on a private `message` update; `/start` is ordinary text for this example. |
| Visible reply | `sendMessage` with the inbound `chat.id`; no parse mode is set. |
| Duplicate | Deduplicate `update_id`; edited messages and callback queries are not subscribed. |

The relay hashes platform, destination account, customer/thread, project and Environment into a bounded Voiceflow `userID`. It creates a session with the private project key, stores the returned `sessionKey`, launches once, then sends `{ action: { type: "text", payload: text } }` to `/v4/interact`. Text traces become platform replies. Follow-ups reuse the key; starting a session every message would reset the conversation.

A bot cannot start a private conversation with a person who has never contacted it. This example accepts private chats only, so group privacy settings do not change its behavior. It does not implement Telegram Business connected accounts or topics.

Telegram retries unsuccessful webhook deliveries; update IDs make retries idempotent at the relay. The Bot API’s 4096-character text limit is respected through smaller chunks. A blocked bot, revoked token or `429` response pauses the conversation; inspect `getWebhookInfo.last_error_message` and the failed job before recovery. An API success does not provide a read receipt.

<a id="test-conversation"></a>

## Test a customer conversation

Verify the reply in the destination you installed.

### 1. Send a real platform message

Open the bot’s `t.me` link, choose **Start**, and send your prepared question. Expect a text answer in that private chat.

### 2. Check continuity and isolation

Ask a related follow-up, then test with a second authorized customer. Confirm the intended Voiceflow project and exchange in [Transcripts](/docs/documentation/measure/transcripts). Run `node --env-file=.env relay.mjs inspect` while the service is stopped to compare event IDs, conversation keys and completion states without printing session tokens.

### 3. Check this platform’s delivery behavior

Message the bot from a second Telegram account, then run the included signed-fixture tests. The second person must have separate memory and the replay must not create a second agent turn.

A saved callback, accepted API request or successful Voiceflow Run does not prove this platform conversation. Keep local signed-fixture tests separate from this authenticated customer test.

<a id="troubleshooting" />

### The callback saves but no reply arrives

Check platform access as well as endpoint connectivity.

Inspect `getWebhookInfo` for a wrong URL, pending count or last error. Confirm the webhook secret matches and that no polling worker is consuming updates. A `403` send commonly means the user has blocked the bot.

### A conversation is paused or a reply is duplicated

Reconcile remote effects before resuming the saved job.

Inspect the event’s `phase`, `failedDuring`, saved traces and accepted chunks in the private data file. A runtime timeout can occur after a tool action; a send timeout can occur after the platform accepted the message. The sample pauses that conversation and does not retry either effect automatically. Follow [Recover failed messages](/docs/guides/channels/messaging/recover-failed-messages), then repeat the platform test.

<a id="go-live"></a>

## Release and maintain the connection

Promote the tested route and keep recovery available.

### 1. Approve the production destination

Use the production bot token and username, register its HTTPS webhook and test from a second authorized Telegram account. Telegram has no Meta-style Page App Review for this ordinary bot; bot availability and rate limits still apply.

### 2. Release the reviewed agent

Have the Voiceflow owner publish the tested agent to the intended Environment. Deploy that alias and production credentials to the relay, restart its service and repeat the [customer test](#test-conversation) with a fresh customer/session. Existing session keys are not an automatic migration to a new release. Keep the previous deployment and state backup available for rollback.

### Rotate, update or disconnect

Maintain both the provider registration and the relay state.

Stop the service before changing `.env` or running maintenance commands. Rotate the platform credentials using its administrator controls, update the secret file and restart. If a webhook secret changes, update both sides and check a real event. For a release change, drain or reconcile pending jobs first; do not erase the state file to resolve a delivery problem.

To disconnect, disable/remove this callback or uninstall this app in the provider, stop the relay and revoke its unused credentials. Confirm no new events arrive and retain/delete customer state according to your policy. Keep the registration details needed to reconnect. See [Pause automated replies](/docs/guides/channels/messaging/pause-automated-replies) for a temporary conversation-specific pause.
