dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Recordings REST API</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-ARI_29394283.html">Asterisk 13 ARI</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Asterisk Project : Asterisk 13 Recordings REST API
                        </span>
                    </h1>
                </div>

                <div id="content" class="view">
                    <div class="page-metadata">
                        
        
            Created by <span class='author'> wikibot</span> on Aug 08, 2014
                        </div>
                    <div id="main-content" class="wiki-content group">
                    <h1 id="Asterisk13RecordingsRESTAPI-Recordings">Recordings</h1>

<div class="table-wrap"><table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"><p> Method </p></th>
<th class="confluenceTh"><p> Path </p></th>
<th class="confluenceTh"><p> Return Model </p></th>
<th class="confluenceTh"><p> Summary </p></th>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/stored</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-StoredRecording">List[StoredRecording]</a> </p></td>
<td class="confluenceTd"><p> List recordings that are complete. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/stored/{recordingName}</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-StoredRecording">StoredRecording</a> </p></td>
<td class="confluenceTd"><p> Get a stored recording's details. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> DELETE </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/stored/{recordingName}</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Delete a stored recording. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> POST </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/stored/{recordingName}/copy</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-StoredRecording">StoredRecording</a> </p></td>
<td class="confluenceTd"><p> Copy a stored recording. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-LiveRecording">LiveRecording</a> </p></td>
<td class="confluenceTd"><p> List live recordings. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> DELETE </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Stop a live recording and discard it. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> POST </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}/stop</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Stop a live recording and store it. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> POST </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}/pause</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Pause a live recording. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> DELETE </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}/pause</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Unpause a live recording. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> POST </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}/mute</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Mute a live recording. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> DELETE </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Recordings-REST-API_29394322.html">/recordings/live/{recordingName}/mute</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Unmute a live recording. </p></td>
</tr>
</tbody></table></div>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-listStored"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-GET/recordings/stored">GET /recordings/stored</h2>

<p>List recordings that are complete.</p>

<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-getStored"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-GET/recordings/stored/{recordingName}">GET /recordings/stored/{recordingName}</h2>

<p>Get a stored recording's details.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-deleteStored"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-DELETE/recordings/stored/{recordingName}">DELETE /recordings/stored/{recordingName}</h2>

<p>Delete a stored recording.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.1">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.1">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-copyStored"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-POST/recordings/stored/{recordingName}/copy">POST /recordings/stored/{recordingName}/copy</h2>

<p>Copy a stored recording.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.2">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording to copy</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-Queryparameters">Query parameters</h3>
<ul>
	<li>destinationRecordingName: string - <strong>(required)</strong> The destination name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.2">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
	<li>409 - A recording with the same name already exists on the system</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-getLive"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-GET/recordings/live/{recordingName}">GET /recordings/live/{recordingName}</h2>

<p>List live recordings.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.3">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.3">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-cancel"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-DELETE/recordings/live/{recordingName}">DELETE /recordings/live/{recordingName}</h2>

<p>Stop a live recording and discard it.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.4">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.4">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-stop"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-POST/recordings/live/{recordingName}/stop">POST /recordings/live/{recordingName}/stop</h2>

<p>Stop a live recording and store it.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.5">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.5">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-pause"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-POST/recordings/live/{recordingName}/pause">POST /recordings/live/{recordingName}/pause</h2>

<p>Pause a live recording. Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.6">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.6">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
	<li>409 - Recording not in session</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-unpause"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-DELETE/recordings/live/{recordingName}/pause">DELETE /recordings/live/{recordingName}/pause</h2>

<p>Unpause a live recording.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.7">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.7">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
	<li>409 - Recording not in session</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-mute"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-POST/recordings/live/{recordingName}/mute">POST /recordings/live/{recordingName}/mute</h2>

<p>Mute a live recording. Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.8">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.8">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
	<li>409 - Recording not in session</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13RecordingsRESTAPI-unmute"></span></p>
<h2 id="Asterisk13RecordingsRESTAPI-DELETE/recordings/live/{recordingName}/mute">DELETE /recordings/live/{recordingName}/mute</h2>

<p>Unmute a live recording.</p>

<h3 id="Asterisk13RecordingsRESTAPI-Pathparameters.9">Path parameters</h3>
<ul>
	<li>recordingName: string - The name of the recording</li>
</ul>


<h3 id="Asterisk13RecordingsRESTAPI-ErrorResponses.9">Error Responses</h3>
<ul>
	<li>404 - Recording not found</li>
	<li>409 - Recording not in session</li>
</ul>
                    </div>

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