Voximplant

https://voximplant.com/docs
Admin
Voximplant is a serverless platform that enables developers to build real-time communication...
Tokens:1,175,071
Snippets:16,803
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Call a User from an Application

Source: https://voximplant.com/docs/guides/calls/video

Before starting a call, ensure camera and microphone permissions are granted. This example shows how to initiate a call from an application, requiring a matching routing rule on the platform.

```javascript
const Voxe = require('voximplant-sdk');

const client = Voxe.getInstance();

// ... client initialization

const callSettings = {
    // ... call options
};

client.call('destination', callSettings).then((call) => {
    console.log('Call started successfully');
}).catch((error) => {
    console.error('Call failed:', error);
});
```

--------------------------------

### Implement Call Handling Tools

Source: https://voximplant.com/docs/guides/smartqueue/howto

As a minimum setup for a voice calls agent, implement tools to accept or decline a call and change the agent's status. This example shows how to handle incoming calls.

```javascript
const voximplant = Voximplant.getInstance();

// ...

async function answerCall() {
    const call = await voximplant.callApi.call(...);
    // ...
}

async function declineCall() {
    const call = await voximplant.callApi.call(...);
    // ...
}
```

--------------------------------

### GetSipWhiteList example

Source: https://voximplant.com/docs/references/httpapi/sipwhitelist

Gets the SIP white list. Get two networks, but skip the first one.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetSipWhiteList/?account_id=1&offset=1&count=2"
```

--------------------------------

### Install Voximplant Web SDK

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Install the Voximplant Web SDK using npm or yarn.

```bash
npm install @voximplant/websdk --save
# OR
yarn add @voximplant/websdk
```

--------------------------------

### SQ_GetQueues example

Source: https://voximplant.com/docs/references/httpapi/smartqueue

Get all the queues.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/SQ_GetQueues/?account_id=1&application_id=1&sq_queue_id=1;2"
```

--------------------------------

### Get Keys Example

Source: https://voximplant.com/docs/references/httpapi/rolesystem

Retrieves information about API keys for a specified account. Supports filtering by key ID and pagination with count and offset parameters. An option to include roles with the key info is available.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetKeys/?account_id=1"
```

--------------------------------

### start()

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vibroadcast/start%28%29

Starts the broadcast.

```objc
@objc
func start()

```

--------------------------------

### Example Incoming SIP Connection

Source: https://voximplant.com/docs/guides/integrations/dasha

Example of connecting a SIP trunk with Dasha for incoming calls.

```bash
dasha sip create-incoming --application-name exampleApp vox_incoming

```

--------------------------------

### GetRecordStorages example

Source: https://voximplant.com/docs/references/httpapi/recordstorages

Get all record storages.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetRecordStorages/?account_id=1"
```

--------------------------------

### Install the SDK

Source: https://voximplant.com/docs/getting-started/platform/react-native

To install the Voximplant SDK for React Native, execute the following command:

```bash
npm install react-native-voximplant --save
```

```bash
yarn add react-native-voximplant
```

--------------------------------

### Example backend function Ruby

Source: https://voximplant.com/docs/guides/sdk/authorization-onetimekey

Example of how to calculate the token in Ruby.

```ruby
require 'digest/md5'
concat Digest::MD5.hexdigest(request.POST['key']+'|'+Digest::MD5.hexdigest(myuser+":voximplant.com:"+mypass))
```

--------------------------------

### UpdateSipRegistration example

Source: https://voximplant.com/docs/references/httpapi/sipregistration

This example shows how to update a SIP registration using the platform API.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/UpdateSipRegistration/?account_id=1&sip_registration_id=1&sip_username=HedyLamarr&outbound_proxy=12&password=123456"
```

--------------------------------

### Example backend function PHP

Source: https://voximplant.com/docs/guides/sdk/authorization-onetimekey

Example of how to calculate the token in PHP.

```php
echo md5($_REQUEST['key'].'|'.md5($myuser.':voximplant.com:'.$mypass));
```

--------------------------------

### Example backend function Node.js

Source: https://voximplant.com/docs/guides/sdk/authorization-onetimekey

Example of how to calculate the token in Node.js.

```javascript
const app = express();

let md5 = crypto.createHash('md5');

app.use(bodyParser.urlencoded({ extended: false }));

app.post('/', cors(), (req, res) => {
  res.writeHead(200, { 'Content-Type': 'text/plain' });
  const hash = md5
    .update(`${req.body.appUser}:voximplant.com:${req.body.appUserPassword}`)
    .digest('hex');
  md5 = crypto.createHash('md5');
  const token = md5.update(`${req.body.key}\|${hash}`).digest('hex');
  res.end(token);
});

```

--------------------------------

### Initializer

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vicustomvideosource/init%28forbroadcast%3Aframesize%3A%29

Creates a custom video source instance.

```swift
@objc
init(
    forBroadcast: Bool,
    frameSize: CGSize = .zero
)
```

--------------------------------

### node

Source: https://voximplant.com/docs/references/reactnative/voximplant/connectoptions

Specifies the Voximplant account node. More information can be found in the getting started guide.

```typescript
node:
ConnectionNode
```

--------------------------------

### init

Source: https://voximplant.com/docs/references/websdk-v5/core/core

Initializes the SDK and returns an instance. If the SDK is already initialized, it returns the existing instance.

```APIDOC
## init

### Description
Initializes the SDK and returns an instance. If the SDK is already initialized, returns the previously created instance without applying the new options.

### Method
Static

### Parameters
#### options
- **options** (CoreInitOptions) - Optional - Initialization options

