- Log in to the system administration
- Navigate to 'Home' > 'Tenant' > 'System' > 'Music on Hold'
¶ Changing Music On Hold on a Tenant Level
Music on Hold Class allows users to have a class of files (multiple sound files) that would be played in a specific order.
¶ Adding a new MoH Class
To set up configuration, please navigate to the ‘Classes’ section and proceed with the following:
-
Click the ‘Add MOH Class’ button
-
Populate the following fields:
- Class Name
Enter a desired Class name
(E.g. Test)
- Stream URL
Enter the stream URL to be placed as MoH
NOTE: This is optional.
- Status
Set the Status to 'ON'
- Sort files
In case you have multiple sound files assigned to MoH class, you can select the order in which you would like these sound files to be played.
You can choose between the following two options:
- Alphabetically – Files inside the selected MoH Class will be played in the alphabetical order.
- Randomly - Files inside the selected MoH Class will be played in the random order.
¶ Adding a New Recording
To set up configuration, please navigate to the ‘Content’ section and proceed with the following:
1. Click the ‘Add New Record’ button
2. Populate the following fields:
- Clip Name
Set 'Clip Name' as desired
(E.g. Test)
- File
Upload a file
NOTE: Please note that the compatible format for sound files is: 8Khz, Mono, 16-Bit PCM.
You can use any online free converter for this conversion (e.g. https://g711.org/). When uploading file from the GUI, it must be in .wav or .mp3 format.
- Class
Select the desired class
(E.g. default)
- Status
Set the Status to 'ON'
When creating a Tenant, every Destination on that Tenant will have the ‘default’ Music on Hold by default. Music on Hold can be changed on a Destination level.
For an Extension, please navigate to:
‘Tenant' -> 'Extensions' -> 'Advanced options' -> under the 'General' section -> 'Music on Hold’
From the drop-down menu, select a preferred MoH class.
NOTE: Users can find the same Settings on the Master Tenant level. However, please note that when adding a MoH class to Master Tenant, it will not be added to Slave Tenants.
¶ Changing Default Music on Hold on a System Level
To change Default Music on Hold on a System Level that would be applied to every newly created Tenant, users need to change the Default Music on Hold Class.
To change the Default MoH class:
- SSH to the system by entering the following command:
ssh root@IP-ADDRESS-OF-THE-SYSTEM -p2020
Password: enter your user password
(e.g. ssh [email protected] -p2020)
- Create a folder named tenant-default and change its ownership:
mkdir tenant-default chown 555:555 tenant-default
- After creating the folder, users have to upload the sound file they would like to use as their new default MoH when creating a new Tenant.
NOTE: When uploading a sound file from the backend, it needs to in an acceptable format for sound files, such as 8Khz, Mono, 16-Bit PCM. Users can use any online free converter for this conversion (e.g. https://g711.org/). It must be in the .gsm format.
Once the File is converted to .gsm, please upload it to a created tenant-default folder:
/opt/pbxware/pw/var/lib/asterisk/sounds/tenant-default/
After uploading the file to the designated folder, users must also change file ownership and permissions for it.
- Enter the tenant-default folder:
cd /opt/pbxware/pw/var/lib/asterisk/sounds/tenant-default/
- Change ownership of the uploaded default.gsm file:
chown 555:555 default.gsm
- Change the mode of the uploaded default.gsm file:
chmod 644 default.gsm
Once this is completed, every Tenant that is created afterwards should have a new MoH file used as default MoH.
NOTE: Please note that this action does not affect the existing Tenants. For each existing Tenant, users would need to manually change the default Class for its Destinations.
¶ Adding MoH as a Ringtone
MoH can be set as a ringtone on Extensions, Ring Groups. For a Ring Group, it can be changed under 'Advanced Options'.
In order to set up configuration successfully, please do the following:
-
Navigate to 'Extensions' -> 'Ring Groups'
-
Click the 'Show Advanced Options'
-
Navigate to the 'Dial Options' field
NOTE: To play music to ring group callers, please set this field to 'm(tenant-number-$CLASS)', where m = MOH class e.g. m('m-150-default'), (150-tenant number).