Customizações
Desenvolvimento
Para utilização do Envio de Mensagens via WhatsApp e Busca de Resposta de Mensagem pela Worknow, foram desenvolvidos dois métodos, conforme definição abaixo:
string EnviaMensagemWhatsApp(int codColigada, int codFilial, int codTipoCurso, string idTemplate, string phoneTo, string[] paramsMessage, bool bypassConfirmation, byte[] file, string fileType, string fileName);
string BuscaRespostaMensagemWhatsApp(int codColigada, int codFilial, int codTipoCurso, string idMensagem);
Para utilização dos métodos, será necessário referenciar a DLL “RM.Wnw.Worknow.Intf.dll” da pasta RM.Net.
Envia Mensagem WhatsApp
Os seguintes parâmetros são esperados:
- codColigada: Coligada do contexto que está sendo utilizado.
- codFilial: Filial do contexto que está sendo utilizado.
- codTipoCurso: Nível de ensino do contexto que está sendo utilizado. (Caso o módulo não seja do Educacional, deve ser passado -1)
- idTemplate: Identificador do template da mensagem. Para mais informações sobre parametrização do Workchat, acesse nossa WikiHelp.
- phoneTo: Número do telefone que será enviado a mensagem, com DDD. (Exemplo: 11987654321)
- paramsMessage: Parâmetros que serão utilizados na mensagem definida no template. Os parâmetros serão substituídos na ordem em que aparecem.
Exemplo de mensagem com parâmetro: “Olá Sra. {{1}}! Bem-vinda ao nosso chatbot, selecione a opção {{2}} ou {{3}}.”. Neste caso deve ser enviado um array com 3 parâmetros, onde o primeiro valor do array será utilizado para substituir {{1}}, o segundo o {{2}} e assim por diante.
- bypassConfirmation: Esse parâmetro diz se é para a mensagem já ser cadastrada “confirmada para o envio” ou não. Caso seja passado false ou não seja passado o parâmetro, a mensagem será enviada para o Workchat como “aguardando confirmação”, de modo que o usuário deve entrar na plataforma e confirmar a mensagem para envio. Caso seja passado true, a mensagem já cairá na fila de envio e a mensagem será enviada automaticamente.
- file: Arquivo a ser enviado em formato base64.
- fileType: O mime type do arquivo. Por exemplo, para PDF deve ser utilizado “application/pdf”. No caso de png, deve ser utilizado “imagem/png”.
- fileName: Nome do arquivo, por exemplo “boleto.pdf”.
Ao ser executado, o método fará o envio na mensagem e irá retornar um Json com os seguintes valores:
- Id: Identificador da mensagem enviada.
- Status: Status de envio na mensagem. Alternativas: “Sucesso” ou “Erro”.
- Mensagem: Mensagem de retorno do envio. Exemplos: “Mensagem enviada com sucesso.” ou “Erro ao enviar mensagem.”
- Erro: Mensagem de erro caso ocorra: Exemplo: “Número de envio não á válido”.
O resultado da execução do método irá gerar Log na tabela ZWNLOG e também na tabela ZWNCONTROLEMSG.
- ZWNLOG: Registro de Log da chamada de API com Workchat.
- ZWNCONTROLEMSG: Tabela de controle das mensagens. Só é preenchida em caso de sucesso. O status da tabela pode conter dois valores: E – Enviado e R – Respondido.
Busca Resposta Mensagem WhatsApp
Os seguintes parâmetros são esperados:
- codColigada: Coligada do contexto que está sendo utilizado.
- codFilial: Filial do contexto que está sendo utilizado.
- codTipoCurso: Nível de ensino do contexto que está sendo utilizado. (Caso o módulo não seja do Educacional, deve ser passado -1)
- idMensagem: Identificador da mensagem enviada.
Este método serve para buscar a resposta da mensagem enviada. O retorno do método devolve as seguintes informações.
- Id: Identificador da mensagem enviada.
- Status: Status de envio na mensagem. Alternativas: “Sucesso” ou “Erro”.
- Mensagem: Mensagem de retorno da resposta. Exemplos: “Busca de resposta realizada com sucesso.” ou “Resposta pendente.”
- Erro: Mensagem de erro caso ocorra: Exemplo: “Licença inválida. Favor entrar em contato com a Worknow!”.
- Resposta: Resposta original do usuário.
Caso a mensagem ainda não tenha sido respondida, o status de retorno será “Erro” e a mensagem “Resposta pendente.”
Caso a mensagem tenha sido respondida, o status de retorno será “Sucesso” e a mensagem “Busca de resposta realizada com sucesso.”
