dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Configuration_res_parking</title>
        <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    </head>

    <body class="theme-default aui-theme-default">
        <div id="page">
            <div id="main" class="aui-page-panel">
                <div id="main-header">
                    <div id="breadcrumb-section">
                        <ol id="breadcrumbs">
                            <li class="first">
                                <span><a href="index.html">Asterisk Project</a></span>
                            </li>
                                                    <li>
                                <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
                            </li>
                                                    <li>
                                <span><a href="Asterisk-13-Module-Configuration_29394289.html">Asterisk 13 Module Configuration</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Asterisk Project : Asterisk 13 Configuration_res_parking
                        </span>
                    </h1>
                </div>

                <div id="content" class="view">
                    <div class="page-metadata">
                        
        
            Created and last modified by <span class='author'> wikibot</span> on Aug 11, 2014
                        </div>
                    <div id="main-content" class="wiki-content group">
                    

<p>This configuration documentation is for functionality provided by <code>res_parking</code>.</p>

<h2 id="Asterisk13Configuration_res_parking-res_parking.conf">res_parking.conf</h2>

<h3 id="Asterisk13Configuration_res_parking-globals">globals</h3>

<p>Options that apply to every parking lot</p>

<h4 id="Asterisk13Configuration_res_parking-ConfigurationOptionReference">Configuration Option Reference</h4>

<div class="table-wrap"><table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"><p> Option Name </p></th>
<th class="confluenceTh"><p> Type </p></th>
<th class="confluenceTh"><p> Default Value </p></th>
<th class="confluenceTh"><p> Regular Expression </p></th>
<th class="confluenceTh"><p> Description </p></th>
</tr>
<tr>
<td class="confluenceTd"><p> <code>parkeddynamic</code> </p></td>
<td class="confluenceTd"><p> <code>Boolean</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Enables dynamically created parkinglots. </p></td>
</tr>
</tbody></table></div>

<h3 id="Asterisk13Configuration_res_parking-parking_lot">parking_lot</h3>

<p>Defined parking lots for res_parking to use to park calls on</p>

<h4 id="Asterisk13Configuration_res_parking-ConfigurationOptionReference.1">Configuration Option Reference</h4>

<div class="table-wrap"><table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"><p> Option Name </p></th>
<th class="confluenceTh"><p> Type </p></th>
<th class="confluenceTh"><p> Default Value </p></th>
<th class="confluenceTh"><p> Regular Expression </p></th>
<th class="confluenceTh"><p> Description </p></th>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>context</code></a> </p></td>
<td class="confluenceTd"><p> <code>String</code> </p></td>
<td class="confluenceTd"><p> <code>parkedcalls</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> The name of the context where calls are parked and picked up from. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkext</code></a> </p></td>
<td class="confluenceTd"><p> <code>String</code> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Extension to park calls to this parking lot. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>parkext_exclusive</code> </p></td>
<td class="confluenceTd"><p> <code>Boolean</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> If yes, the extension registered as parkext will park exclusively to this parking lot. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkpos</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>701-750</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Numerical range of parking spaces which can be used to retrieve parked calls. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>parkinghints</code> </p></td>
<td class="confluenceTd"><p> <code>Boolean</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> If yes, this parking lot will add hints automatically for parking spaces. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>parkingtime</code> </p></td>
<td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
<td class="confluenceTd"><p> <code>45</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Amount of time a call will remain parked before giving up (in seconds). </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>parkedmusicclass</code> </p></td>
<td class="confluenceTd"><p> <code>String</code> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Which music class to use for parked calls. They will use the default if unspecified. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>comebacktoorigin</code></a> </p></td>
<td class="confluenceTd"><p> <code>Boolean</code> </p></td>
<td class="confluenceTd"><p> <code>yes</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Determines what should be done with the parked channel if no one picks it up before it times out. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>comebackdialtime</code> </p></td>
<td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
<td class="confluenceTd"><p> <code>30</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Timeout for the Dial extension created to call back the parker when a parked call times out. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>comebackcontext</code></a> </p></td>
<td class="confluenceTd"><p> <code>String</code> </p></td>
<td class="confluenceTd"><p> <code>parkedcallstimeout</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Context where parked calls will enter the PBX on timeout when comebacktoorigin=no </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>courtesytone</code></a> </p></td>
<td class="confluenceTd"><p> <code>String</code> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> If the name of a sound file is provided, use this as the courtesy tone </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkedplay</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>caller</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Who we should play the courtesytone to on the pickup of a parked call from this lot </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkedcalltransfers</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Who to apply the DTMF transfer features to when parked calls are picked up or timeout. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkedcallreparking</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Who to apply the DTMF parking feature to when parked calls are picked up or timeout. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkedcallhangup</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Who to apply the DTMF hangup feature to when parked calls are picked up or timeout. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>parkedcallrecording</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>no</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Who to apply the DTMF MixMonitor recording feature to when parked calls are picked up or timeout. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_parking_29394918.html"><code>findslot</code></a> </p></td>
<td class="confluenceTd"><p> <code>Custom</code> </p></td>
<td class="confluenceTd"><p> <code>first</code> </p></td>
<td class="confluenceTd"><p> <code>false</code> </p></td>
<td class="confluenceTd"><p> Rule to use when trying to figure out which parking space a call should be parked with. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <code>courtesytone</code> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> </p></td>
<td class="confluenceTd"><p> If set, the sound set will be played to whomever is set by parkedplay </p></td>
</tr>
</tbody></table></div>

