Mudanças entre as edições de "PHWhatsApp"
(9 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
Linha 1: | Linha 1: | ||
− | |||
− | |||
O PHWhatsApp é um integrador do PH ERP que permite realizar o envio de mensagens WhatsApp por meio de API. | O PHWhatsApp é um integrador do PH ERP que permite realizar o envio de mensagens WhatsApp por meio de API. | ||
Linha 26: | Linha 24: | ||
* '''Reiniciar''': Reinicia o serviço do PHWhatsApp. | * '''Reiniciar''': Reinicia o serviço do PHWhatsApp. | ||
− | ==== | + | ===API=== |
+ | |||
+ | ---- | ||
+ | |||
+ | ====enviarMensagemTexto==== | ||
* '''Método:''' GET. | * '''Método:''' GET. | ||
* '''Autenticação''': Basic (Usuário e Senha). | * '''Autenticação''': Basic (Usuário e Senha). | ||
Linha 44: | Linha 46: | ||
|Mensagem que será enviada | |Mensagem que será enviada | ||
|} | |} | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ====verificarNumero==== | ||
+ | * '''Método:''' GET. | ||
+ | * '''Autenticação''': Basic (Usuário e Senha). | ||
+ | |||
+ | '''Parâmetros''' | ||
+ | {| class="wikitable" style="width: 100%" | ||
+ | ! Nome | ||
+ | !Tipo | ||
+ | !Descrição | ||
+ | |- | ||
+ | |numero | ||
+ | |String | ||
+ | |Número a ser verificado(DDI+DDD+Número). | ||
+ | |} | ||
+ | |||
+ | ---- | ||
===Consumindo a API=== | ===Consumindo a API=== | ||
Linha 57: | Linha 78: | ||
Rest := NewPHConexaoREST; | Rest := NewPHConexaoREST; | ||
try | try | ||
− | // Envio via 'GET' | + | // Envio via 'GET' |
Rest.Metodo := 'GET'; | Rest.Metodo := 'GET'; | ||
− | // URL = Host do servidor + Porta + EndPoint | + | // URL = Host do servidor + Porta + EndPoint |
Rest.URL := 'http://localhost:8083/enviarMensagemTexto'; | Rest.URL := 'http://localhost:8083/enviarMensagemTexto'; | ||
− | // Informar no cabeçalho os dados criptografados do serviço | + | // Informar no cabeçalho os dados criptografados do serviço |
Rest.AddHeader('Authorization', 'Basic cGhzeXM6MTIzNDU2Nzg5'); | Rest.AddHeader('Authorization', 'Basic cGhzeXM6MTIzNDU2Nzg5'); | ||
// número de destino da mensagem | // número de destino da mensagem | ||
− | Rest.AddParametro('numero', ' | + | Rest.AddParametro('numero', '554799999999'); |
// mensagem a ser enviada | // mensagem a ser enviada | ||
− | Rest.AddParametro('mensagem', ' | + | Rest.AddParametro('mensagem', 'Teste de envio de mensagem no whatsapp'); |
Rest.Executar; | Rest.Executar; | ||
if not Rest.RetornoErro then | if not Rest.RetornoErro then | ||
Linha 76: | Linha 97: | ||
end; | end; | ||
end; | end; | ||
+ | |||
+ | ====Usabilidade==== | ||
+ | |||
+ | * '''Quebra de linha da mensagem''': Para realizar a quebra de linha da mensagem, deve ser utilizado a marcação '''\n'''. Exemplo: Mensagem com \n quebra de linha. | ||
+ | |||
+ | * '''Mensagens em negrito''': Para o envio de mensagens em negrito, a frase deve estar circundado por *. Exemplo *Mensagem em negrito* |
Edição atual tal como às 19h10min de 20 de junho de 2021
O PHWhatsApp é um integrador do PH ERP que permite realizar o envio de mensagens WhatsApp por meio de API.
Nota
Para utilizar o integrador é necessário entrar em contato com o suporte para solicitar a instalação do serviço do PHWhatsApp em seu servidor. |
Índice
Configurando o Serviço
Após a instalação do PHWhatsApp é necessário realizar as configurações do servidor, para isso temos que executar o arquivo PHWhatsApp.exe que está na pasta de instalação do PHWhatsApp. Na aba Serviço é possível configurar os dados de acesso da API da integração.
Campos
- Porta: Identificação da porta liberada para realizar o acesso a API.
- Usuário: Usuário que será utilizado para realizar a autenticação no serviço.
- Senha: Senha que será utilizada para realizar a autenticação no serviço.
- Authorization: Campo leitura que contém os dados de acesso criptografados para a autenticação no servidor.
Opções
- Autenticar Dispositivo: Essa opção permite realizar a leitura do QRCode do WhatsApp Web para autenticar o dispositivo.
- Iniciar: Inicia o serviço de aplicação do PHWhatsApp.
- Parar: Interrompe a execução do serviço do PHWhatsApp.
- Reiniciar: Reinicia o serviço do PHWhatsApp.
API
enviarMensagemTexto
- Método: GET.
- Autenticação: Basic (Usuário e Senha).
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
numero | String | Número do destinatário da mensagem (DDI+DDD+Número). |
mensagem | String | Mensagem que será enviada |
verificarNumero
- Método: GET.
- Autenticação: Basic (Usuário e Senha).
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
numero | String | Número a ser verificado(DDI+DDD+Número). |
Consumindo a API
Após realizar a configuração do servidor de aplicação, com o serviço iniciado podemos consumir através de script do PHERP a API do PHWhatsApp, para isso utilizaremos o objeto TPHConexaoREST.
Exemplo de utilização
procedure EnviarMensagemWhatsApp; var REST: TPHConexaoREST; begin Rest := NewPHConexaoREST; try // Envio via 'GET' Rest.Metodo := 'GET'; // URL = Host do servidor + Porta + EndPoint Rest.URL := 'http://localhost:8083/enviarMensagemTexto'; // Informar no cabeçalho os dados criptografados do serviço Rest.AddHeader('Authorization', 'Basic cGhzeXM6MTIzNDU2Nzg5'); // número de destino da mensagem Rest.AddParametro('numero', '554799999999'); // mensagem a ser enviada Rest.AddParametro('mensagem', 'Teste de envio de mensagem no whatsapp'); Rest.Executar; if not Rest.RetornoErro then informacao(Rest.Retorno) else ErroValidacao(Rest.Retorno); finally REST.Free; end; end;
Usabilidade
- Quebra de linha da mensagem: Para realizar a quebra de linha da mensagem, deve ser utilizado a marcação \n. Exemplo: Mensagem com \n quebra de linha.
- Mensagens em negrito: Para o envio de mensagens em negrito, a frase deve estar circundado por *. Exemplo *Mensagem em negrito*