Skip to main content

Domínios — Jornadas

Usados em Jornadas.

JourneyType​

Campo type. Ao gerar, envie a key. Inválido → 1174003.

CodeKeyNomeOrigem (sourceId)
1authorization_term_acceptanceAceite de Termo de AutorizaçãoTermo de autorização
2loan_formalizationFormalização de EmpréstimoEmpréstimo

JourneyStatus​

Devolvido em status como StatusField.

CodeKeyNomeCorSignificado
1pendingAguardando AcessoCinzaGerada; o cliente ainda não abriu o link.
2in_progressEm AndamentoAzulO cliente abriu o link e está nas etapas.
3externalEm Etapa ExternaLaranjaO cliente foi para uma etapa fora da jornada (assinatura no provedor) e ainda não voltou.
4completedConcluídaVerdeTodas as etapas concluídas.
5canceledCanceladaVermelhoCancelada pelo operador, pelo cliente ou substituída por nova jornada.
6expiredExpiradaMarromPrazo do link encerrado.

pending, in_progress e external são os status abertos: só neles o link funciona e a jornada pode ser cancelada.

JourneyStepStatus​

Campo steps[].status.

CodeKeyNomeCor
1pendingPendenteCinza
2in_progressEm AndamentoAzul
3completedConcluídaVerde
4skippedNão ExibidaCinza claro
5canceledCanceladaVermelho

JourneyEventType​

Campo type de GET /v5/journeys/{id}/events. São eventos da trilha da jornada, não eventos de webhook.

CodeKeyNome
1generatedJornada Gerada
2invitation_sentConvite Enviado
3invitation_failedFalha no Envio do Convite
4openedLink Aberto
5resumedJornada Retomada
6restartedJornada Reiniciada
7step_viewedEtapa Exibida
8step_completedEtapa Concluída
9step_backVoltou Etapa
10step_back_deniedVoltar Etapa Negado
11answeredResposta Registrada
12draft_savedRascunho Salvo
13document_viewedDocumento Visualizado
14document_acceptedDocumento Aceito
15geolocation_grantedGeolocalização Autorizada
16geolocation_deniedGeolocalização Negada
17handler_executedAção Executada
18external_redirectedRedirecionado para Etapa Externa
19external_returnedRetorno da Etapa Externa
20conflictConflito de Revisão
21completedJornada Concluída
22canceledJornada Cancelada
23expiredJornada Expirada
24completion_message_sentMensagem de Conclusão Enviada

JourneyGeolocationStatus​

Campo geolocation.status em steps[] e accesses[].

CodeKeyNome
1not_requestedNão Solicitada
2grantedAutorizada
3deniedNegada
4unavailableIndisponível

JourneyMessageChannel​

Campo content.messages[].channel.

CodeKeyNome
1emailE-mail
2smsSMS
3whatsappWhatsApp

JourneyMessageEvent​

Campo content.messages[].event.

CodeKeyNomeQuando é enviada
1invitationConviteNa geração da jornada.
2completedConclusãoQuando a jornada é concluída.

JourneyResumeMode​

Campo content.settings.navigation.resumeMode: o que acontece quando o cliente reabre um link já iniciado.

CodeKeyNome
1continueContinuar de onde parou
2restartRecomeçar do início