dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Mailboxes 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 Mailboxes 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="Asterisk13MailboxesRESTAPI-Mailboxes">Mailboxes</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-Mailboxes-REST-API_29394325.html">/mailboxes</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Mailbox">List[Mailbox]</a> </p></td>
<td class="confluenceTd"><p> List all mailboxes. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Mailboxes-REST-API_29394325.html">/mailboxes/{mailboxName}</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Mailbox">Mailbox</a> </p></td>
<td class="confluenceTd"><p> Retrieve the current state of a mailbox. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> PUT </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Mailboxes-REST-API_29394325.html">/mailboxes/{mailboxName}</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Change the state of a mailbox. (Note - implicitly creates the mailbox). </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> DELETE </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Mailboxes-REST-API_29394325.html">/mailboxes/{mailboxName}</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Destroy a mailbox. </p></td>
</tr>
</tbody></table></div>


<p><span class="confluence-anchor-link" id="Asterisk13MailboxesRESTAPI-list"></span></p>
<h2 id="Asterisk13MailboxesRESTAPI-GET/mailboxes">GET /mailboxes</h2>

<p>List all mailboxes.</p>

<p><span class="confluence-anchor-link" id="Asterisk13MailboxesRESTAPI-get"></span></p>
<h2 id="Asterisk13MailboxesRESTAPI-GET/mailboxes/{mailboxName}">GET /mailboxes/{mailboxName}</h2>

<p>Retrieve the current state of a mailbox.</p>

<h3 id="Asterisk13MailboxesRESTAPI-Pathparameters">Path parameters</h3>
<ul>
	<li>mailboxName: string - Name of the mailbox</li>
</ul>


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


<p><span class="confluence-anchor-link" id="Asterisk13MailboxesRESTAPI-update"></span></p>
<h2 id="Asterisk13MailboxesRESTAPI-PUT/mailboxes/{mailboxName}">PUT /mailboxes/{mailboxName}</h2>

<p>Change the state of a mailbox. (Note - implicitly creates the mailbox).</p>

<h3 id="Asterisk13MailboxesRESTAPI-Pathparameters.1">Path parameters</h3>
<ul>
	<li>mailboxName: string - Name of the mailbox</li>
</ul>


<h3 id="Asterisk13MailboxesRESTAPI-Queryparameters">Query parameters</h3>
<ul>
	<li>oldMessages: int - <strong>(required)</strong> Count of old messages in the mailbox</li>
	<li>newMessages: int - <strong>(required)</strong> Count of new messages in the mailbox</li>
</ul>


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


<p><span class="confluence-anchor-link" id="Asterisk13MailboxesRESTAPI-delete"></span></p>
<h2 id="Asterisk13MailboxesRESTAPI-DELETE/mailboxes/{mailboxName}">DELETE /mailboxes/{mailboxName}</h2>

<p>Destroy a mailbox.</p>

<h3 id="Asterisk13MailboxesRESTAPI-Pathparameters.2">Path parameters</h3>
<ul>
	<li>mailboxName: string - Name of the mailbox</li>
</ul>


<h3 id="Asterisk13MailboxesRESTAPI-ErrorResponses.2">Error Responses</h3>
<ul>
	<li>404 - Mailbox not found</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>