### Returns
- **Core** - The Core SDK instance.
```

--------------------------------

### GetSmsHistory example

Source: https://voximplant.com/docs/references/httpapi/sms

Get messages that had been sent to number 12345678222 starting from March 1, 2019. Number of resulting rows is limited to 2.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetSmsHistory/?account_id=5&destination_number=12345678222&row_limit=2&from_date=2019-03-01%2000%3A00%3A00"
```

--------------------------------

### GetSipRegistrations example

Source: https://voximplant.com/docs/references/httpapi/sipregistration

Example of how to retrieve all active SIP registrations using the HTTP API.

```bash
curl -H "token.sh" "https://api.voximplant.com/platform_api/GetSipRegistrations/?account_id=1"
```

--------------------------------

### Initializer

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vicallsettings/init%28localvideostream%3Areceivevideo%3Acustomdata%3Aextraheaders%3Astatscollectioninterval%3Apreferredvideocodec%3Acallkitsupport%3A%29

Creates the call settings.

```swift
@objc
init(
    localVideoStream: VILocalVideoStream? = nil,
    receiveVideo: Bool = false,
    customData: String? = nil,
    extraHeaders: [String : String]? = nil,
    statsCollectionInterval: TimeInterval = 0,
    preferredVideoCodec: VIVideoCodec = .auto,
    callKitSupport: Bool = false
)
```

--------------------------------

### A2PGetSmsHistory example

Source: https://voximplant.com/docs/references/httpapi/sms

Get messages that had been sent to number 12345678222 starting from March 1, 2019. Number of resulting rows is limited to 2.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/A2PGetSmsHistory/?account_id=5&destination_number=12345678222&row_limit=2&from_date=2019-03-01%2000%3A00%3A00"
```

--------------------------------

### SQ_GetAgentCustomStatusMapping example

Source: https://voximplant.com/docs/references/httpapi/smartqueue

Example for getting agent custom status mapping.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/SQ_GetAgentCustomStatusMapping/?account_id=5&application_id=1"
```

--------------------------------

### GetHistoryReports example

Source: https://voximplant.com/docs/references/httpapi/history

This example shows how to get all history reports using the GetHistoryReports method.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetHistoryReports/?account_id=1&history_type=all"
```

--------------------------------

### Example Outgoing SIP Connection

Source: https://voximplant.com/docs/guides/integrations/dasha

Example of connecting a SIP trunk with Dasha for outgoing calls.

```bash
dasha sip create-outgoing --server exampleApp.exampleAcc.n4.voximplant.com --account exampleUsername --ask-password vox_outgoing
password: enter_your_password_here

```

--------------------------------

### ReorderRules example

Source: https://voximplant.com/docs/references/httpapi/rules

This example shows how to reorder rules by providing a semicolon-separated list of rule IDs.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/ReorderRules/?account_id=1&rule_id=1%3B7%3B3"
```

--------------------------------

### Logger example

Source: https://voximplant.com/docs/guides/troubleshooting/scenarios

An example of how to use the built-in Logger.write() method to debug scenarios.

```voxengine
Logger.write("User ID: " + userId + ", Call ID: " + callId);
```

--------------------------------

### Example backend function Java(Spring)

Source: https://voximplant.com/docs/guides/sdk/authorization-onetimekey

Example of how to calculate the token in Java (Spring).

```java
@RestController
@EnableAutoConfiguration
public class StartPoint {

private static final String login = "";
    private static final String pass = "";
    private static final String HASH;

static {
        HASH = DigestUtils.md5DigestAsHex((login + ":voximplant.com:" + pass).getBytes());
    }

@RequestMapping("/hash/{login}")
    public String getHash(@PathVariable String login) {
        String key = login + "|" + HASH;
        return DigestUtils.md5DigestAsHex(key.getBytes());
    }

public static void main(String[] args) {
        SpringApplication.run(StartPoint.class, args);
    }
}

```

--------------------------------

### GetCountries example

Source: https://voximplant.com/docs/references/httpapi/regulationaddress

Get Germany.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetCountries/?account_id=1&country_code=DE"
```

--------------------------------

### Add Subuser Example

Source: https://voximplant.com/docs/references/httpapi/rolesystem

Creates a new subuser for a specified account. Requires the new subuser's name and password. Optional parameters include description and role assignments.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/AddSubUser/?account_id=1&new_subuser_name=John_McClane&new_subuser_password=pssw0rd"
```

--------------------------------

### Connect and Log in with One-Time Key (v4 vs v5)

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Illustrates the differences in connecting and logging in using a one-time key between v4 and v5. The v5 approach simplifies the process and uses promises for asynchronous operations.

```javascript
const username = `username@$app.account.voximplant.com`;

const sdk = VoxImplant.getInstance();
await sdk.init({
  node: ACCOUNT_NODE
});

// Connect to the cloud and request a key
await sdk.connect()
sdk.requestOneTimeLoginKey(username);

// Listen to the server response
sdk.addEventListener(VoxImplant.Events.AuthResult, async (e) => {
  if (e.result) {
    // Login is successful
  } else if (e.code == 302) {
    const { key } = e;
    // IMPORTANT: You should always calculate the token on your backend!
    const hashRequest = await fetch('https://your.backend.com/', {
      method: 'POST',
      body: JSON.stringify({
        username,
        key,
      }),
    });

    const hash = await hashRequest.json();
    sdk.loginWithOneTimeKey(username, token);
  }
});
```

