Setting up the Voice Elements Platform

From VESupport

Jump to: navigation, search


Install the Voice Elements Platform

The Voice Elements Platform can be installed by downloading and running the Voice Elements Platform installer. Voice Elements and our SIP stack platform (HMP Elements) will be installed as part of the install process along with the Configuration Wizard and the Voice Elements Dashboard application.

During the installation, you may be prompted to install third-party software, such as the Microsoft .NET Framework. These installations will be launched automatically, you should select default options whenever prompted.

After installation is complete, run the Elements Dashboard by selecting it from the Windows Start Menu. The first time the Elements Dashboard is run, you will be prompted to enter your license information. You should have received your license information in your welcome e-mail. If you did not, please e-mail Support. After successfully licensing Voice Elements, the Configuration Wizard will launch automatically. It will walk you through the process of configuring your Voice Elements Platform.

Using the Configuration Wizard

The initial screen of the Configuration Wizard looks like this:


Here you are asked which type of configuration you'd like to use. The first option, Place and Receive Calls Outside, should be selected for production systems, where you intend for your Voice Elements application to communicate with the outside world. The second option, Place and Receive Calls Internally, should be selected if this is a development-only system and you don't plan on it communicating with the outside world. The Configuration Wizard can be re-run from the Elements Dashboard help menu should you desire to change the configuration.

If you select the option to Place and Calls Outside, you will be presented with additional choices:


Each of these options represents a different method of placing calls to the outside world:

SIP Carrier - Select this option if you have a SIP carrier who provides your SIP trunks.

T1 or PRI Carrier - Select this option of you have a traditional carrier which provides T1 or PRI trunking. This option requires that a SIP/PSTN gateway be installed to terminate the T1/PRI trunks and convert them to SIP signaling. Note that this option is also appropriate if you have a legacy PBX on-site and Voice Elements will be communicating to it via a SIP gateway.

Inventive Cloud - Select this option if you would like to use Inventive Labs' Cloud service (formerly know as Telephony Bank). Using this option, your Voice Elements application communicates with Inventive Labs' hosted SIP platform, thus requiring no third-party SIP or T1/PRI provider.

If you select the SIP Carrier option, you will have an additional choice to make, whether to use an existing SIP carrier or Inventive Labs' Instant Carrier service:


Inventive Labs' Instant Carrier service works exactly like a third-party SIP carrier, except that it is provided and maintained by Inventive Labs. Selecting Existing SIP Carrier allows you to use a third-party provider for SIP trunking.

Whichever choice you make, you will be prompted for additional information, such as the IP address of your provider and your external IP address. The Configuration Wizard is intelligent and will automatically populate most of this information for you. For the information which is not automatically configured, there are helpful information dialogs which can be accessed by selecting the "i" button next to the configuration item in question. If you run into questions, please contact Support. Also, when the Configuration Wizard is complete, it will automatically open your default web browser to a Wiki document describing what to do next in order to make your first inbound and outbound test calls.

Please note that for either SIP Carrier choice, a static IP address is generally required for production systems. This is primarily due to the fact that most carriers identify SIP endpoints by IP address (along with authentication). Chances are that if your external IP address changes, the carrier's settings will need to be updated or call attempts will fail. While a dynamic IP address will work correctly initially, if it changes it can lead to call issues which are difficult to track down.

Other Elements Dashboard Features

Uninstall Licenses

You may want to move your Voice Elements Platform license from one server to another. To do this, you will uninstall the license from the existing Voice Elements server. To do this, select "Activate License" from the "Tools" menu in the Elements Dashboard:


In the dialog which opens, enter your license key and click the 'Uninstall' button:


Detailed Configuration Settings

You can fine tune your Voice Elements configuration by accessing the XML configuration files for the Voice Elements and HMP Elements settings. To do so, click either 'Configuration' button to the right of the service you wish to configure:


Use this link for more detailed explanation of the HMP Elements configuration settings. Use this link for an explanation of the Voice Elements configuration settings.

Configure Your Router

You will need to configure your router to route SIP (call control traffic) and RTP (voice traffic) to your computer. You may use this guide HMP Elements - Router Configuration.

Start HMP Elements and Voice Elements

Once your router is configured, you will need to start up HMP Elements and Voice Elements. The preferred order is to start HMP Elements before Voice Elements. You may do this by clicking the "Start" button next to HMP Elements, and the "Start" button next to Voice Elements (as seen in the image below). Once both services show their status as running, you may begin testing your installation.


Test Your Installation using the VE Sampler

The simplest way to test the Voice Elements Platform is to run the Voice Elements Sampler. The Voice Elements Sampler is included with the Voice Elements Platform and can be accessed by clicking the 'Start Sampler' button in the Elements Dashboard:


It contains sample code to showing common telephony applications, such as Inbound IVR, Text-to-Speech, Outbound IVR, Conference, and more.

You can also start the Voice Elements Sampler by selecting it from the "Voice Elements Developer" folder on the Windows Start Menu. The Sampler should automatically detect and connect to your local Voice Elements server, or the Inventive Cloud server in the case where you are using the Inventive Cloud. Once you have connected, you may select from the dropdown different examples to test.

Testing Inbound Calls

If you are using either the Inventive Cloud service or the Inventive Instant Carrier service you are setup for a demo account for the Voice Elements platform. You will be granted 120 minutes of calling time to evaluate our product. You will be able to send outbound calls to any phone number in North America, and will be able to test inbound functionality from any phone in the world.

To do this, you will need to do the following:

  1. Make sure the Voice Elements Platform is up and running (this includes HMP Elements and Voice Elements)
  2. Make sure a Voice Elements Application is up and running. In this case you could use the VE Sampler
  3. Dial 720-428-2910 (Inventive Cloud) or 720-428-2907 (Inventive Instant Carrier) from any phone. The call should connect almost immediately.
  4. Once you are prompted for your access code, enter it in and press #. The call will then be sent to your Voice Elements Platform and should behave just as any other inbound call.

Your access code should be displayed at the top right of the VE Sampler. It will also be included in the e-mail sent to you after you register to demo the product. If you have lost this number, you may E-mail Support.

Test Your Installation using the Elements Dashboard

Follow this guide to place calls using the Elements Dashboard

Using the Elements Dashboard

Please use this link for a detailed guide of using the Elements Dashboard.

Place and Receive Calls

There are a variety of ways that you can configure Voice Elements Platform to both send and receive calls. Below are specific links that describe what you need to do to get connected using the chosen method:

Connect to a third party SIP carrier

Connect to your SIP based PBX or Gateway

Test Voice Elements Platform on your own machine using WebRTC

Connect to the Inventive Labs SIP carrier service

Connect to the Inventive Labs Telephony Bank Service

Getting set up with Inventive Lab's SIP Service

Please use this link for a detailed guide of setting up Voice Elements Platform to work with Inventive Lab's SIP Service

Personal tools