Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api
Plugin to integrate WhatsApp Cloud API on MedusaJS
https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api
ecommerce hacktoberfest medusa-hackathon medusajs plugin whatsapp whatsapp-api
Last synced: 2 months ago
JSON representation
Plugin to integrate WhatsApp Cloud API on MedusaJS
- Host: GitHub
- URL: https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api
- Owner: monkeymars
- Created: 2022-10-16T16:20:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-13T17:07:43.000Z (about 2 years ago)
- Last Synced: 2024-04-26T04:43:43.921Z (8 months ago)
- Topics: ecommerce, hacktoberfest, medusa-hackathon, medusajs, plugin, whatsapp, whatsapp-api
- Language: JavaScript
- Homepage:
- Size: 1.17 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## medusa-plugin-whatsapp-cloud-api
WhatsApp Cloud API / Messaging plugin.
Learn more about how you can use this plugin in the [documentaion](https://docs.medusajs.com/advanced/backend/plugins/overview/).
[](https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api/actions/workflows/node-ci.yml)
[](https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api/actions/workflows/npm-publish.yml)
[](https://github.com/monkeymars/medusa-plugin-whatsapp-cloud-api/actions/workflows/codeql.yml)
## Install Plugin
In the directory of your Medusa server, run the following command to install WhatsApp Cloud API plugin:
#### Yarn or NPM
```bash
npm install --save medusa-plugin-whatsapp-cloud-api
```
```bash
yarn add medusa-plugin-whatsapp-cloud-api
```
## Options
Next, you need to add configurations for **medusa-plugin-whatsapp-cloud-api** plugin.
In **medusa-config.js** add the following at the plugins array:
```js
const plugins = [
{
resolve: `medusa-plugin-whatsapp-cloud-api`,
options: {
accessToken: "",
WABA_ID: "",
senderPhoneNumberId: "",
graphAPIVersion: "",
},
},
];
```
## Dynamic usage
You can resolve the WhatsApp service to dynamically send messages via WhatsApp Cloud API. Example:
#### sendMessageTemplate
```js
router.get("/send-message-sample", async (req, res) => {
const whatsappService = req.scope.resolve("whatsappService");
const response = await whatsappService.sendMessageTemplate({
templateId: "flight_confirmation", // your message templates
recipientPhone: "+6281556750222",
headerMessage: [
{
type: "image",
image: {
link: "https://",
},
},
],
contentMessage: [
{ type: "text", text: "NYC" },
{ type: "text", text: "JFK" },
{
type: "date_time",
date_time: {
fallback_value: "December 24, 2022",
},
},
],
lang: "en_US",
});
res.json({
message: `message sent: ${response.status}`,
});
});
```
#### sendLocation
```js
whatsappService.sendLocation({
name: "GBK Stadium",
address: "Jl. Pintu Satu Senayan, Gelora, Kota Jakarta Pusat, DKI Jakarta",
recipientPhone: "+6281556750222",
latitude: -6.21844,
longitude: 106.8018,
});
```
## Preview: sendMessageTemplate
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
## Resources
- [Overview of plugins in Medusa](https://docs.medusajs.com/advanced/backend/plugins/overview)
- [Create Message Templates for WhatsApp Business Account](https://business.facebook.com/business/help/2055875911147364?id=2129163877102343)
- [WhatsApp Cloud API Messages References](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages)
- [Create Plugin](https://docs.medusajs.com/advanced/backend/plugins/create)