```javascript
import { Core } from '@voximplant/websdk';

const core = Core.init({});
const { client } = core;
const ACCOUNT_NODE = ConnectionNode.${NODE_n};
const username = "username@app.account.voximplant.com";

await client.connect({
  node: ACCOUNT_NODE,
});
const key = await client.requestOneTimeKey({
  username,
});

// IMPORTANT: You should always calculate the token on your backend!
const hashRequest = await fetch('https://your.backend.com/', {
  method: 'POST',
  body: JSON.stringify({
    username,
    key,
  }),
});

const hash = await hashRequest.json();

const loginData = await client.loginOneTimeKey({
  username,
  hash,
});
```

--------------------------------

### GetDialogflowKeys example

Source: https://voximplant.com/docs/references/httpapi/dialogflowcredentials

Gets Dialogflow keys.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetDialogflowKeys/?account_id=1&dialogflow_key_id=1"
```

--------------------------------

### Initializer

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/viconferencesettings/init%28localvideostream%3Amuteaudio%3Acustomdata%3Aextraheaders%3Astatscollectioninterval%3Apreferredvideocodec%3A%29

Creates the conference settings.

```objc
@objc
init(
    localVideoStream: VILocalVideoStream? = nil,
    muteAudio: Bool = false,
    customData: String? = nil,
    extraHeaders: [String : String]? = nil,
    statsCollectionInterval: TimeInterval = 0,
    preferredVideoCodec: VIVideoCodec = .auto
)
```

--------------------------------

### Video Recording Example

Source: https://voximplant.com/docs/references/voxengine/callrecordparameters

Enable video recording by setting the 'video' parameter to true. The default is false.

```javascript
video: 
false
 |
undefined
 |
true
```

--------------------------------

### SQ_GetAgents example

Source: https://voximplant.com/docs/references/httpapi/smartqueue

Get all agents with their current statuses.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/SQ_GetAgents/?account_id=1&application_id=1&with_sq_statuses=true&handle_calls=false"
```

--------------------------------

### Show Local Preview (v5)

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Illustrates the v5 approach for showing local video. This involves enabling the device tracker, starting the video preview, creating a video renderer, and manually appending the renderer's element to a DOM container.

```javascript
const streamModule = core.getModule(streamToken);
const deviceTracker = streamModule.createHelper(StreamHelper.DeviceTracker);
deviceTracker.enableTracker();
await deviceTracker.startPreviewVideo();

const stream = deviceTracker.previewVideoStream.value;
const renderer = streamModule.rendererManager.createVideoRenderer(stream);
const videoElement = renderer.getElement();
// mount videoElement to any DOM element
document.getElementById('local_video_holder')?.appendChild(videoElement);

```

--------------------------------

### GetSecretValue example

Source: https://voximplant.com/docs/references/httpapi/secrets

Get the value of secret 10.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetSecretValue/?account_id=1&application_id=1&secret_id=10"
```

--------------------------------

### Create a Voximplant Client Instance (Objective-C)

Source: https://voximplant.com/docs/getting-started/platform/ios

Import the VoximplantSDK and create an instance of VIClient. This is the first step to using the SDK.

```objectivec
#import <VoximplantSDK/VoximplantSDK.h>

@interface AppDelegate ()
@property (nonatomic, strong) VIClient *voximplantClient;
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    self.voximplantClient = [VIClient shared];
    return YES;
}
```

--------------------------------

### GetSecrets example

Source: https://voximplant.com/docs/references/httpapi/secrets

Get secrets of application 1.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetSecrets/?account_id=1&application_id=1&count=2"
```

--------------------------------

### Create a Voximplant Client Instance (Swift)

Source: https://voximplant.com/docs/getting-started/platform/ios

Import the VoximplantSDK and create an instance of VIClient. This is the first step to using the SDK.

```swift
import VoximplantSDK

let Voximplant = VIClient.shared
```

--------------------------------

### GetRegions example

Source: https://voximplant.com/docs/references/httpapi/regulationaddress

Get regions with city AACHEN.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetRegions/?account_id=1&country_code=DE&phone_category_name=GEOGRAPHIC&city_name=AACHEN"
```

--------------------------------

### Initializer

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vilocalvideostream/init%28videosource%3A%29

Creates the local video stream instance with the provided video source.

```swift
@objc
init?(videoSource: VILocalVideoSource)
```

--------------------------------

### Connect and Log In to Voximplant Cloud (Objective-C)

Source: https://voximplant.com/docs/getting-started/platform/ios

Implement the VIClientSessionDelegate protocol, create a client instance, and call connect. Log in using a password or a one-time key in the clientSessionDidConnect callback.

```objectivec
#import <VoximplantSDK/VoximplantSDK.h>

@interface CallManager : NSObject <VIClientSessionDelegate>
@property (nonatomic, strong) VIClient *voximplantClient;
@end

@implementation CallManager

- (instancetype)init {
    self = [super init];
    if (self) {
        self.voximplantClient = [VIClient shared];
        self.voximplantClient.sessionDelegate = self;
    }
    return self;
}

- (void)connect {
    [self.voximplantClient connect];
}

- (void)clientSessionDidConnect:(VIClientSession *)clientSession {
    // Log in using a password
    [self.voximplantClient login:password];
    // Or log in using a one-time key
    // [self.voximplantClient login:oneTimeKey];
}

- (void)clientSession:(VIClientSession *)clientSession didFailConnectWithError:(NSError *)error {
    // Handle connection error
}

- (void)clientSessionDidDisconnect:(VIClientSession *)clientSession {
    // Handle disconnection
}
```

--------------------------------

### SQ_GetSkills example

Source: https://voximplant.com/docs/references/httpapi/smartqueue

Get the skills with id 2 and 4

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/SQ_GetSkills/?account_id=1&application_id=1&sq_skill_id=2;4"
```

--------------------------------

### Initialize SDK

Source: https://voximplant.com/docs/references/websdk-v5/core/core

