https://github.com/symfony/telegram-notifier

Symfony Telegram Notifier Bridge
https://github.com/symfony/telegram-notifier

component notifier php symfony symfony-component telegram

Last synced: about 2 months ago
JSON representation

Symfony Telegram Notifier Bridge

• Host: GitHub
• URL: https://github.com/symfony/telegram-notifier
• Owner: symfony
• License: mit
• Created: 2019-10-05T11:56:54.000Z (over 6 years ago)
• Default Branch: 7.3
• Last Pushed: 2025-12-19T08:39:26.000Z (3 months ago)
• Last Synced: 2025-12-22T02:52:31.319Z (3 months ago)
• Topics: component, notifier, php, symfony, symfony-component, telegram
• Language: PHP
• Homepage: https://symfony.com/notifier
• Size: 206 KB
• Stars: 72
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Telegram Notifier

=================

Provides [Telegram](https://telegram.org) integration for Symfony Notifier.

DSN example

-----------

```

TELEGRAM_DSN=telegram://TOKEN@default?channel=CHAT_ID

```

where:

 - `TOKEN` is your Telegram token

 - `CHAT_ID` is your Telegram chat id

Adding Interactions to a Message

--------------------------------

With a Telegram message, you can use the `TelegramOptions` class to add

[message options](https://core.telegram.org/bots/api).

```php

use Symfony\Component\Notifier\Bridge\Telegram\Reply\Markup\Button\InlineKeyboardButton;

use Symfony\Component\Notifier\Bridge\Telegram\Reply\Markup\InlineKeyboardMarkup;

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('');

// Create Telegram options

$telegramOptions = (new TelegramOptions())

    ->chatId('@symfonynotifierdev')

    ->parseMode('MarkdownV2')

    ->disableWebPagePreview(true)

    ->disableNotification(true)

    ->replyMarkup((new InlineKeyboardMarkup())

        ->inlineKeyboard([

            (new InlineKeyboardButton('Visit symfony.com'))

                ->url('https://symfony.com/'),

        ])

    );

// Add the custom options to the chat message and send the message

$chatMessage->options($telegramOptions);

$chatter->send($chatMessage);

```

Adding files to a Message

-------------------------

With a Telegram message, you can use the `TelegramOptions` class to add

[message options](https://core.telegram.org/bots/api).

> :warning: **WARNING**

In one message you can send only one file

[Telegram supports 3 ways](https://core.telegram.org/bots/api#sending-files) for passing files:

 * You can send files by passing public http url to option:

   * Photo

     ```php

     $telegramOptions = (new TelegramOptions())

          ->photo('https://localhost/photo.mp4');

     ```

   * Video

     ```php

     $telegramOptions = (new TelegramOptions())

          ->video('https://localhost/video.mp4');

     ```

   * Animation

     ```php

     $telegramOptions = (new TelegramOptions())

          ->animation('https://localhost/animation.gif');

     ```

   * Audio

     ```php

     $telegramOptions = (new TelegramOptions())

          ->audio('https://localhost/audio.ogg');

     ```

   * Document

     ```php

     $telegramOptions = (new TelegramOptions())

          ->document('https://localhost/document.odt');

     ```

   * Sticker

     ```php

     $telegramOptions = (new TelegramOptions())

          ->sticker('https://localhost/sticker.webp', '🤖');

     ```

 * You can send files by passing local path to option, in this case file will be sent via multipart/form-data:

    * Photo

      ```php

      $telegramOptions = (new TelegramOptions())

           ->uploadPhoto('files/photo.png');

      ```

    * Video

      ```php

      $telegramOptions = (new TelegramOptions())

           ->uploadVideo('files/video.mp4');

      ```

    * Animation

      ```php

          $telegramOptions = (new TelegramOptions())

               ->uploadAnimation('files/animation.gif');

      ```

    * Audio

      ```php

      $telegramOptions = (new TelegramOptions())

           ->uploadAudio('files/audio.ogg');

      ```

    * Document

      ```php

      $telegramOptions = (new TelegramOptions())

           ->uploadDocument('files/document.odt');

      ```

    * Sticker

      ```php

      $telegramOptions = (new TelegramOptions())

           ->uploadSticker('files/sticker.webp', '🤖');

      ```

 * You can send files by passing file_id to option:

   * Photo

     ```php

     $telegramOptions = (new TelegramOptions())

          ->photo('ABCDEF');

     ```

   * Video

     ```php

     $telegramOptions = (new TelegramOptions())

          ->video('ABCDEF');

     ```

   * Animation

     ```php

     $telegramOptions = (new TelegramOptions())

          ->animation('ABCDEF');

     ```

   * Audio

     ```php

     $telegramOptions = (new TelegramOptions())

          ->audio('ABCDEF');

     ```

   * Document

     ```php

     $telegramOptions = (new TelegramOptions())

          ->document('ABCDEF');

     ```

   * Sticker - *Can't be sent using file_id*

Full example:

```php

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('Photo Caption');

// Create Telegram options

$telegramOptions = (new TelegramOptions())

    ->chatId('@symfonynotifierdev')

    ->parseMode('MarkdownV2')

    ->disableWebPagePreview(true)

    ->hasSpoiler(true)

    ->protectContent(true)

    ->photo('https://symfony.com/favicons/android-chrome-192x192.png');

// Add the custom options to the chat message and send the message

$chatMessage->options($telegramOptions);

$chatter->send($chatMessage);

```

Adding Location to a Message

----------------------------

With a Telegram message, you can use the `TelegramOptions` class to add

[message options](https://core.telegram.org/bots/api).

```php

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('');

// Create Telegram options

$telegramOptions = (new TelegramOptions())

    ->chatId('@symfonynotifierdev')

    ->parseMode('MarkdownV2')

    ->location(48.8566, 2.3522);

// Add the custom options to the chat message and send the message

$chatMessage->options($telegramOptions);

$chatter->send($chatMessage);

```

Adding Venue to a Message

----------------------------

With a Telegram message, you can use the `TelegramOptions` class to add

[message options](https://core.telegram.org/bots/api).

```php

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('');

// Create Telegram options

$telegramOptions = (new TelegramOptions())

    ->chatId('@symfonynotifierdev')

    ->parseMode('MarkdownV2')

    ->venue(48.8566, 2.3522, 'Center of Paris', 'France, Paris');

// Add the custom options to the chat message and send the message

$chatMessage->options($telegramOptions);

$chatter->send($chatMessage);

```

Adding Contact to a Message

----------------------------

With a Telegram message, you can use the `TelegramOptions` class to add

[message options](https://core.telegram.org/bots/api).

```php

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('');

$vCard = 'BEGIN:VCARD

VERSION:3.0

N:Doe;John;;;

FN:John Doe

EMAIL;type=INTERNET;type=WORK;type=pref:johnDoe@example.org

TEL;type=WORK;type=pref:+330186657200

END:VCARD';

// Create Telegram options

$telegramOptions = (new TelegramOptions())

    ->chatId('@symfonynotifierdev')

    ->parseMode('MarkdownV2')

    ->contact('+330186657200', 'John', 'Doe', $vCard);

// Add the custom options to the chat message and send the message

$chatMessage->options($telegramOptions);

$chatter->send($chatMessage);

```

Updating Messages

-----------------

The `TelegramOptions::edit()` method was introduced in Symfony 6.2.

When working with interactive callback buttons, you can use the `TelegramOptions`

to reference a previous message to edit.

```php

use Symfony\Component\Notifier\Bridge\Telegram\Reply\Markup\Button\InlineKeyboardButton;

use Symfony\Component\Notifier\Bridge\Telegram\Reply\Markup\InlineKeyboardMarkup;

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('Are you really sure?');

$telegramOptions = (new TelegramOptions())

    ->chatId($chatId)

    ->edit($messageId) // extracted from callback payload or SentMessage

    ->replyMarkup((new InlineKeyboardMarkup())

        ->inlineKeyboard([

            (new InlineKeyboardButton('Absolutely'))->callbackData('yes'),

        ])

    );

```

Answering Callback Queries

--------------------------

The `TelegramOptions::answerCallbackQuery()` method was introduced in Symfony 6.3.

When sending message with inline keyboard buttons with callback data, you can use

`TelegramOptions` to [answer callback queries](https://core.telegram.org/bots/api#answercallbackquery).

```php

use Symfony\Component\Notifier\Bridge\Telegram\TelegramOptions;

use Symfony\Component\Notifier\Message\ChatMessage;

$chatMessage = new ChatMessage('Thank you!');

$telegramOptions = (new TelegramOptions())

    ->chatId($chatId)

    ->answerCallbackQuery(

        callbackQueryId: '12345', // extracted from callback

        showAlert: true,

        cacheTime: 1,

    );

```

Resources

---------

 * [Contributing](https://symfony.com/doc/current/contributing/index.html)

 * [Report issues](https://github.com/symfony/symfony/issues) and

   [send Pull Requests](https://github.com/symfony/symfony/pulls)

   in the [main Symfony repository](https://github.com/symfony/symfony)