Versions Compared

Key

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

Scroll export button
scopecurrent
template-id0fa09813-8b86-460a-aa1d-ef450a80e9ce
quick-starttrue
add-onScroll PDF Exporter

Info

This guide explains how to configure Retail mode for x-hoppers – Wildix wireless headset solution that allows fast and easy communication for retail stores.

Created: May 2022

Updated: February May 2024

Permalink: https://wildix.atlassian.net/wiki/x/QB-OAQ

Other documentation: x-hoppers User Guidex-hoppers datasheet, x-bees documentation

...


DeviceBackOfficeHelperHopperSalesFloorHopperSalesFloorHopper + AISuperHopper + AI
Ideal for: For SIP devicesAdministration and support users who don't face customers Customer care, contact center, users who need access to integrations Retail assistants who work on the shop floorRetail assistants who work on the shop floorManagers and supervisors
Free minutes for outbound calls100 min3000 min3000 min3000 min3000 min3000 min
SMS included100 sms200 sms1000 sms1000 sms1000 sms1000 sms
Chats and videoconferencing
Using x-bees apps
Adding guests to conversations
Integrations
Personal contact-me link, meeting scheduler, website widget
Website widget setup
Max number of devices / callsUp to 1 device / 2 callsUp to 10 devices / 4 callsUp to 10 devices / 8 calls

Up to 10 devices / 8 calls 
(max 2 calls on DECT headset) 

Up to 10 devices / 8 calls
(max 2 calls on DECT headset)

Up to 10 devices / 8 calls 
Contact center events logging
DECT headset included
Internal broadcast channel

Customer service powered by AI prompts

Wallboard and analytics


Note

Note:

  • Before WMS Beta 6.04.20230920.1:
    You need to assign "Business" license to all the users who need "x-hoppers-SalesFloorHopper" and "x-hoppers-SalesFloorHopper_AI" licenses.
    Possibility to assign all types of x-hoppers licenses on PBX for each single user is coming soon. 

  • Starting from WMS Beta 6.04.20230920.1:
    The relevant licenses can be assigned to users via WMS -> Users -> Edit user -> License type field. See more in PBX Licensing and Activation - Admin guide (section "Assign correct license type to each user").

    Warning

    Current limitation: Users that have x-hoppers-HelperHopper / x-hoppers-SalesFloorHopper + AI licenses, need to be assigned x-hoppers-SalesFloorHopper license in WMS.


...

The Headset is automatically deactivated and can’t receive calls while charging. 

Activation 

1.

...

To configure Retail mode on your PBX, open a ticket with our Technical Support team and our x-hoppers architects will help you with the setup. 

Note

Note: To see if Retail mode is activated, you can check the following parameters in the [wildixair] section of the /rw2/etc/provision.conf file:

  • WairRetailmode=on
  • WairAudiofeedback=voice
  • WairSilentcharging=on
  • WairSilentmode=off

2. Set up multicell DECT Network

You need to install and provision W-AIR Base stations and set up a multicell W-AIR DECT network. For detailed information and instructions on how to plan and configure multicell network, check this guide: W-AIR Network Admin Guide - Sync over LAN.

3. Register headsets

Before headsets can be assigned to specific users, they need to be registered to W-AIR Base Station. 

...

Limitation: It is impossible to register a headset if the code of DECT network set up in WMS → Devices → W-AIR Networks is different from "0000" (default code).

...

Set up multicell DECT Network

You need to install and provision W-AIR Base stations and set up a multicell W-AIR DECT network. For detailed information and instructions on how to plan and configure multicell network, check this guide: W-AIR Network Admin Guide - Sync over LAN.

2. Register headsets

Before headsets can be assigned to specific users, they need to be registered to W-AIR Base Station. 

Warning

Limitation: It is impossible to register a headset if the code of DECT network set up in WMS → Devices → W-AIR Networks is different from "0000" (default code).

