MCP: WhatsApp
Números, templates e Flows do WhatsApp pelo MCP. 22 ferramentas.
Ferramentas desta área, geradas do código do servidor. As descrições vêm desse código, em português. Para conectar, veja o MCP da XBASE.
create-interactive-preset
Cria um modelo de mensagem interativa no workspace: botões de resposta (kind=buttons, até 3) ou lista (kind=list, até 10 opções).
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
name | sim | — |
kind | sim | buttons = até 3 botões de resposta; list = menu com até 10 opções |
headerText | não | — |
bodyText | sim | — |
footerText | não | — |
buttons | não | Só para kind=buttons |
listButtonText | não | Só para kind=list: texto do botão que abre a lista |
rows | não | Só para kind=list |
create-waba-template
Cria um template WABA de texto direto na Meta (Cloud API) e submete para aprovação (fica PENDING). Corpo com {{1}}, {{2}}… exige bodyParamsExample na mesma ordem. connectionId escolhe a WABA (padrão: o número mais antigo do workspace).
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | não | ID da conexão WhatsApp (veja list-whatsapp-connections) |
shortcut | sim | Atalho no chat (menu /) |
title | sim | — |
elementName | sim | Nome do template na Meta |
languageCode | sim | Ex.: pt_BR |
category | sim | — |
content | sim | Corpo da mensagem |
header | não | — |
footer | não | — |
buttons | não | — |
bodyParamsExample | não | — |
oncePerThread | não | — |
isActive | não | — |
create-whatsapp-flow
Cria um WhatsApp Flow (rascunho) na WABA do número: a partir de um Flow JSON ou clonando outro flow (cloneFlowId). publish=true publica em seguida — ⚠️ flow publicado não pode mais ser editado.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
name | sim | — |
categories | sim | — |
flowJson | não | Flow JSON da Meta (objeto ou texto JSON) |
cloneFlowId | não | Duplica um flow existente da mesma WABA |
endpointUri | não | Só para flows dinâmicos (data_exchange) |
publish | não | — |
delete-interactive-preset
Exclui um modelo de mensagem interativa do workspace. ⚠️ Ação irreversível.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
presetId | sim | ID do preset interativo (veja list-interactive-presets) |
delete-waba-template
Exclui um template WABA do workspace. ⚠️ Ação irreversível. alsoDeleteOnProvider=true também exclui na Meta (senão ele volta no próximo "Sincronizar"); a Meta bloqueia reutilizar o nome por um tempo.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | sim | ID do template WABA (veja list-waba-templates) |
alsoDeleteOnProvider | não | — |
delete-whatsapp-flow
Exclui um WhatsApp Flow em rascunho. ⚠️ Ação irreversível. A Meta só permite excluir rascunhos; publicado precisa ser descontinuado.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
deprecate-whatsapp-flow
Descontinua um WhatsApp Flow publicado. ⚠️ Ação irreversível: o flow deixa de poder ser enviado e não volta a ser publicado.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
get-waba-template
Detalhe de um template WABA do workspace.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | sim | ID do template WABA (veja list-waba-templates) |
get-whatsapp-flow
Detalhe de um WhatsApp Flow: status, categorias, erros de validação e o Flow JSON. withPreview=true inclui o link de prévia da Meta.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
withPreview | não | — |
list-interactive-presets
Lista os modelos salvos de mensagem interativa (botões de resposta / lista) do workspace.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
list-waba-templates
Lista os templates WABA do workspace (atalho, nome na Meta, status, categoria e conteúdo).
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
status | não | — |
limit | não | Máximo de templates (padrão 100) |
list-whatsapp-connections
Lista os números de WhatsApp (Cloud API) conectados ao workspace, com o agente vinculado a cada um.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
list-whatsapp-flows
Lista os WhatsApp Flows (formulários da Meta) da WABA de um número do workspace, com status.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
publish-whatsapp-flow
Publica um WhatsApp Flow. ⚠️ Ação irreversível: depois de publicado o flow não pode mais ser editado (só descontinuado). O Flow JSON precisa passar na validação da Meta.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
remove-channel-agent
Desvincula o agente de um número de WhatsApp do workspace: o agente para de responder as conversas desse número (as conversas ficam só com humanos).
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
rename-whatsapp-connection
Renomeia um número de WhatsApp do workspace (nome de exibição na XBASE). displayName vazio ou null volta ao padrão "WhatsApp <número>".
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
displayName | sim | — |
send-test-whatsapp-flow
Envia um WhatsApp Flow (rascunho ou publicado) para um número de teste, fora do chat. Envia uma mensagem real pelo número escolhido.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
to | sim | — |
flowCta | sim | Texto do botão que abre o flow |
bodyText | sim | — |
headerText | não | — |
footerText | não | — |
set-channel-agent
Vincula um agente do workspace a um número de WhatsApp: o agente passa a responder as conversas desse número (substitui o agente atual). agentReply ajusta espera, modo de resposta e pausa quando um humano responde.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
agentId | sim | ID do agente (veja get-agents-by-workspace) |
agentReply | não | Como o agente responde no canal; ausente = padrão do tipo de agente |
sync-waba-templates
Sincroniza os templates WABA do workspace com a Meta (status de aprovação e templates novos).
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
update-interactive-preset
Substitui o conteúdo de um modelo de mensagem interativa do workspace (envie o conteúdo completo: tipo, corpo e botões ou lista). name é opcional.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
presetId | sim | ID do preset interativo (veja list-interactive-presets) |
name | não | — |
kind | sim | buttons = até 3 botões de resposta; list = menu com até 10 opções |
headerText | não | — |
bodyText | sim | — |
footerText | não | — |
buttons | não | Só para kind=buttons |
listButtonText | não | Só para kind=list: texto do botão que abre a lista |
rows | não | Só para kind=list |
update-waba-template
Edita um template WABA do workspace. Atalho, título, ativo e oncePerThread mudam só na XBASE; mudar conteúdo, cabeçalho, rodapé ou botões re-submete o template para aprovação (quando o provedor permite). Só os campos enviados mudam.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | sim | ID do template WABA (veja list-waba-templates) |
shortcut | não | — |
title | não | — |
category | não | — |
content | não | — |
header | não | — |
footer | não | — |
buttons | não | — |
oncePerThread | não | — |
isActive | não | — |
update-whatsapp-flow
Edita um WhatsApp Flow em rascunho: nome, categorias, endpoint ou Flow JSON (substitui o JSON inteiro). Só os campos enviados mudam. Flow publicado não aceita edição na Meta.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
workspaceId | não | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | sim | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | sim | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
name | não | — |
categories | não | — |
endpointUri | não | — |
flowJson | não | Flow JSON da Meta (objeto ou texto JSON) |