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.
| Propriedade | O que diz |
|---|
| Instâncias | single: uma por agente. per_target: uma por destino, identificado pelo campo indicado. many: quantas forem precisas. |
| Teste | run: 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 à conversa | A 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. |
| Tipo | Nome | Categoria | Instâncias |
|---|
add_sheet_row | Registrar em planilha | agent_action | per_target |
auto_manage_opportunity | Negociações automáticas | agent_utility | single |
cancel_follow_up | Cancelar follow-up | messaging | single |
check_calendar_availability | Verificar Disponibilidade no Calendário | agent_utility | single |
finish_conversation | Finalizar conversa | agent_utility | single |
http_request | Requisição HTTP | agent_action | many |
manage_entry_label | Gerenciar etiquetas da conversa | agent_utility | single |
manage_entry_stage | Gerenciar Etapa atual do Lead | agent_utility | single |
manage_lead_memory | Memória do lead | agent_utility | single |
manage_opportunity | Gerenciar Negociação da Conversa | agent_action | single |
mcp_source | Servidor MCP | agent_utility | per_target |
record_consent | Registrar consentimento | agent_action | single |
record_opt_out | Parar de receber templates (opt-out) | agent_action | single |
reschedule_meeting | Reagendar Reunião | agent_utility | single |
run_workflow | Executar fluxo | agent_action | per_target |
schedule_follow_up | Agendar follow-up | messaging | single |
schedule_meeting | Agendar Reunião | agent_utility | single |
search_knowledge_base | Buscar na base de conhecimento | agent_utility | many |
send_email | Enviar E-mail | messaging | single |
send_media | Enviar Mídia | messaging | single |
send_options | Enviar Opções | messaging | single |
send_platform_email | Enviar e-mail (plataforma) | messaging | single |
transfer_to_automation | Transferir para outra automação | agent_action | single |
transfer_to_human | Transferir conversa | agent_utility | per_target |
update_lead_profile | Atualizar cadastro do lead | agent_action | single |
validate_cep | Validar CEP | agent_utility | single |
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.
| Propriedade | Valor |
|---|
| Tipo | add_sheet_row |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | per_target, por sheet_id |
| Teste | preview |
| Ajusta à conversa | Sim |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
sheet_id | Aba | string | Sim | A aba em que o agente registra as linhas. Opções vindas de google_sheets. Escolha antes em google_sheet_files (Planilha). |
sheet_variable | Muda por conversa | string | Não | Grava 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_use | Quando registrar | string | Não | Ex.: quando o cliente confirmar o pedido. Sem isto, vale a descrição da aba. |
Nenhum campo.
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.
| Propriedade | Valor |
|---|
| Tipo | auto_manage_opportunity |
| Categoria | agent_utility |
| Visibilidade | analysis |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
action | action | string | Sim | Ação a executar. Valores: get, create, create_new, update_value, move, win, lose. |
current_position | Posição atual do cliente | string | Sim | O que o cliente quer agora, segundo as mensagens mais recentes. |
lost_reason | lost_reason | string | Não | Motivo da perda, nas palavras do cliente, para a ação lose. |
opportunity_id | opportunity_id | string | Não | Id exato de uma negociação retornada por get. Obrigatório quando a conversa tem mais de uma negociação aberta. |
stage | stage | string | Não | Nome exato da etapa destino para a ação move. |
title | title | string | Não | Título curto da negociação, como o produto ou plano negociado. |
value | value | number | Não | Valor da negociação na unidade da moeda, com ponto decimal (ex.: 1500.50). |
Cancela um follow-up que este agente agendou na conversa, ou todos os pendentes dele, por exemplo quando o cliente já enviou o comprovante.
| Propriedade | Valor |
|---|
| Tipo | cancel_follow_up |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
all | Todos | boolean | Não | Cancelar todos os pendentes deste agente. |
follow_up_id | Follow-up | string | Não | Qual follow-up cancelar. |
Consulta o Google Calendar e retorna horários livres usando a agenda configurada do agente.
| Propriedade | Valor |
|---|
| Tipo | check_calendar_availability |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
slot_duration | Duração de cada horário | number | Sim | Tamanho de cada bloco livre retornado ao cliente, em minutos. Padrão: 30. |
timezone | Fuso horário padrão | string | Sim | Fuso horário usado por padrão nas consultas de disponibilidade. Padrão: "America/Sao_Paulo". |
work_days | Dias disponíveis | string | Sim | Define 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_end | Horário final | string | Sim | Último horário do dia em que o agente pode oferecer agendamentos. Padrão: "18:00". |
working_start | Horário inicial | string | Sim | Primeiro horário do dia em que o agente pode oferecer agendamentos. Padrão: "08:00". |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
date_from | Data/hora início | string | Sim | Início do período para verificar disponibilidade. |
date_to | Data/hora fim | string | Não | Fim do período para verificar disponibilidade. |
slot_duration | Duração do slot (minutos) | number | Não | Duração de cada slot livre em minutos. |
timezone | Timezone | string | Não | Fuso horário para a consulta. |
work_days | Dias de trabalho | string | Não | Quais dias da semana são dias úteis. |
working_end | Fim do expediente | string | Não | Hora de fim do horário de trabalho. |
working_start | Início do expediente | string | Não | Hora de início do horário de trabalho. |
Encerra a conversa quando o atendimento foi concluído (cliente resolvido ou se despediu).
| Propriedade | Valor |
|---|
| Tipo | finish_conversation |
| Categoria | agent_utility |
| Visibilidade | messaging, post_conversation |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
reason | Motivo | string | Não | Por que a conversa foi finalizada. |
Chama uma API externa com campos que a IA preenche, valores fixos e dados da conversa.
| Propriedade | Valor |
|---|
| Tipo | http_request |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | many |
| Teste | run |
| Ajusta à conversa | Sim |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
auth | Autenticação | object | Não | Bearer, Basic ou chave de API, sempre com um segredo do workspace. |
body_schema | Campos do corpo | array | Não | Forma antiga, convertida em campos ao salvar. |
body_template | Modelo do corpo | string | Não | JSON com {{args.campo}}, {{var.nome}}, {{conversation.entry_id}}, {{lead.id}} e {{secret.nome}}; cada marcador vira um valor JSON. |
fields | Campos | array | Não | Cada campo do caminho, da consulta, do cabeçalho ou do corpo, e quem o preenche: a IA, um valor fixo ou a conversa. |
headers | Cabeçalhos fixos | object | Não | Forma antiga, convertida em campos ao salvar. Credencial: guardada nos segredos do workspace. |
idempotency_header | Cabeçalho de idempotência | string | Não | Nome do cabeçalho com a chave que POST e PATCH enviam. O padrão é Idempotency-Key. |
method | Método HTTP | string | Sim | Operação usada em todas as chamadas desta ferramenta. Padrão: "GET". Opções: GET, POST, PUT, PATCH, DELETE. |
output | Resposta | object | Não | Caminhos da resposta que a IA recebe. Sem caminhos, a IA recebe o JSON da resposta. |
path_params | Parâmetros de caminho | array | Não | Forma antiga, convertida em campos ao salvar. |
query_schema | Parâmetros de consulta | array | Não | Forma antiga, convertida em campos ao salvar. |
timeout_seconds | Tempo limite | number | Não | De 1 a 30 segundos; o padrão é 15. Padrão: 15. |
url | URL do endpoint | string | Sim | Endereço https da API. Use {campo} no caminho para valores que a IA ou a conversa preenchem. |
Nenhum campo.
Adiciona ou remove etiquetas existentes do workspace na conversa atual, em qualquer canal.
| Propriedade | Valor |
|---|
| Tipo | manage_entry_label |
| Categoria | agent_utility |
| Visibilidade | messaging, post_conversation |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
action | Ação | string | Não | Adicionar ou remover a etiqueta. Valores: add, remove. |
label_name | Etiqueta | string | Sim | Nome da etiqueta a colocar na conversa. |
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.
| Propriedade | Valor |
|---|
| Tipo | manage_entry_stage |
| Categoria | agent_utility |
| Visibilidade | messaging, post_conversation |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
current_position | Posição atual do cliente | string | Sim | O que o cliente quer agora, segundo as mensagens mais recentes. |
target_tag_name | Etapa Destino | string | Sim | Nome da etapa para classificar o lead. |
Permite ao agente salvar, atualizar e apagar fatos sobre o lead (preferências, combinados, contexto), reutilizados em todas as conversas futuras.
| Propriedade | Valor |
|---|
| Tipo | manage_lead_memory |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
action | Ação | string | Sim | remember, update ou forget. Valores: remember, update, forget. |
category | Categoria | string | Não | Categoria da memória. Valores: personal, preference, deal, objection, commitment, event, other. |
content | Conteúdo | string | Não | O fato a memorizar. |
memory_id | ID da memória | string | Não | Identificador da memória alvo. |
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.
| Propriedade | Valor |
|---|
| Tipo | manage_opportunity |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
allowed_actions | Ações permitidas | array | Não | O 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). |
currency | Moeda | string | Não | Moeda das negociações criadas pela IA. Opções: BRL, USD, EUR. |
pipeline_id | Funil de negociações | string | Sim | Funil de negociações onde a IA registra a negociação desta conversa. Opções vindas de opportunity_pipelines. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
action | action | string | Sim | Ação a executar. Valores: get, create, create_new, update_value, move, win, lose. |
current_position | Posição atual do cliente | string | Sim | O que o cliente quer agora, segundo as mensagens mais recentes. |
lost_reason | lost_reason | string | Não | Motivo da perda, nas palavras do cliente, para a ação lose. |
opportunity_id | opportunity_id | string | Não | Id exato de uma negociação retornada por get. Obrigatório quando a conversa tem mais de uma negociação aberta. |
stage | stage | string | Não | Nome exato da etapa destino para a ação move. |
title | title | string | Não | Título curto da negociação, como o produto ou plano negociado. |
value | value | number | Não | Valor da negociação na unidade da moeda, com ponto decimal (ex.: 1500.50). |
Escolha um servidor MCP conectado e quais das ferramentas dele a IA pode usar.
| Propriedade | Valor |
|---|
| Tipo | mcp_source |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | per_target, por source_id |
| Teste | scenario |
| Ajusta à conversa | Não |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
all_tools | Todas as ferramentas | boolean | Não | Ligado: a IA recebe todas as ferramentas do servidor. |
source_id | Servidor | string | Sim | Um servidor MCP já conectado em Agentes, MCP. Opções vindas de mcp_sources. |
tools | Ferramentas permitidas | array | Não | Só estas ferramentas chegam à IA. |
Nenhum campo.
Registra o consentimento do lead para receber mensagens quando ele responde sim a uma pergunta do próprio agente.
| Propriedade | Valor |
|---|
| Tipo | record_consent |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
purpose | Finalidade | string | Não | Para que o lead aceita receber mensagens (opcional). |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
message_id | Mensagem citada | string | Sim | Id da mensagem que serve de prova. |
question_message_id | Mensagem citada | string | Sim | Id da mensagem que serve de prova. |
Registra que o lead pediu para não receber mais mensagens, com a mensagem dele como prova.
| Propriedade | Valor |
|---|
| Tipo | record_opt_out |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
message_id | Mensagem citada | string | Sim | Id da mensagem que serve de prova. |
Muda a data/horário de um evento existente no Google Calendar.
| Propriedade | Valor |
|---|
| Tipo | reschedule_meeting |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
send_updates | Notificar participantes | string | Sim | Controla 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). |
timezone | Fuso horário padrão | string | Sim | Fuso horário usado por padrão ao reagendar. Padrão: "America/Sao_Paulo". |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
duration | Duração (minutos) | number | Não | Nova duração em minutos. |
end_time | Novo fim | string | Não | Nova data e hora de fim. |
event_id | ID do agendamento | string | Sim | Evento existente que será reagendado. |
start_time | Novo início | string | Sim | Nova data e hora de início. |
timezone | Timezone | string | Não | Fuso horário do novo horário. |
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.
| Propriedade | Valor |
|---|
| Tipo | run_workflow |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | per_target, por workflow_id |
| Teste | scenario |
| Ajusta à conversa | Sim |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
workflow_id | Fluxo | string | Sim | Fluxo ativo com o gatilho Chamado por agente IA. Opções vindas de agent_workflows. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
inputs | Campos | object | Não | Campos enviados ao gatilho do fluxo. |
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.
| Propriedade | Valor |
|---|
| Tipo | schedule_follow_up |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
fallback_template_id | Template de reserva | string | Não | Só 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_kind | O que agendar | string | Não | Um 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_id | Template | string | Não | Enviado ao contato desta conversa no horário que o agente escolher. Opções vindas de whatsapp_templates. Vale quando message_kind é template. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
cancel_if_contact_replies | Cancelar se o contato responder | boolean | Não | Ligado por padrão. |
date | Data | date | Não | Dia do envio. |
days_from_today | Dias a partir de hoje | integer | Não | 0 hoje, 1 amanhã. |
in_minutes | Daqui a (minutos) | integer | Não | Tempo até o envio. |
template_values | Valores do template | array de string | Não | Variáveis do template de reserva. |
text | Mensagem | string | Sim | Texto enviado no horário agendado. |
time | Hora | time | Não | Hora do envio. |
Cria eventos no Google Calendar usando as regras configuradas do agente.
| Propriedade | Valor |
|---|
| Tipo | schedule_meeting |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
attendees | Convidados fixos | string | Não | Participantes adicionados quando a conversa não informar convidados. Padrão: "". |
create_google_meet | Criar link do Google Meet | boolean | Sim | Gerar automaticamente um link de reunião do Google Meet. Padrão: true. |
description | Descrição padrão | string | Não | Pauta ou contexto padrão da reunião. Padrão: "Reunião agendada via Vozko". |
duration | Duração padrão da reunião | number | Sim | Tempo padrão da reunião em minutos. Padrão: 30. |
location | Local padrão | string | Não | Local físico ou link externo usado por padrão. Padrão: "". |
send_updates | Envio de convites | string | Sim | Controla 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). |
timezone | Fuso horário padrão | string | Sim | Fuso horário usado por padrão para criar eventos. Padrão: "America/Sao_Paulo". |
title | Título padrão da reunião | string | Sim | Nome padrão da reunião criada no calendário. Padrão: "Reunião Agendada". |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
attendees | Convidados | string | Não | Lista de e-mails dos participantes. |
create_google_meet | Criar Google Meet | boolean | Não | Criar link do Google Meet automaticamente. |
description | Descrição | string | Não | Descrição do evento. |
duration | Duração (minutos) | number | Não | Duração da reunião em minutos. |
end_time | Fim | string | Não | Data e hora de fim da reunião. |
location | Local | string | Não | Local do evento. |
start_time | Início | string | Sim | Data e hora de início da reunião. |
timezone | Timezone | string | Não | Fuso horário do evento. |
title | Título | string | Sim | Título do evento no calendário. |
Permite ao agente pesquisar ativamente na base de conhecimento durante a conversa, reformulando a busca quando necessário.
| Propriedade | Valor |
|---|
| Tipo | search_knowledge_base |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | many |
| Teste | scenario |
| Ajusta à conversa | Não |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
knowledge_base_ids | Bases pesquisadas | array | Não | Vazio: pesquisa todas as bases do agente. Com bases escolhidas, esta busca só olha para elas. Opções vindas de knowledge_bases. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
query | Consulta | string | Sim | O que buscar na base de conhecimento. |
Envia e-mails pelo servidor SMTP configurado pelo usuário, sem usar o e-mail de Vozko.
| Propriedade | Valor |
|---|
| Tipo | send_email |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
default_reply_to | Responder para padrão | string | Não | Endereço Reply-To usado quando a chamada não informar outro. |
smtp_from_email | E-mail remetente | string | Sim | Endereço remetente autorizado pelo servidor SMTP. |
smtp_from_name | Nome do remetente | string | Não | Nome exibido no campo From. |
smtp_host | Servidor SMTP | string | Sim | Hostname do servidor SMTP. |
smtp_password | Senha SMTP | string | Não | Senha ou app password SMTP. |
smtp_port | Porta SMTP | number | Não | Porta do servidor SMTP. Padrão: 587. |
smtp_security | Segurança SMTP | string | Não | STARTTLS, 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_username | Usuário SMTP | string | Não | Usuário para autenticação SMTP. |
timeout_seconds | Timeout | number | Não | Timeout em segundos. Padrão: 30. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
bcc | Bcc | string | Não | Destinatários em cópia oculta. |
body | Conteúdo | string | Sim | Conteúdo do e-mail (HTML ou texto). |
body_type | Formato do conteúdo | string | Não | Formato HTML ou texto simples. Valores: html, text. |
cc | Cc | string | Não | Destinatários em cópia. |
reply_to | Responder para | string | Não | Endereço usado no cabeçalho Reply-To. |
subject | Assunto | string | Sim | Assunto do e-mail. |
to | Destinatário | string | Sim | Endereço de e-mail do destinatário. |
Envia uma mídia (imagem, vídeo, áudio, documento ou sticker) ao contato.
| Propriedade | Valor |
|---|
| Tipo | send_media |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
caption | Legenda | string | Não | Legenda opcional (apenas para imagem, vídeo e documento). |
media_id | ID da Mídia | string | Não | ID da mídia a ser enviada. |
media_url | URL da Mídia | string | Não | URL direta da mídia (apenas do CDN). |
to | Destinatário | string | Não | Opcional, por padrão, o contato da conversa atual. |
Envia uma mensagem com botões de resposta rápida ou botão de cópia (Pix, cupons, etc.).
| Propriedade | Valor |
|---|
| Tipo | send_options |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
body | Mensagem | string | Sim | Texto da mensagem exibida acima dos botões. |
buttons | Botões | array de object | Sim | Lista de botões de resposta rápida ou cópia (máx. 3). |
buttons[].id | Identificador | string | Não | ID interno do botão (somente reply). |
buttons[].title | Título | string | Não | Texto exibido no botão (máx. 20 caracteres, somente reply). |
buttons[].type | Tipo | string | Sim | Tipo do botão. Valores: reply, copy_code. |
buttons[].value | Valor a copiar | string | Não | Valor copiado ao clicar (somente copy_code). |
footer | Rodapé | string | Não | Texto do rodapé (opcional). |
header | Cabeçalho | string | Não | Texto do cabeçalho (opcional). |
Envia e-mails transacionais pelos remetentes cadastrados em E-mail, cobrados do saldo.
| Propriedade | Valor |
|---|
| Tipo | send_platform_email |
| Categoria | messaging |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
design_id | Design | string | Não | Design salvo usado como corpo. |
subject | Assunto | string | Sim | Assunto do e-mail. |
text | Texto | string | Não | Corpo do e-mail em texto. |
to | Destinatário | string | Não | Endereço de e-mail do destinatário. |
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.
| Propriedade | Valor |
|---|
| Tipo | transfer_to_automation |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Sim |
Exige configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
destinations | Destinos | array | Sim | Agentes e fluxos que podem receber a conversa, cada um com uma etapa opcional e a descrição de quando usar. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
destination | Destino | string | Sim | O destino escolhido pela IA. |
note | Nota da transferência | string | Sim | Motivo e resumo que o destino recebe. |
variables | Dados para o destino | object | Não | Valores que a IA informa ao transferir. |
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.
| Propriedade | Valor |
|---|
| Tipo | transfer_to_human |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | per_target, por department_id |
| Teste | scenario |
| Ajusta à conversa | Não |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
department_id | Departamento | string | Não | Vazio: usa o departamento da própria conversa. Opções vindas de departments. |
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
reason | Motivo | string | Não | Por que a conversa foi transferida. |
Salva no cadastro do lead o endereço, o bairro, a data de nascimento e campos personalizados que ele informou na conversa.
| Propriedade | Valor |
|---|
| Tipo | update_lead_profile |
| Categoria | agent_action |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
bairro | Bairro | string | Não | Bairro. |
campos | Campos personalizados | object | Não | Campos personalizados de lead. |
cep | CEP | string | Não | CEP do endereço. |
cidade | Cidade | string | Não | Cidade. |
complemento | Complemento | string | Não | Apartamento, bloco. |
data_nascimento | Data de nascimento | string | Não | Data de nascimento do lead. |
logradouro | Logradouro | string | Não | Rua ou avenida. |
numero | Número | string | Não | Número do imóvel. |
uf | UF | string | Não | Estado. |
Verifica e normaliza um CEP, retornando logradouro, bairro, cidade e estado.
| Propriedade | Valor |
|---|
| Tipo | validate_cep |
| Categoria | agent_utility |
| Visibilidade | messaging |
| Instâncias | single |
| Teste | scenario |
| Ajusta à conversa | Não |
Sem configuração.
| Campo | Nome | Tipo | Obrigatório | Descrição |
|---|
cep | CEP | string | Sim | CEP a ser validado (ex: 01310-100). |