Alternate Source

Last Updated : Feb 11, 2025 |
Prolog information
Metadata
Keywords:
You can specify alternate MOH sources on the System SettingsSystemTelephonyTones and Music page.
You can assigned the alternate sources as the Hold Music Source for an Incoming Call Route or a Group.
  • That assigned MOH source overrides any current MOH source associated with the call.
  • The assigned MOH source remains associated with the call as it moves around the IP Office system. This is done using the number of the MOH source (with 1 being the number of the default system source).
  • If the call moves to another IP Office system in a multi-site network, the source with the same number of the other system is used if also configured on that system.

IP500 V2 Alternate Sources

For IP500 V2 systems, you can specify up to 3 alternate sources. Those different types of alternate source supported are:
Alternate Option
Description
WAV:<filename>
Play a specified file from its start or, if already in use, for where it is already playing.
  • The <filename> parameter specifies the file to play:
    • Up to 27 IA5 characters with no spaces.
    • Any file extension.
    • On Linux-base systems, the filename is case sensitive.
  • The file location is /system/primary.
  • When the source is activated, the playback resumes from where it left off last time, instead of starting every time from the beginning.
  • At any moment, all users listening to this source hear the same thing.
XTN:<extension>
Play the source connected to a analog extension port on a IP500 V2 systems.
  • You can set any analog extension with its Equipment Classification set as MOH Source as an alternate source.
  • The <extension> parameter specifies the analog extension's Base Extension number. For example: XTN:224

Linux-based IP Office system

For a Linux-based IP Office system, you can specify up to 31 alternate sources. The different types of alternate source are:
Alternate Option
Description
LINE:<X>,<Y>
Use an alternate source from another IP Office system in the network.
  • You specify the line source using two parameters:
    • <X> = The line number of the connection to the other Linux-based IP Office system (not the outgoing group ID).
    • <Y> = The MOH source number on the other Linux-based server.
      • WAVRST and WAVDIRRST alternate sources are not supported.
  • When the IP Office requires the source, it creates a VoIP call to the source IP Office system. This uses call capacity from the trunk and can be subject to CAC limits.
  • The IP Office drops calls to the source after 30 seconds of no use. You can change the time using the NoUser source number HOLD_MUSIC_TIMEOUT=x. x is the number of seconds. The range is 1 to 600 seconds.
USB:<n>
Play the music streamed by a USB sound device connected to the IP Office system.
  • The IP Office supported up to four USB sources. Not supported on virtual IP Office systems.
  • <n> is the logical USB device number.
    • USB:1 is the first source found. This IP Office automatically uses this as the System Source when that is set to External.
    • Linux servers number additional devices sequentially. For example; USB:1, USB:2, and so on.
  • The IP Office auto-configures itself as follows:
    • It selects Line input and sets the volume close to maximum.
    • If it cannot identify a line input, it uses the microphone input.
  • External USB sound devices are hot-pluggable. However, you must take care when adding or removing USB sound cards, as this can change the logical number of the device.
    • When an USB MOH source is unavailable, the default MOH tone is played instead.
WAV:<filename>
Play a specified file from its start or, if already in use, for where it is already playing.
  • The <filename> parameter specifies the name of the file to played:
    • Up to 27 IA5 characters with no spaces.
    • Any file extension.
    • On Linux-base systems, the filename is case sensitive.
  • The file location is opt/ipoffice/system/primary.
  • When the source is used, playback resumes from where it left off last time, instead of starting from the beginning.
  • At any moment, all users listening to this source hear the same thing.
WAVRST:<file>
Play a specified file, beginning from its start for each caller.
  • Operates similarly to WAV:<filename> above, but for each caller, playback starts from the beginning.
WAVDIR:
Play the files located in the IP Office system's mohwavdir directory.
  • The directory used /disk/tones/mohwavdir (file manager access).
  • Supports up to 255 files. Each file up to 10 minutes.
  • The files are played in filename order (numerical, lower case, then upper case).
  • At any moment, all users listening to the source hear the same thing.
  • Only one WAVDIR: or WAVDIRRST: entry is supported on an IP Office system.
WAVDIRRST:
Play the files located in the IP Office system's mohwavdir directory, restarting from the first file for each caller.
  • Operates similarly to WAVDIR: above, but for each caller playback starts from the beginning of the first file in the folder.
  • Only one WAVDIR: or WAVDIRRST: entry is supported on an IP Office system.
Related links
Music On Hold