<h4 id="Asterisk13Configuration_res_parking-ConfigurationOptionDescriptions">Configuration Option Descriptions</h4>

<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_context"></span></p>
<h5 id="Asterisk13Configuration_res_parking-context">context</h5>

<p>This option is only used if parkext is set.</p>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkext"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkext">parkext</h5>

<p>If this option is used, this extension will automatically be created to place calls into parking lots. In addition, if parkext_exclusive is set for this parking lot, the name of the parking lot will be included in the application's arguments so that it only parks to this parking lot. The extension will be created in <code>context</code>. Using this option also creates extensions for retrieving parked calls from the parking spaces in the same context.</p>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkpos"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkpos">parkpos</h5>

<p>If parkext is set, these extensions will automatically be mapped in <code>context</code> in order to pick up calls parked to these parking spaces.</p>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_comebacktoorigin"></span></p>
<h5 id="Asterisk13Configuration_res_parking-comebacktoorigin">comebacktoorigin</h5>

<p>Valid Options:</p>

<ul>
	<li><code>yes</code> - Automatically have the parked channel dial the device that parked the call with dial timeout set by the <code>parkingtime</code> option. When the call times out an extension to dial the PARKER will automatically be created in the <code>park-dial</code> context with an extension of the flattened parker device name. If the call is not answered, the parked channel that is timing out will continue in the dial plan at that point if there are more priorities in the extension (which won't be the case unless the dialplan deliberately includes such priorities in the <code>park-dial</code> context through pattern matching or deliberately written flattened peer extensions).</li>
	<li><code>no</code> - Place the call into the PBX at <code>comebackcontext</code> instead. The extension will still be set as the flattened peer name. If an extension the flattened peer name isn't available then it will fall back to the <code>s</code> extension. If that also is unavailable it will attempt to fall back to <code>s@default</code>. The normal dial extension will still be created in the <code>park-dial</code> context with the extension also being the flattened peer name.
    <div class="aui-message hint shadowed information-macro">
                    <p class="title">Note</p>
                            <span class="aui-icon icon-hint">Icon</span>
                <div class="message-content">
                            
<p>Flattened Peer Names - Extensions can not include slash characters since those are used for pattern matching. When a peer name is flattened, slashes become underscores. For example if the parker of a call is called <code>SIP/0004F2040001</code> then flattened peer name and therefor the extensions created and used on timeouts will be <code>SIP_0004F204001</code>.</p>

                    </div>
    </div>

    <div class="aui-message hint shadowed information-macro">
                    <p class="title">Note</p>
                            <span class="aui-icon icon-hint">Icon</span>
                <div class="message-content">
                            
<p>When parking times out and the channel returns to the dial plan, the following variables are set:</p>

                    </div>
    </div>
</li>
	<li><code>PARKING_SPACE</code> - extension that the call was parked in prior to timing out.</li>
	<li><code>PARKINGSLOT</code> - Deprecated. Use <code>PARKING_SPACE</code> instead.</li>
	<li><code>PARKEDLOT</code> - name of the lot that the call was parked in prior to timing out.</li>
	<li><code>PARKER</code> - The device that parked the call</li>
	<li><code>PARKER_FLAT</code> - The flat version of <code>PARKER</code></li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_comebackcontext"></span></p>
<h5 id="Asterisk13Configuration_res_parking-comebackcontext">comebackcontext</h5>

<p>The extension the call enters will prioritize the flattened peer name in this context. If the flattened peer name extension is unavailable, then the 's' extension in this context will be used. If that also is unavailable, the 's' extension in the 'default' context will be used.</p>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_courtesytone"></span></p>
<h5 id="Asterisk13Configuration_res_parking-courtesytone">courtesytone</h5>

<p>By default, this tone is only played to the caller of a parked call. Who receives the tone can be changed using the <code>parkedplay</code> option.</p>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkedplay"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkedplay">parkedplay</h5>

<ul>
	<li><code>no</code> - Apply to neither side.</li>
	<li><code>caller</code> - Apply only to the call connecting with the call coming out of the parking lot.</li>
	<li><code>callee</code> - Apply only to the call coming out of the parking lot.</li>
	<li><code>both</code> - Apply to both sides.
    <div class="aui-message hint shadowed information-macro">
                    <p class="title">Note</p>
                            <span class="aui-icon icon-hint">Icon</span>
                <div class="message-content">
                            
<p>If courtesy tone is not specified then this option will be ignored.</p>

                    </div>
    </div>
</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkedcalltransfers"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkedcalltransfers">parkedcalltransfers</h5>

<ul>
	<li><code>no</code> - Apply to neither side.</li>
	<li><code>caller</code> - Apply only to the call connecting with the call coming out of the parking lot.</li>
	<li><code>callee</code> - Apply only to the call coming out of the parking lot.</li>
	<li><code>both</code> - Apply to both sides.</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkedcallreparking"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkedcallreparking">parkedcallreparking</h5>

<ul>
	<li><code>no</code> - Apply to neither side.</li>
	<li><code>caller</code> - Apply only to the call connecting with the call coming out of the parking lot.</li>
	<li><code>callee</code> - Apply only to the call coming out of the parking lot.</li>
	<li><code>both</code> - Apply to both sides.</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkedcallhangup"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkedcallhangup">parkedcallhangup</h5>

<ul>
	<li><code>no</code> - Apply to neither side.</li>
	<li><code>caller</code> - Apply only to the call connecting with the call coming out of the parking lot.</li>
	<li><code>callee</code> - Apply only to the call coming out of the parking lot.</li>
	<li><code>both</code> - Apply to both sides.</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_parkedcallrecording"></span></p>
<h5 id="Asterisk13Configuration_res_parking-parkedcallrecording">parkedcallrecording</h5>

<ul>
	<li><code>no</code> - Apply to neither side.</li>
	<li><code>caller</code> - Apply only to the call connecting with the call coming out of the parking lot.</li>
	<li><code>callee</code> - Apply only to the call coming out of the parking lot.</li>
	<li><code>both</code> - Apply to both sides.</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_parking-parking_lot_findslot"></span></p>
<h5 id="Asterisk13Configuration_res_parking-findslot">findslot</h5>

<ul>
	<li><code>first</code> - Always try to place in the lowest available space in the parking lot</li>
	<li><code>next</code> - Track the last parking space used and always attempt to use the one immediately after.</li>
</ul>


<h3 id="Asterisk13Configuration_res_parking-ImportVersion">Import Version</h3>

<p>This documentation was imported from Asterisk Version SVN-branch-13-r420717</p>
                    </div>

                    
                </div>             </div> 
            <div id="footer">
                <section class="footer-body">
                    <p>Document generated by Confluence on Aug 11, 2014 13:48</p>
                </section>
            </div>
        </div>     </body>
</html>