Telegram Driver

Install

To use the Telegram driver, you must first install the driver package via Composer:

$ composer require sequentsoft/threadflow-telegram

Obtain Your Telegram Bot Token

INFO

Official documentation: https://core.telegram.org/bots/tutorial#getting-ready

Each bot has a unique token which can also be revoked at any time via @BotFather.

Obtaining a token is as simple as contacting @BotFather, issuing the /newbot command and following the steps until you're given a new token. You can find a step-by-step guide here.

Your token will look something like this:

4839574812:AAFD39kkdpWt3ywyRZergyOLMaJhac60qc

Make sure to save your token in a secure place, treat it like a password and don't share it with anyone.

Configuration

The corresponding parameters for the driver must be configured in the .env file.

TELEGRAM_API_TOKEN="your-token-here"
TELEGRAM_WEBHOOK_SECRET="random-string-to-verify-webhook-requests"

Webhook setup

To start a bot using a webhook, you need to configure the webhook URL in the Telegram API.

First, you need to set up a route to handle incoming messages from Telegram. You can change the route to any other route you want.

Route::post(
    '/thread-flow/webhook/telegram',
    \SequentSoft\ThreadFlowTelegram\Laravel\Controllers\WebhookHandleController::class
)->name('threadflow.telegram.webhook');

Artisan Commands

The driver provides several Artisan commands to help you manage your bot.

Long Polling

Long polling is the simplest way to start a bot. You just need to run the command:

$ php artisan threadflow:telegram-polling --channel=my-telegram-channel

Set Webhook

To set the webhook URL for your bot, use the threadflow:telegram-webhook-set command:

$ php artisan threadflow:telegram-webhook-set --channel=my-telegram-channel

Remove Webhook

To remove the webhook URL for your bot, use the threadflow:telegram-webhook-remove command:

$ php artisan threadflow:telegram-webhook-remove --channel=my-telegram-channel

Get Webhook Info

To get the webhook info for your bot, use the threadflow:telegram-webhook-info command:

$ php artisan threadflow:telegram-webhook-info --channel=my-telegram-channel