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