Catálogo de ferramentas

Cada tipo de ferramenta que um agente pode receber, com a configuração que você preenche e os campos que a IA preenche ao chamar.

Esta página é gerada a partir do mesmo catálogo que GET /agents/tools devolve. Para o que é um agente e como as ferramentas entram nele, veja Agentes.

Cada ferramenta de um agente é uma instância de um tipo. Ao criar a instância com POST /agents/{id}/tools, envie o tipo em type, a configuração em config e, se quiser, o nome da função em name e a descrição para a IA em description.

PropriedadeO que diz
Instânciassingle: uma por agente. per_target: uma por destino, identificado pelo campo indicado. many: quantas forem precisas.
Testerun: o teste chama a API de verdade. preview: mostra o que a ferramenta faria, sem executar. scenario: testada só num cenário do simulador.
Ajusta à conversaA ferramenta completa a definição com a configuração salva e com o contexto da conversa ao montar cada turno; os campos abaixo são a base.

Tipos

TipoNomeCategoriaInstâncias
add_sheet_rowRegistrar em planilhaagent_actionper_target
auto_manage_opportunityNegociações automáticasagent_utilitysingle
cancel_follow_upCancelar follow-upmessagingsingle
check_calendar_availabilityVerificar Disponibilidade no Calendárioagent_utilitysingle
finish_conversationFinalizar conversaagent_utilitysingle
http_requestRequisição HTTPagent_actionmany
manage_entry_labelGerenciar etiquetas da conversaagent_utilitysingle
manage_entry_stageGerenciar Etapa atual do Leadagent_utilitysingle
manage_lead_memoryMemória do leadagent_utilitysingle
manage_opportunityGerenciar Negociação da Conversaagent_actionsingle
mcp_sourceServidor MCPagent_utilityper_target
record_consentRegistrar consentimentoagent_actionsingle
record_opt_outParar de receber templates (opt-out)agent_actionsingle
reschedule_meetingReagendar Reuniãoagent_utilitysingle
run_workflowExecutar fluxoagent_actionper_target
schedule_follow_upAgendar follow-upmessagingsingle
schedule_meetingAgendar Reuniãoagent_utilitysingle
search_knowledge_baseBuscar na base de conhecimentoagent_utilitymany
send_emailEnviar E-mailmessagingsingle
send_mediaEnviar Mídiamessagingsingle
send_optionsEnviar Opçõesmessagingsingle
send_platform_emailEnviar e-mail (plataforma)messagingsingle
transfer_to_automationTransferir para outra automaçãoagent_actionsingle
transfer_to_humanTransferir conversaagent_utilityper_target
update_lead_profileAtualizar cadastro do leadagent_actionsingle
validate_cepValidar CEPagent_utilitysingle

Registrar em planilha

Adiciona uma linha a uma aba de uma planilha do Google Planilhas criada no painel. Cada aba escolhida vira uma ferramenta própria do agente, com as colunas da aba como campos.

PropriedadeValor
Tipoadd_sheet_row
Categoriaagent_action
Visibilidademessaging
Instânciasper_target, por sheet_id
Testepreview
Ajusta à conversaSim

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
sheet_idAbastringSimA aba em que o agente registra as linhas. Opções vindas de google_sheets. Escolha antes em google_sheet_files (Planilha).
sheet_variableMuda por conversastringNãoGrava na planilha escolhida para cada conversa, com as colunas da aba modelo. O agente nunca escolhe nem troca a planilha. Opções vindas de conversation_sheet_variables.
when_to_useQuando registrarstringNãoEx.: quando o cliente confirmar o pedido. Sem isto, vale a descrição da aba.

O que a IA preenche

Nenhum campo.

Negociações automáticas

Registra e atualiza as negociações da conversa a partir da análise automática. O responsável pela conversa fica como dono da negociação.

