README

Sobre Alobot

Esse pacote foi criado com o intuito de facilitar o envio de mensagens pelos módulos AGAPE.

Com ele é possível realizar o envio de textos, imagens e arquivos para as redes sociais Whatsapp e Telegram.

O que fazer depois de importar o pacote

Logo depois de realizar a importação do pacote alobot, é necessário que o comando publish seja realizado para importar o arquivo de configuração para o projeto.

php artisan vendor:publish --provider="Agp\Alobot\AgpAlobotServiceProvider" --tag=config

O segundo passo é setar as variáveis que são utilizadas nesse arquivo de configuração importado para o pacote no .env.

ALOBOT_API= value
ALOBOT_ID_INTEGRACAO= value
ALOBOT_TOKEN= value

E está pronto, siga as instruções agora de como utilizá-lo!

Como usar o pacote

Primeiramente você precisa criar uma instância de Alobot.

Logo depois, utilize o método send da instância Alobot e passe as classes AlobotMensagemTexto caso queira enviar um texto ou AlobotMensagemDocumento caso queira enviar um arquivo ou uma imagem.

    $alobot = new Alobot();
    
    /**
    * @param string $numero
    * @param string $texto
    * @param UploadedFile|base64 $file
    */
    $alobot->send([
        new AlobotMensagemTexto($numero, $texto),
        new AlobotMensagemDocumento(AlobotMensagemDocumento::TP_ARQUIVO, $numero, $file),
        new AlobotMensagemDocumento(AlobotMensagemDocumento::TP_IMAGEM, $numero, $file)
    ]);

Alobot

Ao instanciar essa classe, em seu construtor são setados o token e o identificador da integração que serão utilizados na requisição. Essas informações devem ser informadas no arquivo .env e o arquivo de configuração alobot.php deve estar adicionado em seu projeto, sendo ele idêntico ao do pacote alobot.

     $alobot = new Alobot();

AlobotMensagemTexto

Os parâmetros solicitados por essa classe são somente o texto da mensagem e o número de telefone para o qual ela será enviada.

    /**
    * @param string $numero
    * @param string $texto
    */
    $alobot->send([
        new AlobotMensagemTexto($numero, $texto)
    ]);

AlobotMensagemDocumento

Os parâmetros solicitados por essa classe são o tipo do documento, o número de telefone e o arquivo que será enviado.

Atenção: Os formatos que são aceitos para o $file são somente um objeto UploadedFile ou uma string em base64.

    /**
    * @param string $numero
    * @param UploadedFile|base64 $file
    */
    $alobot->send([
        new AlobotMensagemDocumento(AlobotMensagemDocumento::TP_ARQUIVO, $numero, $file),
        new AlobotMensagemDocumento(AlobotMensagemDocumento::TP_IMAGEM, $numero, $file)
    ])

Como criar uma integração

Para você criar uma integracão basta acessar o site https://alobot.com.br, com o mesmo usuário referente ao token passado no arquivo .env, criar um número e colocar o id como valor da variável $ALOBOT_ID_INTEGRACAO no .env.

//Exemplo fictício, não necessariamente o valor utilizado aqui será o seu.
ALOBOT_ID_INTEGRACAO= 1

agp / pacote-alobot

Maintainers

Details