MCP: WhatsApp
WhatsApp numbers, templates and Flows through the MCP. 22 tools.
Tools in this area, generated from the server code. The descriptions come from that code, in Portuguese. To connect, see the XBASE MCP.
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).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
name | yes | — |
kind | yes | buttons = até 3 botões de resposta; list = menu com até 10 opções |
headerText | no | — |
bodyText | yes | — |
footerText | no | — |
buttons | no | Só para kind=buttons |
listButtonText | no | Só para kind=list: texto do botão que abre a lista |
rows | no | 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).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | no | ID da conexão WhatsApp (veja list-whatsapp-connections) |
shortcut | yes | Atalho no chat (menu /) |
title | yes | — |
elementName | yes | Nome do template na Meta |
languageCode | yes | Ex.: pt_BR |
category | yes | — |
content | yes | Corpo da mensagem |
header | no | — |
footer | no | — |
buttons | no | — |
bodyParamsExample | no | — |
oncePerThread | no | — |
isActive | no | — |
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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
name | yes | — |
categories | yes | — |
flowJson | no | Flow JSON da Meta (objeto ou texto JSON) |
cloneFlowId | no | Duplica um flow existente da mesma WABA |
endpointUri | no | Só para flows dinâmicos (data_exchange) |
publish | no | — |
delete-interactive-preset
Exclui um modelo de mensagem interativa do workspace. ⚠️ Ação irreversível.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
presetId | yes | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | yes | ID do template WABA (veja list-waba-templates) |
alsoDeleteOnProvider | no | — |
delete-whatsapp-flow
Exclui um WhatsApp Flow em rascunho. ⚠️ Ação irreversível. A Meta só permite excluir rascunhos; publicado precisa ser descontinuado.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
get-waba-template
Detalhe de um template WABA do workspace.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | yes | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
withPreview | no | — |
list-interactive-presets
Lista os modelos salvos de mensagem interativa (botões de resposta / lista) do workspace.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | 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).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
status | no | — |
limit | no | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | 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).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | 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>".
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
displayName | yes | — |
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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
to | yes | — |
flowCta | yes | Texto do botão que abre o flow |
bodyText | yes | — |
headerText | no | — |
footerText | no | — |
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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
agentId | yes | ID do agente (veja get-agents-by-workspace) |
agentReply | no | 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).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
presetId | yes | ID do preset interativo (veja list-interactive-presets) |
name | no | — |
kind | yes | buttons = até 3 botões de resposta; list = menu com até 10 opções |
headerText | no | — |
bodyText | yes | — |
footerText | no | — |
buttons | no | Só para kind=buttons |
listButtonText | no | Só para kind=list: texto do botão que abre a lista |
rows | no | 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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
templateId | yes | ID do template WABA (veja list-waba-templates) |
shortcut | no | — |
title | no | — |
category | no | — |
content | no | — |
header | no | — |
footer | no | — |
buttons | no | — |
oncePerThread | no | — |
isActive | no | — |
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.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
connectionId | yes | ID da conexão WhatsApp (veja list-whatsapp-connections) |
flowId | yes | ID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows) |
name | no | — |
categories | no | — |
endpointUri | no | — |
flowJson | no | Flow JSON da Meta (objeto ou texto JSON) |