Workaround: you can temporarily change the code to default one ("0000") on the W-AIR Networks page in WMS, register and assign the Headset(s), and then change it back to the custom one.

...

  1. Put the Headset in the registration mode by pressing Call, Volume+ and Volume- buttons at the same time for more than 5 seconds. When the Headset is in registration mode, the LED indicator blinks with short blue flashes and a voice prompt announces “Registering”.

  2. The Headset connects to the Base Station. When the Headset is subscribed, the voice prompt announces “Headset subscribed”.

    Note

    Note: If the registration fails, the voice prompt announces “Headset not subscribed”. Before trying to register the Headset again, please check if it is within range of W-AIR Base station and the voice prompt announces “Registering”.


  3. To check if the Headset is registered to the Base station, go to W-AIR Base Station web interface -> Extensions. If the registration is successful, the device appears in the list of available extensions with the state SIP Registered@RPN00

...

3. Assign headsets to PBX users 

Assigning via WMS 

Headsets can be assigned to users via the W-AIR devices tab in WMS, where you can find the list of all x-hoppers headsets: 

...

Note

Documentation: WMS Start Guide: Devices management.

Assigning via Speech-to-text

x-hoppers allows to configure the logic of assigning headsets to users via speech-to-text, so that staff can take the headset from charger, pronounce their names and automatically get assigned to the headset. 

Note

Note: The support starts from WMS Beta 6.05.20240119.1.

By default, the feature is disabled. To enable it, add the following parameter to the /etc/systemd/system/pbx-data-engine.service.d/override.conf file:

Code Block
--xhop_voice_login true

When enabled, each time the headset is placed into the charger, it gets unassigned. When a user lifts the headset from the charger:

  1. The user is asked to say their name
  2. The user should pronounce the name and surname
  3. The system looks for the user and assigns the headset to the user

Each time the headset is placed into the charger, it gets unassigned and gets Service license type in the system. 

Note

Important: For the feature to start working on the headsets, follow one of the following procedures:

a) After enabling the feature, when using the headsets for the first time, users need to lift the headsets from the charger -> place into the charger -> lift from the charger again.

b) Alternatively, before performing the upgrade and activating the feature, unassign headsets via WMS (Devices -> choose device and click Assign to user -> in the Extension field, choose “unknown”). Then, when users lift the headsets from the charger, they need to press the Call button first.  

5. Configure Dialplan 

Modify the users dialplan as follows: 

...

Enter *Wairhotline*

Note

Note: It is the value which is dialled by the headset in the Retail mode. This value is default and should not be changed.

...

  • Set -> Language -> choose language
  • Play sound -> click Browse (three dots) and choose the sound to be played on joining the broadcast or create it dynamically using TTS, for example Welcome to x-hoppers, joining the broadcast
  • Conference -> enter the conference room ID number. This can be any number, e.g. 1, 2, 3, etc. 


Image Removed

...

Joining the Broadcast from Other Devices

Wildix desk phones can also join the broadcast, as long as they are connected to the same PBX. There are two options:

  • A user should dial the feature code for Conference access (98 by default) + the conference room number. Example: 981 for conference room number 1.
  • Alternatively, a Dialplan can be configured so that when users dial a certain number, e.g. 333, the call is automatically put into the broadcast. 

Image Removed

...

4. Configure Dialplan 

Modify the users dialplan as follows: 

  1. Click Add number
  2. Enter *Wairhotline*

    Note

    Note: It is the value which is dialled by the headset in the Retail mode. This value is default and should not be changed.


  3. Add the below Dialplan applications:
    • Set -> Language -> choose language
    • Play sound -> click Browse (three dots) and choose the sound to be played on joining the broadcast or create it dynamically using TTS, for example Welcome to x-hoppers, joining the broadcast
    • Conference -> enter the conference room ID number. This can be any number, e.g. 1, 2, 3, etc. 

Image Added

Note

Documentation:Dialplan Applications - Admin Guide.

Joining the Broadcast from Other Devices

