LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata (beta)
        • Apply KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Test & Deploy
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • What's a Voice+ application?
  • Checklist
  • Step 1: Integrations
  • Step 2: Create a Voice+ script
  • Step 3: Construct a flow
  • Step 4: Deploy application
  • Step 5: Deploy script & install SDK
  1. GETTING STARTED
  2. Guides

Voice+

From start to finish, set up a multimodal Voice+ experience with NLX

Last updated 26 days ago

What's a Voice+ application?

Voice+ involves enriched multimodal experiences that pair voice prompts with visual assets from web, mobile, or IoT interfaces. Voice + experiences synchronize an AI assistant's voice messaging to the planned progression of steps customers take to complete a task online.

  1. A customer calls a phone number

  2. Your conversational AI assistant greets the customer and asks, “How may I help you?”

  3. Your application identifies the customer's intent and matches to an applicable

  4. An SMS containing a link to your web/mobile/IoT asset is texted to the customer

  5. From there, the AI assistant guides the customer in real-time through the series of onscreen steps until the customer's need has been met

Watch a Voice+ experience in action:


Checklist

You'll complete the following to successfully launch your Voice+ application:


Step 1: Integrations

Est. time to complete: ~10 minutes

A one-time integration of a Natural Language Processing (NLP) engine must be completed in your workspace:

A one-time integration of a voice-enabled communication channel must be completed in your workspace:

A one-time set up of an Action that sends an SMS:

    • Be sure your Action has the following properties defined in the Request model schema:

      • Message (string)

      • PhoneNumber (string)

      • URL (string)


Step 2: Create a Voice+ script

Est. time to complete: ~10 minutes

Voice+ experiences pair voice prompts from an AI assistant to a digital asset (website, mobile app, etc.) to help guide users through a self-service task. Begin by identifying the elements from your digital asset that need to be mapped to a voice line (pages, buttons, etc.) and create a complete script:

  • Select Resources in your workspace menu > Choose Voice+

  • Select New script option > Name your Voice+ experience

  • Click Save

  • Click + Add step > Enter the AI's voice line in the message field*

  • Repeat for each step

  • On the final step of your Voice+ script, enable the Action toggle

    • End: Terminates the phone call after the AI assistant delivers the voice step

    • Continue: Proceeds from the Continue edge of the Voice+ node in your intent flow (see Step 2)

  • Click Save

  • Download your steps to a .csv or .json file using the Download link


Step 3: Construct a flow

Est. time to complete: ~10 minutes

Each flow is invoked when your chosen AI model identifies user intent from a user's utterance ("I want to order room service") and matches it to a flow you've created (OrderRoomService). This match is done based on the training data you provide for your AI model.

  • Select Flows from workspace menu > Choose New flow

  • Enter a descriptive name (no spaces or special characters) > Select Save

  • Within your intent flow, select the Action node > Use the system variable {system.userId} for the Phone number field of your payload on the Action node's side panel

  • In your Action's URL payload field, enter your URL followed by the query parameter ?cid={system.conversationId}

  • Place and link a Basic node after the Action to indicate a text was successfully sent to the user

  • From the Basic node, place and link to a Voice+ node > Click Save


Step 4: Deploy application

Est. time to complete: ~10 minutes

Now you'll create the conversational AI application users will interface with. This step involves attaching all flows you want your application to access, defining flows to handle certain behaviors, setting up the voice channel your application supports, and deploying.

  • Select Applications from workspace menu > Choose New application

  • Enter a descriptive name > Click Save

  • Click Flows tab of application > Select Attach flows > Attach one or more flows created to make available to your application > Click Attach selected then Save

  • Select Default behaviors tab of application > Assign any attached flows to the application's behaviors (if you intend for your Voice+ flow to be the only flow your application handles, then assign to the Welcome behavior) > Click Save

  • Select Channels tab of application > Expand the voice channel your application will support (e.g., Amazon Connect, Amazon Chime SDK, etc.) > Click + Create channel

  • Enter required details for voice > Click Create channel > Click Save

A build constructs the array of workflows that make up your application and updates any changes made to your flows, while deploying makes a successful build live:

  • Click Deployment tab of application > Select Create or Review & build

  • Wait for validation to complete > Select Create build*

  • When satisfied with a successful build, click Deploy


Step 5: Deploy script & install SDK

Est. time to complete: ~10 minutes

You'll need to install NLX's Voice+ SDK to each screen of your digital asset so applicable API calls can be made to trigger voice lines where you've defined them:

  • Select Resources in your workspace menu > Choose Voice+

  • Choose your Voice+ script completed in Step 1 > Click Deployment tab of your Voice+

  • Choose Review & build > Click Create build

  • After a successful build, select Deploy from the Production column > Click Create deployment

  • Select Details link next to the Deployed status > Under Setup instructions, click Open Voice+ configurator

  • Install code snippet with applicable step IDs (downloaded in Step 1) to each page of your frontend

Want to see more? View

You may add the following to an existing in your workspace, if desired.

Looking for more? See

As all Voice+ experiences begin with a traditional voice experience (IVR), you'll construct a flow that sends the SMS containing a link to your digital asset and initiates Voice+ mode. Begin by identifying the tasks your conversational AI application will automate and organize them into individual topics handled by . Determine the sequence of steps and messaging that the conversational application follows to assist a user with the task. The conversation workflow is assembled in a flow's Canvas with a pattern of nodes similar to a flow diagram.

Complete by attaching training data and slots

After adding a greeting with a to the Canvas, place an that will send the SMS link (requires a that sends SMS be previously set up in your workspace). At a minimum, be sure your Action's Request model has at least two properties 1) Phone number, 2) URL

Looking for more? See

*After a build status appears as Built, you may use the Test feature to test the conversation with your application using the latest build.

Looking for more? See

API key: You may auto-generate an API key under the tab, Save, and then enter it in the configurator's field

Conversation ID: Dynamically generated for each conversation session with a user by NLX, you may parse the ID from the user's URL path. Sample code:

To avoid CORS errors, make sure to whitelist your URL domain(s).

Looking for more? See the

🟢
the NLX showcase
voice assistant
Steps for NLP integration
Amazon Chime SDK
Amazon Connect
Twilio Voice
Create a SendSMS Action
🧠
Add + download script
flows
Flow setup
🧠
Intro to flows
🧠
Manage channels
https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/get#examples
🧠
Developer docs
flow
custom API Action
Basic node
Action node
Voice+ script's Settings
in the Voice+ script's Settings