dingyu
/
Asterisk


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
							<!DOCTYPE html>
<html>
    <head>
        <title>Asterisk Project : Asterisk 13 Events 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 Events 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="Asterisk13EventsRESTAPI-Events">Events</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-Events-REST-API_29394320.html">/events</a> </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Message">Message</a> </p></td>
<td class="confluenceTd"><p> WebSocket connection for events. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> POST </p></td>
<td class="confluenceTd"><p> <a href="Asterisk-13-Events-REST-API_29394320.html">/events/user/{eventName}</a> </p></td>
<td class="confluenceTd"><p> void </p></td>
<td class="confluenceTd"><p> Generate a user event. </p></td>
</tr>
</tbody></table></div>


<p><span class="confluence-anchor-link" id="Asterisk13EventsRESTAPI-eventWebsocket"></span></p>
<h2 id="Asterisk13EventsRESTAPI-GET/events">GET /events</h2>

<p>WebSocket connection for events.</p>

<h3 id="Asterisk13EventsRESTAPI-Queryparameters">Query parameters</h3>
<ul>
	<li>app: string - <strong>(required)</strong> Applications to subscribe to.
	<ul>
		<li>Allows comma separated values.</li>
	</ul>
	</li>
</ul>


<p><span class="confluence-anchor-link" id="Asterisk13EventsRESTAPI-userEvent"></span></p>
<h2 id="Asterisk13EventsRESTAPI-POST/events/user/{eventName}">POST /events/user/{eventName}</h2>

<p>Generate a user event.</p>

<h3 id="Asterisk13EventsRESTAPI-Pathparameters">Path parameters</h3>
<ul>
	<li>eventName: string - Event name</li>
</ul>


<h3 id="Asterisk13EventsRESTAPI-Queryparameters.1">Query parameters</h3>
<ul>
	<li>application: string - <strong>(required)</strong> The name of the application that will receive this event</li>
	<li>source: string - URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}
	<ul>
		<li>Allows comma separated values.</li>
	</ul>
	</li>
</ul>


<h3 id="Asterisk13EventsRESTAPI-Bodyparameter">Body parameter</h3>
<ul>
	<li>variables: containers - The &quot;variables&quot; key in the body object holds custom key/value pairs to add to the user event. Ex. { &quot;variables&quot;: { &quot;key&quot;: &quot;value&quot; } }</li>
</ul>


<h3 id="Asterisk13EventsRESTAPI-ErrorResponses">Error Responses</h3>
<ul>
	<li>404 - Application does not exist.</li>
	<li>422 - Event source not found.</li>
	<li>400 - Invalid even tsource URI or userevent data.</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>