Wildix desk phones can also join the broadcast, as long as they are connected to the same PBX. There are two options:

  • A user should dial the feature code for Conference access (98 by default) + the conference room number. Example: 981 for conference room number 1.
  • Alternatively, a Dialplan can be configured so that when users dial a certain number, e.g. 333, the call is automatically put into the broadcast. 

Image Added


Note

Documentation: Dialplan Applications - Admin Guide.

Make Announcement to Users of Specific Departments

Starting from WMS 6.07, it is possible to make announcement in x-hoppers broadcast to users of specific Departments only. 

  1. Create a CURL request that triggers a message to the required department.

Example: 

Code Block
curl -X POST --header 'Authorization: Bearer {token}'

https://{pbx domain}/api/v1/Originate -d

'channel=Local/999@myDialplan&application=System&async=true' -d

'variable=dst=777,dept=Sales,msg=help required at checkouts'

Where:

  • 999 (you can set a custom number) = the Dialplan rule that processes the request. 
  • dst = the rule in the outgoing Dialplan of users that should receive the announcement
  • dept =  department name
  • msg = the announcement: a text prompt or a path to an audio file stored on the PBX
Note

Note: msg and dept values can be wrapped in double quotation marks (“)

2. Create rule 999 (you can set a custom number) and call the following script in that rule:

Code Block
Custom app :: System(data_engine_cli OriginatePlayback ${dst} '${dept}' '${msg}')

Image Added
3. Create a Dialplan rule with dst number (this can be any number that is not occupied by a user or by another real destination, e.g. 111 or 777) in the outgoing users Dialplan(s). If users have different Dialplans, the rule with dst number should be created in each of them (or it can be added as an included procedure). Configuration:

  • Set :: Language :: en (this one is needed for TTS processing)
  • Set(sound=${SHELL(/usr/sbin/data_engine_cli GetSound ${CALLERID(num)})})
  • Play sound :: ${sound}
Warning

Important: In case of changing Department name, make sure to reload PBX engine to apply the changes:

Code Block
# systemctl daemon-reload # systemctl restart pbx-data-engine


Modifying the timeout of broadcast mute

Starting from WMS Beta 6.06.20240315.1, users have possibility to mute the broadcast by double-pressing the Call button. By default, the broadcast gets muted for 60 seconds. If user wants to unmute the broadcast before the 60-second timeout, user can double-press the Call button again. 

The default timeout can be customized. To do this:

1. Add the following line to the file /etc/systemd/system/pbx-data-engine.service.d/override.conf: 


Code Block
# vi /etc/systemd/system/pbx-data-engine.service.d/override.conf
[Service]
Environment='XHOP_UNHOLD_TIMEOUT=120' 


Where 120 is the custom timeout.
 If you want to disable the timeout, set the value to 0:

Code Block
Environment='XHOP_UNHOLD_TIMEOUT=0' 

2. Reload systemd and restart the service to apply the changes:

Code Block
# systemctl daemon-reload
# systemctl restart pbx-data-engine


Note

Note: For WMS versions prior to 6.07, instead of XHOP_UNHOLD_TIMEOUT, the parameter UNHOLD_TIMEOUT should be used.


QR code system 

Use cases  

...

Note

Note:

  • The support starts from WMS 6.03.20230630.3. 
  • The feature works only if there is an x-hoppers license available on the PBX.

...

Record in-store conversations (listen in CDR-View)

Starting from WMS 6.03.20230630.3, it is possible to record in-store conversations and listen them via CDR-View. The recording starts when user unmutes himself in the conference and begins talking.

