/twilio-whatsapp-node-api

This node app connector allows you to make your bot available on WhatsApp using the Twilio API for WhatsApp. This guide will take you through the steps of setting up a Twilio WhatsApp sandbox phone number and deploying the connector so it can respond to messages sent using WhatsApp.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

twilio-whatsapp-node-api

This node app connector allows you to make your bot available on WhatsApp using the Twilio API for WhatsApp. This guide will take you through the steps of setting up a Twilio WhatsApp sandbox phone number and deploying the connector so it can respond to messages sent using WhatsApp.

Note that the Twilio API for WhatsApp is currently in Beta and is subject to change before becoming generally available.

Prerequisites

Https

Making the connector available via https is preferred. Ngrok is recommended for this.

Setup instructions

Download, install and start connector

  1. Download or clone the connector source code: 
    git clone https://github.com/mkgareja/twilio-whatsapp-node-api.git
  2. Install dependencies by running the following command in the folder where you stored the source: 
    npm install
  3. Start the connector with the following command (replacing the environment variable with the appropriate value): 
    node server.js

Make the connector available via https

You can make your locally running connector available via https using ngrok as follows:

  1. The connector runs on port 4337 by default, so execute the following command: 
    ngrok http 4337
  2. Running the command above will display a public https URL, copy it, we will use it in the following steps.

Setup a Twilio WhatsApp phone number

  1. Setup a free Twilio account, which comes with free credit money you can spend on buying a number.
  2. Go to the left pane menu and click the Programmable SMS item, then from the submenu choose WhatsApp.
  3. Follow the instructions in the Learn submenu to set up your testing sandbox by sending a specific WhatsApp message provided on the page to the phone number provided on the page.
  4. Next, in the Sandbox submenu add the https URL you copied earlier to the When a message comes in field. Hit save at the bottom of the page.

That's it! Now you can use WhatsApp to interact with your bot!

Running the connector on Heroku

Click the button below to deploy the connector to Heroku:

Deploy

Twilio API for WhatsApp

The Twilio API for Whatsapp is currently in beta. For more details, visit the Twilio website: Twilio API for WhatsApp.