@green-api/whatsapp-bot

WhatsApp chat bot library for nodejs

Introduction

The WhatsApp chat bot designed for writing own chat bots. Users can interact with bots by sending them command messages in private or group chats.

Installation

npm i @green-api/whatsapp-bot

Getting started

1. Get green api account

To use the WhatsApp Bot API, you first have to visit green-api.com and get free developer account. Green Api will give you id instance and api token, something like

ID_INSTANCE: "0000",
API_TOKEN_INSTANCE: "000000000000000000AAAAAAAAAAAAAA"

2. Add import

You can import library using modern ES6 syntax (you have to add "type":"module" to package.json):

import WhatsAppBot from '@green-api/whatsapp-bot'

or using classic syntax:

const WhatsAppBot = require('@green-api/whatsapp-bot')

3. Initiliaze new WhatsApp Bot with aquired account data

const bot = new WhatsAppBot({
    idInstance: "0000",
    apiTokenInstance: "000000000000000000AAAAAAAAAAAAAA"
})

3. Start coding

A WhatsApp bot was inpired by telegram bot framework - Telegraf. But the WhatsApp bot library inherited limited part of Telegraf API. At this moment whatsapp bot can send and receive text, interact with user by telegraf scenes and use sessions. The bot supports only long-polling mode. To understand basics have look at examples below.

Examples

Hello world example responds with a plain text phrase to any users print:

const WhatsAppBot = require('@green-api/whatsapp-bot')

const bot = new WhatsAppBot({
    idInstance: process.env.ID_INSTANCE,
    apiTokenInstance: process.env.API_TOKEN_INSTANCE
})
bot.on('message', (ctx) => ctx.reply('Hello world!'))
bot.launch()

Bot listens for users command beginning with the / symbol

const WhatsAppBot = require('@green-api/whatsapp-bot')

const bot = new WhatsAppBot({
    idInstance: process.env.ID_INSTANCE,
    apiTokenInstance: process.env.API_TOKEN_INSTANCE
})
bot.command('oldschool', (ctx) => ctx.reply('Hello'))
bot.command('modern', ({ reply }) => reply('Yo'))
bot.command('hipster', WhatsAppBot.reply('λ'))
bot.on('message', (ctx) => ctx.reply('Send /oldschool, /modern or /hipster to launch bot'))
bot.launch()

There's some cool examples too.

Documentation

• API reference

License

Licensed on MIT terms. For additional info have look at LICENSE

Third-party libraries

• @green-api/whatsapp-api-client - WhatsApp API client wrapper for green-api.com
• Telegraf - Modern Telegram Bot Framework for Node.js. You shall accept the License