Initializes the SDK and returns an instance. If already initialized, returns the existing instance.

```typescript
init(options: 
CoreInitOptions
): 
Core

```

--------------------------------

### GetUsers example

Source: https://voximplant.com/docs/references/httpapi/managing_users

Get two first identities.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetUsers/?account_id=1&application_id=1&count=2"
```

--------------------------------

### Get Account Invoices

Source: https://voximplant.com/docs/references/httpapi/invoices

Example of how to retrieve all invoices for a specified account.

```bash
curl -H "token.sh" "https://api.voximplant.com/platform_api/GetAccountInvoices/?account_id=1"
```

--------------------------------

### Get HTMLVideoElement and Play Video

Source: https://voximplant.com/docs/references/websdk-v5/stream/videorenderer

Returns the HTMLVideoElement object and starts playing the video stream.

```typescript
getElement(): 
HTMLVideoElement
```

--------------------------------

### Create Key Example

Source: https://voximplant.com/docs/references/httpapi/rolesystem

Creates a public/private key pair for an account. Optionally, roles can be assigned to the key during creation. The key name is limited to 50 characters.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/CreateKey/?account_id=1"
```

--------------------------------

### GetRules example

Source: https://voximplant.com/docs/references/httpapi/rules

Get the first rule for the template 74951234567.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetRules/?account_id=1&application_id=1&template=74951234567&with_scenarios=true&count=1"
```

--------------------------------

### Initializer Signature

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vivideorendererview/init%28videostream%3Aresizemode%3Acontent%3A%29

Creates a video renderer for a video stream.

```swift
@MainActor
init(
    videoStream: VIVideoStream,
    resizeMode: VIVideoResizeMode,
    @ViewBuilder content: @escaping (VIRendererState) -> Content
)
```

--------------------------------

### GetCallLists example

Source: https://voximplant.com/docs/references/httpapi/calllists

Get all call lists for the specified user.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetCallLists/?account_id=1"
```

--------------------------------

### Video Parameters Example

Source: https://voximplant.com/docs/references/voxengine/callrecordparameters

Configure specific video recording parameters using 'videoParameters'.

```javascript
videoParameters: 
RecorderVideoParameters
```

--------------------------------

### Initialize the SDK

Source: https://voximplant.com/docs/getting-started/platform/react-native

First, import the Voximplant package and obtain a client instance using the getInstance method:

```javascript
import Voximplant from 'react-native-voximplant';
```

--------------------------------

### Get started with Flutter SDK for Android

Source: https://voximplant.com/docs/getting-started/platform/flutter

Lines to add to the android/app/build.gradle file for Android.

```gradle
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

```

--------------------------------

### Create an MCP client and interact with tools

Source: https://voximplant.com/docs/guides/voxengine/mcp

This VoxEngine scenario demonstrates how to create an MCP client, list available tools, call a specific tool, and handle responses. Ensure the Modules.MCP module is required.

```voxengine
const mcpClient = MCP.createClient({
    url: "wss://mcp.example.com/ws",
    username: "user",
    password: "password"
});

mcpClient.on(MCP.ServerEvents.Ready, () => {
    console.log("MCP client is ready");

    // List available tools
    mcpClient.listTools().then(tools => {
        console.log("Available tools:", tools);

        // Call a specific tool
        if (tools.length > 0) {
            const toolName = tools[0].name;
            mcpClient.callTool(toolName, {
                // tool parameters
            }).then(result => {
                console.log(`Tool ${toolName} result:`, result);
            }).catch(error => {
                console.error(`Error calling tool ${toolName}:`, error);
            });
        }
    }).catch(error => {
        console.error("Error listing tools:", error);
    });
});

mcpClient.on(MCP.ServerEvents.Error, (error) => {
    console.error("MCP client error:", error);
});

mcpClient.on(MCP.ServerEvents.Close, () => {
    console.log("MCP client closed");
});

mcpClient.connect();
```

--------------------------------

### Get started with Flutter SDK for iOS

Source: https://voximplant.com/docs/getting-started/platform/flutter

Entries to add to your Info.plist file for iOS.

```xml
<key>NSMicrophoneUsageDescription</key>
<string>Microphone is required to make voice calls</string>
<key>NSCameraUsageDescription</key>
<string>Camera is required to make video calls</string>

```

--------------------------------

### SetRuleInfo example

Source: https://voximplant.com/docs/references/httpapi/rules

This example demonstrates how to edit a rule, specifically setting it to deny all by using exclude patterns.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/SetRuleInfo/?account_id=1&rule_id=1&rule_name=denyall&rule_pattern_exclude=.*"
```

--------------------------------

### Get HTMLAudioElement and Start Playback

Source: https://voximplant.com/docs/references/websdk-v5/stream/audiorenderer

Retrieves the underlying HTMLAudioElement and initiates audio playback. This method returns the HTMLAudioElement.

```typescript
getElement(): 
HTMLAudioElement
```

--------------------------------

### Complete Voximplant Scenario with ElevenLabs Agents Client

Source: https://voximplant.com/docs/voice-ai/elevenlabs/agents-client

This example demonstrates a full Voximplant scenario for integrating ElevenLabs conversational AI. It includes module requirements, client creation, and basic event handling. Ensure you have the necessary ElevenLabs API key and other parameters configured.

```voxengine
const VoxEngine = require('voxengine');
const Modules = VoxEngine.loadModules();