PropriedadeValor
Tipoauto_manage_opportunity
Categoriaagent_utility
Visibilidadeanalysis
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
actionactionstringSimAção a executar. Valores: get, create, create_new, update_value, move, win, lose.
current_positionPosição atual do clientestringSimO que o cliente quer agora, segundo as mensagens mais recentes.
lost_reasonlost_reasonstringNãoMotivo da perda, nas palavras do cliente, para a ação lose.
opportunity_idopportunity_idstringNãoId exato de uma negociação retornada por get. Obrigatório quando a conversa tem mais de uma negociação aberta.
stagestagestringNãoNome exato da etapa destino para a ação move.
titletitlestringNãoTítulo curto da negociação, como o produto ou plano negociado.
valuevaluenumberNãoValor da negociação na unidade da moeda, com ponto decimal (ex.: 1500.50).

Cancelar follow-up

Cancela um follow-up que este agente agendou na conversa, ou todos os pendentes dele, por exemplo quando o cliente já enviou o comprovante.

PropriedadeValor
Tipocancel_follow_up
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
allTodosbooleanNãoCancelar todos os pendentes deste agente.
follow_up_idFollow-upstringNãoQual follow-up cancelar.

Verificar Disponibilidade no Calendário

Consulta o Google Calendar e retorna horários livres usando a agenda configurada do agente.

PropriedadeValor
Tipocheck_calendar_availability
Categoriaagent_utility
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
slot_durationDuração de cada horárionumberSimTamanho de cada bloco livre retornado ao cliente, em minutos. Padrão: 30.
timezoneFuso horário padrãostringSimFuso horário usado por padrão nas consultas de disponibilidade. Padrão: "America/Sao_Paulo".
work_daysDias disponíveisstringSimDefine se o agente agenda de segunda a sexta, segunda a sábado ou todos os dias. Padrão: "weekdays". Opções: weekdays (Segunda a sexta), weekdays_saturday (Segunda a sábado), all_week (Todos os dias).
working_endHorário finalstringSimÚltimo horário do dia em que o agente pode oferecer agendamentos. Padrão: "18:00".
working_startHorário inicialstringSimPrimeiro horário do dia em que o agente pode oferecer agendamentos. Padrão: "08:00".

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
date_fromData/hora iníciostringSimInício do período para verificar disponibilidade.
date_toData/hora fimstringNãoFim do período para verificar disponibilidade.
slot_durationDuração do slot (minutos)numberNãoDuração de cada slot livre em minutos.
timezoneTimezonestringNãoFuso horário para a consulta.
work_daysDias de trabalhostringNãoQuais dias da semana são dias úteis.
working_endFim do expedientestringNãoHora de fim do horário de trabalho.
working_startInício do expedientestringNãoHora de início do horário de trabalho.

Finalizar conversa

Encerra a conversa quando o atendimento foi concluído (cliente resolvido ou se despediu).

PropriedadeValor
Tipofinish_conversation
Categoriaagent_utility
Visibilidademessaging, post_conversation
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
reasonMotivostringNãoPor que a conversa foi finalizada.

Requisição HTTP

Chama uma API externa com campos que a IA preenche, valores fixos e dados da conversa.

PropriedadeValor
Tipohttp_request
Categoriaagent_action
Visibilidademessaging
Instânciasmany
Testerun
Ajusta à conversaSim

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
authAutenticaçãoobjectNãoBearer, Basic ou chave de API, sempre com um segredo do workspace.
body_schemaCampos do corpoarrayNãoForma antiga, convertida em campos ao salvar.
body_templateModelo do corpostringNãoJSON com {{args.campo}}, {{var.nome}}, {{conversation.entry_id}}, {{lead.id}} e {{secret.nome}}; cada marcador vira um valor JSON.
fieldsCamposarrayNãoCada campo do caminho, da consulta, do cabeçalho ou do corpo, e quem o preenche: a IA, um valor fixo ou a conversa.
headersCabeçalhos fixosobjectNãoForma antiga, convertida em campos ao salvar. Credencial: guardada nos segredos do workspace.
idempotency_headerCabeçalho de idempotênciastringNãoNome do cabeçalho com a chave que POST e PATCH enviam. O padrão é Idempotency-Key.
methodMétodo HTTPstringSimOperação usada em todas as chamadas desta ferramenta. Padrão: "GET". Opções: GET, POST, PUT, PATCH, DELETE.
outputRespostaobjectNãoCaminhos da resposta que a IA recebe. Sem caminhos, a IA recebe o JSON da resposta.
path_paramsParâmetros de caminhoarrayNãoForma antiga, convertida em campos ao salvar.
query_schemaParâmetros de consultaarrayNãoForma antiga, convertida em campos ao salvar.
timeout_secondsTempo limitenumberNãoDe 1 a 30 segundos; o padrão é 15. Padrão: 15.
urlURL do endpointstringSimEndereço https da API. Use {campo} no caminho para valores que a IA ou a conversa preenchem.

