mirror of http://gerrit.asterisk.org/asterisk
blocks instead of one large monolithic app. Supports multiple templates and is designed mostly for voicemail delivery over e-mail. There's a todo with a list of ideas in the source code if you want to contribute. Feedback is appreciated! git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@61671 65c4cc65-6c06-0410-ace0-fbb531ad65f31.6.0
Olle Johansson
18 years ago
parent
e1d30288c0
commit
c72efe27be
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,159 @@
|
||||
; MINI-VOICEMAIL dialplan example
|
||||
; ---------------------------------------------------------------------------------------
|
||||
; ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
||||
;
|
||||
;
|
||||
; This is an example on how to use the Mini-Voicemail system to build
|
||||
; voicemail systems.
|
||||
;
|
||||
;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
|
||||
; A macro to test the MINIVMACCOUNT dialplan function
|
||||
; Currently, accountcode and pincode is not used in the application
|
||||
; They where added to be used in dialplan scripting
|
||||
;
|
||||
;
|
||||
[macro-minivmfunctest]
|
||||
exten => s,1,set(account=${ARGV1})
|
||||
exten => minivm,n,verbose(1,-------------------- Minivm Function test - Accoutn ${account} -------------)
|
||||
exten => s,n,verbose(1,---- Has account: ${MINIVMACCOUNT(${account}:hasaccount)})
|
||||
exten => s,n,verbose(1,---- Fullname: ${MINIVMACCOUNT(${account}:fullname)})
|
||||
exten => s,n,verbose(1,---- Email: ${MINIVMACCOUNT(${account}:email)})
|
||||
exten => s,n,verbose(1,---- Pager: ${MINIVMACCOUNT(${account}:pager)})
|
||||
exten => s,n,verbose(1,---- E-mail template: ${MINIVMACCOUNT(${account}:etemplate)})
|
||||
exten => s,n,verbose(1,---- Pager template: ${MINIVMACCOUNT(${account}:ptemplate)})
|
||||
exten => s,n,verbose(1,---- Account code: ${MINIVMACCOUNT(${account}:accountcode)})
|
||||
exten => s,n,verbose(1,---- Path: ${MINIVMACCOUNT(${account}:path)})
|
||||
exten => s,n,verbose(1,---- Pincode: ${MINIVMACCOUNT(${account}:pincode)})
|
||||
exten => s,n,verbose(1,---- Time zone: ${MINIVMACCOUNT(${account}:timezone)})
|
||||
exten => s,n,verbose(1,---- Language: ${MINIVMACCOUNT(${account}:language)})
|
||||
; This requires setvar=customerclass=gold in the account configuration
|
||||
exten => s,n,verbose(1,---- Var:customerclass: ${MINIVMACCOUNT(${account}:customerclass)})
|
||||
|
||||
[minivm-scenario1]
|
||||
; minivmtest tests the dialplan function MINIVMACCOUNT
|
||||
; Check the output in the console with verbose set
|
||||
exten => minivmtest,1,answer
|
||||
exten => minivmtest,n,wait(0.5)
|
||||
exten => minivmtest,n,set(ACCOUNT=do-not-spam-me@example.com)
|
||||
exten => minivmtest,n,macro(minivmfunctest, ${ACCOUNT})
|
||||
exten => minivmtest,n,playback(beep)
|
||||
exten => minivmtest,n,hangup
|
||||
|
||||
;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
|
||||
; "minivm" tests a full scenario
|
||||
; Remember that users may hangup
|
||||
; This works both for users with accounts in minivm.conf and by just giving an e-mail address
|
||||
; without configuring an account
|
||||
exten => minivm,1,answer
|
||||
exten => minivm,n,wait(0.5) ; Wait for Voip channels to settle
|
||||
exten => minivm,n,set(account=oej@example.com)
|
||||
exten => minivm,n,noop(------------------------------------------- Minivm Greet -------------)
|
||||
exten => minivm,n,minivmgreet(${account})
|
||||
exten => minivm,n,verbose(1,-- MINIVM_GREET_STATUS = ${MINIVM_GREET_STATUS} )
|
||||
exten => minivm,n,noop(------------------------------------------- Minivm Record -------------)
|
||||
exten => minivm,n,minivmRecord(${account},b)
|
||||
exten => minivm,n,goto(minivmcleanup,1)
|
||||
|
||||
; Cleanup after recording or hangup
|
||||
exten => minivmcleanup,1,noop(------------------------------------------- Minivm Notify -------------)
|
||||
;Increment voicemail counter with 1. The counter will be used in the e-mail message
|
||||
;and in the filename
|
||||
exten => minivmcleanup,n,gotoif($[${MINIVM_RECORD_STATUS} != SUCCESS]?minivmrecordfailure,1)
|
||||
exten => minivmcleanup,n,set(MINIVMCOUNTER(${account}:voicemailcounter:inc)=1)
|
||||
exten => minivmcleanup,n,set(MVM_COUNTER = ${MINIVMCOUNTER(${account}:voicemailcounter)})
|
||||
exten => minivmcleanup,n,minivmNotify(${account})
|
||||
exten => minivmcleanup,n,verbose(1,-- MINIVM_NOTIFY_STATUS = ${MINIVM_NOTIFY_STATUS} )
|
||||
; Now, clean up after sending voicemail
|
||||
exten => minivmcleanup,n,noop(------------------------------------------- Minivm Delete -------------)
|
||||
exten => minivmcleanup,n,minivmdelete()
|
||||
exten => minivmcleanup,n,verbose(1,-- MINIVM_DELETE_STATUS = ${MINIVM_DELETE_STATUS} )
|
||||
|
||||
;Recording failed
|
||||
exten => minivmrecordfailure,1,playback(vm-sorry)
|
||||
exten => minivmrecordfailure,n,wait(1)
|
||||
exten => minivmrecordfailure,n,hangup
|
||||
|
||||
; If the user hangs up during the recording, we need to clean up
|
||||
; And send notifications
|
||||
exten => h,1,gotoif($[x${MINIVM_DELETE_STATUS} != x] ?h,stop)
|
||||
exten => h,n,noop(------------------------------------------- HANGUP during voicemail recording -------------)
|
||||
exten => h,n,goto(minivmcleanup,1)
|
||||
exten => h,n(stop),noop(---Minivm DONE----)
|
||||
|
||||
;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
|
||||
; Extension to record a greeting message
|
||||
; Call this like:
|
||||
; macro(recordgreetings,alice@atlanta.example.com)
|
||||
;
|
||||
[macro-recordgreetings]
|
||||
exten => s,1,answer
|
||||
exten => s,n,wait(0.5)
|
||||
exten => s,n,set(account=${ARGV1])
|
||||
; This file give extra options not available here, needs to be edited
|
||||
; Change of password does not work
|
||||
exten => s,n(menu),background(vm-options)
|
||||
exten => 1,1,setvar(option=u)
|
||||
exten => 1,n,macro(minivmrec,${account},${option})
|
||||
exten => 1,n,goto(menu)
|
||||
exten => 2,1,setvar(option=b)
|
||||
exten => 2,n,macro(minivmrec,${account},${option})
|
||||
exten => 2,n,goto(menu)
|
||||
exten => 3,1,setvar(option=n)
|
||||
exten => 3,n,macro(minivmrec,${account},${option})
|
||||
exten => 3,n,goto(menu)
|
||||
exten => 4,1,setvar(option=t)
|
||||
exten => 4,n,macro(minivmrec,${account},${option})
|
||||
exten => 4,n,goto(menu)
|
||||
exten => *,1,playback(vm-thankyou)
|
||||
exten => *,n,wait(1)
|
||||
exten => *,n,hangup
|
||||
|
||||
exten => i,1,playback(invalid)
|
||||
exten => i,n,goto(menu)
|
||||
|
||||
[macro-minivmrec]
|
||||
exten => s,1,gotoif(${MINIVMACCOUNT(${account}:hasaccount)}?record)
|
||||
; Account is not configured in minivm.conf or realtime
|
||||
; Phony message, add something useful here
|
||||
exten => s,n,playback(privacy-incorrect)
|
||||
exten => s,n,macroreturn
|
||||
exten => record,1,minivmappmess(${ARGV1},${ARGV2})
|
||||
exten => record,n,noop(Recording status: ${MINIVM_APPMESS_STATUS})
|
||||
exten => record,n,macroreturn
|
||||
|
||||
;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
|
||||
; To set a counter and use a template for voicemail to users without acounts
|
||||
; use something like this
|
||||
;
|
||||
; email address is in the "account" channel variable. Set from ast_db or a script
|
||||
; based on called ID
|
||||
|
||||
exten => sendvoicemail,1,answer
|
||||
exten => sendvoicemail,n,wait(0.5)
|
||||
exten => sendvoicemail,n,set(domain=${CUT(account,@,2)})
|
||||
exten => sendvoicemail,n,set(country=${CUT(domain,.,2)})
|
||||
exten => sendvoicemail,n,minivmgreet(${account})
|
||||
exten => sendvoicemail,n,minivmRecord(${account},b)
|
||||
exten => sendvoicemail,n,goto(sendvmcleanup)
|
||||
|
||||
exten => sendvmcleanup,1,gotoif($[${MINIVM_RECORD_STATUS} != SUCCESS]?done)
|
||||
; The counter is set in the domain directory, so we don't create one directory per user
|
||||
; The counter has the email in the name of the counter, increase it
|
||||
; Set the MVM_COUNTER variable that we use in the template
|
||||
exten => sendvmcleanup,n,set(MINIVMCOUNTER(${account}:voicemailcounter:inc)=1)
|
||||
exten => sendvmcleanup,n,set(MVM_COUNTER = ${MINIVMCOUNTER(${account}:voicemailcounter)})
|
||||
; Increase a domain counter too, to see how many voicemails are sent to this domain
|
||||
; This is just for statistics
|
||||
exten => sendvmcleanup,n,set(MINIVMCOUNTER(${domain}:${domain}-all:inc) = 1)
|
||||
|
||||
; Send voicemail in e-mail with country-specific template
|
||||
; The template need to be defined in minivm.conf
|
||||
;
|
||||
exten => sendvmcleanup,n,minivmNotify(${account}, ${country}_email)
|
||||
exten => sendvmcleanup,n,minivmDelete()
|
||||
|
||||
exten => sendvmcleanup,n(done),wait(0.5)
|
||||
exten => sendvmcleanup,n,hangup
|
||||
|
||||
exten => h,1,gotoif($[${MINIVM_RECORD_STATUS} = SUCCESS]?sendvmcleanup,1))
|
||||
|
||||
@ -0,0 +1,218 @@
|
||||
;
|
||||
; Mini-Voicemail Configuration
|
||||
; for the MiniVM set of applications
|
||||
;
|
||||
; MiniVM consists of the following dialplan applications
|
||||
; MinivmGreet Play personal prompts for busy/unavailable/temporary messages or default prompts
|
||||
; MinivmRecord Record voice prompts to account directory or default directory
|
||||
; MinivmNotify Notify via e-mail or pager - with or without attachment
|
||||
; MinivmDelete Delete voice prompt (filename as argument or channel variable set by MinivmRecord)
|
||||
;
|
||||
; MiniVM works without accounts (just give e-mail address as argument) or with accounts in
|
||||
; this configuration file or realtime. The idea is to build voicemail as building blocks so that
|
||||
; a complete and adaptive voicemail system can be built in the dialplan
|
||||
;
|
||||
;------------------------------ Variables to use in subject, from and message body ------------------
|
||||
; Change the from, body and/or subject, variables:
|
||||
; MVM_NAME, MVM_DUR, MVM_MSGNUM, VM_MAILBOX, MVM_CALLERID, MVM_CIDNUM,
|
||||
; MVM_CIDNAME, MVM_DATE
|
||||
;
|
||||
; In addition to these, you can set the MVM_COUNTER channel variable in the
|
||||
; dial plan and use that as a counter. It will also be used in the file name
|
||||
; of the media file attached to the message
|
||||
;
|
||||
; Note: The emailbody config row can only be up to 512 characters due to a
|
||||
; limitation in the Asterisk configuration subsystem.
|
||||
; To create longer mails, use the templatefile option when creating the template
|
||||
;----------------------------------------------------------------------------------------------------
|
||||
|
||||
[general]
|
||||
; Default format for storing and sending voicemail
|
||||
; (only one format. Can also be set on a per-mailbox level)
|
||||
format=wav49
|
||||
;format=gsm
|
||||
;
|
||||
;Turn on logfile with the following syntax. One line per voicemail received
|
||||
;with minivmRecord()
|
||||
; Mailbox:domain:macrocontext:exten:priority:callerchan:callerid:origdate:origtime:duration:durationstatus:accountcode
|
||||
;logfile=/var/log/asterisk/minivm.log
|
||||
; Who the e-mail notification should appear to come from
|
||||
serveremail=asterisk
|
||||
;serveremail=asterisk@asterisk.example.com
|
||||
; Minimum length of a voicemail message in seconds for the message to be kept
|
||||
; The default is no minimum.
|
||||
;minmessage=3
|
||||
; How many seconds of silence before we end the recording
|
||||
maxsilence=10
|
||||
; Silence threshold (what we consider silence: the lower, the more sensitive)
|
||||
silencethreshold=128
|
||||
; How long greeting messages (busy/unavailable/temp/name) are allowed to be, in seconds
|
||||
;maxgreet=120
|
||||
; If you need to have an external program, i.e. /usr/bin/myapp called when a
|
||||
; voicemail is received by the server. The arguments are
|
||||
;
|
||||
; <app> <username@domain> <callerid-number> <callerid-name>
|
||||
;
|
||||
;externnotify=/usr/bin/myapp
|
||||
; The character set for voicemail messages can be specified here
|
||||
;charset=ISO-8859-1
|
||||
; Skip the "[PBX]:" string from the message title
|
||||
;pbxskip=yes
|
||||
; Change the From: string
|
||||
|
||||
; You can override the default program to send e-mail if you wish, too
|
||||
; This is used both for e-mail and pager messages
|
||||
;mailcmd=/usr/sbin/sendmail -t
|
||||
;
|
||||
;--------------Default e-mail message template (used if no templates are used) ------
|
||||
;fromstring=The Asterisk PBX
|
||||
;
|
||||
|
||||
;emailsubject=[PBX]: New message ${MVM_COUNER} in mailbox ${VM_MAILBOX}
|
||||
; The following definition is very close to the default, but the default shows
|
||||
; just the CIDNAME, if it is not null, otherwise just the CIDNUM, or "an unknown
|
||||
; caller", if they are both null.
|
||||
;emailbody=Dear ${MVM_NAME}:\n\n\tjust wanted to let you know you were just left a ${MVM_DUR} long message (number ${MVM_COUNTER})\nin mailbox ${MVM_MAILBOX} from ${MVM_CALLERID}, on ${MVM_DATE}, so you might\nwant to check it when you get a chance. Thanks!\n\n\t\t\t\t--Asterisk\n
|
||||
;
|
||||
; Set the date format on outgoing mails. Valid arguments can be found on the
|
||||
; strftime(3) man page
|
||||
;
|
||||
; Default
|
||||
emaildateformat=%A, %B %d, %Y at %r
|
||||
; 24h date format
|
||||
;emaildateformat=%A, %d %B %Y at %H:%M:%S
|
||||
;
|
||||
;--------------Default pager message template (used if no templates are used) ------
|
||||
; You can also change the Pager From: string, the pager body and/or subject.
|
||||
; The above defined variables also can be used here
|
||||
;pagerfromstring=The Asterisk PBX
|
||||
;pagersubject=New VM ${MVM_COUNTER}
|
||||
;pagerbody=New ${MVM_DUR} long msg in box ${MVM_MAILBOX}\nfrom ${MVM_CALLERID}, on ${MVM_DATE}
|
||||
;
|
||||
;
|
||||
;--------------Timezone definitions (used in voicemail accounts) -------------------
|
||||
;
|
||||
; Users may be located in different timezones, or may have different
|
||||
; message announcements for their introductory message when they enter
|
||||
; the voicemail system. Set the message and the timezone each user
|
||||
; hears here. Set the user into one of these zones with the tz= attribute
|
||||
; in the options field of the mailbox. Of course, language substitution
|
||||
; still applies here so you may have several directory trees that have
|
||||
; alternate language choices.
|
||||
;
|
||||
; Look in /usr/share/zoneinfo/ for names of timezones.
|
||||
; Look at the manual page for strftime for a quick tutorial on how the
|
||||
; variable substitution is done on the values below.
|
||||
;
|
||||
; Supported values:
|
||||
; 'filename' filename of a soundfile (single ticks around the filename
|
||||
; required)
|
||||
; ${VAR} variable substitution
|
||||
; 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)
|
||||
; P or p AM or PM
|
||||
; Q "today", "yesterday" or ABdY
|
||||
; (*note: not standard strftime value)
|
||||
; q "" (for today), "yesterday", weekday, or ABdY
|
||||
; (*note: not standard strftime value)
|
||||
; R 24 hour time, including minute
|
||||
;
|
||||
; The message here is not used in mini-voicemail, but stays for
|
||||
; backwards compatibility
|
||||
|
||||
[zonemessages]
|
||||
eastern=America/New_York|'vm-received' Q 'digits/at' IMp
|
||||
central=America/Chicago|'vm-received' Q 'digits/at' IMp
|
||||
central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
|
||||
military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
|
||||
|
||||
;----------------------- Message body templates---------------------
|
||||
; [template-name] ; "template-" is a verbatim marker
|
||||
; fromaddress = Your Friendly Asterisk Server
|
||||
; fromemail = asteriskvm@digium.com
|
||||
; subject = <string>
|
||||
; attachmedia = yes | no ; Add media file as attachment?
|
||||
; dateformat = <formatstring> ; See above
|
||||
; charset = <charset> ; Mime charset definition for e-mail messages
|
||||
; locale = <locale> ; Locale for LC_TIME - to get weekdays in local language
|
||||
; ; See your O/S documentation for proper settings for setlocale()
|
||||
; templatefile = <filename> ; File name (relative to Asterisk configuration directory,
|
||||
; or absolute
|
||||
; messagebody = Format ; Message body definition with variables
|
||||
;
|
||||
[template-sv_SE_email]
|
||||
messagebody=Hej ${MVM_NAME}:\n\n\tDu har fått ett röstbrevlåde-meddelande från ${MVM_CALLERID}.\nLängd: ${MVM_DUR}\nMailbox ${MVM_MAILBOX}\nDatum: ${MVM_DATE}. \nMeddelandet bifogas det här brevet. Om du inte kan läsa det, kontakta intern support. \nHälsningar\n\n\t\t\t\t--Asterisk\n
|
||||
subject = Du har fått röstmeddelande (se bilaga)
|
||||
fromemail = swedish-voicemail-service@stockholm.example.com
|
||||
fromaddress = Asterisk Röstbrevlåda
|
||||
charset=iso-8859-1
|
||||
attachmedia=yes
|
||||
dateformat=%A, %d %B %Y at %H:%M:%S
|
||||
locale=sv_SE
|
||||
|
||||
[template-en_US_email]
|
||||
messagebody=Dear ${MVM_NAME}:\n\n\tjust wanted to let you know you were just left a ${MVM_DUR} long message \nin mailbox ${MVM_MAILBOX} from ${MVM_CALLERID}, on ${MVM_DATE}, so you might\nwant to check it when you get a chance. Thanks!\n\n\t\t\t\t--Asterisk\n
|
||||
subject = New voicemail
|
||||
charset=ascii
|
||||
attachmedia=yes
|
||||
dateformat=%A, %B %d, %Y at %r
|
||||
|
||||
;[template-sv_SE_pager]
|
||||
;templatefile = templates/pager_sv_se.txt
|
||||
;subject = Du har fått voicemail
|
||||
;charset=iso-8859-1
|
||||
;attachmedia=no
|
||||
;locale=sv_SE
|
||||
|
||||
;[template-nb_NO_email]
|
||||
;templatefile = templates/email_nb_NO.txt
|
||||
;subject = Du har fått voicemail
|
||||
;charset=iso-8859-1
|
||||
;locale=nb_NO
|
||||
|
||||
;[template-en_US_email_southern]
|
||||
;templatefile = templates/email_en_US.txt
|
||||
;subject = Y'all got voicemail, honey!
|
||||
;charset=ascii
|
||||
|
||||
;[template-en_UK_email]
|
||||
;templatefile = templates/email_en_us.txt
|
||||
;subject = Dear old chap, you've got an electronic communique
|
||||
;charset=ascii
|
||||
|
||||
;----------------------- Mailbox accounts --------------------------
|
||||
;Template for mailbox definition - all options
|
||||
;
|
||||
; [username@domain] ; Has to be unique within domain (MWM_USERNAME, MWM_DOMAIN)
|
||||
; etemplate = sv_SE ; Email template from [templates]
|
||||
; ptemplate = en_US ; Pager template from [templates]
|
||||
; email = userpart@domain ; Extra e-mail address (overrides mailbox name)
|
||||
; pager = pageremail@domain ; E-mail address for pager messages
|
||||
; fullname = Mark Spencer ; Full name (MWM_NAME)
|
||||
; options = ; E-mail options, se below
|
||||
; accountcode = ; Account code (read in dialplan function MINIVMACCOUNT)
|
||||
; pincode = ; Numeric pin code (read in dialplan function MINIVMACCOUNT)
|
||||
; timezone=se ; Time zone
|
||||
; serveremail = asterisk@digium.com ; Who to send email from (overrides template if set)
|
||||
; externnotify = <application> ; External application for this account
|
||||
; volgain = ; Volume gain setting (requires "sox")
|
||||
; setvar=SERVICENAME=Voop.com Networks ; Extra variables to use in template
|
||||
|
||||
; Remember that you can use Asterisk Configuration Templates (ACT)
|
||||
|
||||
; [template@example.com](!) ; Declare template
|
||||
; setvar=customerdomain=example.com
|
||||
; setvar=customerclass=gold
|
||||
; etemplate = sv_se_email
|
||||
; serveremail = voicemail@example.com
|
||||
|
||||
; [user2@example.com](template@example.com) ; Declare user2 account using template
|
||||
; fullname = Olle E. Johansson
|
||||
; ; User inherits everything from template
|
||||
Loading…
Reference in new issue