add a global option to disable priority jumping in applications (when they get update...
[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 ; This configuration file is reloaded 
7 ; - With the "extensions reload" command in the CLI
8 ; - With the "reload" command (that reloads everything) in the CLI
9
10 ;
11 ; The "General" category is for certain variables.  
12 ;
13 [general]
14 ;
15 ; If static is set to no, or omitted, then the pbx_config will rewrite
16 ; this file when extensions are modified.  Remember that all comments
17 ; made in the file will be lost when that happens. 
18 ;
19 ; XXX Not yet implemented XXX
20 ;
21 static=yes
22 ;
23 ; if static=yes and writeprotect=no, you can save dialplan by
24 ; CLI command 'save dialplan' too
25 ;
26 writeprotect=no
27 ;
28 ; If autofallthrough is set, then if an extension runs out of
29 ; things to do, it will terminate the call with BUSY, CONGESTION
30 ; or HANGUP depending on Asterisk's best guess (strongly recommended).
31 ;
32 ; If autofallthrough is not set, then if an extension runs out of 
33 ; things to do, asterisk will wait for a new extension to be dialed 
34 ; (this is the original behavior of Asterisk 1.0 and earlier).
35 ;
36 autofallthrough=yes
37 ;
38 ; If clearglobalvars is set, global variables will be cleared 
39 ; and reparsed on an extensions reload, or Asterisk reload.
40 ;
41 ; If clearglobalvars is not set, then global variables will persist
42 ; through reloads, and even if deleted from the extensions.conf or
43 ; one if its included files, will remain set to the previous value.
44 ;
45 clearglobalvars=no
46 ;
47 ; If priorityjumping is set to 'yes', then applications that support
48 ; 'jumping' to a different priority based on the result of their operations
49 ; will do so (this is backwards compatible behavior with pre-1.2 releases
50 ; of Asterisk). Individual applications can also be requested to do this
51 ; by passing a 'j' option in their arguments.
52 ;
53 priorityjumping=no
54 ;
55 ; You can include other config files, use the #include command (without the ';')
56 ; Note that this is different from the "include" command that includes contexts within 
57 ; other contexts. The #include command works in all asterisk configuration files.
58 ;#include "filename.conf"
59
60 ; The "Globals" category contains global variables that can be referenced
61 ; in the dialplan with ${VARIABLE} or ${ENV(VARIABLE)} for Environmental variable
62 ; ${${VARIABLE}} or ${text${VARIABLE}} or any hybrid
63 ;
64 [globals]
65 CONSOLE=Console/dsp                             ; Console interface for demo
66 ;CONSOLE=Zap/1
67 ;CONSOLE=Phone/phone0
68 IAXINFO=guest                                   ; IAXtel username/password
69 ;IAXINFO=myuser:mypass
70 TRUNK=Zap/g2                                    ; Trunk interface
71 ;
72 ; Note the 'g2' in the TRUNK variable above. It specifies which group (defined
73 ; in zapata.conf) to dial, i.e. group 2, and how to choose a channel to use in
74 ; the specified group. The four possible options are:
75 ;
76 ; g: select the lowest-numbered non-busy Zap channel (aka. ascending sequential hunt group).
77 ; G: select the highest-numbered non-busy Zap channel (aka. descending sequential hunt group).
78 ; r: use a round-robin search, starting at the next highest channel than last time (aka. ascending rotary hunt group).
79 ; R: use a round-robin search, starting at the next lowest channel than last time (aka. descending rotary hunt group).
80 ;
81 TRUNKMSD=1                                      ; MSD digits to strip (usually 1 or 0)
82 ;TRUNK=IAX2/user:pass@provider
83
84 ;
85 ; Any category other than "General" and "Globals" represent 
86 ; extension contexts, which are collections of extensions.  
87 ;
88 ; Extension names may be numbers, letters, or combinations
89 ; thereof. If an extension name is prefixed by a '_'
90 ; character, it is interpreted as a pattern rather than a
91 ; literal.  In patterns, some characters have special meanings:
92 ;
93 ;   X - any digit from 0-9
94 ;   Z - any digit from 1-9
95 ;   N - any digit from 2-9
96 ;   [1235-9] - any digit in the brackets (in this example, 1,2,3,5,6,7,8,9)
97 ;   . - wildcard, matches anything remaining (e.g. _9011. matches 
98 ;       anything starting with 9011 excluding 9011 itself)
99 ;   ! - wildcard, causes the matching process to complete as soon as
100 ;       it can unambiguously determine that no other matches are possible
101 ;
102 ; For example the extension _NXXXXXX would match normal 7 digit dialings, 
103 ; while _1NXXNXXXXXX would represent an area code plus phone number
104 ; preceeded by a one.
105 ;
106 ; Each step of an extension is ordered by priority, which must
107 ; always start with 1 to be considered a valid extension.  The priority
108 ; "next" or "n" means the previous priority plus one, regardless of whether
109 ; the previous priority was associated with the current extension or not.
110 ; The priority "same" or "s" means the same as the previously specified
111 ; priority, again regardless of whether the previous entry was for the
112 ; same extension.  Priorities may be immediately followed by a plus sign
113 ; and another integer to add that amount (most useful with 's' or 'n').  
114 ; Priorities may then also have an alias, or label, in 
115 ; parenthesis after their name which can be used in goto situations
116 ;
117 ; Contexts contain several lines, one for each step of each
118 ; extension, which can take one of two forms as listed below,
119 ; with the first form being preferred.  One may include another
120 ; context in the current one as well, optionally with a
121 ; date and time.  Included contexts are included in the order
122 ; they are listed.
123 ;
124 ;[context]
125 ;exten => someexten,priority[+offset][(alias)],application(arg1,arg2,...)
126 ;exten => someexten,priority[+offset][(alias)],application,arg1|arg2...
127 ;
128 ; Timing list for includes is 
129 ;
130 ;   <time range>|<days of week>|<days of month>|<months>
131 ;
132 ;include => daytime|9:00-17:00|mon-fri|*|*
133 ;
134 ; ignorepat can be used to instruct drivers to not cancel dialtone upon
135 ; receipt of a particular pattern.  The most commonly used example is
136 ; of course '9' like this:
137 ;
138 ;ignorepat => 9
139 ;
140 ; so that dialtone remains even after dialing a 9.
141 ;
142
143 ;
144 ; Sample entries for extensions.conf
145 ;
146 ;
147 [dundi-e164-canonical]
148 ;
149 ; List canonical entries here
150 ;
151 ;exten => 12564286000,1,Macro(std-exten,6000,IAX2/foo)
152 ;exten => _125642860XX,1,Dial(IAX2/otherbox/${EXTEN:7})
153
154 [dundi-e164-customers]
155 ;
156 ; If you are an ITSP or Reseller, list your customers here.
157 ;
158 ;exten => _12564286000,1,Dial(SIP/customer1)
159 ;exten => _12564286001,1,Dial(IAX2/customer2)
160
161 [dundi-e164-via-pstn]
162 ;
163 ; If you are freely delivering calls to the PSTN, list them here
164 ;
165 ;exten => _1256428XXXX,1,Dial(Zap/g2/${EXTEN:7}) ; Expose all of 256-428 
166 ;exten => _1256325XXXX,1,Dial(Zap/g2/${EXTEN:7}) ; Ditto for 256-325
167
168 [dundi-e164-local]
169 ;
170 ; Context to put your dundi IAX2 or SIP user in for
171 ; full access
172 ;
173 include => dundi-e164-canonical
174 include => dundi-e164-customers
175 include => dundi-e164-via-pstn
176
177 [dundi-e164-switch]
178 ;
179 ; Just a wrapper for the switch
180 ;
181 switch => DUNDi/e164
182
183 [dundi-e164-lookup]
184 ;
185 ; Locally to lookup, try looking for a local E.164 solution
186 ; then try DUNDi if we don't have one.
187 ;
188 include => dundi-e164-local
189 include => dundi-e164-switch
190 ;
191 ; DUNDi can also be implemented as a Macro instead of using 
192 ; the Local channel driver. 
193 ;
194 [macro-dundi-e164]
195 ;
196 ; ARG1 is the extension to Dial
197 ;
198 exten => s,1,Goto(${ARG1},1)
199 include => dundi-e164-lookup
200
201 ;
202 ; Here are the entries you need to participate in the IAXTEL
203 ; call routing system.  Most IAXTEL numbers begin with 1-700, but
204 ; there are exceptions.  For more information, and to sign
205 ; up, please go to www.gnophone.com or www.iaxtel.com
206 ;
207 [iaxtel700]
208 exten => _91700XXXXXXX,1,Dial(IAX2/${IAXINFO}@iaxtel.com/${EXTEN:1}@iaxtel)
209
210 ;
211 ; The SWITCH statement permits a server to share the dialplain with
212 ; another server. Use with care: Reciprocal switch statements are not
213 ; allowed (e.g. both A -> B and B -> A), and the switched server needs
214 ; to be on-line or else dialing can be severly delayed.
215 ;
216 [iaxprovider]
217 ;switch => IAX2/user:[key]@myserver/mycontext
218
219 [trunkint]
220 ;
221 ; International long distance through trunk
222 ;
223 exten => _9011.,1,Macro(dundi-e164,${EXTEN:4})
224 exten => _9011.,n,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
225
226 [trunkld]
227 ;
228 ; Long distance context accessed through trunk
229 ;
230 exten => _91NXXNXXXXXX,1,Macro(dundi-e164,${EXTEN:1})
231 exten => _91NXXNXXXXXX,n,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
232
233 [trunklocal]
234 ;
235 ; Local seven-digit dialing accessed through trunk interface
236 ;
237 exten => _9NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
238
239 [trunktollfree]
240 ;
241 ; Long distance context accessed through trunk interface
242 ;
243 exten => _91800NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
244 exten => _91888NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
245 exten => _91877NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
246 exten => _91866NXXXXXX,1,Dial(${TRUNK}/${EXTEN:${TRUNKMSD}})
247
248 [international]
249 ;
250 ; Master context for international long distance
251 ;
252 ignorepat => 9
253 include => longdistance
254 include => trunkint
255
256 [longdistance]
257 ;
258 ; Master context for long distance
259 ;
260 ignorepat => 9
261 include => local
262 include => trunkld
263
264 [local]
265 ;
266 ; Master context for local, toll-free, and iaxtel calls only
267 ;
268 ignorepat => 9
269 include => default
270 include => parkedcalls
271 include => trunklocal
272 include => iaxtel700
273 include => trunktollfree
274 include => iaxprovider
275 ;
276 ; You can use an alternative switch type as well, to resolve
277 ; extensions that are not known here, for example with remote 
278 ; IAX switching you transparently get access to the remote
279 ; Asterisk PBX
280
281 ; switch => IAX2/user:password@bigserver/local
282 ;
283 ; An "lswitch" is like a switch but is literal, in that
284 ; variable substitution is not performed at load time
285 ; but is passed to the switch directly (presumably to
286 ; be substituted in the switch routine itself)
287 ;
288 ; lswitch => Loopback/12${EXTEN}@othercontext
289 ;
290 ; An "eswitch" is like a switch but the evaluation of
291 ; variable substitution is performed at runtime before
292 ; being passed to the switch routine.
293 ;
294 ; eswitch => IAX2/context@${CURSERVER}
295
296 [macro-stdexten];
297 ;
298 ; Standard extension macro:
299 ;   ${ARG1} - Extension  (we could have used ${MACRO_EXTEN} here as well
300 ;   ${ARG2} - Device(s) to ring
301 ;
302 exten => s,1,Dial(${ARG2},20)                                   ; Ring the interface, 20 seconds maximum
303 exten => s,2,Goto(s-${DIALSTATUS},1)                            ; Jump based on status (NOANSWER,BUSY,CHANUNAVAIL,CONGESTION,ANSWER)
304
305 exten => s-NOANSWER,1,Voicemail(u${ARG1})               ; If unavailable, send to voicemail w/ unavail announce
306 exten => s-NOANSWER,2,Goto(default,s,1)                 ; If they press #, return to start
307
308 exten => s-BUSY,1,Voicemail(b${ARG1})                   ; If busy, send to voicemail w/ busy announce
309 exten => s-BUSY,2,Goto(default,s,1)                             ; If they press #, return to start
310
311 exten => _s-.,1,Goto(s-NOANSWER,1)                              ; Treat anything else as no answer
312
313 exten => a,1,VoicemailMain(${ARG1})                             ; If they press *, send the user into VoicemailMain
314
315 [macro-stdPrivacyexten];
316 ;
317 ; Standard extension macro:
318 ;   ${ARG1} - Extension  (we could have used ${MACRO_EXTEN} here as well
319 ;   ${ARG2} - Device(s) to ring
320 ;   ${ARG3} - Optional DONTCALL context name to jump to (assumes the s,1 extension-priority)
321 ;   ${ARG4} - Optional TORTURE context name to jump to (assumes the s,1 extension-priority)`
322 ;
323 exten => s,1,Dial(${ARG2},20|p)                                 ; Ring the interface, 20 seconds maximum, call screening option (or use P for databased call screening)
324 exten => s,2,Goto(s-${DIALSTATUS},1)                            ; Jump based on status (NOANSWER,BUSY,CHANUNAVAIL,CONGESTION,ANSWER)
325
326 exten => s-NOANSWER,1,Voicemail(u${ARG1})               ; If unavailable, send to voicemail w/ unavail announce
327 exten => s-NOANSWER,2,Goto(default,s,1)                 ; If they press #, return to start
328
329 exten => s-BUSY,1,Voicemail(b${ARG1})                   ; If busy, send to voicemail w/ busy announce
330 exten => s-BUSY,2,Goto(default,s,1)                             ; If they press #, return to start
331
332 exten => s-DONTCALL,1,Goto(${ARG3},s,1)               ; Callee chose to send this call to a polite "Don't call again" script.
333
334 exten => s-TORTURE,1,Goto(${ARG4},s,1)                ; Callee chose to send this call to a telemarketer torture script.
335
336 exten => _s-.,1,Goto(s-NOANSWER,1)                              ; Treat anything else as no answer
337
338 exten => a,1,VoicemailMain(${ARG1})                             ; If they press *, send the user into VoicemailMain
339
340 [demo]
341 ;
342 ; We start with what to do when a call first comes in.
343 ;
344 exten => s,1,Wait,1                     ; Wait a second, just for fun
345 exten => s,n,Answer                     ; Answer the line
346 exten => s,n,SetVar(TIMEOUT(digit)=5)   ; Set Digit Timeout to 5 seconds
347 exten => s,n,SetVar(TIMEOUT(response)=10)       ; Set Response Timeout to 10 seconds
348 exten => s,n(restart),BackGround(demo-congrats) ; Play a congratulatory message
349 exten => s,n(instruct),BackGround(demo-instruct)        ; Play some instructions
350 exten => s,n,WaitExten          ; Wait for an extension to be dialed.
351
352 exten => 2,1,BackGround(demo-moreinfo)  ; Give some more information.
353 exten => 2,n,Goto(s,instruct)
354
355 exten => 3,1,SetVar(LANGUAGE()=fr)              ; Set language to french
356 exten => 3,n,Goto(s,restart)                    ; Start with the congratulations
357
358 exten => 1000,1,Goto(default,s,1)
359 ;
360 ; We also create an example user, 1234, who is on the console and has
361 ; voicemail, etc.
362 ;
363 exten => 1234,1,Playback(transfer,skip)         ; "Please hold while..." 
364                                         ; (but skip if channel is not up)
365 exten => 1234,n,Macro(stdexten,1234,${CONSOLE})
366
367 exten => 1235,1,Voicemail(u1234)                ; Right to voicemail
368
369 exten => 1236,1,Dial(Console/dsp)               ; Ring forever
370 exten => 1236,n,Voicemail(u1234)                ; Unless busy
371
372 ;
373 ; # for when they're done with the demo
374 ;
375 exten => #,1,Playback(demo-thanks)              ; "Thanks for trying the demo"
376 exten => #,n,Hangup                     ; Hang them up.
377
378 ;
379 ; A timeout and "invalid extension rule"
380 ;
381 exten => t,1,Goto(#,1)                  ; If they take too long, give up
382 exten => i,1,Playback(invalid)          ; "That's not valid, try again"
383
384 ;
385 ; Create an extension, 500, for dialing the
386 ; Asterisk demo.
387 ;
388 exten => 500,1,Playback(demo-abouttotry); Let them know what's going on
389 exten => 500,n,Dial(IAX2/guest@misery.digium.com/s@default)     ; Call the Asterisk demo
390 exten => 500,n,Playback(demo-nogo)      ; Couldn't connect to the demo site
391 exten => 500,n,Goto(s,6)                ; Return to the start over message.
392
393 ;
394 ; Create an extension, 600, for evaulating echo latency.
395 ;
396 exten => 600,1,Playback(demo-echotest)  ; Let them know what's going on
397 exten => 600,n,Echo                     ; Do the echo test
398 exten => 600,n,Playback(demo-echodone)  ; Let them know it's over
399 exten => 600,n,Goto(s,6)                ; Start over
400
401 ;
402 ; Give voicemail at extension 8500
403 ;
404 exten => 8500,1,VoicemailMain
405 exten => 8500,n,Goto(s,6)
406 ;
407 ; Here's what a phone entry would look like (IXJ for example)
408 ;
409 ;exten => 1265,1,Dial(Phone/phone0,15)
410 ;exten => 1265,n,Goto(s,5)
411
412 ;[mainmenu]
413 ;
414 ; Example "main menu" context with submenu
415 ;
416 ;exten => s,1,Answer
417 ;exten => s,n,Background(thanks)                ; "Thanks for calling press 1 for sales, 2 for support, ..."
418 ;exten => s,n,WaitExten
419 ;exten => 1,1,Goto(submenu,s,1)
420 ;exten => 2,1,Hangup
421 ;include => default
422 ;
423 ;[submenu]
424 ;exten => s,1,Ringing                                   ; Make them comfortable with 2 seconds of ringback
425 ;exten => s,n,Wait,2
426 ;exten => s,n,Background(submenuopts)   ; "Thanks for calling the sales department.  Press 1 for steve, 2 for..."
427 ;exten => s,n,WaitExten
428 ;exten => 1,1,Goto(default,steve,1)
429 ;exten => 2,1,Goto(default,mark,2)
430
431 [default]
432 ;
433 ; By default we include the demo.  In a production system, you 
434 ; probably don't want to have the demo there.
435 ;
436 include => demo
437
438 ;
439 ; Extensions like the two below can be used for FWD, Nikotel, sipgate etc.
440 ; Note that you must have a [sipprovider] section in sip.conf whereas
441 ; the otherprovider.net example does not require such a peer definition
442 ;
443 ;exten => _41X.,1,Dial(SIP/${EXTEN:2}@sipprovider,,r)
444 ;exten => _42X.,1,Dial(SIP/user:passwd@${EXTEN:2}@otherprovider.net,30,rT)
445
446 ; Real extensions would go here. Generally you want real extensions to be 4 or 5
447 ; digits long (although there is no such requirement) and start with a single
448 ; digit that is fairly large (like 6 or 7) so that you have plenty of room to
449 ; overlap extensions and menu options without conflict.  You can alias them with
450 ; names, too and use global variables
451
452 ;exten => 6245,hint,SIP/Grandstream1&SIP/Xlite1,Joe Schmoe ; Channel hints for presence
453 ;exten => 6245,1,Dial(SIP/Grandstream1,20,rt)   ; permit transfer
454 ;exten => 6245,n(dial),Dial(${HINT},20,rtT)             ; Use hint as listed
455 ;exten => 6245,n,Voicemail(u6245)               ; Voicemail (unavailable)
456 ;exten => 6245,s+1,Hangup                       ; s+1, same as n
457 ;exten => 6245,dial+101,Voicemail(b6245)        ; Voicemail (busy)
458 ;exten => 6361,1,Dial(IAX2/JaneDoe,,rm)         ; ring without time limit
459 ;exten => 6389,1,Dial(MGCP/aaln/1@192.168.0.14)
460 ;exten => 6394,1,Dial(Local/6275/n)             ; this will dial ${MARK}
461
462 ;exten => 6275,1,Macro(stdexten,6275,${MARK})   ; assuming ${MARK} is something like Zap/2
463 ;exten => mark,1,Goto(6275|1)                   ; alias mark to 6275
464 ;exten => 6536,1,Macro(stdexten,6236,${WIL})    ; Ditto for wil
465 ;exten => wil,1,Goto(6236|1)
466 ;
467 ; Some other handy things are an extension for checking voicemail via
468 ; voicemailmain
469 ;
470 ;exten => 8500,1,VoicemailMain
471 ;exten => 8500,n,Hangup
472 ;
473 ; Or a conference room (you'll need to edit meetme.conf to enable this room)
474 ;
475 ;exten => 8600,1,Meetme(1234)
476 ;
477 ; Or playing an announcement to the called party, as soon it answers
478 ;
479 ;exten = 8700,1,Dial(${MARK},30,A(/path/to/my/announcemsg))
480 ;
481 ; For more information on applications, just type "show applications" at your
482 ; friendly Asterisk CLI prompt.
483 ;
484 ; 'show application <command>' will show details of how you
485 ; use that particular application in this file, the dial plan. 
486 ;