Vonage SMS Integration

Before proceeding, ensure that you have purchased at least one DID on the Vonage platform that supports SMS/MMS.

---

Obtain the Vonage API Key

The PBX uses the Vonage API Key and API Secret to send SMS and MMS messages.

Steps

1. Log in to your Vonage account.

2. Click the Vonage logo in the top-left corner to open the Vonage API Dashboard.

3. Copy and securely record the following values:

   • API Key

   • API Secret

❗Important Treat the API Key and API Secret as sensitive credentials. Do not share them publicly or commit them to source control.

---

Configure SMS with the Vonage Trunk in the PBX

Before configuring SMS/MMS in the PBX, you must have already configured a Vonage SIP trunk using one of the following methods:

• Configuring Vonage Register Based Trunk

• Configuring Vonage IP Based Trunk

---

Sign In to the PBX Web Portal

You can manage SMS/MMS settings at the tenant level using one of the following methods:

• System Administrator

  1. Sign in to the PBX Web Portal as a System Administrator.

  2. Navigate to Tenants.

  3. Select the target tenant and click Manage.

• Tenant Administrator

  • Sign in directly as a Tenant Administrator for the tenant.

❗Reference For more details, see Tenant Management.

---

Add an SMS Configuration in the PBX

Follow the steps below to create an SMS/MMS configuration.

1. In the PBX Web Portal, navigate to SMS/MMS.

2. Click Add.

3. Configure the following fields:

   • Sender ID (Optional) Enter the sender ID used for outbound SMS, if applicable. For more information, see:

     • Global Sender ID Registration Guide

     • Global Sender ID Portal – FAQs

   • Trunk Select your previously configured Vonage SIP trunk.

   • API Key Enter the Vonage API Key obtained earlier.

   • Secret Enter the Vonage API Secret obtained earlier.

1. Click OK to save the configuration.

2. You are redirected to the SMS/MMS list page, and the new SMS configuration is displayed.

---

Copy the PBX SMS Webhook URL

Vonage requires a webhook URL to deliver inbound SMS to the PBX.

You can obtain the webhook URL using either method:

• Select the SMS configuration and click Copy Webhook, or

• Double-click the SMS configuration to open it, then copy the Webhook URL from the details page.

Keep this webhook URL available for the next step.

---

Configure Inbound SMS Webhooks in Vonage

Vonage sends inbound SMS messages to the PBX using the configured webhook URL.

You can configure the webhook at either the account level or the number level.

---

Option 1: Add a Webhook URL at the Account Level

1. Log in to your Vonage account.

2. Navigate to Build & Manage.

3. Under the SMS settings section, configure the following:

   • API: Select SMS API

   • Webhook format: Select POST-JSON

   • Inbound SMS webhooks: Paste the PBX SMS Webhook URL

4. Click Save changes.

---

Option 2: Add a Webhook URL at the Number Level

You can define a unique inbound SMS webhook for a specific number.

❗Important A number-level webhook takes precedence over the account-level webhook.

1. Navigate to Your Numbers.

2. Locate the number you want to configure.

3. Click the pencil icon in the Manage column.

1. In the pop-up configuration window, set the Inbound SMS Webhook URL.

2. Click Save before closing the window.

---

Verify the Configuration

At this point, the Vonage SMS/MMS integration is complete.

You can now create outbound and inbound rules in the PBX to send and receive SMS/MMS messages using the Vonage trunk—just as you would configure rules for outbound and inbound voice calls.