Skip to main content

Vonage as an inbound channel

Vonage is a cloud communications platform that provides API interfaces that can be used to implement phone numbers, SMS exchange, message exchange in WhatsApp and the Facebook Messenger, as well as calls.

Do the following to use Vonage as an inbound channel:

  1. Set up the service.
  2. Create a channel in JAICP.
  3. Create an application.
  4. Test the bot.

Set up the service​

Sign in to the Vonage service.

Copy the values of the Key and Secret tokens in the Getting started page. You will need these tokens to connect the bot to the channel.

Creating a channel in JAICP​

Go to JAICP and click Channels → Inbound → Connect channel in the dashboard. Select Vonage under Messengers and social networks.

Fill out the following fields:

  • Name — specify a name for the channel or keep the default one.
  • Access token — leave the field blank.
  • Authentication type — select your authentication type.
tip
Bearer Token is the authentication type used to test the service; you can request the token from Vonage. Basic Authorization is used for active connections.

For Basic Authorization:

  • API Key — specify the Key token copied before in the Getting started page of the Vonage service.
  • API Secret — specify the Secret token copied before in the Getting started page of the Vonage service.

For Bearer Token:

  • Bearer Token — specify your Bearer Token.

After filling out authentication fields:

  • Branch — specify the project branch you want to deploy into the channel (master by default). You can also select a Git tag or enter a specific commit hash.
  • Agent — select customer engagement platform or leave this field empty.
  • Deployment — select Automatic (whenever any change made to the project is saved) or Manual (using the Deploy button in the channel description line).
caution
You have to deploy a script before starting the bot. At this stage, the system builds the bot, checks the script syntax, and performs tests. Click Create.

Click  → select Edit channel. You are now in the channel settings.

Copy the Status URL and Inbound URL values: you will need these when you connect your application.

Create an application​

Return to the Vonage service. Click Messages and Dispatch → Create an application on the dashboard.

Fill out the following fields:

  • Application name — specify the name for your application.
  • Status URL — specify the Status URL token copied previously from channel settings.
  • Inbound URL — specify the Inbound URL token copied previously from channel settings.

Click Create application.

Add the numbers in the Numbers page to associate them with the application → click Next. Then associate your external accounts in messengers with the application to use them as your communication channel. Click Done.

Testing a bot​

Open the bot dialog window in the connected messenger and send a welcome/activating phrase to it according to your script. Then a dialog with your bot should start.