const elevenLabsClient = Modules.ElevenLabs.createAgentsClient({
    apiKey: 'YOUR_ELEVENLABS_API_KEY',
    // Optional: specify a custom ElevenLabs compatible backend url
    // baseUrl: 'YOUR_CUSTOM_ELEVENLABS_BACKEND_URL',
    // Optional: specify custom conversation initiation data
    // conversationInitiationClientData: {
    //     // ... your custom data ...
    // },
    // Optional: specify custom audio settings for the bot
    // botAudioSettings: {
    //     // ... your custom audio settings ...
    // },
    // Optional: specify custom LLM settings
    // llmSettings: {
    //     // ... your custom LLM settings ...
    // },
    // Optional: specify custom TTS settings
    // ttsSettings: {
    //     // ... your custom TTS settings ...
    // },
    // Optional: specify custom ASR settings
    // asrSettings: {
    //     // ... your custom ASR settings ...
    // },
    // Optional: specify custom turn talking settings
    // turnTalkingSettings: {
    //     // ... your custom turn talking settings ...
    // },
    // Optional: specify custom agent settings
    // agentSettings: {
    //     // ... your custom agent settings ...
    // },
    // Optional: specify custom webhook settings
    // webhookSettings: {
    //     // ... your custom webhook settings ...
    // },
    // Optional: specify custom streaming settings
    // streamingSettings: {
    //     // ... your custom streaming settings ...
    // },
    // Optional: specify custom logging settings
    // loggingSettings: {
    //     // ... your custom logging settings ...
    // },
    // Optional: specify custom error handling settings
    // errorHandlingSettings: {
    //     // ... your custom error handling settings ...
    // },
    // Optional: specify custom security settings
    // securitySettings: {
    //     // ... your custom security settings ...
    // },
    // Optional: specify custom performance settings
    // performanceSettings: {
    //     // ... your custom performance settings ...
    // },
    // Optional: specify custom advanced settings
    // advancedSettings: {
    //     // ... your custom advanced settings ...
    // }
});

VoxEngine.ready(() => {
    const call = VoxEngine.callPstn('YOUR_PHONE_NUMBER');

    call.on(VoxEngine.CallEvents.Connected, () => {
        // Start sending media between the call and the ElevenLabs client
        VoxEngine.sendMediaBetween(call, elevenLabsClient);
    });

    call.on(VoxEngine.CallEvents.Disconnected, () => {
        // Clean up resources if necessary
        elevenLabsClient.destroy();
    });

    // Handle events from the ElevenLabs client
    elevenLabsClient.on(Modules.ElevenLabs.AgentsClientEvents.Message, (message) => {
        console.log('ElevenLabs message:', message);
        // Implement your application's business logic based on the message
    });

    elevenLabsClient.on(Modules.ElevenLabs.AgentsClientEvents.Error, (error) => {
        console.error('ElevenLabs error:', error);
        // Implement your error handling logic
    });
});

```

--------------------------------

### GetAuditLogAsync example

Source: https://voximplant.com/docs/references/httpapi/history

Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetAuditLogAsync/?account_id=1&from_date=2018-02-01%2000%3A00%3A00&to_date=2018-03-01%2000%3A00%3A00&filtered_cmd=BindSkill%3BAddSkill%3BDelSkill&advanced_filters=152&output=csv"
```

--------------------------------

### startProcessing

Source: https://voximplant.com/docs/references/websdk-v5/stream/audioprocessor

Starts processing audio in the provided local audio stream.

```APIDOC
## startProcessing

### Description
Starts processing audio in the provided local audio stream.

### Method
```
startProcessing(streamToProcess: LocalStream): Promise<LocalStream>
```

### Parameters
#### Path Parameters
- **streamToProcess** (LocalStream) - Required - Local audio stream to process.

### Returns
#### Success Response
- **type**: Promise<LocalStream>
```

--------------------------------

### CoreInitOptions

Source: https://voximplant.com/docs/references/websdk-v5/core/coreinitoptions

Represents the options used for initializing the SDK's core functionalities. It includes optional parameters for configuration.

```APIDOC
## CoreInitOptions

### Description
SDK initialization options.

### Props

- **logger** (LoggerOptions) - Optional - Logger options.
```

--------------------------------

### GetAuditLog example

Source: https://voximplant.com/docs/references/httpapi/history

Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetAuditLog/?account_id=1&from_date=2018-02-01%2000%3A00%3A00&to_date=2018-03-01%2000%3A00%3A00&filtered_cmd=BindSkill%3BAddSkill%3BDelSkill&advanced_filters=152&count=3"
```

--------------------------------

### GetCallListDetails example

Source: https://voximplant.com/docs/references/httpapi/calllists

Gets details of the specified call list. Returns a CSV file by default.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetCallListDetails/?account_id=1&list_id=1&output=json"
```

--------------------------------

### A2P Get SMS History Request

Source: https://voximplant.com/docs/references/voxengine/voximplantapi/a2pgetsmshistoryrequest

The A2P Get SMS History Request is used to retrieve a list of A2P SMS transactions. It allows filtering by various parameters such as start date, end date, phone number, and transaction status.

