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.

Setup

Install the package using npm or yarn:

npm i adonisjs-whatsapp
# or
yarn add adonisjs-whatsapp

Then, configure the package using the configure command:

node ace configure 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_ID: Env.schema.string(),
WABA_TOKEN: Env.schema.string(),
WABA_VERIFY: Env.schema.string(),

Usage

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.

// start/whatsapp.ts

import WhatsApp from '@ioc:Adonis/Addons/WhatsApp'

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

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

// app/Controllers/Http/ExampleController.ts

import WhatsApp from '@ioc:Adonis/Addons/WhatsApp'
import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'

export default class ExampleController {
  public async example(_ctx: HttpContextContract) {
    await WhatsApp.sendText(628123456789, 'Lorem ipsum dolor sit amet.')
  }
}

Features

• [x] Mark messages as read
• [x] Upload media to the WhatsApp server
• [x] Download media from the WhatsApp server
• [x] Send text messages
• [x] Send images
• [x] Send documents
• [x] Send audios
• [x] Send videos
• [x] Send stickers
• [x] Send locations
• [x] Send template messages
• [x] Send contacts
• [x] Send reply button messages
• [x] Send list messages
• [x] Include a Webhook Endpoint 
• [x] Event listener when receiving a webhook

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.