Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This document provides description of Voice Bots feature, setup instructions, use cases and overview of how you can benefit from using Voice Assistant.

Created: November 2024

Updated: January 20242025

Permalink: https://x-hoppers.atlassian.net/wiki/x/DAD8B

...

  1. API Key: enter the unique identifier that allows to grant access to the OpenAI API, which lets to send requests and receive responses from the Assistant

  2. Assistant ID: fill out the unique identifier of a specific OpenAI Assistant you created.

...

Dial by Name Setup

Setting up Dial by name option in Voice bot allows to ask the bot to dial colleagues just by pronouncing their name / extension. To configure the option, follow the steps below:

  • In Voice bot settings add the Transfer tool 

...

  • Fill out the fields of the Transfer section:

  1. Description: enter instructions for the transfer, e.g. “Transfer the call to the extension number of the colleague from the same organization if asked by the caller.“

  2. Context: enter the name of the Dialplan to which the call should be transferred

Note

The Dialplan should include the Dial the phone application:

dial-by-name-dialplan.pngImage Added
  1. Destination: select the option Directory, in this case the AI utilizes the Organization Directory for the transfer

  2. Pipeline: choose the Voice bot should generate a reply and transfer the call or transfer the call without replying

...

  • Click Save to save the changes.

Manage Voice Bots

The Voice Bots that you have created are displayed in x-hoppers admin -> PBX -> Integrations -> Cloud integrations -> Voice Bots section. You can see the Voice Bot name, Bot ID, and Integration type.

...

  1. On the screen that pops up, type the word “delete” and click Delete:

...

Dialplan Configuration

To let store associates access Voice bot from the headset, you can add the Voice bot to the *wair* section of x-hoppers Dialpan. In this case, users can just double-press the AUX Functionbutton on the headset and get into the menu with the Voice bot. Add the following applications under *wair* number:

  • Set

...

  • Set a language which the Voice Bot will use: add Set application -> Codecs -> alaw, ulaw
    Voice bot cannot be started in case the call was answered with opus codec. To avoid such a scenario, you can set alaw/ ulaw codecs.

  • Set -> Language -> select the language

Note

Note:

  • The following languages are supported:

    • English (British), English (US), French, Italian

    • Spanish, Dutch, German, Arabic, Catalan, Danish, Swedish, Portuguese - starting from WMS 6.09.20241106.2

    • Swiss German - starting from WMS 6.09.20241211.2

  • Arabic (ar), Swedish (se) are not present in the drop-down list, but you can enter them manually, for example:

setting-language-manually.png
  • Basque and Estonian languages are not supported

  • Add the Voice Bot application and -> choose the necessary Voice Bot from the list:

...

Note: Voice bot cannot be started in case the call was answered with opus codec. To avoid such a scenario, you can set alaw/ ulaw codecs in Dialplan: add Set application -> Codecs -> alaw, ulaw:

...

In case you need to make Voice bot available by calling a specific number, you can enter the number and add the same applications mentioned above:

...

Choose speaker

Tip

Note: The support starts from WMS 6.09.20241129.1.

...