```APIDOC
## A2P Get SMS History Request

### Description
Retrieves a history of A2P SMS transactions.

### Method
GET

### Endpoint
`/a2p/getSmsHistory`

### Query Parameters
- **_from** (date) - Optional - The start date for the history search in the format YYYY-MM-DD.
- **_to** (date) - Optional - The end date for the history search in the format YYYY-MM-DD.
- **phone_number** (string) - Optional - Filters history by a specific phone number.
- **count** (int) - Optional - The maximum number of records to return. Default is 100.
- **offset** (int) - Optional - The number of records to skip. Default is 0.
- **transaction_state** (string) - Optional - Filters history by transaction state. Possible values: `delivered`, `failed`, `sent`, `undelivered`.

### Response
#### Success Response (200)
Returns a JSON object containing a list of `SmsTransaction` objects and the total count of transactions.

- **transactions** (array) - A list of `SmsTransaction` objects.
- **total_count** (int) - The total number of transactions found.

### Response Example
```json
{
  "transactions": [
    {
      "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
      "source_phone_number": "+12345678900",
      "destination_phone_number": "+10987654321",
      "created_at": "2023-10-27 10:00:00",
      "sent_at": "2023-10-27 10:01:00",
      "delivered_at": "2023-10-27 10:05:00",
      "transaction_state": "delivered",
      "error_message": null,
      "price": 0.01,
      "currency": "USD",
      "campaign_id": "campaign_abc",
      "user_id": 12345,
      "application_id": 67890
    }
  ],
  "total_count": 1
}
```
```

--------------------------------

### Request SmartQueue History

Source: https://voximplant.com/docs/references/voxengine/voximplantapi/smartqueueinterface

Gets the historical data for a specified SmartQueue. Consult the SmartQueue reporting guide for a comprehensive understanding of the history data.

```typescript
requestSmartQueueHistory: 
(request: RequestSmartQueueHistoryRequest) => Promise<RequestSmartQueueHistoryResponse>
```

--------------------------------

### Connect and Log In to Voximplant Cloud (Swift)

Source: https://voximplant.com/docs/getting-started/platform/ios

Implement the VIClientSessionDelegate protocol, create a client instance, and call connect. Log in using a password or a one-time key in the clientSessionDidConnect callback.

```swift
import VoximplantSDK

class CallManager: NSObject, VIClientSessionDelegate {
    let Voximplant = VIClient.shared

    override init() {
        super.init()
        Voximplant.sessionDelegate = self
    }

    func connect() {
        Voximplant.connect()
    }

    func clientSessionDidConnect(_ clientSession: VIClientSession) {
        // Log in using a password
        Voximplant.login("your_password")
        // Or log in using a one-time key
        // Voximplant.login("your_one_time_key")
    }

    func clientSession(_ clientSession: VIClientSession, didFailConnectWithError error: Error) {
        // Handle connection error
    }

    func clientSessionDidDisconnect(_ clientSession: VIClientSession) {
        // Handle disconnection
    }
}
```

--------------------------------

### CreateCallList example

Source: https://voximplant.com/docs/references/httpapi/calllists

Adds a new CSV file for call list processing and starts the specified rule immediately.

```bash
curl --data-binary '@callList.csv' -H "`bash token.sh`" -H 'Content-type: text/csv' 'https://api.voximplant.com/platform_api/CreateCallList/?account_id=1&rule_id=1&priority=1&max_simultaneous=2&num_attempts=2&name=callList'
```

--------------------------------

### Initialize Voximplant Client

Source: https://voximplant.com/docs/getting-started/platform/android

Create and initialize an IClient instance for the Voximplant SDK. Permissions are automatically handled by the SDK.

```java
IClient client = Voximplant.getClient();

```

--------------------------------

### GetTransactionHistoryAsync example

Source: https://voximplant.com/docs/references/httpapi/history

Get the three transactions record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC with the 'gift' or 'money_distribution' types.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetTransactionHistoryAsync/?account_id=1&from_date=2012-01-01%2000%3A00%3A00&to_date=2014-01-01%2000%3A00%3A00&transaction_type=gift%3Bmoney_distribution&timezone=Etc/GMT&output=csv"
```

--------------------------------

### CreateSipRegistration example

Source: https://voximplant.com/docs/references/httpapi/sipregistration

Create SIP registration.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/CreateSipRegistration/?account_id=123&sip_username=JohnGalt&proxy=localhost"
```

--------------------------------

### GetTransactionHistory example

Source: https://voximplant.com/docs/references/httpapi/history

Get the three transactions record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC with the 'gift' or 'money_distribution' types.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetTransactionHistory/?account_id=1&from_date=2012-01-01%2000%3A00%3A00&to_date=2014-01-01%2000%3A00%3A00&count=3&transaction_type=gift%3Bmoney_distribution&timezone=Etc/GMT"
```

--------------------------------

### Inworld Realtime API Client Scenario Example

Source: https://voximplant.com/docs/voice-ai/inworld/realtime-api-client

This is a complete VoxEngine scenario demonstrating the usage of the Inworld Realtime API client. It requires the Inworld module and shows how to create a client instance, send media, and handle responses.

```voxengine
require("Modules.Inworld");

VoxEngine.runScenario(function() {
    var call = VoxEngine.createCall({ callerid: "1234567890", numbertodial: "1234567890" });
    var realtimeAPIClient = Inworld.createRealtimeAPIClient({
        // Provide your Inworld API key and other parameters here
        apiKey: "YOUR_INWORLD_API_KEY",
        // For example, to use a specific character:
        // character: "YOUR_CHARACTER_ID",
        // Or to use a specific scene:
        // scene: "YOUR_SCENE_ID",
    });

    // Send media from the call to the Inworld Realtime API client
    call.sendMediaTo(realtimeAPIClient);

    // Send media from the Inworld Realtime API client to the call
    realtimeAPIClient.sendMedia(call);

    // Handle Inworld Realtime API events
    realtimeAPIClient.on("sessionStarted", function(event) {
        console.log("Session started:", event);
        // You can send initial commands here, e.g., to start a conversation
        realtimeAPIClient.responseCreate({
            text: "Hello, Inworld!"
        });
    });

    realtimeAPIClient.on("text", function(event) {
        console.log("Received text:", event.text);
        // Process text responses from Inworld
    });

    realtimeAPIClient.on("audio", function(event) {
        console.log("Received audio chunk");
        // Play audio received from Inworld
        call.sendMedia(event.audio);
    });

    realtimeAPIClient.on("error", function(event) {
        console.error("Realtime API error:", event);
    });

    realtimeAPIClient.on("sessionEnded", function(event) {
        console.log("Session ended:", event);
        // Clean up resources or end the call
        call.hangup();
    });

    // Start the Inworld session
    realtimeAPIClient.startSession();

    call.on(" rozpoczęty", function() {
        console.log("Call started");
    });

    call.on("ended", function() {
        console.log("Call ended");
        // End the Inworld session if the call ends
        realtimeAPIClient.endSession();
    });
});

