Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmiseev/laravel-telegram-notification
Telegram Notifications for Laravel 5.5
https://github.com/dmiseev/laravel-telegram-notification
bot-api laravel notifications telegram-notification
Last synced: about 1 month ago
JSON representation
Telegram Notifications for Laravel 5.5
- Host: GitHub
- URL: https://github.com/dmiseev/laravel-telegram-notification
- Owner: dmiseev
- License: mit
- Created: 2018-01-11T21:19:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-09T10:33:09.000Z (almost 7 years ago)
- Last Synced: 2024-04-05T14:41:57.850Z (9 months ago)
- Topics: bot-api, laravel, notifications, telegram-notification
- Language: PHP
- Homepage:
- Size: 11.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Notifications for Laravel 5.6
This package makes it easy to send Telegram notification using [Telegram Bot API](https://core.telegram.org/bots) with Laravel 5.5.
## Installation
You can install the package via composer:
``` bash
composer require dmiseev/laravel-telegram-notification
```
## Setting up your Telegram Bot
Talk to [@BotFather](https://core.telegram.org/bots#6-botfather) and generate a Bot API Token.
Then, configure your Telegram Bot API Token:
```php
// config/services.php
...
'telegram' => [
'token' => env('TELEGRAM_TOKEN', 'YOUR BOT TOKEN HERE')
],
...
```
## Usage
You can now use the channel in your `via()` method inside the Notification class.
``` php
use Dmiseev\TelegramNotification\TelegramChannel;
use Dmiseev\TelegramNotification\TelegramMessage;
use Illuminate\Notifications\Notification;
class WithdrawCreate extends Notification
{
/**
* @var Withdraw
*/
private $withdraw;
/**
* @var User
*/
private $user;
/**
* @param Withdraw $withdraw
*/
public function __construct(Withdraw $withdraw, User $user)
{
$this->withdraw = $withdraw;
$this->user = $user;
}
public function via($notifiable)
{
return [TelegramChannel::class];
}
public function toTelegram($notifiable)
{
return TelegramMessage::create()
->to($this->user->telegram_user_id)
->content("*HI!* \n One of your withdraws has been created!")
->button('View Withdraw', url('/withdraws/' . $this->withdraw->id));
}
}
```
### Routing a message
You can either send the notification by providing with the chat id of the recipient to the `to($chatId)` method like shown in the above example or add a `routeNotificationForTelegram()` method in your notifiable model:
``` php
...
/**
* @return int
*/
public function routeNotificationForTelegram()
{
return $this->telegram_user_id;
}
...
```
### Available Message methods
- `to($chatId)`: (integer) Recipient's chat id.
- `content('')`: (string) Notification message, supports markdown. For more information on supported markdown styles, check out these [docs](https://telegram-bot-sdk.readme.io/docs/sendmessage#section-markdown-style).
- `button($text, $url)`: (string) Adds an inline "Call to Action" button. You can add as many as you want and they'll be placed 2 in a row.
- `options([])`: (array) Allows you to add additional or override `sendMessage` payload (A Telegram Bot API method used to send message internally). For more information on supported parameters, check out these [docs](https://telegram-bot-sdk.readme.io/docs/sendmessage).
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.