feat(experimental): add interactive messages support (buttons, lists, templates, carousel)

⚠️ EXPERIMENTAL FEATURE - Use only for testing with disposable accounts

Implements full support for WhatsApp interactive messages including:
- Simple text buttons (up to 3 buttons)
- Buttons with images/videos
- List messages (up to 10 items in sections)
- Template buttons (quick reply, URL, call actions)
- Carousel messages (up to 10 scrollable cards)

Features:
- Feature flag 'enableInteractiveMessages' (default: true for dev/testing)
- Prometheus metrics for tracking sends, successes, failures, and latency
- Comprehensive TypeScript types for all interactive message formats
- Extensive logging with warnings about potential account bans
- Automatic 'biz' node injection when feature is enabled

CRITICAL WARNINGS:
- These features may NOT work on non-business WhatsApp accounts
- Can cause temporary or permanent account BANS
- WhatsApp actively blocks this functionality since April 2022
- Messages may be rejected or fail silently
- Use ONLY in dev environment with test accounts

Architecture:
- Added ButtonInfo, Templatable, Listable, Carouselable types to Message.ts
- Extended AnyMediaMessageContent and AnyRegularMessageContent
- Implemented message generation in messages.ts
- Added getButtonType() and getButtonArgs() helpers in messages-send.ts
- Injected 'biz' node in stanza construction with metrics tracking
- Added 4 new Prometheus metrics: interactiveMessagesSent, Success, Failures, Latency

Documentation:
- Complete usage guide in INTERACTIVE_MESSAGES.md
- Examples for all interactive message types
- Metrics monitoring queries
- Troubleshooting guide
- Migration path to WhatsApp Business API

Related issues:
- https://github.com/WhiskeySockets/Baileys/issues/56
- https://github.com/WhiskeySockets/Baileys/issues/25
- https://github.com/WhiskeySockets/Baileys/pull/2291

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Renato Alcara
2026-01-23 00:51:33 -03:00
parent fe2563d509
commit 90db2512d9
7 changed files with 837 additions and 4 deletions
+73 -2
View File
@@ -56,7 +56,7 @@ import {
S_WHATSAPP_NET
} from '../WABinary'
import { USyncQuery, USyncUser } from '../WAUSync'
import { recordMessageSent, recordMessageRetry, recordMessageFailure } from '../Utils/prometheus-metrics'
import { recordMessageSent, recordMessageRetry, recordMessageFailure, metrics } from '../Utils/prometheus-metrics'
import { makeNewsletterSocket } from './newsletter'
export const makeMessagesSocket = (config: SocketConfig) => {
@@ -68,7 +68,8 @@ export const makeMessagesSocket = (config: SocketConfig) => {
patchMessageBeforeSending,
cachedGroupMetadata,
enableRecentMessageCache,
maxMsgRetryCount
maxMsgRetryCount,
enableInteractiveMessages
} = config
const sock = makeNewsletterSocket(config)
const {
@@ -603,6 +604,33 @@ export const makeMessagesSocket = (config: SocketConfig) => {
return { nodes, shouldIncludeDeviceIdentity }
}
// ⚠️ EXPERIMENTAL: Functions to detect and handle interactive messages
// These features may not work and can cause account bans
const getButtonType = (message: proto.IMessage): string | undefined => {
if (message.buttonsMessage) {
return 'buttons'
} else if (message.templateMessage) {
return 'template'
} else if (message.listMessage) {
return 'list'
} else if (message.buttonsResponseMessage) {
return 'buttons_response'
} else if (message.listResponseMessage) {
return 'list_response'
} else if (message.templateButtonReplyMessage) {
return 'template_reply'
} else if (message.interactiveMessage) {
return 'interactive'
}
return undefined
}
const getButtonArgs = (message: proto.IMessage): BinaryNodeAttributes => {
// Return appropriate attributes for each button type
// This is often empty but required for the 'biz' node structure
return {}
}
const relayMessage = async (
jid: string,
message: proto.IMessage,
@@ -965,6 +993,49 @@ export const makeMessagesSocket = (config: SocketConfig) => {
content: binaryNodeContent
}
// ⚠️ EXPERIMENTAL: Inject 'biz' node for interactive messages
// This may not work and can cause account bans
const buttonType = getButtonType(message)
if (buttonType && enableInteractiveMessages) {
const startTime = Date.now()
logger.warn(
{ msgId, buttonType, to: destinationJid, enableInteractiveMessages },
'[EXPERIMENTAL] Injecting biz node for interactive message - may cause ban'
)
// Track that we're sending an interactive message
metrics.interactiveMessagesSent.inc({ type: buttonType })
try {
;(stanza.content as BinaryNode[]).push({
tag: 'biz',
attrs: {},
content: [
{
tag: buttonType,
attrs: getButtonArgs(message)
}
]
})
// Track success and latency after message is sent
metrics.interactiveMessagesSuccess.inc({ type: buttonType })
metrics.interactiveMessagesLatency.observe({ type: buttonType }, Date.now() - startTime)
} catch (error) {
logger.error(
{ error, msgId, buttonType },
'[EXPERIMENTAL] Failed to inject biz node for interactive message'
)
metrics.interactiveMessagesFailures.inc({ type: buttonType, reason: 'injection_failed' })
}
} else if (buttonType && !enableInteractiveMessages) {
logger.warn(
{ msgId, buttonType },
'[EXPERIMENTAL] Interactive message detected but feature disabled (enableInteractiveMessages=false)'
)
metrics.interactiveMessagesFailures.inc({ type: buttonType, reason: 'feature_disabled' })
}
// if the participant to send to is explicitly specified (generally retry recp)
// ensure the message is only sent to that person
// if a retry receipt is sent to everyone -- it'll fail decryption for everyone else who received the msg