kononovspb/botman-viber-driver

BotMan 的 Viber 驱动程序

v1.0 2020-04-11 08:03 UTC

This package is auto-updated.

Last update: 2024-09-11 17:33:37 UTC


README

通过 BotMan 连接 Viber

安装 & 设置

首先,您需要将 Viber 驱动程序拖入。

composer require kononovspb/botman-viber-driver

然后,在创建 BotMan 实例之前加载驱动程序(仅当您不使用 BotMan Studio 时)

DriverManager::loadDriver(\Kononovspb\Drivers\Viber\ViberDriver::class);

// Create BotMan instance
BotManFactory::create($config);

此驱动程序需要有效的安全 URL 以设置 webhooks 并从聊天用户接收事件和信息。这意味着您的应用程序应通过 HTTPS URL 访问。

要连接 BotMan 与您的 Viber Bot,您首先需要遵循 官方指南 创建您的 Viber Bot 和访问令牌。

一旦您获得访问令牌,将其放在您的 .env 文件中,例如 VIBER_TOKEN=YOUR-VIBER-TOKEN-HERE。它将自动加载到您的 config/botman/viber.php 文件中。

如果您不使用 BotMan Studio,请将这些行添加到您从 BotManFactory 创建对象时传递的 $config 数组中。

'viber' => [
    'token' => 'YOUR-VIBER-TOKEN-HERE',
]

注册您的 Webhook

为了让您的 Viber Bot 了解如何与您的 BotMan Bot 进行通信,您必须将 BotMan 运行的 URL 注册到 Viber 上。

您可以通过向此 URL 发送 POST 请求来完成此操作

https://chatapi.viber.com/pa/set_webhook

此 POST 请求需要一个名为 url 的参数,该参数指向您的 BotMan 逻辑/控制器所在的 URL。如果您使用 BotMan Studio,它将是: https://yourapp.domain/botman。HTTPS 是必须的,出于安全原因。

{
   "url":"https://my.host.com",
   "event_types":[
      "delivered",
      "seen",
      "failed",
      "subscribed",
      "unsubscribed",
      "conversation_started"
   ],
   "send_name": true,
   "send_photo": true
}

您可以在 官方文档 中了解请求中的其他字段。

您可以使用控制台命令来注册您的 Webhook 而不是手动将请求发送到 Viber。

php artisan botman:viber:register