feat: whatsapp cloud api

Author: DavidsonGomes

Docker/.env.example

@@ -51,6 +51,11 @@ RABBITMQ_URI=amqp://guest:guest@rabbitmq:5672
 
 WEBSOCKET_ENABLED=false
 
+WA_BUSINESS_TOKEN_WEBHOOK=evolution
+WA_BUSINESS_URL=https://graph.facebook.com
+WA_BUSINESS_VERSION=v18.0
+WA_BUSINESS_LANGUAGE=pt_BR
+
 SQS_ENABLED=false
 SQS_ACCESS_KEY_ID=
 SQS_SECRET_ACCESS_KEY=

Dockerfile

@@ -66,6 +66,11 @@ ENV RABBITMQ_URI=amqp://guest:guest@rabbitmq:5672
 
 ENV WEBSOCKET_ENABLED=false
 
+ENV WA_BUSINESS_TOKEN_WEBHOOK=evolution
+ENV WA_BUSINESS_URL=https://graph.facebook.com
+ENV WA_BUSINESS_VERSION=v18.0
+ENV WA_BUSINESS_LANGUAGE=pt_BR
+
 ENV SQS_ENABLED=false
 ENV SQS_ACCESS_KEY_ID=
 ENV SQS_SECRET_ACCESS_KEY=

src/config/env.config.ts

@@ -86,6 +86,13 @@ export type Websocket = {
   ENABLED: boolean;
 };
 
