<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API">Asterisk 12 Bridges REST API</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~dlee">David M. Lee</a>
</h4>
<br/>
<div class="notificationGreySide">
<div>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Bridges'>Bridges</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-GET%2Fbridges'>GET /bridges</a></li>
<li><a href='#Asterisk12BridgesRESTAPI-POST%2Fbridges'>POST /bridges</a></li>
<li><a href='#Asterisk12BridgesRESTAPI-GET%2Fbridges%2F%5C'>GET /bridges/{bridgeId}</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Pathparameters'>Path parameters</a></li>
</ul>
<li><a href='#Asterisk12BridgesRESTAPI-DELETE%2Fbridges%2F%5C'>DELETE /bridges/{bridgeId}</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Pathparameters'>Path parameters</a></li>
</ul>
<li><a href='#Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2FaddChannel'>POST /bridges/{bridgeId}/addChannel</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Pathparameters'>Path parameters</a></li>
<li><a href='#Asterisk12BridgesRESTAPI-Queryparameters'>Query parameters</a></li>
</ul>
<li><a href='#Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2FremoveChannel'>POST /bridges/{bridgeId}/removeChannel</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Pathparameters'>Path parameters</a></li>
<li><a href='#Asterisk12BridgesRESTAPI-Queryparameters'>Query parameters</a></li>
</ul>
<li><a href='#Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2Frecord'>POST /bridges/{bridgeId}/record</a></li>
<ul>
<li><a href='#Asterisk12BridgesRESTAPI-Pathparameters'>Path parameters</a></li>
<li><a href='#Asterisk12BridgesRESTAPI-Queryparameters'>Query parameters</a></li>
</ul>
</ul>
</ul></div>
<h1><a name="Asterisk12BridgesRESTAPI-Bridges"></a>Bridges</h1>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Method </th>
<th class='confluenceTh'> Path </th>
<th class='confluenceTh'> Return Model </th>
<th class='confluenceTh'> Summary </th>
</tr>
<tr>
<td class='confluenceTd'> GET </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-getBridges">/bridges</a> </td>
<td class='confluenceTd'> List[Bridge] </td>
<td class='confluenceTd'> List active bridges </td>
</tr>
<tr>
<td class='confluenceTd'> POST </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-newBridge">/bridges</a> </td>
<td class='confluenceTd'> Bridge </td>
<td class='confluenceTd'> Create a new bridge </td>
</tr>
<tr>
<td class='confluenceTd'> GET </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-getBridge">/bridges/{bridgeId}</a> </td>
<td class='confluenceTd'> Bridge </td>
<td class='confluenceTd'> Get bridge details </td>
</tr>
<tr>
<td class='confluenceTd'> DELETE </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-deleteBridge">/bridges/{bridgeId}</a> </td>
<td class='confluenceTd'> </td>
<td class='confluenceTd'> Delete bridge </td>
</tr>
<tr>
<td class='confluenceTd'> POST </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-addChannelToBridge">/bridges/{bridgeId}/addChannel</a> </td>
<td class='confluenceTd'> </td>
<td class='confluenceTd'> Add a channel to a bridge </td>
</tr>
<tr>
<td class='confluenceTd'> POST </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-removeChannelFromBridge">/bridges/{bridgeId}/removeChannel</a> </td>
<td class='confluenceTd'> </td>
<td class='confluenceTd'> Remove a channel from a bridge </td>
</tr>
<tr>
<td class='confluenceTd'> POST </td>
<td class='confluenceTd'> <a href="#Asterisk12BridgesRESTAPI-recordBridge">/bridges/{bridgeId}/record</a> </td>
<td class='confluenceTd'> </td>
<td class='confluenceTd'> Start a recording </td>
</tr>
</tbody></table>
</div>
<p><a name="Asterisk12BridgesRESTAPI-getBridges"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-GET%2Fbridges"></a>GET /bridges</h2>
<p>List active bridges</p>
<p><a name="Asterisk12BridgesRESTAPI-newBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-POST%2Fbridges"></a>POST /bridges</h2>
<p>Create a new bridge</p>
<p><a name="Asterisk12BridgesRESTAPI-getBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-GET%2Fbridges%2F%5C"></a>GET /bridges/{bridgeId}</h2>
<p>Get bridge details</p>
<h3><a name="Asterisk12BridgesRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>bridgeId: string- Bridge's id</li>
</ul>
<p><a name="Asterisk12BridgesRESTAPI-deleteBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-DELETE%2Fbridges%2F%5C"></a>DELETE /bridges/{bridgeId}</h2>
<p>Delete bridge</p>
<h3><a name="Asterisk12BridgesRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>bridgeId: string- Bridge's id</li>
</ul>
<p><a name="Asterisk12BridgesRESTAPI-addChannelToBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2FaddChannel"></a>POST /bridges/{bridgeId}/addChannel</h2>
<p>Add a channel to a bridge</p>
<h3><a name="Asterisk12BridgesRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>bridgeId: string- Bridge's id</li>
</ul>
<h3><a name="Asterisk12BridgesRESTAPI-Queryparameters"></a>Query parameters</h3>
<ul>
<li>channel: string- Channel's id</li>
</ul>
<p><a name="Asterisk12BridgesRESTAPI-removeChannelFromBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2FremoveChannel"></a>POST /bridges/{bridgeId}/removeChannel</h2>
<p>Remove a channel from a bridge</p>
<h3><a name="Asterisk12BridgesRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>bridgeId: string- Bridge's id</li>
</ul>
<h3><a name="Asterisk12BridgesRESTAPI-Queryparameters"></a>Query parameters</h3>
<ul>
<li>channel: string- Channel's id</li>
</ul>
<p><a name="Asterisk12BridgesRESTAPI-recordBridge"></a></p>
<h2><a name="Asterisk12BridgesRESTAPI-POST%2Fbridges%2F%5C%2Frecord"></a>POST /bridges/{bridgeId}/record</h2>
<p>Start a recording</p>
<h3><a name="Asterisk12BridgesRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>bridgeId: string- Bridge's id</li>
</ul>
<h3><a name="Asterisk12BridgesRESTAPI-Queryparameters"></a>Query parameters</h3>
<ul>
<li>name: string- Recording's filename</li>
<li>maxDurationSeconds: int= 0- Maximum duration of the recording, in seconds. 0 for no limit.</li>
<li>maxSilenceSeconds: int= 0- Maximum duration of silence, in seconds. 0 for no limit.</li>
<li>append: boolean- If true, and recording already exists, append to recording.</li>
<li>beep: boolean- Play beep when recording begins</li>
<li>terminateOn: string= "none"- DTMF input to terminate recording.</li>
</ul>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>