...

  1. create directory /etc/systemd/system/pbx-data-engine.service.d

    Code Block
    # mkdir /etc/systemd/system/pbx-data-engine.service.d


  2. Add the following key to the file: 

    Code Block
    # vi  nano-tiny /etc/systemd/system/pbx-data-engine.service.d/override.conf
    
    [Service]
    ExecStart=
    ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr


  3. Reload systemd and restart the service to apply the changes:

    Code Block
    # systemctl daemon-reload
    # systemctl restart reload
    # systemctl restart pbx-data-engine


    Note

    Note: Reloading systemd is required each time you make any changes to the /etc/systemd/system/pbx-data-engine.service.d/override.conf file.


    Once enabled, the recording of in-store conversations get displayed in the CDR-View. 
    Recording starts when a user unmutes themselves in the conference and starts talking.

...

  1. Create x-bees conversation with all the users that are participating in the x-hoppers conference and also needed managers.

  2. Copy x-bees conversation ID (available in the URL of the conversation)

  3. Add the following data to the /rw2/etc/pbx/x-hoppers.json file:

    Code Block
    [
      {
        "store_veesion_id": "test-store-wildix",
        "name": "Store1",
        "audio_conf_id": "2",
        "location": "Odesa2",
        "xbees_channel_id": "f6d17593-98b6-471d-941a-cd03153f",
     
      "veesion_user_extension": "12345"
      }
    ]
    
    


    Where:

  4. store_veesion_id (optional): ID of the store on the Veesion side. Applicable if there is Veesion integration. 
  5. name

    :

     name of the store 

    • audio_conf_id: ID of the audio broadcast channel in x-hoppers where the communication takes place
    • location: location of the store
    • xbees_channel_id: ID of the x-bees conversation, copied in step 2, where the content will be posted.user: user, on behalf of whom , where the content will  will be posted (applicable for Veesion integration)

When the feature is enabled, whatever is told in the conference is automatically transcribed and displayed in x-bees conversation, so managers could monitor what was discussed in the conference.

...

Where 6 is the preferred volume. The maximum value is 10. The default value for both parameters is 0.

Other features

ChatGPT Integration

ChatGPT integration with x-hoppers can enhance customer support and information sharing, allowing to ask questions and instantly receive answers. Powered by ChatGPT, x-hoppers processes the questions and generates the response based on its knowledge base, which is then played back to the user through the broadcast channel.  

Note

Currently, users are limited to asking one question. To ask another question, Headset should be put into the Charger and then lifted again. This restarts the interaction and allows users to ask a new question. Alternatively, user has to double-press the AUX Function button.

How to set up 

...

Speech to text -> insert Please unmute and say question for Chat GPT, or wait to join the broadcast (or any customized text)

...

How to use 

For the current development stage, users are limited to asking one question. To ask another question, Headset should be put into the Charger and then lifted again, which restarts the interaction and allows to ask a new question. Alternatively, user has to double-press the AUX Function button.

...

, which is then played back to the user through the broadcast channel.

Documentation: How to set up ChatGPT for x-hoppers

Voice authorization  

x-hoppers allows to configure voice authorization for assigning headsets to users. When enabled, the system compares the voice of the user with user voices previously saved in the system and in case of a match, allows authorisation, eliminating the risk of user logging in under a different name.

Documentation: How to set up Voice Authorization for x-hoppers

Push-to-talk on mobile

This option allows to send Push-to-talk messages to x-hoppers broadcast from x-bees conversation. Users can send voice messages to x-hoppers broadcast via mobile and receive broadcast messages to x-bees conversation, having them played automatically in Speaker mode. 

Read more in the documentation How to configure and use Push-to-talk for x-hoppers


Macrosuite divider macro
dividerTypetext
dividerWidth70
emoji{"id":"smile","name":"Smiling Face with Open Mouth and Smiling Eyes","short_names":["smile"],"colons":":smile:","emoticons":["C:","c:",":D",":-D"],"unified":"1f604","skin":null,"native":"😄"}
textColor#000000
dividerWeight2
labelPositionmiddle
textAlignmentcenter
iconColor#0052CC
fontSizemedium
textNot finding the help you need? Join the Facebook group to ask a question!
emojiEnabledfalse
dividerColor#DFE1E6
dividerIconbootstrap/CloudsFill

...