How to configure and use Push-to-talk for x-hoppers

The document describes how to configure Push-to-talk feature for x-hoppers broadcast.

x-hoppers Documentation: x-hoppers Documentation

Created: May 2024

Permalink: https://wildix.atlassian.net/wiki/x/AQCIIg

Introduction

The feature allows to send Push-to-talk messages to x-hoppers broadcast from x-bees conversation. With this option, users can send voice messages to x-hoppers broadcast via mobile and receive broadcast messages to x-bees conversation on mobile, having them played automatically in Speaker mode. 

Requirements

  • x-hoppers-SalesFloorHopper licence or higher
  • ACL permission Can see call recordings
  • WMS v. 6.07
  • x-bees mobile app v. 1.68 or higher
  • Note: The XBees Android App requires the "Nearby Devices" permission to be granted.

Configuration

  1. Add the parameter  --conf_recording or -ptt to the /etc/systemd/system/pbx-data-engine.service.d/override.conf file.

    Example: 

    [Service]
    
    ExecStart=
    
    ExecStart=/usr/sbin/pbx_data_engine.py --conf_recording --daemon
  2. Restart the service to apply the changes: 

    systemctl daemon-reload 
    
    systemctl restart pbx-data-engine
  3. For the feature to work on mobile, make sure there is an included procedure pbxservice(Services codes dialplan) set in Dialplan:



  4. Create a conversation in x-bees, adding all members of x-hoppers broadcast, including all W-AIR headset users and all users of x-bees mobile app, that are going to use the Push-to-talk feature. The transcription and audio files of what was pronounced in x-hoppers broadcast will be added to this conversation.

  5. Add the following lines to the /rw2/etc/pbx/x-hoppers.json file: 

    [
        {
            "audio_conf_id": 0,
            "xbees_channel_id": "a1b88b80-a287-4848-8d1a-9fb8721f"
        }
    ]

    Where:

    1. “0” is the number of x-hopper conference

    2. "a1b88b80-a287-4848-8d1a-9fb8721f" is the ID of x-bees conversation. 

      Note: The conversation ID is available in the conversation URL: 


  6. Restart the service to apply the changes: 

    systemctl daemon-reload 
    
    systemctl restart pbx-data-engine

Usage on Mobile 

On mobile, users need to: 

  1. Go to Settings -> Integrations -> enable the toggle next to Allow Push-to-talk option:


    Note: The Push-to-Talk button under Allow Push-to-Talk can currently be used to connect Jabra Perform 45 headset. 

    Important: On Android, it is necessary to allow "Nearby Devices" permission for x-bees app for the Push-to-talk feature to work. 

  2. Find x-hoppers conversation on the Inbox tab -> press and hold the relevant conversation -> on the pop-up screen that appears below, press the option Enter x-hoppers group:



  3. To send a voice message to x-hoppers broadcast via mobile, user should press and hold the Push-to-talk button next to the message field:


    The message is played to users in x-hoppers broadcast. Also, once mobile user enters the x-hoppers conversation, the group messages are automatically played on mobile in Speaker mode.

    What is pronounced in x-hoppers broadcast is added as a message from the relevant user with a transcription and audio file:
     

  4. To exit the broadcast, go to the Inbox tab ->  press and hold the relevant conversation -> on the pop-up screen that appears below, press the option Exit x-hoppers group: