Scenarios

Scenarios in Voximplant are JavaScript documents within a Voximplant application, where you can implement logic processing calls and messages. They define when to answer or make a call, synthesize speech, recognize speech, and more.

To execute a scenario, you need a routing rule. You can execute a scenario automatically, for example, by an incoming call, or manually from the control panel or via the management API.

You can have multiple scenarios in one application.

Open your application, select Scenarios on the left menu, and click on the plus icon to create a new scenario. Give it a name.

This opens a new tab in the online IDE on the right, where you can write your code. If needed, you can rename the scenario or modify the source code later.

You can share a scenario between different applications. To do this, move a scenario you want to share to the Shared folder at the top of the scenarios list:

You can use functions from two scenarios in the same application. To achieve this, you need to add two scenarios to the same routing rule. Afterward, both scenarios will execute in the same space, allowing you to call functions and access variables from both scenarios without the need to import anything.

To execute a scenario, you need to create a routing rule and launch it.

There are several ways to launch a routing rule:

For more information about routing rules, refer to the next article.

Almost every guide in this documentation includes a scenario example along with some SDK code examples. For instance, the voice call and the video call articles provide ready-to-use scenario examples and the code to build a client on Web, iOS, and Android SDKs. Feel free to use the scenario examples in your project.

Every demo client on the Voximplant GitHub includes a fully functional scenario in the Readme.md file. For instance, the Video conference client demo provides a ready-to-use scenario that you can simply copy and paste into your application.

Developers can also get started with scenario development on the Voximplant control panel. The control panel offers ready-to-use scenario templates that can be used to create a simple project of your choice. Feel free to select a suitable template and follow a step-by-step guide to developing an application for your specific purpose.

For those who prefer manual scenario writing, we provide comprehensive scenario API explanations in the VoxEngine section of our API reference. Additionally, we offer scenario code examples with detailed comments in our guides.

If you encounter any difficulties while writing scenarios, our support team is always ready to assist you.

Q: I have several modules imported in my scenario. Do I need to import them to each scenario as well?
A: If you bind all of your scenarios to one routing rule, they execute in one context, that is why you do not need to re-import the modules. It is enough to import them to one of the scenarios.

Q: Can I organize my scenarios into folders?
A: Unfortunately, no. There is a Shared folder for shared ones, and the rest scenarios appear as a list. In the current version of VoxEngine, you cannot organize them into folders.

Q: What is the Shared folder in the scenario list.
A: All the scenarios you add to the Shared folder are available for all applications within your account. To add a scenario to the shared folder, right-click on the scenario and choose Refactoring → Move to Shared.

Q: Do I need to create a separate scenario for processing each type of call, or can I describe the logic in one scenario?
A: It is a best practice to start with one scenario and implement the logic of processing different types of calls within one scenario. You can divide different logic into different scenarios, for example, one scenario sorts and processes incoming calls, and the other scenario processes outgoing calls or call lists.