Merged revisions 378374,378377,378384 via svnmerge from
[asterisk/asterisk.git] / configs / features.conf.sample
1 ;
2 ; Sample Call Features (parking, transfer, etc) configuration
3 ;
4
5 [general]
6 parkext => 700                  ; What extension to dial to park.  Set per parking lot.
7 ;parkext_exclusive=yes          ; Specify that the parkext created for this parking lot
8                                 ; will only access this parking lot. (default is no)
9 parkpos => 701-720              ; What extensions to park calls on. (defafult parking lot)
10                                 ; These need to be numeric, as Asterisk starts from the start position
11                                 ; and increments with one for the next parked call.
12                                 ; Set per parking lot.
13 context => parkedcalls          ; Which context parked calls are in (default parking lot)
14                                 ; Set per parking lot.
15 ;parkinghints = no              ; Add hints priorities automatically for parking slots (default is no).
16                                 ; Set per parking lot.
17 ;parkingtime => 45              ; Number of seconds a call can be parked before returning.
18                                 ; Set per parking lot. (default is 45 seconds)
19
20 ;comebacktoorigin = yes         ; Setting this option configures the behavior of call parking when the
21                                 ; parked call times out (See the parkingtime option).  The default value is 'yes'.
22                                 ; Set per parking lot.
23                                 ;
24                                 ; 'yes' - When the parked call times out, attempt to send the call back to the peer
25                                 ;         that parked this call. This is done by saving off the name of the channel
26                                 ;         that parked the call. The call will return to the context 'park-dial' and
27                                 ;         an extension created based on the name of the channel that originally parked
28                                 ;         the call.  This extension will be created automatically to do a Dial() to the
29                                 ;         device that originally parked the call for comebacktodialtime seconds. If the
30                                 ;         call is not answered, the call will proceed to 'park-dial,t,1'.
31                                 ;
32                                 ; 'no'  - This option is useful for performing custom dialplan functionality prior to
33                                 ;         sending the call back to the extension that initially parked the call, or to
34                                 ;         an entirely different destination.
35                                 ;
36                                 ;         When the parked call times out, send it back to the dialplan.  The location
37                                 ;         will be defined by the comebackcontext option. The extension will be built from
38                                 ;         the saved channel name that parked the call. For example, if a SIP peer named
39                                 ;         '0004F2040001' parked this call, the extension will be 'SIP_0004F2040001'.
40                                 ;         (Note that an underscore is used here because the '/' character has a special
41                                 ;         meaning in extension names for CallerID matching.)  If this extension does not
42                                 ;         exist, the call will be sent to the 's' extension, instead.  Finally, if the 's'
43                                 ;         extension of 'parkedcallstimeout' does not exist, the call will fall back to the
44                                 ;         's' extension of the 'default' context.
45                                 ;
46                                 ;         Additionally, in this example an extension of 'SIP_0004F2040001' will be
47                                 ;         created in the 'park-dial' context.  This extension will be set up to do a
48                                 ;         Dial() to 'SIP/0004F2040001'.
49                                 ;
50                                 ;         During the timeout procedure, the following variables are set
51                                 ;         PARKINGSLOT - extension that the call was parked in prior to timing out
52                                 ;         PARKEDLOT - name of the lot that the call was parked in prior to timing out
53                                 ;         PARKER - name of the device that parked the call
54
55 ;comebackdialtime = 30          ; When a parked call times out, this is the number of seconds to dial the device that
56                                 ; originally parked the call.  It is also available as a channel variable COMEBACKDIALTIME
57                                 ; after a parked call has timed out.
58                                 ; The default value is 30 seconds.
59                                 ; Set per parking lot.
60
61 ;comebackcontext = parkedcallstimeout
62                                 ; The context a timed out call will return to if comebcktoorigin=no.
63                                 ; The default value is 'parkedcallstimeout'.
64                                 ; Set per parking lot.
65
66 ;courtesytone = beep            ; Sound file to play to when someone picks up a parked call
67                                 ; and also when the Touch Monitor is activated/deactivated.
68                                 ; Default is no tone.
69 ;parkedplay = caller            ; Who to play courtesytone to when picking up a parked call.
70                                 ; One of: parked, caller, both  (default is caller)
71                                 ; Operates on all parking lots.
72 ;parkedcalltransfers = caller   ; Enables or disables DTMF based transfers when picking up a parked call.
73                                 ; one of: callee, caller, both, no (default is no)
74                                 ; Set per parking lot.
75 ;parkedcallreparking = caller   ; Enables or disables DTMF based parking when picking up a parked call.
76                                 ; one of: callee, caller, both, no (default is no)
77                                 ; Set per parking lot.
78 ;parkedcallhangup = caller      ; Enables or disables DTMF based hangups when picking up a parked call.
79                                 ; one of: callee, caller, both, no (default is no)
80                                 ; Set per parking lot.
81 ;parkedcallrecording = caller   ; Enables or disables DTMF based one-touch recording when picking up a parked call.
82                                 ; one of: callee, caller, both, no (default is no)
83                                 ; Set per parking lot.
84 ;parkeddynamic = yes            ; Enables dynamically created parkinglots. (default is no)
85                                 ; Operates on all parking lots.
86 ;adsipark = yes                 ; if you want ADSI parking announcements
87                                 ; Operates on all parking lots.
88 ;findslot => next               ; Continue to the 'next' free parking space.
89                                 ; Defaults to 'first' available
90                                 ; Set per parking lot.
91 ;parkedmusicclass=default       ; This is the MOH class to use for the parked channel
92                                 ; as long as the class is not set on the channel directly
93                                 ; using Set(CHANNEL(musicclass)=whatever) in the dialplan
94                                 ; Set per parking lot.
95
96 ;transferdigittimeout => 3      ; Number of seconds to wait between digits when transferring a call
97                                 ; (default is 3 seconds)
98 ;xfersound = beep               ; to indicate an attended transfer is complete
99 ;xferfailsound = beeperr        ; to indicate a failed transfer
100 ;pickupexten = *8               ; Configure the pickup extension. (default is *8)
101 ;pickupsound = beep             ; to indicate a successful pickup (default: no sound)
102 ;pickupfailsound = beeperr      ; to indicate that the pickup failed (default: no sound)
103 ;featuredigittimeout = 1000     ; Max time (ms) between digits for
104                                 ; feature activation  (default is 1000 ms)
105 ;atxfernoanswertimeout = 15     ; Timeout for answer on attended transfer default is 15 seconds.
106 ;atxferdropcall = no            ; If someone does an attended transfer, then hangs up before the transferred
107                                 ; caller is connected, then by default, the system will try to call back the
108                                 ; person that did the transfer.  If this is set to "yes", the callback will
109                                 ; not be attempted and the transfer will just fail.
110                                 ; For atxferdropcall=no to work properly, you also need to
111                                 ; define ATXFER_NULL_TECH in main/features.c.  The reason the
112                                 ; code is not enabled by default is spelled out in the comment
113                                 ; block near the top of main/features.c describing ATXFER_NULL_TECH.
114 ;atxferloopdelay = 10           ; Number of seconds to sleep between retries (if atxferdropcall = no)
115 ;atxfercallbackretries = 2      ; Number of times to attempt to send the call back to the transferer.
116                                 ; By default, this is 2.
117
118 ;
119 ;*** Define another parking lot
120 ;
121 ; You can set parkinglot with the CHANNEL dialplan function
122 ; or by setting 'parkinglot' directly in the channel configuration file.
123 ;
124 ; (Note: Leading '0's and any non-numerical characters on parkpos extensions
125 ;  will be ignored.  Parkext on the other hand can be any string.)
126 ;
127 ;[parkinglot_edvina]
128 ;context => edvinapark
129 ;parkext => 799
130 ;parkpos => 800-850
131 ;findslot => next
132 ;comebacktoorigin = no
133 ;comebackdialtime = 90
134 ;comebackcontext = edvinapark-timeout ; Make sure you create the context!
135 ;parkedmusicclass = edvina
136
137 ; Note that the DTMF features listed below only work when two channels have answered and are bridged together.
138 ; They can not be used while the remote party is ringing or in progress. If you require this feature you can use
139 ; chan_local in combination with Answer to accomplish it.
140
141
142 [featuremap]
143 ;blindxfer => #1                ; Blind transfer  (default is #) -- Make sure to set the T and/or t option in the Dial() or Queue() app call!
144 ;disconnect => *0               ; Disconnect  (default is *) -- Make sure to set the H and/or h option in the Dial() or Queue() app call!
145 ;automon => *1                  ; One Touch Record a.k.a. Touch Monitor -- Make sure to set the W and/or w option in the Dial() or Queue() app call!
146 ;atxfer => *2                   ; Attended transfer  -- Make sure to set the T and/or t option in the Dial() or Queue()  app call!
147 ;parkcall => #72                ; Park call (one step parking)  -- Make sure to set the K and/or k option in the Dial() app call!
148 ;automixmon => *3               ; One Touch Record a.k.a. Touch MixMonitor -- Make sure to set the X and/or x option in the Dial() or Queue() app call!
149
150 [applicationmap]
151 ; Note that the DYNAMIC_FEATURES channel variable must be set to use the features
152 ; defined here.  The value of DYNAMIC_FEATURES should be the names of the features
153 ; to allow the channel to use separated by '#'.  For example:
154 ;
155 ;    Set(__DYNAMIC_FEATURES=myfeature1#myfeature2#myfeature3)
156 ;
157 ; (Note: The two leading underscores allow these feature settings to be set on
158 ;  on the outbound channels, as well.  Otherwise, only the original channel
159 ;  will have access to these features.)
160 ;
161 ; The syntax for declaring a dynamic feature is any of the following:
162 ;
163 ;<FeatureName> => <DTMF_sequence>,<ActivateOn>[/<ActivatedBy>],<Application>[,<AppArguments>[,MOH_Class]]
164 ;<FeatureName> => <DTMF_sequence>,<ActivateOn>[/<ActivatedBy>],<Application>[,"<AppArguments>"[,MOH_Class]]
165 ;<FeatureName> => <DTMF_sequence>,<ActivateOn>[/<ActivatedBy>],<Application>([<AppArguments>])[,MOH_Class]
166
167 ;
168 ;  FeatureName   -> This is the name of the feature used when setting the
169 ;                   DYNAMIC_FEATURES variable to enable usage of this feature.
170 ;  DTMF_sequence -> This is the key sequence used to activate this feature.
171 ;  ActivateOn    -> This is the channel of the call that the application will be executed
172 ;                   on. Valid values are "self" and "peer". "self" means run the
173 ;                   application on the same channel that activated the feature. "peer"
174 ;                   means run the application on the opposite channel from the one that
175 ;                   has activated the feature.
176 ;  ActivatedBy   -> This is which channel is allowed to activate this feature. Valid
177 ;                   values are "caller", "callee", and "both". "both" is the default.
178 ;                   The "caller" is the channel that executed the Dial application, while
179 ;                   the "callee" is the channel called by the Dial application.
180 ;  Application   -> This is the application to execute.
181 ;  AppArguments  -> These are the arguments to be passed into the application.  If you need
182 ;                   commas in your arguments, you should use either the second or third
183 ;                   syntax, above.
184 ;  MOH_Class     -> This is the music on hold class to play while the idle
185 ;                   channel waits for the feature to complete. If left blank,
186 ;                   no music will be played.
187 ;
188
189 ;
190 ; IMPORTANT NOTE: The applicationmap is not intended to be used for all Asterisk
191 ;   applications. When applications are used in extensions.conf, they are executed
192 ;   by the PBX core. In this case, these applications are executed outside of the
193 ;   PBX core, so it does *not* make sense to use any application which has any
194 ;   concept of dialplan flow. Examples of this would be things like Macro, Goto,
195 ;   Background, WaitExten, and many more.
196 ;
197 ; Enabling these features means that the PBX needs to stay in the media flow and
198 ; media will not be re-directed if DTMF is sent in the media stream.
199 ;
200 ; Example Usage:
201 ;
202 ;testfeature => #9,peer,Playback,tt-monkeys  ;Allow both the caller and callee to play
203 ;                                            ;tt-monkeys to the opposite channel
204 ;
205 ; Set arbitrary channel variables, based upon CALLERID number (Note that the application
206 ; argument contains commas)
207 ;retrieveinfo => #8,peer,Set(ARRAY(CDR(mark),CDR(name))=${ODBC_FOO(${CALLERID(num)})})
208 ;
209 ;pauseMonitor   => #1,self/callee,Pausemonitor     ;Allow the callee to pause monitoring
210 ;                                                  ;on their channel
211 ;unpauseMonitor => #3,self/callee,UnPauseMonitor   ;Allow the callee to unpause monitoring
212 ;                                                  ;on their channel
213
214 ; Dynamic Feature Groups:
215 ;   Dynamic feature groups are groupings of features defined in [applicationmap]
216 ;   that can have their own custom key mappings.  To give a channel access to a dynamic
217 ;   feature group, add the group name to the value of the DYNAMIC_FEATURES variable.
218 ;
219 ; example:
220 ; [myGroupName]         ; defines the group named myGroupName
221 ; testfeature => #9     ; associates testfeature with the group and the keycode '#9'.
222 ; pauseMonitor =>       ; associates pauseMonitor with the group and uses the keycode specified
223 ;                       ; in the [applicationmap].