The "Voicemail Admin Module" allows you to make changes to the default voicemail settings used by the system, and to make changes to voicemail settings for each individual user.
It also allows you to view statistics about the voicemail system on a global or per user basis, and to delete files relating to voicemail on a global or per user basis.
It also allows you to define timezone definitions for use by the voicemail system.
The "Voicemail Admin Module" is related to the Extensions Module, because it sets certain defaults that are used in the Voicemail section of the Extensions Module Module, and because it allows you to set individual settings and view individual statistics for extensions that have been defined on your system in the Extensions module. If you make a change to a setting for a particular extension in this module, that change will appear in the Voicemail section of the Extensions module for that extension, either in the pre-set fields or in the "VM Options" field
Login
From the top menu click Settings, then from the drop down click Voicemail Admin
Voicemail Admin Settings
These settings are for advanced use cases. In most cases, the defaults will work. These should not be touched unless you know what you are doing.
Login
In the top menu click Settings, In the Dropdown click Voicemail Admin then click the Settings tab.
adsifdn - The ADSI feature descriptor number to download to
adsisec - The ADSI security lock code
adsiver - The ADSI voicemail application version number
attach - Attach the voicemail to email
authpassword - IMAP server master password
authuser - IMAP server master username
backupdeleted - Number of deleted messages saved per mailbox (can be a number or yes/no, yes meaning MAXMSG, no meaning 0).
callback - Context to call back from; if not listed, calling the sender back will not be permitted.
charset - The character set for voicemail messages
cidinternalcontexts - Comma separated list of internal contexts to use caller ID.
dialout - Context to dial out from [option 4 from the advanced menu] if not listed, dialing out will not be permitted.
emailbody - Change the email body. Variables:
VM_NAME
VM_DUR
VM_MSGNUM
VM_MAILBOX
VM_CALLERID
VM_DATE
emaildateformat - Load date format config for Voicemail mail.
envelope - Whether to play back envelope information before message playback. Default = yes. This does NOT affect option 3,3 from the advanced options menu.
exitcontext - Context to check for handling * or 0 calls to operator. "Operator Context"
expungeonhangup - Expunge (mark messages for deletion) on hangup/exit.
externpassnotify - Command specified runs after a user changes his password.
forcegreetings - Force new user to record greetings (the same as forcename, except for recording greetings). Default = No.
forcename - Force a new user to record their name. A new user is determined by the password being the same as the mailbox number. Default = yes.
format - Formats for writing voicemail. Note that when using IMAP storage for Voicemail, only the first format specified will be used.
The format setting selects audio file format(s) to use when storing voice mail messages. The value is a string defining the audio format(s) of the message file. The default format string is wav49|gsm|wav , meaning that Asterisk will save the voicemail message in all three supported formats. When emailing the attachment, however, it will send only the first of the formats defined here. When playing back (as with all file playback) Asterisk will attempt to use the optimum format based on the codec used for the current channel, in order to provide the best sound quality and to reduce transcoding processing time.
wav49: In this format, the file size will be small, the quality good, and it's a good choice for sending voicemail messages in email. The file will have a .WAV extension, which all Windows users should have no problems with, and users on other platforms should also be able to easily play these sound files.
gsm: Voicemail saved in this format will have about the same file size and same audio quality as wav49. It may be less well supported by client operating systems if sent to users in email, however.
wav: This is an uncompressed sound format with a .wav extension, so the file size is very large. Sound quality will be great, but you probably don't want to email it, and you must have adequate disk space.
g723sf: The sample voicemail.conf file has this option commented out. If you try to activate it, you will find that it doesn't work.
If you're running Asterisk on Mac OS X, which has a case-preserving but case-insensitive file system, you can use .wav but you won't be able to use .WAV(wav49). Asterisk tries to pick the best file in the Playback command based on the encoding of your channel, and then looks for the file by file type in a specific order. In either case, asterisk will look for filename.wav, and if there is a filename.WAV, the file lookup will succeed. Asterisk will then try to play the file as "wav", and choke on the format. This is especially noticeable in voicemail. If you have both wav49 and wav in the format= option, one will replace the other. You must remove wav49 from the format= option in voicemail.conf.
fromstring - From: string for email. Default = "PBX Voicemail"
greetingsfolder - If imapgreetings=yes, then specify which folder to store your greetings in. If you do not specify a folder, then INBOX will be used.
imapclosetimeout - For IMAP storage
imapflags - IMAP server flags. Specify any IMAP flags needed here ("notls" for example).
imapgreetings - If using IMAP storage, specify whether voicemail greetings should be stored via IMAP. If no, then greetings are stored as if IMAP storage were not enabled.
imapopentimeout - For IMAP storage - TCP open timeout in seconds
imapparentfolder - Set the parent folder (default is to have no parent folder set).
imapserver - IMAP server address (IP Address or Hostname)
imapwritetimeout - For IMAP storage - TCP write timeout in seconds
listen-control-forward-key - Customize the key that fast-forwards message playback
listen-control-pause-key - Customize the key that pauses/un-pauses message playback
listen-control-restart-key - Customize the key that restarts message playback
listen-control-reverse-key - Customize the key that rewinds message playback
listen-control-stop-key - Customize the key that stops message playback
mailcmd - Mail command
maxgreet - Max message greeting length
maxlogins - Maximum failed login attempts
maxmessage - Maximum message time length (in seconds). Default = 300
maxmsg - Maximum number of messages per folder. If not specified, a default value (100) is used. Maximum value for this option is 9999.
minpassword - Minimum character (digit) count for passwords. This password length will be enforced.
maxsecs - Maximum message time length (in seconds). Default = 300
maxsilence - How many seconds of silence before we end the recording
minsecs - Min message time length – maxsilence should be less than minsecs, or you may get empty messages.
moveheard - Move heard messages to the "Old" folder automatically. Default = No
nextaftercmd - Skip to the next message after save/delete. Default = No
obdcstorage - The value of odbcstorage is the database connection configured in res_odbc.conf.
odbctable - The default table for ODBC Voicemail storage is voicemessages.
operator - Operator break. Allow sender to hit 0 before/after/during leaving a voicemail to reach an operator. Default = yes
pagerbody - Body of message sent to pager
pagerfromstring - From: string sent to pager
pagersubject - Subject sent to pager
pbxskip - Skip the "[PBX]:" string from the message title. Default = No
pollfreq - If the "pollmailboxes" option is enabled, this option sets the polling frequency in seconds. Default = 30
pollmailboxes - Whether to poll mailboxes for MWI (message waiting indicator). If mailboxes are changed anywhere outside of app_voicemail, then this option must be enabled for MWI to work. This enables polling mailboxes for changes. Normally, it will expect that changes are only made when someone called in to one of the Voicemail applications. Examples of situations that would require this option are web interfaces to Voicemail or an email client in the case of using IMAP storage. Default = yes
review - Allow sender to review/rerecord their message before saving it. Default = No
saycid - Read back caller's telephone number prior to playing the incoming message, and just after announcing the date and time the message was left. If not described, or set to no, it will be in the envelope. Default = No
sayduration - Say duration information before message playback Default = Yes
saydurationm - The minimum message length (in minutes) required in order to trigger the system to say the message duration. Specify in minutes the minimum duration to say. Default = 2
searchcontexts - Search all contexts instead of the current context (if one is not specified). Default = No
sendvoicemail - Send voicemail message. If not listed, sending messages from inside voicemail will not be permitted. Default = yes
serveremail - Who the e-mail notification should appear to come from
silencethreshold - Silence threshold (what we consider silence: the lower, the more sensitive)
skipms - How many milliseconds to skip forward/back when rewinding/fast-forwarding in message playback
usedirectory - Permit finding entries for forward/compose from the directory. Default = yes
userscontext - User context is where entries from users.conf are registered. Default value = "default"
vm-mismatch - Customize which sound file is used instead of the default prompt that says: "The passwords you entered and re-entered did not match. Please try again."
vm-newpassword - Customize which sound file is used instead of the default prompt that says: "Please enter your new password followed by the pound key."
vm-passchanged - Customize which sound file is used instead of the default prompt that says: "Your password has been changed."
vm-password - Customize which sound file is used instead of the default prompt that says: "password"
vm-reenterpassword - Customize which sound file is used instead of the default prompt that says: "Please re-enter your password followed by the pound key"
volgain - Emails bearing the voicemail may arrive in a volume too quiet to be heard. This parameter allows you to specify how much gain to add to the message when sending a Voicemail. NOTE: sox must be installed for this option to work.
Voicemail Admin Dialplan Behaviour
These settings are for advanced use cases. In most cases the defaults will work. These should not be touched unless you know what you are doing.
Logging in
In the top menu click Settings, In the Dropdown click Voicemail Admin then select the Dialplan Behavior tab
General Dialplan Settings
Disable Standard Prompt - Yes/No - Whether to disable the standard voicemail instructions that follow the user-recorded message. These standard instructions tell the caller to leave a message after the beep. This can be individually controlled for users who have VMX locater enabled.
Direct Dial Mode - Unavailable/Busy/No Message - Whether to play the busy message, the unavailable message, or no message when direct dialing voicemail.
Voicemail Recording Gain - The amount of gain to amplify a voicemail message when being recorded. You may need to increase this if users are complaining about messages on your system being hard to hear. The gain is in Decibels, which doubles the volume for every 3 db.
Operator Extension - Default number to dial when a voicemail user "zeros out" (if enabled) - in other words, the user will be sent to this destination when they press "0" from within the voicemail system. This destination can be any number, including an external number. There is NO VALIDATION, so it should be tested after configuration. Note: This default will be overridden by any VMX Locater "0" option you set for an extension. The VMX Locater option is used even when VMX Locater is not enabled.
Advanced VmX Locater Settings
Msg Timeout - Time to wait after message has played to timeout and/or repeat the message if no entry pressed. Default = 2 seconds.
Times to Play Message - Number of times to play the recorded message if the caller does not press any options and it times out. One attempt means we won't repeat it, and it will be treated as a timeout. A timeout would be the normal behavior. It is fairly common to leave this at zero and play a message telling callers to press an option, letting them know that they will otherwise go to voicemail.
Error Re-tries - Number of times to play invalid options and repeat the message upon receiving an undefined option. One retry means it will repeat at one time after the intial failure.
Disable Standard Prompt after Max Loops - If the Max Loops are reached and the call goes to voicemail, setting this to Yes will disable the standard voicemail prompt that follows the user's recorded greeting. This default can be overriden with a unique ..vmx/vmxopts/loops AstDB entry for the given mode (busy/unavail) and user.
Disable Standard Prompt on 'dovm' Extension - If the special advanced extension of 'dovm' is used, setting this to Yes will disable the standard voicemail prompt prompt that follows the user's recorded greeting. This default can be overridden with a unique ..vmx/vmxopts/dovm AstDB entry for the given mode (busy/unavail) and user.
Voicemail Admin Timezone Definitions
Login
In the top menu click Settings, In the Dropdown click Voicemail Admin then click the Timezone Definitions tab.
New Name - Descriptive name for time zone definition
New Timezone Definition - Time announcement for message playback. Timezone definition format is: timezone|values
Timezones - select a time world timezone - Your system's timezones are available in /usr/share/zoneinfo/
Values - select a value - The values supported in the timezone definition string include:
'filename' The name of a sound file (the file name must be single-quoted)
variable A variable to be substituted (see below for supported variable values)
Supported variables:
A or a Day of week (Saturday, Sunday, ...)
B or b or h Month name (January, February, ...)
d or e numeric day of month (first, second, ..., thirty-first)
Y Year
I or l Hour, 12 hour clock
H Hour, 24 hour clock (single digit hours preceded by "oh")
k Hour, 24 hour clock (single digit hours NOT preceded by "oh")
M Minute, with 00 pronounced as "o'clock"
N Minute, with 00 pronounced as "hundred" (US military time)
