Many doc directory improvements, including:
[asterisk/asterisk.git] / doc / tex / localchannel.tex
1 \subsection{Introduction}
2
3 chan\_local is a pseudo-channel. Use of this channel simply loops calls back 
4 into the dialplan in a different context. Useful for recursive routing.
5
6 \subsection{Syntax}
7 \begin{verbatim}
8  Local/extension@context[/n]
9 \end{verbatim}
10
11 Adding "/n" at the end of the string will make the Local channel not do a 
12 native transfer (the "n" stands for "n"o release) upon the remote end answering 
13 the line. This is an esoteric, but important feature if you expect the Local 
14 channel to handle calls exactly like a normal channel. If you do not have the 
15 "no release" feature set, then as soon as the destination (inside of the Local 
16 channel) answers the line, the variables and dial plan will revert back to that 
17 of the original call, and the Local channel will become a zombie and be removed 
18 from the active channels list. This is desirable in some circumstances, but can 
19 result in unexpected dialplan behavior if you are doing fancy things with 
20 variables in your call handling.
21
22 There is another option that can be used with local channels, which is the "j" 
23 option.  The "j" option must be used with the "n" option to make sure that the 
24 local channel does not get optimized out of the call.  This option will enable 
25 a jitterbuffer on the local channel.  The jitterbuffer will be used to de-jitter 
26 audio that it receives from the channel that called the local channel.  This is 
27 especially in the case of putting chan\_local in between an incoming SIP call 
28 and Asterisk applications, so that the incoming audio will be de-jittered.
29
30 \subsection{Purpose}
31
32 The Local channel construct can be used to establish dialing into any part of 
33 the dialplan.
34
35 Imagine you have a TE410P in your box. You want to do something for which you 
36 must use a Dial statement (for instance when dropping files in 
37 \path{/var/spool/outgoing}) but you do want to be able to use your dialplans 
38 least-cost-routes or other intelligent stuff. What you could do before we had 
39 chan\_local was create a cross-link between two ports of the TE410P and then 
40 Dial out one port and in the other. This way you could control where the call 
41 was going.
42
43 Of course, this was a nasty hack, and to make it more sensible, chan\_local was 
44 built.
45
46 The "Local" channel driver allows you to convert an arbitrary extension into a 
47 channel. It is used in a variety of places, including agents, etc.
48
49 This also allows us to hop to contexts like a GoSub routine; See examples below.
50
51 \subsection{Examples}
52
53 \begin{verbatim}
54 [inbound] ; here falls all incoming calls
55 exten => s,1,Answer
56 exten => s,2,Dial(local/200@internal,30,r)
57 exten => s,3,Playback(sorrynoanswer)
58 exten => s,4,Hangup
59
60 [internal] ; here where our phones falls for default
61 exten => 200,1,Dial(sip/blah)
62 exten => 200,102,VoiceMail(${EXTEN}@default)
63   
64 exten => 201,1,Dial(zap/1)
65 exten => 201,102,VoiceMail(${EXTEN}@default)
66
67 exten => _0.,1,Dial(Zap/g1/${EXTEN:1}) ; outgoing calls with 0+number
68 \end{verbatim}
69
70 \subsection{Caveats}
71
72 If you use chan\_local from a call-file and you want to pass channel variables 
73 into your context, make sure you append the '/n', because otherwise 
74 chan\_local will 'optimize' itself out of the call-path, and the variables will 
75 get lost. i.e.
76
77 \begin{verbatim}
78  Local/00531234567@pbx becomes Local/00531234567@pbx/n
79 \end{verbatim}