Docs
Páginas desta seção

Filtros de leads e conversas

Por recurso

Fluxos

Catálogo de nós

Todos os tipos de nó que um fluxo aceita, com a configuração, as saídas e as chaves de saída de cada um.

Esta página é gerada a partir do mesmo catálogo que GET /workflows/node-types devolve, então traz exatamente os nós que a API aceita hoje. Para entender como os nós se ligam, leia antes o guia Fluxos.

Como ler cada nó

ItemO que significa
TipoO valor de type do nó no grafo.
CategoriaO valor de category no catálogo.
FluxosOs tipos de fluxo (messages ou voice) que aceitam o nó.
Precisa de conversaO nó só tem efeito quando a execução roda numa conversa; numa execução de lead ele segue sem efeito.
Escopo do gatilhoSó nos gatilhos: conversation dispara apenas nas conversas pelas quais o fluxo responde; global dispara para todo o workspace, conforme a configuração do gatilho.
Comportamento no testeO valor de testBehavior. Em sends_message a mensagem é sempre simulada; em external_call a chamada real só acontece com confirmRealCalls; em waits o teste descreve a espera sem esperar.
ConfiguraçãoOs campos de config. Um campo obrigatório vazio bloqueia a publicação (NODE_MISSING_REQUIRED_FIELD).
SaídasOs ids que as conexões que saem do nó levam em label. Toda saída obrigatória precisa de uma conexão para publicar.
Chaves de saídaO que o nó grava para os passos seguintes, lido com {{node.<id>.<chave>}} ou {{last.<chave>}}.

Índice

NóTipoCategoriaFluxos
Chamado por agente IAtrigger_agent_callGatilhosmessages
Aniversáriotrigger_birthdayGatilhosmessages
Ligação Recebidatrigger_call_receivedGatilhosvoice
Ligação de Campanhatrigger_campaign_callGatilhosvoice
Primeira Mensagemtrigger_first_messageGatilhosmessages
Formulário respondidotrigger_form_submittedGatilhosmessages
Mensagem Recebidatrigger_message_receivedGatilhosmessages
Entrou na etapatrigger_stage_addedGatilhosmessages
Webhooktrigger_webhookGatilhosmessages
Enviar E-mailaction_send_emailMensagensmessages e voice
Enviar e-mail (plataforma)action_send_platform_emailMensagensmessages e voice
Adicionar linha na planilhaaction_add_sheet_rowAçõesmessages e voice
Gerenciar Etiquetaaction_assign_labelAçõesmessages
Atribuir ao Membroaction_assign_memberAçõesmessages
Cancelar mensagens agendadasaction_cancel_scheduled_messagesAçõesmessages e voice
Verificar Disponibilidadeaction_check_calendar_availabilityAçõesmessages e voice
Consentimentoaction_consentAçõesmessages
Criar evento na agendaaction_create_calendar_eventAçõesmessages e voice
Exportar mensagens para planilhaaction_export_messages_sheetAçõesmessages
Finalizar Conversaaction_finish_conversationAçõesmessages
Requisição HTTPaction_http_requestAçõesmessages e voice
Gerenciar Negociaçãoaction_manage_opportunityAçõesmessages
Mover Etapaaction_move_stageAçõesmessages
Tocar Áudioaction_play_audioAçõesvoice
Responder ao agenteaction_reply_to_agentAçõesmessages
Reagendar evento na agendaaction_reschedule_calendar_eventAçõesmessages
Agendar mensagemaction_schedule_messageAçõesmessages e voice
Enviar formulárioaction_send_formAçõesmessages
Enviar Opçõesaction_send_interactiveAçõesmessages
Enviar Mídiaaction_send_mediaAçõesmessages
Enviar pesquisaaction_send_surveyAçõesmessages
Enviar Templateaction_send_templateAçõesmessages e voice
Enviar Textoaction_send_textAçõesmessages
Transferir conversaaction_transfer_departmentAçõesmessages
Transferir para Filaaction_transfer_to_queueAçõesvoice
Atualizar Leadaction_update_leadAçõesmessages
Agente IAaction_ai_agentIAmessages
Código (JavaScript)action_codeLógicamessages e voice
Formatar Data/Horaaction_format_dateLógicamessages e voice
Hora Atualaction_get_current_timeLógicamessages e voice
Loop / Iteraçãoaction_loopLógicamessages e voice
Definir Variávelaction_set_variableLógicamessages e voice
Condiçãocondition_branchCondiçõesmessages e voice
Canalcondition_channelCondiçõesmessages
Verificar Etiquetacondition_check_labelCondiçõesmessages
Verificar Negociaçãocondition_check_opportunityCondiçõesmessages
Verificar Etapacondition_check_stageCondiçõesmessages
Lead tem consentimento?condition_consentCondiçõesmessages
Filtrocondition_filterCondiçõesmessages e voice
Classificar Textocondition_text_matchCondiçõesmessages e voice
Aguardar Teclawait_dtmfEsperasvoice
Aguardar Duraçãowait_durationEsperasmessages
Aguardar Respostawait_for_replyEsperasmessages
Esperar Horáriowait_scheduleEsperasmessages
FimendFimmessages e voice
Plano de Fundodecoration_backgroundDecoraçãomessages

Gatilhos

Chamado por agente IA

Dispara quando um agente de IA executa este fluxo na conversa em que está atendendo.

  • Tipo: trigger_agent_call
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Inicia o fluxo quando um agente de IA chama a ferramenta Executar fluxo durante um atendimento, sempre na conversa atual.

Como funciona: Disponibiliza {{input.<campo>}} com os campos declarados (validados antes de iniciar) e {{agent.id}} / {{agent.name}}. Use o nó Responder ao agente para devolver um resultado ao agente.

Configuração

CampoTipoObrigatórioSignificado
inputsagent_call_inputsNãoCampos recebidos do agente. Cada campo vira um parâmetro da ferramenta Executar fluxo: nome (minúsculas, dígitos e _), tipo (string, number, boolean, object, array), descrição, obrigatório e exemplo.

Configuração padrão

