MkAuth WhatsApp Send Message [16/07/2024 03:05]
![Mikrotik](https://mikrotik.com/img/mtv2/newlogo.svg)
Mantenha sua aplicação sempre atualizada
Upgrade v1 => v2
ProxMox
sudo apt-get install build-essential && cd ~ && cd /var/api/Mwsm && pm2 delete all && pm2 kill && npm remove pm2 -g && mkdir -p ~/.pm2/node_modules/ && cd ~ && rm -r /var/api/Mwsm && git clone https://github.com/MKCodec/Mwsm.git /var/api/Mwsm && cd /var/api/Mwsm && npm install --silent && npm i -g pm2 && pm2 update && pm2 flush && pm2 start mwsm.json && pm2 save && pm2 startup && pm2 log 0
MkAuth
```sh
cd ~ && cd /var/api/Mwsm && pm2 kill && pm2 delete all && npm remove pm2 -g || apt-get remove nodejs -y && rm -vrf ~/.pm2/node_modules /var/api/Mwsm && apt-get install -y ca-certificates fonts-liberation libappindicator3-1 libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils git curl build-essential && curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && apt-get install -y nodejs && cd ~ && mkdir -p /var/api/Mwsm && git clone https://github.com/MKCodec/Mwsm.git /var/api/Mwsm && cd /var/api/Mwsm && npm i git+https://github.com/MKCodec/WhatsApp-API && npm install github:MKCodec/WhatsApp-API && npm install --silent && npm i -g pm2 && pm2 update && pm2 flush && pm2 start mwsm.json && pm2 save && pm2 startup && pm2 log 0
```
Update v2 => v2 Beta++
> ### Após rodar o comando reconfigure as opções no menu settings ###
```sh
cd ~ && cd /var/api/Mwsm && pm2 delete all && pm2 kill && git reset --hard HEAD~1 && git pull "https://github.com/MKCodec/Mwsm.git" --rebase --autostash && npm install --silent && npm run start:mwsm
```
ERROS
Em Caso de Erros Habilite o Debbuger e Siga as Dicas do Guia de Utilização Debugger
no Final da Pagina
** Mwsm > Settings > Extras > Debugger
No Caso do Erro Persistir Contate-nos no Forum do mkauth
Novidades V2.0.33++
Release |
Recurso |
Update |
Patch |
2.0.33 |
Alternativa de conexão com API do MkAuth |
04/06/2024 12:42 ✅ |
|
2.0.33 |
Correção do Bug Tunel Dev do Mkauth |
|
04/06/2024 17:00 ✅ |
2.0.33 |
Correção do sistema de log |
|
06/06/2024 11:45 ✅ |
2.0.33 |
Disparos via Mikrotik ( /tool fetch ) |
|
08/06/2024 07:03 ✅ |
2.0.33 |
Verificação RegEx no Numero Disparado |
|
11/06/2024 13:29 ✅ |
2.0.33 |
Listagem de Usuarios MkAuth |
|
20/06/2024 12:49 ✅ |
2.0.34 |
Upgrade da API do WhatsApp |
02/07/2024 01:30 ✅ |
|
2.0.34 |
Correção da função Logout |
|
07/07/2024 00:04 ✅ |
2.0.35 |
Inclusão de senha + Melhoria do Log |
13/07/2024 04:42 ✅ |
|
2.0.35 |
Proteção por token no acesso Mikrotik |
|
16/07/2024 03:05 ✅ |
OBS: Para Utilizar as Melhorias do Log é Necessario Substituir a API do MkAuth Pela Versão Adaptada Desse Link.
Habilite o Endpoint em Provedor > Controle de Usuarios > API > cliente.api GET
Update : Utilize quando a sua versão instalada for inferior ao do Release [ Requer Reconfiguração ]
Patch : Utilize quando a sua versão instalada for igual ao do Release
Atualização:
Manual
1 - Insira um dos codigos no prompt de comando onde o mwsm esta instalado.
> Lembre-se de sempre atualizar o navegador (F5) quando realizar uma atualização Manual.
Update
```sh
cd ~ && cd /var/api/Mwsm && pm2 delete all && pm2 kill && git reset --hard HEAD~1 && git pull "https://github.com/MKCodec/Mwsm.git" --rebase --autostash && npm install --silent && npm run start:mwsm
```
Patch
```sh
wget https://raw.githubusercontent.com/MKCodec/Mwsm/main/mwsm.js -O /var/api/Mwsm/mwsm.js
wget https://raw.githubusercontent.com/MKCodec/Mwsm/main/script.js -O /var/api/Mwsm/script.js
wget https://raw.githubusercontent.com/MKCodec/Mwsm/main/style.css -O /var/api/Mwsm/style.css
wget https://raw.githubusercontent.com/MKCodec/Mwsm/main/index.html -O /var/api/Mwsm/index.html
cd ~ && cd /var/api/Mwsm && pm2 log 0
```
Automática
1 - Habilite a função no webadmin do mwsm.
> as atualizações serão instaladas entre 00:00 e 05:00 am e conterão somente correções de bugs que não interferem no funcionamento da API, atualizações criticas que requerem reconfiguração serão feitas somente de forma manual
** `Extras > Update`
Compatibilidade [ MkAuth API ]
|
BAR |
PIX |
QR |
QRL |
PDF |
Gerencianet |
✅ |
✅ |
✅ |
✅ |
✅ |
Iugu |
✅ |
✅ |
✅ |
✅ |
✅ |
Galaxpay |
✅ |
✅ |
✅ |
✅ |
✅ |
Santander |
✅ |
❌ |
❌ |
❌ |
✅ |
OBS: Compatibilidade Relatada por Usuarios Podendo Funcionar em Bancos/Gateways Ausentes Dessa Lista
Funcionalidade:
- Enviar mensagens de texto e/ou anexos via whatsapp para clientes cadastrados no mkauth
Requisitos :
- Servidor Linux ( Container ubuntu ) Proxmox ou Mkauth
Instalação :
Proxmox
OBS: é necessario instalar uma distribuição linux no proxmox antes de inserir os codigos abaixo
1 - Atualize seu sistema
```sh
apt update
```
```sh
apt upgrade -y
```
2 - Instale as dependencias necessarias
```sh
apt-get install git curl libnss3-dev libgdk-pixbuf2.0-dev libgtk-3-dev libxss-dev libasound2 build-essential -y
```
3 - Instale o node
```sh
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && apt-get install -y nodejs
```
4 - Instale o Mwsm
```sh
git clone https://github.com/MKCodec/Mwsm.git /var/api/Mwsm && cd /var/api/Mwsm
```
5 - Instale as dependencias do Mwsn
```sh
npm install --silent && npm run start:mwsm
```
Mkauth
1 - Atualize seu sistema
```sh
sudo apt update
```
2 - Instale as dependencias necessarias
```sh
sudo apt install git curl build-essential
```
```sh
sudo apt-get install ca-certificates fonts-liberation libappindicator3-1 libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils
```
3 - Instale o node
```sh
sudo curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && apt-get install -y nodejs
```
4 - Crie o diretório de instalação do Mwsm
```sh
sudo mkdir -p /var/api/Mwsm
```
5 - Instale o Mwsm
```sh
sudo git clone https://github.com/MKCodec/Mwsm.git /var/api/Mwsm && cd /var/api/Mwsm
```
6 - Instale as dependencias do Mwsn
```sh
sudo npm install --silent
```
7 - Inicialize o Mwsn
```sh
sudo npm run start:mwsm
```
Configuração :
Tutorial
1 - Habilite o Tunel Dev API do MKauth
** `Opções > Rede do Servidor > MkTunel > ( Ativar e Gravar )`
[![MkAuth](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/dev.png)](#)
2 - Habilite o EndPoint (Titulos GET) e (Cliente GET) do MkAuth
** `Provedor > Controle de Usuarios > API > ( Habilitar Endpoints titulo.api GET, cliente.api GET e Gravar )`
[![MkAuth](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/endpoint.png)](#)
3 - Acesse seu servidor web através do IP:PORTA em uma nova aba do novegador
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/terminal.png)](#)
4 - Aguarde a geração do QRCode
5 - Faça a leitura do QRCode com o WhatsApp
** `Whatsapp > Menu > Aparelhos Conectados > Conectar um Aparelho`
6 - Entre no whatsapp que acabou de conectar e pegue o token temporario para acessar as configurações
OBS: para criar um token fixo envie o comando como mensagem de outro celular para o numero conectado a API
```sh
Token:SENHA
```
TOKEN = *Comando* | : = *Divisor* | SENHA { altere para sua senha de 7 digitos }
7- Altere o valor conforme suas necessidades.
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/settings.png)](#)
| Nome | Default | Função |
| --------------- | ----------------- | --------------------------------------------------------------- |
| `Break` | `1 segundo` | Tempo de disparo entre mensagens condicionadas com a TAG `##`. |
| `Sleep` | `30 segundos` | Tempo de disparo entre mensagens com numeros diferentes. |
| `Access` | `8000` | Porta de acesso do sistema/interface. |
| `Call` | | Resposta após Receber uma Chamada. |
| `Wait` | `1 segundo` | Tempo para Rejeitar uma Chamada. |
| `Message ` | | Resposta após Receber uma Mensagem. |
| `Auto-Response` | `on` | Habilitar Resposta Automatica. |
| `Replies` | `on` | Marcar conversas em resposta automaticas. |
| `Auto-Reject` | `on` | Habilitar Rejeição de Chamadas Automatica. |
| `Alert` | `on` | Habilitar Mensagem de Resposta ao Rejeitar Chamadas. |
| `Counter` | `1` | Quantidade de Auto-Respostas por usuario (renovado todo dia) |
8 - Configure a API do MkAuth no Mwsm.
** `Mwsm > Settings > API`
| Campo | Dado |
| ----------|-------------------------------------------------------------|
| `TUNEL` | Insira o URL encontrada em Tunel no passo 2 desse tutorial |
| `CLIENT` | Insira o Codigo encontrado em Client no passo 2 desse tutorial |
| `SECRET` | Insira o Codigo encontrado em Secret no passo 2 desse tutorial |
| `DOMAIN` | Insira o Dominio ou IP do seu mkauth |
[![MkAuth](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/sync.png)](#)
| Nome | Função |
| -------------- | --------------------------------------------------------------|
| `Delay` | Tempo de espera para disparo de mensagens ordenadas. |
| `MkAuth Link` | Habilita a sincronia com a API do MkAuth. |
| `BAR` | Envia codigo de barras. |
| `PIX` | Envia codigo pix copia e cola |
| `QR` | Envia imagem do Qrcode pix. |
| `QRL` | Envia link pix Para acessar QRCode e Copia e cola. |
| `PDF` | Envia Boleto em PDF |
OBS: Por padrão o delay ideal é 2s porem se sua API disparar de forma desordenada considere elevar esse valor.
9 - Configure seu servidor no MKAuth seguindo as instruções do servidor Web
> **Senha :** Insira o `Token Fixo` de Acesso ao Aplicativo no Campo Senha no MkAuth
MkAuth até Versão 24.02
** `Opções > Servidor de SMS > Servidor`
[![MkAuth](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/mkauth.png)](#)
MkAuth Versão 24.03 ou Superior
** `Opções > Servidor de WhatsApp > Servidor`
[![MkAuth](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/whatsapp.png)](#)
Utilização :
Tutorial
> Utilize o simulador do mkauth antes de colocar em produção : `settings > Options > Run`.
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/msn.png)](#)
> Exemplo para teste no webadmin ( mkauth simulator )
> ```sh
> {"uid":"E5:BE:ED:DE:2E:EF","find":"415"}
> ```
> Exemplo de utilização no mkauth ( Insira exatamente assim, não edite )
> ```sh
> {"uid":"%logincliente%","find":"%numerotitulo%"}
> ```
> É possivel combinar a Utilização com a tag ## seguindo o exemplo abaixo:
> ```sh
> Mensagem1##https://via.placeholder.com/350x150.png##Mensagem3##{"uid":"%logincliente%","find":"%numerotitulo%"}##Mensagem5
> ```
### Exemplo De Mensagem Para Utilização no MkAuth
> ** `Opções > Servidor de SMS > Mensagens`
>
> ```sh
> Olá %nomeresumido%, sua fatura %numerotitulo% vence no dia %vencimento%, para sua comodidade estamos enviado os dados para pagamento: ##{"uid":"%logincliente%","find":"%numerotitulo%"}##desconsidere esse aviso caso tenha feito o pagamento.
> ```
### Como Enviar Mensagens Via Mikrotik
> As mensagens via Mikrotik podem ser enviadas via Script com o comando Abaixo:
>
> ```sh
> /tool fetch "http://IP-API/mikrotik/TOKEN/DDI+DDD+NUMERO/MENSAGEM"
> ```
>
> **OBS:** Subistitua os Espaços por `%20` ao Inserir uma Mensage no Toll Fetch
>
> **Ex:** Para `/tool fetch "http://192.168.3.250:8000/mikrotik/1234567/5511988888888/Mensagem de Teste"` :
>
> ```sh
> /tool fetch "http://192.168.3.250:8000/mikrotik/1234567/5511988888888/Mensagem%20de%20Teste"
> ```
### Testando
1 - Envie uma mensagem pelo Sumulador `settings > Options > Run` ou MkAuth `Opções > Servidor de SMS > Mensagens`
2 - Verifique o Status do envio no Log `Mwsm > Log`.
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/log.png)](#)
| Opção | Função |
| -----------------|--------------------------------------------------------------------------------------|
| `ID` | Idenificador de Registro |
| `TITLE` | Balão Flutuante com numero do titulo (Boleto) ao selecionar um Registro |
| `START` | Inicio do Processamento |
| `FINISH` | Conclusão do Processamento |
| `TARGET` | Whatsapp Alvo do Disparo |
| `STATUS` | Status do Envio |
Debugger
> Para um melhor entendimento utilize esse guia como base na solução de possiveis erros.
>
> ** `Settings > Extras > Debug ON`
>
> Todos os Resultados tem somente 2 retornos possiveis:
> True = Positivo
False = Negativo
### 1 - Teste a Conexão com API MkAuth
> ** `Settings > API > MkAuth Link` ( Desabilite e Habilite )
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/auth.png)](#)
| Opção | Retorno |
| -----------------|-------------------------------------------------------------|
| `Authentication` | Autenticação com API do MkAuth via Token JWT |
| `Communication` | Comunicação Entre APP e API do MkAuth |
### 2 - Teste a Comunicação da API MkAuth
Utilize o Simulador MkAuth para analisar esses dados
** `Settings > Run > MkAuth Simulator ON`
Em um cenario em que a comunicação foi feita de forma correta receberemos o seguinte resultado
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/success.png)](#)
> Na Primeira linha temos o comando de entrada de acesso a API do MkAuth.
>
> Nas Demais Linhas Temos o Retorno Da API e por Fim o Resultado da Requisição.
| Opção | Retorno |
| -------------|---------------------------------------------------------|
| `Payment` | Status do Pagamento da Mensalidade Pesquisada |
| `MkAuth` | Modulos Disponiveis no Aplicativo |
| `Module` | Função Integrada pela API |
| `Available` | Disponibilidade pelo Gateway de Pagamento |
| `Allowed` | Permissão de Utilização Configurada em `Settings > API` |
Em um Cenario em que Ocorreu uma Falha na Requisição, o Debug ira Apontar a Falha e Onde Ocorreu
O Dado inserido no campo uid esta incorreto ( não existe no MkAUth )
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/uid.png)](#)
O Dado inserido no campo find esta incorreto ( não faz parte do uid inserido )
[![Node](https://raw.githubusercontent.com/MKCodec/Mwsm/main/img/find.png)](#)
> É importante Levar em Consideração que os Dados Enviados Pelo MkAuth utilizando suas variaveis são enviados ao Aplicativo Seguindo o Mesmo Caminho que o `MkAUth Simulator`, se o Comando `{"uid":"%logincliente%","find":"%numerotitulo%"}` vindo do MkAuth Funcionar más o `{"uid":"Paulo.Santos","find":"144"}` inserido no Simulador não Funcionar é Possivel que vc Esteja Inserindo de Forma Errada, desse modo sugerimos que Dispare uma Mensagem via MkAuth e Copie a Primeira Linha do Debug para Disparar via Simulador.
>
> **OBS:** `%numerotitulo%` é uma variavel **exclusiva** de SMS `Opções > Servidor de SMS > Mensagens` e não é possivel incluir como mensagem ( cartinha na lista de clientes ).
Extras :
Tags
| Tag | Efeito | Exemplo |
| -------------- | -------------- | --------------------------------------------------------------- |
| `##` | quebra balão | Mensagem1`##`Mensagem2`##`Mensagem3 |
| `\n` | quebra linha | Linha1`\n`Linha2`\n`Linha3 |
| `*` | negrito | `*`Mensagem`*` |
DOAÇÕES PIX :
Contribua com a sobrevivência desse projeto estimulando melhorias e atualizações.
![Pix](https://github.com/MKCodec/Mwsm/assets/143403919/24660f85-17d0-4de4-94e7-de85828a9265)
e9b9d669-4412-4dec-994c-310005904088
00020126580014BR.GOV.BCB.PIX0136e9b9d669-4412-4dec-994c-3100059040885204000053039865802BR5924CLEBER FERREIRA DE SOUZA6007CARUARU62070503***63045854