As a prerequisite, you will need to have VICIdial SVN version 3449 or higher and obtain a valid TILTx API key from your Smart Carrier Dashboard. Please note you must have full permissions with your VICIdial administrative login to check your SVN version and complete this integration. If you do not have full permission with your VICIdial administrative login, you will receive a message that you do not have permission to view this page. If you receive this message, please contact your VICIdial system administrator.

We will now outline how to integrate our Call Shaper Module with a VICIdial system in a few short steps. 

Step One: Checking the SVN Trunk Version 

To check your VICIdial SVN trunk version login to your VICIdial admin console and select Admin, and a new menu of admin options will appear below.

Under the Admin menu options, select System Settings. 

At the top of the page, you will see your SVN trunk version. In this example, the SVN version is 3657 which means we meet the minimum requirements of SVN version 3449 or higher and we can therefore move on to step two. If you do not have SVN version 3449 or higher, we will cover how to manually add the call shaper module in another video. Or you will need to complete an SVN trunk upgrade. If you need to complete an SVN trunk upgrade please contact your VICIdial system administrator. 

Step Two: Retrieving a Valid TILTx API Key

To retrieve a valid API key log into your Smart Carrier dashboard here www.app.smartcarrier.io.

Navigate to my account and select API keys. You can click the Copy icon to copy the API Key to your clipboard or click the View key to see your API key. If there is no TILTx API key shown please contact us directly by emailing support@smartcarrier.io.

Step Three: Adding the Settings Container

To add the settings container, from the VICIdial admin console, navigate to Admin and select Settings Containers. 

In the settings containers page, click Add a Settings Container.

In the Container ID field, enter TILTX_SHAKEN_API_KEY into the Settings Container ID field in all caps.

In the Container Notes field enter “TILTx Call Shaper,” or anything you'd like to describe this integration. 

In the container type field select “Other.” 

In the Admin User Group drop-down menu, select “all admin user groups” and press “Submit.” 

You will now be directed to a new page with the message “SETTINGS CONTAINER ADDED,” and a box below marked “Container Entry.” 

Copy and paste the TILTx API Key from the ShakenSwitch portal into the Container Entry Field and press “Submit.” 

You will now see a message on the top of your screen settings container modified displaying your Settings Container ID.

Step Four: Updating the Dial Plan Entry 

From the VICIdial administrative console, navigate to Admin and select Carriers.

On the Carriers page, you will need to update the dialplan entry for the carrier or carrier(s) that you choose to integrate with the TILTx Call Shaper module and the dial plan entry field in the first line of your dial plan. 

When done press the Submit button and a message "carrier modified with the corresponding trunk which has been updated.” 

You have now completed the Call Shaper Module Integration. 

Please see this article to view configurable CLI flags for the AGI script.