```

--------------------------------

### Connect and Log in with Password (v4 vs v5)

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Compares the v4 and v5 methods for connecting and logging in with a password. Note the required 'account node' parameter in v5 and the shift to promises for handling results.

```javascript
const sdk = VoxImplant.getInstance();
const ACCOUNT_NODE = VoxImplant.ConnectionNode.${NODE_n}
await sdk.init({
  node: ACCOUNT_NODE
});
await sdk.connect();
await sdk.login("username@app.account.voximplant.com","password");
```

```javascript
import { Core } from '@voximplant/websdk';

const core = Core.init({});
const { client } = core;
const ACCOUNT_NODE = ConnectionNode.${NODE_n}
await client.connect({
  node: ACCOUNT_NODE,
});
await client.login({
  username: "username@app.account.voximplant.com",
  password: "password",
});
```

--------------------------------

### Get SmartQueue Day History

Source: https://voximplant.com/docs/references/voxengine/voximplantapi/smartqueueinterface

Fetches the metrics for a SmartQueue over the last two days. Refer to the SmartQueue reporting guide for more details on interpreting these metrics.

```typescript
getSmartQueueDayHistory: 
(request: GetSmartQueueDayHistoryRequest) => Promise<GetSmartQueueDayHistoryResponse>
```

--------------------------------

### Get Key Roles Example

Source: https://voximplant.com/docs/references/httpapi/rolesystem

Retrieves the roles associated with a specific API key. An optional boolean parameter can be used to include expanded role properties.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetKeyRoles/?account_id=1&key_id=ab81c50e-573e-4446-9af9-105269dfafca"
```

--------------------------------

### GetCallHistoryAsync example

Source: https://voximplant.com/docs/references/httpapi/history

Get the first call session history record with calls and record URLs from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.

```bash
curl -H "`bash token.sh`" "https://api.voximplant.com/platform_api/GetCallHistoryAsync/?account_id=1&from_date=2020-02-25%2000%3A00%3A00&to_date=2020-02-26%2000%3A00%3A00&timezone=Etc/GMT&with_calls=true&with_records=true&output=csv"
```

--------------------------------

### Initializer

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/virejectmode/init%28from%3A%29

Initializes a VIRejectMode instance from a decoder.

```swift
init(from decoder: any Decoder) throws
```

--------------------------------

### Show Local Preview (v4)

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Demonstrates the method for showing local video in v4 of the SDK, which involved initializing the SDK with a container ID and calling showLocalVideo.

```javascript
await sdk.init({
  node: VoxImplant.ConnectionNode.NODE_n,
  // id of the HTMLElement that is used as a default container for local video elements
  localVideoContainerId: 'local_video_holder',
});

await sdk.showLocalVideo(true);

```

--------------------------------

### Grok Voice Agent API Client Scenario

Source: https://voximplant.com/docs/voice-ai/xai/grok

This is a complete scenario example for integrating the Grok Voice Agent API Client in your Voximplant application. It demonstrates the basic setup and usage.

```javascript
const VoxEngine = require('voxengine');
const Modules = VoxEngine.loadModules({
    Grok: 'grok'
});

VoxEngine.addEventListener(VoxEngine.CallEvents.Incoming, function (call) {
    const grokClient = Modules.Grok.createVoiceAgentAPIClient({
        // Your Grok API key
        apiKey: 'YOUR_GROK_API_KEY',
        // Grok model name (e.g., 'grok-1')
        model: 'grok-1',
        // Optional: Grok API endpoint
        // endpoint: 'https://api.grok.x.ai/v1/chat/completions'
    });

    // Forward audio from the call to the Grok client
    call.sendMedia(grokClient);

    // Forward audio from the Grok client to the call
    grokClient.sendMedia(call);

    grokClient.addEventListener(Modules.Grok.VoiceAgentAPIEvents.Transcription, function (event) {
        VoxEngine.log('Grok Transcription:', event.text);
    });

    grokClient.addEventListener(Modules.Grok.VoiceAgentAPIEvents.Response, function (event) {
        VoxEngine.log('Grok Response:', event.text);
        // You can send the Grok response back to the caller if needed
        // call.sendText(event.text);
    });

    grokClient.addEventListener(Modules.Grok.VoiceAgentAPIEvents.Error, function (event) {
        VoxEngine.log('Grok Error:', event.message);
    });

    grokClient.addEventListener(Modules.Grok.VoiceAgentAPIEvents.Close, function (event) {
        VoxEngine.log('Grok Connection Closed');
        call.hangup();
    });

    // Start the Grok session
    grokClient.start({
        // Optional: initial prompt or context for the Grok model
        // prompt: 'You are a helpful assistant.'
    });
});

VoxEngine.addEventListener(VoxEngine.CallEvents.Failed, function (call) {
    VoxEngine.log('Call failed');
});

VoxEngine.addEventListener(VoxEngine.CallEvents.Ended, function (call) {
    VoxEngine.log('Call ended');
});

```

--------------------------------

### Initialize Voximplant SDK v4

