Integração WhatsApp - GUPSHUP
Manual com o objetivo de realizar passo a passo a configuração para Integração via WhatsApp, enviando mensagens após o laudo ficar pronto ou de aniversariante.
Versão | Proprietário | Nota | Data |
|---|---|---|---|
1.0 | @Rafael Carvalho | Criação de documento | 13/02/2025 |
Índice
Primeira etapa: Pré-Requisitos
Criação de Conta
Antes de iniciar o processo o cliente deverá criar a conta na gupshup, https://www.gupshup.io/pt.
Para criar a conta, é necessário ter um Facebook do Laboratório, Cartão de Crédito para colocar créditos na plataforma.
Possuir um número Ativo.
Ao entrar no site, devemos clicar na opção de “Entrar”, conforme imagem abaixo:
Em seguida, será aberto a tela de login, mas como não temos, vamos criar, clicando na opção “Sign up here”, conforme imagem abaixo:
OBS.: É possível fazer o login também com uma conta do google, github ou facebook, porém o processo sinalizado nessa etapa é criando uma conta nova, sem vínculo com google, github ou facebook.
Agora, irá solicitar alguns dados que teremos que preencher, como primeiro e último nome, e-mail, senha, código de confirmação e aceite dos termos de serviço e política de privacidade da plataforma, conforme imagem abaixo:
OBS.: Senha deve ter no mínimo 8 caracteres, contendo no mínimo 1 letra Maiúscula, 1 Minúscula, 1 Número e 1 Caractere especial.
Após preencher as informações, clicaremos em “Sign up” e a conta será criada.
Com a conta criada, agora podemos acessar para criar o APP (Cada APP é vinculado a um número de WhatsApp - O Sistema está preparado somente para utilizar apenas um número de envio).
Caso o cliente não tenha criado o APP, podemos clicar no botão de “Criar APP”, colocar o nome desejado para o App e Clicar em “OK”, em seguida, clicaremos em “Acessar painel”.
Feito isso, teremos que “Publicar” nosso APP, conforme tela abaixo:
Após clicar em “Publicar”, devemos selecionar a opção desejada, se é um novo numero ou se é de um número ja ativo em alguma outra plataforma.
Ao ativar o GUPSHUP, não é possível utilizar o WhatsApp no Celular/WEB, então se o laboratório quiser manter o numero atual para continuar mandando mensagem precisaria de um número novo.
Em seguida, (Caso seja selecionado a opção “Novo número de telefone”, será exibido uma página exibindo os valores, onde devemos selecionar Brasil como país) e seguir o passo a passo até a finalização.
Esses valores podem ter mudanças a critério de definição da META/GUPSHUP, imagem acima é apenas para simulação do processo, no momento em que foi criado o manual.
Vamos inserindo os dados e clicando no botão de “Prosseguir”.
Detalhes (Dados de Contato):
Em seguida chegará um código no e-mail que você precisará colocar na próxima etapa.
Feito isso, próximo passo é vincular ao facebook, onde após o login, o laboratório terá que preencher algumas informações como nome da empresa, e-mail comercial, site/perfil comercial da empresa, país.
Em seguida, nas mesmas informações do facebook, terá algumas dados a ser preenchido referente ao whatsapp, como o número que será usado, nome que irá aparecer no wpp business, etc.
Após preencher essas informações, o aplicativo será ativado.
Não é possível usar um número que esteja associado a uma conta no facebook, ou seja, caso esteja associado precisa desvincular dessa conta para conseguir utilizar na integração.
Segunda etapa: Acessando APP
Devemos acessar o aplicativo que criamos, repare que após finalizar os processos, o APP fica ativo quando estiver ok, e exibe também qual é o numero do whatsapp.
Devemos clicar no botão para redirecionar a tela de configuração do APP, conforme imagem abaixo:
Em seguida, devemos criar o modelo de mensagem de resultado, clicando na opção “Criar modelo”, conforme imagem abaixo:
Após isso, digitaremos os dados para cadastrar o modelo.
Imagens abaixo mostra uma configuração e mais abaixo terá uma explicação de cada campo.
Nome do modelo: Apenas nome do template, útil para dar suporte posteriormente e identificar sobre o que o template é.
Categoria: Categoria da mensagem (Será relacionado ao conteúdo da mensagem)
Idioma: Português (BR)
Rótulo de modelos: Descritivo simples sobre do que se trata o template.
Cabeçalho: Caso queira usar um cabeçalho fixo na mensagem (Pode ser usado Textos, Imagens, Vídeos, Documentos, etc).
Corpo: Aqui é onde iremos configurar a mensagem de fato, o texto é simples onde vamos digitar e podemos colocar formatação nas letras como em negrito, itálico , emojis, etc.
As variáveis são representadas por “{{numerosequencial}}”, ou seja, “{{1}},{{2}}”.
Cada variável, será correspondente a uma tag no nosso sistema para configurar a mensagem, exemplo: #cliente#, #url_resultado#, etc.
Ao inserir os dados, podemos ir visualizando no modelo de preview da mensagem ao lado direito da nossa configuração.
Rodapé: Possibilidade de inserir um texto fixo no Rodapé.
Botões: Aqui podemos criar Botões de redirecionamento para Links (Fixos ou Dinâmicos), Botões dinâmicos receberão um parâmetro/variável para ser implementada no link:
Ex.: https://sia.softeasy.com.br/{{6}} onde {{6}} seria o parâmetro que nós enviaríamos, ex.: #URL_RESULTADO_BOTAO# que é uma tag que vai mandar um link valido.
Marcar checkbox de “Permitir que a Meta altere a categoria deste modelo durante a aprovação”: Essa marcação, permite que a IA da meta altere a categoria da mensagem, para o template não ser reprovado, caso a categoria que você escolheu não seja compatível com a mensagem que foi escrita no template.
Feito isso, clicaremos no botão “Visualizar e enviar” para criar o template:
Feito isso, clicaremos em “Enviar”.
O site nos redirecionará para a tela de templates novamente, onde devemos consultar qual é o status do nosso template que criamos, clicando no ícone “”.
Exemplo:
Deverá ter um ID de modelo da Gupshup e do Facebook (Quando é gerado o do facebook é pq houve aprovação).
Acima podemos ver que o Status está aprovado.
A validação da META é bem rápida, aguarde no máximo até 10 minutos, caso não tenha tido atualização, tente clonar o modelo criando um modelo igual.
Com esses dados, agora podemos continuar nossa configuração.
Devemos também, pegar a API KEY da conta, para conseguirmos utilizar a integração.
A opção fica ao clicar no ícone de “Imagem de Perfil”, conforme imagem abaixo:
Terceira etapa: Configuração de Parâmetros SiaLab
Após obter os requisitos acima, siga o manual abaixo:
Ir até o menu Configurações > Parâmetros do sistema > Dados Integrações.
Irá abrir a tela a seguir:
Iremos colocar a Gupshup como Serviço de Mensagem e preencher uma Data de Ativação (Passará a enviar mensagens para as amostras cujo a data de entrada seja > ou = a Data de Ativação).
Marcar a opção “Utiliza Integração com o WhatsApp.”
Informar a URL da API (https://api.gupshup.io/wa/api/v1/template/msg)
Informar a API KEY (Colocar a chave API que copiamos da no processo anterior).
Marcar a opção “Envia notificação de resultados de exame.”
No texto, iremos utilizar nosso padrão estabelecido, e só vamos passar os parâmetros conforme configuramos no template da gupshup:
channel=whatsapp&
source=NUMERODOCLIENTE&
destination=#CELWHATS#& (Aqui é a tag para usar o telefone do prontuario, ou seja, destinatário)
src.name=ZapSofteasy& (Nome do aplicativo que criamos)
template={"id":"aa7e85f9-4461-4a5b-8d40-11e4c1ab1a15","params":["#NOME#","#POSTO#","#AMOSTRA#","#URL_RESULTADO#",”#URL_PESQUISA#”,”URL_RESULTADO_BOTAO#]} (Aqui, no id, iremos utilizar o ID do modelo gupshup do template, gerado na etapa anterior, e os parametros iremos passar a tag, no nosso exemplo, tinhamos 6 variáveis no template, então teremos 6 variaveis na configuração da mensagem no sistema.
ATENÇÃO: DEVERÁ TER A MESMA QUANTIDADE DE PARAMETROS DE ACORDO COM AS VARIÁVEIS ESTABELECIDAS NO TEMPLATE.
Um exemplo real ficaria assim:
channel=whatsapp&
source=5511952495510&
destination=#CELWHATS#&
src.name=ZapSofteasy&
teemplate={"id":"aa7e85f9-4461-4a5b-8d40-11e4c1ab1a15","params":["#NOME#","#POSTO#","#AMOSTRA#","#URL_RESULTADO#",”#URL_PESQUISA#”,”URL_RESULTADO_BOTAO#]}
É possível também configurar mensagem para aniversariante, segue o mesmo padrão de estrutura de mensagem, ai deverá ser criado o template na gupshup.
Caso desejado, deverá ser ativado no Menu Gerencial > Automações > Whatsapp Aniversário.
Será disparado as mensagens todo dia caso tenha algum aniversariante, pela manhã as 9h.
Após preencher as informações corretamente, clicaremos em “GRAVAR”.
Opção “Legenda da mensagem” mostra as tags possíveis para substituição na mensagem do resultado.
RECOMENDAMOS APÓS CONFIGURAR O AMBIENTE, UTILIZAR A OPÇÃO “Testar envio de mensagem”.
As mensagens só serão enviadas quando os exames estiverem Completos (Assinados), após realizar a liberação do último exame, será criado o registro na (app_fila) e realizado a tentativa de envio da mensagem no momento da liberação, caso de algum erro durante o processo, será exibido a mensagem do erro em tela, criado o registro na app_fila e será possível realizar o reenvio pela tela de Integração WhatsApp.
Caso dê certo, irá apresentar a mensagem de sucesso conforme imagem abaixo:
Configuração URL de Resultado
Agora, devemos configurar a URL do Laudo, caso ainda não esteja configurada.
Acessar o menu Configurações > Parâmetros do sistema > Laudos.
Caso o Checkbox “Usa visão do paciente para laudos” esteja marcado, a URL não irá trocar nenhuma TAG, ou seja, a URL digitada no campo “Url Comprovante Coleta” será a mesma que exibe na tela, caso esteja desmarcada e tenha alguma tag informada, o sistema realizará as trocas.
#labcode#= será substituída pelo ID do laboratório (Deve ficar com a TAG na URL, o sistema que fará a troca da tag pelo ID/Código do laboratório).
tipolog= Utilizaremos pacatend, no caso, esse tipo de login é utilizado para o login por amostra, ou seja, login que irá abrir diretamente no site.
#posto# será substituída pelo posto do atendimento (Deve ficar com a TAG na URL, o sistema que fará a troca da tag pelo posto).
#amostra# será substituída pelo posto do atendimento (Deve ficar com a TAG na URL, o sistema que fará a troca da tag pela a amostra).
#password# será substituída pela senha do atendimento (Deve ficar com a TAG na URL, o sistema que fará a troca da tag pela senha).
Configuração URL de Pesquisa de Satisfação
Agora, devemos configurar a URL da Pesquisa de Satisfação, caso ainda não esteja configurada.
Acessar o menu Configurações > Parâmetros do sistema > Aba Atendimentos
Marcar o checkbox: “Utiliza pesquisa de satisfação”
Preencher a url no campo abaixo do checkbox:
https://sia.softeasy.com.br/pesquisa-satisfacao/#labcode#/#movpacid#
#labcode#= será substituída pelo ID do laboratório (Deve ficar com a TAG na URL, o sistema que fará a troca da tag pelo ID/Código do laboratório).
#movpacid#= será substituída pelo ID da movpac, para responder a pesquisa referente ao atendimento.
Painel de Integração (Reenvio de Mensagens - Consulta de Mensagens Enviadas/Não Enviadas)
Nessa tela, podemos consultar todas as mensagens que houve tentativa de envio para o whatsapp, as que tiveram falha, é possível reenviar clicando no botão “Reenviar não enviados”, é possível também realizar os filtros para encontrar um determinado posto/amostra, assim como filtrar só por já enviados, não enviados, ou todos.
Para acessar, devemos ir no Menu Integrações > Integração com WhatsApp, conforme imagem abaixo:
O Reenvio só é feito para as que não foram enviadas, ou seja, só é feito 1 envio com SUCESSO por amostra, os reenvios podem ser realizados N vezes, não tem limitação.
As informações utilizadas para o reenvio, serão sempre as atuais (N° telefone, Nome do Paciente, Parametrização para envio da mensagem, etc.), então se houver alguma falha por telefone incorreto ou não existente por exemplo, deverá ser atualizado no prontuário e posteriormente reenviado no painel, com isso será utilizado o novo número informado e reenviado a mensagem, o mesmo é válido para os demais registros.
Conclusão
O WhatsApp é uma das ferramentas mais utilizada hoje no dia a dia para facilitar a comunicação, e se tornou muito útil para interação com o paciente de forma rápida, podendo ser habilitado/desabilitado a qualquer momento desde que o cliente possua o pacote.
Podemos considerar que o envio de mensagens de resultado pronto via WhatsApp é um recurso moderno e se torna essencial para laboratórios que estão se modernizando, oferecendo novas soluções aos seus pacientes, além de confiabilidade nos processos.