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