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