https://github.com/codesyncr/adonisjs-whatsapp
The "adonisjs-whatsapp" plugin is a powerful extension for Adonis JS, designed to seamlessly integrate with the WhatsApp Cloud API. This plugin empowers developers to effortlessly incorporate WhatsApp's cloud-based functionalities into their Adonis JS applications. By simplifying the implementation of WhatsApp's API
https://github.com/codesyncr/adonisjs-whatsapp
Last synced: about 1 year ago
JSON representation
The "adonisjs-whatsapp" plugin is a powerful extension for Adonis JS, designed to seamlessly integrate with the WhatsApp Cloud API. This plugin empowers developers to effortlessly incorporate WhatsApp's cloud-based functionalities into their Adonis JS applications. By simplifying the implementation of WhatsApp's API
- Host: GitHub
- URL: https://github.com/codesyncr/adonisjs-whatsapp
- Owner: CodeSyncr
- License: mit
- Created: 2023-09-02T07:12:33.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-24T13:46:27.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T23:02:04.544Z (about 1 year ago)
- Language: TypeScript
- Size: 1.49 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
## What's this
This package makes it easy for developers to access the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api) service in the AdonisJS 5 application.
## Getting Started
Please create and configure your Facebook WhatsApp application by following the ["Get Started"](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started) section of the official guide.
For AdonisJS v5 use 1.x branch
## Features
- [x] Multiple whatsapp number setup via database
- [x] Generic Webhook for handling all numbers request
- [x] Mark messages as read
- [x] Upload media to 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
- [x] Create Template
- [x] Get Templates
- [x] 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](#installation)
- [Usage](#usage)
- [Events](#events)
- [Changelog](#changelog)
- [License](#license)
## Installation
Install the package using npm or yarn:
```bash
npm i @brighthustle/adonisjs-whatsapp
# or
yarn add @brighthustle/adonisjs-whatsapp
```
Then, configure the package using the configure command:
```bash
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.
```ts
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.
```ts
// 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](./adonis-typings/events.ts).
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.
```ts
// 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](./CHANGELOG.md) for more information on what has changed recently.
## License
The MIT License (MIT). Please see [LICENSE](./LICENSE.md) 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