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