Integrate Omilia

This help page provides information about Omilia virtual agents. CXone also supports Omilia, an agent assist application that provides voice biometric authentication.

If you're setting up an Omilia voice virtual agent, contact your CXone Account Representative. The information on this page is only for setting up text virtual agents.

Before completing the tasks on this page, be sure that the prerequisites for the integration have been met.

Create a Script

Required permissions: Studio Script View, Create/Edit

You need at least one Studio script to route interactions to your virtual agent. Follow the script guidelines and requirements. The supported virtual agent action for this provider is Textbot Exchange and your script must have the digital media typeClosed A medium, such as voice, email, and chat, through which a contact connects with an intended recipient..

If you're using a SIPClosed Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. backchannel connection with your virtual agent, contact your CXone Account Representative for help with the integration.

You can learn more about Studio scripting in the Fundamentals and Technical Reference Guide sections of the online help.

When your virtual agent is ready to go into production, assign the script to one or more points of contact.

Add an App to Virtual Agent Hub

Required permissions: Automation & AI > Launch Automation & AI

Adding a configuration app to Virtual Agent Hub establishes the connection between CXone and your virtual agent provider.

  1. In CXone, click the app selector and select Other > Automation & AI and then click Virtual Agent Hub. You can also double-click the virtual agent action in your Studio script to launch Virtual Agent Hub.
  2. Click Add Bot.

  3. Enter a Virtual Agent (Bot) Name and click Omilia in the list of virtual agent providers.

  4. Click Next.

  5. Complete the fields in the configuration form and click Next. You can find details about this form in the Configuration Page Details section on this page.

  6. Click Next.

  7. If you're setting up a text virtual agent, select Text Only (No Voice Support) on the Voice page. If you're setting up a voice virtual agent, contact your CXone Account Representative.

  8. Click Next.

  9. On the Transcript page, select the option for whether you want the conversation transcript and intent information captured. This option is only available for text virtual agents. It's not supported for voice integrations that use a SIPClosed Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. backchannel connection.

    Option Details
    Do Not Capture or Archive Transcript or Intent Info Select this option if you don't want to capture conversation transcriptions or intentClosed The meaning or purpose behind what a contact says/types; what the contact wants to communicate or accomplish information.
    Capture and Archive Intent Info Only

    Select this option if you want to want to capture intent information only. Captured data is stored only for the duration of the interaction by default.

    This option requires custom scripting.

    Capture and Archive Transcript and Intent Info

    Select this option if you want to capture both transcript and intent data. Captured data is only stored for the duration of the interaction by default.

    This option requires custom scripting.

  10. Click Next.

  11. On the Test + Add page, you can test your bot's connection by sending voice or text prompts. If your test messages don't work, click Back to return to the Configuration page and verify the settings. You may also need to verify configurations in your virtual agent provider's management console.

  12. Click Add.

Omilia Configuration Page Details

Use the information in the following table when completing the Configuration page. You see this page when adding an app in Virtual Agent Hub

Field

Details
Integration Version

Select the version of Virtual Agent Hub that you want to use. This option allows you to use a previous version of Virtual Agent Hub until you're ready to switch to a newly-released version. The available versions are: 

  • Version 1.0.0: This is the first version of Virtual Agent Hub. The custom payload object returns as customPayload.payload.xxxx.
  • Version 2.0.0: This version is not available for this provider.
  • Version 3.0.0: This version introduced StandardBot, which standardizes how CXone communicates with virtual agent providers. The customPayload object returns as an array, as customPayloadscriptPayloads[n].xxxx. This version is available for all providers.
API Key

Paste in your API key for Omilia.

You can find this in your Omilia Cloud Platform console: 

  1. Go to the miniApps section and open the Manage page.
  2. Search for your Omilia virtual agent and open it.
  3. On the Chat tab, copy the value of the apiKey key.

This is a required field.

Omilia Base URL

Enter the base URL for your Omilia Orchestrator Flows (SND - PRD).

You can find this in your Omilia Cloud Platform console:

  1. Go to the miniApps section and open the Manage page.
  2. Search for your Omilia virtual agent and open it.
  3. On the Chat tab, copy the value of the apiUrl key.
  4. After you paste the URL into the Omilia Base URL field in Virtual Agent Hub, replace the wss in the URL with https and follow this format: https://${region}-m.ocp.ai/agent-vb-mw. For example, if the apiUrl value is wss://us1-m.ocp.ai, change it to https://us1-m.ocp.ai.

This is a required field.

Timeout Intent Enter the name of the intent you want the Omilia virtual agent to use when a timeout occurs. This field is optional.
Fall Back Intent Enter the name of the intent you want the Omilia virtual agent to use for a default intent. This is used when the virtual agent doesn't recognize the contact's input. This field is optional.
External Provider Timeout

