Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(baileys): receive round video notes as video with their media

Yudhi Armyndharis36e14e55db86
diff --git a/src/engine/adapters/baileys-events.ts b/src/engine/adapters/baileys-events.ts
index 7db2732e7..b7b457064 100644
--- a/src/engine/adapters/baileys-events.ts
+++ b/src/engine/adapters/baileys-events.ts
@@ -1229,6 +1229,7 @@ export class BaileysEvents {
const isMediaType =
contentType === 'imageMessage' ||
contentType === 'videoMessage' ||
+ contentType === 'ptvMessage' ||
contentType === 'audioMessage' ||
contentType === 'documentMessage' ||
contentType === 'documentWithCaptionMessage' ||
@@ -1248,6 +1249,7 @@ export class BaileysEvents {
const subMessage =
normalizedContent.imageMessage ??
normalizedContent.videoMessage ??
+ normalizedContent.ptvMessage ??
normalizedContent.audioMessage ??
normalizedContent.documentMessage ??
normalizedContent.stickerMessage;
@@ -1265,6 +1267,7 @@ export class BaileysEvents {
const subMessage =
normalizedContent.imageMessage ??
normalizedContent.videoMessage ??
+ normalizedContent.ptvMessage ??
normalizedContent.audioMessage ??
normalizedContent.documentMessage ??
normalizedContent.stickerMessage;
diff --git a/src/engine/adapters/baileys-message-mapper.spec.ts b/src/engine/adapters/baileys-message-mapper.spec.ts
index 677bab5bf..6effae007 100644
--- a/src/engine/adapters/baileys-message-mapper.spec.ts
+++ b/src/engine/adapters/baileys-message-mapper.spec.ts
@@ -23,6 +23,8 @@ describe('mapBaileysMessageType (baileys content-type -> neutral MessageType)',
['extendedTextMessage', false, 'text'],
['imageMessage', false, 'image'],
['videoMessage', false, 'video'],
+ // A round video note is a VideoMessage under its own key.
+ ['ptvMessage', false, 'video'],
['audioMessage', false, 'audio'],
['audioMessage', true, 'voice'],
['documentMessage', false, 'document'],
@@ -233,6 +235,25 @@ describe('extractBaileysContext (quoted body shares the live body extractor)', (
expect(quoted({ stickerMessage: {} })?.body).toBe('');
});
+ it('reads the quote, timer and mentions off a video note', () => {
+ expect(
+ extractBaileysContext({
+ ptvMessage: {
+ contextInfo: {
+ stanzaId: 'wamid.original',
+ quotedMessage: { conversation: 'the original' },
+ expiration: 86400,
+ mentionedJid: ['[email protected]'],
+ },
+ },
+ }),
+ ).toMatchObject({
+ quotedMessage: { id: 'wamid.original', body: 'the original' },
+ ephemeralDuration: 86400,
+ mentionedJids: ['[email protected]'],
+ });
+ });
+
it('carries a quote from a button-reply contextInfo', () => {
expect(
extractBaileysContext({
diff --git a/src/engine/adapters/baileys-message-mapper.ts b/src/engine/adapters/baileys-message-mapper.ts
index 894cb1ec9..f21e0ad01 100644
--- a/src/engine/adapters/baileys-message-mapper.ts
+++ b/src/engine/adapters/baileys-message-mapper.ts
@@ -38,6 +38,8 @@ export function mapBaileysMessageType(
case 'imageMessage':
return 'image';
case 'videoMessage':
+ case 'ptvMessage':
+ // A round video note is a VideoMessage under its own content key.
return 'video';
case 'audioMessage':
return isPtt ? 'voice' : 'audio';
@@ -806,6 +808,7 @@ export interface BaileysContextContent {
extendedTextMessage?: (BaileysContextCarrier & { backgroundArgb?: number | null; font?: number | null }) | null;
imageMessage?: BaileysContextCarrier | null;
videoMessage?: BaileysContextCarrier | null;
+ ptvMessage?: BaileysContextCarrier | null;
audioMessage?: BaileysContextCarrier | null;
documentMessage?: BaileysContextCarrier | null;
stickerMessage?: BaileysContextCarrier | null;
@@ -844,6 +847,7 @@ export function extractBaileysContext(content: BaileysContextContent): BaileysMe
content.extendedTextMessage ??
content.imageMessage ??
content.videoMessage ??
+ content.ptvMessage ??
content.audioMessage ??
content.documentMessage ??
content.stickerMessage ??
diff --git a/src/engine/adapters/baileys.adapter.spec.ts b/src/engine/adapters/baileys.adapter.spec.ts
index b77c4e8e1..3d84722a4 100644
--- a/src/engine/adapters/baileys.adapter.spec.ts
+++ b/src/engine/adapters/baileys.adapter.spec.ts
@@ -2723,6 +2723,59 @@ describe('BaileysAdapter inbound fan-out', () => {
expect(msg.media).toEqual({ mimetype: 'image/png', data: imgBuf.toString('base64') });
});
+ it.each([
+ ['downloads', 'true'],
+ ['marks as omitted', 'false'],
+ ])('inbound video note: types it as video, %s its media and keeps its quote', async (_label, enabled) => {
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+ const baileys = jest.requireMock('@whiskeysockets/baileys') as {
+ getContentType: jest.Mock;
+ downloadMediaMessage: jest.Mock;
+ };
+ baileys.getContentType.mockImplementation(realGetContentType);
+ const clip = Buffer.from('MP4BYTES');
+ baileys.downloadMediaMessage.mockResolvedValue(streamOf(clip));
+ const prev = process.env.MEDIA_DOWNLOAD_ENABLED;
+ process.env.MEDIA_DOWNLOAD_ENABLED = enabled;
+ try {
+ const onMessage = jest.fn();
+ const adapter = newAdapter();
+ await adapter.initialize({ onMessage });
+ fakeSock.fire('messages.upsert', {
+ type: 'notify',
+ messages: [
+ {
+ key: { remoteJid: '[email protected]', fromMe: false, id: 'PTV1' },
+ message: {
+ ptvMessage: {
+ mimetype: 'video/mp4',
+ fileLength: 8,
+ contextInfo: { stanzaId: 'ORIG1', quotedMessage: { conversation: 'the original' } },
+ },
+ },
+ messageTimestamp: 1700000020,
+ },
+ ],
+ });
+ await new Promise(r => setImmediate(r));
+ await new Promise(r => setImmediate(r));
+ expect(onMessage).toHaveBeenCalledTimes(1);
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+ const msg = onMessage.mock.calls[0][0] as IncomingMessage;
+ expect(msg.type).toBe('video');
+ expect(msg.quotedMessage).toEqual({ id: 'ORIG1', body: 'the original' });
+ if (enabled === 'true') {
+ expect(msg.media).toEqual({ mimetype: 'video/mp4', data: clip.toString('base64') });
+ } else {
+ expect(msg.media).toEqual({ mimetype: 'video/mp4', omitted: true, sizeBytes: 8 });
+ expect(baileys.downloadMediaMessage).not.toHaveBeenCalled();
+ }
+ } finally {
+ if (prev === undefined) delete process.env.MEDIA_DOWNLOAD_ENABLED;
+ else process.env.MEDIA_DOWNLOAD_ENABLED = prev;
+ }
+ });
+
it('inbound media: skips the download entirely when the declared fileLength exceeds the cap', async () => {
const prev = process.env.MEDIA_DOWNLOAD_MAX_BYTES;
process.env.MEDIA_DOWNLOAD_MAX_BYTES = '10';