Sunbird VA Whatsapp

This Node.js project demonstrates WhatsApp integration for three bots: Parent Sakhi,Teacher Sakhi, and Story bot.

Architecture

Table of Contents

• Features
• Tech stack
• Dependant services
• Prerequisites
• Getting Started
  • configuration
• API Collection
• Telemetry events

Features

• WhatsApp integration with service provider to interact with three bots(Sakhi, Parent, Teacher).
• Bot will respond with Text and Audio message

Tech-stack

• NodeJS
• Whatsapp Business API's (Gupshup)
• Prostgres DB

Dependant services

• Story Sakhi
• Activity Sakhi
• Telemetry Service

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (>v16.0)
• npm/yarn
• Postgres - DB (for session management)
• Gupshup (service provider account)

Getting Started

1. Clone the repository:

git clone https://github.com/DJP-Digital-Jaaduii-Pitara/whatsapp-bot.git
cd whatsapp-bot

2. Install dependencies:

npm install

or

yarn

3. configuration

• Duplicate the .env file & name it to .env.local for local development.
• Update the respective values. refer below

Name	value	Description
PORT	3010	Default value
NODE_ENV	prod	To handle .env file specific to local, prod etc..
LOG_LEVEL	info	for local development user debug & for server instance use info
Bot specific properties
ACTIVITY_SAKHI_URL	-	Activity sakhi bot service internal public endpoint for parent & teacher ex: https://activity-bot-service:7081/api/v1/query
STORY_SAKHI_UTL	-	Story sakhi bot service internal public endpoint https://story-bot-service:7081/api/v1/query
BOT_API_TOKEN	-	BOT API token - If required
Telemetry specific properties
TELEMETRY_SERVICE_URL	-	Telemetry servie internal public endpoint to send telemetry events ex: https://telemetry-service:9000/v1/telemetry
API_TOKEN	-	For telemetry server
APP_ENV	dev	For telemetry server
APP_NAME	ejp	For telemetry server
WhatsApp service provider specific keys
WA_PROVIDER_TOKEN	-	ex: API_TOKEN of the app created in the Whatsapp service provider
WA_PROVIDER_NUMBER	91XXXXXXXXXX	The phone number attached to the app in the WhatsApp service provider
WA_PROVIDER_APPNAME	-	Name of the app created in the Whatsapp service provider
For Postgress DB
POSTGRES_URL	postgres://:@:/<database_name>	Progress DB connection string. ex: postgres://postgress:password@localhost:5432/eJP

sample .env.local file

PORT=3010
LOG_LEVEL=debug
CHAR_LIMIT=1024
ACTIVITY_SAKHI_URL=https://<internal_public_ip>:7081/v1/query
STORY_SAKHI_URL=http://<internal_public_ip>:7081/v1/query
POSTGRES_URL=postgres://postgres:[email protected]:5432/eJP
TELEMETRY_SERVICE_URL=http://<internal_public_ip>:9001/v1/telemetry
APP_ENV=dev
APP_NAME=ejp
WA_PROVIDER_APPNAME=eJPApp
WA_PROVIDER_NUMBER=91xxxxxxxxxx
WA_PROVIDER_TOKEN=<api_token>

Note:
If Postgres is SSL enabled, then to avoid ssl check you can set ?sslmode=no-verify to the POSTGRES_URL .env property (ref)

4. Start the application:

For local development use npm run local

For Production/Live development use npm run start

Note:
To test/verify the application is running after start/deploy, run the below command curl localhost:3010/health
(or)
Use browser to test using public ip
<ip>:3010/health

output : "eJP WhatsApp Bot is runnig v"

API Collection

Postman collection for testing

Build Docker image

• To build Docker image docker build -t whatsappbot:latest .

Gupshup - How to setup

Telemetry events

The sample telemetry events generated by WhatsApp bot service are document below

• Start event
  This event indicates you has started the new/fresh conversation in WhatsApp for the day.

• Feedback event
  This event indicates the user has clicked on Like/Dislike message for the response given by the bot.

• Log event
  This event indicates api calls triggered by the WhatsApp bot service.