thiagolp90/slack

Send messages with Slack API.

dev-main 2022-01-07 16:08 UTC

Requires

• php: ^7.3|^8.0

MIT

• Thiago Lopes

README

Pacote Laravel para enviar mensagens instantâneas ou com delay via Slack API.

Instalação

composer require thiagolp90/slack

Configuração

Configure as variáveis de ambiente no arquivo .env com os dados de sua aplicação Slack (Sua aplicação precisa de ser configurada corretamente e ter as permissões necessárias para isto).

SLACK_TOKEN=XXXXXXXXX
SLACK_USERNAME=XXXXXXXXX

Faça a migração para poder salvar o histórico das mensagens enviadas e para poder enviar mensagens com delay.

php artisan migrate

Adicione no seu Scheduling Queued Job no arquivo app/Console/Kernel.php para enviar as mensagens com delay (Seu servidor precisa estar configurado para executar tarefas via crontab):

use Developes\Slack\Jobs\SendSlackNotifications;

//Dentro do método schedule adicione:
$schedule->job(new SendSlackNotifications)->everyMinute();

Para utilisar o método sendMessageWithConfirmButtons adicione a seguinte linha no seu arquivo app/Http/Middleware/VerifyCsrfToken.php, para receber a resposta do Webhook enviado pela Slack:

protected $except = [
    '/slack/webhook'
];

Não esqueça de modificar a Request Url nas configurações do seu aplicativo Slack em Interactivity para https://www.meusite.com/slack/webhook.

Como usar

use Developes\Slack\Facades\Slack;

//Enviar uma mensagem instantânea, SLACKID pode ser ou um ID de usuário como um canal (não esqueça de adicionar o seu aplicativo ao canal específico)
Slack::sendMessage('#meucanal', 'Test');

//Enviar uma mensagem em um horário específico, sendAt recebe como parametro um objeto Carbon
Slack::sendAt(now()->addMinutes(5))->sendMessage('SLACKID', 'Test with sendAt');

//Adicionar um tempo para o envio da sua mensagem, valor 'days' configurado por padrão
Slack::delayTo(2)->sendMessage('SLACKID', 'Test with delayTo (days)');
Slack::delayTo(30, 'minutes')->sendMessage('SLACKID', 'Test with delayTo (minutes)');
Slack::delayTo(4, 'hours')->sendMessage('SLACKID', 'Test with delayTo (hours)');
Slack::delayTo(6, 'months')->sendMessage('SLACKID', 'Test with delayTo (months)');

//Enviar uma mensagem com botões de confirmação
Slack::sendMessageWithConfirmButtons('SLACKID', "Voulez-vous confirmer cet action ?", ['Oui', 'Non']);