O que a IA preenche

Nenhum campo.

Gerenciar etiquetas da conversa

Adiciona ou remove etiquetas existentes do workspace na conversa atual, em qualquer canal.

PropriedadeValor
Tipomanage_entry_label
Categoriaagent_utility
Visibilidademessaging, post_conversation
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
actionAçãostringNãoAdicionar ou remover a etiqueta. Valores: add, remove.
label_nameEtiquetastringSimNome da etiqueta a colocar na conversa.

Gerenciar Etapa atual do Lead

Classifica e move o lead para uma etapa do kanban. Em mensagens: executa durante a conversa. Em voz: executa automaticamente após o encerramento da ligação.

PropriedadeValor
Tipomanage_entry_stage
Categoriaagent_utility
Visibilidademessaging, post_conversation
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
current_positionPosição atual do clientestringSimO que o cliente quer agora, segundo as mensagens mais recentes.
target_tag_nameEtapa DestinostringSimNome da etapa para classificar o lead.

Memória do lead

Permite ao agente salvar, atualizar e apagar fatos sobre o lead (preferências, combinados, contexto), reutilizados em todas as conversas futuras.

PropriedadeValor
Tipomanage_lead_memory
Categoriaagent_utility
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
actionAçãostringSimremember, update ou forget. Valores: remember, update, forget.
categoryCategoriastringNãoCategoria da memória. Valores: personal, preference, deal, objection, commitment, event, other.
contentConteúdostringNãoO fato a memorizar.
memory_idID da memóriastringNãoIdentificador da memória alvo.

Gerenciar Negociação da Conversa

Cria e atualiza as negociações desta conversa no funil de negociações: valor, etapa, ganho ou perda. A IA fica como responsável pelas negociações que criar.

PropriedadeValor
Tipomanage_opportunity
Categoriaagent_action
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
allowed_actionsAções permitidasarrayNãoO que a IA pode fazer com as negociações. Abrir outra negociação e marcar como ganho ficam desligados até você permitir. Padrão: ["create","update_value","move","lose"]. Opções: create (Criar negociação), create_new (Abrir outra negociação), update_value (Atualizar valor), move (Mover de etapa), win (Marcar como ganho), lose (Marcar como perdido).
currencyMoedastringNãoMoeda das negociações criadas pela IA. Opções: BRL, USD, EUR.
pipeline_idFunil de negociaçõesstringSimFunil de negociações onde a IA registra a negociação desta conversa. Opções vindas de opportunity_pipelines.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
actionactionstringSimAção a executar. Valores: get, create, create_new, update_value, move, win, lose.
current_positionPosição atual do clientestringSimO que o cliente quer agora, segundo as mensagens mais recentes.
lost_reasonlost_reasonstringNãoMotivo da perda, nas palavras do cliente, para a ação lose.
opportunity_idopportunity_idstringNãoId exato de uma negociação retornada por get. Obrigatório quando a conversa tem mais de uma negociação aberta.
stagestagestringNãoNome exato da etapa destino para a ação move.
titletitlestringNãoTítulo curto da negociação, como o produto ou plano negociado.
valuevaluenumberNãoValor da negociação na unidade da moeda, com ponto decimal (ex.: 1500.50).

Servidor MCP

Escolha um servidor MCP conectado e quais das ferramentas dele a IA pode usar.

