feat(messages): add sendProduct endpoint for WhatsApp Business catalog cards

Author: yarninz

src/api/controllers/sendMessage.controller.ts

@@ -7,6 +7,7 @@ import {
   SendLocationDto,
   SendMediaDto,
   SendPollDto,
+  SendProductDto,
   SendPtvDto,
   SendReactionDto,
   SendStatusDto,
@@ -101,6 +102,13 @@ export class SendMessageController {
     return await this.waMonitor.waInstances[instanceName].pollMessage(data);
   }
 
+  public async sendProduct({ instanceName }: InstanceDto, data: SendProductDto) {
+    if (!isURL(data?.productImage) && !isBase64(data?.productImage)) {
+      throw new BadRequestException('productImage must be a URL or base64 string');
+    }
+    return await this.waMonitor.waInstances[instanceName].productMessage(data);
+  }
+
   public async sendStatus({ instanceName }: InstanceDto, data: SendStatusDto, file?: any) {
     return await this.waMonitor.waInstances[instanceName].statusMessage(data, file);
   }

src/api/dto/sendMessage.dto.ts

@@ -167,3 +167,28 @@ export class SendReactionDto {
   key: proto.IMessageKey;
   reaction: string;
 }
+
+export class SendProductDto extends Metadata {
+  /** WhatsApp internal product id (from /business/getCatalog `id`) */
+  productId: string;
+  /** Business owner JID — `<phone>@s.whatsapp.net` of the catalog owner */
+  businessOwnerJid: string;
+  /** Product image — URL or base64 */
+  productImage: string;
+  /** Merchant-side retailer id (e.g. `BD3`). Optional. */
+  retailerId?: string;
+  /** Product title shown to recipients as a fallback. */
+  title?: string;
+  /** Product description shown as a fallback. */
+  description?: string;
+  /** ISO 4217 currency code (e.g. `ILS`, `USD`). Defaults to `USD`. */
+  currencyCode?: string;
+  /** Price × 1000 (e.g. 5500 ILS → `5500000`). */
+  priceAmount1000?: number;
+  /** Product landing URL. Optional. */
+  url?: string;
+  /** How many images the product has in the catalog. Defaults to 1. */
+  productImageCount?: number;
+  /** Optional caption sent alongside the product card. */
+  caption?: string;
+}

src/api/routes/sendMessage.router.ts

@@ -7,6 +7,7 @@ import {
   SendLocationDto,
   SendMediaDto,
   SendPollDto,
+  SendProductDto,
   SendPtvDto,
   SendReactionDto,
   SendStatusDto,
@@ -23,6 +24,7 @@ import {
   locationMessageSchema,
   mediaMessageSchema,
   pollMessageSchema,
+  productMessageSchema,
   ptvMessageSchema,
   reactionMessageSchema,
   statusMessageSchema,
@@ -162,6 +164,16 @@ export class MessageRouter extends RouterBroker {
 
         return res.status(HttpStatus.CREATED).json(response);
       })
+      .post(this.routerPath('sendProduct'), ...guards, async (req, res) => {
+        const response = await this.dataValidate<SendProductDto>({
+          request: req,
+          schema: productMessageSchema,
+          ClassRef: SendProductDto,
+          execute: (instance, data) => sendMessageController.sendProduct(instance, data),
+        });
+
+        return res.status(HttpStatus.CREATED).json(response);
+      })
       .post(this.routerPath('sendList'), ...guards, async (req, res) => {
         const response = await this.dataValidate<SendListDto>({
           request: req,

src/validate/message.schema.ts

@@ -447,3 +447,30 @@ export const buttonsMessageSchema: JSONSchema7 = {
   },
   required: ['number'],
 };
+
+export const productMessageSchema: JSONSchema7 = {
+  $id: v4(),
+  type: 'object',
+  properties: {
+    number: { ...numberDefinition },
+    productId: { type: 'string', minLength: 1 },
+    businessOwnerJid: {
+      type: 'string',
+      pattern: '^[0-9]+@s[.]whatsapp[.]net$',
+      description: '"businessOwnerJid" must look like "<phone>@s.whatsapp.net"',
+    },
+    productImage: { type: 'string', minLength: 1 },
+    retailerId: { type: 'string' },
+    title: { type: 'string' },
+    description: { type: 'string' },
+    currencyCode: { type: 'string', minLength: 3, maxLength: 3 },
+    priceAmount1000: { type: 'integer', minimum: 0 },
+    url: { type: 'string' },
+    productImageCount: { type: 'integer', minimum: 1 },
+    caption: { type: 'string' },
+    delay: { type: 'integer', description: 'Enter a value in milliseconds' },
+    quoted: { ...quotedOptionsSchema },
+  },
+  required: ['number', 'productId', 'businessOwnerJid', 'productImage'],
+  ...isNotEmpty('number', 'productId', 'businessOwnerJid', 'productImage'),
+};