For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
  • VoxEngine Development
    • VoxEngine concepts
    • Applications
    • Users
    • Scenarios
    • Routing rules
    • Phone numbers
    • Calls and sessions
    • Video calls
    • Management API
    • Account subusers
    • Integrations
    • Firewall
    • Cloud IDE
    • Type declarations
    • VoxEngine CI
    • Working with API requests
    • Working with the Voximplant's API
    • Remote session management
    • Key-value storage
    • Secret storage
    • Custom data
    • Limits and restrictions
    • Scenarios troubleshooting
    • How billing works
  • Management API
    • Overview
    • Developer Basics
    • Authorization
    • Callbacks
    • Child accounts
    • Accessing secure objects
  • Web and Mobile SDKs
    • iOS: CallKit
    • Android: ConnectionService
    • Screen sharing
    • Custom video sources
    • Mobile SDK statistics
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Managing secrets
  • Usage
  • See also
VoxEngine Development

Secret storage

Learn how to use secret storage in Voximplant.
||View as Markdown|
Was this page helpful?
Edit this page
Previous

Key-value storage

Next

Custom data

Built with

Voximplant provides a secret storage for keeping your sensitive data such as passwords, API keys, or tokens and using them in your application.

Managing secrets

To create a secret:

  1. Open your control panel and select a necessary application
  2. Select Secrets in the left menu

Secrets menu

  1. Click the Add secret button and follow the instructions to create a secret

To edit or delete the secret, click the corresponding button in the secret record:

Secret buttons

Management API

You can create, edit, and delete secrets via Management API requests. Use the AddSecret, DelSecret, GetSecrets, GetSecretValue, and SetSecretInfo methods to manage secrets.

Usage

To use a saved secret in your scenario, use the VoxEngine.getSecretValue() method.

Here’s a example on how to get a secret in a scenario:

Getting a secret in a scenario
1VoxEngine.addEventListener(AppEvents.Started, () => {
2 const secretKey = 'test';
3 const secret = VoxEngine.getSecretValue(secretKey);
4 const message = typeof secret === 'undefined' ? 'The secret value is undefined!' : secret;
5 Logger.write(`===> ${message}`);
6 VoxEngine.terminate();
7});

See also

  • Key-Value Storage
  • Custom data