PropriedadeValor
Tipomcp_source
Categoriaagent_utility
Visibilidademessaging
Instânciasper_target, por source_id
Testescenario
Ajusta à conversaNão

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
all_toolsTodas as ferramentasbooleanNãoLigado: a IA recebe todas as ferramentas do servidor.
source_idServidorstringSimUm servidor MCP já conectado em Agentes, MCP. Opções vindas de mcp_sources.
toolsFerramentas permitidasarrayNãoSó estas ferramentas chegam à IA.

O que a IA preenche

Nenhum campo.

Registrar consentimento

Registra o consentimento do lead para receber mensagens quando ele responde sim a uma pergunta do próprio agente.

PropriedadeValor
Tiporecord_consent
Categoriaagent_action
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

CampoNomeTipoObrigatórioDescrição
purposeFinalidadestringNãoPara que o lead aceita receber mensagens (opcional).

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
message_idMensagem citadastringSimId da mensagem que serve de prova.
question_message_idMensagem citadastringSimId da mensagem que serve de prova.

Parar de receber templates (opt-out)

Registra que o lead pediu para não receber mais mensagens, com a mensagem dele como prova.

PropriedadeValor
Tiporecord_opt_out
Categoriaagent_action
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
message_idMensagem citadastringSimId da mensagem que serve de prova.

Reagendar Reunião

Muda a data/horário de um evento existente no Google Calendar.

PropriedadeValor
Tiporeschedule_meeting
Categoriaagent_utility
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
send_updatesNotificar participantesstringSimControla se o Google Calendar avisa os participantes do reagendamento. Padrão: "all". Opções: all (Notificar todos), externalOnly (Somente convidados externos), none (Não notificar).
timezoneFuso horário padrãostringSimFuso horário usado por padrão ao reagendar. Padrão: "America/Sao_Paulo".

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
durationDuração (minutos)numberNãoNova duração em minutos.
end_timeNovo fimstringNãoNova data e hora de fim.
event_idID do agendamentostringSimEvento existente que será reagendado.
start_timeNovo iníciostringSimNova data e hora de início.
timezoneTimezonestringNãoFuso horário do novo horário.

Executar fluxo

Executa um fluxo de automação na conversa atual, com os campos que o gatilho Chamado por agente IA do fluxo pede. Cada fluxo escolhido vira uma ferramenta própria do agente.

PropriedadeValor
Tiporun_workflow
Categoriaagent_action
Visibilidademessaging
Instânciasper_target, por workflow_id
Testescenario
Ajusta à conversaSim

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
workflow_idFluxostringSimFluxo ativo com o gatilho Chamado por agente IA. Opções vindas de agent_workflows.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
inputsCamposobjectNãoCampos enviados ao gatilho do fluxo.

Agendar follow-up

Agenda uma mensagem para mais tarde nesta conversa, como cobrar um comprovante. Por padrão é cancelada se o contato responder antes. Pode ser um texto escrito pelo agente, com template de reserva fora da janela de 24 horas, ou um template do WhatsApp oficial escolhido aqui; o agente só preenche o horário e os valores do template, e o destino é sempre o contato desta conversa.

PropriedadeValor
Tiposchedule_follow_up
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

CampoNomeTipoObrigatórioDescrição
fallback_template_idTemplate de reservastringNãoSó no WhatsApp oficial, para envios fora da janela de 24 horas. Opções vindas de whatsapp_templates. Vale quando message_kind é vazio ou text.
message_kindO que agendarstringNãoUm template sai dentro ou fora da janela de 24 horas, só no WhatsApp oficial, e é cobrado no envio. Padrão: "text". Opções: text (Uma mensagem escrita pelo agente), template (Um template do WhatsApp).
template_idTemplatestringNãoEnviado ao contato desta conversa no horário que o agente escolher. Opções vindas de whatsapp_templates. Vale quando message_kind é template.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
cancel_if_contact_repliesCancelar se o contato responderbooleanNãoLigado por padrão.
dateDatadateNãoDia do envio.
days_from_todayDias a partir de hojeintegerNão0 hoje, 1 amanhã.
in_minutesDaqui a (minutos)integerNãoTempo até o envio.
template_valuesValores do templatearray de stringNãoVariáveis do template de reserva.
textMensagemstringSimTexto enviado no horário agendado.
timeHoratimeNãoHora do envio.

