How to receive and process a notification#
Installation#
npm i @green-api/whatsapp-api-client
Import#
There are several ways how to import the library to a project Using standard JavaScript
const whatsAppClient = require("@green-api/whatsapp-api-client");
Using ES6 JavaScript
import whatsAppClient from "@green-api/whatsapp-api-client";
Using TypeScript
 
import * as whatsAppClient from "@green-api/whatsapp-api-client";
How to initialize an object#
Store your authorization data separate from the code. The library allows you to create a file with an arbitrary name and location in the following format:
API_TOKEN_INSTANCE = "MY_API_TOKEN_INSTANCE"
ID_INSTANCE = "MY_ID_INSTANCE"
const restAPI = whatsAppClient.restAPI(({
    credentialsPath: "examples\\credentials"
}))
Examples#
You may see the full example at: StartReceivingNotifications.js
How to receive and process a notification#
import whatsAppClient from '@green-api/whatsapp-api-client'
(async () => {
    let restAPI = whatsAppClient.restAPI(({
        idInstance: process.env.ID_INSTANCE,
        apiTokenInstance: process.env.API_TOKEN_INSTANCE
    }))
    try {
        // receive WhatsApp notifications.
        console.log( "Waiting incoming notifications...")
        await restAPI.webhookService.startReceivingNotifications()
        restAPI.webhookService.onReceivingMessageText((body) => {
            console.log(body)
            restAPI.webhookService.stopReceivingNotifications();
            //console.log("Notifications is about to stop in 5 sec if no messages will be queued...")
        })
        restAPI.webhookService.onReceivingDeviceStatus((body) => {
            console.log(body)
        })
        restAPI.webhookService.onReceivingAccountStatus((body) => {
            console.log(body)
        })
    } catch (ex) {
        console.error(ex.toString())
    }
})();
The full list of examples#
| Description | Module | 
|---|---|
| Example of sending text using Async | SendWhatsAppMessageAsync.js | 
| Example of sending text using Callback | SendWhatsAppMessageCallback.js | 
| Example of sending a picture by URL | SendWhatsAppFileUrl.js | 
| Example of sending a picture by uploading from the disk | SendWhatsAppFileUpload.js | 
| Example of receiving an incoming notification with the receiveNotification method | ReceiveNotifications.js | 
| Example of receiving a webhook endpoint notification on the local machine | SampleReceiveWebhook.js | 
| Example of receiving a webhook endpoint notification on the local machine | SampleReceiveWebhook.js | 
| Example of receiving incoming notifications via webhook service REST API | StartReceivingNotifications.js | 
| Example of receiving incoming notifications to a server | ReceiveWebhook.js | 
| Example of getting a QR code via HTTP | getQRCode.js | 
| Example of getting a QR code via websocket | getQRCodeWebsocket.js |