codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / extensions_minivm.conf.sample
1 ; MINI-VOICEMAIL dialplan example
2 ; ---------------------------------------------------------------------------------------
3 ;
4 ; This is an example on how to use the Mini-Voicemail system to build
5 ; voicemail systems.
6 ;
7 ;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
8 ; A macro to test the MINIVMACCOUNT dialplan function
9 ;       Currently, accountcode and pincode is not used in the application
10 ;       They where added to be used in dialplan scripting
11 ;
12 ;
13 [macro-minivmfunctest]
14 exten => s,1,set(account=${ARGV1})
15 exten => minivm,n,verbose(1,-------------------- Minivm Function test - Accoutn ${account}  -------------)
16 exten => s,n,verbose(1,---- Has account:       ${MINIVMACCOUNT(${account}:hasaccount)})
17 exten => s,n,verbose(1,---- Fullname:          ${MINIVMACCOUNT(${account}:fullname)})
18 exten => s,n,verbose(1,---- Email:             ${MINIVMACCOUNT(${account}:email)})
19 exten => s,n,verbose(1,---- Pager:             ${MINIVMACCOUNT(${account}:pager)})
20 exten => s,n,verbose(1,---- E-mail template:   ${MINIVMACCOUNT(${account}:etemplate)})
21 exten => s,n,verbose(1,---- Pager template:    ${MINIVMACCOUNT(${account}:ptemplate)})
22 exten => s,n,verbose(1,---- Account code:      ${MINIVMACCOUNT(${account}:accountcode)})
23 exten => s,n,verbose(1,---- Path:              ${MINIVMACCOUNT(${account}:path)})
24 exten => s,n,verbose(1,---- Pincode:           ${MINIVMACCOUNT(${account}:pincode)})
25 exten => s,n,verbose(1,---- Time zone:         ${MINIVMACCOUNT(${account}:timezone)})
26 exten => s,n,verbose(1,---- Language:          ${MINIVMACCOUNT(${account}:language)})
27 ; This requires setvar=customerclass=gold in the account configuration
28 exten => s,n,verbose(1,---- Var:customerclass: ${MINIVMACCOUNT(${account}:customerclass)})
29
30 [minivm-scenario1]
31 ; minivmtest tests the dialplan function MINIVMACCOUNT
32 ; Check the output in the console with verbose set
33 exten => minivmtest,1,answer
34 exten => minivmtest,n,wait(0.5)
35 exten => minivmtest,n,set(ACCOUNT=do-not-spam-me@example.com)
36 exten => minivmtest,n,macro(minivmfunctest, ${ACCOUNT})
37 exten => minivmtest,n,playback(beep)
38 exten => minivmtest,n,hangup
39
40 ;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
41 ; "minivm" tests a full scenario
42 ; Remember that users may hangup
43 ; This works both for users with accounts in minivm.conf and by just giving an e-mail address
44 ; without configuring an account
45 exten => minivm,1,answer
46 exten => minivm,n,wait(0.5)     ; Wait for Voip channels to settle
47 exten => minivm,n,set(account=oej@example.com)
48 exten => minivm,n,noop(------------------------------------------- Minivm Greet   -------------)
49 exten => minivm,n,minivmgreet(${account})
50 exten => minivm,n,verbose(1,-- MINIVM_GREET_STATUS = ${MINIVM_GREET_STATUS} )
51 exten => minivm,n,noop(------------------------------------------- Minivm Record  -------------)
52 exten => minivm,n,minivmRecord(${account},b)
53 exten => minivm,n,goto(minivmcleanup,1)
54
55 ; Cleanup after recording or hangup
56 exten => minivmcleanup,1,noop(------------------------------------------- Minivm Notify  -------------)
57 ;Increment voicemail counter with 1. The counter will be used in the e-mail message
58 ;and in the filename
59 exten => minivmcleanup,n,gotoif($[${MINIVM_RECORD_STATUS} != SUCCESS]?minivmrecordfailure,1)
60 exten => minivmcleanup,n,set(MINIVMCOUNTER(${account}:voicemailcounter:inc)=1)
61 exten => minivmcleanup,n,set(MVM_COUNTER = ${MINIVMCOUNTER(${account}:voicemailcounter)})
62 exten => minivmcleanup,n,minivmNotify(${account})
63 exten => minivmcleanup,n,verbose(1,-- MINIVM_NOTIFY_STATUS = ${MINIVM_NOTIFY_STATUS} )
64 ; Now, clean up after sending voicemail
65 exten => minivmcleanup,n,noop(------------------------------------------- Minivm Delete  -------------)
66 exten => minivmcleanup,n,minivmdelete()
67 exten => minivmcleanup,n,verbose(1,-- MINIVM_DELETE_STATUS = ${MINIVM_DELETE_STATUS} )
68
69 ;Recording failed
70 exten => minivmrecordfailure,1,playback(vm-sorry)
71 exten => minivmrecordfailure,n,wait(1)
72 exten => minivmrecordfailure,n,hangup
73
74 ; If the user hangs up during the recording, we need to clean up
75 ; And send notifications
76 exten => h,1,gotoif($[x${MINIVM_DELETE_STATUS} != x] ?h,stop)
77 exten => h,n,noop(------------------------------------------- HANGUP during voicemail recording   -------------)
78 exten => h,n,goto(minivmcleanup,1)
79 exten => h,n(stop),noop(---Minivm DONE----)
80
81 ;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
82 ; Extension to record a greeting message
83 ; Call this like:
84 ;       macro(recordgreetings,alice@atlanta.example.com)
85 ;
86 [macro-recordgreetings]
87 exten => s,1,answer
88 exten => s,n,wait(0.5)
89 exten => s,n,set(account=${ARGV1])
90 ; This file give extra options not available here, needs to be edited
91 ; Change of password does not work
92 exten => s,n(menu),background(vm-options)
93 exten => 1,1,setvar(option=u)
94 exten => 1,n,macro(minivmrec,${account},${option})
95 exten => 1,n,goto(menu)
96 exten => 2,1,setvar(option=b)
97 exten => 2,n,macro(minivmrec,${account},${option})
98 exten => 2,n,goto(menu)
99 exten => 3,1,setvar(option=n)
100 exten => 3,n,macro(minivmrec,${account},${option})
101 exten => 3,n,goto(menu)
102 exten => 4,1,setvar(option=t)
103 exten => 4,n,macro(minivmrec,${account},${option})
104 exten => 4,n,goto(menu)
105 exten => *,1,playback(vm-thankyou)
106 exten => *,n,wait(1)
107 exten => *,n,hangup
108
109 exten => i,1,playback(invalid)
110 exten => i,n,goto(menu)
111
112 [macro-minivmrec]
113 exten => s,1,gotoif(${MINIVMACCOUNT(${account}:hasaccount)}?record)
114 ; Account is not configured in minivm.conf or realtime
115 ; Phony message, add something useful here
116 exten => s,n,playback(privacy-incorrect)
117 exten => s,n,macroreturn
118 exten => record,1,minivmappmess(${ARGV1},${ARGV2})
119 exten => record,n,noop(Recording status: ${MINIVM_APPMESS_STATUS})
120 exten => record,n,macroreturn
121
122 ;.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
123 ; To set a counter and use a template for voicemail to users without acounts
124 ; use something like this
125 ;
126 ; email address is in the "account" channel variable. Set from ast_db or a script
127 ; based on called ID
128
129 exten => sendvoicemail,1,answer
130 exten => sendvoicemail,n,wait(0.5)
131 exten => sendvoicemail,n,set(domain=${CUT(account,@,2)})
132 exten => sendvoicemail,n,set(country=${CUT(domain,.,2)})
133 exten => sendvoicemail,n,minivmgreet(${account})
134 exten => sendvoicemail,n,minivmRecord(${account},b)
135 exten => sendvoicemail,n,goto(sendvmcleanup)
136
137 exten => sendvmcleanup,1,gotoif($[${MINIVM_RECORD_STATUS} != SUCCESS]?done)
138 ; The counter is set in the domain directory, so we don't create one directory per user
139 ; The counter has the email in the name of the counter, increase it
140 ; Set the MVM_COUNTER variable that we use in the template
141 exten => sendvmcleanup,n,set(MINIVMCOUNTER(${account}:voicemailcounter:inc)=1)
142 exten => sendvmcleanup,n,set(MVM_COUNTER = ${MINIVMCOUNTER(${account}:voicemailcounter)})
143 ; Increase a domain counter too, to see how many voicemails are sent to this domain
144 ; This is just for statistics
145 exten => sendvmcleanup,n,set(MINIVMCOUNTER(${domain}:${domain}-all:inc) = 1)
146
147 ; Send voicemail in e-mail with country-specific template
148 ; The template need to be defined in minivm.conf
149 ;
150 exten => sendvmcleanup,n,minivmNotify(${account}, ${country}_email)
151 exten => sendvmcleanup,n,minivmDelete()
152
153 exten => sendvmcleanup,n(done),wait(0.5)
154 exten => sendvmcleanup,n,hangup
155
156 exten => h,1,gotoif($[${MINIVM_RECORD_STATUS} = SUCCESS]?sendvmcleanup,1))