Configure Voximplant

Initial Voximplant Setup

Set up the minimum Voximplant configuration for Voice AI scenarios
View as Markdown

For the complete documentation index, see llms.txt.

VoxEngine setup is centered on three components:

  • Applications: top-level containers for each environment
  • Scenarios: JavaScript programs that control calls
  • Routing rules: destination patterns that trigger scenarios

Basic inbound routing model

For your first project, we recommend configuring one application first, adding one scenario, and attaching a single routing rule that can receive test traffic. you can start by doing this via Voximplant’s Control Panel (manage.voximplant.com) and later use the management API to do this programmatically.

Setup order

Create an account

Use manage.voximplant.com to configure applications, scenarios, routing, channels, and storage.

1

Open manage.voximplant.com

Go to manage.voximplant.com.

2

Sign in or create an account

Sign in with your existing account, or create a new one at Sign up.

3

Verify access

After login, confirm you can access the application list and project navigation.

Sign up for a Voximplant account

Create an application

A Voximplant application is the top-level container for a task or environment. It holds scenarios, users, routing rules, and attached numbers.

1

Open Applications

In Control Panel, open Applications.

2

Create a new application

Click New application (or Create from the empty state). Create an application

3

Name and save the application

Set the application name (for example voice-ai-staging) and create it.

Use different applications for projects that do not share the same Voximplant resources - prod-agent-global vs. new-agent-prototype - or for intentional isolation - such as voice-ai-staging vs. voice-ai-production.

More information:

Create a scenario

Scenarios are JavaScript documents inside an application. VoxEngine executes them when a routing rule matches.

1

Open your application

2

Go to Scenarios

Select Scenarios.

3

Create a scenario

Click the plus button to create a scenario. Create a scenario

4

Name and paste code

Name the scenario and paste your example code.

We recommend that you keep scenario names short and specific since there are situations where you may use this channel name elsewhere (like with SIP routing).

More information:

Setup routing

Routing rules decide which scenario starts for an incoming destination or a manually triggered outbound flow. For example, ^(\+91)\d{10}$ could go to an India-specific voice AI scenario, while ^(\+1)\d{10}$ could go to a US-specific one.

1

Open Routing

Open your application and go to Routing. Create a routing rule

2

Create a rule

Click Create / New rule. Attach scenarios to a routing rule

3

Set rule and pattern

Set a rule name and a destination pattern.

4

Attach scenarios

Attach one or more scenarios in priority order.

5

Save

Save the rule.

For your first rule, we recommend a using .* to matches all destinations. You can create more specific rules later as needed.

Regular Expression pattern basics:

  • .* matches any destination (good as a starting point & fallback)
  • +?[1-9]\d{1,14} matches E.164-style numbers
  • 123.+ matches destinations starting with 123

Routing evaluation is top-to-bottom. The first matching rule is used.

As you get more advanced with more unique situations, you can consider patterns such as:

  • One explicit test rule with a unique alias/pattern
  • One fallback global rule (.*) below it

Voximplant also includes a rule check that will help verify your patterns. Validate routing with rule checker

More information:

Application Storage and Secrets

Voximplant provides two separate stores for every application:

  • Secrets — for sensitive values such as API keys, tokens, and passwords. Use VoxEngine.getSecretValue('<name>') to read them.
  • Application Storage (ApplicationStorage) — a key-value store for small non-sensitive config values like destination numbers, feature flags, and shared counters across scenario instances.

The examples in this guide use Secrets to hold API keys for external services (for example OPENAI_API_KEY) and ApplicationStorage for non-sensitive config.

Application Storage and Secrets in manage.voximplant.com

Example:

Read a secret and a config value
1require(Modules.ApplicationStorage);
2const apiKey = VoxEngine.getSecretValue('OPENAI_API_KEY');
3const calleeDestination = (await ApplicationStorage.get("CALLEE_DESTINATION")).value;

More information: