Rate this page:

Your first Voximplant app

If you're here, it means you are ready to create your first Voximplant app and make it work. To achieve that, you have to complete the following steps:

  1. Create an application
  2. Create a scenario inside it
  3. Create a rule and attach it to the scenario
  4. Buy a phone number
  5. Test the app

Application

Let us begin with an application. Go to the Voximplant control panel and log into your account or create a new one. Then choose the application section from the menu in the upper left corner and click New application in the upper right corner or Create at the bottom of page:

This opens the New application editor window where you will set it up and confirm by clicking Create. The new app appears in the application list. To change its name, icon or description, click the three dots menu and select Edit.

With this done, we move to scenario creation.

Scenario

Open your newly created app, select Scenarios on the left menu, and click on the plus icon and give your scenario a name:

This opens a new tab in the online IDE on the right. This is where you write your code. If needed, you can rename the scenario or change the source code later. Also, you can upload changes automatically via the Management API.

Now, give your scenario a name and add some code. Here is an example of what you can write there:

Sample code

Sample code

In this scenario, we will play synthesized speech to a callee using the say method. But we will test it after we create a rule and buy a phone number.

Rule

Let's move to the Rules section. Rules tell the platform which scenarios to execute when a call arrives at the platform or the StartScenarios API method is called. To create a rule, switch to the Routing tab of the application and either click Create in the center of the screen or New rule in the upper right corner:

This will open an editor where you can enter a rule name and select JavaScript scenarios. Name the rule ‘incoming’, for example, and choose the ‘myFirstScenario’ scenario in Assigned Scenarios. Then confirm the rule creation:

Phone number

The last thing we need to test our app is a phone number. You can rent a number from us and set your own CallerID, if you want to (not for test numbers). In this quickstart, we rent a test phone number accessible as an extension. On the Voximplant control panel, select My phone numbers on the left menu and then click Buy new phone number in the upper right corner:

The phone number interface will be displayed. Select Test numbers, then select one or more test numbers and click Buy selected:

After you buy a number, you will immediately see this number in the list. Associate a phone number with your application to execute your JavaScript code and play a voice greeting if the rented phone number is called. To do so, go to Applications, click on the needed application and switch to the Numbers tab. Here, click on the Available tab, select a number, and click Attach. Now you get to pick a routing rule: in this case, it can be the rule you created or all rules:

Test call

Next you can make a call. Dial one of the access numbers displayed on the page and enter the number you bought as an extension when you hear the prompt.

When the connection is established, you will hear a synthesized voice that reads a text – this is the Voximplant cloud that executed your JavaScript code and carried out your instructions. In case of errors, check the Voximplant JavaScript session log for details.

I want to continue

Now you know how to create a basic working app. You can supplement or modify it. To do this, use our guides on how to: