README

安装

此包可以通过Composer安装。

composer require mprince/laravel8-viber-bot

在Laravel 5.5及以上版本中，包将自动注册服务提供者。在Laravel 5.4中，您必须安装此服务提供者。

// config/app.php
'providers' => [
    ...
    Paragraf\ViberBot\ViberBotServiceProvider::class,
    ...
];

变更日志

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

配置

您需要在.env中设置并在webhook中进行设置。

环境变量

VIBERBOT_API=your_viber_token
VIBERBOT_NAME=name
VIBERBOT_PHOTO=photo

在Info标签页创建机器人后，您可以在Viber Partners上找到Viber令牌。

WebHook

您必须运行包含URL参数的artisan命令以运行webhook。

php artisan viber-bot:webhook https://example-url.com/some-route

注意：它必须是完整URL，并且必须是HTTPS。

配置文件

可选地，您可以使用此命令发布此包的配置文件

php artisan vendor:publish --provider="Paragraf\ViberBot\ViberBotServiceProvider"

以下配置文件将发布在config/viberbot.php中

用法

安装完成后，您将可以访问Bot和Client类。

Bot类

使用bot类，您可以导航ViberBot的工作方式。

(new Bot($request, new TextMessage()))
  ->on(new MessageEvent($request->timestamp, $request->message_token, 
  new ViberUser($request->sender['id'],$request->sender['name']), $request->message))
  ->hears("Hi!")
  ->replay("Hello World!")
  ->send();

注意：如果viber用户未设置name，您将得到错误。

您可以更改响应类型Message和Event，它监听该事件。

事件列表

ConversationStartedEvent
DeliveredEvent
FailedEvent
MessageEvent
SeenEvent
SubscribedEvent
UnsubscribedEvent

注意：如果您不想监听所有事件，您可以在config/viberbot.php中更改event_types。如果更改，您必须再次运行php artisan viber-bot:webhook your-url以应用更改。

消息列表

TextMessage
BroadcastMessage
ContactMessage
FileMessage
KeyboardMessage
LocationMessage
PictureMessage
StickerMessage
URLMessage
VideoMessage
WelcomeMessage
CarouselMessage - ToDo

Client类

Client类，为您提供额外的实用工具。

 (new Client())->broadcast('Hello', User::all(), 'viber_id');

注意：broadcast()中的$method必须指向viber_id。此外，getOnlineStatus()需要viber_ids。

如果您想了解更多关于Viber API或某些功能如何工作的信息，请查看Viber REST API

贡献

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

安全性

如果您发现任何与安全性相关的问题，请通过电子邮件nemanja.ivankovic@paragraf.rs联系，而不是使用问题跟踪器。

mprince / laravel8-viber-bot

维护者

详情