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
StatusStatus da Validação [Sent = Envio / Replied = Resposta / Expired = Expirado]String
CreatedAtData da Criação da ValidaçãoDatetime

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.