Agendar Reunião

Cria eventos no Google Calendar usando as regras configuradas do agente.

PropriedadeValor
Tiposchedule_meeting
Categoriaagent_utility
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
attendeesConvidados fixosstringNãoParticipantes adicionados quando a conversa não informar convidados. Padrão: "".
create_google_meetCriar link do Google MeetbooleanSimGerar automaticamente um link de reunião do Google Meet. Padrão: true.
descriptionDescrição padrãostringNãoPauta ou contexto padrão da reunião. Padrão: "Reunião agendada via Vozko".
durationDuração padrão da reuniãonumberSimTempo padrão da reunião em minutos. Padrão: 30.
locationLocal padrãostringNãoLocal físico ou link externo usado por padrão. Padrão: "".
send_updatesEnvio de convitesstringSimControla se o Google Calendar envia convites aos participantes. Padrão: "all". Opções: all (Enviar para todos), externalOnly (Somente convidados externos), none (Não enviar convites).
timezoneFuso horário padrãostringSimFuso horário usado por padrão para criar eventos. Padrão: "America/Sao_Paulo".
titleTítulo padrão da reuniãostringSimNome padrão da reunião criada no calendário. Padrão: "Reunião Agendada".

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
attendeesConvidadosstringNãoLista de e-mails dos participantes.
create_google_meetCriar Google MeetbooleanNãoCriar link do Google Meet automaticamente.
descriptionDescriçãostringNãoDescrição do evento.
durationDuração (minutos)numberNãoDuração da reunião em minutos.
end_timeFimstringNãoData e hora de fim da reunião.
locationLocalstringNãoLocal do evento.
start_timeIníciostringSimData e hora de início da reunião.
timezoneTimezonestringNãoFuso horário do evento.
titleTítulostringSimTítulo do evento no calendário.

Buscar na base de conhecimento

Permite ao agente pesquisar ativamente na base de conhecimento durante a conversa, reformulando a busca quando necessário.

PropriedadeValor
Tiposearch_knowledge_base
Categoriaagent_utility
Visibilidademessaging
Instânciasmany
Testescenario
Ajusta à conversaNão

Configuração

CampoNomeTipoObrigatórioDescrição
knowledge_base_idsBases pesquisadasarrayNãoVazio: pesquisa todas as bases do agente. Com bases escolhidas, esta busca só olha para elas. Opções vindas de knowledge_bases.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
queryConsultastringSimO que buscar na base de conhecimento.

Enviar E-mail

Envia e-mails pelo servidor SMTP configurado pelo usuário, sem usar o e-mail de Vozko.

PropriedadeValor
Tiposend_email
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
default_reply_toResponder para padrãostringNãoEndereço Reply-To usado quando a chamada não informar outro.
smtp_from_emailE-mail remetentestringSimEndereço remetente autorizado pelo servidor SMTP.
smtp_from_nameNome do remetentestringNãoNome exibido no campo From.
smtp_hostServidor SMTPstringSimHostname do servidor SMTP.
smtp_passwordSenha SMTPstringNãoSenha ou app password SMTP.
smtp_portPorta SMTPnumberNãoPorta do servidor SMTP. Padrão: 587.
smtp_securitySegurança SMTPstringNãoSTARTTLS, TLS implícito ou sem TLS para relays sem autenticação. Padrão: "starttls". Opções: starttls (STARTTLS), implicit_tls (TLS implícito), none (Sem TLS).
smtp_usernameUsuário SMTPstringNãoUsuário para autenticação SMTP.
timeout_secondsTimeoutnumberNãoTimeout em segundos. Padrão: 30.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
bccBccstringNãoDestinatários em cópia oculta.
bodyConteúdostringSimConteúdo do e-mail (HTML ou texto).
body_typeFormato do conteúdostringNãoFormato HTML ou texto simples. Valores: html, text.
ccCcstringNãoDestinatários em cópia.
reply_toResponder parastringNãoEndereço usado no cabeçalho Reply-To.
subjectAssuntostringSimAssunto do e-mail.
toDestinatáriostringSimEndereço de e-mail do destinatário.

Enviar Mídia

