Overview

Quick Start

Immersive Voice Mode

Full-screen voice interface for immersive conversations.

const touchpoint = await create({
  config: {
    applicationUrl: "YOUR_APPLICATION_URL",
    headers: { "nlx-api-key": "YOUR_API_KEY" },
    languageCode: "en-US",
  },
  input: "voice", // Enable full voice mode
});

Compact Voice Mode (Voice Mini)

Floating module for voice without taking over the screen.

const touchpoint = await create({
  config: {
    applicationUrl: "YOUR_APPLICATION_URL",
    headers: { "nlx-api-key": "YOUR_API_KEY" },
    languageCode: "en-US",
  },
  input: "voiceMini", // Enable compact voice mode
});

Voice Input Options

Mode	Description	Best For
voice	Full-screen voice interface with immersive experience	Primary voice interactions, voice-first applications
voiceMini	Compact floating module with minimal controls	Voice as a secondary input option, space-constrained layouts

Application and Touchpoint Prerequisites

All voice modes require:

Item	Description
Voice-enabled Application	Your NLX application must be configured for voice on API channels
Browser support	WebRTC APIs must be available
User permissions	Microphone access must be granted when prompted

When to Use Immersive Voice mode

Use voice when:

• Voice is the primary interaction method

• You want an immersive, focused experience

• Screen real estate isn't a concern

• The conversation is the main user activity

When to use Voice Mini

Use voiceMini when:

• You're using Voice+ in Bidirectional mode

• Voice is an optional input method alongside other UI

• You need to preserve screen space

• Users need access to other page content during voice interaction

• You want a less intrusive voice option