PHPackages                             mhsahebgharani/telegram-bot - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. mhsahebgharani/telegram-bot

ActiveProject[Framework](/categories/framework)

mhsahebgharani/telegram-bot
===========================

package for telegram bot with laravel

1.1.1(9mo ago)13MITPHP

Since Aug 3Pushed 9mo agoCompare

[ Source](https://github.com/MHSahebgharani/telegram-bot)[ Packagist](https://packagist.org/packages/mhsahebgharani/telegram-bot)[ RSS](/packages/mhsahebgharani-telegram-bot/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (5)Used By (0)

Telegram Bot
============

[](#telegram-bot)

A Laravel package for handling Telegram bot for channels and direct message webhooks and message strategies.

Features
--------

[](#features)

- Webhook handling for Telegram bots
- Strategy pattern for different message types (text, file, poll, base64, etc.)
- Easily extendable and configurable

Creating a Telegram Bot
-----------------------

[](#creating-a-telegram-bot)

Before you can use this package, you need to create a Telegram bot and obtain a bot token:

1. Open the Telegram app and search for the official bot called [@BotFather](https://t.me/BotFather).
2. Start a chat with BotFather and type the command: `/newbot`
3. Follow the prompts to choose a name and a username for your bot (the username must end with "bot", e.g., `mychannelhelperbot`).
4. After completing the steps, BotFather will provide you with an API token. It will look like: `123456789:ABCdefGhIJKlmNoPQRstuVWXyz`
5. **Keep this token safe!** You’ll need it to connect your code to your Telegram bot.

Once you have your token, you can proceed with the installation and configuration steps below.

Installation
------------

[](#installation)

Install via Composer:

```
composer require mhsahebgharani/telegram-bot
```

Usage
-----

[](#usage)

1. **Set your bot token and webhook URL in your `.env` file:**

    ```
    TELEGRAM_BOT_TOKEN=your-telegram-bot-token
    TELEGRAM_WEBHOOK_URL=https://yourdomain.com/api/telegram/webhook
    ```
2. **Set the webhook URL:**

    The package will read the webhook URL from your `.env` variable `TELEGRAM_WEBHOOK_URL`. Use the following artisan command to set your Telegram webhook URL:

    ```
    php artisan telegram:set-webhook
    ```

    This command will use the value of `TELEGRAM_WEBHOOK_URL` from your `.env` file.
3. Publish the config file (if using Laravel):

    ```
    php artisan vendor:publish --provider="TelegramBot\\TelegramServiceProvider"
    ```
4. Configure your Telegram bot token and webhook in `config/telegram.php` if needed.
5. Use the provided controllers and strategies to handle incoming messages.
6. **Test Route:**

    A test route is available at:

    ```
    POST /telegram/channel/post

    ```

    Use this route to test sending messages to your Telegram channel.

Webhook Handler
---------------

[](#webhook-handler)

The package provides a webhook endpoint to receive updates from Telegram. Make sure your webhook URL is set correctly in your `.env` file as `TELEGRAM_WEBHOOK_URL`.

- The default webhook route is: ```
    POST /telegram/webhook

    ```
- Telegram will send all updates (messages, commands, etc.) to this endpoint.
- You can customize the route in your Laravel routes file if needed.

**Testing the Webhook:**

- You can use tools like [ngrok](https://ngrok.com/) for local development to expose your local server to Telegram.
- Ensure your server is accessible via HTTPS, as Telegram requires a secure endpoint.

Commands Handler
----------------

[](#commands-handler)

The package includes an artisan command to set your Telegram webhook easily:

```
php artisan telegram:set-webhook
```

- This command uses the `TELEGRAM_WEBHOOK_URL` from your `.env` file to register your webhook with Telegram.
- Run this command whenever you change your webhook URL or bot token.

**Adding Custom Commands:**

- You can extend the package to handle custom Telegram commands by creating new command classes in the `Telegram\\Handlers\\Commands` namespace (for example, `app/Telegram/Handlers/Commands/MyCustomCommand.php`).
- **Each handler should implement the `TelegramHandlerInterface`.**
- After creating a new command, register it in the `commands` array in your `config/telegram.php` file to make it available to your bot.

**Sample Custom Command Handler:**

```