WhatsApp Bot for NodeJs
npm install @green-api/whatsapp-bot
npm i @green-api/whatsapp-bot
`
Getting started
$3
To use the WhatsApp Bot API, you first have to visit green-api.com and get free developer account for API-V0. Green Api will give you id instance and api token, something like
`
ID_INSTANCE: "0000",
API_TOKEN_INSTANCE: "000000000000000000AAAAAAAAAAAAAA"
`
In case you want API-V1 protocol you also have to visit green-api.com and choose Chat bot price option. Green API will give you a free trial period if you ask them. Access token looks like this:
`
token = 'gr.abcdefg...'
`
$3
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
For API-V0 protocol
`
const bot = new WhatsAppBot({
idInstance: "0000",
apiTokenInstance: "000000000000000000AAAAAAAAAAAAAA"
})
`
For API-V1 protocol
`
const bot = new WhatsAppBot(process.env.TOKEN_V1, {apiType: WhatsAppBot.GreenApiV1})
`
$3
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.
$3
Hello world example responds with a plain text phrase to any users print:
`js
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
`js
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()
``