README

这是一个 Botman 的 WhatsApp 驱动程序，用于与 WhatsApp 进行通信。该驱动程序允许创建用于 WhatsApp 的聊天机器人，发送和接收消息，管理对话并保持与用户的会话状态。

要求

在使用此驱动程序之前，您必须拥有以下内容：

访问 WhatsApp API 的凭证
PHP 8.0 或更高版本
Botman 2.6

安装

要安装此驱动程序，只需在终端执行以下命令

composer require booster-api/driver-whatsapp

配置

要使用此驱动程序，您需要将以下配置添加到您的 config/botman/whatsapp-web.php 文件中

return [

    /*
    |--------------------------------------------------------------------------
    | Whatsapp Token
    |--------------------------------------------------------------------------
    |
    | Your Whatsapp bot token you received after creating
    | the chatbot through Whatsapp.
    |
    */
    'secret' => env('WHATSAPP_SECRET'),
    'url' => env('WHATSAPP_URL'),
    'api_key' => env('WHATSAPP_API_KEY'),
];

WHATSAPP_SECRET：是用于验证发送到您的 WhatsApp 实例的请求的密钥。此密钥应在 WhatsApp 开发者控制台中定义。
WHATSAPP_URL：是接收 WhatsApp 请求的 WhatsApp 实例的 URL。此 URL 也应在 Admin Booster API 的开发者控制台中定义。
WHATSAPP_API_KEY：是用于验证发送到 Booster API 的请求的 API 密钥。您应生成此密钥并可用于验证请求是否来自您的集成。

以下是如何在 .env 文件中定义这些配置变量的示例

WHATSAPP_SECRET=your_webhook_secret
WHATSAPP_URL=https://api.booster-api.com
WHATSAPP_API_KEY=your_api_key

使用

要使用此驱动程序，只需创建一个新的 Botman 实例并按以下方式设置对话路由

use BotMan\BotMan\BotMan;
use BotMan\BotMan\BotManFactory;
use BotMan\BotMan\Drivers\DriverManager;

$config = [
    'secret' => 'WHATSAPP_SECRET',
    'url' => 'WHATSAPP_URL',
    'api_key' => 'WHATSAPP_API_KEY',
];

DriverManager::loadDriver(BoosterAPI\Whatsapp\Driver\WhatsappWebDriver::class);

$botman = BotManFactory::create($config);

$botman->hears('oi', function (BotMan $bot) {
    $bot->reply('Olá! Como posso ajudar?');
});

$botman->listen();

此示例定义了一个响应“嗨”消息的问候消息的路由。

有关如何使用 Botman 的更多信息，请参阅官方文档：https://botman.io/2.0/getting-started

功能

Botman WhatsApp 驱动程序可以发送的消息类型列表

文本：简单的文本消息
图片：带图片的消息（JPEG 或 PNG）
音频文件：音频消息（MP3 或 AAC）
视频：带视频的消息（MP4）
位置：带有发送者位置的消息
联系人：带有联系信息的消息（姓名和电话号码）
文档：带有附件的消息（PDF、DOCX、XLSX）
系统消息：WhatsApp 发送的消息，如交付通知、阅读和其他状态信息。

贡献

如果您想为此驱动程序做出贡献，请随时发送拉取请求或打开新的问题。您的帮助非常受欢迎！

booster-api / driver-whatsapp

维护者

详细信息

README

要求

安装

配置

使用

功能

贡献