Este é um Driver do Botman para se comunicar com o WhatsApp. O Driver permite criar chatbots para o WhatsApp, enviando e recebendo mensagens, gerenciando conversas e mantendo o estado da conversa com o usuário.
Antes de usar este Driver, você deve ter:
Uma conta no Booster API
- Credenciais para acessar a API do WhatsApp
- PHP 8.0 ou superior
- Botman 2.6
Para instalar este Driver, basta executar o seguinte comando no terminal:
composer require booster-api/driver-whatsapp
Para usar este Driver, você precisa adicionar as seguintes configurações ao seu arquivo 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
: é a chave secreta usada para autenticar as solicitações enviadas para o seu instancia do Whatsapp. Esta chave deve ser definida no console de desenvolvimento do WhatsApp. -
WHATSAPP_URL
: é a URL da instancia do Whatsapp que recebe as solicitações do WhatsApp. Esta URL também deve ser definida no console de desenvolvimento no Admin Booster API. -
WHATSAPP_API_KEY
: é a chave de API usada para autenticar as solicitações enviadas para a API do Booster API. Esta chave deve ser gerada por você e pode ser usada para verificar se a solicitação veio da sua integração.
Aqui está um exemplo de como definir essas variáveis de configuração em um arquivo .env
:
WHATSAPP_SECRET=your_webhook_secret
WHATSAPP_URL=https://api.booster-api.com
WHATSAPP_API_KEY=your_api_key
Para usar este Driver, basta criar uma nova instância do Botman e definir as rotas de conversação da seguinte maneira:
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();
Este exemplo define uma rota que responde à mensagem 'oi' com uma mensagem de saudação.
Para mais informações sobre como usar o Botman, consulte a documentação oficial: https://botman.io/2.0/getting-started
lista de tipos de mensagens que podem ser enviadas usando o Driver do Botman para o WhatsApp:
- Texto: mensagens de texto simples
- Imagens: mensagens com imagens (JPEG ou PNG)
- Arquivos de áudio: mensagens de áudio (MP3 ou AAC)
- Vídeos: mensagens com vídeos (MP4)
- Localização: mensagens com a localização do remetente
- Contatos: mensagens com informações de contato (nome e número de telefone)
- Documentos: mensagens com documentos anexados (PDF, DOCX, XLSX)
- Mensagens de sistema: mensagens que o WhatsApp envia, como notificações de entrega, leitura e outras informações de status.
Se você quiser contribuir com este Driver, sinta-se à vontade para enviar um pull request ou abrir uma nova issue. Sua ajuda é muito bem-vinda!