Vonage

Introduction

Vonage is a communication platform as a service (CPaaS) provider for consumers and businesses that makes it possible for customers to connect and communicate on any device through cloud-hosted voice, video, chat, and short message service (SMS).

library_add_check

Prerequisites

Ensure you have access to your Vonage dashboard.

Configure Vonage as a Custom SMS Connector (Service Provider)

This article will help you set Vonage as a Custom Connector on MoEngage dashboard.

Before proceeding, ensure you have the following parameters for calls to Vonage API (Nexmo). You can find your Key and Secret in Vonage Dashboard. You can also read about Vonage SMS API here.

Parameter	Description
api_key	- Your Key. For example: `api_key=n3xm0rocks`
api_secret	- Your Secret. For example: `api_secret=12ab34cd`

info	Information We've revamped our dashboard settings. This article describes the steps to be followed to configure Infobip as a Custom Connector (Service Provider) in the revamped settings UI and the older UI.

Configure in Revamped UI

Navigate to Settings -> Channel -> SMS -> Sender Configuration.
Click +Add Service Provider at the top right corner.

Add the following details in the Sender Details screen.

Field	Description
Mark as default	Turn on this toggle to mark the sender as the default sender for the service provider being configured. If marked as default, this sender would be used for sending all SMS campaigns from MoEngage unless you select a different sender while creating the campaign.
Service provider name	This field identifies the service provider you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the service provider here.
Sender name	This field identifies the Sender. Type the name of the sender here.
Sender type	The Sender type can either be Promotional or Transactional. Choose the Sender type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users. Choose the Sender type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.

Configure the Webhook by adding the following details

Field	Description
API URL	This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The Vonage URL for Infobip is: https://rest.nexmo.com/sms/json
Method	Select POST as the HTTP method.
URL Parameters	Add the URL Parameters to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, if the API URL call uses the GET method, all the parameters, such as API Key, Authorization, and so on, are passed as URL Parameters.
Headers	Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. Add the Authorization Header.
Body Type	Choose the Body Type as Form and add the following details: You can find your Key and Secret in Vonage Dashboard. In the to field, add Moesms_destination to pass the mobile number of the user. In the text field, add Moesms_message. In the from field, add the sender ID of your account provided by Vonage.

Send a test SMS to verify your configuration.
Click Save to save the Sender Configuration.
You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking for Custom Connectors.

Configure in Old UI

Once you are ready, log in to MoEngage dashboard and follow the steps outlined below:

On the MoEngage Dashboard, navigate to Settings > Channel > SMS & Connector and click on the SMS Connector Config tab.
In Custom Connecters, click CREATE.

Step 1: Set the Connector

Fill in the following details:

Field	Description
Connecter Name	Type the name to identify the Vonage custom connector.
Sender Name	Type the name to identify the Vonage sender.

Step 2: Configure Webhook

Add the Vonage webhook URL . Choose GET or as suggested by Vonage. The following example uses the SMS API of Vonage.

GET Method:

Once you enter your API Request URL, you will be able to see the URL parameters here:

You can find your Key and Secret in Vonage Dashboard.

In to the field, add Moesms_destination to pass the mobile number of the user. In the text field, add Moesms_message, as shown below

Replace From with the sender Id of your account provided by Vonage.

Step 3: Test and save the settings

Do a test SMS to make sure everything is set up correctly. And finally, click Save to save the settings.

Now you are good to proceed with SMS Campaign creation.

Next Steps

Create an SMS campaign using the Getting Started for creating SMS campaign.
Set the Frequency Capping for SMS.
Set the Current Service Provider.
Read more about campaign analytics.