<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<base href="https://wiki.asterisk.org/wiki" />
<title>Message Title</title>
<style type="text/css">@media only screen and (max-device-width: 480px) {.mobile-only {
width: auto !important;
height: auto !important;
overflow: visible !important;
line-height: normal !important;
font-size: inherit !important;
mso-hide: all;
}
.desktop-only {
display: none !important;
}
/* iPhone 3GS fix for unwanted 20px right margin */
body { min-width: 100% !important; padding: 0; margin: 0; }
#center-content-table { max-width: none; !important; }
#header-pattern-container { padding: 10px 10px 10px 10px !important; line-height: 20px !important; }
#header-avatar-image-container { padding-right: 8px !important; }
#email-content-container { padding: 0 !important; }
.mobile-expand { border-radius: 0 !important; border-left: 0 !important; border-right: 0 !important; padding-left: 26px !important;}
.mobile-resize-text { font-size: 16px !important; line-height: 22px !important; }
#page-title-pattern-header { font-size: 20px !important; line-height: 28px !important; }
#page-title-pattern-icon-image-container-cell { padding-top: 7px !important; }
#inline-user-pattern { display: block !important; }
#inline-user-pattern-avatar { padding-top: 3px !important; }
.contextual-area-pattern { border-bottom: 1px solid #ccc !important; padding: 15px 10px 0 10px !important;}
.users-involved-pattern-column-table { width: 100% !important; }
.users-involved-pattern-avatar-table-cell { padding: 3px 5px 5px 0 !important; }
.users-involved-pattern-column-container { padding-right: 0 !important; }
.contextual-excerpt-pattern, #users-involved-pattern { border: 0 !important; }
/** Aui Typography upsized for mobile **/
#content-excerpt-pattern-container, #contextual-excerpt-pattern-text-container { font-size: 16px !important; line-height: 22px !important; }
#content-excerpt-pattern-container h1, #contextual-excerpt-pattern-text-container h1 { font-size: 24px !important; line-height: 28px !important; }
#content-excerpt-pattern-container h2, #contextual-excerpt-pattern-text-container h2 { font-size: 20px !important; line-height: 28px !important; }
#content-excerpt-pattern-container h3, #contextual-excerpt-pattern-text-container h3 { font-size: 18px !important; line-height: 24px !important; }
#content-excerpt-pattern-container h4, #contextual-excerpt-pattern-text-container h4 { font-size: 16px !important; line-height: 22px !important; }
#content-excerpt-pattern-container h5, #contextual-excerpt-pattern-text-container h5 { font-size: 14px !important; line-height: 20px !important; }
#content-excerpt-pattern-container h6, #contextual-excerpt-pattern-text-container h6 { font-size: 14px !important; line-height: 20px !important; }
.user-mention { line-height: 18px !important; }
/** Aui Typography end **/
/* Show appropriate footer logo on mobile, display links vertically */
#footer-pattern { padding: 15px 10px !important; }
#footer-pattern-logo-desktop-container { padding: 0 !important; }
#footer-pattern-logo-desktop { width: 0 !important; height: 0 !important; }
#footer-pattern-logo-mobile {
padding-top: 10px !important;
width: 30px !important;
height: 27px !important;
display: inline !important;
}
#footer-pattern-text {
display: block !important;
}
#footer-pattern-links-container { line-height: 0 !important;}
.footer-pattern-links.mobile-resize-text,
.footer-pattern-links.mobile-resize-text,
#footer-pattern-text.mobile-resize-text,
#footer-pattern-links-container.no-footer-links {
font-size: 14px !important;
line-height: 20px !important;
}
.footer-link { display: block !important; }
#footer-pattern-links-container table { display: inline-block !important; float: none !important; }
#footer-pattern-links-container, #footer-pattern-text { text-align: center !important; }
#footer-pattern-links { padding-bottom: 5px !important; }
/** Team Calendar overrides, these should be removed when notifications are updated in Team Calendars. For now CSS
overrides are being used because the structure of the content can't change without rereleasing the plugin */
.mail-calendar-container .day-header + table tr td:first-child {
vertical-align: top !important;
padding-top: 5px !important;
}}
@media (min-width: 900px) {#center-content-table { width: 900px; }}
@media all {#outlook a {padding:0;} /* Force Outlook to provide a "view in browser" menu link. */
/* Prevent Webkit and Windows Mobile platforms from changing default font sizes.*/
body{-webkit-text-size-adjust:100%; -ms-text-size-adjust:100%;}
.ExternalClass {width:100%;} /* Force Hotmail to display emails at full width */
#background-table {margin:0; padding:0; width:100% !important; }
/* Needed to override highlighting on date and time links in iOS */
.grey a {color: #707070; text-decoration: none; }/* These styles are appended to the head element of a notification in order to prevent Apple Mail and similar
clients from underlining the due dates with a blue hyperlink */
/* a lozenge outside an inline task should always be #333, lozenges inside an inline task should be
colored according to their upcoming due dates, a completed task date lozenge or deleted task date
lozenge should always be #707070 */
.date-time-lozenge a {color: #333333; text-decoration: none; }
.inline-task-text-container .date-time-lozenge.date-upcoming a {color: #DF6F00; text-decoration: none; }
.inline-task-text-container .date-time-lozenge.date-past a {color: #D04437; text-decoration: none; }
.inline-task-text-container.content-deleted-color .date-time-lozenge a,
.inline-task-text-container.checked .date-time-lozenge a {
color: #707070; text-decoration: none;
}}
</style>
</head>
<body>
<table id="background-table" cellpadding="0" cellspacing="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; background-color: #f5f5f5">
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0px; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0px; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 9px"><a href="https://wiki.asterisk.org/wiki/display/~wikibot?src=email" style="color: #3b73af; text-decoration: none"><img id="header-avatar-image" class="image_fix" src="cid:avatar_cb9f14dc0329f364cb46fa5adbde00e6" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top" /></a></td>
<td id="header-text-container" valign="middle" style="padding: 0px; border-collapse: collapse; vertical-align: middle; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">Wiki Bot <strong>created</strong> a page</td>
</tr>
</tbody>
</table> </td>
</tr>
<!-- End Header pattern -->
<tr>
<td id="email-content-container" style="padding: 0px; border-collapse: collapse; padding: 0 20px">
<table id="email-content-table" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; border-spacing: 0; border-collapse: separate">
<tbody>
<tr>
<td class="email-content-rounded-top mobile-expand" style="padding: 0px; border-collapse: collapse; color: #fff; padding: 0 15px 0 16px; height: 15px; background-color: #fff; border-left: 1px solid #ccc; border-top: 1px solid #ccc; border-right: 1px solid #ccc; border-bottom: 0; border-top-right-radius: 5px; border-top-left-radius: 5px"> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #ccc; border-right: 1px solid #ccc; border-top: 0; border-bottom: 0; padding: 0 15px 15px 16px; background-color: #fff">
<table id="page-title-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td id="page-title-pattern-icon-image-container" valign="top" style="padding: 0px; border-collapse: collapse; width: 16px; vertical-align: top">
<table cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td id="page-title-pattern-icon-image-container-cell" style="padding: 0px; border-collapse: collapse; width: 16px; padding: 9px 8px 0px 0px; mso-text-raise: 5px; mso-line-height-rule: exactly"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?src=email" title="page icon" style="vertical-align: top;; color: #3b73af; text-decoration: none"><img style="vertical-align: top; display: block;" src="cid:page-icon" alt="page icon" title="page icon" height="16" width="16" border="0" /></a></td>
</tr>
</tbody>
</table> </td>
<td style="vertical-align: top;; padding: 0px; border-collapse: collapse; padding-right: 5px; font-size: 20px; line-height: 30px; mso-line-height-rule: exactly" id="page-title-pattern-header-container"><span id="page-title-pattern-header" style="font-family: Arial, sans-serif; padding: 0; font-size: 20px; line-height: 30px; mso-text-raise: 2px; mso-line-height-rule: exactly; vertical-align: middle"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?src=email" title="Asterisk 17 REST Data Models" style="color: #3b73af; text-decoration: none">Asterisk 17 REST Data Models</a></span></td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #ccc; border-right: 1px solid #ccc; border-top: 0; border-bottom: 0; padding: 0 15px 15px 16px; background-color: #fff">
<table class="content-excerpt-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">
<tbody>
<tr>
<td class="content-excerpt-pattern-container mobile-resize-text " style="padding: 0px; border-collapse: collapse; padding: 0 0 0 24px"> <style type="text/css">/**/
div.rbtoc1564679343913 {padding: 0px;}
div.rbtoc1564679343913 ul {list-style: disc;margin-left: 0px;}
div.rbtoc1564679343913 li {margin-left: 0px;padding-left: 0px;}
/**/</style>
<div class="toc-macro rbtoc1564679343913" style="padding: 0px; padding: 0px">
<ul class="toc-indentation" style="margin: 10px 0 0 0; margin-top: 0; list-style: disc; margin-left: 0px; list-style: disc; margin-left: 0px">
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-AsteriskInfo" style="color: #3b73af; text-decoration: none">AsteriskInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-AsteriskPing" style="color: #3b73af; text-decoration: none">AsteriskPing</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BuildInfo" style="color: #3b73af; text-decoration: none">BuildInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ConfigInfo" style="color: #3b73af; text-decoration: none">ConfigInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ConfigTuple" style="color: #3b73af; text-decoration: none">ConfigTuple</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-LogChannel" style="color: #3b73af; text-decoration: none">LogChannel</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Module" style="color: #3b73af; text-decoration: none">Module</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-SetId" style="color: #3b73af; text-decoration: none">SetId</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-StatusInfo" style="color: #3b73af; text-decoration: none">StatusInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-SystemInfo" style="color: #3b73af; text-decoration: none">SystemInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Variable" style="color: #3b73af; text-decoration: none">Variable</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-TextMessage" style="color: #3b73af; text-decoration: none">TextMessage</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-TextMessageVariable" style="color: #3b73af; text-decoration: none">TextMessageVariable</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-CallerID" style="color: #3b73af; text-decoration: none">CallerID</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Dialed" style="color: #3b73af; text-decoration: none">Dialed</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-DialplanCEP" style="color: #3b73af; text-decoration: none">DialplanCEP</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-RTPstat" style="color: #3b73af; text-decoration: none">RTPstat</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-LiveRecording" style="color: #3b73af; text-decoration: none">LiveRecording</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-StoredRecording" style="color: #3b73af; text-decoration: none">StoredRecording</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-FormatLangPair" style="color: #3b73af; text-decoration: none">FormatLangPair</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Sound" style="color: #3b73af; text-decoration: none">Sound</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Playback" style="color: #3b73af; text-decoration: none">Playback</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-DeviceState" style="color: #3b73af; text-decoration: none">DeviceState</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Mailbox" style="color: #3b73af; text-decoration: none">Mailbox</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ApplicationMoveFailed" style="color: #3b73af; text-decoration: none">ApplicationMoveFailed</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ApplicationReplaced" style="color: #3b73af; text-decoration: none">ApplicationReplaced</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeAttendedTransfer" style="color: #3b73af; text-decoration: none">BridgeAttendedTransfer</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeBlindTransfer" style="color: #3b73af; text-decoration: none">BridgeBlindTransfer</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeCreated" style="color: #3b73af; text-decoration: none">BridgeCreated</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeDestroyed" style="color: #3b73af; text-decoration: none">BridgeDestroyed</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeMerged" style="color: #3b73af; text-decoration: none">BridgeMerged</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-BridgeVideoSourceChanged" style="color: #3b73af; text-decoration: none">BridgeVideoSourceChanged</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelCallerId" style="color: #3b73af; text-decoration: none">ChannelCallerId</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelConnectedLine" style="color: #3b73af; text-decoration: none">ChannelConnectedLine</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelCreated" style="color: #3b73af; text-decoration: none">ChannelCreated</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelDestroyed" style="color: #3b73af; text-decoration: none">ChannelDestroyed</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelDialplan" style="color: #3b73af; text-decoration: none">ChannelDialplan</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelDtmfReceived" style="color: #3b73af; text-decoration: none">ChannelDtmfReceived</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelEnteredBridge" style="color: #3b73af; text-decoration: none">ChannelEnteredBridge</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelHangupRequest" style="color: #3b73af; text-decoration: none">ChannelHangupRequest</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelHold" style="color: #3b73af; text-decoration: none">ChannelHold</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelLeftBridge" style="color: #3b73af; text-decoration: none">ChannelLeftBridge</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelStateChange" style="color: #3b73af; text-decoration: none">ChannelStateChange</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelTalkingFinished" style="color: #3b73af; text-decoration: none">ChannelTalkingFinished</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelTalkingStarted" style="color: #3b73af; text-decoration: none">ChannelTalkingStarted</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelUnhold" style="color: #3b73af; text-decoration: none">ChannelUnhold</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelUserevent" style="color: #3b73af; text-decoration: none">ChannelUserevent</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ChannelVarset" style="color: #3b73af; text-decoration: none">ChannelVarset</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ContactInfo" style="color: #3b73af; text-decoration: none">ContactInfo</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-ContactStatusChange" style="color: #3b73af; text-decoration: none">ContactStatusChange</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-DeviceStateChanged" style="color: #3b73af; text-decoration: none">DeviceStateChanged</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Dial" style="color: #3b73af; text-decoration: none">Dial</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-EndpointStateChange" style="color: #3b73af; text-decoration: none">EndpointStateChange</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Message" style="color: #3b73af; text-decoration: none">Message</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-MissingParams" style="color: #3b73af; text-decoration: none">MissingParams</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Peer" style="color: #3b73af; text-decoration: none">Peer</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-PeerStatusChange" style="color: #3b73af; text-decoration: none">PeerStatusChange</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-PlaybackContinuing" style="color: #3b73af; text-decoration: none">PlaybackContinuing</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-PlaybackFinished" style="color: #3b73af; text-decoration: none">PlaybackFinished</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-PlaybackStarted" style="color: #3b73af; text-decoration: none">PlaybackStarted</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-RecordingFailed" style="color: #3b73af; text-decoration: none">RecordingFailed</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-RecordingFinished" style="color: #3b73af; text-decoration: none">RecordingFinished</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-RecordingStarted" style="color: #3b73af; text-decoration: none">RecordingStarted</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-StasisEnd" style="color: #3b73af; text-decoration: none">StasisEnd</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-StasisStart" style="color: #3b73af; text-decoration: none">StasisStart</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-TextMessageReceived" style="color: #3b73af; text-decoration: none">TextMessageReceived</a> </li>
<li style="margin-left: 0px; padding-left: 0px; margin-left: 0px; padding-left: 0px"> <a href="#Asterisk17RESTDataModels-Application" style="color: #3b73af; text-decoration: none">Application</a> </li>
</ul>
</div> <h1 id="Asterisk17RESTDataModels-AsteriskInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">AsteriskInfo</h1> <p style="margin: 10px 0 0 0">Asterisk system information</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"status": {
"required": false,
"type": "StatusInfo",
"description": "Info about Asterisk status"
},
"config": {
"required": false,
"type": "ConfigInfo",
"description": "Info about Asterisk configuration"
},
"build": {
"required": false,
"type": "BuildInfo",
"description": "Info about how Asterisk was built"
},
"system": {
"required": false,
"type": "SystemInfo",
"description": "Info about the system running Asterisk"
}
},
"id": "AsteriskInfo",
"description": "Asterisk system information"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>build: <a href="#Asterisk17RESTDataModels-BuildInfo" style="color: #3b73af; text-decoration: none">BuildInfo</a> <em>(optional)</em> - Info about how Asterisk was built</li>
<li>config: <a href="#Asterisk17RESTDataModels-ConfigInfo" style="color: #3b73af; text-decoration: none">ConfigInfo</a> <em>(optional)</em> - Info about Asterisk configuration</li>
<li>status: <a href="#Asterisk17RESTDataModels-StatusInfo" style="color: #3b73af; text-decoration: none">StatusInfo</a> <em>(optional)</em> - Info about Asterisk status</li>
<li>system: <a href="#Asterisk17RESTDataModels-SystemInfo" style="color: #3b73af; text-decoration: none">SystemInfo</a> <em>(optional)</em> - Info about the system running Asterisk</li>
</ul> <h1 id="Asterisk17RESTDataModels-AsteriskPing" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">AsteriskPing</h1> <p style="margin: 10px 0 0 0">Asterisk ping information</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"timestamp": {
"required": true,
"type": "string",
"description": "The timestamp string of request received time"
},
"ping": {
"required": true,
"type": "string",
"description": "Always string value is pong"
},
"asterisk_id": {
"required": true,
"type": "string",
"description": "Asterisk id info"
}
},
"id": "AsteriskPing",
"description": "Asterisk ping information"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string - Asterisk id info</li>
<li>ping: string - Always string value is pong</li>
<li>timestamp: string - The timestamp string of request received time</li>
</ul> <h1 id="Asterisk17RESTDataModels-BuildInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BuildInfo</h1> <p style="margin: 10px 0 0 0">Info about how Asterisk was built</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"kernel": {
"required": true,
"type": "string",
"description": "Kernel version Asterisk was built on."
},
"machine": {
"required": true,
"type": "string",
"description": "Machine architecture (x86_64, i686, ppc, etc.)"
},
"user": {
"required": true,
"type": "string",
"description": "Username that build Asterisk"
},
"date": {
"required": true,
"type": "string",
"description": "Date and time when Asterisk was built."
},
"os": {
"required": true,
"type": "string",
"description": "OS Asterisk was built on."
},
"options": {
"required": true,
"type": "string",
"description": "Compile time options, or empty string if default."
}
},
"id": "BuildInfo",
"description": "Info about how Asterisk was built"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>date: string - Date and time when Asterisk was built.</li>
<li>kernel: string - Kernel version Asterisk was built on.</li>
<li>machine: string - Machine architecture (x86_64, i686, ppc, etc.)</li>
<li>options: string - Compile time options, or empty string if default.</li>
<li>os: string - OS Asterisk was built on.</li>
<li>user: string - Username that build Asterisk</li>
</ul> <h1 id="Asterisk17RESTDataModels-ConfigInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ConfigInfo</h1> <p style="margin: 10px 0 0 0">Info about Asterisk configuration</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Asterisk system name."
},
"default_language": {
"required": true,
"type": "string",
"description": "Default language for media playback."
},
"max_load": {
"required": false,
"type": "double",
"description": "Maximum load avg on system."
},
"setid": {
"required": true,
"type": "SetId",
"description": "Effective user/group id for running Asterisk."
},
"max_open_files": {
"required": false,
"type": "int",
"description": "Maximum number of open file handles (files, sockets)."
},
"max_channels": {
"required": false,
"type": "int",
"description": "Maximum number of simultaneous channels."
}
},
"id": "ConfigInfo",
"description": "Info about Asterisk configuration"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>default_language: string - Default language for media playback.</li>
<li>max_channels: int <em>(optional)</em> - Maximum number of simultaneous channels.</li>
<li>max_load: double <em>(optional)</em> - Maximum load avg on system.</li>
<li>max_open_files: int <em>(optional)</em> - Maximum number of open file handles (files, sockets).</li>
<li>name: string - Asterisk system name.</li>
<li>setid: <a href="#Asterisk17RESTDataModels-SetId" style="color: #3b73af; text-decoration: none">SetId</a> - Effective user/group id for running Asterisk.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ConfigTuple" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ConfigTuple</h1> <p style="margin: 10px 0 0 0">A key/value pair that makes up part of a configuration object.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"attribute": {
"required": true,
"type": "string",
"description": "A configuration object attribute."
},
"value": {
"required": true,
"type": "string",
"description": "The value for the attribute."
}
},
"id": "ConfigTuple",
"description": "A key/value pair that makes up part of a configuration object."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>attribute: string - A configuration object attribute.</li>
<li>value: string - The value for the attribute.</li>
</ul> <h1 id="Asterisk17RESTDataModels-LogChannel" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">LogChannel</h1> <p style="margin: 10px 0 0 0">Details of an Asterisk log channel</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"status": {
"required": true,
"type": "string",
"description": "Whether or not a log type is enabled"
},
"configuration": {
"required": true,
"type": "string",
"description": "The various log levels"
},
"type": {
"required": true,
"type": "string",
"description": "Types of logs for the log channel"
},
"channel": {
"required": true,
"type": "string",
"description": "The log channel path"
}
},
"id": "LogChannel",
"description": "Details of an Asterisk log channel"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>channel: string - The log channel path</li>
<li>configuration: string - The various log levels</li>
<li>status: string - Whether or not a log type is enabled</li>
<li>type: string - Types of logs for the log channel</li>
</ul> <h1 id="Asterisk17RESTDataModels-Module" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Module</h1> <p style="margin: 10px 0 0 0">Details of an Asterisk module</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"use_count": {
"required": true,
"type": "int",
"description": "The number of times this module is being used"
},
"status": {
"required": true,
"type": "string",
"description": "The running status of this module"
},
"support_level": {
"required": true,
"type": "string",
"description": "The support state of this module"
},
"name": {
"required": true,
"type": "string",
"description": "The name of this module"
},
"description": {
"required": true,
"type": "string",
"description": "The description of this module"
}
},
"id": "Module",
"description": "Details of an Asterisk module"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>description: string - The description of this module</li>
<li>name: string - The name of this module</li>
<li>status: string - The running status of this module</li>
<li>support_level: string - The support state of this module</li>
<li>use_count: int - The number of times this module is being used</li>
</ul> <h1 id="Asterisk17RESTDataModels-SetId" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">SetId</h1> <p style="margin: 10px 0 0 0">Effective user/group id</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"group": {
"required": true,
"type": "string",
"description": "Effective group id."
},
"user": {
"required": true,
"type": "string",
"description": "Effective user id."
}
},
"id": "SetId",
"description": "Effective user/group id"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>group: string - Effective group id.</li>
<li>user: string - Effective user id.</li>
</ul> <h1 id="Asterisk17RESTDataModels-StatusInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">StatusInfo</h1> <p style="margin: 10px 0 0 0">Info about Asterisk status</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"last_reload_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was last reloaded."
},
"startup_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was started."
}
},
"id": "StatusInfo",
"description": "Info about Asterisk status"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>last_reload_time: Date - Time when Asterisk was last reloaded.</li>
<li>startup_time: Date - Time when Asterisk was started.</li>
</ul> <h1 id="Asterisk17RESTDataModels-SystemInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">SystemInfo</h1> <p style="margin: 10px 0 0 0">Info about Asterisk</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"entity_id": {
"required": true,
"type": "string",
"description": ""
},
"version": {
"required": true,
"type": "string",
"description": "Asterisk version."
}
},
"id": "SystemInfo",
"description": "Info about Asterisk"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>entity_id: string</li>
<li>version: string - Asterisk version.</li>
</ul> <h1 id="Asterisk17RESTDataModels-Variable" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Variable</h1> <p style="margin: 10px 0 0 0">The value of a channel variable</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"value": {
"required": true,
"type": "string",
"description": "The value of the variable requested"
}
},
"id": "Variable",
"description": "The value of a channel variable"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>value: string - The value of the variable requested</li>
</ul> <h1 id="Asterisk17RESTDataModels-Endpoint" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Endpoint</h1> <p style="margin: 10px 0 0 0">An external device that may offer/accept calls to/from Asterisk.</p> <p style="margin: 10px 0 0 0">Unlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"resource": {
"required": true,
"type": "string",
"description": "Identifier of the endpoint, specific to the given technology."
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"unknown",
"offline",
"online"
]
},
"required": false,
"type": "string",
"description": "Endpoint's state"
},
"technology": {
"required": true,
"type": "string",
"description": "Technology of the endpoint"
},
"channel_ids": {
"required": true,
"type": "List[string]",
"description": "Id's of channels associated with this endpoint"
}
},
"id": "Endpoint",
"description": "An external device that may offer/accept calls to/from Asterisk.\n\nUnlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>channel_ids: List[string] - Id's of channels associated with this endpoint</li>
<li>resource: string - Identifier of the endpoint, specific to the given technology.</li>
<li>state: string <em>(optional)</em> - Endpoint's state</li>
<li>technology: string - Technology of the endpoint</li>
</ul> <h1 id="Asterisk17RESTDataModels-TextMessage" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">TextMessage</h1> <p style="margin: 10px 0 0 0">A text message.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"body": {
"required": true,
"type": "string",
"description": "The text of the message."
},
"to": {
"required": true,
"type": "string",
"description": "A technology specific URI specifying the destination of the message. Valid technologies include sip, pjsip, and xmp. The destination of a message should be an endpoint."
},
"variables": {
"required": false,
"type": "List[TextMessageVariable]",
"description": "Technology specific key/value pairs associated with the message."
},
"from": {
"required": true,
"type": "string",
"description": "A technology specific URI specifying the source of the message. For sip and pjsip technologies, any SIP URI can be specified. For xmpp, the URI must correspond to the client connection being used to send the message."
}
},
"id": "TextMessage",
"description": "A text message."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>body: string - The text of the message.</li>
<li>from: string - A technology specific URI specifying the source of the message. For sip and pjsip technologies, any SIP URI can be specified. For xmpp, the URI must correspond to the client connection being used to send the message.</li>
<li>to: string - A technology specific URI specifying the destination of the message. Valid technologies include sip, pjsip, and xmp. The destination of a message should be an endpoint.</li>
<li>variables: <a href="#Asterisk17RESTDataModels-TextMessageVariable" style="color: #3b73af; text-decoration: none">List[TextMessageVariable]</a> <em>(optional)</em> - Technology specific key/value pairs associated with the message.</li>
</ul> <h1 id="Asterisk17RESTDataModels-TextMessageVariable" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">TextMessageVariable</h1> <p style="margin: 10px 0 0 0">A key/value pair variable in a text message.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"value": {
"required": true,
"type": "string",
"description": "The value of the variable."
},
"key": {
"required": true,
"type": "string",
"description": "A unique key identifying the variable."
}
},
"id": "TextMessageVariable",
"description": "A key/value pair variable in a text message."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>key: string - A unique key identifying the variable.</li>
<li>value: string - The value of the variable.</li>
</ul> <h1 id="Asterisk17RESTDataModels-CallerID" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">CallerID</h1> <p style="margin: 10px 0 0 0">Caller identification</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"name": {
"required": true,
"type": "string"
},
"number": {
"required": true,
"type": "string"
}
},
"id": "CallerID",
"description": "Caller identification"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>name: string</li>
<li>number: string</li>
</ul> <h1 id="Asterisk17RESTDataModels-Channel" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Channel</h1> <p style="margin: 10px 0 0 0">A specific communication connection between Asterisk and an Endpoint.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"accountcode": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string",
"description": "Name of the channel (i.e. SIP/foo-0000a7e3)"
},
"language": {
"required": true,
"type": "string",
"description": "The default spoken language"
},
"channelvars": {
"required": false,
"type": "object",
"description": "Channel variables"
},
"caller": {
"required": true,
"type": "CallerID"
},
"creationtime": {
"required": true,
"type": "Date",
"description": "Timestamp when channel was created"
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"Down",
"Rsrved",
"OffHook",
"Dialing",
"Ring",
"Ringing",
"Up",
"Busy",
"Dialing Offhook",
"Pre-ring",
"Unknown"
]
},
"required": true,
"type": "string"
},
"connected": {
"required": true,
"type": "CallerID"
},
"dialplan": {
"required": true,
"type": "DialplanCEP",
"description": "Current location in the dialplan"
},
"id": {
"required": true,
"type": "string",
"description": "Unique identifier of the channel.\n\nThis is the same as the Uniqueid field in AMI."
}
},
"id": "Channel",
"description": "A specific communication connection between Asterisk and an Endpoint."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>accountcode: string</li>
<li>caller: <a href="#Asterisk17RESTDataModels-CallerID" style="color: #3b73af; text-decoration: none">CallerID</a> </li>
<li>channelvars: <a href="#Asterisk17RESTDataModels-object" style="color: #3b73af; text-decoration: none">object</a> <em>(optional)</em> - Channel variables</li>
<li>connected: <a href="#Asterisk17RESTDataModels-CallerID" style="color: #3b73af; text-decoration: none">CallerID</a> </li>
<li>creationtime: Date - Timestamp when channel was created</li>
<li>dialplan: <a href="#Asterisk17RESTDataModels-DialplanCEP" style="color: #3b73af; text-decoration: none">DialplanCEP</a> - Current location in the dialplan</li>
<li>id: string - Unique identifier of the channel.</li>
</ul> <p style="margin: 10px 0 0 0">This is the same as the Uniqueid field in AMI.</p>
<ul style="margin: 10px 0 0 0">
<li>language: string - The default spoken language</li>
<li>name: string - Name of the channel (i.e. SIP/foo-0000a7e3)</li>
<li>state: string</li>
</ul> <h1 id="Asterisk17RESTDataModels-Dialed" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Dialed</h1> <p style="margin: 10px 0 0 0">Dialed channel information.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {},
"id": "Dialed",
"description": "Dialed channel information."
}
</pre>
</div>
</div> <h1 id="Asterisk17RESTDataModels-DialplanCEP" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">DialplanCEP</h1> <p style="margin: 10px 0 0 0">Dialplan location (context/extension/priority)</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"priority": {
"required": true,
"type": "long",
"description": "Priority in the dialplan"
},
"exten": {
"required": true,
"type": "string",
"description": "Extension in the dialplan"
},
"app_data": {
"required": true,
"type": "string",
"description": "Parameter of current dialplan application"
},
"app_name": {
"required": true,
"type": "string",
"description": "Name of current dialplan application"
},
"context": {
"required": true,
"type": "string",
"description": "Context in the dialplan"
}
},
"id": "DialplanCEP",
"description": "Dialplan location (context/extension/priority)"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>app_data: string - Parameter of current dialplan application</li>
<li>app_name: string - Name of current dialplan application</li>
<li>context: string - Context in the dialplan</li>
<li>exten: string - Extension in the dialplan</li>
<li>priority: long - Priority in the dialplan</li>
</ul> <h1 id="Asterisk17RESTDataModels-RTPstat" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">RTPstat</h1> <p style="margin: 10px 0 0 0">A statistics of a RTP.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"txjitter": {
"required": false,
"type": "double",
"description": "Jitter on transmitted packets."
},
"local_stdevjitter": {
"required": false,
"type": "double",
"description": "Standard deviation jitter on local side."
},
"local_minjitter": {
"required": false,
"type": "double",
"description": "Minimum jitter on local side."
},
"rxjitter": {
"required": false,
"type": "double",
"description": "Jitter on received packets."
},
"rtt": {
"required": false,
"type": "double",
"description": "Total round trip time."
},
"stdevrtt": {
"required": false,
"type": "double",
"description": "Standard deviation round trip time."
},
"local_maxjitter": {
"required": false,
"type": "double",
"description": "Maximum jitter on local side."
},
"maxrtt": {
"required": false,
"type": "double",
"description": "Maximum round trip time."
},
"local_normdevrxploss": {
"required": false,
"type": "double",
"description": "Average number of packets lost on local side."
},
"remote_minrxploss": {
"required": false,
"type": "double",
"description": "Minimum number of packets lost on remote side."
},
"txoctetcount": {
"required": true,
"type": "int",
"description": "Number of octets transmitted."
},
"rxoctetcount": {
"required": true,
"type": "int",
"description": "Number of octets received."
},
"local_maxrxploss": {
"required": false,
"type": "double",
"description": "Maximum number of packets lost on local side."
},
"remote_normdevrxploss": {
"required": false,
"type": "double",
"description": "Average number of packets lost on remote side."
},
"local_stdevrxploss": {
"required": false,
"type": "double",
"description": "Standard deviation packets lost on local side."
},
"remote_stdevjitter": {
"required": false,
"type": "double",
"description": "Standard deviation jitter on remote side."
},
"local_normdevjitter": {
"required": false,
"type": "double",
"description": "Average jitter on local side."
},
"txploss": {
"required": true,
"type": "int",
"description": "Number of transmitted packets lost."
},
"remote_stdevrxploss": {
"required": false,
"type": "double",
"description": "Standard deviation packets lost on remote side."
},
"remote_maxrxploss": {
"required": false,
"type": "double",
"description": "Maximum number of packets lost on remote side."
},
"txcount": {
"required": true,
"type": "int",
"description": "Number of packets transmitted."
},
"remote_minjitter": {
"required": false,
"type": "double",
"description": "Minimum jitter on remote side."
},
"remote_maxjitter": {
"required": false,
"type": "double",
"description": "Maximum jitter on remote side."
},
"remote_ssrc": {
"required": true,
"type": "int",
"description": "Their SSRC."
},
"channel_uniqueid": {
"required": true,
"type": "string",
"description": "The Asterisk channel's unique ID that owns this instance."
},
"rxcount": {
"required": true,
"type": "int",
"description": "Number of packets received."
},
"rxploss": {
"required": true,
"type": "int",
"description": "Number of received packets lost."
},
"remote_normdevjitter": {
"required": false,
"type": "double",
"description": "Average jitter on remote side."
},
"local_ssrc": {
"required": true,
"type": "int",
"description": "Our SSRC."
},
"minrtt": {
"required": false,
"type": "double",
"description": "Minimum round trip time."
},
"local_minrxploss": {
"required": false,
"type": "double",
"description": "Minimum number of packets lost on local side."
},
"normdevrtt": {
"required": false,
"type": "double",
"description": "Average round trip time."
}
},
"id": "RTPstat",
"description": "A statistics of a RTP."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>channel_uniqueid: string - The Asterisk channel's unique ID that owns this instance.</li>
<li>local_maxjitter: double <em>(optional)</em> - Maximum jitter on local side.</li>
<li>local_maxrxploss: double <em>(optional)</em> - Maximum number of packets lost on local side.</li>
<li>local_minjitter: double <em>(optional)</em> - Minimum jitter on local side.</li>
<li>local_minrxploss: double <em>(optional)</em> - Minimum number of packets lost on local side.</li>
<li>local_normdevjitter: double <em>(optional)</em> - Average jitter on local side.</li>
<li>local_normdevrxploss: double <em>(optional)</em> - Average number of packets lost on local side.</li>
<li>local_ssrc: int - Our SSRC.</li>
<li>local_stdevjitter: double <em>(optional)</em> - Standard deviation jitter on local side.</li>
<li>local_stdevrxploss: double <em>(optional)</em> - Standard deviation packets lost on local side.</li>
<li>maxrtt: double <em>(optional)</em> - Maximum round trip time.</li>
<li>minrtt: double <em>(optional)</em> - Minimum round trip time.</li>
<li>normdevrtt: double <em>(optional)</em> - Average round trip time.</li>
<li>remote_maxjitter: double <em>(optional)</em> - Maximum jitter on remote side.</li>
<li>remote_maxrxploss: double <em>(optional)</em> - Maximum number of packets lost on remote side.</li>
<li>remote_minjitter: double <em>(optional)</em> - Minimum jitter on remote side.</li>
<li>remote_minrxploss: double <em>(optional)</em> - Minimum number of packets lost on remote side.</li>
<li>remote_normdevjitter: double <em>(optional)</em> - Average jitter on remote side.</li>
<li>remote_normdevrxploss: double <em>(optional)</em> - Average number of packets lost on remote side.</li>
<li>remote_ssrc: int - Their SSRC.</li>
<li>remote_stdevjitter: double <em>(optional)</em> - Standard deviation jitter on remote side.</li>
<li>remote_stdevrxploss: double <em>(optional)</em> - Standard deviation packets lost on remote side.</li>
<li>rtt: double <em>(optional)</em> - Total round trip time.</li>
<li>rxcount: int - Number of packets received.</li>
<li>rxjitter: double <em>(optional)</em> - Jitter on received packets.</li>
<li>rxoctetcount: int - Number of octets received.</li>
<li>rxploss: int - Number of received packets lost.</li>
<li>stdevrtt: double <em>(optional)</em> - Standard deviation round trip time.</li>
<li>txcount: int - Number of packets transmitted.</li>
<li>txjitter: double <em>(optional)</em> - Jitter on transmitted packets.</li>
<li>txoctetcount: int - Number of octets transmitted.</li>
<li>txploss: int - Number of transmitted packets lost.</li>
</ul> <h1 id="Asterisk17RESTDataModels-Bridge" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Bridge</h1> <p style="margin: 10px 0 0 0">The merging of media from one or more channels.</p> <p style="margin: 10px 0 0 0">Everyone on the bridge receives the same audio.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge_type": {
"allowableValues": {
"valueType": "LIST",
"values": [
"mixing",
"holding"
]
},
"required": true,
"type": "string",
"description": "Type of bridge technology"
},
"name": {
"required": true,
"type": "string",
"description": "Name the creator gave the bridge"
},
"creator": {
"required": true,
"type": "string",
"description": "Entity that created the bridge"
},
"video_mode": {
"required": false,
"type": "string",
"description": "The video mode the bridge is using. One of 'none', 'talker', or 'single'."
},
"creationtime": {
"required": true,
"type": "Date",
"description": "Timestamp when bridge was created"
},
"channels": {
"required": true,
"type": "List[string]",
"description": "Ids of channels participating in this bridge"
},
"video_source_id": {
"required": false,
"type": "string",
"description": "The ID of the channel that is the source of video in this bridge, if one exists."
},
"bridge_class": {
"required": true,
"type": "string",
"description": "Bridging class"
},
"technology": {
"required": true,
"type": "string",
"description": "Name of the current bridging technology"
},
"id": {
"required": true,
"type": "string",
"description": "Unique identifier for this bridge"
}
},
"id": "Bridge",
"description": "The merging of media from one or more channels.\n\nEveryone on the bridge receives the same audio."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>bridge_class: string - Bridging class</li>
<li>bridge_type: string - Type of bridge technology</li>
<li>channels: List[string] - Ids of channels participating in this bridge</li>
<li>creationtime: Date - Timestamp when bridge was created</li>
<li>creator: string - Entity that created the bridge</li>
<li>id: string - Unique identifier for this bridge</li>
<li>name: string - Name the creator gave the bridge</li>
<li>technology: string - Name of the current bridging technology</li>
<li>video_mode: string <em>(optional)</em> - The video mode the bridge is using. One of 'none', 'talker', or 'single'.</li>
<li>video_source_id: string <em>(optional)</em> - The ID of the channel that is the source of video in this bridge, if one exists.</li>
</ul> <h1 id="Asterisk17RESTDataModels-LiveRecording" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">LiveRecording</h1> <p style="margin: 10px 0 0 0">A recording that is in progress</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"talking_duration": {
"required": false,
"type": "int",
"description": "Duration of talking, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds."
},
"name": {
"required": true,
"type": "string",
"description": "Base name for the recording"
},
"target_uri": {
"required": true,
"type": "string",
"description": "URI for the channel or bridge being recorded"
},
"format": {
"required": true,
"type": "string",
"description": "Recording format (wav, gsm, etc.)"
},
"cause": {
"required": false,
"type": "string",
"description": "Cause for recording failure if failed"
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"recording",
"paused",
"done",
"failed",
"canceled"
]
},
"required": true,
"type": "string"
},
"duration": {
"required": false,
"type": "int",
"description": "Duration in seconds of the recording"
},
"silence_duration": {
"required": false,
"type": "int",
"description": "Duration of silence, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds."
}
},
"id": "LiveRecording",
"description": "A recording that is in progress"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>cause: string <em>(optional)</em> - Cause for recording failure if failed</li>
<li>duration: int <em>(optional)</em> - Duration in seconds of the recording</li>
<li>format: string - Recording format (wav, gsm, etc.)</li>
<li>name: string - Base name for the recording</li>
<li>silence_duration: int <em>(optional)</em> - Duration of silence, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds.</li>
<li>state: string</li>
<li>talking_duration: int <em>(optional)</em> - Duration of talking, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds.</li>
<li>target_uri: string - URI for the channel or bridge being recorded</li>
</ul> <h1 id="Asterisk17RESTDataModels-StoredRecording" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">StoredRecording</h1> <p style="margin: 10px 0 0 0">A past recording that may be played back.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"name": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
},
"id": "StoredRecording",
"description": "A past recording that may be played back."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>format: string</li>
<li>name: string</li>
</ul> <h1 id="Asterisk17RESTDataModels-FormatLangPair" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">FormatLangPair</h1> <p style="margin: 10px 0 0 0">Identifies the format and language of a sound file</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"language": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
},
"id": "FormatLangPair",
"description": "Identifies the format and language of a sound file"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>format: string</li>
<li>language: string</li>
</ul> <h1 id="Asterisk17RESTDataModels-Sound" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Sound</h1> <p style="margin: 10px 0 0 0">A media file that may be played back.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"text": {
"required": false,
"type": "string",
"description": "Text description of the sound, usually the words spoken."
},
"id": {
"required": true,
"type": "string",
"description": "Sound's identifier."
},
"formats": {
"required": true,
"type": "List[FormatLangPair]",
"description": "The formats and languages in which this sound is available."
}
},
"id": "Sound",
"description": "A media file that may be played back."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>formats: <a href="#Asterisk17RESTDataModels-FormatLangPair" style="color: #3b73af; text-decoration: none">List[FormatLangPair]</a> - The formats and languages in which this sound is available.</li>
<li>id: string - Sound's identifier.</li>
<li>text: string <em>(optional)</em> - Text description of the sound, usually the words spoken.</li>
</ul> <h1 id="Asterisk17RESTDataModels-Playback" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Playback</h1> <p style="margin: 10px 0 0 0">Object representing the playback of media to a channel</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"next_media_uri": {
"required": false,
"type": "string",
"description": "If a list of URIs is being played, the next media URI to be played back."
},
"target_uri": {
"required": true,
"type": "string",
"description": "URI for the channel or bridge to play the media on"
},
"language": {
"type": "string",
"description": "For media types that support multiple languages, the language requested for playback."
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"playing",
"continuing",
"done"
]
},
"required": true,
"type": "string",
"description": "Current state of the playback operation."
},
"media_uri": {
"required": true,
"type": "string",
"description": "The URI for the media currently being played back."
},
"id": {
"required": true,
"type": "string",
"description": "ID for this playback operation"
}
},
"id": "Playback",
"description": "Object representing the playback of media to a channel"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>id: string - ID for this playback operation</li>
<li>language: string <em>(optional)</em> - For media types that support multiple languages, the language requested for playback.</li>
<li>media_uri: string - The URI for the media currently being played back.</li>
<li>next_media_uri: string <em>(optional)</em> - If a list of URIs is being played, the next media URI to be played back.</li>
<li>state: string - Current state of the playback operation.</li>
<li>target_uri: string - URI for the channel or bridge to play the media on</li>
</ul> <h1 id="Asterisk17RESTDataModels-DeviceState" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">DeviceState</h1> <p style="margin: 10px 0 0 0">Represents the state of a device.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"UNKNOWN",
"NOT_INUSE",
"INUSE",
"BUSY",
"INVALID",
"UNAVAILABLE",
"RINGING",
"RINGINUSE",
"ONHOLD"
]
},
"required": true,
"type": "string",
"description": "Device's state"
},
"name": {
"required": true,
"type": "string",
"description": "Name of the device."
}
},
"id": "DeviceState",
"description": "Represents the state of a device."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>name: string - Name of the device.</li>
<li>state: string - Device's state</li>
</ul> <h1 id="Asterisk17RESTDataModels-Mailbox" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Mailbox</h1> <p style="margin: 10px 0 0 0">Represents the state of a mailbox.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"old_messages": {
"required": true,
"type": "int",
"description": "Count of old messages in the mailbox."
},
"name": {
"required": true,
"type": "string",
"description": "Name of the mailbox."
},
"new_messages": {
"required": true,
"type": "int",
"description": "Count of new messages in the mailbox."
}
},
"id": "Mailbox",
"description": "Represents the state of a mailbox."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>name: string - Name of the mailbox.</li>
<li>new_messages: int - Count of new messages in the mailbox.</li>
<li>old_messages: int - Count of old messages in the mailbox.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ApplicationMoveFailed" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ApplicationMoveFailed</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that trying to move a channel to another Stasis application failed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
},
"destination": {
"required": true,
"type": "string"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ApplicationMoveFailed",
"description": "Notification that trying to move a channel to another Stasis application failed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>args: List[string] - Arguments to the application</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
<li>destination: string</li>
</ul> <h1 id="Asterisk17RESTDataModels-ApplicationReplaced" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ApplicationReplaced</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that another WebSocket has taken over for an application.</p> <p style="margin: 10px 0 0 0">An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {},
"id": "ApplicationReplaced",
"description": "Notification that another WebSocket has taken over for an application.\n\nAn application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeAttendedTransfer" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeAttendedTransfer</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that an attended transfer has occurred.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"replace_channel": {
"required": false,
"type": "Channel",
"description": "The channel that is replacing transferer_first_leg in the swap"
},
"is_external": {
"required": true,
"type": "boolean",
"description": "Whether the transfer was externally initiated or not"
},
"transferer_second_leg_bridge": {
"type": "Bridge",
"description": "Bridge the transferer second leg is in"
},
"destination_bridge": {
"type": "string",
"description": "Bridge that survived the merge result"
},
"transferer_second_leg": {
"required": true,
"type": "Channel",
"description": "Second leg of the transferer"
},
"destination_link_second_leg": {
"type": "Channel",
"description": "Second leg of a link transfer result"
},
"destination_threeway_channel": {
"type": "Channel",
"description": "Transferer channel that survived the threeway result"
},
"transfer_target": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred to"
},
"result": {
"required": true,
"type": "string",
"description": "The result of the transfer attempt"
},
"destination_type": {
"required": true,
"type": "string",
"description": "How the transfer was accomplished"
},
"destination_application": {
"type": "string",
"description": "Application that has been transferred into"
},
"destination_threeway_bridge": {
"type": "Bridge",
"description": "Bridge that survived the threeway result"
},
"destination_link_first_leg": {
"type": "Channel",
"description": "First leg of a link transfer result"
},
"transferee": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred"
},
"transferer_first_leg": {
"required": true,
"type": "Channel",
"description": "First leg of the transferer"
},
"transferer_first_leg_bridge": {
"type": "Bridge",
"description": "Bridge the transferer first leg is in"
}
},
"id": "BridgeAttendedTransfer",
"description": "Notification that an attended transfer has occurred."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>destination_application: string <em>(optional)</em> - Application that has been transferred into</li>
<li>destination_bridge: string <em>(optional)</em> - Bridge that survived the merge result</li>
<li>destination_link_first_leg: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - First leg of a link transfer result</li>
<li>destination_link_second_leg: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - Second leg of a link transfer result</li>
<li>destination_threeway_bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> <em>(optional)</em> - Bridge that survived the threeway result</li>
<li>destination_threeway_channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - Transferer channel that survived the threeway result</li>
<li>destination_type: string - How the transfer was accomplished</li>
<li>is_external: boolean - Whether the transfer was externally initiated or not</li>
<li>replace_channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel that is replacing transferer_first_leg in the swap</li>
<li>result: string - The result of the transfer attempt</li>
<li>transfer_target: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel that is being transferred to</li>
<li>transferee: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel that is being transferred</li>
<li>transferer_first_leg: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - First leg of the transferer</li>
<li>transferer_first_leg_bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> <em>(optional)</em> - Bridge the transferer first leg is in</li>
<li>transferer_second_leg: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - Second leg of the transferer</li>
<li>transferer_second_leg_bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> <em>(optional)</em> - Bridge the transferer second leg is in</li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeBlindTransfer" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeBlindTransfer</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a blind transfer has occurred.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"type": "Bridge",
"description": "The bridge being transferred"
},
"replace_channel": {
"required": false,
"type": "Channel",
"description": "The channel that is replacing transferer when the transferee(s) can not be transferred directly"
},
"is_external": {
"required": true,
"type": "boolean",
"description": "Whether the transfer was externally initiated or not"
},
"exten": {
"required": true,
"type": "string",
"description": "The extension transferred to"
},
"result": {
"required": true,
"type": "string",
"description": "The result of the transfer attempt"
},
"context": {
"required": true,
"type": "string",
"description": "The context transferred to"
},
"transferee": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel performing the blind transfer"
}
},
"id": "BridgeBlindTransfer",
"description": "Notification that a blind transfer has occurred."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> <em>(optional)</em> - The bridge being transferred</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel performing the blind transfer</li>
<li>context: string - The context transferred to</li>
<li>exten: string - The extension transferred to</li>
<li>is_external: boolean - Whether the transfer was externally initiated or not</li>
<li>replace_channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel that is replacing transferer when the transferee(s) can not be transferred directly</li>
<li>result: string - The result of the transfer attempt</li>
<li>transferee: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel that is being transferred</li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeCreated" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeCreated</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a bridge has been created.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeCreated",
"description": "Notification that a bridge has been created."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeDestroyed" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeDestroyed</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a bridge has been destroyed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeDestroyed",
"description": "Notification that a bridge has been destroyed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeMerged" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeMerged</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that one bridge has merged into another.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"bridge_from": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeMerged",
"description": "Notification that one bridge has merged into another."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
<li>bridge_from: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-BridgeVideoSourceChanged" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">BridgeVideoSourceChanged</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that the source of video in a bridge has changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"old_video_source_id": {
"required": false,
"type": "string"
},
"bridge": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeVideoSourceChanged",
"description": "Notification that the source of video in a bridge has changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
<li>old_video_source_id: string <em>(optional)</em> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelCallerId" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelCallerId</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Channel changed Caller ID.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"caller_presentation_txt": {
"required": true,
"type": "string",
"description": "The text representation of the Caller Presentation value."
},
"caller_presentation": {
"required": true,
"type": "int",
"description": "The integer representation of the Caller Presentation value."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed Caller ID."
}
},
"id": "ChannelCallerId",
"description": "Channel changed Caller ID."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>caller_presentation: int - The integer representation of the Caller Presentation value.</li>
<li>caller_presentation_txt: string - The text representation of the Caller Presentation value.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel that changed Caller ID.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelConnectedLine" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelConnectedLine</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Channel changed Connected Line.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel whose connected line has changed."
}
},
"id": "ChannelConnectedLine",
"description": "Channel changed Connected Line."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel whose connected line has changed.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelCreated" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelCreated</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has been created.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelCreated",
"description": "Notification that a channel has been created."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelDestroyed" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelDestroyed</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has been destroyed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"cause": {
"required": true,
"type": "int",
"description": "Integer representation of the cause of the hangup"
},
"cause_txt": {
"required": true,
"type": "string",
"description": "Text representation of the cause of the hangup"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelDestroyed",
"description": "Notification that a channel has been destroyed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>cause: int - Integer representation of the cause of the hangup</li>
<li>cause_txt: string - Text representation of the cause of the hangup</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelDialplan" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelDialplan</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Channel changed location in the dialplan.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"dialplan_app_data": {
"required": true,
"type": "string",
"description": "The data to be passed to the application."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed dialplan location."
},
"dialplan_app": {
"required": true,
"type": "string",
"description": "The application about to be executed."
}
},
"id": "ChannelDialplan",
"description": "Channel changed location in the dialplan."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel that changed dialplan location.</li>
<li>dialplan_app: string - The application about to be executed.</li>
<li>dialplan_app_data: string - The data to be passed to the application.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelDtmfReceived" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelDtmfReceived</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">DTMF received on a channel.</p> <p style="margin: 10px 0 0 0">This event is sent when the DTMF ends. There is no notification about the start of DTMF</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"duration_ms": {
"required": true,
"type": "int",
"description": "Number of milliseconds DTMF was received"
},
"digit": {
"required": true,
"type": "string",
"description": "DTMF digit received (0-9, A-E, # or *)"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which DTMF was received"
}
},
"id": "ChannelDtmfReceived",
"description": "DTMF received on a channel.\n\nThis event is sent when the DTMF ends. There is no notification about the start of DTMF"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel on which DTMF was received</li>
<li>digit: string - DTMF digit received (0-9, A-E, # or *)</li>
<li>duration_ms: int - Number of milliseconds DTMF was received</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelEnteredBridge" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelEnteredBridge</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has entered a bridge.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"type": "Channel"
}
},
"id": "ChannelEnteredBridge",
"description": "Notification that a channel has entered a bridge."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelHangupRequest" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelHangupRequest</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">A hangup was requested on the channel.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"soft": {
"type": "boolean",
"description": "Whether the hangup request was a soft hangup request."
},
"cause": {
"type": "int",
"description": "Integer representation of the cause of the hangup."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which the hangup was requested."
}
},
"id": "ChannelHangupRequest",
"description": "A hangup was requested on the channel."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>cause: int <em>(optional)</em> - Integer representation of the cause of the hangup.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel on which the hangup was requested.</li>
<li>soft: boolean <em>(optional)</em> - Whether the hangup request was a soft hangup request.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelHold" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelHold</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">A channel initiated a media hold.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"musicclass": {
"required": false,
"type": "string",
"description": "The music on hold class that the initiator requested."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the hold event."
}
},
"id": "ChannelHold",
"description": "A channel initiated a media hold."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel that initiated the hold event.</li>
<li>musicclass: string <em>(optional)</em> - The music on hold class that the initiator requested.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelLeftBridge" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelLeftBridge</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has left a bridge.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelLeftBridge",
"description": "Notification that a channel has left a bridge."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> </li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelStateChange" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelStateChange</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification of a channel's state change.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelStateChange",
"description": "Notification of a channel's state change."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelTalkingFinished" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelTalkingFinished</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Talking is no longer detected on the channel.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"duration": {
"required": true,
"type": "int",
"description": "The length of time, in milliseconds, that talking was detected on the channel"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking completed."
}
},
"id": "ChannelTalkingFinished",
"description": "Talking is no longer detected on the channel."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel on which talking completed.</li>
<li>duration: int - The length of time, in milliseconds, that talking was detected on the channel</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelTalkingStarted" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelTalkingStarted</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Talking was detected on the channel.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking started."
}
},
"id": "ChannelTalkingStarted",
"description": "Talking was detected on the channel."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel on which talking started.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelUnhold" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelUnhold</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">A channel initiated a media unhold.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the unhold event."
}
},
"id": "ChannelUnhold",
"description": "A channel initiated a media unhold."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The channel that initiated the unhold event.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelUserevent" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelUserevent</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">User-generated event with additional user-defined fields in the object.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"eventname": {
"required": true,
"type": "string",
"description": "The name of the user event."
},
"bridge": {
"required": false,
"type": "Bridge",
"description": "A bridge that is signaled with the user event."
},
"userevent": {
"required": true,
"type": "object",
"description": "Custom Userevent data"
},
"endpoint": {
"required": false,
"type": "Endpoint",
"description": "A endpoint that is signaled with the user event."
},
"channel": {
"required": false,
"type": "Channel",
"description": "A channel that is signaled with the user event."
}
},
"id": "ChannelUserevent",
"description": "User-generated event with additional user-defined fields in the object."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>bridge: <a href="#Asterisk17RESTDataModels-Bridge" style="color: #3b73af; text-decoration: none">Bridge</a> <em>(optional)</em> - A bridge that is signaled with the user event.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - A channel that is signaled with the user event.</li>
<li>endpoint: <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> <em>(optional)</em> - A endpoint that is signaled with the user event.</li>
<li>eventname: string - The name of the user event.</li>
<li>userevent: <a href="#Asterisk17RESTDataModels-object" style="color: #3b73af; text-decoration: none">object</a> - Custom Userevent data</li>
</ul> <h1 id="Asterisk17RESTDataModels-ChannelVarset" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ChannelVarset</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Channel variable changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"variable": {
"required": true,
"type": "string",
"description": "The variable that changed."
},
"channel": {
"required": false,
"type": "Channel",
"description": "The channel on which the variable was set.\n\nIf missing, the variable is a global variable."
},
"value": {
"required": true,
"type": "string",
"description": "The new value of the variable."
}
},
"id": "ChannelVarset",
"description": "Channel variable changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The channel on which the variable was set.</li>
</ul> <p style="margin: 10px 0 0 0">If missing, the variable is a global variable.</p>
<ul style="margin: 10px 0 0 0">
<li>value: string - The new value of the variable.</li>
<li>variable: string - The variable that changed.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ContactInfo" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ContactInfo</h1> <p style="margin: 10px 0 0 0">Detailed information about a contact on an endpoint.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"aor": {
"required": true,
"type": "string",
"description": "The Address of Record this contact belongs to."
},
"uri": {
"required": true,
"type": "string",
"description": "The location of the contact."
},
"roundtrip_usec": {
"required": false,
"type": "string",
"description": "Current round trip time, in microseconds, for the contact."
},
"contact_status": {
"allowableValues": {
"valueType": "LIST",
"values": [
"Unreachable",
"Reachable",
"Unknown",
"NonQualified",
"Removed"
]
},
"required": true,
"type": "string",
"description": "The current status of the contact."
}
},
"id": "ContactInfo",
"description": "Detailed information about a contact on an endpoint."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>aor: string - The Address of Record this contact belongs to.</li>
<li>contact_status: string - The current status of the contact.</li>
<li>roundtrip_usec: string <em>(optional)</em> - Current round trip time, in microseconds, for the contact.</li>
<li>uri: string - The location of the contact.</li>
</ul> <h1 id="Asterisk17RESTDataModels-ContactStatusChange" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">ContactStatusChange</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">The state of a contact on an endpoint has changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
},
"contact_info": {
"required": true,
"type": "ContactInfo"
}
},
"id": "ContactStatusChange",
"description": "The state of a contact on an endpoint has changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>contact_info: <a href="#Asterisk17RESTDataModels-ContactInfo" style="color: #3b73af; text-decoration: none">ContactInfo</a> </li>
<li>endpoint: <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-DeviceStateChanged" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">DeviceStateChanged</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a device state has changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"device_state": {
"required": true,
"type": "DeviceState",
"description": "Device state object"
}
},
"id": "DeviceStateChanged",
"description": "Notification that a device state has changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>device_state: <a href="#Asterisk17RESTDataModels-DeviceState" style="color: #3b73af; text-decoration: none">DeviceState</a> - Device state object</li>
</ul> <h1 id="Asterisk17RESTDataModels-Dial" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Dial</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Dialing state has changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"forwarded": {
"required": false,
"type": "Channel",
"description": "Channel that the caller has been forwarded to."
},
"caller": {
"required": false,
"type": "Channel",
"description": "The calling channel."
},
"dialstatus": {
"required": true,
"type": "string",
"description": "Current status of the dialing attempt to the peer."
},
"forward": {
"required": false,
"type": "string",
"description": "Forwarding target requested by the original dialed channel."
},
"dialstring": {
"required": false,
"type": "string",
"description": "The dial string for calling the peer channel."
},
"peer": {
"required": true,
"type": "Channel",
"description": "The dialed channel."
}
},
"id": "Dial",
"description": "Dialing state has changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>caller: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - The calling channel.</li>
<li>dialstatus: string - Current status of the dialing attempt to the peer.</li>
<li>dialstring: string <em>(optional)</em> - The dial string for calling the peer channel.</li>
<li>forward: string <em>(optional)</em> - Forwarding target requested by the original dialed channel.</li>
<li>forwarded: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> - Channel that the caller has been forwarded to.</li>
<li>peer: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> - The dialed channel.</li>
</ul> <h1 id="Asterisk17RESTDataModels-EndpointStateChange" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">EndpointStateChange</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Endpoint state changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
}
},
"id": "EndpointStateChange",
"description": "Endpoint state changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>endpoint: <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-Event" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Event</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Message" style="color: #3b73af; text-decoration: none">Message</a> <br /> Subtypes: <a href="#Asterisk17RESTDataModels-ApplicationMoveFailed" style="color: #3b73af; text-decoration: none">ApplicationMoveFailed</a> <a href="#Asterisk17RESTDataModels-ApplicationReplaced" style="color: #3b73af; text-decoration: none">ApplicationReplaced</a> <a href="#Asterisk17RESTDataModels-BridgeAttendedTransfer" style="color: #3b73af; text-decoration: none">BridgeAttendedTransfer</a> <a href="#Asterisk17RESTDataModels-BridgeBlindTransfer" style="color: #3b73af; text-decoration: none">BridgeBlindTransfer</a> <a href="#Asterisk17RESTDataModels-BridgeCreated" style="color: #3b73af; text-decoration: none">BridgeCreated</a> <a href="#Asterisk17RESTDataModels-BridgeDestroyed" style="color: #3b73af; text-decoration: none">BridgeDestroyed</a> <a href="#Asterisk17RESTDataModels-BridgeMerged" style="color: #3b73af; text-decoration: none">BridgeMerged</a> <a href="#Asterisk17RESTDataModels-BridgeVideoSourceChanged" style="color: #3b73af; text-decoration: none">BridgeVideoSourceChanged</a> <a href="#Asterisk17RESTDataModels-ChannelCallerId" style="color: #3b73af; text-decoration: none">ChannelCallerId</a> <a href="#Asterisk17RESTDataModels-ChannelConnectedLine" style="color: #3b73af; text-decoration: none">ChannelConnectedLine</a> <a href="#Asterisk17RESTDataModels-ChannelCreated" style="color: #3b73af; text-decoration: none">ChannelCreated</a> <a href="#Asterisk17RESTDataModels-ChannelDestroyed" style="color: #3b73af; text-decoration: none">ChannelDestroyed</a> <a href="#Asterisk17RESTDataModels-ChannelDialplan" style="color: #3b73af; text-decoration: none">ChannelDialplan</a> <a href="#Asterisk17RESTDataModels-ChannelDtmfReceived" style="color: #3b73af; text-decoration: none">ChannelDtmfReceived</a> <a href="#Asterisk17RESTDataModels-ChannelEnteredBridge" style="color: #3b73af; text-decoration: none">ChannelEnteredBridge</a> <a href="#Asterisk17RESTDataModels-ChannelHangupRequest" style="color: #3b73af; text-decoration: none">ChannelHangupRequest</a> <a href="#Asterisk17RESTDataModels-ChannelHold" style="color: #3b73af; text-decoration: none">ChannelHold</a> <a href="#Asterisk17RESTDataModels-ChannelLeftBridge" style="color: #3b73af; text-decoration: none">ChannelLeftBridge</a> <a href="#Asterisk17RESTDataModels-ChannelStateChange" style="color: #3b73af; text-decoration: none">ChannelStateChange</a> <a href="#Asterisk17RESTDataModels-ChannelTalkingFinished" style="color: #3b73af; text-decoration: none">ChannelTalkingFinished</a> <a href="#Asterisk17RESTDataModels-ChannelTalkingStarted" style="color: #3b73af; text-decoration: none">ChannelTalkingStarted</a> <a href="#Asterisk17RESTDataModels-ChannelUnhold" style="color: #3b73af; text-decoration: none">ChannelUnhold</a> <a href="#Asterisk17RESTDataModels-ChannelUserevent" style="color: #3b73af; text-decoration: none">ChannelUserevent</a> <a href="#Asterisk17RESTDataModels-ChannelVarset" style="color: #3b73af; text-decoration: none">ChannelVarset</a> <a href="#Asterisk17RESTDataModels-ContactStatusChange" style="color: #3b73af; text-decoration: none">ContactStatusChange</a> <a href="#Asterisk17RESTDataModels-DeviceStateChanged" style="color: #3b73af; text-decoration: none">DeviceStateChanged</a> <a href="#Asterisk17RESTDataModels-Dial" style="color: #3b73af; text-decoration: none">Dial</a> <a href="#Asterisk17RESTDataModels-EndpointStateChange" style="color: #3b73af; text-decoration: none">EndpointStateChange</a> <a href="#Asterisk17RESTDataModels-PeerStatusChange" style="color: #3b73af; text-decoration: none">PeerStatusChange</a> <a href="#Asterisk17RESTDataModels-PlaybackContinuing" style="color: #3b73af; text-decoration: none">PlaybackContinuing</a> <a href="#Asterisk17RESTDataModels-PlaybackFinished" style="color: #3b73af; text-decoration: none">PlaybackFinished</a> <a href="#Asterisk17RESTDataModels-PlaybackStarted" style="color: #3b73af; text-decoration: none">PlaybackStarted</a> <a href="#Asterisk17RESTDataModels-RecordingFailed" style="color: #3b73af; text-decoration: none">RecordingFailed</a> <a href="#Asterisk17RESTDataModels-RecordingFinished" style="color: #3b73af; text-decoration: none">RecordingFinished</a> <a href="#Asterisk17RESTDataModels-RecordingStarted" style="color: #3b73af; text-decoration: none">RecordingStarted</a> <a href="#Asterisk17RESTDataModels-StasisEnd" style="color: #3b73af; text-decoration: none">StasisEnd</a> <a href="#Asterisk17RESTDataModels-StasisStart" style="color: #3b73af; text-decoration: none">StasisStart</a> <a href="#Asterisk17RESTDataModels-TextMessageReceived" style="color: #3b73af; text-decoration: none">TextMessageReceived</a> </p> <p style="margin: 10px 0 0 0">Base type for asynchronous events from Asterisk.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"subTypes": [
"DeviceStateChanged",
"PlaybackStarted",
"PlaybackContinuing",
"PlaybackFinished",
"RecordingStarted",
"RecordingFinished",
"RecordingFailed",
"ApplicationMoveFailed",
"ApplicationReplaced",
"BridgeCreated",
"BridgeDestroyed",
"BridgeMerged",
"BridgeBlindTransfer",
"BridgeAttendedTransfer",
"BridgeVideoSourceChanged",
"ChannelCreated",
"ChannelDestroyed",
"ChannelEnteredBridge",
"ChannelLeftBridge",
"ChannelStateChange",
"ChannelDtmfReceived",
"ChannelDialplan",
"ChannelCallerId",
"ChannelUserevent",
"ChannelHangupRequest",
"ChannelVarset",
"ChannelTalkingStarted",
"ChannelTalkingFinished",
"ChannelHold",
"ChannelUnhold",
"ContactStatusChange",
"EndpointStateChange",
"Dial",
"StasisEnd",
"StasisStart",
"TextMessageReceived",
"ChannelConnectedLine",
"PeerStatusChange"
],
"properties": {
"application": {
"required": true,
"type": "string",
"description": "Name of the application receiving the event."
},
"timestamp": {
"required": true,
"type": "Date",
"description": "Time at which this event was created."
}
},
"id": "Event",
"description": "Base type for asynchronous events from Asterisk."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
</ul> <h1 id="Asterisk17RESTDataModels-Message" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Message</h1> <p style="margin: 10px 0 0 0">Subtypes: <a href="#Asterisk17RESTDataModels-ApplicationMoveFailed" style="color: #3b73af; text-decoration: none">ApplicationMoveFailed</a> <a href="#Asterisk17RESTDataModels-ApplicationReplaced" style="color: #3b73af; text-decoration: none">ApplicationReplaced</a> <a href="#Asterisk17RESTDataModels-BridgeAttendedTransfer" style="color: #3b73af; text-decoration: none">BridgeAttendedTransfer</a> <a href="#Asterisk17RESTDataModels-BridgeBlindTransfer" style="color: #3b73af; text-decoration: none">BridgeBlindTransfer</a> <a href="#Asterisk17RESTDataModels-BridgeCreated" style="color: #3b73af; text-decoration: none">BridgeCreated</a> <a href="#Asterisk17RESTDataModels-BridgeDestroyed" style="color: #3b73af; text-decoration: none">BridgeDestroyed</a> <a href="#Asterisk17RESTDataModels-BridgeMerged" style="color: #3b73af; text-decoration: none">BridgeMerged</a> <a href="#Asterisk17RESTDataModels-BridgeVideoSourceChanged" style="color: #3b73af; text-decoration: none">BridgeVideoSourceChanged</a> <a href="#Asterisk17RESTDataModels-ChannelCallerId" style="color: #3b73af; text-decoration: none">ChannelCallerId</a> <a href="#Asterisk17RESTDataModels-ChannelConnectedLine" style="color: #3b73af; text-decoration: none">ChannelConnectedLine</a> <a href="#Asterisk17RESTDataModels-ChannelCreated" style="color: #3b73af; text-decoration: none">ChannelCreated</a> <a href="#Asterisk17RESTDataModels-ChannelDestroyed" style="color: #3b73af; text-decoration: none">ChannelDestroyed</a> <a href="#Asterisk17RESTDataModels-ChannelDialplan" style="color: #3b73af; text-decoration: none">ChannelDialplan</a> <a href="#Asterisk17RESTDataModels-ChannelDtmfReceived" style="color: #3b73af; text-decoration: none">ChannelDtmfReceived</a> <a href="#Asterisk17RESTDataModels-ChannelEnteredBridge" style="color: #3b73af; text-decoration: none">ChannelEnteredBridge</a> <a href="#Asterisk17RESTDataModels-ChannelHangupRequest" style="color: #3b73af; text-decoration: none">ChannelHangupRequest</a> <a href="#Asterisk17RESTDataModels-ChannelHold" style="color: #3b73af; text-decoration: none">ChannelHold</a> <a href="#Asterisk17RESTDataModels-ChannelLeftBridge" style="color: #3b73af; text-decoration: none">ChannelLeftBridge</a> <a href="#Asterisk17RESTDataModels-ChannelStateChange" style="color: #3b73af; text-decoration: none">ChannelStateChange</a> <a href="#Asterisk17RESTDataModels-ChannelTalkingFinished" style="color: #3b73af; text-decoration: none">ChannelTalkingFinished</a> <a href="#Asterisk17RESTDataModels-ChannelTalkingStarted" style="color: #3b73af; text-decoration: none">ChannelTalkingStarted</a> <a href="#Asterisk17RESTDataModels-ChannelUnhold" style="color: #3b73af; text-decoration: none">ChannelUnhold</a> <a href="#Asterisk17RESTDataModels-ChannelUserevent" style="color: #3b73af; text-decoration: none">ChannelUserevent</a> <a href="#Asterisk17RESTDataModels-ChannelVarset" style="color: #3b73af; text-decoration: none">ChannelVarset</a> <a href="#Asterisk17RESTDataModels-ContactStatusChange" style="color: #3b73af; text-decoration: none">ContactStatusChange</a> <a href="#Asterisk17RESTDataModels-DeviceStateChanged" style="color: #3b73af; text-decoration: none">DeviceStateChanged</a> <a href="#Asterisk17RESTDataModels-Dial" style="color: #3b73af; text-decoration: none">Dial</a> <a href="#Asterisk17RESTDataModels-EndpointStateChange" style="color: #3b73af; text-decoration: none">EndpointStateChange</a> <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> <a href="#Asterisk17RESTDataModels-MissingParams" style="color: #3b73af; text-decoration: none">MissingParams</a> <a href="#Asterisk17RESTDataModels-PeerStatusChange" style="color: #3b73af; text-decoration: none">PeerStatusChange</a> <a href="#Asterisk17RESTDataModels-PlaybackContinuing" style="color: #3b73af; text-decoration: none">PlaybackContinuing</a> <a href="#Asterisk17RESTDataModels-PlaybackFinished" style="color: #3b73af; text-decoration: none">PlaybackFinished</a> <a href="#Asterisk17RESTDataModels-PlaybackStarted" style="color: #3b73af; text-decoration: none">PlaybackStarted</a> <a href="#Asterisk17RESTDataModels-RecordingFailed" style="color: #3b73af; text-decoration: none">RecordingFailed</a> <a href="#Asterisk17RESTDataModels-RecordingFinished" style="color: #3b73af; text-decoration: none">RecordingFinished</a> <a href="#Asterisk17RESTDataModels-RecordingStarted" style="color: #3b73af; text-decoration: none">RecordingStarted</a> <a href="#Asterisk17RESTDataModels-StasisEnd" style="color: #3b73af; text-decoration: none">StasisEnd</a> <a href="#Asterisk17RESTDataModels-StasisStart" style="color: #3b73af; text-decoration: none">StasisStart</a> <a href="#Asterisk17RESTDataModels-TextMessageReceived" style="color: #3b73af; text-decoration: none">TextMessageReceived</a> </p> <p style="margin: 10px 0 0 0">Base type for errors and events</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"discriminator": "type",
"properties": {
"type": {
"required": true,
"type": "string",
"description": "Indicates the type of this message."
},
"asterisk_id": {
"required": false,
"type": "string",
"description": "The unique ID for the Asterisk instance that raised this event."
}
},
"subTypes": [
"MissingParams",
"Event"
],
"id": "Message",
"description": "Base type for errors and events"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
</ul> <h1 id="Asterisk17RESTDataModels-MissingParams" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">MissingParams</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Message" style="color: #3b73af; text-decoration: none">Message</a> </p> <p style="margin: 10px 0 0 0">Error event sent when required params are missing.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"params": {
"required": true,
"type": "List[string]",
"description": "A list of the missing parameters"
}
},
"id": "MissingParams",
"description": "Error event sent when required params are missing."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>params: List[string] - A list of the missing parameters</li>
</ul> <h1 id="Asterisk17RESTDataModels-Peer" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Peer</h1> <p style="margin: 10px 0 0 0">Detailed information about a remote peer that communicates with Asterisk.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"peer_status": {
"required": true,
"type": "string",
"description": "The current state of the peer. Note that the values of the status are dependent on the underlying peer technology."
},
"time": {
"required": false,
"type": "string",
"description": "The last known time the peer was contacted."
},
"cause": {
"required": false,
"type": "string",
"description": "An optional reason associated with the change in peer_status."
},
"port": {
"required": false,
"type": "string",
"description": "The port of the peer."
},
"address": {
"required": false,
"type": "string",
"description": "The IP address of the peer."
}
},
"id": "Peer",
"description": "Detailed information about a remote peer that communicates with Asterisk."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>address: string <em>(optional)</em> - The IP address of the peer.</li>
<li>cause: string <em>(optional)</em> - An optional reason associated with the change in peer_status.</li>
<li>peer_status: string - The current state of the peer. Note that the values of the status are dependent on the underlying peer technology.</li>
<li>port: string <em>(optional)</em> - The port of the peer.</li>
<li>time: string <em>(optional)</em> - The last known time the peer was contacted.</li>
</ul> <h1 id="Asterisk17RESTDataModels-PeerStatusChange" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">PeerStatusChange</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">The state of a peer associated with an endpoint has changed.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"peer": {
"required": true,
"type": "Peer"
},
"endpoint": {
"required": true,
"type": "Endpoint"
}
},
"id": "PeerStatusChange",
"description": "The state of a peer associated with an endpoint has changed."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>endpoint: <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> </li>
<li>peer: <a href="#Asterisk17RESTDataModels-Peer" style="color: #3b73af; text-decoration: none">Peer</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-PlaybackContinuing" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">PlaybackContinuing</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing the continuation of a media playback operation from one media URI to the next in the list.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackContinuing",
"description": "Event showing the continuation of a media playback operation from one media URI to the next in the list."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>playback: <a href="#Asterisk17RESTDataModels-Playback" style="color: #3b73af; text-decoration: none">Playback</a> - Playback control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-PlaybackFinished" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">PlaybackFinished</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing the completion of a media playback operation.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackFinished",
"description": "Event showing the completion of a media playback operation."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>playback: <a href="#Asterisk17RESTDataModels-Playback" style="color: #3b73af; text-decoration: none">Playback</a> - Playback control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-PlaybackStarted" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">PlaybackStarted</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing the start of a media playback operation.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackStarted",
"description": "Event showing the start of a media playback operation."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>playback: <a href="#Asterisk17RESTDataModels-Playback" style="color: #3b73af; text-decoration: none">Playback</a> - Playback control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-RecordingFailed" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">RecordingFailed</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing failure of a recording operation.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingFailed",
"description": "Event showing failure of a recording operation."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>recording: <a href="#Asterisk17RESTDataModels-LiveRecording" style="color: #3b73af; text-decoration: none">LiveRecording</a> - Recording control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-RecordingFinished" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">RecordingFinished</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing the completion of a recording operation.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingFinished",
"description": "Event showing the completion of a recording operation."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>recording: <a href="#Asterisk17RESTDataModels-LiveRecording" style="color: #3b73af; text-decoration: none">LiveRecording</a> - Recording control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-RecordingStarted" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">RecordingStarted</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Event showing the start of a recording operation.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingStarted",
"description": "Event showing the start of a recording operation."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>recording: <a href="#Asterisk17RESTDataModels-LiveRecording" style="color: #3b73af; text-decoration: none">LiveRecording</a> - Recording control object</li>
</ul> <h1 id="Asterisk17RESTDataModels-StasisEnd" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">StasisEnd</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has left a Stasis application.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "StasisEnd",
"description": "Notification that a channel has left a Stasis application."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-StasisStart" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">StasisStart</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">Notification that a channel has entered a Stasis application.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
},
"replace_channel": {
"required": false,
"type": "Channel"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "StasisStart",
"description": "Notification that a channel has entered a Stasis application."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>args: List[string] - Arguments to the application</li>
<li>channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> </li>
<li>replace_channel: <a href="#Asterisk17RESTDataModels-Channel" style="color: #3b73af; text-decoration: none">Channel</a> <em>(optional)</em> </li>
</ul> <h1 id="Asterisk17RESTDataModels-TextMessageReceived" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">TextMessageReceived</h1> <p style="margin: 10px 0 0 0">Base type: <a href="#Asterisk17RESTDataModels-Event" style="color: #3b73af; text-decoration: none">Event</a> </p> <p style="margin: 10px 0 0 0">A text message was received from an endpoint.</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"message": {
"required": true,
"type": "TextMessage"
},
"endpoint": {
"required": false,
"type": "Endpoint"
}
},
"id": "TextMessageReceived",
"description": "A text message was received from an endpoint."
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>asterisk_id: string <em>(optional)</em> - The unique ID for the Asterisk instance that raised this event.</li>
<li>type: string - Indicates the type of this message.</li>
<li>application: string - Name of the application receiving the event.</li>
<li>timestamp: Date - Time at which this event was created.</li>
<li>endpoint: <a href="#Asterisk17RESTDataModels-Endpoint" style="color: #3b73af; text-decoration: none">Endpoint</a> <em>(optional)</em> </li>
<li>message: <a href="#Asterisk17RESTDataModels-TextMessage" style="color: #3b73af; text-decoration: none">TextMessage</a> </li>
</ul> <h1 id="Asterisk17RESTDataModels-Application" style="margin: 10px 0 0 0; font-size: 24px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">Application</h1> <p style="margin: 10px 0 0 0">Details of a Stasis application</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom">
<b class="code-title"></b>
<span class="collapse-source expand-control"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="theme: Confluence; brush: javascript; collapse: true; gutter: false" style="font-size:12px;; margin: 10px 0 0 0; margin-top: 0">
{
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of this application"
},
"endpoint_ids": {
"required": true,
"type": "List[string]",
"description": "{tech}/{resource} for endpoints subscribed to."
},
"channel_ids": {
"required": true,
"type": "List[string]",
"description": "Id's for channels subscribed to."
},
"device_names": {
"required": true,
"type": "List[string]",
"description": "Names of the devices subscribed to."
},
"events_disallowed": {
"required": true,
"type": "List[object]",
"description": "Event types not sent to the application."
},
"bridge_ids": {
"required": true,
"type": "List[string]",
"description": "Id's for bridges subscribed to."
},
"events_allowed": {
"required": true,
"type": "List[object]",
"description": "Event types sent to the application."
}
},
"id": "Application",
"description": "Details of a Stasis application"
}
</pre>
</div>
</div>
<ul style="margin: 10px 0 0 0">
<li>bridge_ids: List[string] - Id's for bridges subscribed to.</li>
<li>channel_ids: List[string] - Id's for channels subscribed to.</li>
<li>device_names: List[string] - Names of the devices subscribed to.</li>
<li>endpoint_ids: List[string] - {tech}/{resource} for endpoints subscribed to.</li>
<li>events_allowed: <a href="#Asterisk17RESTDataModels-object" style="color: #3b73af; text-decoration: none">List[object]</a> - Event types sent to the application.</li>
<li>events_disallowed: <a href="#Asterisk17RESTDataModels-object" style="color: #3b73af; text-decoration: none">List[object]</a> - Event types not sent to the application.</li>
<li>name: string - Name of this application</li>
</ul> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand action-padding last-row-padding" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #ccc; border-right: 1px solid #ccc; border-top: 0; border-bottom: 0; padding: 0 15px 15px 16px; background-color: #fff; padding-bottom: 10px; padding-bottom: 10px">
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">
<tbody>
<tr>
<td id="actions-pattern-container" valign="middle" style="padding: 0px; border-collapse: collapse; padding: 15px 0 0 24px; vertical-align: middle">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?src=email" title="View page Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image" height="16" width="16" border="0" title="View page Icon" src="cid:com.atlassian.confluence.plugins.confluence-email-resources%3Aview-page-email-adg-footer-item%3Aicon" alt="View page Icon" style="vertical-align: middle" /></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?src=email" title="View page" style="color: #3b73af; text-decoration: none">View page</a></td>
<td class="actions-pattern-action-bull" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; color: #999; padding: 0 5px">•</td>
</tr>
</tbody>
</table>
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?showComments=true&showCommentArea=true&src=email#addcomment" title="Add comment Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image" height="16" width="16" border="0" title="Add comment Icon" src="cid:com.atlassian.confluence.plugins.confluence-email-resources%3Aadd-comment-to-content-email-adg-footer-item%3Aicon" alt="Add comment Icon" style="vertical-align: middle" /></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+17+REST+Data+Models?showComments=true&showCommentArea=true&src=email#addcomment" title="Add comment" style="color: #3b73af; text-decoration: none">Add comment</a></td>
<td class="actions-pattern-action-bull" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; color: #999; padding: 0 5px">•</td>
</tr>
</tbody>
</table>
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://wiki.asterisk.org/wiki/plugins/likes/like.action?contentId=42010716&src=email" title="Like Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image" height="16" width="16" border="0" title="Like Icon" src="cid:com.atlassian.confluence.plugins.confluence-like%3Aview-email-adg-content-item%3Aicon" alt="Like Icon" style="vertical-align: middle" /></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://wiki.asterisk.org/wiki/plugins/likes/like.action?contentId=42010716&src=email" title="Like" style="color: #3b73af; text-decoration: none">Like</a></td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-rounded-bottom mobile-expand" style="padding: 0px; border-collapse: collapse; color: #fff; height: 5px; line-height: 5px; padding: 0 15px 0 16px; background-color: #fff; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; border-top: 0; border-left: 1px solid #ccc; border-bottom: 1px solid #ccc; border-right: 1px solid #ccc; mso-line-height-rule: exactly"> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="footer-pattern" style="padding: 0px; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">
<tbody>
<tr>
<td id="footer-pattern-links-container" width="100%" style="padding: 0px; border-collapse: collapse; color: #999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px">
<tbody>
<tr>
<td class="footer-pattern-links mobile-resize-text" style="padding: 0px; border-collapse: collapse"><a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST&src=email" title="" style="color: #3b73af; text-decoration: none">Stop watching space</a></td>
<td class="footer-pattern-links-bull" style="padding: 0px; border-collapse: collapse; padding: 0 5px; color: #999">•</td>
</tr>
</tbody>
</table>
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px">
<tbody>
<tr>
<td class="footer-pattern-links mobile-resize-text" style="padding: 0px; border-collapse: collapse"><a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action?src=email" title="" style="color: #3b73af; text-decoration: none">Manage notifications</a></td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0px; border-collapse: collapse; color: #999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px; display: none">This message was sent by Atlassian Confluence 5.6.6</td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table>
<table id="sealed-section" border="0" cellpadding="0" cellspacing="0" width="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; display: none">
<tbody>
<tr>
<td style="padding: 0px; border-collapse: collapse; border: 0; font-size: 0px; line-height: 0; mso-line-height-rule: exactly"></td>
</tr>
</tbody>
</table>
</body>
</html>