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.

Before you begin

Collect the agent, account and host access.

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.

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:

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.

Run the relay

Configure and host the supplied executable example.

Use the configuration file 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.

1

Download and configure the relay

On a Linux host you administer, create /opt/voiceflow-messaging and extract the relay archive 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 installed:

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.

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.

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:

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.

Route conversations and replies

Keep the customer, agent session and reply destination aligned.

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.

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. 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.

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, then repeat the platform test.

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 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 for a temporary conversation-specific pause.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.