@brighthustle/adonisjs-whatsapp

What's this

This package makes it easy for developers to access the WhatsApp Cloud API service in the AdonisJS 5 application.

Getting Started

Please create and configure your Facebook WhatsApp application by following the "Get Started" section of the official guide.

For AdonisJS v5 use 1.x branch

Features

• Multiple whatsapp number setup via database
• Generic Webhook for handling all numbers request
• Mark messages as read
• Upload media to the WhatsApp server
• Send text messages
• Send images
• Send documents
• Send audios
• Send videos
• Send stickers
• Send locations
• Send template messages
• Send contacts
• Send reply button messages
• Send list messages
• Include a Webhook Endpoint
• Event listener when receiving a webhook
• Create Template
• Get Templates
• Delete Template
• Download media from the WhatsApp server
• Get Analytics
• Get Phone Numbers, Display Name
• QR Codes Action
• Get Business Account Details & Extended Credit

Table of Contents

• Installation
• Usage
• Events
• Changelog
• License

Installation

Install the package using npm or yarn:

npm i @brighthustle/adonisjs-whatsapp
# or
yarn add @brighthustle/adonisjs-whatsapp

Then, configure the package using the configure command:

node ace configure @brighthustle/adonisjs-whatsapp

After executing the above command, a config/whatsapp.ts file will be created, where you can define the WhatsApp Cloud API.

An important step is to set environment variables in your .env and validate them in the env.ts file.

WABA_PHONE_ID: Env.schema.string(),
WABA_ID: Env.schema.string(),
WABA_TOKEN: Env.schema.string(),
WABA_VERIFY: Env.schema.string(),

Usage

To send text, images, and more, use the same singleton in your preload, controller or service file.

// app/controllers/example_controller.ts

import whatsapp from '@brighthustle/adonisjs-whatsapp/services/main'
import type { HttpContext } from '@adonisjs/core/http'

export default class ExampleController {
  public async example(ctx: HttpContext) {
    await whatsapp.sendText(0000000000, 'Lorem ipsum dolor sit amet.', {}, 1)
  }
}

Note

The last parameter, in this case, 1, is required when the configuration provider is set to lucid. It represents the data ID and is used to associate the message with a specific context when using the Lucid database provider.

Make sure to fetch the parameters from database according to your specific use case and configuration.

Events

The package supports events that are triggered when receiving a webhook from WhatsApp, some of which can be seen here.

The event can be subscribed to via the start/whatsapp.ts file. It have phoneNumberId which can be used to identify the message is sent for which user.

To handle incoming WhatsApp messages in your AdonisJS application, you can subscribe to the message:text and other event using the start/whatsapp.ts file. This event provides a WhatsAppMessageContract object, which contains information about the incoming message.

// start/whatsapp.ts

import whatsapp from '@brighthustle/adonisjs-whatsapp/services/main'
import { WhatsAppMessageContract } from '@brighthustle/adonisjs-whatsapp/types'

whatsapp.on('message:text', function (message: WhatsAppMessageContract) {
  // TODO: do whatever you want

  // Example: Identify the user by phoneNumberId
  const userPhoneNumberId = message.phoneNumberId;
  console.log(`Received a text message for user with phoneNumberId: ${userPhoneNumberId}`);
  // TODO: Add your custom logic to handle the message
})

Changelog

Please see the CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see LICENSE file for more information.

Disclaimer

This package is not officially maintained by Facebook. WhatsApp and Facebook trademarks and logos are the property of Meta Platforms, Inc.

NOTICE

This package is modified from the original package https://github.com//adonisjs-whatsapp Written By : sooluh