THIS WIKI HAS BEEN UPDATED FOR VERSION 13 OF YOUR PBX GUI
Overview
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
Click the Settings tab.
Settings
A
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
B
backupdeleted
Number of deleted messages saved per mailbox (can be a number or yes/no, yes meaning MAXMSG, no meaning 0).
C
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.
D
dialout
Context to dial out from [option 4 from the advanced menu] if not listed, dialing out will not be permitted.
E
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.
emailsubject
Email subject. Default = "PBX Voicemail Notification"
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.
externnotify
External Voicemail notify application. Default = "/var/lib/asterisk/agi-bin/vmnotify-newvm.php"
externpass
External password changing command (overrides externpassnotify).
externpassnotify
Command specified runs after a user changes his password.
F
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"
G
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.
I
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
L
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
M
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
N
nextaftercmd
Skip to the next message after save/delete. Default = No
O
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
P
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
R
review
Allow sender to review/rerecord their message before saving it. Default = No
S
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
smdienable
Enable Simple Message Desk Interface (SMDI) integration
smdiport
Valid port as specified in smdi.conf for using smdi for external notification.
T
tempgreetwarn
Temporary greeting reminder. Default = yes
U
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"
V
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.