Tutorials: SMS Setup

SMS Setup

In this guide we will go over setting up and using Voxtelesys SMS services with VitalPBX. Note that MMS is currently not supported on VitalPBX.

Before we begin you will want to make sure your license supports the SMS integration and the package is added to your PBX. Verify your license with VitalPBX Sales.

To add the SMS package go to Admin > Add-ons > Install SMS

Setting up SMS with Voxtelesys is easy! If you do run into any issues you can reach out to Voxtelesys Support. During the setup you will be working in the Voxtelesys Portal and VitalPBX UI. If possible it is best to have both pages up as you will copy and paste the API Keys, Webhooks, etc.

First thing we will want to do is create the messaging provider in VitalPBX.

PBX > SMS > Messaging Providers

Select Voxtelesys from the drop-down menu and give it a description. Leave this page open as we will need to create and copy the API key from the Voxtelesys Portal.

Voxtelesys Portal: Create API Key

Go to APIs > Keys > Create Key

Make sure you enable the key, give it a name to make it easy to identify and select the Trunk Group.

Use the Copy button to copy your key to your clipboard.

VitalPBX: Create Messaging Application

With the API key copied, go back to VitalPBX and paste it into your Voxtelesys Messaging Provider setup.

Save and reload VitalPBX when you are finished.

Now that the Messaging Provider is built in VitalPBX, we can use the Webhook they generated to create our Messaging Application in the Voxtelesys Portal.

From the Voxtelesys Messaging Provider template on VitalPBX, copy the Webhook URL.

Back at the Voxtelesys Portal let’s start building the Messaging Application.

APIs > Messaging Applications > Create Application

Profile Name: Name your Messaging Application.

Trunk Group: Select your SIP Trunk.

HTTP Method: Select the POST method.

Events: Both

MO Webhook: This is the Webhook URL from VitalPBX.

Save and reload VitalPBX when you are finished.

DR Webhook: This is the Webhook URL from VitalPBX.

DR Type: Set it to "Per recipient"

Authentication: Set it to "None"

Save when you are finished.

Voxtelesys Portal: Assign SMS and Messaging Application to your Numbers

Go to Phone Numbers > Numbers > Find and edit the number you want to SMS enable

Enable SMS

Select your Service Trunk

Select your Messaging Application

Select your Campaign

If you do not have a Campaign you can select “None - Surcharges Apply.” If you have any issues with message delivery, we will be unable to troubleshoot without a campaign approved and assigned. To create a campaign you can do some here: https://portal.voxtelesys.net/sms-campaigns-registry

Save when you are finished.

Almost done! All we need to do now is add the SMS numbers to VitalPBX, this can be down two ways:

On VitalPBX in the Messaging Provider section, click on the "Add Number" button.

Add the number using E164 formatting

On VitalPBX in the Messaging Provider, click on the "Get Numbers from API" button.

Click on the Continue button.

Final Notes

That’s it! SMS integration between Voxtelesys and VitalPBX is now complete. Here are some extra tips:

Tip 1: Make sure the SMS number is Assigned to the user/extension:

Tip 2: Inbound SMS follows your inbound rules.

Tip 3: VitalPBX support SMS in E164 formatting. Make sure the numbers are setup in VitalPBX as E164 and make sure that your Messaging Application and Inbound Trunk on Voxtelesys are both setup as E164.

Tip 4: When this guide was created only VitalPBX Connect app was supported for messaging.

Tip 5: You can check SMS logs on VitalPBX to help troubleshoot your incoming messages. We have SMS logs on our Portal.