codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / res_parking.conf.sample
1 [general]
2 ;parkeddynamic = yes            ; Enables dynamically created parkinglots. (default is no)
3                                 ; If the option is enabled then the following
4                                 ; variables can be used to dynamically create
5                                 ; new parking lots.
6                                 ;
7                                 ; The PARKINGDYNAMIC variable specifies the
8                                 ; parking lot to use as a template to create
9                                 ; a dynamic parking lot.  It is an error to
10                                 ; specify a non-existent parking lot for the
11                                 ; template.  If not set then the default
12                                 ; parking lot is used as the template.
13                                 ;
14                                 ; The PARKINGDYNCONTEXT variable specifies
15                                 ; the dialplan context to use for the newly
16                                 ; created dynamic parking lot.  If not set
17                                 ; then the context from the parking lot
18                                 ; template is used.  The context is created
19                                 ; if it does not already exist and the new
20                                 ; parking lot needs to create extensions.
21                                 ;
22                                 ; The PARKINGDYNEXTEN variable specifies the
23                                 ; parkext to use for the newly created dynamic
24                                 ; parking lot.  If not set then the parkext
25                                 ; is used from the parking lot template.  If
26                                 ; the template does not specify a parkext
27                                 ; then no extensions are created for the
28                                 ; newly created parking lot.  The dynamic
29                                 ; parking lot cannot be created if it needs
30                                 ; to create extensions that overlap existing
31                                 ; parking lot extensions.  The only exception
32                                 ; to this is for the parkext extension and
33                                 ; only if neither of the overlaping parking
34                                 ; lot's parkext is exclusive.
35                                 ;
36                                 ; The PARKINGDYNPOS variable specifies the
37                                 ; parking positions to use for the newly
38                                 ; created dynamic parking lot.  If not set
39                                 ; then the parkpos from the parking lot
40                                 ; template is used.
41
42 ; A parking lot named 'default' will automatically be used when no other
43 ; named parking lot is indicated for use by the park application or a
44 ; channel's parkinglot function and PARKINGLOT channel variable. This parking
45 ; lot is guaranteed to exist and will be created even if default is left out of
46 ; the configuration file.
47
48 [default]                       ; Default Parking Lot
49 parkext => 700                  ; What extension to dial to park. (optional; if
50                                 ; specified, extensions will be created for parkext and
51                                 ; the whole range of parkpos)
52                                 ;
53                                 ; Note: Generated parking extensions cannot overlap.
54                                 ; The only exception is if neither overlapping parkext
55                                 ; is exclusive.
56
57 ;parkext_exclusive=yes          ; Specify that the parkext created for this parking lot
58                                 ; will only access this parking lot. (default is no)
59
60 parkpos => 701-720              ; What range of parking spaces to use - must be numeric
61                                 ; Creates these spaces as extensions if parkext is set.
62                                 ; Since this value is interpreted numerically, leading 0's
63                                 ; will be ignored (so expect 00700-00720 to map to 700-720)
64
65 context => parkedcalls          ; Which context parked calls and the default park
66
67 ;parkinghints = no              ; Add hints priorities automatically for parkpos
68                                 ; extensions if parkext is set
69
70 ;parkingtime => 45              ; Number of seconds a call can be parked before returning
71
72 ;comebacktoorigin = yes         ; Setting this option configures the behavior of call parking when the
73                                 ; parked call times out (See the parkingtime option).  The default value is 'yes'.
74                                 ;
75                                 ; 'yes' - When the parked call times out, attempt to send the call back to the peer
76                                 ;         that parked this call. This is done by saving off the name of the channel
77                                 ;         that parked the call. The call will return to the context 'park-dial' and
78                                 ;         an extension created based on the name of the channel that originally parked
79                                 ;         the call.  This extension will be created automatically to do a Dial() to the
80                                 ;         device that originally parked the call for comebacktodialtime seconds. If the
81                                 ;         call is not answered, the call will proceed to the next priority (usually none
82                                 ;         unless you deliberately set up a catch-all second priority in the park-call
83                                 ;         context) in the dialplan for extension matching the peer name (same as how
84                                 ;         peer names are flattened into extensions when comebacktoorigin is 'no').
85                                 ;
86                                 ; 'no'  - This option is useful for performing custom dialplan functionality prior to
87                                 ;         sending the call back to the extension that initially parked the call, or to
88                                 ;         an entirely different destination.
89                                 ;
90                                 ;         When the parked call times out, send it back to the dialplan.  The location
91                                 ;         will be defined by the comebackcontext option. The extension will be built from
92                                 ;         the saved channel name that parked the call. For example, if a SIP peer named
93                                 ;         '0004F2040001' parked this call, the extension will be 'SIP_0004F2040001'.
94                                 ;         (Note that an underscore is used here because the '/' character has a special
95                                 ;         meaning in extension names for CallerID matching.)  If this extension does not
96                                 ;         exist, the call will be sent to the 's' extension, instead.  Finally, if the 's'
97                                 ;         extension of 'parkedcallstimeout' does not exist, the call will fall back to the
98                                 ;         's' extension of the 'default' context.
99                                 ;
100                                 ;         Additionally, in this example an extension of 'SIP_0004F2040001' will be
101                                 ;         created in the 'park-dial' context.  This extension will be set up to do a
102                                 ;         Dial() to 'SIP/0004F2040001'.
103                                 ;
104                                 ; During the timeout procedure, the following variables are set
105                                 ; PARKING_SPACE - extension that the call was parked in prior to timing out
106                                 ; PARKEDLOT - name of the lot that the call was parked in prior to timing out
107                                 ; PARKER - dial string to call the device that parked the call
108
109 ;comebackdialtime = 30          ; When a parked call times out, this is the number of seconds to dial the device that
110                                 ; originally parked the call.  It is also available as a channel variable COMEBACKDIALTIME
111                                 ; after a parked call has timed out.
112                                 ; The default value is 30 seconds.
113
114 ;comebackcontext = parkedcallstimeout
115                                 ; The context a timed out call will return to if comebcktoorigin=no.
116                                 ; The default value is 'parkedcallstimeout'.
117
118 ;courtesytone = beep            ; Sound file to play to when someone picks up a parked call
119                                 ; and also when the Touch Monitor is activated/deactivated.
120                                 ; Default is no tone.
121
122 ;parkedplay = caller            ; Who to play courtesytone to when picking up a parked call.
123                                 ; One of: parked, caller, both  (default is caller)
124
125 ;parkedcalltransfers = caller   ; Enables or disables DTMF based transfers when picking up a parked call.
126                                 ; one of: callee, caller, both, no (default is no)
127
128 ;parkedcallreparking = caller   ; Enables or disables DTMF based parking when picking up a parked call.
129                                 ; one of: callee, caller, both, no (default is no)
130
131 ;parkedcallhangup = caller      ; Enables or disables DTMF based hangups when picking up a parked call.
132                                 ; one of: callee, caller, both, no (default is no)
133
134 ;findslot => next               ; Sets the method for selecting parking spaces when a call is parked
135                                 ; 'next' - use the next parking space from the most recently used one.
136                                 ; 'first' - use the lowest numbered parking space available
137
138 ;parkedmusicclass = default     ; This is the MOH class to use for the parked channel
139                                 ; as long as the class is not set on the channel directly
140                                 ; using Set(CHANNEL(musicclass)=whatever) in the dialplan
141
142 ;*** Define another parking lot
143 ;
144 ; The parkinglot used can be set with the CHANNEL(parkinglot) dialplan function or by
145 ; setting the 'parkinglot' configuration for a channel in its configuration file.
146 ;
147 ; Parking lots can now be any named configuration category aside from
148 ; 'general' which is reserved for general options. They no longer need to be
149 ; prefixed with 'parkinglot_'
150 ;
151 ;[edvina]
152 ;context => edvina_park
153 ;parkpos => 800-850
154 ;findslot => next
155 ;comebacktoorigin = no
156 ;comebackdialtime = 90
157 ;comebackcontext = edvinapark-timeout
158 ;parkedmusicclass = edvina
159 ;
160 ; Since edvina doesn't define parkext, extensions won't automatically be
161 ; created for parking to it or for retrieving calls from it. These can be
162 ; created manually in the dial plan by using the Park and ParkedCall
163 ; applications.