Index
Fluxos do WhatsApp em jornadas
Um WhatsApp Flow permite que você tenha uma interação mais estruturada em suas mensagens, como um formulário dentro do WhatsApp. Pense nisso como oferecer aos clientes uma variedade de opções e, em seguida, detalhar essas opções por meio de várias telas para obter informações muito precisas e estruturadas. Essas opções podem estar em diferentes formatos, como caixas de texto, seleções únicas e de múltipla escolha, seletores de data, etc. noreferrer">fornece um exemplo em que as empresas orientam os compradores interessados em uma compra, mostrando primeiro uma visão geral de alto nível dos produtos disponíveis. Os clientes podem então selecionar suas preferências para restringir a um item específico, terminando com um link para concluir o pagamento.
Criando um fluxo do WhatsApp
Fluxos podem ser criados na página Fluxos, em Conteúdo:
WhatsApp Flows são criados com uma linguagem de codificação chamada Flow JSON.
Exemplo: criando um seletor de data simples Fluxo
Quando você precisa obter uma data de um usuário, pedir que ele digite pode ser problemático. Os usuários podem enviar "12-08-2025," "próxima segunda-feira," ou "12 de agosto" o que exige que seu serviço interprete muitos formatos diferentes. O DatePicker do WhatsApp Flows resolve isso apresentando um calendário simples e interativo. Isso melhora a experiência do usuário e fornece sempre uma data perfeitamente formatada.
Existem duas etapas principais para que o DatePicker funcione em suas jornadas.
1. Crie um novo fluxo do WhatsApp
Dê um nome a ele e selecione uma categoria.
Agora, basta copiar e colar este código em seu fluxo e salvá-lo:
{
"telas": [
{
"dados": {},
"id": "APPOINTMENT_SCREEN",
"layout": {
"crianças": [
{
"crianças": [
{
"rótulo": "Sua data de nascimento",
"nome": "Data_de_nascimento",
"obrigatório": verdadeiro,
"tipo": "Selecionador de data",
"texto auxiliar": "Selecione sua data de nascimento"
},
{
"rótulo": "Continuar",
"ação ao clicar": {
"nome": "completo",
"carga útil": {
"data": "${form.Date_of_Birth}"
}
},
"tipo": "Rodapé"
}
],
"nome": "caminho_fluxo",
"tipo": "Formulário"
}
],
"tipo": "SingleColumnLayout"
},
"terminal": verdadeiro,
"título": "Data de Nascimento"
}
],
"versão": "7.2"
}Para entender como esse código funciona, expanda a seção Detalhes abaixo:
Detalhes
Entenda as principais propriedades JSON
Para usar esse código de maneira eficaz, você precisa saber o que as propriedades principais fazem.
id: "APPOINTMENT_SCREEN": Esta é uma peça crucial necessária no lado do Turn.io para permitir que tela deste fluxo para iniciar para um usuário, já que um fluxo pode ter múltiplas telas.
type: "DatePicker": Este é o componente essencial que diz ao WhatsApp para mostrar uma interface de calendário.
name: "date": Este é o identificador dos dados que você recebe. Depois que o usuário selecionar uma data e clicar em "Concluir," seu serviço receberá os dados com este nome (por exemplo, {"date": "2025-10-20"}).
label: "Escolha a data do seu compromisso": Este é o prompt de texto exibido ao usuário acima do seletor de calendário.
min-date: "2024-09-06": Esta propriedade é usada para validação. Neste exemplo, evita que o usuário selecione qualquer data anterior a 6 de setembro de 2024.
type: "Footer" e label: "Complete": Essas propriedades criam o botão de envio no qual o usuário tocará para confirmar a data selecionada. Quando tocado, o fluxo será fechado e enviará os dados de volta ao seu serviço.
A documentação completa dos fluxos pode ser encontrada em Meta.
Depois que o código for salvo, você poderá visualizar a aparência do fluxo para um usuário final no lado direito do código de fluxo.
Publicar
Se estiver satisfeito com a experiência, você pode publicar o fluxo, o que possibilita usá-lo em uma jornada.
2. Chame o fluxo em uma jornada
Depois de escrever, salvar e publicar o fluxo, você agora poderá usá-lo em jornadas. Existem duas opções:
2.1 Usar o cartão de fluxo
Basta adicionar o novo cartão de fluxo à sua jornada e selecionar o fluxo que você criou:
Você também pode editar seus fluxos diretamente no Journeys:
Se você precisar acessar os resultados do seu Flow, basta usar a referência do cartão. Por exemplo, se você estiver coletando um nome e uma idade, e seu cartão se chamar Flow_1, eles estarão acessíveis em @ref_Flow_1.name e @ref_Flow_1.age. Você pode então usar esses dados para atualizar o perfil do usuário, fazer chamadas de API, ramificar a jornada ou o que quiser fazer.
Se o seu fluxo tiver várias telas, você também pode especificar em qual página ele deve começar, referenciando o ID dessa tela na barra lateral:
Se durante um fluxo o usuário digitar uma mensagem de volta, a jornada continuará para o "fluxo não concluído". Se o usuário preencher o Fluxo depois disso, a jornada não retornará ao caminho de resultados do Fluxo:
Os fluxos também podem ser usados para editar dados existentes. Para fazer isso, você pode passar quaisquer dados para um fluxo usando os dados Initial data na barra lateral:
Os fluxos também podem usar expressões e variáveis nesses dados. Usar variáveis para preencher previamente o fluxo pode ser muito poderoso:
Em seu Flow JSON, você também precisa esperar esses dados. Você precisa definir data na definição de fluxo do WhatsApp, bem como init-value para cada campo de entrada para o qual você está passando dados iniciais:
{
"versão": "7.2",
"telas": [
{
"id": "START_SCREEN",
"título": "Olá Mundo",
"terminal": verdadeiro,
"sucesso": verdade,
"dados": {
"nome": {
"tipo": "string",
"__exemplo__": "João"
},
},
"layout": {
"tipo": "SingleColumnLayout",
"crianças": [
{
"tipo": "TextInput",
"nome": "nome",
"rótulo": "Nome",
"valor inicial": "${data.name}"
},
…
]
}
}
]
}2.2 Use o bloco de código
A função de código a ser usada para enviar um fluxo do WhatsApp é:
whatsapp_flow("Continue", "your_flow_id", "APPOINTMENT_SCREEN")Parâmetro | Descrição |
Continuar | O texto a ser exibido no botão que o fluxo gera. O fluxo só começa quando o usuário clica neste botão. |
your_flow_id | Isso pode ser encontrado navegando de volta para a página Fluxo onde você cria um fluxo. Cada fluxo tem seu "ID do fluxo" listado aqui e você pode copiá-lo. |
APPOINTMENT_SCREEN | O nome da tela do fluxo que deve ser mostrada neste momento. Um único fluxo pode ter várias telas. Para nosso código na Etapa 1, tínhamos apenas essa tela. |
A documentação para usar o WhatsApp Flows no Turn.io em diferentes cenários pode ser encontrada aqui. No entanto, um exemplo simplista incorporando o código de fluxo que definimos acima é mostrado abaixo.
card Flow do
fluxo =
whatsapp_flow("Continuar", "seu_fluxo's_id", "APPOINTMENT_SCREEN") faça
header("este é o cabeçalho")
text("este é o corpo")
rodapé("este é o rodapé")
fim
então(Obrigado quando has_text(flow.date))
então (Outro)
fim
cartão Obrigado, faça
text("Obrigado! Seu compromisso está agendado para @flow.date")
fim
cartão Outros fazem
text("Você não selecionou uma data.")
endO acima permite que você envie um fluxo ao usuário com um corpo de texto, um rodapé, um cabeçalho e um botão conforme mostrado abaixo. Você pode, é claro, optar por não enviar o corpo, rodapé e cabeçalho do texto.
O as linhas de código subsequentes no código acima permitem que você acesse a data em que os usuários fizeram o piquete com o "@flow.date" variável. Qualquer variável definida no código do fluxo pode ser acessada dessa forma assim que o fluxo terminar. Uma jornada não avançará até que o fluxo seja concluído ou o usuário a cancele. É por isso que verificamos se o usuário realmente selecionou uma data e ramificamos nossa jornada com base nisso.
Modelos de fluxo
Criamos alguns modelos para ajudá-lo a começar. Basta acessar seu Gerenciador de WhatsApp, criar um novo fluxo e colar o código JSON de qualquer um dos modelos abaixo.
Registro de pacientes
{
"telas":[
{
"dados":{
},"id":"Registro",
"layout":{
"crianças":[
{
"crianças":[
{
"tipo de entrada":"texto",
"rótulo":"Nome',
"nome":"Nome_nome",
"obrigatório":verdadeiro,
"tipo":"TextInput"
},
{
"tipo de entrada":"texto",
"rótulo":"Sobrenome",
"nome":"Sobrenome",
"obrigatório":verdadeiro,
"tipo":"TextInput"
},
{
"rótulo":"Aniversário",
"nome":"Aniversário",
"obrigatório":verdadeiro,
"tipo":"Selecionador de data"
},
{
"fonte de dados":[
{
"id":"0_Masculino",
"título":"Masculino"
},
{
"id":"1_Feminino",
"título":"Feminino"
},
{
"id":"2_Outro",
"título":"Outro"
},
{
"id":"3_Prefer_not_to_say",
"título":"Prefiro não dizer"
}
],
"rótulo":"Sexo",
"nome":"Sexo",
"obrigatório":verdadeiro,
"tipo":"RadioButtonsGroup"
},
{
"texto":"Deseja receber mensagens nossas?",
"tipo":"TextBody"
},
{
"label":"Sim, quero receber mensagens suas",
"nome":"Sim_eu_quero_receber_mensagens_de_você",
"obrigatório":verdadeiro,
"tipo":"Ativar"
},
{
"rótulo":"Concluído",
"ação ao clicar":{
"nome":"completo",
"carga útil":{
"Nome_nome":"${form.Nome_nome}",
"Sobrenome":"${form.Sobrenome}",
"Aniversário":"${form.Aniversário}",
"Sexo":"${form.Gênero}",
"Opt_in":"${form.Yes_I_want_to_receive_messages_from_you}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"terminal":verdadeiro,
"título":"Inscrição"
}
],
"versão":"7.2"
}Agendamento de compromissos
{
"telas":[
{
"dados":{
},
"id":"Reserva",
"layout":{
"crianças":[
{
"crianças":[
{
"fonte de dados":[
{
"id":"0_Consulta_Geral","título":"Consulta geral"
},
{
"id":"1_Consulta_pediátrica",
"título":"Consulta pediátrica"
},
{
"id":"2_Acompanhamento",
"título":"Acompanhamento"
},
{
"id":"3_Exame",
"título":"Exame"
},
{
"id":"4_Emergência",
"título":"Emergência"
}
],
"rótulo":"Motivo da visita",
"nome":"Motivo_da_visita",
"obrigatório":verdadeiro,
"tipo":"RadioButtonsGroup"
},
{
"fonte de dados":[
{
"id":"0_Clínica_A",
"título":"Clínica A"
},
{
"id":"1_Clínica_B",
"título":"Clínica B"
},
{
"id":"2_Clínica_C",
"título":"Clínica C"
}
],
"rótulo":"Clínica",
"nome":"Clínica",
"obrigatório":verdadeiro,
"tipo":"suspenso"
},
{
"rótulo":"Data preferencial",
"nome":"data_preferida",
"obrigatório":verdadeiro,
"tipo":"Selecionador de data"
},
{
"fonte de dados":[
{
"id":"0_8:00-9:00",
"título":"8h00-9h00"
},
{
"id":"1_9:00-10:00",
"título":"9:00-10:00"
},
{
"id":"2_10:00-11:00",
"título":"10:00-11:00"
},
{
"id":"3_11:00-12:00",
"título":"11h00-12h00"
},
{
"id":"4_12:00-13:00",
"título":"12h00-13h00"
},
{
"id":"5_13:00-14:00",
"título":"13:00-14:00"
},
{
"id":"6_14:00-15:00",
"título":"14:00-15:00"
},
{
"id":"7_15:00-16:00",
"título":"15:00-16:00"
},
{
"id":"8_16:00-17:00",
"título":"16:00-17:00"
},
{
"id":"9_17:00-18:00",
"título":"17:00-18:00"
}
],
"rótulo":"horário preferido","nome":"horário_preferido",
"obrigatório":verdadeiro,
"tipo":"CheckboxGrupo"
},
{
"rótulo":"Livro",
"ação ao clicar":{
"nome":"completo",
"carga útil":{
"Motivo_da_visita":"${form.Motivo_da_visita}",
"Clínica":"${form.Clínica}",
"Data_preferida":"${form.data_preferida}",
"Hora_preferida":"${form.Hora_preferida}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"terminal":verdadeiro,
"título":"Agende seu horário"
}
],
"versão":"7.2"
}Ingestão de pacientes
{
"telas":[
{
"dados":{
},
"id":"Visita_atual",
"layout":{
"crianças":[
{
"crianças":[
{
"tipo":"TextArea",
"rótulo":"Motivo da visita",
"obrigatório":verdadeiro,
"nome":"Motivo_da_visita",
"helper-text":"Conte-nos por que você está aqui e quaisquer sintomas que você tenha"
},
{
"tipo de entrada":"texto",
"rótulo":"Duração dos sintomas",
"nome":"Duração_do sintoma",
"obrigatório":verdadeiro,
"tipo":"TextInput",
"helper-text":"Há quanto tempo você sente isso?"
},
{
"rótulo":"Próximo",
"ação ao clicar":{
"nome":"navegar",
"próximo":{
"nome":"histórico_médico",
"tipo":"tela"
},
"carga útil":{
"Motivo_da_visita":"${form.Motivo_da_visita}",
"Symptom_duration":"${form.Symptom_duration}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"título":"Visita atual"
},
{
"dados":{
"Motivo_da_visita":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Duração_dos sintomas":{
"__exemplo__":"Exemplo",
"tipo":"string"
}
},
"id":"Histórico_médico",
"layout":{
"crianças":[
{
"crianças":[
{
"texto":"Por favor, preencha-os da melhor maneira possível. Pule qualquer coisa sobre a qual você não tenha certeza.',
"tipo":"TextBody"
},
{
"fonte de dados":[
{
"id":"0_Fadiga","título":"Fadiga"
},
{
"id":"1_Fever",
"título":"Febre"
},
{
"id":"2_Mudanças_de_peso",
"título":"Alterações de peso"
},
{
"id":"3_Chest_pain",
"título":"Dor no peito"
},
{
"id":"4_Tosse_/_Falta_de_respiração",
"título":"Tosse / Falta de ar"
},
{
"id":"5_Náusea_/_Dor_Abdominal",
"título":"Náusea/Dor abdominal"
},
{
"id":"6_Joint_pain_/_Muscle_aches",
"título":"Dor nas articulações / Dores musculares"
},
{
"id":"7_Dor de cabeça/Tontura",
"título":"Dor de cabeça/Tontura"
},
{
"id":"8_Ansiedade_/_Depressão",
"título":"Ansiedade/Depressão"
}
],
"rótulo":"Condições recentes",
"nome":"Condições_recentes",
"obrigatório":falso,
"tipo":"CheckboxGrupo"
},
{
"fonte de dados":[
{
"id":"0_Diabetes_(Tipo_1_ou_2)",
"título":"Diabetes (Tipo 1 ou 2)"
},
{
"id":"1_High_blood_ Pressure",
"título":"Pressão alta"
},
{
"id":"2_Asma",
"título":"Asma"
},
{
"id":"3_COPD",
"título":"DPOC"
},
{
"id":"4_Artrite",
"título":"Artrite"
},
{
"id":"5_Mental_Health_Issues",
"título":"Questões de saúde mental"
},
{
"id":"6_Outro",
"título":"Outro"
},
{
"id":"7_Option",
"título":"Opção"
}
],
"rótulo":"Condições Crônicas",
"nome":"Condições_Crônicas",
"obrigatório":falso,
"tipo":"CheckboxGrupo"
},
{
"fonte de dados":[
{
"id":"0_Sim",
"título":"Sim"
},
{
"id":"1_Não",
"título":"Não"
}
],"rótulo":"Hospitalizações recentes",
"nome":"hospitalizações_recentes",
"obrigatório":falso,
"tipo":"RadioButtonsGroup"
},
{
"rótulo":"Medicamentos",
"nome":"Medicamentos",
"obrigatório":falso,
"tipo":"TextArea",
"helper-text":"Você está tomando algum medicamento?"
},
{
"rótulo":"Alergias",
"nome":"Alergias",
"obrigatório":falso,
"tipo":"TextArea",
"texto auxiliar":"Alguma alergia conhecida?"
},
{
"rótulo":"Continuar",
"ação ao clicar":{
"nome":"navegar",
"próximo":{
"nome":"história_família",
"tipo":"tela"
},
"carga útil":{
"Condições_recentes":"${form.Condições_recentes}",
"Condições_crônicas":"${form.Condições_crônicas}",
"Hospitalizações_recentes":"${form.hospitalizações_recentes}",
"Medicamentos":"${form.Medicamentos}",
"Alergias":"${form.Allergies}",
"Motivo_para_visita":"${data.Motivo_para_visita}",
"Symptom_duration":"${data.Symptom_duration}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"título":"Histórico médico"
},
{
"dados":{
"Condições_recentes":{
"__exemplo__":[
],
"itens":{
"tipo":"string"
},
"tipo":"matriz"
},
"Condições_crônicas":{
"__exemplo__":[
],
"itens":{
"tipo":"string"
},
"tipo":"matriz"
},
"Hospitalizações_recentes":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Medicamentos":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Alergias":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Motivo_da_visita":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Duração_dos sintomas":{
"__exemplo__":"Exemplo",
"tipo":"string"
}
},
"id":"história_família",
"layout":{
"crianças":[
{
"crianças":[
{
"fonte de dados":[
{
"id":"0_Heart_disease",
"título":"Doença cardíaca"
},
{
"id":"1_Diabetes","título":"Diabetes"
},
{
"id":"2_High_blood_ Pressure",
"título":"Pressão alta"
},
{
"id":"3_Cancer",
"título":"Câncer"
},
{
"id":"4_Stroke",
"título":"Traço"
},
{
"id":"5_Outras_condições_hereditárias",
"título":"Outras condições hereditárias"
}
],
"rótulo":"história_família",
"nome":"história_família",
"obrigatório":falso,
"tipo":"CheckboxGrupo"
},
{
"rótulo":"Continuar",
"ação ao clicar":{
"nome":"navegar",
"próximo":{
"nome":"Estilo de vida",
"tipo":"tela"
},
"carga útil":{
"Family_history":"${form.Family_history}",
"Condições_recentes":"${data.Condições_recentes}",
"Condições_crônicas":"${data.Condições_crônicas}",
"Hospitalizações_recentes":"${data.hospitalizações_recentes}",
"Medicamentos":"${data.Medicamentos}",
"Alergias":"${data.Allergies}",
"Motivo_para_visita":"${data.Motivo_para_visita}",
"Symptom_duration":"${data.Symptom_duration}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"título":"História da família"
},
{
"dados":{
"Histórico_da família":{
"__exemplo__":[
],
"itens":{
"tipo":"string"
},
"tipo":"matriz"
},
"Condições_recentes":{
"__exemplo__":[
],
"itens":{
"tipo":"string"
},
"tipo":"matriz"
},
"Condições_crônicas":{
"__exemplo__":[
],
"itens":{
"tipo":"string"
},
"tipo":"matriz"
},
"Hospitalizações_recentes":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Medicamentos":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Alergias":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Motivo_da_visita":{
"__exemplo__":"Exemplo",
"tipo":"string"
},
"Duração_dos sintomas":{
"__exemplo__":"Exemplo",
"tipo":"string"
}
},"id":"Estilo de vida",
"layout":{
"crianças":[
{
"crianças":[
{
"tipo de entrada":"texto",
"rótulo":"Ocupação",
"nome":"Ocupação",
"obrigatório":falso,
"tipo":"TextInput"
},
{
"fonte de dados":[
{
"id":"0_Sim",
"título":"Sim"
},
{
"id":"1_Não",
"título":"Não"
}
],
"rótulo":"Você fuma?",
"nome":"Você_fuma",
"obrigatório":falso,
"tipo":"RadioButtonsGroup"
},
{
"fonte de dados":[
{
"id":"0_Sim",
"título":"Sim"
},
{
"id":"1_Não",
"título":"Não"
}
],
"rótulo":"Você bebe?",
"nome":"Você_bebe",
"obrigatório":falso,
"tipo":"RadioButtonsGroup"
},
{
"fonte de dados":[
{
"id":"0_Frequentemente",
"título":"Frequentemente"
},
{
"id":"1_Às vezes",
"título":"Às vezes"
},
{
"id":"2_Nunca",
"título":"Nunca"
}
],
"rótulo":"Hábito de exercício",
"nome":"Exercício_hábito",
"obrigatório":falso,
"tipo":"RadioButtonsGroup"
},
{
"rótulo":"Concluído",
"ação ao clicar":{
"nome":"completo",
"carga útil":{
"Ocupação":"${form.Occupation}",
"Você_fuma":"${form.Você_fuma}",
"Você_drink":"${form.Do_you_drink}",
"Exercício_hábito":"${form.Exercício_hábito}",
"Family_history":"${data.Family_history}",
"Condições_recentes":"${data.Condições_recentes}",
"Condições_crônicas":"${data.Condições_crônicas}",
"Hospitalizações_recentes":"${data.hospitalizações_recentes}",
"Medicamentos":"${data.Medicamentos}",
"Alergias":"${data.Allergies}",
"Motivo_para_visita":"${data.Motivo_para_visita}",
"Symptom_duration":"${data.Symptom_duration}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],"tipo":"SingleColumnLayout"
},
"terminal":verdadeiro,
"título":"Estilo de vida"
}
],
"versão":"7.2"
}Seletor de data
{
"telas":[
{
"dados":{
},
"id":"RECOMENDAR",
"layout":{
"crianças":[
{
"crianças":[
{
"rótulo":"Data",
"nome":"Data",
"obrigatório":verdadeiro,
"tipo":"Selecionador de data"
},
{
"rótulo":"Enviar",
"ação ao clicar":{
"nome":"completo",
"carga útil":{
"screen_0_Birthday_0":"${form.Date}"
}
},
"tipo":"Rodapé"
}
],
"nome":"caminho_fluxo",
"tipo":"Formulário"
}
],
"tipo":"SingleColumnLayout"
},
"terminal":verdadeiro,
"título":"Escolha uma data"
}
],
"versão":"7.2"
}