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