dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Endpoints 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 Endpoints 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="Asterisk13EndpointsRESTAPI-Endpoints">Endpoints</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-Endpoints-REST-API_29394323.html">/endpoints</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Endpoint">List[Endpoint]</a> </p></td>
<td class="confluenceTd"><p> List all endpoints. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> PUT </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Endpoints-REST-API_29394323.html">/endpoints/sendMessage</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Send a message to some technology URI or endpoint. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Endpoints-REST-API_29394323.html">/endpoints/{tech}</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Endpoint">List[Endpoint]</a> </p></td>
<td class="confluenceTd"><p> List available endoints for a given endpoint technology. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> GET </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Endpoints-REST-API_29394323.html">/endpoints/{tech}/{resource}</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Endpoint">Endpoint</a> </p></td>
<td class="confluenceTd"><p> Details for an endpoint. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> PUT </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Endpoints-REST-API_29394323.html">/endpoints/{tech}/{resource}/sendMessage</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Send a message to some endpoint in a technology. </p></td>
</tr>
</tbody></table></div>


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

<p>List all endpoints.</p>

<p><span class="confluence-anchor-link" id="Asterisk13EndpointsRESTAPI-sendMessage"></span></p>
<h2 id="Asterisk13EndpointsRESTAPI-PUT/endpoints/sendMessage">PUT /endpoints/sendMessage</h2>

<p>Send a message to some technology URI or endpoint.</p>

<h3 id="Asterisk13EndpointsRESTAPI-Queryparameters">Query parameters</h3>
<ul>
	<li>to: string - <strong>(required)</strong> The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.</li>
	<li>from: string - <strong>(required)</strong> The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.</li>
	<li>body: string - The body of the message</li>
</ul>


<h3 id="Asterisk13EndpointsRESTAPI-Bodyparameter">Body parameter</h3>
<ul>
	<li>variables: containers -</li>
</ul>


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


<p><span class="confluence-anchor-link" id="Asterisk13EndpointsRESTAPI-listByTech"></span></p>
<h2 id="Asterisk13EndpointsRESTAPI-GET/endpoints/{tech}">GET /endpoints/{tech}</h2>

<p>List available endoints for a given endpoint technology.</p>

<h3 id="Asterisk13EndpointsRESTAPI-Pathparameters">Path parameters</h3>
<ul>
	<li>tech: string - Technology of the endpoints (sip,iax2,...)</li>
</ul>


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


<p><span class="confluence-anchor-link" id="Asterisk13EndpointsRESTAPI-get"></span></p>
<h2 id="Asterisk13EndpointsRESTAPI-GET/endpoints/{tech}/{resource}">GET /endpoints/{tech}/{resource}</h2>

<p>Details for an endpoint.</p>

<h3 id="Asterisk13EndpointsRESTAPI-Pathparameters.1">Path parameters</h3>
<ul>
	<li>tech: string - Technology of the endpoint</li>
	<li>resource: string - ID of the endpoint</li>
</ul>


<h3 id="Asterisk13EndpointsRESTAPI-ErrorResponses.2">Error Responses</h3>
<ul>
	<li>400 - Invalid parameters for sending a message.</li>
	<li>404 - Endpoints not found</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13EndpointsRESTAPI-sendMessageToEndpoint"></span></p>
<h2 id="Asterisk13EndpointsRESTAPI-PUT/endpoints/{tech}/{resource}/sendMessage">PUT /endpoints/{tech}/{resource}/sendMessage</h2>

<p>Send a message to some endpoint in a technology.</p>

<h3 id="Asterisk13EndpointsRESTAPI-Pathparameters.2">Path parameters</h3>
<ul>
	<li>tech: string - Technology of the endpoint</li>
	<li>resource: string - ID of the endpoint</li>
</ul>


<h3 id="Asterisk13EndpointsRESTAPI-Queryparameters.1">Query parameters</h3>
<ul>
	<li>from: string - <strong>(required)</strong> The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.</li>
	<li>body: string - The body of the message</li>
</ul>


<h3 id="Asterisk13EndpointsRESTAPI-Bodyparameter.1">Body parameter</h3>
<ul>
	<li>variables: containers -</li>
</ul>


<h3 id="Asterisk13EndpointsRESTAPI-ErrorResponses.3">Error Responses</h3>
<ul>
	<li>400 - Invalid parameters for sending a message.</li>
	<li>404 - Endpoint 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>