Envia uma mídia (imagem, vídeo, áudio, documento ou sticker) ao contato.

PropriedadeValor
Tiposend_media
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
captionLegendastringNãoLegenda opcional (apenas para imagem, vídeo e documento).
media_idID da MídiastringNãoID da mídia a ser enviada.
media_urlURL da MídiastringNãoURL direta da mídia (apenas do CDN).
toDestinatáriostringNãoOpcional, por padrão, o contato da conversa atual.

Enviar Opções

Envia uma mensagem com botões de resposta rápida ou botão de cópia (Pix, cupons, etc.).

PropriedadeValor
Tiposend_options
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
bodyMensagemstringSimTexto da mensagem exibida acima dos botões.
buttonsBotõesarray de objectSimLista de botões de resposta rápida ou cópia (máx. 3).
buttons[].idIdentificadorstringNãoID interno do botão (somente reply).
buttons[].titleTítulostringNãoTexto exibido no botão (máx. 20 caracteres, somente reply).
buttons[].typeTipostringSimTipo do botão. Valores: reply, copy_code.
buttons[].valueValor a copiarstringNãoValor copiado ao clicar (somente copy_code).
footerRodapéstringNãoTexto do rodapé (opcional).
headerCabeçalhostringNãoTexto do cabeçalho (opcional).

Enviar e-mail (plataforma)

Envia e-mails transacionais pelos remetentes cadastrados em E-mail, cobrados do saldo.

PropriedadeValor
Tiposend_platform_email
Categoriamessaging
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
design_idDesignstringNãoDesign salvo usado como corpo.
subjectAssuntostringSimAssunto do e-mail.
textTextostringNãoCorpo do e-mail em texto.
toDestinatáriostringNãoEndereço de e-mail do destinatário.

Transferir para outra automação

Passa a conversa para um agente ou fluxo da lista de destinos, que continua o atendimento com o histórico e a nota de quem transferiu. Cada destino pode levar a conversa para uma etapa de outro funil.

PropriedadeValor
Tipotransfer_to_automation
Categoriaagent_action
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaSim

Configuração

Exige configuração.

CampoNomeTipoObrigatórioDescrição
destinationsDestinosarraySimAgentes e fluxos que podem receber a conversa, cada um com uma etapa opcional e a descrição de quando usar.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
destinationDestinostringSimO destino escolhido pela IA.
noteNota da transferênciastringSimMotivo e resumo que o destino recebe.
variablesDados para o destinoobjectNãoValores que a IA informa ao transferir.

Transferir conversa

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

PropriedadeValor
Tipotransfer_to_human
Categoriaagent_utility
Visibilidademessaging
Instânciasper_target, por department_id
Testescenario
Ajusta à conversaNão

Configuração

CampoNomeTipoObrigatórioDescrição
department_idDepartamentostringNãoVazio: usa o departamento da própria conversa. Opções vindas de departments.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
reasonMotivostringNãoPor que a conversa foi transferida.

Atualizar cadastro do lead

Salva no cadastro do lead o endereço, o bairro, a data de nascimento e campos personalizados que ele informou na conversa.

PropriedadeValor
Tipoupdate_lead_profile
Categoriaagent_action
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
bairroBairrostringNãoBairro.
camposCampos personalizadosobjectNãoCampos personalizados de lead.
cepCEPstringNãoCEP do endereço.
cidadeCidadestringNãoCidade.
complementoComplementostringNãoApartamento, bloco.
data_nascimentoData de nascimentostringNãoData de nascimento do lead.
logradouroLogradourostringNãoRua ou avenida.
numeroNúmerostringNãoNúmero do imóvel.
ufUFstringNãoEstado.

Validar CEP

Verifica e normaliza um CEP, retornando logradouro, bairro, cidade e estado.

PropriedadeValor
Tipovalidate_cep
Categoriaagent_utility
Visibilidademessaging
Instânciassingle
Testescenario
Ajusta à conversaNão

Configuração

Sem configuração.

O que a IA preenche

CampoNomeTipoObrigatórioDescrição
cepCEPstringSimCEP a ser validado (ex: 01310-100).