Enviar Mensagem por SMS

Este método é utilizado para criar uma validação de segundo fator de autenticação via sms e enviar o sms 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}/sms/2fa

Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{id}/sms/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
textTexto recebido no smsString
typeTipo da Validação (SMS ou Email)String
statusSent = Enviado.
Delivered = Entregue. Certificamos que o cliente recebeu a mensagem em seu celular.
Replied = Respondido, faça um Get para obter a resposta.
Expired = Tempo de expiração configurado foi expirado, caso o cliente resposta a mensagem após a expiração, desconsideramos a resposta.
Failed = Falha. Caso tenhamos obtido um retorno de falha no envio da mensagem, notificaremos através desse status.
String
createdAtData da Criação da ValidaçãoDatetime
smsSendLimitLimite de envio por transação antes da expiração do tempo de respostaInt
expirationTimeTempo máximo para respostaDatetim

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

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 SMS 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 SMS. 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.

Envio de SMS com templates distintos (ChannelID)

É possível cadastrar SMS com parâmetros distintos, para isso, o cliente deverá solicitar ao [email protected] o cadastro dos SMS, informando quais parâmetros deverão ser cadastrados para cada fluxo. Como retorno, o suporte devolverá quais 'channelID' correspondem a cada fluxo do cliente.

Quais são os parâmetros que o cliente deve cadastrar para o 2FA SMS?

  • text - Texto enviado através da mensagem
  • expirationTime - Tempo que o usuário final tem para responder o SMS
  • smsSendLimit

Para enviar um SMS respeitando os parâmetros atrelados ao channelID

  • Criar a transação passando todos os dados necessários + o campo channelID
  • Usando o ID da transação criada, realizar chamada no endpoint de 2FA SMS
  • Sucesso! O SMS será enviado de acordo com o que foi cadastrado para o channelID

*O channelID é o fator determinante para que a ClearSale envie o SMS de acordo com o que o cliente precisa.