Adding the WhatsApp Channel (via Vonage)
This document provides detailed instructions for adding the WhatsApp Business Messaging channel to your bot via Vonage Messages API.
SentiOne enables you to integrate with the WhatsApp channel via Vonage platform. Vonage is the messaging platform and API that enables easy integration with SMS, MMS, and popular social chat apps, including WhatsApp.
Prerequisites
- Active Vonage account
- Obtained phone number within Vonage Console
- You can buy a virtual phone number in Vonage
- Or transfer your existing phone number to Vonage
Step 1: Connect your WhatsApp account
-
Login to the Vonage portal and navigate to the
External Accounts
section. -
Choose
Set up WhatsApp with Vonage
, read instructions and chooseContinue with Meta
.
- You will be directed to Facebook to set up a WhatsApp Business account. Follow the steps to register and connect your WhatsApp Business account to the Vonage API Platform to chat with WhatsApp users via the WhatsApp Business API. Setup includes:
- Creating new or selecting your Meta and WhatsApp Business Accounts
- Creating or selecting your WhatsApp Business Profile
- Verifying your WhatsApp Business number.
Step 2: Create Vonage Application
A Vonage Application is a set of security and configuration information for connecting External Accounts (like WhatsApp), Numbers, and SentiOne Automate Webhooks to the Vonage API.
- In the Vonage portal navigate to the
Applications
section. - Click on
+ Create a new application
. In the Create App screen:
- Give a friendly identifier to your application [1].
- Generate a public and private key [2]. The private key will be downloaded to your computer.
- Enable
Messages
inCapabilities
section.
- Enable
Enhanced Inbound Media Security
option [1]. - Set
Inbound URL
[2] andStatus URL
[3]. - Remember to
Save
changes.
Inbound URL
andStatus URL
From the version v218 of Automate, those URLs are available in the Application on the channel creation page. Navigate to
Channels
module, click Create and select WhatsApp by Vonage.For versions prior to v218, contact your system administrator to get
Inbound URL
andStatus URL
.
Step 3: Link the Application to Number and WhatsApp social channel
- In the Vonage portal navigate to the
Applications
section and choose the application created in the previous step.
- Use
Link numbers
[1] andLink social channels
[2] tab to link your application with the proper phone number and WhatsApp account (connected in STEP 1).
Step 4: Set API Key settings
- In the Vonage portal navigate to the
API Settings
section:
- Give your API key a friendly name in the
Account name
field [1]. - In
SMS settings
make sure you haveMessages API
enabled [2].
Step 5: Configure the channel and connect the bot in SentiOne Automate
- In the Automate platform navigate to the
Channels
module. - Click on
Create
button and chooseWhatsApp by Vonage
option. In the Create App screen fill the form based on the data from the previous steps:Phone number
- number with international prefix (without+
sign)Api key
- API key from Step 4Api secret
- Account secret (API secret) from Step 4Application id
- Application ID from Step 2Webhooks secret
- Signature secret form Step 4Private key
- copy&pase private key from Step 2.
- Save changes and connect the channel to your bot on the channels list.
Updated over 1 year ago