Administration

UCX Administration
Applications – Music on Hold

The UCX system provides a set of eight default Music On Hold (MOH) files. These files are installed in the default MOH category that is used by default for all extensions, incoming routes, outgoing routes, ring groups, queues, etc..

You can customize the MOH feature in the following ways:

  • Use custom music files and/or recorded announcements
  • Create different MOH categories that can be used for different purposes (e.g., inbound and/or outbound routes, ring groups, queues)
  • Enable/disable random selection of MOH files
  • Remove existing MOH files

The current release of UCX supports only MOH files in wave formats. If you upload an MP3 file, the system will automatically convert the file into wave format. 

The UCX system uses wave files that are PCM encoded (or equivalent CCITT u-law encoded), with 16 bit samples, 8 kHz sample rate and mono channel settings.  If you upload a wave file in a different format, the file is automatically converted to this format.

The maximum supported size of a file that can be uploaded is 1 GB.

Adding Music Category

To add a music category, perform the following steps:

  1. From the PBX tab, select PBX Configuration
  2. From the left side column, select Music on Hold
  3. From the list of actions and categories on the right side, select Add Music Category
  4. In the Category Name field, enter the name for the new music category
  5. Press the Submit Changes button to create the new category

The new category will now appear in the drop-down list for Music on Hold when you configure your inbound routes, outbound routes, queues, ring groups and conferences. The example below shows the new MoH category on the Inbound Routes page.

To change the default Music on Hold category used for SIP extensions, perform the following steps:

  1. Navigate to SIP Settings page.
  2. Scroll down to Advanced General Settings section.
  3. In the field Other SIP Settings, add the parameter ‘ mohsuggest mohcategory ‘ where mohcategory is the name of the desired Music on Hold category.

In the example below, there should be a MoH category named ‘SIPextensions’ created on the system before assigning it to the parameter mohsuggest.

Adding Music File

To add custom music files or announcements that are to be used by the MOH feature of your UCX system, perform the following steps:

  1. From the PBX tab, select PBX Configuration
  2. From the left side column, select Music on Hold
  3. From the list of MOH categories on the right side, select a MOH category (the default category if you didn’t create additional MOH categories)
  4. Use the Browse button to select the file you want to upload
  5. Use the Volume Adjustment drop-down list box to select the volume level you want to use for the file
  6. Press the Upload button to upload the selected file to the UCX system

NOTE

The UCX system uses internally the following WAV file parameters:

  • PCM
  • 8000 Hz
  • 16-bit
  • Mono

    If you upload a WAV file with different parameters, the file will be automatically converted to the format specified above.

    The Volume Adjustment setting is applied during the upload of the file. It cannot be used to adjust the volume of any recording that is already uploaded and stored on the UCX. If you have a copy of the original recording, you can delete the file from the UCX and upload it again with a different Volume Adjustment setting.

    Do not use spaces or the "&" (ampersand) symbol as part of the file name.

  • Removing Music File

    You may want to remove existing music files used by the MOH feature (for example the default set of MOH files pre-installed on the UCX system).

    To remove music files from your UCX system, perform the following steps:

    1. From the PBX tab, select PBX Configuration
    2. From the left side column, select Music on Hold
    3. From the list of MOH categories on the right side, select the MOH category with the file you want to delete
    4. Press the red delete icon  beside the music file name to delete the file

    NOTE

    When removing MOH files from the default music category, you must always keep at least one file that is used as the default Music On Hold.

    Configuring Random Play

    For each music category, you can select if MOH files are to be played one after another or selected randomly.

    To enable/disable random selection of files for MOH playback, perform the following steps:

    1. From the PBX tab, select PBX Configuration
    2. From the left side column, select Music on Hold
    3. From the list of MOH categories on the right side, select a MOH category (the default category if you didn’t create additional MOH categories)
    4. Press the Enable Random Play button to enable random file selection (or Disable Random Play button to disable random file selection)

    Adding Streaming Category

    To add a streaming category, perform the following steps:

    1. From the PBX tab, select PBX Configuration
    2. From the left side column, select Music on Hold
    3. From the list of actions and categories on the right side, select Add Streaming Category
    4. In the Category Name field, enter the name for the new streaming category
    5. In the Stream location field, enter the HTTP address of the audio streaming site 
    6. Press the Submit Changes button to create the new category

    AddStreamingCategory.png

    The new category will now appear in the drop-down list for Music on Hold when you configure your inbound routes, outbound routes, queues, ring groups and conferences. 

    NOTE

    The audio bit stream must be compatible with mpg123 application, i.e. the supported audio formats are MPEG-1 and MPEG-2, layers 1, 2, and 3. The most common are MP3 files.

    Since the audio stream is coming from an external source, ensure proper configuration of the NAT traversal rules in your network.

    Adding Line-In Source

    The Line-In audio input allows an external device to be connected to the UCX Server for playing music on hold.

    Line-In source can be added via a streaming category using the following steps:

    1. From the PBX tab, select PBX Configuration
    2. From the left side column, select Music on Hold
    3. From the list of actions and categories on the right side, select Add Streaming Category
    4. In the Category Name field, enter LineIn (not case-sensitive)
    5. Leave the Stream location field empty (this field is ignored when the Line-In audio input is detected in the system)
    6. Press the Submit Changes button to create the new category

    The new LineIn category will now appear in the drop-down list for Music on Hold when you configure your inbound routes, outbound routes, queues, ring groups and conferences.

    NOTE

    This feature is available on the Galaxy Mini, the UCX250, and some older platforms.

    Galaxy Mini

    On the Galaxy Mini, the Line-In jack is the Red connector located on the Front Panel.
    GMIniMoHJack_0.png
    After the LineIn configuration has been applied, the UCX Administration page provides specific detail on which jack to use on the front of the Galaxy Mini.

    GMiniLineIn.png

    UCX250

    On the UCX250 the Line-In jack is the blue connector located on the rear panel.

    After the LineIn configuration has been applied, the UCX Administration page provides specific detail on which jack to use on the front of the UCX250.

    UCx250LineIn.png

    Older Platforms

    On older platforms, this feature is available only with the Light Blue Line-In connector.

    Contents