CLEARSALE

Enviar Mensagem por WhatsApp

Este método é utilizado para criar uma validação de segundo fator de autenticação via WhatsApp e enviar mensagem via WhatsApp para o hotphone do dono do CPF enviado na transação da Plataforma Data Trust.**

📘

Endereço dos nossos serviços:

Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/{id}/whatsapps/2fa
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{id}/whatsapps/2fa

Acesse aqui a documentação técnica

O módulo 2FA tem retorno assíncrono, depende de ação do seu cliente para que se obtenha a resposta da mensagem. Primeiro faça a chamada do módulo (método POST) para que possamos enviar a mensagem ao seu cliente, depois, faça a consulta do resultado utilizando o método GET. Você também pode implementar um Webhook para ser notificado quando o resultado estiver pronto!

Dicionário de variáveis

NomeDescriçãoTipo
StatusStatus do WhatsAppString
CreatedAtData da Criação da ValidaçãoDatetime
ReplyObjeto da Resposta do WhatsApp 2FA. Status estará como 2 - RepliedReply
SendLimitLimite de envio por transação antes da expiração do tempo de respostaInt
ExpirationTimeTempo máximo para respostaDatetime
TextMensagem de texto que o cliente ira receber*String

Status

NomeDescriçãoNotificação Webhook
WaitingAguardando confirmação de envio do WhatsAppNão
SentWhatsApp enviado com sucessoNão
FailedEnvio de WhatsApp falhouSim
DeliveredWhatsApp entregue ao usuário com sucessoNão
ReadWhatsApp lido pelo usuárioNão
RepliedWhatsApp respondido pelo usuárioSim
ExpiredWhatsApp expiradoSim

*Obs: cada "\r\n" no campo text corresponde a uma quebra de linha.

*Obs 2: Somente os status Replied, Expired e Failed contemplam envio de Webhook.

2º Fator de Autenticação WhatsApp - Reply

NomeDescriçãoTipo
OptionResposta do WhatsApp 2FA (1, 2 ou 3)Int
RepliedAtData da Resposta da ValidaçãoDatetime

As respostas possíveis para o módulo de 2FA são:

1 - Sim

2 - Não

3 - Não sou {nome}

Nome enviado na mensagem

No caso do cliente ter enviado o campo 'name' através do endpoint de transação, o nome enviado na mensagem de WhatsApp será exatamente o que foi enviado pelo cliente, sem possibilidade de adaptações.

No caso do cliente não ter enviado o campo 'name' através do endpoint de transação, o fluxo interno de busca de nome no Datalake ClearSale é acionado. Para o fluxo interno, será possível realizar a adaptação de enviar apenas o primeiro nome ou o nome + sobrenome (último nome) do usuário final na mensagem WhatsApp. Para solicitar essa adaptação, entre em contato com [email protected]. No caso da ClearSale não encontrar o nome, a mensagem será enviada apenas com "Prezado(a)", sem nome, dessa forma garantiremos que mesmo assim a mensagem seja enviada com sucesso.

Campos Genéricos (genericFields)

A inclusão de campos genéricos foi pensada para que o cliente possa inserir nas mensagens de texto de 2FA (inicialmente somente via WhatsApp), variáveis que somente a empresa cliente tem acesso aos dados e que façam sentido para o entendimento do contexto da mensagem pelo seu cliente / consumidor.

Para o envio de campos genéricos para uso na mensagem de 2FA é necessário alinhamento prévio, para que então o campo passe a ser considerado no envio da transação.

Uma vez que os campos estejam mapeados, é possível adicionar uma máscara para validar o dado enviado, como por exemplo enviar somente letras, enviar uma data, um valor monetário, etc.

Se você tem interesse em enviar campos genéricos na mensagem de 2FA entre em contato com o [email protected]