- Como criar Mensagens via API com o Método CreateMessage:
Siga o exemplo da imagem abaixo (documentação CreateMessage)
2. Erros nos Responses
Caso tenha alguma notificação com erro, você pode conferir o tipo de retorno (cada tipo de response no HTTP carrega o tipo de erro) em nossa documentação.
- Regras e possibilidades do envio do link via SMS
- Qual o prazo para expirar o link da biometria facial enviado via SMS?
O tempo de expiração pode ser calculado da seguinte maneira:
Quantidade de envios de SMS e e-mail x intervalo de tempo (minutos) de reenvio + intervalo de tempo (minutos) de reenvio (início e fim).
- Quantidade de envios SMS e e-mail = Quantos SMS o cliente poderá receber nesse template (caso ele não termine a primeira vez).
- Intervalo de tempo (minutos) reenvio = Quanto tempo ele poderá reenviar um SMS.
💡 Tempo de Expiração: quando terminar de enviar as quantidades de envios estabelecidas (respeitando seus intervalos de tempo) o último link enviado, vai expirar após X minutos de reenvio estabelecido (intervalo de tempo (em minutos) reenvio).
Exemplo:
Quantidade de envios SMS e e-mails = 2 vezes
Intervalo de tempo (min) reenvio = 720 min (12 horas)
Logo, o total de horas para expiração seria de 24 horas (2x720 = 1.440 min)
- Intervalo de reenvio de notificações (início e fim) = Em qual horário ele pode fazer notificações. Exemplo: 08:00 (início) às 18:00 (Fim).
Configurando para horário comercial: Tempo de reenvio do link estivesse como 08:00 até 18:00
Configurando para horas corridas: Tempo de reenvio do link estivesse como 00:00 até 23:59
- Quando expira o link, o status do processo vai para qual status?
Quando o link de um determinado processo expira, automaticamente este processo será atualizado para o status 4 (cancelado). É possível conferir todos os status de retorno, na seguinte documentação: https://crediariohomolog.acesso.io/clientesacesso/services/v3/docs/#section/Enumerados
- Como controlar o seu meio de comunicação com os usuários, ou seja, efetuar uma chamada de CreateMessage (via SMS, e-mail ou Whatsapp)
Utilize o endpoint {{URLINSTANCE}}/Capture/SMS/Start.aspx?id={{ID}}", onde as variáveis URLINSTANCE E ID deverão ser substituídas pelos valores:
- {{URLINSTANCE}}: URL Portal
Exemplo: https://crediariohomolog.acesso.io/teste
-{{ID}}: ID do processo retornado no método CreateMessage.
4. Cliente informa que não recebe o SMS
É necessário efetuar a chamada do ExecuteMessage para finalização do processo, e assim o SMS será enviado para o seu cliente.
Para garantir isso, verifique em sua função a query que irá retornar:
Busque no canto direito, após CreateMessage, se há a palavra “False”. Note que no exemplo foi “chamado” o Only Selfie (SEND) como “FALSE”, e não houve ExecuteMessage após o CreateMessage, ou seja, o processo não foi criado 100% no sistema e não houve disparo de SMS, pois o mesmo só ocorre após o ExecuteMessage. No sistema é necessário chamar o ExecuteMessage para concluir esse cadastro em até 60 minutos (prazo máximo que disponibilizamos o envio dos dados para o processID).
5. Quais informações preciso encaminhar no payload?
Para a requisição de Createmessage o Payload seria o “Header” e todo corpo de texto que seguem no modelo:
Header parameter name: APIKEY (substitua com sua APIKEY)
HTTP Authorization Scheme: bearer (substitua com o seu token de autenticação gerado)
{ "subject": {
"Code": "12345678910",
"Name": "Bob",
"Gender": "M",
"BirthDate": "01/01/0001",
"Email": "email@example.com",
"Phone": "5543999999999" },
"indexes":
[
{ "key": "{NUMERO DA SOLICITAÇÃO}",
"value": "0",
"page": "SMS"}
],
"template": "assinatura",
"send": false,
"enableQRCode": true }
Para mais detalhes, consulte nosso tópico de CreateProcess: https://developers.unico.io/check/RecursosAdicionais/api_guide/api-reference/#tag/Processes/operation/CreateProcess
6. Função cancelProcess, quando é aplicável e em qual momento?
A função cancelProcess, bem como seu procedimento para cancelar um processo, é aplicável somente no fluxo SMS.
Não existe uma forma de cancelar um processo do fluxo de biometria normal, porque o fluxo de biometria normal é cancelado automaticamente após 1 hora caso não haja respostas, diferente do fluxo SMS que vai respeitar o tempo de expiração do template. Para ser cancelado, o processo não pode ter sido enviado ao backend para receber autenticação, só pode ser cancelado caso o cliente não tenha finalizado o processo.
