Skip to main content

Vonage

note

Currently, only WhatsApp is supported on this channel.

Prerequisite​

  • An HTTPS Endpoint to your bot

    • Set the externalUrl field in botpress.config.json
    • Create an HTTPS tunnel to your machine using Ngrok. Tutorial
    • Using Nginx and Let's Encrypt. Tutorial

  • Create a Vonage Account

  • Create a Vonage Application

    • Give it a name
    • Under Authentication, click Generate public and private key (this will download a file called private.key. You will need this file later on.)
    • Click Generate new application

Steps​

Get your API credentials​

  1. Go to your Account Settings.
  2. Scroll down and copy your API key, API secret and Signature secret from the LIVE credentials section.
  3. Go to your applications and select your newly created application (https://dashboard.nexmo.com/applications/).
  4. Copy the Application ID.

Configure your bot​

  1. Edit data/bots/<YOUR_BOT_ID>/bot.config.json. In the messaging.channels.vonage section write this configuration:

  • enabled: set to true;

  • apiKey: paste your API key;

  • apiSecret: paste your API Secret;

  • signatureSecret: paste your Signature secret;

  • applicationId: paste your Application ID;

  • privateKey: paste the content of the private.key file that was generated when you created your Vonage Application;

    • Paste the full key value, including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- lines;
    • Replace all line breaks with the newline character \n;

  • useTestingApi (optional): set to true if you want to use the Sandbox instead of the Live version of Vonage API (see Setup a Messages Sandbox).

    Your bot.config.json should look like this:

{
  // ... other data
  "messaging": {
    "channels": {
      "vonage": {
        "enabled": true,
        "apiKey": "your_api_key",
        "apiSecret": "your_api_secret",
        "signatureSecret": "your_signature_secret",
        "applicationId": "your_application_id",
        "privateKey": "your_private_key",
        "useTestingApi": false
      }
      // ... other channels can also be configured here
    }
  }
}
  1. Restart Botpress.
  2. You should see your webhook endpoint in the console on startup.

Setup a Messages Sandbox​

When wanting to test the integration with Vonage and WhatsApp, you need to enable a Sandbox where you can send test messages.

  1. In the left end side menu of Vonage Dashboard select Messages and Dispatch (beta)

  2. Click Sandbox.

  3. Click the channel you want to setup and follow the instructions detailed on the page.

  4. Under Webhooks, type the following URLs:

    Inbound: <EXTERNAL_URL>/api/v1/messaging/webhooks/<YOUR_BOT_ID>/vonage/inbound

    Status: <EXTERNAL_URL>/api/v1/messaging/webhooks/<YOUR_BOT_ID>/vonage/status

File Reception​

Vonage currently supports receiving image , audio, video, file , and location.

note

Please, keep in mind that the links coming from the Vonage API are only valid for 10 minutes.

An action (Storage - Store File Locally) is available in order to store the file locally.