Improve sample configuration files (bug #1125)
[asterisk/asterisk.git] / configs / extensions.conf.sample
1 ;
2 ; Static extension configuration file, used by
3 ; the pbx_config module. This is where you configure all your 
4 ; inbound and outbound calls in Asterisk. 
5
6
7 ;
8 ; The "General" category is for certain variables.  
9 ;
10 [general]
11 ;
12 ; If static is set to no, or omitted, then the pbx_config will rewrite
13 ; this file when extensions are modified.  Remember that all comments
14 ; made in the file will be lost when that happens. 
15 ;
16 ; XXX Not yet implemented XXX
17 ;
18 static=yes
19 ;
20 ; if static=yes and writeprotect=no, you can save dialplan by
21 ; CLI command 'save dialplan' too
22 ;
23 writeprotect=no
24
25 ; You can include other config files, use the #include command (without the ';')
26 ; Note that this is different from the "include" command that includes contexts within 
27 ; other contexts. The #include command works in all asterisk configuration files.
28 ;#include "filename.conf"
29
30 ; The "Globals" category contains global variables that can be referenced
31 ; in the dialplan with ${VARIABLE} or ${ENV(VARIABLE)} for Environmental variable
32 ; ${${VARIABLE}} or ${text${VARIABLE}} or any hybrid
33 ;
34 [globals]
35 CONSOLE=Console/dsp                             ; Console interface for demo
36 ;CONSOLE=Zap/1
37 ;CONSOLE=Phone/phone0
38 IAXINFO=guest                                   ; IAXtel username/password
39 ;IAXINFO=myuser:mypass
40 TRUNK=Zap/g2                                    ; Trunk interface
41 TRUNKMSD=1                                      ; MSD digits to strip (usually 1 or 0)
42 ;TRUNK=IAX2/user:pass@provider
43
44 ;
45 ; Any category other than "General" and "Globals" represent 
46 ; extension contexts, which are collections of extensions.  
47 ;
48 ; Extension names may be numbers, letters, or combinations
49 ; thereof. If an extension name is prefixed by a '_'
50 ; character, it is interpreted as a pattern rather than a
51 ; literal.  In patterns, some characters have special meanings:
52 ;
53 ;   X - any digit from 0-9
54 ;   Z - any digit from 1-9
55 ;   N - any digit from 2-9
56 ;   [1235-9] - any digit in the brackets (in this example, 1,2,3,5,6,7,8,9)
57 ;   . - wildcard, matches anything remaining (e.g. _9011. matches 
58 ;       anything starting with 9011 excluding 9011 itself)
59 ;
60 ; For example the extension _NXXXXXX would match normal 7 digit dialings, 
61 ; while _1NXXNXXXXXX would represent an area code plus phone number
62 ; preceeded by a one.
63 ;
64 ; Contexts contain several lines, one for each step of each
65 ; extension, which can take one of two forms as listed below,
66 ; with the first form being preferred.  One may include another
67 ; context in the current one as well, optionally with a
68 ; date and time.  Included contexts are included in the order
69 ; they are listed.
70 ;
71 ;[context]
72 ;exten => someexten,priority,application(arg1,arg2,...)
73 ;exten => someexten,priority,application,arg1|arg2...
74 ;
75 ; Timing list for includes is 
76 ;
77 ;   <time range>|<days of week>|<days of month>|<months>
78 ;
79 ;include => daytime|9:00-17:00|mon-fri|*|*
80 ;
81 ; ignorepat can be used to instruct drivers to not cancel dialtone upon
82 ; receipt of a particular pattern.  The most commonly used example is
83 ; of course '9' like this:
84 ;
85 ;ignorepat => 9
86 ;
87 ; so that dialtone remains even after dialing a 9.
88 ;
89
90 ;
91 ; Here are the entries you need to participate in the IAXTEL
92 ; call routing system.  Most IAXTEL numbers begin with 1-700, but
93 ; there are exceptions.  For more information, and to sign
94 ; up, please go to www.gnophone.com or www.iaxtel.com
95 ;
96 [iaxtel700]
97 exten => _91700XXXXXXX,1,Dial(IAX2/${IAXINFO}@iaxtel.com/${EXTEN:1}@iaxtel)
98
99 ;
100 ; The SWITCH statement permits a server to share the dialplain with
101 ; another server. Use with care: Reciprocal switch statements are not
102 ; allowed (e.g. both A -> B and B -> A), and the switched server needs
103 ; to be on-line or else dialing can be severly delayed.
104 ;
105 [iaxprovider]
106 ;switch => IAX2/user:[key]@myserver/mycontext
107
108 [trunkint]
109 ;
110 ; International long distance through trunk
111 ;
112 exten => _9011.,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
113 exten => _9011.,2,Congestion
114
115 [trunkld]
116 ;
117 ; Long distance context accessed through trunk
118 ;
119 exten => _91NXXNXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
120 exten => _91NXXNXXXXXX,2,Congestion
121
122 [trunklocal]
123 ;
124 ; Local seven-digit dialing accessed through trunk interface
125 ;
126 exten => _9NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
127 exten => _9NXXXXXX,2,Congestion
128
129 [trunktollfree]
130 ;
131 ; Long distance context accessed through trunk interface
132 ;
133 exten => _91800NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
134 exten => _91800NXXXXXX,2,Congestion
135 exten => _91888NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
136 exten => _91888NXXXXXX,2,Congestion
137 exten => _91877NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
138 exten => _91877NXXXXXX,2,Congestion
139 exten => _91866NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
140 exten => _91866NXXXXXX,2,Congestion
141
142 [international]
143 ;
144 ; Master context for international long distance
145 ;
146 ignorepat => 9
147 include => longdistance
148 include => trunkint
149
150 [longdistance]
151 ;
152 ; Master context for long distance
153 ;
154 ignorepat => 9
155 include => local
156 include => trunkld
157
158 [local]
159 ;
160 ; Master context for local, toll-free, and iaxtel calls only
161 ;
162 ignorepat => 9
163 include => default
164 include => parkedcalls
165 include => trunklocal
166 include => iaxtel700
167 include => trunktollfree
168 include => iaxprovider
169 ;
170 ; You can use an alternative switch type as well, to resolve
171 ; extensions that are not known here, for example with remote 
172 ; IAX switching you transparently get access to the remote
173 ; Asterisk PBX
174
175 ; switch => IAX2/user:password@bigserver/local
176
177 [macro-stdexten];
178 ;
179 ; Standard extension macro:
180 ;   ${ARG1} - Extension  (we could have used ${MACRO_EXTEN} here as well
181 ;   ${ARG2} - Device(s) to ring
182 ;
183 exten => s,1,Dial(${ARG2},20)                                   ; Ring the interface, 20 seconds maximum
184 exten => s,2,Voicemail(u${ARG1})                                ; If unavailable, send to voicemail w/ unavail announce
185 exten => s,3,Goto(default,s,1)                                  ; If they press #, return to start
186 exten => s,102,Voicemail(b${ARG1})                              ; If busy, send to voicemail w/ busy announce
187 exten => s,103,Goto(default,s,1)                                ; If they press #, return to start
188
189
190 [demo]
191 ;
192 ; We start with what to do when a call first comes in.
193 ;
194 exten => s,1,Wait,1                     ; Wait a second, just for fun
195 exten => s,2,Answer                     ; Answer the line
196 exten => s,3,DigitTimeout,5             ; Set Digit Timeout to 5 seconds
197 exten => s,4,ResponseTimeout,10         ; Set Response Timeout to 10 seconds
198 exten => s,5,BackGround(demo-congrats)  ; Play a congratulatory message
199 exten => s,6,BackGround(demo-instruct)  ; Play some instructions
200
201 exten => 2,1,BackGround(demo-moreinfo)  ; Give some more information.
202 exten => 2,2,Goto(s,6)
203
204 exten => 3,1,SetLanguage(fr)            ; Set language to french
205 exten => 3,2,Goto(s,5)                  ; Start with the congratulations
206
207 exten => 1000,1,Goto(default,s,1)
208 ;
209 ; We also create an example user, 1234, who is on the console and has
210 ; voicemail, etc.
211 ;
212 exten => 1234,1,Playback(transfer,skip)         ; "Please hold while..." 
213                                         ; (but skip if channel is not up)
214 exten => 1234,2,Macro(stdexten,1234,${CONSOLE})
215
216 exten => 1235,1,Voicemail(u1234)                ; Right to voicemail
217
218 exten => 1236,1,Dial(Console/dsp)               ; Ring forever
219 exten => 1236,2,Voicemail(u1234)                ; Unless busy
220
221 ;
222 ; # for when they're done with the demo
223 ;
224 exten => #,1,Playback(demo-thanks)              ; "Thanks for trying the demo"
225 exten => #,2,Hangup                     ; Hang them up.
226
227 ;
228 ; A timeout and "invalid extension rule"
229 ;
230 exten => t,1,Goto(#,1)                  ; If they take too long, give up
231 exten => i,1,Playback(invalid)          ; "That's not valid, try again"
232
233 ;
234 ; Create an extension, 500, for dialing the
235 ; Asterisk demo.
236 ;
237 exten => 500,1,Playback(demo-abouttotry); Let them know what's going on
238 exten => 500,2,Dial(IAX2/guest@misery.digium.com/s@default)     ; Call the Asterisk demo
239 exten => 500,3,Playback(demo-nogo)      ; Couldn't connect to the demo site
240 exten => 500,4,Goto(s,6)                ; Return to the start over message.
241
242 ;
243 ; Create an extension, 600, for evaulating echo latency.
244 ;
245 exten => 600,1,Playback(demo-echotest)  ; Let them know what's going on
246 exten => 600,2,Echo                     ; Do the echo test
247 exten => 600,3,Playback(demo-echodone)  ; Let them know it's over
248 exten => 600,4,Goto(s,6)                ; Start over
249
250 ;
251 ; Give voicemail at extension 8500
252 ;
253 exten => 8500,1,VoicemailMain
254 exten => 8500,2,Goto(s,6)
255 ;
256 ; Here's what a phone entry would look like (IXJ for example)
257 ;
258 ;exten => 1265,1,Dial(Phone/phone0,15)
259 ;exten => 1265,2,Goto(s,5)
260
261 ;[mainmenu]
262 ;
263 ; Example "main menu" context with submenu
264 ;
265 ;exten => s,1,Answer
266 ;exten => s,2,Background(thanks)                ; "Thanks for calling press 1 for sales, 2 for support, ..."
267 ;exten => 1,1,Goto(submenu,s,1)
268 ;exten => 2,1,Hangup
269 ;include => default
270 ;
271 ;[submenu]
272 ;exten => s,1,Ringing                                   ; Make them comfortable with 2 seconds of ringback
273 ;exten => s,2,Wait,2
274 ;exten => s,3,Background(submenuopts)   ; "Thanks for calling the sales department.  Press 1 for steve, 2 for..."
275 ;exten => 1,1,Goto(default,steve,1)
276 ;exten => 2,1,Goto(default,mark,2)
277
278 [default]
279 ;
280 ; By default we include the demo.  In a production system, you 
281 ; probably don't want to have the demo there.
282 ;
283 include => demo
284
285 ;
286 ; Extensions like the two below can be used for FWD, Nikotel, sipgate etc.
287 ; Note that you must have a [sipprovider] section in sip.conf whereas
288 ; the otherprovider.net example does not require such a peer definition
289 ;
290 ;exten => _41X.,1,Dial(SIP/${EXTEN:2}@sipprovider,,r)
291 ;exten => _42X.,1,Dial(SIP/user:passwd@${EXTEN:2}@otherprovider.net,30,rT)
292
293 ; Real extensions would go here. Generally you want real extensions to be 4 or 5
294 ; digits long (although there is no such requirement) and start with a single
295 ; digit that is fairly large (like 6 or 7) so that you have plenty of room to
296 ; overlap extensions and menu options without conflict.  You can alias them with
297 ; names, too and use global variables
298
299 ;exten => 6245,1,Dial(SIP/Grandstream1,20,rt)   ; permit transfer
300 ;exten => 6245,1,Dial(SIP/Grandstream1&SIP/Xlite1,20,rtT)
301 ;exten => 6361,1,Dial(IAX2/JaneDoe,,rm)         ; ring without time limit
302 ;exten => 6389,1,Dial(MGCP/aaln/1@192.168.0.14)
303 ;exten => 6394,1,Dial(Local/6275/n)             ; this will dial ${MARK}
304
305 ;exten => 6275,1,Macro(stdexten,6275,${MARK})   ; assuming ${MARK} is something like Zap/2
306 ;exten => mark,1,Goto(6275|1)                   ; alias mark to 6275
307 ;exten => 6536,1,Macro(stdexten,6236,${WIL})    ; Ditto for wil
308 ;exten => wil,1,Goto(6236|1)
309 ;
310 ; Some other handy things are an extension for checking voicemail via
311 ; voicemailmain
312 ;
313 ;exten => 8500,1,VoicemailMain
314 ;exten => 8500,2,Hangup
315 ;
316 ; Or a conference room (you'll need to edit meetme.conf to enable this room)
317 ;
318 ;exten => 8600,1,Meetme(1234)
319 ;
320 ; Or playing an announcement to the called party, as soon it answers
321 ;
322 ;exten = 8700,1,Dial(${MARK},30,A(/path/to/my/announcemsg))
323 ;
324 ; For more information on applications, just type "show applications" at your
325 ; friendly Asterisk CLI prompt.
326 ;
327 ; 'show application <command>' will show details of how you
328 ; use that particular application in this file, the dial plan. 
329 ;