WhatsApp API

MCP: WhatsApp

Números, plantillas y Flows de WhatsApp por el MCP. 22 herramientas.

Herramientas de esta área, generadas del código del servidor. Las descripciones vienen de ese código, en portugués. Para conectar, mira el MCP de 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
namesí—
kindsíbuttons = até 3 botões de resposta; list = menu com até 10 opções
headerTextno—
bodyTextsí—
footerTextno—
buttonsnoSó para kind=buttons
listButtonTextnoSó para kind=list: texto do botão que abre a lista
rowsnoSó 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdnoID da conexão WhatsApp (veja list-whatsapp-connections)
shortcutsíAtalho no chat (menu /)
titlesí—
elementNamesíNome do template na Meta
languageCodesíEx.: pt_BR
categorysí—
contentsíCorpo da mensagem
headerno—
footerno—
buttonsno—
bodyParamsExampleno—
oncePerThreadno—
isActiveno—

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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
namesí—
categoriessí—
flowJsonnoFlow JSON da Meta (objeto ou texto JSON)
cloneFlowIdnoDuplica um flow existente da mesma WABA
endpointUrinoSó para flows dinâmicos (data_exchange)
publishno—

delete-interactive-preset

Exclui um modelo de mensagem interativa do workspace. ⚠️ Ação irreversível.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
presetIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
templateIdsíID do template WABA (veja list-waba-templates)
alsoDeleteOnProviderno—

delete-whatsapp-flow

Exclui um WhatsApp Flow em rascunho. ⚠️ Ação irreversível. A Meta só permite excluir rascunhos; publicado precisa ser descontinuado.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsíID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows)

get-waba-template

Detalhe de um template WABA do workspace.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
templateIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsíID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows)
withPreviewno—

list-interactive-presets

Lista os modelos salvos de mensagem interativa (botões de resposta / lista) do workspace.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
statusno—
limitnoMá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ámetroObligatorioDescripción
workspaceIdnoOpcional: 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsí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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
displayNamesí—

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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsíID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows)
tosí—
flowCtasíTexto do botão que abre o flow
bodyTextsí—
headerTextno—
footerTextno—

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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
agentIdsíID do agente (veja get-agents-by-workspace)
agentReplynoComo 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ámetroObligatorioDescripción
workspaceIdnoOpcional: 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
presetIdsíID do preset interativo (veja list-interactive-presets)
nameno—
kindsíbuttons = até 3 botões de resposta; list = menu com até 10 opções
headerTextno—
bodyTextsí—
footerTextno—
buttonsnoSó para kind=buttons
listButtonTextnoSó para kind=list: texto do botão que abre a lista
rowsnoSó 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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
templateIdsíID do template WABA (veja list-waba-templates)
shortcutno—
titleno—
categoryno—
contentno—
headerno—
footerno—
buttonsno—
oncePerThreadno—
isActiveno—

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ámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
connectionIdsíID da conexão WhatsApp (veja list-whatsapp-connections)
flowIdsíID do WhatsApp Flow na Meta (só dígitos; veja list-whatsapp-flows)
nameno—
categoriesno—
endpointUrino—
flowJsonnoFlow JSON da Meta (objeto ou texto JSON)

En esta página