etc-asterisk/voicemail.conf

   1 ;
   2 ; Voicemail Configuration
   3 ;
   4
   5 ;
   6 ; NOTE: Asterisk has to edit this file to change a user's password.  This does
   7 ; not currently work with the "#include <file>" directive for Asterisk
   8 ; configuration files, nor when using realtime static configuration.
   9 ; Do not use them with this configuration file.
  10 ;
  11
  12 [general]
  13 ; Formats for writing Voicemail.  Note that when using IMAP storage for
  14 ; voicemail, only the first format specified will be used.
  15 ;format=g723sf|wav49|wav
  16 format=gsm
  17 ;
  18 ; WARNING:
  19 ; If you change the list of formats that you record voicemail in
  20 ; when you have mailboxes that contain messages, you _MUST_ absolutely
  21 ; manually go through those mailboxes and convert/delete/add the
  22 ; the message files so that they appear to have been stored using
  23 ; your new format list. If you don't do this, very unpleasant
  24 ; things may happen to your users while they are retrieving and
  25 ; manipulating their voicemail.
  26 ;
  27 ; In other words: don't change the format list on a production system
  28 ; unless you are _VERY_  sure that you know what you are doing and are
  29 ; prepared for the consequences.
  30 ;
  31 ; Who the e-mail notification should appear to come from
  32 serveremail=assistance-informatique@auf.org
  33 ;serveremail=asterisk@linux-support.net
  34 ; Should the email contain the voicemail as an attachment
  35 attach=no
  36 ; Maximum number of messages per folder.  If not specified, a default value
  37 ; (100) is used.  Maximum value for this option is 9999.  If set to 0, a
  38 ; mailbox will be greetings-only.
  39 maxmsg=100
  40 ; Maximum length of a voicemail message in seconds
  41 maxsecs=240
  42 ; Minimum length of a voicemail message in seconds for the message to be kept
  43 ; The default is no minimum.
  44 ; minsecs=3
  45 ; Maximum length of greetings in seconds
  46 maxgreet=120
  47 ; How many milliseconds to skip forward/back when rew/ff in message playback
  48 skipms=3000
  49 ; How many seconds of silence before we end the recording
  50 maxsilence=10
  51 ; Silence threshold (what we consider silence: the lower, the more sensitive)
  52 silencethreshold=128
  53 ; Max number of failed login attempts
  54 maxlogins=3
  55 ;
  56 ; Move heard messages to the 'Old' folder automagically.  Defaults to on.
  57 ;moveheard=yes
  58 ;
  59 ; Forward an urgent message as an urgent message.  Defaults to no so
  60 ; sender can set the urgency on the envelope of the forwarded message.
  61 ;forward_urgent_auto=no
  62 ;
  63 ; User context is where entries from users.conf are registered.  The
  64 ; default value is 'default'
  65 ;
  66 ;userscontext=default
  67 ;
  68 ; If you need to have an external program, i.e. /usr/bin/myapp
  69 ; called when a voicemail is left, delivered, or your voicemailbox
  70 ; is checked, uncomment this.
  71 ;externnotify=/usr/bin/myapp
  72
  73 ; If you would also like to enable SMDI notification then set smdienable to yes.
  74 ; You will also need to make sure smdiport is set to a valid port as specified in
  75 ; smdi.conf.
  76 ;smdienable=yes
  77 ;smdiport=/dev/ttyS0
  78
  79 ; If you need to have an external program, i.e. /usr/bin/myapp
  80 ; called when a voicemail password is changed, uncomment this. The
  81 ; arguments passed to the application are: <context> <mailbox> <newpassword>
  82 ; Note: If this is set, the password will NOT be changed in voicemail.conf
  83 ; If you would like to also change the password in voicemail.conf, use
  84 ; the externpassnotify option below instead.
  85 ;externpass=/usr/bin/myapp
  86 ;externpassnotify=/usr/bin/myapp
  87
  88 ; If you would like to have an external program called when a user changes the
  89 ; voicemail password for the purpose of doing validation on the new password,
  90 ; then use this option.  The script can decide whether or not the new password
  91 ; meets minimum password strength requirements before the Voicemail application
  92 ; accepts the password.  If the script decides that the password is not acceptable,
  93 ; the user will be informed that the new password does not meet minimum password
  94 ; requirements, and they will be asked to enter another password.
  95 ;
  96 ; The arguments passed to this script are <mailbox> <context> <old pw> <new pw>.
  97 ;
  98 ; The script should print "VALID" to stdout to indicate that the new password
  99 ; is acceptable.  If the password is considered too weak, the script should print
 100 ; "INVALID" to stdout.
 101 ;
 102 ; There is an example script in the contrib/scripts/ directory, voicemailpwcheck.py,
 103 ; which implements some basic password checking, and can be used as a starting point
 104 ; for use with this option.
 105 ;
 106 ;externpasscheck=/usr/local/bin/voicemailpwcheck.py
 107
 108 ; For the directory, you can override the intro file if you want
 109 ;directoryintro=dir-intro
 110 ; The character set for voicemail messages can be specified here
 111 ; default: ISO-8859-1
 112 charset=UTF-8
 113 ; The ADSI feature descriptor number to download to
 114 ;adsifdn=0000000F
 115 ; The ADSI security lock code
 116 ;adsisec=9BDBF7AC
 117 ; The ADSI voicemail application version number.
 118 ;adsiver=1
 119 ; Skip the "[PBX]:" string from the message title
 120 pbxskip=yes
 121 ; Change the From: string
 122 fromstring=Systeme VoIP
 123 ; Permit finding entries for forward/compose from the directory
 124 ;usedirectory=yes
 125 ; Voicemail can be stored in a database using the ODBC driver.
 126 ; The value of odbcstorage is the database connection configured
 127 ; in res_odbc.conf.
 128 ;odbcstorage=asterisk
 129 ; The default table for ODBC voicemail storage is voicemessages.
 130 ;odbctable=voicemessages
 131 ;
 132 ; Change the from, body and/or subject, variables:
 133 ;     VM_NAME, VM_DUR, VM_MSGNUM, VM_MAILBOX, VM_CALLERID, VM_CIDNUM,
 134 ;     VM_CIDNAME, VM_DATE
 135 ; Additionally, on forwarded messages, you have the variables:
 136 ;     ORIG_VM_CALLERID, ORIG_VM_CIDNUM, ORIG_VM_CIDNAME, ORIG_VM_DATE
 137 ; You can select between two variables by using dialplan functions, e.g.
 138 ;     ${IF(${ISNULL(${ORIG_VM_DATE})}?${VM_DATE}:${ORIG_VM_DATE})}
 139 ;
 140 ; Note: The emailbody config row can only be up to 512 characters due to a
 141 ;       limitation in the Asterisk configuration subsystem.
 142 ;emailsubject=[PBX]: New message ${VM_MSGNUM} in mailbox ${VM_MAILBOX}
 143 emailsubject=[BoiteVocale ${VM_MAILBOX}] Nouveau message ${VM_MSGNUM} dans la boite vocale ${VM_MAILBOX}
 144
 145 ; The following definition is very close to the default, but the default shows
 146 ; just the CIDNAME, if it is not null, otherwise just the CIDNUM, or "an unknown
 147 ; caller", if they are both null.
 148 ;emailbody=Dear ${VM_NAME}:\n\n\tjust wanted to let you know you were just left a ${VM_DUR} long message (number ${VM_MSGNUM})\nin mailbox ${VM_MAILBOX} from ${VM_CALLERID}, on ${VM_DATE}, so you might\nwant to check it when you get a chance.  Thanks!\n\n\t\t\t\t--Asterisk\n
 149
 150 emailbody=\nCher-ère ${VM_NAME},\n\nNous vous informons qu'un message vient d'être ajouté dans\nvotre messagerie vocale ${VM_MAILBOX}.\n\n\tExpéditeur : ${VM_CALLERID} (${VM_CIDNUM})\n\tDate : ${VM_DATE}\n\tDurée : ${VM_DUR}\n\tNuméro du message : ${VM_MSGNUM}\n\nPour consulter votre messagerie vocale, composez *66\n\n--\nSystème Voix-sur-IP de l'AUF <assistance-informatique@auf.org>\n
 151
 152 ;
 153 ; Note: ${IF()} strips spacing at the beginning and end of its true and false
 154 ; values, so a newline cannot be placed at either location.  The word 'so' is
 155 ; therefore duplicated, in order for the newline to be interpreted correctly.
 156 ;emailbody=Dear ${VM_NAME}:\n\n\tjust wanted to let you know you were just ${IF($["${VM_CIDNUM}" = "${ORIG_VM_CIDNUM}"]?left:forwarded)} a ${VM_DUR} long message (number ${VM_MSGNUM})\nin mailbox ${VM_MAILBOX} from ${VM_CALLERID}, on ${VM_DATE},\n${IF($["${VM_CIDNUM}" = "${ORIG_VM_CIDNUM}"]?so:(originally sent by ${ORIG_VM_CALLERID} on ${ORIG_VM_DATE})\nso)} you might want to check it when you get a chance.  Thanks!\n\n\t\t\t\t--Asterisk\n
 157 ;
 158 ; You can also change the Pager From: string, the pager body and/or subject.
 159 ; The above defined variables also can be used here
 160 ;pagerfromstring=The Asterisk PBX
 161 ;pagersubject=New VM
 162 ;pagerbody=New ${VM_DUR} long msg in box ${VM_MAILBOX}\nfrom ${VM_CALLERID}, on ${VM_DATE}
 163 ;
 164 ; Set the date format on outgoing mails. Valid arguments can be found on the
 165 ; strftime(3) man page
 166 ;
 167 ; Default
 168 ; emaildateformat=%A, %B %d, %Y at %r
 169 ; 24h date format
 170 ;emaildateformat=%A, %d %B %Y at %H:%M:%S
 171 emaildateformat = le %A, %d %B %Y à %H:%M:%S
 172 ;
 173 ; Default for pager use
 174 ; pagerdateformat=%A, %B %d, %Y at %r
 175 pagerdateformat=le %d %B %Y à %H:%M:%S
 176 ; Short 24h date format for pager use
 177 ;pagerdateformat=%T %D
 178 ;
 179 ; You can override the default program to send e-mail if you wish, too
 180 ;
 181 ;mailcmd=/usr/sbin/sendmail -t
 182 ;
 183 ;pollmailboxes=no    ;   If mailboxes are changed anywhere outside of app_voicemail,
 184 ;                    ; then this option must be enabled for MWI to work.  This
 185 ;                    ; enables polling mailboxes for changes.  Normally, it will
 186 ;                    ; expect that changes are only made when someone called in
 187 ;                    ; to one of the voicemail applications.
 188 ;                    ;   Examples of situations that would require this option are
 189 ;                    ; web interfaces to voicemail or an email client in the case
 190 ;                    ; of using IMAP storage.
 191 ;                    ; Default: no
 192 ;pollfreq=30         ;   If the "pollmailboxes" option is enabled, this option
 193 ;                    ; sets the polling frequency.  The default is once every
 194 ;                    ; 30 seconds.
 195 ; If using IMAP storage, specify whether voicemail greetings should be stored
 196 ; via IMAP. If no, then greetings are stored as if IMAP storage were not enabled
 197 ;imapgreetings=no
 198 ; If imapgreetings=yes, then specify which folder to store your greetings in. If
 199 ; you do not specify a folder, then INBOX will be used
 200 ;greetingsfolder=INBOX
 201 ; Some IMAP server implementations store folders under INBOX instead of
 202 ; using a top level folder (ex. INBOX/Friends).  In this case, user
 203 ; imapparentfolder to set the parent folder. For example, Cyrus IMAP does
 204 ; NOT use INBOX as the parent. Default is to have no parent folder set.
 205 ;imapparentfolder=INBOX
 206 ;
 207 ;
 208 ;
 209 ; Each mailbox is listed in the form <mailbox>=<password>,<name>,<email>,<pager_email>,<options>
 210 ; if the e-mail is specified, a message will be sent when a message is
 211 ; received, to the given mailbox. If pager is specified, a message will be
 212 ; sent there as well. If the password is prefixed by '-', then it is
 213 ; considered to be unchangeable.
 214 ;
 215 ; Advanced options example is extension 4069
 216 ; NOTE: All options can be expressed globally in the general section, and
 217 ; overridden in the per-mailbox settings, unless listed otherwise.
 218 ;
 219 ; tz=central            ; Timezone from zonemessages below. Irrelevant if envelope=no.
 220 ; locale=de_DE.UTF-8    ; set the locale for generation of the date/time strings (make
 221                         ; sure the locales are installed in your operating system; e.g
 222                         ; on Debian Linux you can use "dpkg-reconfigure locales").
 223                         ; If you use UTF-8 locales, make sure to set the "charset" option
 224                         ; to UTF-8 too. If you mix different locales for different users
 225                         ; you should avoid words in the emaildateformat specification, e.g.:
 226                         ; emaildateformat=%A, %d %B %Y, %H:%M:%S
 227 ; attach=yes            ; Attach the voicemail to the notification email *NOT* the pager email
 228 ; attachfmt=wav49       ; Which format to attach to the email.  Normally this is the
 229                         ; first format specified in the format parameter above, but this
 230                         ; option lets you customize the format sent to particular mailboxes.
 231                         ; Useful if Windows users want wav49, but Linux users want gsm.
 232                         ; [per-mailbox only]
 233 ; saycid=yes            ; Say the caller id information before the message. If not described,
 234                         ;     or set to no, it will be in the envelope
 235 ; cidinternalcontexts=intern    ; Internal Context for Name Playback instead of
 236                         ; extension digits when saying caller id.
 237 ; sayduration=no        ; Turn on/off the duration information before the message. [ON by default]
 238 ; saydurationm=2        ; Specify the minimum duration to say. Default is 2 minutes
 239 ; dialout=fromvm ; Context to dial out from [option 4 from mailbox's advanced menu].
 240                  ; If not specified, option 4 will not be listed and dialing out
 241                  ; from within VoiceMailMain() will not be permitted.
 242 sendvoicemail=yes ; Allow the user to compose and send a voicemail while inside
 243                   ; VoiceMailMain() [option 5 from mailbox's advanced menu].
 244                   ; If set to 'no', option 5 will not be listed.
 245 ; searchcontexts=yes    ; Current default behavior is to search only the default context
 246                         ; if one is not specified.  The older behavior was to search all contexts.
 247                         ; This option restores the old behavior [DEFAULT=no]
 248                         ; Note: If you have this option enabled, then you will be required to have
 249                         ; unique mailbox names across all contexts. Otherwise, an ambiguity is created
 250                         ; since it is impossible to know which mailbox to retrieve when one is requested.
 251 callback=fromvm         ; Context to call back from
 252                         ;     if not listed, calling the sender back will not be permitted
 253 ; exitcontext=fromvm    ; Context to go to on user exit such as * or 0
 254                         ;     The default is the current context.
 255 ; review=yes            ; Allow sender to review/rerecord their message before saving it [OFF by default
 256 ; operator=yes      ; Allow sender to hit 0 before/after/during leaving a voicemail to
 257                     ; reach an operator.  This option REQUIRES an 'o' extension in the
 258                     ; same context (or in exitcontext, if set), as that is where the
 259                     ; 0 key will send you.  [OFF by default]
 260 ; envelope=no           ; Turn on/off envelope playback before message playback. [ON by default]
 261                         ;     This does NOT affect option 3,3 from the advanced options menu
 262 ; delete=yes            ; After notification, the voicemail is deleted from the server. [per-mailbox only]
 263                         ;     This is intended for use with users who wish to receive their
 264                         ;     voicemail ONLY by email. Note:  "deletevoicemail" is provided as an
 265                         ;     equivalent option for Realtime configuration.
 266 ; volgain=0.0           ; Emails bearing the voicemail may arrive in a volume too
 267                         ;     quiet to be heard.  This parameter allows you to specify how
 268                         ;     much gain to add to the message when sending a voicemail.
 269                         ;     NOTE: sox must be installed for this option to work.
 270 ; nextaftercmd=yes      ; Skips to the next message after hitting 7 or 9 to delete/save current message.
 271 ; forcename=yes         ; Forces a new user to record their name.  A new user is
 272                         ;     determined by the password being the same as
 273                         ;     the mailbox number.  The default is "no".
 274 ; forcegreetings=no     ; This is the same as forcename, except for recording
 275                         ;     greetings.  The default is "no".
 276 ; hidefromdir=yes       ; Hide this mailbox from the directory produced by app_directory
 277                         ;     The default is "no".
 278 ; tempgreetwarn=yes     ; Remind the user that their temporary greeting is set
 279
 280 ; passwordlocation=spooldir
 281                     ; Usually the voicemail password (vmsecret) is stored in
 282                     ; this configuration file.  By setting this option you can
 283                     ; specify where Asterisk should read/write the vmsecret.
 284                     ; Supported options:
 285                     ;   voicemail.conf:
 286                     ;     This is the default option.  The secret is read from
 287                     ;     and written to voicemail.conf (or users.conf).
 288                     ;   spooldir:
 289                     ;     The secret is stored in a separate file in the user's
 290                     ;     voicemail spool directory in a file named secret.conf.
 291                     ;     Please ensure that normal Linux users are not
 292                     ;     permitted to access Asterisk's spool directory as the
 293                     ;     secret is stored in plain text.  If a secret is not
 294                     ;     found in this directory, the password in
 295                     ;     voicemail.conf (or users.conf) will be used.
 296                     ; Note that this option does not affect password storage for
 297                     ; realtime users, which are still stored in the realtime
 298                     ; backend.
 299 ; messagewrap=no    ; Enable next/last message to wrap around to
 300                     ; first (from last) and last (from first) message
 301                     ; The default is "no".
 302 ; minpassword=0 ; Enforce minimum password length
 303
 304 ; vm-password=custom_sound
 305                         ;     Customize which sound file is used instead of the default
 306                         ;     prompt that says: "password"
 307 ; vm-newpassword=custom_sound
 308                         ;     Customize which sound file is used instead of the default
 309                         ;     prompt that says: "Please enter your new password followed by
 310                         ;     the pound key."
 311 ; vm-passchanged=custom_sound
 312                         ;     Customize which sound file is used instead of the default
 313                         ;     prompt that says: "Your password has been changed."
 314 ; vm-reenterpassword=custom_sound
 315                         ;     Customize which sound file is used instead of the default
 316                         ;     prompt that says: "Please re-enter your password followed by
 317                         ;     the pound key"
 318 ; vm-mismatch=custom_sound
 319                         ;     Customize which sound file is used instead of the default
 320                         ;     prompt that says: "The passwords you entered and re-entered
 321                         ;     did not match."
 322 ; vm-invalid-password=custom_sound
 323                         ;     Customize which sound file is used instead of the default
 324                         ;     prompt that says: ...
 325 ; vm-pls-try-again=custom_sound
 326                         ; Customize which sound file is used instead of the
 327                         ; default prompt that says "Please try again."
 328 ; vm-prepend-timeout=custom_sound
 329                         ; Customize which sound file is used when the user
 330                         ; times out while recording a prepend message instead
 331                         ; of the default prompt that says "then press pound"
 332                         ; note that this will currently follow vm-pls-try-again.
 333                         ; this behavior is subject to change in the near future.
 334 ; listen-control-forward-key=#  ; Customize the key that fast-forwards message playback
 335 ; listen-control-reverse-key=*  ; Customize the key that rewinds message playback
 336 ; listen-control-pause-key=0    ; Customize the key that pauses/unpauses message playback
 337 ; listen-control-restart-key=2  ; Customize the key that restarts message playback
 338 ; listen-control-stop-key=13456789      ; Customize the keys that interrupt message playback, probably all keys not set above
 339
 340 ; Maximum number of messages allowed in the 'Deleted' folder. If set to 0
 341 ; or no then no deleted messages will be moved. If non-zero (max 9999) then up
 342 ; to this number of messages will be automagically saved when they are
 343 ; 'deleted' on a FIFO basis.
 344 ; defaults to being off
 345 backupdeleted=10
 346
 347
 348 [zonemessages]
 349 ; Users may be located in different timezones, or may have different
 350 ; message announcements for their introductory message when they enter
 351 ; the voicemail system. Set the message and the timezone each user
 352 ; hears here. Set the user into one of these zones with the tz= attribute
 353 ; in the options field of the mailbox. Of course, language substitution
 354 ; still applies here so you may have several directory trees that have
 355 ; alternate language choices.
 356 ;
 357 ; Look in /usr/share/zoneinfo/ for names of timezones.
 358 ; Look at the manual page for strftime for a quick tutorial on how the
 359 ; variable substitution is done on the values below.
 360 ;
 361 ; Supported values:
 362 ; 'filename'    filename of a soundfile (single ticks around the filename
 363 ;               required)
 364 ; ${VAR}        variable substitution
 365 ; A or a        Day of week (Saturday, Sunday, ...)
 366 ; B or b or h   Month name (January, February, ...)
 367 ; d or e        numeric day of month (first, second, ..., thirty-first)
 368 ; Y             Year
 369 ; I or l        Hour, 12 hour clock
 370 ; H             Hour, 24 hour clock (single digit hours preceded by "oh")
 371 ; k             Hour, 24 hour clock (single digit hours NOT preceded by "oh")
 372 ; M             Minute, with 00 pronounced as "o'clock"
 373 ; N             Minute, with 00 pronounced as "hundred" (US military time)
 374 ; P or p        AM or PM
 375 ; Q             "today", "yesterday" or ABdY
 376 ;               (*note: not standard strftime value)
 377 ; q             "" (for today), "yesterday", weekday, or ABdY
 378 ;               (*note: not standard strftime value)
 379 ; R             24 hour time, including minute
 380 ;
 381 eastern=America/New_York|'vm-received' Q 'digits/at' IMp
 382 central=America/Chicago|'vm-received' Q 'digits/at' IMp
 383 central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
 384 military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
 385 european=Europe/Copenhagen|'vm-received' a d b 'digits/at' HM
 386
 387
 388 [default]
 389
 390 ; surcharge AUF locale (pour le contexte [AUF] surtout)
 391 #include "auf/voicemail.local"