Voice Reference

What Touchpoint Voice can do

Embed a full‑screen, voice‑first interface that connects to your NLX flows.

Highlights:

  • Immersive UI: Full‑screen voice experience with mic control and speaking indicators

  • Server‑driven UI: Render custom modalities during calls

  • Control: Drive flows, send text, choices, and slots via ConversationHandler

  • Branding: Show brand icon; theme fonts, colors, and radii

  • Lifecycle: Close ends the call and resets conversation state

How it works with NLX

Remember:

  • Config: applicationUrl + nlx-api-key (Configuration)

  • Voice: Touchpoint requests voice credentials, connects to LiveKit, and streams audio

  • Requests: Low‑latency request data is sent over LiveKit’s data channel

  • Modalities: Payloads map to components via customModalities

  • Init: Use initializeConversation to customize welcome behavior for voice sessions

Quick setup

See the full Configuration Reference for details.

API at a glance

create(options) returns a Touchpoint instance with conversationHandler and UI controls. Voice‑relevant options include required connection info (applicationUrl, nlx-api-key, languageCode), input: "voice", branding (brandIcon), theming, customModalities, initializeConversation, and initialContext.

Component building blocks

Re‑use the same component primitives as Chat for custom modalities:

Behavior notes

  • Closing the voice UI ends the call and clears responses; reopening starts a fresh session

  • Mic is toggled within the voice screen; speaker volume is controlled from the header

  • Speaking indicators reflect both user and agent activity

Next steps

Last updated