json
{
  "inputs": []
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
input.<campo>não informadoValor de cada campo enviado pelo agente.
agent.idnão informadoID do agente que executou o fluxo.
agent.namenão informadoNome do agente que executou o fluxo.

Aniversário

Dispara uma vez no dia do aniversário de cada lead, no fuso horário da área de trabalho.

  • Tipo: trigger_birthday
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Para parabenizar o lead no dia do aniversário.

Como funciona: Usa a data de nascimento do cadastro do lead. Começa uma execução por lead e por dia, mesmo sem conversa aberta; 29 de fevereiro conta no dia 28 em anos não bissextos. Disponibiliza {{lead_id}}, {{lead_name}} e {{birthday}}. Nós que dependem de uma conversa seguem sem efeito nessas execuções.

Configuração

CampoTipoObrigatórioSignificado
hournumberNãoHora do disparo. Hora do dia (0 a 23) a partir da qual o fluxo começa para os aniversariantes do dia. Limites: mínimo 0, máximo 23, passo 1.

Configuração padrão

json
{
  "hour": 9
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
lead_idnão informadoID do lead.
lead_namenão informadoNome do lead.
birthdaynão informadoData do aniversário (AAAA-MM-DD).

Ligação Recebida

Dispara quando uma ligação chega pelo tronco SIP escolhido. O fluxo atende a ligação no lugar de chamar a equipe.

  • Tipo: trigger_call_received
  • Categoria: trigger
  • Fluxos: voice
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Inicia um fluxo de chamada (URA) quando uma ligação chega por um tronco SIP. Só existe em fluxos do tipo voice.

Como funciona: Atende a ligação e disponibiliza {{caller_number}} e {{called_number}}. Um tronco só pode ter um fluxo de chamada ativo. Chegar em Fim desliga a ligação.

Configuração

CampoTipoObrigatórioSignificado
trunk_idselectSimTronco SIP. Origem das opções: sip_trunks.

Configuração padrão

json
{
  "trunk_id": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
caller_numbernão informadoNúmero de quem ligou.
called_numbernão informadoNúmero discado pelo cliente.

Ligação de Campanha

Dispara quando a pessoa atende uma ligação feita por uma campanha de ligação. A campanha escolhe a linha telefônica e os leads. O fluxo é uma URA: toca áudios gravados e lê teclas, sem voz por IA e sem reconhecimento de fala.

  • Tipo: trigger_campaign_call
  • Categoria: trigger
  • Fluxos: voice
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Inicia um fluxo de chamada quando uma campanha de ligação chama um lead e ele atende. Só existe em fluxos do tipo voice.

Como funciona: O fluxo começa no momento em que a pessoa atende e disponibiliza {{called_number}} e {{lead_name}}. Ligações não atendidas não iniciam o fluxo. Chegar em Fim desliga a ligação. É uma URA de áudios gravados e teclas: não existe nó de voz por IA nem de reconhecimento de fala.

Configuração

Sem campos de configuração.

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
called_numbernão informadoNúmero chamado pela campanha.
lead_namenão informadoNome do lead chamado.

Primeira Mensagem

Dispara quando o contato envia a primeira mensagem.

  • Tipo: trigger_first_message
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: conversation
  • Comportamento no teste: trigger

Quando usar: Inicia o fluxo na PRIMEIRA mensagem do contato (uma vez por contato). Ideal para boas-vindas/atendimento inicial.

Como funciona: Disponibiliza {{message}} com o texto recebido e {{contact_number}} com o endereço do contato no canal (telefone no WhatsApp, id do chat no Telegram/Instagram; ausente em grupos).

Configuração

Sem campos de configuração.

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Formulário respondido

Dispara quando um contato envia um formulário do WhatsApp ou um formulário de um site.

  • Tipo: trigger_form_submitted
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Inicia o fluxo a cada envio de um formulário do WhatsApp ou de um formulário de um site (página publicada), por exemplo para etiquetar a conversa, criar uma negociação ou avisar a equipe.

Como funciona: Cada envio, de um formulário do WhatsApp ou de um site, inicia a sua própria execução, mesmo quando a mesma pessoa envia o formulário de novo. Disponibiliza {{form_id}}, {{form_response_id}} e {{form.<chave_do_campo>}} com o valor exibido de cada resposta (campos sensíveis mascarados). Formulários de site disparam só depois que a página é publicada com o formulário, e entregam os campos da versão publicada. Só dispara para os formulários escolhidos; sem formulário escolhido o fluxo não pode ser publicado.

Configuração

CampoTipoObrigatórioSignificado
form_idsmulti-selectSimFormulários. Escolha ao menos um formulário do WhatsApp ou de um site: sem formulário o gatilho não dispara. Origem das opções: trigger_forms.

Configuração padrão

json
{
  "form_ids": []
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
form_idnão informadoID do formulário respondido (a chave pública, nos formulários de site).
form_response_idnão informadoID da resposta.
form.<campo>não informadoResposta de cada campo pela chave do campo; campos sensíveis chegam mascarados.

Mensagem Recebida

Dispara a cada mensagem recebida no chat.

  • Tipo: trigger_message_received
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: conversation
  • Comportamento no teste: trigger

Quando usar: Inicia o fluxo a CADA mensagem recebida. Use para um atendente que sempre responde.

Como funciona: Disponibiliza {{message}} com o texto recebido e {{contact_number}} com o endereço do contato no canal (telefone no WhatsApp, id do chat no Telegram/Instagram; ausente em grupos).

Configuração

Sem campos de configuração.

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Entrou na etapa

Dispara quando uma conversa deste fluxo entra em uma etapa do funil.

  • Tipo: trigger_stage_added
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: conversation
  • Comportamento no teste: trigger

Quando usar: Para agir quando a conversa muda de etapa no funil, por exemplo avisar a equipe ou mandar um template de acompanhamento.

Como funciona: Disponibiliza {{stage_id}}. Sem etapa escolhida, dispara para qualquer etapa. Vale para toda entrada em etapa: CRM, inbox, Elo, agente de IA, outro fluxo e a etapa inicial de uma conversa nova. Só dispara nas conversas pelas quais este fluxo responde: as dos números, contas e campanhas que usam este fluxo, ou conversas delegadas a ele; outro fluxo com a mesma etapa não dispara junto. Uma etapa mudada por este mesmo fluxo não o inicia de novo, e uma sequência de fluxos movendo a conversa para depois de 3 fluxos seguidos. Enquanto este fluxo está em execução na conversa, uma nova mudança de etapa não inicia outra execução. A conversa pode estar fora da janela de atendimento: comece com um template.

Configuração

CampoTipoObrigatórioSignificado
stage_idselectNãoEtapa. Vazio: qualquer etapa. Origem das opções: stages.

Configuração padrão

json
{
  "stage_id": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
stage_idnão informadoID da etapa em que a conversa entrou.

Webhook

Dispara quando um sistema externo faz um POST na URL do webhook.

  • Tipo: trigger_webhook
  • Categoria: trigger
  • Fluxos: messages
  • Escopo do gatilho: global
  • Comportamento no teste: trigger

Quando usar: Inicia o fluxo a partir de um evento externo (POST HTTP), por exemplo carrinho abandonado, pagamento pendente ou pedido pago de uma loja. Configure a URL, o segredo e o modo de autenticação no painel do nó.

Como funciona: Disponibiliza {{var.webhook.body.*}} com o corpo recebido e {{var.webhook.method}}. Iniciar em Conversa: o payload traz entry_id e entry_type, ou phone de uma conversa existente. Iniciar em Lead: o payload traz phone (o lead é encontrado ou criado, com name no cadastro novo) ou email (lead existente), e o fluxo roda mesmo sem conversa, com {{lead_id}} e {{lead_name}}. event e external_id no payload evitam execuções repetidas quando a loja reenvia o mesmo evento. Nós que dependem de uma conversa seguem sem efeito em execuções de lead.

Configuração

CampoTipoObrigatórioSignificado
start_onselectNãoIniciar em. Conversa: a conversa existente pelo entry_id e entry_type ou pelo phone. Lead: o lead pelo phone (criado se não existir) ou pelo email, mesmo sem conversa. Valores: conversation (Conversa), lead (Lead).
eventstagsNãoEventos aceitos. Opcional. Com eventos, só chamadas cujo campo event esteja na lista começam o fluxo; as outras são aceitas e ignoradas.

Configuração padrão

json
{
  "start_on": "conversation"
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
lead_idnão informadoID do lead.
lead_namenão informadoNome do lead.

Mensagens

Enviar E-mail

Envia um e-mail usando um servidor SMTP configurado pelo usuário.

  • Tipo: action_send_email
  • Categoria: messaging
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para enviar e-mail via SMTP.

Configuração

CampoTipoObrigatórioSignificado
smtp_hosttextSimServidor SMTP. Hostname do servidor SMTP, sem protocolo ou porta.
smtp_portnumberNãoPorta SMTP. 587 para STARTTLS, 465 para TLS implícito ou 25 para relay sem TLS.
smtp_securityselectSimSegurança SMTP. Valores: starttls (STARTTLS), implicit_tls (TLS implícito), none (Sem TLS).
smtp_usernametextNãoUsuário SMTP. Opcional para relays sem autenticação.
smtp_passwordtextNãoSenha SMTP. Obrigatória quando usuário SMTP for informado.
smtp_from_emailtextSimE-mail remetente. Endereço autorizado pelo servidor SMTP.
smtp_from_nametextNãoNome do remetente.
default_reply_totextNãoResponder para padrão. Reply-To padrão opcional.
totextSimDestinatário. Aceita variáveis e múltiplos endereços separados por vírgula.
cctextNãoCc. Destinatários em cópia, separados por vírgula.
bcctextNãoBcc. Destinatários em cópia oculta, separados por vírgula.
reply_totextNãoResponder para. Reply-To específico deste envio.
subjecttextSimAssunto. Aceita variáveis do workflow.
bodytextareaSimConteúdo. Conteúdo HTML ou texto simples. Aceita variáveis do workflow.
body_typeselectNãoFormato. Valores: html (HTML), text (Texto).
timeout_secondsnumberNãoTimeout. Tempo máximo para conectar e enviar.

Configuração padrão

json
{
  "body": "",
  "body_type": "html",
  "smtp_from_email": "",
  "smtp_from_name": "",
  "smtp_host": "",
  "smtp_password": "",
  "smtp_port": 587,
  "smtp_security": "starttls",
  "smtp_username": "",
  "subject": "",
  "timeout_seconds": 30,
  "to": "{{email}}"
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
falhaFalhaNão
timeoutTempo esgotadoNão

Chaves de saída

ChaveTipoDescrição
tolistDestinatários principais usados no envio.
cclistDestinatários em cópia.
bcclistDestinatários em cópia oculta.
subjecttextAssunto enviado.
message_idtextMessage-ID gerado para o e-mail.
server_responsetextResposta do servidor SMTP, quando disponível.
sentbooleantrue se o e-mail foi enviado com sucesso.
successbooleanAlias booleano para sucesso.
errortextErro quando o envio não foi realizado.
next_edgetextSaída seguida pelo workflow: sucesso, falha ou timeout.

Enviar e-mail (plataforma)

Envia um e-mail transacional pelo e-mail da plataforma, com um remetente do seu domínio verificado.

  • Tipo: action_send_platform_email
  • Categoria: messaging
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para mandar um e-mail transacional ao lead (confirmação, código, aviso de pedido) pelos remetentes cadastrados em E-mail.

Como funciona: Vai para o e-mail do cadastro do lead, ou para o endereço em 'to'. Em fluxos de chamada não há cadastro do lead: preencha 'to' (por exemplo, o e-mail da equipe que retorna a ligação). O corpo é um texto ('body_mode' text) ou um design salvo ('body_mode' design). Cobra um envio do saldo antes de enviar e devolve se o envio falhar; respeita a lista de bloqueio e recusa leads bloqueados. Não exige consentimento de marketing e não leva link de descadastro. O e-mail enviado fica registrado na conversa de e-mail do lead, onde a resposta dele também chega. Assunto e texto aceitam variáveis do fluxo {{...}} e as do e-mail ({{first_name}}, {{name}}, {{email}}, {{company}}, {{field.chave}}). Saídas: 'sent' quando o provedor aceitou e 'failed' quando foi recusado; o motivo fica em reason e error.

Configuração

CampoTipoObrigatórioSignificado
sender_idselectNãoRemetente. Vazio usa o remetente padrão do workspace. Origem das opções: email_senders.
totextNãoDestinatário. Vazio usa o e-mail do cadastro do lead. Aceita variáveis do fluxo.
subjecttextSimAssunto.
body_modeselectSimConteúdo. Valores: text (Texto), design (Design salvo).
texttextareaQuando body_mode é textTexto. Parágrafos separados por uma linha em branco. Vale quando body_mode é text.
design_idselectQuando body_mode é designDesign. Origem das opções: email_designs. Vale quando body_mode é design.

Configuração padrão

json
{
  "body_mode": "text",
  "design_id": "",
  "sender_id": "",
  "subject": "",
  "text": "",
  "to": ""
}

Saídas

Saída (label)NomeObrigatória
sentEnviadoSim
failedFalhaNão

Chaves de saída

ChaveTipoDescrição
sentbooleantrue quando o provedor aceitou o e-mail.
message_idtextID do e-mail na plataforma.
provider_message_idtextID do e-mail no provedor.
totextEndereço que recebeu o e-mail.
repeatedbooleantrue quando este passo já tinha enviado e o envio não foi repetido.
reasontextCódigo do motivo quando o envio falha.
errortextDescrição da recusa quando o envio falha.

Ações

Adicionar linha na planilha

Registra uma linha em uma planilha do Google Planilhas criada no painel, com as colunas preenchidas por variáveis do fluxo.

  • Tipo: action_add_sheet_row
  • Categoria: action
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para registrar pedidos, leads, agendamentos ou qualquer dado do fluxo em uma planilha do Google Planilhas.

Como funciona: A linha é validada pelos tipos das colunas e entra na fila de gravação; a saída 'sucesso' significa que ela foi aceita e será gravada em instantes, na ordem. Colunas preenchidas pelo sistema (telefone do lead, data, link da conversa) não entram no mapeamento. Uma variável sem valor leva à saída 'erro', nunca a uma célula com {{...}}. Cada coluna só aceita o tipo dela: número e dinheiro pedem um número, data uma data, data e hora uma data com hora, sim/não um booleano e escolha uma das opções da coluna. Texto (parâmetro de ferramenta do tipo string ou sem tipo, resposta do cliente, formulário) numa coluna desses tipos bloqueia a publicação; declare o parâmetro da ferramenta com o tipo da coluna (number, date, datetime, boolean ou enum com as opções da coluna) ou use um dado da conversa com esse tipo. Quando a aba tem linha única (por conversa, na aba ou no mês da aba, ou pelos valores de colunas escolhidas) e o registro já existe, nada é gravado de novo: o passo segue pela saída opcional 'ja_registrada' se ela estiver ligada, senão pela 'sucesso', com already_recorded=true e existing_row_id apontando a linha que já existia. Numa aba com linha única por conversa, um fluxo sem conversa (iniciado por um lead) segue pela 'erro' com o código google_sheet_unique_needs_conversation. Para gravar numa planilha diferente por conversa (por exemplo, uma por franquia), preencha sheet_variable com um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}; sheet_id passa a ser a aba da planilha modelo desse dado, usada só para mapear as colunas. A planilha da conversa é escolhida quando a execução começa e fica a mesma até o fim; sem ela a execução nem começa, e o passo nunca grava na planilha modelo.

Configuração

CampoTipoObrigatórioSignificado
sheet_idselectSimPlanilha. Origem das opções: google_sheets.
sheet_variablesheet_variableNãoMuda por conversa. Um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}. Vazio grava sempre na mesma planilha.
valuessheet_columnsSimColunas. O valor de cada coluna. Aceita variáveis do fluxo {{...}}.

Configuração padrão

json
{
  "sheet_id": "",
  "values": {}
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão
ja_registradaJá registradaNão

Chaves de saída

ChaveTipoDescrição
row_idtextID da linha na fila de gravação.
sheet_idtextID da planilha.
sheet_titletextTítulo da planilha.
sheet_urltextLink da planilha no Google.
duplicatebooleantrue quando este passo já tinha registrado a linha e ela não foi repetida.
already_recordedbooleantrue quando a aba tem linha única e este registro já existia; nada foi gravado de novo.
existing_row_idtextID da linha que já registrava este registro, quando already_recorded é true.
errortextDescrição da recusa.
error_codetextCódigo da recusa.

Gerenciar Etiqueta

Adiciona ou remove uma etiqueta existente da conversa atual do workflow, em qualquer canal.

  • Tipo: action_assign_label
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: writes_data

Quando usar: Para adicionar ou remover uma etiqueta da conversa.

Como funciona: Idempotente: se a conversa já tem a etiqueta (ao adicionar) ou não tem (ao remover), o nó segue pelo caminho de sucesso sem mudar nada.

Configuração

CampoTipoObrigatórioSignificado
actionselectNãoAção. Valores: add (Adicionar), remove (Remover).
label_idselectSimEtiqueta. Origem das opções: labels.

Configuração padrão

json
{
  "action": "add",
  "label_id": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a conversa fica com a etiqueta pedida.
changedbooleantrue quando a etiqueta foi de fato adicionada ou removida agora.
label_idtextID da etiqueta.
label_nametextNome da etiqueta.
errortextDescrição do erro quando a mudança falha.

Atribuir ao Membro

Atribui a conversa a um membro específico do workspace.

  • Tipo: action_assign_member
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: writes_data

Quando usar: Para atribuir a conversa a um atendente específico.

Configuração

CampoTipoObrigatórioSignificado
member_idselectSimMembro. Origem das opções: members.

Configuração padrão

json
{
  "member_id": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a atribuição é realizada com sucesso.
assigned_user_idtextID do usuário atribuído.
assigned_user_emailtextE-mail do usuário atribuído.
errortextDescrição do erro quando a atribuição falha.

Cancelar mensagens agendadas

Cancela mensagens e templates que este fluxo agendou e que ainda não foram enviados.

  • Tipo: action_cancel_scheduled_messages
  • Categoria: action
  • Fluxos: messages e voice
  • Comportamento no teste: writes_data

Quando usar: Quando o motivo de um agendamento deixou de existir, por exemplo quando o comprovante chegou por outro caminho.

Como funciona: Escolha uma mensagem pelo ID devolvido pelo nó Agendar mensagem ({{node.<id>.follow_up_id}}) ou todas as pendentes que este fluxo agendou. 'mine' cancela as que o fluxo agendou nesta conversa e as que esta execução agendou para um telefone com "Para"; numa execução sem conversa (aniversário, webhook em lead, ligação) só as que esta execução agendou para um telefone. Pelo ID, um template agendado para um telefone é cancelado de qualquer execução deste fluxo; uma mensagem da conversa, só a partir da mesma conversa. Uma mensagem já enviada não é cancelada.

Configuração

CampoTipoObrigatórioSignificado
scopeselectSimO que cancelar. Valores: mine (Todas que este fluxo agendou aqui), id (Uma mensagem pelo ID).
follow_up_idtextQuando scope é idID da mensagem agendada. Vale quando scope é id.

Configuração padrão

json
{
  "follow_up_id": "",
  "scope": "mine"
}

Saídas

Saída (label)NomeObrigatória
sucessoCanceladaSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
cancellednumberQuantas mensagens foram canceladas.
cancelled_idslistIDs das mensagens canceladas.
errortextDescrição da recusa.
error_codetextCódigo da recusa.

Verificar Disponibilidade

Consulta o Google Calendar do workspace e retorna horários livres no período informado.

  • Tipo: action_check_calendar_availability
  • Categoria: action
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para consultar horários livres no Google Calendar, inclusive durante uma ligação (por exemplo, para o dia que quem ligou digitou em Aguardar Tecla com o tipo data).

Como funciona: date_from/date_to aceitam YYYY-MM-DD (dia de expediente inteiro) ou data/hora ISO/RFC3339. date_to vazio consulta até o fim do expediente. Datas iguais sem hora consultam um único dia. Use timezone do workspace. Não invente disponibilidade; só confirme após success=true.

Configuração

CampoTipoObrigatórioSignificado
date_fromtextSimData/hora início.
date_totextNãoData/hora fim.
timezonetextSimTimezone.
slot_durationnumberNãoDuração do slot (minutos).
working_starttextNãoInício do expediente.
working_endtextNãoFim do expediente.
work_daysselectNãoDias de trabalho. Valores: weekdays (Segunda a Sexta), weekdays_saturday (Segunda a Sábado), all_week (Todos os dias).

Configuração padrão

json
{
  "date_from": "{{var.date_from}}",
  "date_to": "",
  "slot_duration": 30,
  "timezone": "America/Sao_Paulo",
  "work_days": "weekdays",
  "working_end": "18:00",
  "working_start": "08:00"
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a consulta foi bem-sucedida.
available_slotstextLista de horários livres formatados.
available_slots_jsontextJSON array com objetos {start, end} dos slots livres.
busy_countnumberQuantidade de eventos ocupados encontrados.
date_fromdateInício do período consultado (RFC3339).
date_todateFim do período consultado (RFC3339).
timezonetextTimezone efetivamente usada.
calendar_emailtextConta Google conectada ao workspace.
errortextDescrição do erro quando a consulta falha.

Consentimento

Registra ou retira o consentimento do lead da conversa para receber mensagens.

  • Tipo: action_consent
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: writes_data

Quando usar: Para gravar no lead da conversa a vontade dele sobre receber mensagens: 'registrar' quando ele aceitou, 'retirar' quando pediu para parar.

Como funciona: Modo 'registrar' só é aceito depois da resposta do lead em todos os caminhos (saída 'replied' de wait_for_reply, uma opção de action_send_interactive ou a saída 'true' de uma condição sobre {{selected_option_id}} ou {{selected_option_title}}) e cita a mensagem do lead que acordou o fluxo, inclusive o toque em um botão de template. Modo 'retirar' vale em qualquer ponto: cita a mensagem que disparou o fluxo ou, sem mensagem, grava a nota do nó com a execução. Depois de retirar, os envios do fluxo para este lead são recusados. Qualquer recusa ou falha interrompe a execução com o motivo; o fluxo fica registrado como autor.

Configuração

CampoTipoObrigatórioSignificado
modeselectSimAção. Valores: registrar (Registrar consentimento), retirar (Retirar consentimento (parar de receber)).
purposetextNãoFinalidade. Opcional. Para que o lead aceitou receber mensagens. Aceita variáveis. Vale quando mode é registrar.
notetextNãoNota. Opcional. Gravada como prova quando a execução não tem uma mensagem do lead. Aceita variáveis. Vale quando mode é retirar.

Configuração padrão

json
{
  "mode": "",
  "note": "",
  "purpose": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoRegistradoSim

Chaves de saída

ChaveTipoDescrição
lead_idtextID do lead da conversa.
changedbooleantrue quando a vontade do lead mudou agora; false quando já estava registrada.
event_idtextID do evento na linha do tempo do lead, quando mudou.

Criar evento na agenda

Cria um evento no Google Calendar do workspace. Gerar um link do Google Meet para o evento é opcional.

  • Tipo: action_create_calendar_event
  • Categoria: action
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para criar um evento no Google Calendar (visita, consulta, chamada ou qualquer compromisso), inclusive durante uma ligação, com o horário confirmado por quem ligou.

Como funciona: Requer uma conexão ativa com o Google Calendar do workspace.

Configuração

CampoTipoObrigatórioSignificado
titletextSimTítulo.
descriptiontextareaNãoDescrição.
locationtextNãoLocal.
start_timetextSimInício.
end_timetextNãoFim.
durationnumberNãoDuração (minutos).
timezonetextSimTimezone.
attendeestextareaNãoConvidados.
create_google_meetselectNãoCriar link do Google Meet (opcional). Valores: true (Sim), false (Não).
send_updatesselectNãoEnviar convites. Valores: all (Todos), externalOnly (Somente externos), none (Não enviar).

Configuração padrão

json
{
  "attendees": "",
  "create_google_meet": "true",
  "description": "Evento agendado via ",
  "duration": 30,
  "end_time": "",
  "location": "",
  "send_updates": "all",
  "start_time": "{{var.start_time}}",
  "timezone": "America/Sao_Paulo",
  "title": "Evento agendado"
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando o evento é criado com sucesso.
titletextTítulo final enviado ao Google Calendar.
google_event_idtextID do evento no Google Calendar.
meeting_linktextLink do Google Meet do evento, vazio quando o Meet não foi pedido.
start_timedateInício do evento em RFC3339.
end_timedateFim do evento em RFC3339.
timezonetextTimezone efetivamente usada.
attendeeslistLista final de participantes convidados.
calendar_emailtextConta Google conectada ao workspace.
errortextDescrição do erro quando a criação falha.

Exportar mensagens para planilha

Grava na planilha uma linha por mensagem da conversa, desde a última exportação desta conversa para a mesma planilha.

  • Tipo: action_export_messages_sheet
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: external_call

Quando usar: Para registrar a linha do tempo de um cliente numa planilha do Google Planilhas, por exemplo quando a conversa entra na etapa de pagamento recebido.

Como funciona: Lê as mensagens novas da conversa desde a última exportação para esta planilha e grava todas de uma vez, uma linha por mensagem, na ordem em que aconteceram. As colunas com fonte de mensagem (data, quem enviou, sentido, texto, link da mídia) mudam a cada linha; as do lead e da conversa se repetem em todas. Repetir o passo nunca duplica linhas. A saída 'erro' recebe recusas da planilha, e nesse caso nada é marcado como exportado. Para gravar numa planilha diferente por conversa (por exemplo, uma por franquia), preencha sheet_variable com um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}; sheet_id passa a ser a aba da planilha modelo desse dado, usada só para mapear as colunas. A planilha da conversa é escolhida quando a execução começa e fica a mesma até o fim; sem ela a execução nem começa, e o passo nunca grava na planilha modelo.

Configuração

CampoTipoObrigatórioSignificado
sheet_idselectSimPlanilha. Origem das opções: google_sheets.
sheet_variablesheet_variableNãoMuda por conversa. Um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}. Vazio grava sempre na mesma planilha.
valuessheet_columnsNãoColunas. O valor das colunas preenchidas pelo fluxo, igual em todas as linhas desta exportação. Aceita variáveis do fluxo {{...}}.

Configuração padrão

json
{
  "sheet_id": "",
  "values": {}
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
exportednumberQuantas mensagens novas entraram na fila de gravação.
duplicatesnumberMensagens que já estavam na planilha e não foram repetidas.
has_morebooleantrue quando há mais mensagens do que cabem em uma exportação; a próxima exportação continua delas.
sheet_idtextID da planilha.
sheet_titletextTítulo da planilha.
sheet_urltextLink da planilha no Google.
errortextDescrição da recusa.
error_codetextCódigo da recusa.

Finalizar Conversa

Encerra a conversa atual no CRM (status Finalizada). Reabre se o cliente mandar mensagem de novo.

  • Tipo: action_finish_conversation
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: writes_data

Quando usar: Quando o fluxo concluiu o atendimento e a conversa deve sair do conjunto aberto (ex.: após despedida, resolução, ou fim de automação).

Como funciona: Chama o mesmo serviço de status que humanos e a ferramenta finish_conversation da IA. Origem: system · motivo: workflow. Idempotente se já estiver finalizada. Não encerra o run do workflow, conecte a saída sucesso a um nó Fim se quiser terminar o fluxo.

Configuração

CampoTipoObrigatórioSignificado
outcome_codeselectNãoDesfecho. O desfecho registrado no encerramento, da lista do workspace. Obrigatório quando o workspace exige um desfecho; sem ele o nó sai pela saída erro. Origem das opções: outcomes.
notetextNãoNota (opcional). Apenas registro no output do nó; o motivo de sistema permanece workflow.

Configuração padrão

json
{
  "note": "",
  "outcome_code": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a conversa foi finalizada (ou já estava).
entry_idtextID da entrada finalizada.
entry_typetextTipo da entrada (whatsapp, unofficial_whatsapp, instagram, telegram ou support).
close_sourcetextProveniência do encerramento (system).
close_reasontextMotivo (workflow).
close_outcometextCódigo do desfecho registrado, quando houver.
errortextDescrição do erro quando falha.

Requisição HTTP

Faz uma requisição HTTP para um serviço externo.

  • Tipo: action_http_request
  • Categoria: action
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para chamar uma API externa (ex.: ViaCEP, CRM, etc.).

Como funciona: Monte url, headers e corpo com variáveis (ex.: url com {{node.<id>.<arg>}}). Se a resposta for JSON, CADA campo do corpo torna-se uma saída de dados deste nó, acessível adiante via {{node.<id>.<campo>}} (ex.: {{node.n4.logradouro}}). Credenciais (senha, token, chave de API) ficam nos segredos do workspace: use {{secret.<nome>}} na url, nos headers, no corpo ou no token; o valor só é lido ao montar a requisição e nunca vai para o estado nem para os logs.

Configuração

CampoTipoObrigatórioSignificado
methodselectSimMétodo. Valores: GET (GET), POST (POST), PUT (PUT), PATCH (PATCH), DELETE (DELETE), HEAD (HEAD), OPTIONS (OPTIONS).
urltextSimURL.
headerskeyvalueNãoHeaders. Cabeçalhos HTTP em formato chave-valor.
query_paramskeyvalueNãoParâmetros de Query. Parâmetros adicionados à URL (?key=value).
bodytextareaNãoCorpo da Requisição. Corpo JSON da requisição (suporta variáveis).
auth_typeselectNãoAutenticação. Valores: vazio (Nenhuma), bearer (Bearer Token), basic (Basic Auth), api_key (API Key (Header)).
auth_tokentextNãoToken / Senha. Bearer token, senha do Basic Auth, ou valor da API Key.
auth_usertextNãoUsuário (Basic Auth). Apenas para Basic Auth.
auth_key_nametextNãoNome do Header (API Key). Nome do header para API Key.
timeout_secondsnumberNãoTimeout (segundos). Tempo máximo de espera pela resposta, até 30 segundos.
capture_variabletextNãoSalvar resposta em variável. Salva o corpo da resposta em uma variável para uso em nós posteriores.
capture_labeltextNãoNome amigável da resposta. Como a resposta aparece nas listas e nos campos.

Configuração padrão

json
{
  "headers": {},
  "method": "GET",
  "url": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
falhaFalhaNão
timeoutTempo esgotadoNão

Chaves de saída

ChaveTipoDescrição
status_codenumberCódigo HTTP (ex: 200, 404).
bodytextCorpo bruto da resposta (string).
successbooleantrue se status < 400.
*não informadoSe a resposta for JSON, cada campo do objeto é extraído automaticamente. Ex: se o body for {"bairro":"Sé"}, use {{last.bairro}}.

Gerenciar Negociação

Cria ou atualiza negociações da conversa: valor, etapa, ganho ou perda.

  • Tipo: action_manage_opportunity
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: writes_data

Quando usar: Para registrar a venda da conversa no funil de negociações, por exemplo depois que um agente confirma o fechamento.

Como funciona: Sem ID da negociação, o nó age na única negociação aberta da conversa neste funil; com mais de uma aberta, segue pela saída Erro. Criar nova negociação sempre abre outra, para quando a conversa trata mais de um contrato. Mover, atualizar valor e marcar como perdido nunca criam negociação. O fluxo fica registrado como responsável e autor. Ganho exige valor; perdido exige motivo.

Configuração

CampoTipoObrigatórioSignificado
pipeline_idselectSimFunil de negociações. O funil de negociações onde fica a negociação desta conversa. Origem das opções: opportunity_pipelines.
actionselectSimAção. Valores: create (Criar ou atualizar), create_new (Criar nova negociação), update_value (Atualizar valor), move (Mover de etapa), win (Marcar como ganho), lose (Marcar como perdido).
opportunity_idtextNãoID da negociação. Opcional. Vazio: a única negociação aberta da conversa neste funil. Com mais de uma aberta, informe o ID vindo de um passo anterior. Vale quando action é create, update_value, move, win ou lose.
stage_idselectQuando action é moveEtapa da negociação. Etapa onde a negociação fica. Obrigatória para mover. Origem das opções: opportunity_stages. Vale quando action é create, create_new ou move.
titletextNãoTítulo. Título usado quando a negociação é criada. Vale quando action é create ou create_new.
valuetextQuando action é update_valueValor. Número com ponto decimal, ex.: 1500.50. Aceita variáveis. Ganho exige valor quando a negociação ainda não tem. Vale quando action é create, create_new, update_value ou win.
lost_reasontextQuando action é loseMotivo da perda. Aceita variáveis. Vale quando action é lose.

Configuração padrão

json
{
  "action": "create",
  "pipeline_id": "",
  "title": "Negociação da conversa",
  "value": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a negociação foi registrada.
createdbooleantrue quando a negociação foi criada agora.
opportunity_idtextID da negociação.
statustextSituação da negociação: open, won ou lost.
stage_idtextID da etapa da negociação.
titletextTítulo da negociação.
value_centsnumberValor em centavos.
valuenumberValor na unidade da moeda.
currencytextMoeda da negociação.
errortextMotivo quando a negociação não pôde ser registrada.

Mover Etapa

Move a conversa para a etapa escolhida. Uma conversa de outro funil vai para o funil dessa etapa.

  • Tipo: action_move_stage
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: writes_data

Quando usar: Para avançar a conversa no funil conforme o fluxo (ex.: qualificado, proposta enviada, ganho) ou para levá-la a uma etapa de outro funil de conversas.

Como funciona: A conversa vai exatamente para a etapa escolhida. Se ela está em outro funil, muda para o funil dessa etapa, como quem usa "mover para funil" no CRM; uma conversa ainda sem etapa entra no funil da etapa escolhida. Já estando na etapa, não muda nada. Só etapas de funis de conversa servem; etapas de funis de negociações são recusadas. pipeline_changed diz se a conversa trocou de funil, from_pipeline_id e from_pipeline_name dizem de onde ela saiu.

Configuração

CampoTipoObrigatórioSignificado
stage_idselectSimEtapa. A etapa para onde a conversa vai. Uma conversa de outro funil muda para o funil desta etapa. Origem das opções: stages.

Configuração padrão

json
{
  "stage_id": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a conversa está na etapa escolhida.
changedbooleantrue quando a conversa mudou de etapa (false se já estava nela).
stage_idtextID da etapa escolhida.
stage_nametextNome da etapa escolhida.
pipeline_idtextID do funil da etapa escolhida.
pipeline_nametextNome do funil da etapa escolhida.
from_stage_idtextID da etapa anterior (vazio se não havia).
from_stage_nametextNome da etapa anterior.
from_pipeline_idtextID do funil onde a conversa estava (vazio se não havia etapa).
from_pipeline_nametextNome do funil onde a conversa estava.
pipeline_changedbooleantrue quando a conversa saiu de outro funil para o funil da etapa escolhida.
errortextDescrição do erro quando a conversa não pôde ser movida.
error_codetextCódigo da recusa quando a conversa não pôde ser movida.

Tocar Áudio

Toca um áudio da biblioteca de mídias para quem está na ligação.

  • Tipo: action_play_audio
  • Categoria: action
  • Fluxos: voice
  • Comportamento no teste: voice_only

Quando usar: Para falar com quem ligou: saudação, menu de opções ou aviso. Só existe em fluxos de chamada.

Como funciona: Toca o áudio escolhido (media_id, use find_resource medias com um arquivo de áudio). Com 'interruptible' (padrão), uma tecla pressionada corta o áudio e fica guardada para o próximo wait_dtmf, como numa URA.

Configuração

CampoTipoObrigatórioSignificado
media_idselectSimÁudio. Arquivo de áudio da biblioteca de mídias. Origem das opções: medias.
interruptiblebooleanNãoTecla interrompe o áudio. Quem ligou pode escolher a opção sem ouvir o áudio até o fim.

Configuração padrão

json
{
  "interruptible": true,
  "media_id": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
interruptedbooleanVerdadeiro quando uma tecla cortou o áudio.

Responder ao agente

Devolve um resultado ao agente de IA que executou este fluxo.

  • Tipo: action_reply_to_agent
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: pure

Quando usar: Em fluxos com o gatilho Chamado por agente IA, para contar ao agente o que aconteceu (por exemplo status e mensagem).

Como funciona: Interpola cada campo, mascara dados sensíveis (tokens, senhas, CPF) e grava o mapa como resultado da execução; a última gravação vale. O agente vê só esses campos, nunca o estado interno do fluxo. Segue pela saída padrão e disponibiliza os mesmos campos em {{last.<campo>}}.

Configuração

CampoTipoObrigatórioSignificado
fieldsagent_reply_fieldsNãoCampos devolvidos ao agente. Lista de chave e valor; o valor aceita variáveis como {{input.cpf}} ou {{node.<id>.<campo>}}.

Configuração padrão

json
{
  "fields": []
}

Saídas

Encerra o caminho e não tem saídas.

Chaves de saída

ChaveTipoDescrição
<campo>não informadoCada campo devolvido ao agente, já mascarado.

Reagendar evento na agenda

Muda a data/horário de um evento já existente no Google Calendar, mantendo os participantes e o link do Google Meet, quando houver.

  • Tipo: action_reschedule_calendar_event
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: external_call

Quando usar: Para mudar a data/horário de um evento existente na agenda (reagendamento).

Como funciona: Requer o ID do evento (google_event_id do nó Criar evento na agenda) e uma conexão ativa com o Google Calendar.

Configuração

CampoTipoObrigatórioSignificado
event_idtextSimID do evento.
start_timetextSimNovo início.
end_timetextNãoNovo fim.
durationnumberNãoDuração (minutos).
timezonetextSimTimezone.
send_updatesselectNãoNotificar participantes. Valores: all (Todos), externalOnly (Somente externos), none (Não notificar).

Configuração padrão

json
{
  "duration": 0,
  "end_time": "",
  "event_id": "{{var.google_event_id}}",
  "send_updates": "all",
  "start_time": "{{var.start_time}}",
  "timezone": "America/Sao_Paulo"
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando o evento é reagendado com sucesso.
google_event_idtextID do evento no Google Calendar.
meeting_linktextLink do Google Meet do evento, vazio quando o evento não tem Meet.
start_timedateNovo início em RFC3339.
end_timedateNovo fim em RFC3339.
timezonetextTimezone efetivamente usada.
errortextDescrição do erro quando o reagendamento falha.

Agendar mensagem

Agenda uma mensagem ou um template do WhatsApp para mais tarde, como cobrar um comprovante. Aparece nas mensagens agendadas da conversa que vai recebê-la.

  • Tipo: action_schedule_message
  • Categoria: action
  • Fluxos: messages e voice
  • Precisa de conversa: sim
  • Comportamento no teste: writes_data

Quando usar: Para lembrar o contato de algo mais tarde (um comprovante, um documento, uma resposta) sem prender o fluxo esperando. Com message_kind 'template' a mensagem agendada é o próprio template aprovado; com "Para" (campo 'to') ele vai para qualquer telefone, de qualquer fluxo: aniversário, webhook em lead, formulário ou ligação.

Como funciona: message_kind 'text' (o padrão) agenda o texto na conversa do fluxo; ao agendar, o passo confere se o horário cai dentro da janela de 24 horas do WhatsApp oficial (que vai até 24 horas depois da última mensagem do contato): dentro, agenda o texto; fora, agenda o template de reserva (fallback_template_id com fallback_params) e, sem ele, vai para a saída 'erro'. Para lembrar o contato em qualquer horário, use um único passo com message_kind 'text' e fallback_template_id; não divida o fluxo por horário (com código ou condição) para escolher entre texto e template: o passo já escolhe pela janela real, que conta a partir da última mensagem do contato e não de agora. message_kind 'template' agenda o template escolhido em template_id com template_params (um valor por variável do template, na ordem: primeiro a variável do cabeçalho de texto, se houver, depois as do corpo; um cabeçalho de imagem, vídeo ou documento usa a mídia do próprio template e não leva valor); não precisa de texto, vale dentro ou fora da janela, é cobrado no envio e o horário vai até 30 dias. Sem "Para" o template vai ao contato da conversa do WhatsApp oficial; em fluxos de chamada, sem "Para", vai a quem ligou. Com "Para" ou em fluxos de chamada, business_phone_id (o número do WhatsApp que envia) é obrigatório; a mensagem fica na conversa desse telefone com esse número, que é aberta se ainda não existir, e no horário sai pelo mesmo envio do botão Enviar template do CRM (saldo, limite mensal, opt-out, bloqueio e proteção contra spam). 'to' aceita um número fixo ou um dado do fluxo, como o telefone do lead; um dado sem valor ou um telefone inválido vai para a saída 'erro'. Por padrão a mensagem é cancelada se o contato responder antes, na conversa que vai recebê-la. Ao agendar e de novo antes de enviar, o sistema confere se uma pessoa assumiu a conversa que vai receber a mensagem (a do fluxo ou, com "Para", a desse telefone): ao agendar, vai para a saída 'erro' com follow_up_not_allowed; no horário, a mensagem não é enviada e fica cancelada. Cada conversa guarda no máximo 3 mensagens pendentes agendadas por automação.

Configuração

CampoTipoObrigatórioSignificado
message_kindchoice_cardsNãoO que agendar. Valores: text (Mensagem escrita), template (Sempre um template).
texttextareaQuando message_kind é vazio ou textMensagem. Vale quando message_kind é vazio ou text.
fallback_template_idselectNãoTemplate de reserva. Se a janela de 24h estiver fechada no horário, envia este template. Só no WhatsApp oficial. Origem das opções: whatsapp_templates. Vale quando message_kind é vazio ou text.
fallback_paramstagsNãoValores do template de reserva. As variáveis do template de reserva, na ordem: primeiro a do cabeçalho de texto, se houver, depois as do corpo. Aceita dados do fluxo. Vale quando message_kind é vazio ou text.
totextNãoPara. Telefone que recebe o template. Aceita um dado do fluxo ou um número fixo. Vale quando message_kind é template.
business_phone_idselectQuando to está preenchidoNúmero do WhatsApp. Obrigatório quando Para está preenchido e em fluxos de chamada. Origem das opções: business_phones. Vale quando message_kind é template.
template_idselectQuando message_kind é templateTemplate WhatsApp. Origem das opções: whatsapp_templates. Vale quando message_kind é template.
template_paramstagsNãoValores do template. As variáveis do template, na ordem: primeiro a do cabeçalho de texto, se houver, depois as do corpo. Aceita dados do fluxo. Vale quando message_kind é template.
when_modeselectSimQuando. Valores: in (Daqui a um tempo), day (Daqui a alguns dias, num horário), date (Numa data e horário).
delay_amountnumberQuando when_mode é inQuanto tempo. Número inteiro maior que zero, ou uma variável. Vale quando when_mode é in.
delay_unitselectQuando when_mode é inUnidade. Ou uma variável com minutes, hours ou days. Valores: minutes (Minutos), hours (Horas), days (Dias). Vale quando when_mode é in.
days_from_todaynumberQuando when_mode é dayDias a partir de hoje. 0 hoje, 1 amanhã, ou uma variável. Vale quando when_mode é day.
datetextQuando when_mode é dateData. Vale quando when_mode é date.
timetextQuando when_mode é day ou dateHorário. HH:MM no fuso do workspace, ou uma variável. Vale quando when_mode é day ou date.
cancel_on_replybooleanNãoCancelar se o contato responder. Ligado: qualquer mensagem do contato antes do horário, na conversa que vai receber a mensagem, cancela o envio.

Configuração padrão

json
{
  "business_phone_id": "",
  "cancel_on_reply": true,
  "date": "",
  "days_from_today": 1,
  "delay_amount": 4,
  "delay_unit": "hours",
  "fallback_template_id": "",
  "message_kind": "text",
  "template_id": "",
  "text": "",
  "time": "10:00",
  "to": "",
  "when_mode": "in"
}

Saídas

Saída (label)NomeObrigatória
sucessoAgendadaSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
follow_up_idtextID da mensagem agendada, para cancelar depois.
scheduled_attextHorário do envio em UTC (ISO 8601).
scheduled_fortextHorário do envio no fuso do workspace (DD/MM/AAAA HH:MM).
kindtexttext ou template.
errortextDescrição da recusa.
error_codetextCódigo da recusa.
error_fieldtextCampo do horário que foi recusado.
error_field_labeltextNome do campo do horário que foi recusado.

Enviar formulário

Envia um formulário do WhatsApp e espera o contato responder. Só no WhatsApp oficial, com a janela de 24 horas aberta.

  • Tipo: action_send_form
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: waits

Quando usar: Para coletar vários dados de uma vez (cadastro, pesquisa, agendamento) com um formulário publicado do WhatsApp.

Como funciona: O nó PAUSA até o contato enviar o formulário. Respostas comuns de texto NÃO avançam o nó. Saídas: 'completed' (formulário enviado pelo contato), 'no_reply' (sem resposta até o timeout), 'send_failed' (não foi possível enviar: janela de 24 horas fechada sem template reserva, canal que não é WhatsApp oficial, formulário não publicado no número). Com a janela fechada, o template reserva (um template aprovado com botão deste formulário) é enviado no lugar e o nó continua esperando a resposta. Depois de 'completed' o fluxo tem {{form_response_id}} e {{form.<chave_do_campo>}} com o valor exibido de cada resposta (campos sensíveis mascarados).

Configuração

CampoTipoObrigatórioSignificado
form_idselectSimFormulário. Origem das opções: whatsapp_forms.
headertextNãoCabeçalho.
bodytextareaSimTexto da mensagem.
footertextNãoRodapé.
ctatextSimTexto do botão.
timeout_secondsnumberNãoTimeout (segundos).
fallback_template_idselectNãoTemplate reserva. Enviado quando a janela de 24 horas está fechada. Opcional. Origem das opções: whatsapp_templates.
fallback_paramskeyvalueNãoParâmetros do template reserva.

Configuração padrão

json
{
  "body": "",
  "cta": "",
  "fallback_params": {},
  "fallback_template_id": "",
  "footer": "",
  "form_id": "",
  "header": "",
  "timeout_seconds": 300
}

Saídas

Saída (label)NomeObrigatória
completedRespondeuSim
no_replyNão respondeuNão
send_failedFalha no envioNão

Chaves de saída

ChaveTipoDescrição
sentbooleantrue se o formulário foi enviado.
form_idtextID do formulário enviado.
send_idtextID do envio do formulário.
message_idtextID da mensagem enviada.
reasontextMotivo quando o envio falha.
fallback_template_idtextID do template reserva, quando ele foi enviado no lugar do formulário.
form_response_idtextID da resposta (após a resposta).
form.<campo>não informadoResposta de cada campo pela chave do campo (após a resposta).

Enviar Opções

Envia uma escolha única (botões ou lista) e ramifica o fluxo conforme a opção escolhida pelo contato. Funciona no WhatsApp, Instagram e Telegram, cada canal exibe as opções no formato que suporta.

  • Tipo: action_send_interactive
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: waits

Quando usar: Para pedir uma escolha ÚNICA e seguir um caminho diferente por opção. Use 'buttons' para poucas opções e 'list' para muitas; cada canal renderiza no formato nativo dele.

Como funciona: Saídas DINÂMICAS: cada opção (botão ou linha da lista) vira uma saída com o MESMO id da opção. Preencha as opções ANTES de conectar. Ao conectar qualquer saída de opção (ou 'no_match'/'no_reply'/'send_failed'), o nó PAUSA aguardando a resposta e ramifica pelo id escolhido. Saídas opcionais: 'no_match' (respondeu algo fora das opções), 'no_reply' (não respondeu até o timeout), 'send_failed' (falha no envio). Sem nenhuma saída de opção conectada, comporta-se como envio simples e segue adiante (compatibilidade). LIMITES POR CANAL: WhatsApp exibe 3 botões ou 10 itens de lista (com descrição por item); Instagram exibe até 13 opções com rótulo de 20 caracteres e SEM descrição; Telegram exibe as opções em teclado inline, sem limite prático de quantidade nem de rótulo, mas o id da opção não pode passar de 64 bytes. Opções além do limite de um canal simplesmente não aparecem nele, o editor mostra quais. FORMATO EXATO das opções, com as chaves escritas exatamente assim: buttons é uma string JSON com a lista de {"Type":"reply","ID":"...","Title":"...","CopyCode":""}; sections é uma string JSON com a lista de {"title":"...","rows":[{"id":"...","title":"...","description":"..."}]} (minúsculas).

Configuração

CampoTipoObrigatórioSignificado
interactive_typeselectNãoFormato. Valores: buttons (Botões (poucas opções)), list (Lista (muitas opções)).
header_typeselectNãoTipo de Cabeçalho. Valores: vazio (Nenhum), text (Texto), image (Imagem), video (Vídeo).
header_texttextNãoTexto do Cabeçalho.
header_media_urltextNãoURL da Mídia.
bodytextareaSimTexto da mensagem.
footertextNãoRodapé.
buttonsbuttonsNãoBotões.
list_buttontextNãoRótulo do menu (lista).
sectionslist_sectionsNãoOpções da lista.
timeout_secondsnumberNãoTimeout (segundos).

Configuração padrão

json
{
  "body": "Seu texto aqui",
  "buttons": "[]",
  "footer": "",
  "header_media_url": "",
  "header_text": "",
  "header_type": "",
  "interactive_type": "buttons",
  "list_button": "Ver opções",
  "sections": "[]",
  "timeout_seconds": 300
}

Saídas

As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.

Chaves de saída

ChaveTipoDescrição
message_idtextID da mensagem enviada.
sentbooleantrue se enviado com sucesso.
selected_option_idtextid da opção escolhida (após a resposta).
selected_option_titletexttexto da opção escolhida (após a resposta).

Enviar Mídia

Envia uma imagem, vídeo, áudio ou documento ao contato.

  • Tipo: action_send_media
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: sends_message

Quando usar: Para enviar imagem, vídeo, áudio ou documento.

Configuração

CampoTipoObrigatórioSignificado
media_idselectNãoMídia Salva. Origem das opções: medias.
media_urltextNãoURL da Mídia.
captiontextareaNãoLegenda.

Configuração padrão

json
{
  "caption": "",
  "media_id": "",
  "media_url": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
media_urltextURL da mídia enviada.
media_typetextTipo da mídia (image, video, audio, document).
captiontextLegenda enviada.
message_idtextID da mensagem enviada.
sentbooleantrue se enviado com sucesso.

Enviar pesquisa

Envia agora uma pesquisa de satisfação (CSAT ou NPS) para o contato da conversa.

  • Tipo: action_send_survey
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: writes_data

Quando usar: Para pedir a nota do atendimento num ponto do fluxo, sem esperar a conversa ser encerrada.

Como funciona: Usa a pesquisa escolhida e as mesmas regras do envio automático: no WhatsApp oficial só com a janela de 24 horas aberta, e no máximo uma pesquisa por contato a cada 24 horas. Saídas: 'sent' (enviada), 'cooling_down' (o contato já recebeu uma pesquisa nas últimas 24 horas), 'failed' (pesquisa removida, janela fechada, canal sem pesquisa ou envio recusado; o motivo fica em {{node.<id>.reason}}). A resposta do contato é registrada na pesquisa, não no fluxo.

Configuração

CampoTipoObrigatórioSignificado
survey_idselectSimPesquisa. Origem das opções: surveys.

Configuração padrão

json
{
  "survey_id": ""
}

Saídas

Saída (label)NomeObrigatória
sentEnviadaSim
cooling_downJá recebeu hojeNão
failedNão enviadaNão

Chaves de saída

ChaveTipoDescrição
sentbooleantrue quando a pesquisa foi enviada.
survey_idtextID da pesquisa.
send_idtextID do envio da pesquisa.
message_idtextID da mensagem enviada.
reasontextMotivo quando a pesquisa não é enviada.
errortextDescrição da recusa.

Enviar Template

Envia um template pré-aprovado do WhatsApp para o contato da conversa ou, com "Para" preenchido, para qualquer número. Selecione o número do WhatsApp emissor.

  • Tipo: action_send_template
  • Categoria: action
  • Fluxos: messages e voice
  • Precisa de conversa: sim
  • Comportamento no teste: sends_message

Quando usar: Para enviar um template de WhatsApp pré-aprovado (necessário fora da janela de 24h). Sem "Para", envia ao contato da conversa do WhatsApp oficial. Com "Para" (campo 'to'), envia a qualquer telefone, de qualquer fluxo: conversa de Instagram ou e-mail, webhook, formulário, aniversário ou ligação. Em fluxos de chamada, sem "Para", envia ao número de quem ligou.

Como funciona: Com "Para" ou em fluxos de chamada, o envio é o mesmo do botão Enviar template do CRM: abre ou reaproveita a conversa desse telefone no número escolhido em "Número do WhatsApp" (obrigatório nesses casos), cobra o saldo pelo preço da categoria, estorna se o WhatsApp recusar, respeita o limite mensal de envios, opt-out, bloqueio e a proteção contra spam, e conta como envio avulso no resumo de campanhas. 'to' aceita uma variável ({{caller_number}}, um dado da conversa, de planilha ou de HTTP) ou um número fixo; o telefone é validado no envio. Se o envio for recusado (telefone inválido, opt-out, bloqueio, sem saldo, limite mensal, template não aprovado, conversa já aberta), o passo falha com o código do motivo e o fluxo para com alerta, sem nova tentativa.

Configuração

CampoTipoObrigatórioSignificado
totextNãoPara. Telefone que recebe o template. Aceita variáveis ou um número fixo.
business_phone_idselectQuando to está preenchidoNúmero do WhatsApp. Origem das opções: business_phones.
template_idselectSimTemplate WhatsApp. Origem das opções: whatsapp_templates.
paramskeyvalueNãoParâmetros do Template.

Configuração padrão

json
{
  "business_phone_id": "",
  "params": {},
  "template_id": "",
  "to": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
business_phone_idtextID do número do WhatsApp usado no envio.
template_idtextID do template enviado.
template_nametextNome do template enviado.
message_idtextID da mensagem enviada.
sentbooleantrue se enviado com sucesso.

Enviar Texto

Envia uma mensagem de texto ao contato.

  • Tipo: action_send_text
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: sends_message

Quando usar: Para enviar uma mensagem de texto ao contato (texto fixo ou montado com variáveis). Útil para enviar a saída de um nó anterior, ou em canais onde o agente não envia sozinho.

Configuração

CampoTipoObrigatórioSignificado
texttextareaSimTexto da Mensagem.

Configuração padrão

json
{
  "text": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
texttextTexto enviado.
sentbooleantrue se enviado com sucesso.
message_idtextID da mensagem no canal.

Transferir conversa

Passa a conversa a uma pessoa pela roleta do workspace (a mesma regra de distribuição da primeira mensagem) e pausa a automação. O departamento é opcional: vazio, usa o da conversa.

  • Tipo: action_transfer_department
  • Categoria: action
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: writes_data

Quando usar: Para passar a conversa a uma pessoa pela roleta, do departamento da conversa ou de um departamento escolhido.

Como funciona: Usa o modo da roleta do workspace (online ou última vez online) e só entrega a quem pode receber conversas. Sem ninguém disponível, a conversa vai para a fila da equipe (queued = true). Pausa a automação desta conversa.

Configuração

CampoTipoObrigatórioSignificado
department_idselectNãoDepartamento. Vazio: usa o departamento da própria conversa. Origem das opções: departments.

Configuração padrão

json
{
  "department_id": ""
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando a conversa foi entregue a alguém ou à fila da equipe.
queuedbooleantrue quando ninguém estava disponível e a conversa foi para a fila da equipe.
department_idtextID do departamento escolhido (vazio: departamento da conversa).
department_nametextNome do departamento escolhido.
assigned_user_idtextID de quem recebeu a conversa (vazio na fila da equipe).
assigned_user_emailtextE-mail de quem recebeu a conversa.
errortextDescrição do erro quando a transferência falha.

Transferir para Fila

Coloca quem ligou na fila com música de espera até um atendente livre atender.

  • Tipo: action_transfer_to_queue
  • Categoria: action
  • Fluxos: voice
  • Comportamento no teste: voice_only

Quando usar: Para passar a ligação a uma pessoa: depois do menu, na opção 'falar com atendente'. Só existe em fluxos de chamada.

Como funciona: Escolha a fila (queue_id, use find_resource call_queues). Quem ligou ouve a música de espera da fila e é entregue a quem está livre há mais tempo (ou à estratégia da fila). 'notes' chega ao atendente antes de atender e aceita variáveis como {{var.x}}. Quando alguém atende, o fluxo termina e a ligação segue com o atendente. Se o tempo máximo de espera da fila passar, segue pela saída 'timeout'; sem ela conectada, a ligação é encerrada.

Configuração

CampoTipoObrigatórioSignificado
queue_idselectSimFila. Fila de atendimento que recebe a ligação. Origem das opções: call_queues.
notestextareaNãoNota para o atendente. Aparece para o atendente antes de ele atender. Aceita variáveis.

Configuração padrão

json
{
  "notes": "",
  "queue_id": ""
}

Saídas

Saída (label)NomeObrigatória
timeoutNinguém atendeuNão

Chaves de saída

ChaveTipoDescrição
transferredbooleanVerdadeiro quando um atendente assumiu a ligação.

Atualizar Lead

Preenche no cadastro do lead da conversa o nome, o endereço, o bairro, a data de nascimento e campos personalizados.

  • Tipo: action_update_lead
  • Categoria: action
  • Fluxos: messages
  • Comportamento no teste: writes_data

Quando usar: Depois de um passo que extraiu dados da conversa (agente de IA, requisição HTTP, variável), para gravar no cadastro do lead o nome, o CEP, o endereço, o bairro, a data de nascimento ou campos personalizados.

Como funciona: Só preenche o que está vazio no cadastro: um valor diferente já salvo nunca é substituído e aparece em conflicts. O nome é a exceção: substitui o nome do perfil do WhatsApp ou de uma importação, mas nunca um nome editado por uma pessoa nem o de um formulário. Com CEP, o CEP é conferido e cidade, UF e logradouro vêm dele; sem CEP, informe cidade e UF junto com o bairro ou o logradouro. O endereço vira o endereço principal e aguarda localização no mapa. Campos sensíveis nunca são gravados por fluxos. Campos vazios depois de trocar as variáveis são ignorados; sem nenhum dado, ou com um dado recusado, segue pela saída Erro sem gravar nada. Uma variável que não existe naquele ponto do fluxo nunca é gravada como texto: o passo segue pela saída Erro sem gravar nada e o rastro mostra a variável. {{message}} é a última mensagem do contato e só existe em fluxos iniciados ou retomados por uma mensagem. O fluxo fica registrado como autor da mudança.

Configuração

CampoTipoObrigatórioSignificado
nametextNãoNome. Substitui o nome do perfil do WhatsApp; um nome editado por uma pessoa é mantido.
zip_codetextNãoCEP. 8 dígitos, com ou sem hífen. Aceita variáveis.
streettextNãoLogradouro. Rua ou avenida, sem o número.
numbertextNãoNúmero do endereço. Número do imóvel, não o telefone. Precisa do CEP ou da cidade e UF.
complementtextNãoComplemento.
districttextNãoBairro.
citytextNãoCidade. Obrigatória sem CEP.
statetextNãoUF. Sigla ou nome do estado. Obrigatória sem CEP.
birth_datetextNãoData de nascimento. DD/MM/AAAA ou AAAA-MM-DD.
custom_fieldskeyvalueNãoCampos personalizados. Chave de um campo personalizado de lead e o valor a gravar. Seleção aceita só as opções do campo.

Configuração padrão

json
{
  "custom_fields": {}
}

Saídas

Saída (label)NomeObrigatória
sucessoSucessoSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
successbooleantrue quando o cadastro foi conferido sem recusa.
lead_idtextID do lead da conversa.
changedlistCampos preenchidos agora: name, addresses, birthDate ou customFields.<chave>.
conflictslistCampos que já tinham outro valor e foram mantidos.
errortextMotivo quando nada foi gravado.

IA

Agente IA

Gera uma resposta usando o agente de IA e salva em uma variável.

  • Tipo: action_ai_agent
  • Categoria: ai
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: ai_model

Quando usar: Para conversar com o contato usando IA, classificar intenção ou orquestrar ferramentas. source=prompt (defina model+instructions) para um agente ad-hoc; source=agent (defina agent_id) para reutilizar um agente salvo.

Como funciona: ENVIO: em response_mode=segmented o PRÓPRIO NÓ envia as mensagens no WhatsApp (divididas, com indicador de 'digitando'), não conecte um send_text depois (envio duplicado, é bloqueado). Em response_mode=default o nó também envia a resposta no WhatsApp; use um send_text apenas para enviar por outro canal, transformar o texto, ou quando o agente roteia para ferramentas (aí o nó NÃO envia). Com custom_tools, a IA escolhe uma ferramenta e o fluxo SAI pela saída cujo nome é o da ferramenta. Quando o caminho de uma ferramenta termina sem próxima aresta, o fluxo volta sozinho ao agente com o resultado, e quando um passo do caminho falha sem a saída erro conectada, volta com o erro; se o caminho terminar em end, action_finish_conversation, action_transfer_department, action_assign_member, action_transfer_to_queue ou action_reply_to_agent, a conversa sai do agente ali. Defina custom_tools ANTES de conectar. Ao chamar uma ferramenta, cada argumento fica acessível adiante como {{node.<id>.<arg>}} (ex.: {{node.n2.cep}}).

Configuração

CampoTipoObrigatórioSignificado
input_modeselectNãoModo de entrada. Valores: conversation (Conversa (histórico completo)), custom (Texto personalizado).
response_modeselectNãoModo de resposta. Segmentada: divide a resposta em múltiplas mensagens curtas. No WhatsApp, envia cada mensagem com indicador de digitação automaticamente. Valores: default (Padrão (uma mensagem)), segmented (Segmentada (múltiplas mensagens + digitação)).
texttextareaNãoTexto de entrada.
include_historyselectNãoIncluir histórico. Valores: no (Não), yes (Sim).
sourceselectNãoFonte de IA. Modo do nó (padrão 'agent' quando vazio). 'agent': usa um agente salvo, preencha agent_id; model/instructions são ignorados. 'prompt': agente ad-hoc, preencha model e instructions; agent_id é ignorado. Valores: agent (Agente salvo), prompt (Prompt inline).
agent_idselectNãoAgente. Origem das opções: agents.
modelselectNãoModelo. Origem das opções: ai_models.
reasoning_levelreasoning_levelNãoNível de raciocínio. Só no modo 'prompt'. Um dos níveis que o modelo oferece em reasoning.levels (find_resource ai_models ou GET /agents/options); vazio usa o padrão do modelo. Um nível que o modelo não oferece é recusado ao salvar, ao ativar e na execução.
instructionstextareaNãoPrompt do sistema.
additional_contexttextareaNãoContexto adicional.
context_windownumberNãoJanela de contexto (mensagens).
response_variabletextNãoSalvar resposta na variável.
knowledge_base_idsmulti-selectNãoBases de conhecimento. Bases de conhecimento para RAG. Quando usando um agente, as bases vinculadas ao agente são usadas automaticamente. Origem das opções: knowledge_bases.
mcp_collection_idsmulti-selectNãoColeções MCP. Coleções MCP que delimitam as ferramentas disponíveis para esta IA. Origem das opções: mcp_collections.
custom_toolstoolsNãoFerramentas.

Configuração padrão

json
{
  "additional_context": "",
  "agent_id": "",
  "context_window": 50,
  "custom_tools": [],
  "include_history": "yes",
  "input_mode": "conversation",
  "instructions": "",
  "knowledge_base_ids": [],
  "mcp_collection_ids": [],
  "model": "",
  "response_mode": "default",
  "response_variable": "ai_response",
  "source": "agent",
  "text": "{{message}}"
}

Saídas

As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.

Saídas fixas, além das que a configuração cria:

Saída (label)NomeObrigatória
defaultResposta (texto)Sim
erroErroNão

Chaves de saída

ChaveTipoDescrição
response_texttextResposta gerada pela IA.
messageslistLista de mensagens segmentadas (quando modo segmentado).
deliveredbooleantrue se as mensagens foram enviadas diretamente pelo nó.
agent_idtextID do agente utilizado.
modeltextModelo de IA utilizado.
tool_nametextNome da ferramenta chamada pela IA (se houver).
tool_argsobjectArgumentos da ferramenta chamada (objeto JSON).

Lógica

Código (JavaScript)

Executa JavaScript em um sandbox seguro. Tem acesso a input, state.get/set, fetch (HTTPS), secrets, log, json, b64, crypto, sleep. O valor retornado vira a saída do nó (acessível via {{last.<campo>}}).

  • Tipo: action_code
  • Categoria: logic
  • Fluxos: messages e voice
  • Comportamento no teste: external_call

Quando usar: Para lógica personalizada em sandbox JavaScript quando nenhum nó pronto resolve.

Como funciona: Os campos do objeto retornado pelo script tornam-se as saídas de dados deste nó (acessíveis adiante via {{node.<id>.<campo>}}). Roda em sandbox com input, state.get/set, fetch (HTTPS) e log.

Configuração

CampoTipoObrigatórioSignificado
codecodeSimCódigo JavaScript.
output_variabletextNãoSalvar retorno em variável. Opcional. Se preenchido, o valor retornado pelo script também é gravado no estado do fluxo sob este nome (acessível por {{state.<nome>}} ou via state.get('<nome>') em nós seguintes).
timeout_msnumberNãoTimeout (ms). Tempo máximo do script, até 60000 ms (60 s). Limites: mínimo 1, máximo 60000.

Configuração padrão

json
{
  "code": "// ─────────────────────────────────────────────────────────────────────\n// Sandbox JavaScript, sem eval, sem require, sem timers, sem DOM.\n// Retorne um objeto → seus campos viram a saída deste nó, acessíveis\n// nos próximos nós como {{last.<campo>}}. Sem retorno → saída vazia.\n// ─────────────────────────────────────────────────────────────────────\n\n// ── Entrada ─────────────────────────────────────────────────────────\n//   input                       Saída do nó anterior (objeto congelado).\n//                               Ex.: input.body, input.status\n\n// ── Estado do fluxo (persiste entre nós desta execução) ────────────\n//   state.get(chave)            Lê uma variável salva antes.\n//   state.set(chave, valor)     Escreve uma variável (auditado).\n//\n//   Chaves com pontos viram caminho aninhado, igual aos templates\n//   {{a.b.c}}. Ex.: o nó AI Agent grava \"ai_response\" como objeto;\n//   para ler o argumento \"query\" da chamada de ferramenta, use:\n//     state.get(\"ai_response.tool_args.query\")\n//   Índices numéricos viajam em arrays: state.get(\"hits.0.title\").\n\n// ── Log (aparece no log da execução) ───────────────────────────────\n//   log('info', 'mensagem', obj)\n//   // Níveis: 'debug' | 'info' | 'warn' | 'error'\n\n// ── HTTP (somente HTTPS, com proteção SSRF) ────────────────────────\n//   // Bloqueia IPs privados/loopback/metadata da nuvem.\n//   fetch('https://api.exemplo.com/x')\n//   fetch({\n//     url: 'https://api.exemplo.com/x',\n//     method: 'POST',\n//     headers: { 'X-Api-Key': secrets.get('minha_chave') },\n//     body: { ola: 'mundo' },   // objeto → vira JSON automaticamente\n//     timeout_ms: 3000,\n//   })\n//   // → { status, ok, headers, body, url, duration_ms }\n\n// ── Segredos (escopo do workspace, nunca enumeráveis) ──────────────\n//   secrets.get('stripe_key')   Lança erro se não estiver autorizado.\n\n// ── JSON ────────────────────────────────────────────────────────────\n//   json.parse(texto)\n//   json.stringify(valor)\n\n// ── Base64 ──────────────────────────────────────────────────────────\n//   b64.encode(texto)\n//   b64.decode(texto)\n\n// ── Cripto ──────────────────────────────────────────────────────────\n//   crypto.uuid()                       gera UUID v4\n//   crypto.hash('sha256', 'texto')      também 'sha1' e 'md5'\n\n// ── Aleatoriedade (Math padrão; NÃO use p/ segurança) ──────────────\n//   Math.random()                       0..1\n//   Math.floor(Math.random() * 10)      inteiro 0..9\n//   crypto.uuid()                       use isto p/ unicidade real\n\n// ── Datas (Date padrão do JS) ──────────────────────────────────────\n//   new Date()                          agora\n//   Date.now()                          epoch em ms\n//   new Date().toISOString()            '2026-05-22T12:34:56.789Z'\n//   new Date(Date.now() + 86400000)     amanhã\n//   new Date('2026-12-31').getTime()    parse → epoch ms\n\n// ── Strings, números, arrays, regex, ES5+ padrão ──────────────────\n//   'oi'.toUpperCase()\n//   [1, 2, 3].map(x => x * 2)\n//   /\\d+/.test('abc123')\n\n// ── Pausa (conta no orçamento de tempo) ────────────────────────────\n//   sleep(250)                  pausa 250 ms\n\n// ── Limites (padrão; podem ser menores no seu plano) ───────────────\n//   tempo 5 s (até 60 s em Timeout) · saída ≤ 256 KB · log ≤ 64 KB\n//   fetch ≤ 20 chamadas · resposta ≤ 5 MB\n\n// ─────────────────────────────────────────────────────────────────────\n\nreturn {\n  ok: true,\n  saudacao: 'Olá ' + (input.nome || 'mundo'),\n  em: new Date().toISOString(),\n};\n",
  "output_variable": "",
  "timeout_ms": 5000
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
*não informadoOs campos do objeto retornado pelo script. Use {{last.<campo>}}.

Formatar Data/Hora

Formata, converte ou calcula datas e horários.

  • Tipo: action_format_date
  • Categoria: logic
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para formatar/converter/calcular datas e horas.

Configuração

CampoTipoObrigatórioSignificado
inputtextSimEntrada.
formatselectNãoFormato de saída. Valores: 2006-01-02 15:04:05 (YYYY-MM-DD HH:mm:ss), 2006-01-02 (YYYY-MM-DD), 02/01/2006 (DD/MM/YYYY), 02/01/2006 15:04 (DD/MM/YYYY HH:mm), 15:04:05 (HH:mm:ss), 15:04 (HH:mm), Monday (Dia da semana), January (Mês por extenso), unix (Timestamp Unix).
timezoneselectNãoFuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC).
operationselectNãoOperação. Valores: none (Nenhuma), add (Adicionar tempo), subtract (Subtrair tempo).
amountnumberNãoQuantidade.
unitselectNãoUnidade. Valores: minutes (Minutos), hours (Horas), days (Dias), weeks (Semanas), months (Meses).

Configuração padrão

json
{
  "amount": 0,
  "format": "2006-01-02 15:04:05",
  "input": "now",
  "operation": "none",
  "timezone": "America/Sao_Paulo",
  "unit": "hours"
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
formattedtextData formatada como string.
timestampnumberTimestamp Unix (segundos).
isodateData em formato ISO 8601.

Hora Atual

Obtém a data e hora atual e salva em variáveis.

  • Tipo: action_get_current_time
  • Categoria: logic
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para obter a data/hora atual em um fuso e usar adiante.

Configuração

CampoTipoObrigatórioSignificado
timezoneselectNãoFuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC).
variabletextNãoSalvar como variável.

Configuração padrão

json
{
  "timezone": "America/Sao_Paulo",
  "variable": "current_time"
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
datetimetextData e hora completa (YYYY-MM-DD HH:mm:ss).
datedateApenas a data (YYYY-MM-DD).
timetextApenas a hora (HH:mm:ss).
hournumberHora (0-23).
minutenumberMinuto (0-59).
weekdaytextDia da semana (Monday, Tuesday, etc.).
timestampnumberTimestamp Unix (segundos).
isodateData em formato ISO 8601.

Loop / Iteração

Itera sobre uma lista (array JSON). A cada passagem define o item atual e o índice.

  • Tipo: action_loop
  • Categoria: logic
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para iterar sobre uma lista (list_variable).

Como funciona: Percorre a lista item a item: a saída 'body' executa uma vez por item (normalmente retornando ao próprio loop para iterar) e a saída 'done' segue ao terminar. Um ciclo de volta ao loop é válido; o loop garante o término.

Configuração

CampoTipoObrigatórioSignificado
list_variabletextSimVariável da lista.
item_variabletextNãoNome do item.

Configuração padrão

json
{
  "item_variable": "item",
  "list_variable": ""
}

Saídas

Saída (label)NomeObrigatória
bodyCorpo do loopSim
doneConcluídoSim
failFalhaNão

Chaves de saída

ChaveTipoDescrição
itemunknownItem atual da iteração.
indexnumberÍndice da iteração atual (0-based).
totalnumberTotal de itens na lista.
is_firstbooleantrue se é o primeiro item.
is_lastbooleantrue se é o último item.

Definir Variável

Define uma variável no estado do fluxo.

  • Tipo: action_set_variable
  • Categoria: logic
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para gravar/derivar uma variável de fluxo reutilizável adiante.

Como funciona: Grava a variável de fluxo (nome em 'variable') com o 'value' já interpolado; fica disponível adiante como {{var.<nome>}}. Se o valor cita uma variável que não existe naquele ponto do fluxo, a variável não é gravada e o rastro mostra qual faltou.

Configuração

CampoTipoObrigatórioSignificado
variabletextSimNome da Variável.
variable_labeltextNãoNome amigável. Como a variável aparece nas listas e nos campos.
valuetextNãoValor.

Configuração padrão

json
{
  "value": "",
  "variable": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
variablenão informadoNome da variável definida. Repete o valor da configuração.
valuenão informadoValor atribuído. Repete o valor da configuração.

Condições

Condição

Divide o fluxo com base em uma condição (campo, operador, valor).

  • Tipo: condition_branch
  • Categoria: condition
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para uma decisão booleana sobre uma variável (operadores: eq, contains, gt, empty, matches, in, etc.).

Configuração

CampoTipoObrigatórioSignificado
variabletextSimVariável. Texto ou referência de estado. Use {{...}} para interpolar (ex.: {{node.n2.count}}, {{var.status}}).
operatorselectSimOperador. Valores: eq (Igual a (==)), neq (Diferente de (!=)), eq_ci (Igual (ignorar maiúsc.)), neq_ci (Diferente (ignorar maiúsc.)), contains (Contém), not_contains (Não contém), contains_ci (Contém (ignorar maiúsc.)), starts_with (Começa com), ends_with (Termina com), empty (Está vazio), not_empty (Não está vazio), is_null (É nulo), is_not_null (Não é nulo), gt (Maior que (>)), gte (Maior ou igual (>=)), lt (Menor que (<)), lte (Menor ou igual (<=)), matches (Corresponde a regex), not_matches (Não corresponde a regex), is_number (É número), is_not_number (Não é número), is_true (É verdadeiro), is_false (É falso), length_eq (Comprimento igual a), length_gt (Comprimento maior que), length_lt (Comprimento menor que), in (Está na lista (vírgula)), not_in (Não está na lista (vírgula)).
valuetextNãoValor.

Configuração padrão

json
{
  "operator": "eq",
  "value": "",
  "variable": ""
}

Saídas

Saída (label)NomeObrigatória
trueVerdadeiroSim
falseFalsoSim

Chaves de saída

ChaveTipoDescrição
matchedbooleantrue ou false (resultado da condição).
variablenão informadoNome da variável avaliada. Repete o valor da configuração.
operatornão informadoOperador utilizado. Repete o valor da configuração.

Canal

Divide o fluxo pelo canal em que a conversa está acontecendo.

  • Tipo: condition_channel
  • Categoria: condition
  • Fluxos: messages
  • Comportamento no teste: pure

Quando usar: Quando o mesmo fluxo atende vários canais e um trecho precisa mudar (ex.: template no WhatsApp oficial, texto simples no resto).

Configuração

Sem campos de configuração.

Saídas

Saída (label)NomeObrigatória
whatsappWhatsApp oficialSim
unofficial_whatsappWhatsApp não oficialSim
instagramInstagramSim
telegramTelegramSim
facebookMessengerSim
webchatWebChatSim
mercadolivreMercado LivreSim
tiktokTikTokSim
emailE-mailSim
rcsRCSSim
smsSMSSim
defaultOutros canaisSim

Chaves de saída

ChaveTipoDescrição
channeltextCanal da execução (whatsapp, instagram, telegram, ...).
matchedbooleantrue quando havia uma aresta para esse canal; false quando caiu no padrão.

Verificar Etiqueta

Verifica se a entrada possui uma etiqueta específica.

  • Tipo: condition_check_label
  • Categoria: condition
  • Fluxos: messages
  • Comportamento no teste: reads_data

Quando usar: Para verificar se a conversa tem uma etiqueta específica.

Configuração

CampoTipoObrigatórioSignificado
label_idselectSimEtiqueta. Origem das opções: labels.

Configuração padrão

json
{
  "label_id": ""
}

Saídas

Saída (label)NomeObrigatória
truePossuiSim
falseNão PossuiSim
erroErroNão

Chaves de saída

ChaveTipoDescrição
matchedbooleantrue se a entrada possui a etiqueta.
label_idnão informadoID da etiqueta verificada. Repete o valor da configuração.
label_nametextNome da etiqueta (se encontrada).
errortextMotivo quando as etiquetas não puderam ser lidas (saída Erro).

Verificar Negociação

Verifica as negociações da conversa: se existem, se há mais de uma aberta, a situação ou a etapa.

  • Tipo: condition_check_opportunity
  • Categoria: condition
  • Fluxos: messages
  • Comportamento no teste: reads_data

Quando usar: Para seguir caminhos diferentes conforme a conversa já tenha uma negociação, ela esteja ganha ou em uma etapa.

Como funciona: Considera a negociação do ID informado ou a única negociação aberta da conversa no funil; sem aberta, a última encerrada. Com mais de uma aberta e sem ID, verificar situação ou etapa interrompe a execução. A saída lista todas as negociações para usar em um Loop.

Configuração

CampoTipoObrigatórioSignificado
pipeline_idselectSimFunil de negociações. O funil de negociações onde fica a negociação desta conversa. Origem das opções: opportunity_pipelines.
checkselectSimVerificar. Valores: exists (Tem negociação), several_open (Tem mais de uma negociação aberta), status (Situação da negociação é), stage (Negociação está na etapa).
opportunity_idtextNãoID da negociação. Opcional. Vazio: a única negociação aberta da conversa neste funil ou, sem aberta, a última encerrada. Vale quando check é exists, status ou stage.
statusselectQuando check é statusSituação. Valores: open (Aberto), won (Ganho), lost (Perdido). Vale quando check é status.
stage_idselectQuando check é stageEtapa da negociação. Etapa a comparar. Origem das opções: opportunity_stages. Vale quando check é stage.

Configuração padrão

json
{
  "check": "exists",
  "pipeline_id": ""
}

Saídas

Saída (label)NomeObrigatória
trueSimSim
falseNãoSim

Chaves de saída

ChaveTipoDescrição
matchedbooleantrue quando a verificação foi atendida.
opportunity_idtextID da negociação (vazio se não há).
statustextSituação da negociação: open, won ou lost.
stage_idtextID da etapa da negociação.
value_centsnumberValor em centavos.
valuenumberValor na unidade da moeda.
open_countnumberQuantidade de negociações abertas da conversa no funil.
opportunitieslistLista das negociações da conversa no funil, abertas primeiro.

Verificar Etapa

Verifica se a conversa está em uma etapa do funil.

  • Tipo: condition_check_stage
  • Categoria: condition
  • Fluxos: messages
  • Comportamento no teste: reads_data

Configuração

CampoTipoObrigatórioSignificado
stage_idselectSimEtapa. A etapa a comparar com a etapa atual da conversa. Origem das opções: stages.

Configuração padrão

json
{
  "stage_id": ""
}

Saídas

Saída (label)NomeObrigatória
trueEstá na etapaSim
falseNão estáSim

Chaves de saída

ChaveTipoDescrição
matchedbooleantrue se a conversa está na etapa escolhida.
stage_idnão informadoID da etapa verificada. Repete o valor da configuração.
current_stage_idtextID da etapa atual da conversa (vazio se não há).
current_stage_nametextNome da etapa atual da conversa.

Lead tem consentimento?

Segue pelo estado do consentimento do lead da conversa: concedido, retirado ou sem registro.

  • Tipo: condition_consent
  • Categoria: condition
  • Fluxos: messages
  • Comportamento no teste: reads_data

Quando usar: Para seguir caminhos diferentes conforme o lead da conversa aceitou receber mensagens, pediu para parar ou não tem registro.

Como funciona: Lê o registro atual do lead. Uma conversa sem lead segue por 'none'. Uma falha de leitura interrompe a execução em vez de escolher um caminho.

Configuração

Sem campos de configuração.

Saídas

Saída (label)NomeObrigatória
grantedTem consentimentoSim
withdrawnPediu para não receberSim
noneSem registroSim

Chaves de saída

ChaveTipoDescrição
statetextgranted, withdrawn ou none.
lead_idtextID do lead da conversa (vazio se não há).

Filtro

Continua o fluxo apenas se a condição for verdadeira. Caso contrário, encerra.

  • Tipo: condition_filter
  • Categoria: condition
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para continuar só se a condição for verdadeira; caso contrário a execução encerra ali.

Como funciona: Quando a condição é falsa, a execução do fluxo ENCERRA neste nó; quando verdadeira, segue pela saída para o próximo nó.

Configuração

CampoTipoObrigatórioSignificado
variabletextSimVariável. Texto ou referência de estado. Use {{...}} para interpolar (ex.: {{node.n2.count}}, {{var.status}}).
operatorselectSimOperador. Valores: eq (Igual a (==)), neq (Diferente de (!=)), eq_ci (Igual (ignorar maiúsc.)), neq_ci (Diferente (ignorar maiúsc.)), contains (Contém), not_contains (Não contém), contains_ci (Contém (ignorar maiúsc.)), starts_with (Começa com), ends_with (Termina com), empty (Está vazio), not_empty (Não está vazio), is_null (É nulo), is_not_null (Não é nulo), gt (Maior que (>)), gte (Maior ou igual (>=)), lt (Menor que (<)), lte (Menor ou igual (<=)), matches (Corresponde a regex), not_matches (Não corresponde a regex), is_number (É número), is_not_number (Não é número), is_true (É verdadeiro), is_false (É falso), length_eq (Comprimento igual a), length_gt (Comprimento maior que), length_lt (Comprimento menor que), in (Está na lista (vírgula)), not_in (Não está na lista (vírgula)).
valuetextNãoValor.

Configuração padrão

json
{
  "operator": "eq",
  "value": "",
  "variable": ""
}

Saídas

Uma única saída: a conexão vai sem label (ou com default).

Chaves de saída

ChaveTipoDescrição
passedbooleantrue se o filtro deixou passar.
variablenão informadoNome da variável avaliada. Repete o valor da configuração.

Classificar Texto

Roteia o fluxo com base no texto recebido (switch/case).

  • Tipo: condition_text_match
  • Categoria: condition
  • Fluxos: messages e voice
  • Comportamento no teste: pure

Quando usar: Para rotear por correspondência de texto (switch/case) sem custo de IA.

Como funciona: Saídas DINÂMICAS: cada item de 'cases' cria uma saída (rótulo igual ao value do case), preencha 'cases' ANTES de conectar. Há sempre uma saída 'default' para quando nada corresponde.

Configuração

CampoTipoObrigatórioSignificado
texttextSimTexto.
casescasesNãoCasos.
match_modeselectNãoModo de comparação. Valores: exact (Exato), contains (Contém).

Configuração padrão

json
{
  "cases": [],
  "match_mode": "exact",
  "text": "{{message}}"
}

Saídas

As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.

Saídas fixas, além das que a configuração cria:

Saída (label)NomeObrigatória
defaultPadrãoNão

Chaves de saída

ChaveTipoDescrição
matchedtextValor do caso que correspondeu (vazio se padrão).
textnão informadoTexto avaliado. Repete o valor da configuração.

Esperas

Aguardar Tecla

Espera quem ligou apertar uma tecla de um menu ou digitar um valor, como CPF, data ou telefone.

  • Tipo: wait_dtmf
  • Categoria: wait
  • Fluxos: voice
  • Comportamento no teste: voice_only

Quando usar: Para ler a opção de um menu de URA ou pedir que quem ligou digite um valor (CPF, CNPJ, data, telefone, número, valor em centavos, CEP). Coloque depois de um action_play_audio que faz a pergunta.

Como funciona: 'mode' menu (o padrão): saídas DINÂMICAS, cada tecla em 'keys' (0-9, * ou #) vira uma saída com o próprio dígito como rótulo; conecte todas; a tecla fica em 'key'. 'mode' collect: quem ligou digita vários dígitos e termina com 'finish_key' (# por padrão), com uma pausa maior que 'digit_timeout_seconds' ou ao completar o tamanho do tipo; o valor é conferido pela regra do tipo em 'input_type' e sai por 'collected' com o valor em 'value' (e em {{var.<variable>}} quando 'variable' está preenchido) e o que foi digitado em 'digits'. 'invalid' recebe teclas fora do menu ou um valor que não passa na regra; 'timeout' recebe o silêncio após 'timeout_seconds' (até 60). Se não forem conectadas, a ligação é encerrada. Para pedir de novo, ligue 'invalid' ou 'timeout' de volta ao áudio; 'max_attempts' limita essas voltas e a última falha sai por 'attempts_exhausted' (sem conexão, a ligação é encerrada).

Configuração

CampoTipoObrigatórioSignificado
modeselectNãoO que esperar. Valores: menu (Uma tecla de um menu), collect (Um valor digitado).
keysmulti-selectQuando mode é vazio ou menuTeclas. Cada tecla escolhida vira uma saída. Valores: 0 (0), 1 (1), 2 (2), 3 (3), 4 (4), 5 (5), 6 (6), 7 (7), 8 (8), 9 (9), * (*), # (#). Vale quando mode é vazio ou menu.
input_typeselectQuando mode é collectTipo do valor. O valor só sai por Valor recebido quando passa na regra do tipo; data é digitada como DDMMAAAA. Valores: digits (Dígitos digitados), number (Número digitado), cpf (CPF digitado), cnpj (CNPJ digitado), cpf_cnpj (CPF ou CNPJ digitado), date (Data digitada), phone (Telefone digitado), money_cents (Valor digitado em centavos), cep (CEP digitado). Vale quando mode é collect.
min_digitsnumberNãoMínimo de dígitos. Limites: mínimo 1, máximo 32. Vale quando input_type é digits, number ou money_cents.
max_digitsnumberNãoMáximo de dígitos. Ao chegar no máximo, a digitação termina sem precisar da tecla de fim. Limites: mínimo 1, máximo 32. Vale quando input_type é digits, number ou money_cents.
finish_keyselectNãoTecla para terminar. Valores: # (#), * (*). Vale quando mode é collect.
timeout_secondsnumberNãoEsperar a primeira tecla até (segundos). Até 60 segundos.
digit_timeout_secondsnumberNãoPausa entre dígitos (segundos). Uma pausa maior termina a digitação. Limites: mínimo 1, máximo 60. Vale quando mode é collect.
max_attemptsnumberNãoMáximo de tentativas. Conta as falhas (tecla ou valor inválido e silêncio); a última sai por Tentativas esgotadas. Limites: mínimo 0, máximo 10.
variabletextNãoGuardar na variável. Opcional. O valor válido fica em {{var.<nome>}} para os próximos passos. Vale quando mode é collect.
variable_labeltextNãoNome amigável. Como a variável aparece nas listas e nos campos. Vale quando mode é collect.

Configuração padrão

json
{
  "keys": [],
  "mode": "menu",
  "timeout_seconds": 8
}

Saídas

As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.

Saídas fixas, além das que a configuração cria:

Saída (label)NomeObrigatória
invalidTecla inválidaNão
timeoutSem respostaNão

Chaves de saída

ChaveTipoDescrição
keytextTecla pressionada no menu (vazio quando ninguém apertou).
valueunknownValor digitado e validado, no tipo escolhido (vazio quando a entrada é inválida).
digitstextTeclas digitadas, sem a tecla de fim (também quando a entrada é inválida).

Aguardar Duração

Pausa o fluxo por um tempo determinado.

  • Tipo: wait_duration
  • Categoria: wait
  • Fluxos: messages
  • Comportamento no teste: waits

Quando usar: Para pausar o fluxo por um tempo fixo.

Configuração

CampoTipoObrigatórioSignificado
secondsnumberSimDuração (segundos).

Configuração padrão

json
{
  "seconds": 60
}

Saídas

Saída (label)NomeObrigatória
completedTempo passouSim
message_receivedMensagem recebidaNão

Aguardar Resposta

Pausa o fluxo até o contato responder ou expirar o tempo.

  • Tipo: wait_for_reply
  • Categoria: wait
  • Fluxos: messages
  • Precisa de conversa: sim
  • Comportamento no teste: waits

Quando usar: Para pausar e aguardar a próxima mensagem do contato (essencial para conversa contínua).

Como funciona: Pausa o fluxo até o contato responder. Padrão conversacional: conecte 'replied' de volta ao agente e 'timeout' para encerrar; o ciclo é válido porque o wait garante término.

Configuração

CampoTipoObrigatórioSignificado
timeout_secondsnumberSimTimeout (segundos).

Configuração padrão

json
{
  "timeout_seconds": 300
}

Saídas

Saída (label)NomeObrigatória
repliedRespondeuSim
timeoutNão respondeuNão

Esperar Horário

Pausa o fluxo até uma data/hora específica. Ideal para enviar mensagens em horários programados.

  • Tipo: wait_schedule
  • Categoria: wait
  • Fluxos: messages
  • Comportamento no teste: waits

Quando usar: Para pausar até uma data/horário específico (envios agendados).

Configuração

CampoTipoObrigatórioSignificado
modeselectSimModo. Valores: time (Horário específico (ex: 16:00)), datetime (Data e hora exata), next_weekday (Próximo dia da semana).
timetextNãoHorário (HH:mm).
datetextNãoData (YYYY-MM-DD).
weekdayselectNãoDia da semana. Valores: Monday (Segunda-feira), Tuesday (Terça-feira), Wednesday (Quarta-feira), Thursday (Quinta-feira), Friday (Sexta-feira), Saturday (Sábado), Sunday (Domingo).
timezoneselectNãoFuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC).

Configuração padrão

json
{
  "date": "",
  "mode": "time",
  "time": "09:00",
  "timezone": "America/Sao_Paulo"
}

Saídas

Saída (label)NomeObrigatória
completedHorário atingidoSim
message_receivedMensagem recebidaNão

Chaves de saída

ChaveTipoDescrição
scheduled_atdateData/hora agendada (ISO 8601).
wait_minutesnumberMinutos de espera calculados.

Fim

Fim

Finaliza a execução do fluxo. Em fluxos de chamada, desliga a ligação.

  • Tipo: end
  • Categoria: end
  • Fluxos: messages e voice
  • Comportamento no teste: end

Quando usar: Para encerrar um caminho do fluxo. Todo grafo precisa de ao menos um caminho que chegue a um 'end'.

Configuração

Sem campos de configuração.

Saídas

Encerra o caminho e não tem saídas.

Decoração

Plano de Fundo

Elemento de decoração para organizar visualmente o fluxo. Não tem impacto na execução.

  • Tipo: decoration_background
  • Categoria: decoration
  • Fluxos: messages
  • Comportamento no teste: decoration

Configuração

CampoTipoObrigatórioSignificado
colorcolorNãoCor de Fundo.

Configuração padrão

json
{
  "color": "#f0f0f0"
}

Saídas

Não participa da execução e não tem saídas.