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