Enter the number of seconds you want the script to wait for a response from  Omilia. When the timeout is reached, control returns to the script, which takes the error branch.

Assign the Omilia App to an Action

Required permissions: Studio Script View, Create/Edit

When the virtual agentClosed The meaning or purpose behind what a contact says/types; what the contact wants to communicate or accomplish app is set up and configured in Virtual Agent Hub, you need to assign it to the virtual agent action in your script. This connects the action and the script to your virtual agent provider.

  1. In Studio, open the script you want to modify.

  2. If you haven't done so already, click the Tools tab, expand the Automation and AI category, and add the virtual agent action you want to use. Be sure to put it in the correct location in your script. If you don't see the action you expect, verify that your script media type is correct. For example, if you're creating a script for a voice virtual agent, the script must be a phone script.

  3. Double-click the action to open Virtual Agent Hub.

    The Virtual Agent Hub main page has a list of current bots is on the left. Each has a delete icon and a checkmark icon to the right of the bot name.
  4. In the left column, locate the virtual agent that you want to assign to the action and click the checkmark An icon of a circle with a checkmark inside. next to it.
  5. Click Close.

Test Your Virtual Agent Bot

Required permissions: Automation & AI > Launch Automation & AI

You can test many aspects of your virtual agent to make sure everything works as intended. You can run tests from the virtual agent app's properties page in Virtual Agent Hub. When testing, you can: 

  • Verify that the virtual agent app is correctly configured to communicate with the virtual agent provider.
  • Add custom payload JSON to test the virtual agent's handling of custom payload data.
  • Trigger a welcome intent event to test how the virtual agent begins a conversation.
  • Trigger a custom intent event to test any custom events you've created for your virtual agent.
  • Trigger a timeout event to test how the virtual agent responds when the contact times out.
  • Test how the virtual agent handles DTMFClosed Signaling tones that are generated when a user presses or taps a key on their telephone keypad. input.

The following image is an example of the properties page for a virtual agent app in Virtual Agent Hub. It shows the Configuration and Voice tabs and the Test pane.

The properties page for a bot in Virtual Agent Hub showing the Test pane on the right side of the page.

  1. In CXone, click the app selector and select Other > Automation & AI and then click Virtual Agent Hub. You can also double-click the virtual agent action in your Studio script to launch Virtual Agent Hub.
  2. Click to select the configuration app for the virtual agent you want to test from the list on the left.

  3. In the Test pane, enter a test message in the Type a message field and press Enter to send it. You can also click Microphone An icon shaped like a microphone. and speak into your computer's microphone.

  4. Click Start with welcome intent to start a test conversation from the beginning. The virtual agent responds with its default welcome message. You can enter test messages.

  5. Click More Options An icon with three dots stacked vertically. to test other aspects of your virtual agent.

    Field Details
    Add Custom Payload JSON

    Select to test sending custom payload JSON to your virtual agent.

    Enter the custom payload in the Add Custom Payload JSON text box that appears on the Test + Add page. Press Enter after each line.

    Send a test message when you're ready to test the custom payload. When you're finished testing custom payload, click Close on the Add Custom Payload JSON pane.

    Trigger Welcome Intent Event Select to test the default Welcome intentClosed The meaning or purpose behind what a contact says/types; what the contact wants to communicate or accomplish. The virtual agent sends the welcome message. Enter a message to respond.
    Trigger Custom Intent Event Select to test a custom intent event. Enter the Event Name in the pop-up that appears and click Trigger. The virtual agent sends the message for the intent you entered. Send a response to test the intent.
    Trigger Timeout Event Select to view the default timeout intent. The virtual agent sends the timeout response message that it's configured with.
    DTMF Input Select to test your voice virtual agent's response to DTMFClosed Signaling tones that are generated when a user presses or taps a key on their telephone keypad. tones. Enter DTMF Characters and click Input to see the virtual agent's response to those characters.
  6. Click Reset to start your test again.

  7. If you need to make changes based on the results of your testing, you can: 

    • Modify the Studio scripts for the virtual agent.
    • Modify the configuration settings in the virtual agent's app in Virtual Agent Hub.
    • Modify the virtual agent's configuration settings in the provider's console. Click the large square button on the app properties page in Virtual Agent Hub. The example at the beginning of this section shows the Google Dialogflow CX app with the provider button. It has the An icon that has a square with an arrow overlaid on top of it. The arrow points from the center of the square to the top right corner of the square. icon on it to indicate that the link opens an external site.
  8. Test the virtual agent thoroughly after each change to your scripts or any configuration settings.
  9. When you're finished testing, click Close.