Vonage Connector

The Vonage connector lets you send SMS messages through your Vonage account as part of your Descope flows, such as for one-time passwords or notifications. This article covers how to set up and test the connector.

Configuration

To configure the Vonage connector, you'll need your Vonage API credentials and a sender ID or phone number. Go to the Connectors page in the Descope Console, search for Vonage, and select it.

Settings

• Connector name: Custom name for your connector. This will come in handy when creating multiple connectors from the same connector template.
• Connector description: Describe what your connector is used for.
• API Key: Your Vonage API key. To obtain this, go to the Vonage API Dashboard.
• API Secret: Your Vonage API secret, found next to the API key in the Vonage API Dashboard.
• From: The sender ID or number the SMS is sent from. An alphanumeric sender ID is not supported in every country.

The connector's configuration screen in the Console shows the exact IPs your requests originate from, for example:

Requests from this connector will come from the following IPs: 52.210.65.163, 52.209.75.229

See Public Static IPs for the full, region-specific list. For Vonage, allowlist the Project Static IPs for your project's region; messaging connectors do not use the Connector static IPs.

Testing

Before deploying your connector, it's crucial to verify its configuration:

1. Enter a phone number to which the test SMS should be sent.
2. Use the Test button to initiate a test SMS message.

This test ensures that your connector is properly set up and can send SMS messages successfully.

For further assistance or troubleshooting, refer to the Vonage SMS API documentation or contact Descope support.

Using the Connector in Authentication Methods

The Vonage connector can be used to send OTP codes in your authentication methods.

One-time Password (OTP)

1. Navigate to Authentication Methods → One-time Password.
2. In the SMS section, select your configured Vonage connector from the dropdown.
3. Customize your SMS template if needed.

Your OTP SMS will now be sent through Vonage.

Using Vonage Explicitly in Flows

You can also override the default SMS OTP connector inside a specific flow action, to use Vonage for that action regardless of your default connector setting. Open the flow, select the OTP action (or add a new one), and choose Vonage as the connector for that step.

Sending Custom Messages via Vonage in Flows

You can also use the Vonage connector to send a custom SMS message outside of the OTP flow, for example as part of a notification step in a flow.

1. Go to Flows, choose the flow you want to edit, and select + to add a step.
2. Select Connector, then choose Vonage, and place the node in your flow.
3. Double-click the node to configure it:
   • To: The phone number the message should be sent to. We recommend using {{user.phone}}.
   • Message: The content of the SMS message.