+export type WaBusiness = {
+  TOKEN_WEBHOOK: string;
+  URL: string;
+  VERSION: string;
+  LANGUAGE: string;
+};
+
 export type EventsWebhook = {
   APPLICATION_STARTUP: boolean;
   INSTANCE_CREATE: boolean;
@@ -179,6 +186,7 @@ export interface Env {
   RABBITMQ: Rabbitmq;
   SQS: Sqs;
   WEBSOCKET: Websocket;
+  WA_BUSINESS: WaBusiness;
   LOG: Log;
   DEL_INSTANCE: DelInstance;
   LANGUAGE: Language;
@@ -286,6 +294,12 @@ export class ConfigService {
       WEBSOCKET: {
         ENABLED: process.env?.WEBSOCKET_ENABLED === 'true',
       },
+      WA_BUSINESS: {
+        TOKEN_WEBHOOK: process.env.WA_BUSINESS_TOKEN_WEBHOOK || '',
+        URL: process.env.WA_BUSINESS_URL || '',
+        VERSION: process.env.WA_BUSINESS_VERSION || '',
+        LANGUAGE: process.env.WA_BUSINESS_LANGUAGE || 'en',
+      },
       LOG: {
         LEVEL: (process.env?.LOG_LEVEL.split(',') as LogLevel[]) || [
           'ERROR',

src/dev-env.yml

@@ -12,7 +12,6 @@ SERVER:
   DISABLE_MANAGER: false
   DISABLE_DOCS: false
 
-
 CORS:
   ORIGIN:
     - "*"
@@ -96,6 +95,12 @@ SQS:
 WEBSOCKET:
   ENABLED: false
 
+WA_BUSINESS:
+  TOKEN_WEBHOOK: evolution
+  URL: https://graph.facebook.com
+  VERSION: v18.0
+  LANGUAGE: pt_BR
+
 # Global Webhook Settings
 # Each instance's Webhook URL and events will be requested at the time it is created
 WEBHOOK:
@@ -152,12 +157,12 @@ QRCODE:
   COLOR: "#198754"
 
 TYPEBOT:
-  API_VERSION: 'old' # old | latest
+  API_VERSION: "old" # old | latest
   KEEP_OPEN: false
 
 CHATWOOT:
   # If you leave this option as false, when deleting the message for everyone on WhatsApp, it will not be deleted on Chatwoot.
-  MESSAGE_DELETE: true # false | true 
+  MESSAGE_DELETE: true # false | true
   IMPORT:
     # This db connection is used to import messages from whatsapp to chatwoot database
     DATABASE:
@@ -192,5 +197,4 @@ AUTHENTICATION:
     EXPIRIN_IN: 0 # seconds - 3600s === 1h | zero (0) - never expires
     SECRET: L=0YWt]b2w[WF>#>:&E`
 
-
-LANGUAGE: "pt-BR" # pt-BR, en 
+LANGUAGE: "pt-BR" # pt-BR, en

src/validate/validate.schema.ts

@@ -277,6 +277,25 @@ export const audioMessageSchema: JSONSchema7 = {
   required: ['audioMessage', 'number'],
 };
 
+export const templateMessageSchema: JSONSchema7 = {
+  $id: v4(),
+  type: 'object',
+  properties: {
+    number: { ...numberDefinition },
+    options: { ...optionsSchema },
+    templateMessage: {
+      type: 'object',
+      properties: {
+        name: { type: 'string' },
+        language: { type: 'string' },
+      },
+      required: ['name', 'language'],
+      ...isNotEmpty('name', 'language'),
+    },
+  },
+  required: ['templateMessage', 'number'],
+};
+
 export const buttonMessageSchema: JSONSchema7 = {
   $id: v4(),
   type: 'object',

src/whatsapp/controllers/instance.controller.ts

@@ -3,7 +3,7 @@ import { isURL } from 'class-validator';
 import EventEmitter2 from 'eventemitter2';
 import { v4 } from 'uuid';
 
-import { ConfigService, HttpServer } from '../../config/env.config';
+import { ConfigService, HttpServer, WaBusiness } from '../../config/env.config';
 import { Logger } from '../../config/logger.config';
 import { BadRequestException, InternalServerErrorException } from '../../exceptions';
 import { RedisCache } from '../../libs/redis.client';
@@ -12,15 +12,17 @@ import { RepositoryBroker } from '../repository/repository.manager';
 import { AuthService, OldToken } from '../services/auth.service';
 import { CacheService } from '../services/cache.service';
 import { ChatwootService } from '../services/chatwoot.service';
+import { IntegrationService } from '../services/integration.service';
 import { WAMonitoringService } from '../services/monitor.service';
 import { RabbitmqService } from '../services/rabbitmq.service';
 import { SettingsService } from '../services/settings.service';
 import { SqsService } from '../services/sqs.service';
 import { TypebotService } from '../services/typebot.service';
 import { WebhookService } from '../services/webhook.service';
 import { WebsocketService } from '../services/websocket.service';
-import { WAStartupService } from '../services/whatsapp.service';
-import { Events, wa } from '../types/wa.types';
+import { BaileysStartupService } from '../services/whatsapp.baileys.service';
+import { BusinessStartupService } from '../services/whatsapp.business.service';
+import { Events, Integration, wa } from '../types/wa.types';
 
 export class InstanceController {
   constructor(
@@ -36,6 +38,7 @@ export class InstanceController {
     private readonly rabbitmqService: RabbitmqService,
     private readonly sqsService: SqsService,
     private readonly typebotService: TypebotService,
+    private readonly integrationService: IntegrationService,
     private readonly cache: RedisCache,
     private readonly chatwootCache: CacheService,
   ) {}
@@ -50,6 +53,7 @@ export class InstanceController {
     events,
     qrcode,
     number,
+    integration,
     token,
     chatwoot_account_id,
     chatwoot_token,
@@ -87,14 +91,31 @@ export class InstanceController {
       this.logger.verbose('checking duplicate token');
       await this.authService.checkDuplicateToken(token);
 
+      if (!token && integration !== Integration.WHATSAPP_BUSINESS) {
+        throw new BadRequestException('token is required');
+      }
+
       this.logger.verbose('creating instance');
-      const instance = new WAStartupService(
-        this.configService,
-        this.eventEmitter,
-        this.repository,
-        this.cache,
-        this.chatwootCache,
-      );
+      let instance: BaileysStartupService | BusinessStartupService;
+      if (integration === Integration.WHATSAPP_BUSINESS) {
+        instance = new BusinessStartupService(
+          this.configService,
+          this.eventEmitter,
+          this.repository,
+          this.cache,
+          this.chatwootCache,
+        );
+        await this.waMonitor.saveInstance({ integration, instanceName, token, number });
+      } else {
+        instance = new BaileysStartupService(
+          this.configService,
+          this.eventEmitter,
+          this.repository,
+          this.cache,
+          this.chatwootCache,
+        );
+      }
+
       instance.instanceName = instanceName;
 
       const instanceId = v4();
@@ -361,6 +382,23 @@ export class InstanceController {
 
       this.settingsService.create(instance, settings);
 
+      let webhook_wa_business = null,
+        access_token_wa_business = '';
+
+      if (integration === Integration.WHATSAPP_BUSINESS) {
+        if (!number) {
+          throw new BadRequestException('number is required');
+        }
+        const urlServer = this.configService.get<HttpServer>('SERVER').URL;
+        webhook_wa_business = `${urlServer}/webhook/whatsapp/${encodeURIComponent(instance.instanceName)}`;
+        access_token_wa_business = this.configService.get<WaBusiness>('WA_BUSINESS').TOKEN_WEBHOOK;
+      }
+
+      this.integrationService.create(instance, {
+        integration,
+        number,
+        token,
+      });
       if (!chatwoot_account_id || !chatwoot_token || !chatwoot_url) {
         let getQrcode: wa.QrCode;
 
@@ -375,6 +413,9 @@ export class InstanceController {
           instance: {
             instanceName: instance.instanceName,
             instanceId: instanceId,
+            integration: integration,
+            webhook_wa_business,
+            access_token_wa_business,
             status: 'created',
           },
           hash,
@@ -470,6 +511,9 @@ export class InstanceController {
         instance: {
           instanceName: instance.instanceName,
           instanceId: instanceId,
+          integration: integration,
+          webhook_wa_business,
+          access_token_wa_business,
           status: 'created',
         },
         hash,

src/whatsapp/controllers/sendMessage.controller.ts

@@ -14,6 +14,7 @@ import {
   SendReactionDto,
   SendStatusDto,
   SendStickerDto,
+  SendTemplateDto,
   SendTextDto,
 } from '../dto/sendMessage.dto';
 import { WAMonitoringService } from '../services/monitor.service';
@@ -28,6 +29,11 @@ export class SendMessageController {
     return await this.waMonitor.waInstances[instanceName].textMessage(data);
   }
 
+  public async sendTemplate({ instanceName }: InstanceDto, data: SendTemplateDto) {
+    logger.verbose('requested sendList from ' + instanceName + ' instance');
+    return await this.waMonitor.waInstances[instanceName].templateMessage(data);
+  }
+
   public async sendMedia({ instanceName }: InstanceDto, data: SendMediaDto) {
     logger.verbose('requested sendMedia from ' + instanceName + ' instance');
 

src/whatsapp/dto/chat.dto.ts

@@ -31,8 +31,12 @@ export class NumberBusiness {
   message?: string;
   description?: string;
   email?: string;
+  websites?: string[];
   website?: string[];
   address?: string;
+  about?: string;
+  vertical?: string;
+  profilehandle?: string;
 }
 
 export class ProfileNameDto {

src/whatsapp/dto/instance.dto.ts

@@ -3,6 +3,7 @@ export class InstanceDto {
   instanceId?: string;
   qrcode?: boolean;
   number?: string;
+  integration?: string;
   token?: string;
   webhook?: string;
   webhook_by_events?: boolean;

src/whatsapp/dto/integration.dto.ts

@@ -0,0 +1,5 @@
+export class IntegrationDto {
+  integration: string;
+  number: string;
+  token: string;
+}