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