Source: https://voximplant.com/docs/guides/sdk/web-sdk-migration-guide

Initialize the Voximplant SDK instance using the v4 getInstance method.

```javascript
const sdk = VoxImplant.getInstance();
await sdk.init({
  node: $ACCOUNT_NODE
});
```

--------------------------------

### init(resizeMode:)

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vivideorendereruiview/init%28resizemode%3A%29

Creates a UIKit video renderer view with a specified video scaling type.

```APIDOC
## init(resizeMode:)

### Description
Creates a UIKit video renderer view.

### Method
`init`

### Parameters
#### Parameters
- **resizeMode** (VIVideoResizeMode) - Required - Video renderer scaling type
```

--------------------------------

### StartPlaybackParameters

Source: https://voximplant.com/docs/references/voxengine/startplaybackparameters

Defines the parameters for starting an audio playback. This object allows for specifying the source of the audio, playback control options, and other related settings.

```APIDOC
## StartPlaybackParameters

### Description

This object is used to configure the playback of audio within the VoxEngine. It allows developers to specify various attributes of the audio playback, such as the source, volume, and playback mode.

### Object Properties

- **url** (string) - Optional - The URL of the audio file to be played. Supported formats include MP3, WAV, and OGG.
- **text** (string) - Optional - The text to be synthesized into speech and played. This requires a TTS engine to be configured.
- **voice** (string) - Optional - The name of the voice to be used for text-to-speech synthesis. If not specified, a default voice will be used.
- **language** (string) - Optional - The language for the text-to-speech synthesis. For example, 'en-US' for American English.
- **volume** (number) - Optional - The playback volume, ranging from 0.0 (silent) to 1.0 (maximum volume). Defaults to 1.0.
- **loop** (boolean) - Optional - If set to true, the audio will loop indefinitely. Defaults to false.
- **delay_silence** (number) - Optional - The duration of silence in milliseconds to be added before starting playback. Defaults to 0.
- **playback_mode** (string) - Optional - Specifies the mode of playback. Possible values include 'synchronous' and 'asynchronous'. Defaults to 'asynchronous'.
- **media_unit** (string) - Optional - Specifies the media unit to be used for playback. This is typically used in advanced scenarios.
```

--------------------------------

### Start Conference Response

Source: https://voximplant.com/docs/references/voxengine/voximplantapi/getaccountinforequest

Represents the response after starting a conference.

```APIDOC
## StartConferenceResponse

### Description
Response received after starting a conference.

### Response
#### Success Response (200)
(No specific fields detailed in the source)
```

--------------------------------

### Start Conference Request

Source: https://voximplant.com/docs/references/voxengine/voximplantapi/getaccountinforequest

Represents a request to start a conference.

```APIDOC
## StartConferenceRequest

### Description
Initiates the start of a conference.

### Request Body
(No specific fields detailed in the source)
```

--------------------------------

### VINode.node13 Case Example

Source: https://voximplant.com/docs/references/ios_v3/core/documentation/voximplantcore/vinode/node13

Demonstrates the case statement for VINode.node13.

```javascript
case node13
```

--------------------------------

### start

Source: https://voximplant.com/docs/references/androidsdk3/android/sdk/calls/Call

Starts the outgoing call.

```kotlin
fun start(): Unit
```

--------------------------------

### previewDevice(_:)

Source: https://voximplant.com/docs/references/ios_v3/calls/documentation/voximplantcalls/vivideorendererview/previewdevice%28_%3A%29

The signature for the previewDevice(_:) instance method.

```swift
nonisolated
func previewDevice(_ value: PreviewDevice?) -> some View

```

--------------------------------

### start

Source: https://voximplant.com/docs/references/websdk-v5/call/call

Starts an outgoing call. Returns a promise that resolves if the call connection process has started successfully. A resolved promise does not mean that the call is connected; you should subscribe to CallEvent.Connected to be notified that the call is established.

```APIDOC
## start

### Description
Starts an outgoing call.
Returns a promise that is resolved if the call connection process has started successfully. A resolved promise does not mean that the call is connected. You should subscribe to CallEvent.Connected to be notified that the call is established.

### Method
start

### Returns
- **type**: Promise<void>

### Throws
- CallWrongDirectionError — if the method is called for an incoming call
- CallWrongStateError — if the call is in a state different from CallState.Created or CallState.Reconnecting
```

--------------------------------

### Start Balance Field

Source: https://voximplant.com/docs/references/httpapi/structure/calculatedtransactionhistorydatatype

Represents the start account/user balance with currency. This field is optional.

```json
start_balance: 
string
```

--------------------------------

### OpenAI Responses API Client Scenario Example

Source: https://voximplant.com/docs/voice-ai/openai/responses-client

A complete scenario demonstrating the usage of the OpenAI Responses API Client, including module requirements, client instantiation, and event handling.

```javascript
const Voximplant = require("voximplant");
const { Modules } = Voximplant;

const client = Modules.OpenAI.createResponsesClient({
    apiKey: "YOUR_API_KEY",
    model: "gpt-3.5-turbo",
    stream: true
});

client.on(Modules.OpenAI.ResponsesClient.EventType.Message, (event) => {
    console.log(event.message.content);
});

client.on(Modules.OpenAI.ResponsesClient.EventType.Error, (event) => {
    console.error(event.error);
});

client.createResponses({
    messages: [
        { role: "user", content: "Hello!"
        }
    ]
});
```

--------------------------------

### Request parameter examples

Source: https://voximplant.com/docs/guides/speech/tts

Examples of the request parameter for the most common providers.

```voxengine.partial
__
Copy
 __

```
Tokens:
Raw