Domínios — Jornadas
Usados em Jornadas.
JourneyType
Campo type. Ao gerar, envie a key. Inválido → 1174003.
| Code | Key | Nome | Origem (sourceId) |
|---|---|---|---|
1 | authorization_term_acceptance | Aceite de Termo de Autorização | Termo de autorização |
2 | loan_formalization | Formalização de Empréstimo | Empréstimo |
JourneyStatus
Devolvido em status como StatusField.
| Code | Key | Nome | Cor | Significado |
|---|---|---|---|---|
1 | pending | Aguardando Acesso | Cinza | Gerada; o cliente ainda não abriu o link. |
2 | in_progress | Em Andamento | Azul | O cliente abriu o link e está nas etapas. |
3 | external | Em Etapa Externa | Laranja | O cliente foi para uma etapa fora da jornada (assinatura no provedor) e ainda não voltou. |
4 | completed | Concluída | Verde | Todas as etapas concluídas. |
5 | canceled | Cancelada | Vermelho | Cancelada pelo operador, pelo cliente ou substituída por nova jornada. |
6 | expired | Expirada | Marrom | Prazo 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.
| Code | Key | Nome | Cor |
|---|---|---|---|
1 | pending | Pendente | Cinza |
2 | in_progress | Em Andamento | Azul |
3 | completed | Concluída | Verde |
4 | skipped | Não Exibida | Cinza claro |
5 | canceled | Cancelada | Vermelho |
JourneyEventType
Campo type de GET /v5/journeys/{id}/events. São eventos da trilha da jornada, não eventos de webhook.
| Code | Key | Nome |
|---|---|---|
1 | generated | Jornada Gerada |
2 | invitation_sent | Convite Enviado |
3 | invitation_failed | Falha no Envio do Convite |
4 | opened | Link Aberto |
5 | resumed | Jornada Retomada |
6 | restarted | Jornada Reiniciada |
7 | step_viewed | Etapa Exibida |
8 | step_completed | Etapa Concluída |
9 | step_back | Voltou Etapa |
10 | step_back_denied | Voltar Etapa Negado |
11 | answered | Resposta Registrada |
12 | draft_saved | Rascunho Salvo |
13 | document_viewed | Documento Visualizado |
14 | document_accepted | Documento Aceito |
15 | geolocation_granted | Geolocalização Autorizada |
16 | geolocation_denied | Geolocalização Negada |
17 | handler_executed | Ação Executada |
18 | external_redirected | Redirecionado para Etapa Externa |
19 | external_returned | Retorno da Etapa Externa |
20 | conflict | Conflito de Revisão |
21 | completed | Jornada Concluída |
22 | canceled | Jornada Cancelada |
23 | expired | Jornada Expirada |
24 | completion_message_sent | Mensagem de Conclusão Enviada |
JourneyGeolocationStatus
Campo geolocation.status em steps[] e accesses[].
| Code | Key | Nome |
|---|---|---|
1 | not_requested | Não Solicitada |
2 | granted | Autorizada |
3 | denied | Negada |
4 | unavailable | Indisponível |
JourneyMessageChannel
Campo content.messages[].channel.
| Code | Key | Nome |
|---|---|---|
1 | email | |
2 | sms | SMS |
3 | whatsapp |
JourneyMessageEvent
Campo content.messages[].event.
| Code | Key | Nome | Quando é enviada |
|---|---|---|---|
1 | invitation | Convite | Na geração da jornada. |
2 | completed | Conclusão | Quando a jornada é concluída. |
JourneyResumeMode
Campo content.settings.navigation.resumeMode: o que acontece quando o cliente reabre um link já iniciado.
| Code | Key | Nome |
|---|---|---|
1 | continue | Continuar de onde parou |
2 | restart | Recomeçar do início |