mihakot/notification-telegram

Laravel Telegram 通知通道

v0.2.5 2023-10-29 10:41 UTC

This package is auto-updated.

Last update: 2024-09-29 12:43:54 UTC


README

pipeline status Latest Version on Packagist Software License Total Downloads

[目录]

配置

安装包

通过 composer 安装包

composer require mihakot/notification-telegram

如有需要,可以发布配置文件

@php artisan vendor:publish --vendor NotificationChannels\Telegram\TelegramServiceProvider

配置您的 Telegram 机器人

通过 @BotFather 注册机器人并获取 Bot API Token。

然后在其应用程序的 .env 文件中配置它

TELEGRAM_API_TOKEN={YOUR_API_TOKEN}

此变量在配置文件中使用,但在调用方法时也可以使用其他值。

\NotificationChannels\Telegram\Telegram::message()
->setToken('ВАШ_ТОКЕН')

获取 Chat ID

发送通知需要知道 Chat ID。

可以通过 webhook 或通过 Telegram::updates() 获取。

使用

现在可以在 Notification 类的 via() 方法中使用 telegram 通道。

# пример использования

use Illuminate\Notifications\Notification;

class NotifyUser extends Notification
{
    public function via($notifiable)
    {
        return ["telegram"];
    }

    public function toTelegram($notifiable)
    {
        return \NotificationChannels\Telegram\Telegram::message()
            // Получатель
            ->to($notifiable->telegram_chat_id)
            ->content("Hello there!")
            ->line("Your are welcome!")
            ->line("Thank you!")
    }
}

公共方法

// установка токена
->setToken() 

// установка адреса api
->setApiBaseUri() 
 
// получатель события
->to()

// добавление кнопки с действием к сообщению
->button()

// добавление дополнительных опций
->options() 

获取最新的数据

\NotificationChannels\Telegram\Telegram::updates()
->get() 

可用方法

Telegram API getUpdates

# количество получаемых событий 
->limit()

# получаемые события, номер последнего получаемого события (последнее полученное + 1)  
->latest()

# получить события
->get()

发送消息

\NotificationChannels\Telegram\Telegram::message()
->to('Chat ID')
->content('YOUR_MESSAGE')
->send() 

可用方法

# текст уведомления
->content()

# добавление строки к уведомлению 
->line()

# добавление экранированной строки к уведомлению
->escapedLine()

# добавление blade шаблона в качестве уведомления
->view()

# отправка сообщения
->send()

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件 mihakot@gmail.com 而不是使用问题跟踪器。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 以获取更多信息。