Home Explore Help
Register Sign In
dingyu
/
Asterisk
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
Asterisk
/
doc
/
Asterisk-Admin-Guide
/
Asterisk-13-Channels-REST-API_29394321.html

Asterisk-13-Channels-REST-API_29394321.html 32 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3.     <head>
    4. 

  4.         <title>Asterisk Project : Asterisk 13 Channels REST API</title>
    5. 

  5.         <link rel="stylesheet" href="styles/site.css" type="text/css" />
    6. 

  6.         <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7.     </head>
    8. 

  8. 

  9.     <body class="theme-default aui-theme-default">
    10. 

  10.         <div id="page">
    11. 

  11.             <div id="main" class="aui-page-panel">
    12. 

  12.                 <div id="main-header">
    13. 

  13.                     <div id="breadcrumb-section">
    14. 

  14.                         <ol id="breadcrumbs">
    15. 

  15.                             <li class="first">
    16. 

  16.                                 <span><a href="index.html">Asterisk Project</a></span>
    17. 

  17.                             </li>
    18. 

  18.                                                     <li>
    19. 

  19.                                 <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
    20. 

  20.                             </li>
    21. 

  21.                                                     <li>
    22. 

  22.                                 <span><a href="Asterisk-13-ARI_29394283.html">Asterisk 13 ARI</a></span>
    23. 

  23.                             </li>
    24. 

  24.                                                 </ol>
    25. 

  25.                     </div>
    26. 

  26.                     <h1 id="title-heading" class="pagetitle">
    27. 

  27.                                                 <span id="title-text">
    28. 

  28.                             Asterisk Project : Asterisk 13 Channels REST API
    29. 

  29.                         </span>
    30. 

  30.                     </h1>
    31. 

  31.                 </div>
    32. 

  32. 

  33.                 <div id="content" class="view">
    34. 

  34.                     <div class="page-metadata">
    35. 

  35.                         
    36. 

  36.         
    37. 

  37.     
    38. 

  38.         
    39. 

  39.     
    40. 

  40.         
    41. 

  41.     
    42. 

  42.             Created and last modified by <span class='author'> wikibot</span> on Aug 11, 2014
    43. 

  43.                         </div>
    44. 

  44.                     <div id="main-content" class="wiki-content group">
    45. 

  45.                     <h1 id="Asterisk13ChannelsRESTAPI-Channels">Channels</h1>
    46. 

  46. 

  47. <div class="table-wrap"><table class="confluenceTable"><tbody>
    48. 

  48. <tr>
    49. 

  49. <th class="confluenceTh"><p> Method </p></th>
    50. 

  50. <th class="confluenceTh"><p> Path </p></th>
    51. 

  51. <th class="confluenceTh"><p> Return Model </p></th>
    52. 

  52. <th class="confluenceTh"><p> Summary </p></th>
    53. 

  53. </tr>
    54. 

  54. <tr>
    55. 

  55. <td class="confluenceTd"><p> GET </p></td>
    56. 

  56. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels</a> </p></td>
    57. 

  57. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">List[Channel]</a> </p></td>
    58. 

  58. <td class="confluenceTd"><p> List all active channels in Asterisk. </p></td>
    59. 

  59. </tr>
    60. 

  60. <tr>
    61. 

  61. <td class="confluenceTd"><p> POST </p></td>
    62. 

  62. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels</a> </p></td>
    63. 

  63. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">Channel</a> </p></td>
    64. 

  64. <td class="confluenceTd"><p> Create a new channel (originate). </p></td>
    65. 

  65. </tr>
    66. 

  66. <tr>
    67. 

  67. <td class="confluenceTd"><p> GET </p></td>
    68. 

  68. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}</a> </p></td>
    69. 

  69. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">Channel</a> </p></td>
    70. 

  70. <td class="confluenceTd"><p> Channel details. </p></td>
    71. 

  71. </tr>
    72. 

  72. <tr>
    73. 

  73. <td class="confluenceTd"><p> POST </p></td>
    74. 

  74. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}</a> </p></td>
    75. 

  75. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">Channel</a> </p></td>
    76. 

  76. <td class="confluenceTd"><p> Create a new channel (originate with id). </p></td>
    77. 

  77. </tr>
    78. 

  78. <tr>
    79. 

  79. <td class="confluenceTd"><p> DELETE </p></td>
    80. 

  80. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}</a> </p></td>
    81. 

  81. <td class="confluenceTd"><p> void </p></td>
    82. 

  82. <td class="confluenceTd"><p> Delete (i.e. hangup) a channel. </p></td>
    83. 

  83. </tr>
    84. 

  84. <tr>
    85. 

  85. <td class="confluenceTd"><p> POST </p></td>
    86. 

  86. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/continue</a> </p></td>
    87. 

  87. <td class="confluenceTd"><p> void </p></td>
    88. 

  88. <td class="confluenceTd"><p> Exit application; continue execution in the dialplan. </p></td>
    89. 

  89. </tr>
    90. 

  90. <tr>
    91. 

  91. <td class="confluenceTd"><p> POST </p></td>
    92. 

  92. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/answer</a> </p></td>
    93. 

  93. <td class="confluenceTd"><p> void </p></td>
    94. 

  94. <td class="confluenceTd"><p> Answer a channel. </p></td>
    95. 

  95. </tr>
    96. 

  96. <tr>
    97. 

  97. <td class="confluenceTd"><p> POST </p></td>
    98. 

  98. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/ring</a> </p></td>
    99. 

  99. <td class="confluenceTd"><p> void </p></td>
    100. 

  100. <td class="confluenceTd"><p> Indicate ringing to a channel. </p></td>
    101. 

  101. </tr>
    102. 

  102. <tr>
    103. 

  103. <td class="confluenceTd"><p> DELETE </p></td>
    104. 

  104. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/ring</a> </p></td>
    105. 

  105. <td class="confluenceTd"><p> void </p></td>
    106. 

  106. <td class="confluenceTd"><p> Stop ringing indication on a channel if locally generated. </p></td>
    107. 

  107. </tr>
    108. 

  108. <tr>
    109. 

  109. <td class="confluenceTd"><p> POST </p></td>
    110. 

  110. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/dtmf</a> </p></td>
    111. 

  111. <td class="confluenceTd"><p> void </p></td>
    112. 

  112. <td class="confluenceTd"><p> Send provided DTMF to a given channel. </p></td>
    113. 

  113. </tr>
    114. 

  114. <tr>
    115. 

  115. <td class="confluenceTd"><p> POST </p></td>
    116. 

  116. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/mute</a> </p></td>
    117. 

  117. <td class="confluenceTd"><p> void </p></td>
    118. 

  118. <td class="confluenceTd"><p> Mute a channel. </p></td>
    119. 

  119. </tr>
    120. 

  120. <tr>
    121. 

  121. <td class="confluenceTd"><p> DELETE </p></td>
    122. 

  122. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/mute</a> </p></td>
    123. 

  123. <td class="confluenceTd"><p> void </p></td>
    124. 

  124. <td class="confluenceTd"><p> Unmute a channel. </p></td>
    125. 

  125. </tr>
    126. 

  126. <tr>
    127. 

  127. <td class="confluenceTd"><p> POST </p></td>
    128. 

  128. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/hold</a> </p></td>
    129. 

  129. <td class="confluenceTd"><p> void </p></td>
    130. 

  130. <td class="confluenceTd"><p> Hold a channel. </p></td>
    131. 

  131. </tr>
    132. 

  132. <tr>
    133. 

  133. <td class="confluenceTd"><p> DELETE </p></td>
    134. 

  134. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/hold</a> </p></td>
    135. 

  135. <td class="confluenceTd"><p> void </p></td>
    136. 

  136. <td class="confluenceTd"><p> Remove a channel from hold. </p></td>
    137. 

  137. </tr>
    138. 

  138. <tr>
    139. 

  139. <td class="confluenceTd"><p> POST </p></td>
    140. 

  140. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/moh</a> </p></td>
    141. 

  141. <td class="confluenceTd"><p> void </p></td>
    142. 

  142. <td class="confluenceTd"><p> Play music on hold to a channel. </p></td>
    143. 

  143. </tr>
    144. 

  144. <tr>
    145. 

  145. <td class="confluenceTd"><p> DELETE </p></td>
    146. 

  146. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/moh</a> </p></td>
    147. 

  147. <td class="confluenceTd"><p> void </p></td>
    148. 

  148. <td class="confluenceTd"><p> Stop playing music on hold to a channel. </p></td>
    149. 

  149. </tr>
    150. 

  150. <tr>
    151. 

  151. <td class="confluenceTd"><p> POST </p></td>
    152. 

  152. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/silence</a> </p></td>
    153. 

  153. <td class="confluenceTd"><p> void </p></td>
    154. 

  154. <td class="confluenceTd"><p> Play silence to a channel. </p></td>
    155. 

  155. </tr>
    156. 

  156. <tr>
    157. 

  157. <td class="confluenceTd"><p> DELETE </p></td>
    158. 

  158. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/silence</a> </p></td>
    159. 

  159. <td class="confluenceTd"><p> void </p></td>
    160. 

  160. <td class="confluenceTd"><p> Stop playing silence to a channel. </p></td>
    161. 

  161. </tr>
    162. 

  162. <tr>
    163. 

  163. <td class="confluenceTd"><p> POST </p></td>
    164. 

  164. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/play</a> </p></td>
    165. 

  165. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Playback">Playback</a> </p></td>
    166. 

  166. <td class="confluenceTd"><p> Start playback of media. </p></td>
    167. 

  167. </tr>
    168. 

  168. <tr>
    169. 

  169. <td class="confluenceTd"><p> POST </p></td>
    170. 

  170. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/play/{playbackId}</a> </p></td>
    171. 

  171. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Playback">Playback</a> </p></td>
    172. 

  172. <td class="confluenceTd"><p> Start playback of media and specify the playbackId. </p></td>
    173. 

  173. </tr>
    174. 

  174. <tr>
    175. 

  175. <td class="confluenceTd"><p> POST </p></td>
    176. 

  176. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/record</a> </p></td>
    177. 

  177. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-LiveRecording">LiveRecording</a> </p></td>
    178. 

  178. <td class="confluenceTd"><p> Start a recording. </p></td>
    179. 

  179. </tr>
    180. 

  180. <tr>
    181. 

  181. <td class="confluenceTd"><p> GET </p></td>
    182. 

  182. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/variable</a> </p></td>
    183. 

  183. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Variable">Variable</a> </p></td>
    184. 

  184. <td class="confluenceTd"><p> Get the value of a channel variable or function. </p></td>
    185. 

  185. </tr>
    186. 

  186. <tr>
    187. 

  187. <td class="confluenceTd"><p> POST </p></td>
    188. 

  188. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/variable</a> </p></td>
    189. 

  189. <td class="confluenceTd"><p> void </p></td>
    190. 

  190. <td class="confluenceTd"><p> Set the value of a channel variable or function. </p></td>
    191. 

  191. </tr>
    192. 

  192. <tr>
    193. 

  193. <td class="confluenceTd"><p> POST </p></td>
    194. 

  194. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/snoop</a> </p></td>
    195. 

  195. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">Channel</a> </p></td>
    196. 

  196. <td class="confluenceTd"><p> Start snooping. </p></td>
    197. 

  197. </tr>
    198. 

  198. <tr>
    199. 

  199. <td class="confluenceTd"><p> POST </p></td>
    200. 

  200. <td class="confluenceTd"><p> <a href="Asterisk-13-Channels-REST-API_29394321.html">/channels/{channelId}/snoop/{snoopId}</a> </p></td>
    201. 

  201. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Channel">Channel</a> </p></td>
    202. 

  202. <td class="confluenceTd"><p> Start snooping. </p></td>
    203. 

  203. </tr>
    204. 

  204. </tbody></table></div>
    205. 

  205. 

  206. 

  207. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-list"></span></p>
    208. 

  208. <h2 id="Asterisk13ChannelsRESTAPI-GET/channels">GET /channels</h2>
    209. 

  209. 

  210. <p>List all active channels in Asterisk.</p>
    211. 

  211. 

  212. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-originate"></span></p>
    213. 

  213. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels">POST /channels</h2>
    214. 

  214. 

  215. <p>Create a new channel (originate). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.</p>
    216. 

  216. 

  217. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters">Query parameters</h3>
    218. 

  218. <ul>
    219. 

  219. 	<li>endpoint: string - <strong>(required)</strong> Endpoint to call.</li>
    220. 

  220. 	<li>extension: string - The extension to dial after the endpoint answers</li>
    221. 

  221. 	<li>context: string - The context to dial after the endpoint answers. If omitted, uses 'default'</li>
    222. 

  222. 	<li>priority: long - The priority to dial after the endpoint answers. If omitted, uses 1</li>
    223. 

  223. 	<li>app: string - The application that is subscribed to the originated channel, and passed to the Stasis application.</li>
    224. 

  224. 	<li>appArgs: string - The application arguments to pass to the Stasis application.</li>
    225. 

  225. 	<li>callerId: string - CallerID to use when dialing the endpoint or extension.</li>
    226. 

  226. 	<li>timeout: int = 30 - Timeout (in seconds) before giving up dialing, or -1 for no timeout.</li>
    227. 

  227. 	<li>channelId: string - The unique id to assign the channel on creation.</li>
    228. 

  228. 	<li>otherChannelId: string - The unique id to assign the second channel when using local channels.</li>
    229. 

  229. </ul>
    230. 

  230. 

  231. 

  232. <h3 id="Asterisk13ChannelsRESTAPI-Bodyparameter">Body parameter</h3>
    233. 

  233. <ul>
    234. 

  234. 	<li>variables: containers - The &quot;variables&quot; key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { &quot;endpoint&quot;: &quot;SIP/Alice&quot;, &quot;variables&quot;: { &quot;CALLERID(name)&quot;: &quot;Alice&quot; } }</li>
    235. 

  235. </ul>
    236. 

  236. 

  237. 

  238. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses">Error Responses</h3>
    239. 

  239. <ul>
    240. 

  240. 	<li>400 - Invalid parameters for originating a channel.</li>
    241. 

  241. </ul>
    242. 

  242. 

  243. 

  244. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-get"></span></p>
    245. 

  245. <h2 id="Asterisk13ChannelsRESTAPI-GET/channels/{channelId}">GET /channels/{channelId}</h2>
    246. 

  246. 

  247. <p>Channel details.</p>
    248. 

  248. 

  249. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters">Path parameters</h3>
    250. 

  250. <ul>
    251. 

  251. 	<li>channelId: string - Channel's id</li>
    252. 

  252. </ul>
    253. 

  253. 

  254. 

  255. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.1">Error Responses</h3>
    256. 

  256. <ul>
    257. 

  257. 	<li>404 - Channel not found</li>
    258. 

  258. </ul>
    259. 

  259. 

  260. 

  261. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-originateWithId"></span></p>
    262. 

  262. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}">POST /channels/{channelId}</h2>
    263. 

  263. 

  264. <p>Create a new channel (originate with id). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.</p>
    265. 

  265. 

  266. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.1">Path parameters</h3>
    267. 

  267. <ul>
    268. 

  268. 	<li>channelId: string - The unique id to assign the channel on creation.</li>
    269. 

  269. </ul>
    270. 

  270. 

  271. 

  272. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.1">Query parameters</h3>
    273. 

  273. <ul>
    274. 

  274. 	<li>endpoint: string - <strong>(required)</strong> Endpoint to call.</li>
    275. 

  275. 	<li>extension: string - The extension to dial after the endpoint answers</li>
    276. 

  276. 	<li>context: string - The context to dial after the endpoint answers. If omitted, uses 'default'</li>
    277. 

  277. 	<li>priority: long - The priority to dial after the endpoint answers. If omitted, uses 1</li>
    278. 

  278. 	<li>app: string - The application that is subscribed to the originated channel, and passed to the Stasis application.</li>
    279. 

  279. 	<li>appArgs: string - The application arguments to pass to the Stasis application.</li>
    280. 

  280. 	<li>callerId: string - CallerID to use when dialing the endpoint or extension.</li>
    281. 

  281. 	<li>timeout: int = 30 - Timeout (in seconds) before giving up dialing, or -1 for no timeout.</li>
    282. 

  282. 	<li>otherChannelId: string - The unique id to assign the second channel when using local channels.</li>
    283. 

  283. </ul>
    284. 

  284. 

  285. 

  286. <h3 id="Asterisk13ChannelsRESTAPI-Bodyparameter.1">Body parameter</h3>
    287. 

  287. <ul>
    288. 

  288. 	<li>variables: containers - The &quot;variables&quot; key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { &quot;endpoint&quot;: &quot;SIP/Alice&quot;, &quot;variables&quot;: { &quot;CALLERID(name)&quot;: &quot;Alice&quot; } }</li>
    289. 

  289. </ul>
    290. 

  290. 

  291. 

  292. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.2">Error Responses</h3>
    293. 

  293. <ul>
    294. 

  294. 	<li>400 - Invalid parameters for originating a channel.</li>
    295. 

  295. </ul>
    296. 

  296. 

  297. 

  298. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-hangup"></span></p>
    299. 

  299. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}">DELETE /channels/{channelId}</h2>
    300. 

  300. 

  301. <p>Delete (i.e. hangup) a channel.</p>
    302. 

  302. 

  303. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.2">Path parameters</h3>
    304. 

  304. <ul>
    305. 

  305. 	<li>channelId: string - Channel's id</li>
    306. 

  306. </ul>
    307. 

  307. 

  308. 

  309. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.2">Query parameters</h3>
    310. 

  310. <ul>
    311. 

  311. 	<li>reason: string - Reason for hanging up the channel</li>
    312. 

  312. </ul>
    313. 

  313. 

  314. 

  315. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.3">Error Responses</h3>
    316. 

  316. <ul>
    317. 

  317. 	<li>400 - Invalid reason for hangup provided</li>
    318. 

  318. 	<li>404 - Channel not found</li>
    319. 

  319. </ul>
    320. 

  320. 

  321. 

  322. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-continueInDialplan"></span></p>
    323. 

  323. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/continue">POST /channels/{channelId}/continue</h2>
    324. 

  324. 

  325. <p>Exit application; continue execution in the dialplan.</p>
    326. 

  326. 

  327. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.3">Path parameters</h3>
    328. 

  328. <ul>
    329. 

  329. 	<li>channelId: string - Channel's id</li>
    330. 

  330. </ul>
    331. 

  331. 

  332. 

  333. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.3">Query parameters</h3>
    334. 

  334. <ul>
    335. 

  335. 	<li>context: string - The context to continue to.</li>
    336. 

  336. 	<li>extension: string - The extension to continue to.</li>
    337. 

  337. 	<li>priority: int - The priority to continue to.</li>
    338. 

  338. </ul>
    339. 

  339. 

  340. 

  341. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.4">Error Responses</h3>
    342. 

  342. <ul>
    343. 

  343. 	<li>404 - Channel not found</li>
    344. 

  344. 	<li>409 - Channel not in a Stasis application</li>
    345. 

  345. </ul>
    346. 

  346. 

  347. 

  348. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-answer"></span></p>
    349. 

  349. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/answer">POST /channels/{channelId}/answer</h2>
    350. 

  350. 

  351. <p>Answer a channel.</p>
    352. 

  352. 

  353. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.4">Path parameters</h3>
    354. 

  354. <ul>
    355. 

  355. 	<li>channelId: string - Channel's id</li>
    356. 

  356. </ul>
    357. 

  357. 

  358. 

  359. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.5">Error Responses</h3>
    360. 

  360. <ul>
    361. 

  361. 	<li>404 - Channel not found</li>
    362. 

  362. 	<li>409 - Channel not in a Stasis application</li>
    363. 

  363. </ul>
    364. 

  364. 

  365. 

  366. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-ring"></span></p>
    367. 

  367. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/ring">POST /channels/{channelId}/ring</h2>
    368. 

  368. 

  369. <p>Indicate ringing to a channel.</p>
    370. 

  370. 

  371. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.5">Path parameters</h3>
    372. 

  372. <ul>
    373. 

  373. 	<li>channelId: string - Channel's id</li>
    374. 

  374. </ul>
    375. 

  375. 

  376. 

  377. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.6">Error Responses</h3>
    378. 

  378. <ul>
    379. 

  379. 	<li>404 - Channel not found</li>
    380. 

  380. 	<li>409 - Channel not in a Stasis application</li>
    381. 

  381. </ul>
    382. 

  382. 

  383. 

  384. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-ringStop"></span></p>
    385. 

  385. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}/ring">DELETE /channels/{channelId}/ring</h2>
    386. 

  386. 

  387. <p>Stop ringing indication on a channel if locally generated.</p>
    388. 

  388. 

  389. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.6">Path parameters</h3>
    390. 

  390. <ul>
    391. 

  391. 	<li>channelId: string - Channel's id</li>
    392. 

  392. </ul>
    393. 

  393. 

  394. 

  395. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.7">Error Responses</h3>
    396. 

  396. <ul>
    397. 

  397. 	<li>404 - Channel not found</li>
    398. 

  398. 	<li>409 - Channel not in a Stasis application</li>
    399. 

  399. </ul>
    400. 

  400. 

  401. 

  402. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-sendDTMF"></span></p>
    403. 

  403. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/dtmf">POST /channels/{channelId}/dtmf</h2>
    404. 

  404. 

  405. <p>Send provided DTMF to a given channel.</p>
    406. 

  406. 

  407. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.7">Path parameters</h3>
    408. 

  408. <ul>
    409. 

  409. 	<li>channelId: string - Channel's id</li>
    410. 

  410. </ul>
    411. 

  411. 

  412. 

  413. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.4">Query parameters</h3>
    414. 

  414. <ul>
    415. 

  415. 	<li>dtmf: string - DTMF To send.</li>
    416. 

  416. 	<li>before: int - Amount of time to wait before DTMF digits (specified in milliseconds) start.</li>
    417. 

  417. 	<li>between: int = 100 - Amount of time in between DTMF digits (specified in milliseconds).</li>
    418. 

  418. 	<li>duration: int = 100 - Length of each DTMF digit (specified in milliseconds).</li>
    419. 

  419. 	<li>after: int - Amount of time to wait after DTMF digits (specified in milliseconds) end.</li>
    420. 

  420. </ul>
    421. 

  421. 

  422. 

  423. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.8">Error Responses</h3>
    424. 

  424. <ul>
    425. 

  425. 	<li>400 - DTMF is required</li>
    426. 

  426. 	<li>404 - Channel not found</li>
    427. 

  427. 	<li>409 - Channel not in a Stasis application</li>
    428. 

  428. </ul>
    429. 

  429. 

  430. 

  431. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-mute"></span></p>
    432. 

  432. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/mute">POST /channels/{channelId}/mute</h2>
    433. 

  433. 

  434. <p>Mute a channel.</p>
    435. 

  435. 

  436. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.8">Path parameters</h3>
    437. 

  437. <ul>
    438. 

  438. 	<li>channelId: string - Channel's id</li>
    439. 

  439. </ul>
    440. 

  440. 

  441. 

  442. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.5">Query parameters</h3>
    443. 

  443. <ul>
    444. 

  444. 	<li>direction: string = both - Direction in which to mute audio</li>
    445. 

  445. </ul>
    446. 

  446. 

  447. 

  448. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.9">Error Responses</h3>
    449. 

  449. <ul>
    450. 

  450. 	<li>404 - Channel not found</li>
    451. 

  451. 	<li>409 - Channel not in a Stasis application</li>
    452. 

  452. </ul>
    453. 

  453. 

  454. 

  455. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-unmute"></span></p>
    456. 

  456. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}/mute">DELETE /channels/{channelId}/mute</h2>
    457. 

  457. 

  458. <p>Unmute a channel.</p>
    459. 

  459. 

  460. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.9">Path parameters</h3>
    461. 

  461. <ul>
    462. 

  462. 	<li>channelId: string - Channel's id</li>
    463. 

  463. </ul>
    464. 

  464. 

  465. 

  466. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.6">Query parameters</h3>
    467. 

  467. <ul>
    468. 

  468. 	<li>direction: string = both - Direction in which to unmute audio</li>
    469. 

  469. </ul>
    470. 

  470. 

  471. 

  472. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.10">Error Responses</h3>
    473. 

  473. <ul>
    474. 

  474. 	<li>404 - Channel not found</li>
    475. 

  475. 	<li>409 - Channel not in a Stasis application</li>
    476. 

  476. </ul>
    477. 

  477. 

  478. 

  479. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-hold"></span></p>
    480. 

  480. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/hold">POST /channels/{channelId}/hold</h2>
    481. 

  481. 

  482. <p>Hold a channel.</p>
    483. 

  483. 

  484. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.10">Path parameters</h3>
    485. 

  485. <ul>
    486. 

  486. 	<li>channelId: string - Channel's id</li>
    487. 

  487. </ul>
    488. 

  488. 

  489. 

  490. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.11">Error Responses</h3>
    491. 

  491. <ul>
    492. 

  492. 	<li>404 - Channel not found</li>
    493. 

  493. 	<li>409 - Channel not in a Stasis application</li>
    494. 

  494. </ul>
    495. 

  495. 

  496. 

  497. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-unhold"></span></p>
    498. 

  498. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}/hold">DELETE /channels/{channelId}/hold</h2>
    499. 

  499. 

  500. <p>Remove a channel from hold.</p>
    501. 

  501. 

  502. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.11">Path parameters</h3>
    503. 

  503. <ul>
    504. 

  504. 	<li>channelId: string - Channel's id</li>
    505. 

  505. </ul>
    506. 

  506. 

  507. 

  508. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.12">Error Responses</h3>
    509. 

  509. <ul>
    510. 

  510. 	<li>404 - Channel not found</li>
    511. 

  511. 	<li>409 - Channel not in a Stasis application</li>
    512. 

  512. </ul>
    513. 

  513. 

  514. 

  515. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-startMoh"></span></p>
    516. 

  516. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/moh">POST /channels/{channelId}/moh</h2>
    517. 

  517. 

  518. <p>Play music on hold to a channel. Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.</p>
    519. 

  519. 

  520. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.12">Path parameters</h3>
    521. 

  521. <ul>
    522. 

  522. 	<li>channelId: string - Channel's id</li>
    523. 

  523. </ul>
    524. 

  524. 

  525. 

  526. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.7">Query parameters</h3>
    527. 

  527. <ul>
    528. 

  528. 	<li>mohClass: string - Music on hold class to use</li>
    529. 

  529. </ul>
    530. 

  530. 

  531. 

  532. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.13">Error Responses</h3>
    533. 

  533. <ul>
    534. 

  534. 	<li>404 - Channel not found</li>
    535. 

  535. 	<li>409 - Channel not in a Stasis application</li>
    536. 

  536. </ul>
    537. 

  537. 

  538. 

  539. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-stopMoh"></span></p>
    540. 

  540. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}/moh">DELETE /channels/{channelId}/moh</h2>
    541. 

  541. 

  542. <p>Stop playing music on hold to a channel.</p>
    543. 

  543. 

  544. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.13">Path parameters</h3>
    545. 

  545. <ul>
    546. 

  546. 	<li>channelId: string - Channel's id</li>
    547. 

  547. </ul>
    548. 

  548. 

  549. 

  550. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.14">Error Responses</h3>
    551. 

  551. <ul>
    552. 

  552. 	<li>404 - Channel not found</li>
    553. 

  553. 	<li>409 - Channel not in a Stasis application</li>
    554. 

  554. </ul>
    555. 

  555. 

  556. 

  557. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-startSilence"></span></p>
    558. 

  558. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/silence">POST /channels/{channelId}/silence</h2>
    559. 

  559. 

  560. <p>Play silence to a channel. Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.</p>
    561. 

  561. 

  562. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.14">Path parameters</h3>
    563. 

  563. <ul>
    564. 

  564. 	<li>channelId: string - Channel's id</li>
    565. 

  565. </ul>
    566. 

  566. 

  567. 

  568. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.15">Error Responses</h3>
    569. 

  569. <ul>
    570. 

  570. 	<li>404 - Channel not found</li>
    571. 

  571. 	<li>409 - Channel not in a Stasis application</li>
    572. 

  572. </ul>
    573. 

  573. 

  574. 

  575. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-stopSilence"></span></p>
    576. 

  576. <h2 id="Asterisk13ChannelsRESTAPI-DELETE/channels/{channelId}/silence">DELETE /channels/{channelId}/silence</h2>
    577. 

  577. 

  578. <p>Stop playing silence to a channel.</p>
    579. 

  579. 

  580. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.15">Path parameters</h3>
    581. 

  581. <ul>
    582. 

  582. 	<li>channelId: string - Channel's id</li>
    583. 

  583. </ul>
    584. 

  584. 

  585. 

  586. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.16">Error Responses</h3>
    587. 

  587. <ul>
    588. 

  588. 	<li>404 - Channel not found</li>
    589. 

  589. 	<li>409 - Channel not in a Stasis application</li>
    590. 

  590. </ul>
    591. 

  591. 

  592. 

  593. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-play"></span></p>
    594. 

  594. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/play">POST /channels/{channelId}/play</h2>
    595. 

  595. 

  596. <p>Start playback of media. The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)</p>
    597. 

  597. 

  598. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.16">Path parameters</h3>
    599. 

  599. <ul>
    600. 

  600. 	<li>channelId: string - Channel's id</li>
    601. 

  601. </ul>
    602. 

  602. 

  603. 

  604. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.8">Query parameters</h3>
    605. 

  605. <ul>
    606. 

  606. 	<li>media: string - <strong>(required)</strong> Media's URI to play.</li>
    607. 

  607. 	<li>lang: string - For sounds, selects language for sound.</li>
    608. 

  608. 	<li>offsetms: int - Number of media to skip before playing.</li>
    609. 

  609. 	<li>skipms: int = 3000 - Number of milliseconds to skip for forward/reverse operations.</li>
    610. 

  610. 	<li>playbackId: string - Playback ID.</li>
    611. 

  611. </ul>
    612. 

  612. 

  613. 

  614. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.17">Error Responses</h3>
    615. 

  615. <ul>
    616. 

  616. 	<li>404 - Channel not found</li>
    617. 

  617. 	<li>409 - Channel not in a Stasis application</li>
    618. 

  618. </ul>
    619. 

  619. 

  620. 

  621. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-playWithId"></span></p>
    622. 

  622. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/play/{playbackId}">POST /channels/{channelId}/play/{playbackId}</h2>
    623. 

  623. 

  624. <p>Start playback of media and specify the playbackId. The media URI may be any of a number of URI's. Currently sound: and recording: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)</p>
    625. 

  625. 

  626. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.17">Path parameters</h3>
    627. 

  627. <ul>
    628. 

  628. 	<li>channelId: string - Channel's id</li>
    629. 

  629. 	<li>playbackId: string - Playback ID.</li>
    630. 

  630. </ul>
    631. 

  631. 

  632. 

  633. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.9">Query parameters</h3>
    634. 

  634. <ul>
    635. 

  635. 	<li>media: string - <strong>(required)</strong> Media's URI to play.</li>
    636. 

  636. 	<li>lang: string - For sounds, selects language for sound.</li>
    637. 

  637. 	<li>offsetms: int - Number of media to skip before playing.</li>
    638. 

  638. 	<li>skipms: int = 3000 - Number of milliseconds to skip for forward/reverse operations.</li>
    639. 

  639. </ul>
    640. 

  640. 

  641. 

  642. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.18">Error Responses</h3>
    643. 

  643. <ul>
    644. 

  644. 	<li>404 - Channel not found</li>
    645. 

  645. 	<li>409 - Channel not in a Stasis application</li>
    646. 

  646. </ul>
    647. 

  647. 

  648. 

  649. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-record"></span></p>
    650. 

  650. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/record">POST /channels/{channelId}/record</h2>
    651. 

  651. 

  652. <p>Start a recording. Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if that's what you want.</p>
    653. 

  653. 

  654. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.18">Path parameters</h3>
    655. 

  655. <ul>
    656. 

  656. 	<li>channelId: string - Channel's id</li>
    657. 

  657. </ul>
    658. 

  658. 

  659. 

  660. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.10">Query parameters</h3>
    661. 

  661. <ul>
    662. 

  662. 	<li>name: string - <strong>(required)</strong> Recording's filename</li>
    663. 

  663. 	<li>format: string - <strong>(required)</strong> Format to encode audio in</li>
    664. 

  664. 	<li>maxDurationSeconds: int - Maximum duration of the recording, in seconds. 0 for no limit</li>
    665. 

  665. 	<li>maxSilenceSeconds: int - Maximum duration of silence, in seconds. 0 for no limit</li>
    666. 

  666. 	<li>ifExists: string = fail - Action to take if a recording with the same name already exists.</li>
    667. 

  667. 	<li>beep: boolean - Play beep when recording begins</li>
    668. 

  668. 	<li>terminateOn: string = none - DTMF input to terminate recording</li>
    669. 

  669. </ul>
    670. 

  670. 

  671. 

  672. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.19">Error Responses</h3>
    673. 

  673. <ul>
    674. 

  674. 	<li>400 - Invalid parameters</li>
    675. 

  675. 	<li>404 - Channel not found</li>
    676. 

  676. 	<li>409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail</li>
    677. 

  677. 	<li>422 - The format specified is unknown on this system</li>
    678. 

  678. </ul>
    679. 

  679. 

  680. 

  681. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-getChannelVar"></span></p>
    682. 

  682. <h2 id="Asterisk13ChannelsRESTAPI-GET/channels/{channelId}/variable">GET /channels/{channelId}/variable</h2>
    683. 

  683. 

  684. <p>Get the value of a channel variable or function.</p>
    685. 

  685. 

  686. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.19">Path parameters</h3>
    687. 

  687. <ul>
    688. 

  688. 	<li>channelId: string - Channel's id</li>
    689. 

  689. </ul>
    690. 

  690. 

  691. 

  692. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.11">Query parameters</h3>
    693. 

  693. <ul>
    694. 

  694. 	<li>variable: string - <strong>(required)</strong> The channel variable or function to get</li>
    695. 

  695. </ul>
    696. 

  696. 

  697. 

  698. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.20">Error Responses</h3>
    699. 

  699. <ul>
    700. 

  700. 	<li>400 - Missing variable parameter.</li>
    701. 

  701. 	<li>404 - Channel not found</li>
    702. 

  702. 	<li>409 - Channel not in a Stasis application</li>
    703. 

  703. </ul>
    704. 

  704. 

  705. 

  706. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-setChannelVar"></span></p>
    707. 

  707. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/variable">POST /channels/{channelId}/variable</h2>
    708. 

  708. 

  709. <p>Set the value of a channel variable or function.</p>
    710. 

  710. 

  711. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.20">Path parameters</h3>
    712. 

  712. <ul>
    713. 

  713. 	<li>channelId: string - Channel's id</li>
    714. 

  714. </ul>
    715. 

  715. 

  716. 

  717. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.12">Query parameters</h3>
    718. 

  718. <ul>
    719. 

  719. 	<li>variable: string - <strong>(required)</strong> The channel variable or function to set</li>
    720. 

  720. 	<li>value: string - The value to set the variable to</li>
    721. 

  721. </ul>
    722. 

  722. 

  723. 

  724. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.21">Error Responses</h3>
    725. 

  725. <ul>
    726. 

  726. 	<li>400 - Missing variable parameter.</li>
    727. 

  727. 	<li>404 - Channel not found</li>
    728. 

  728. 	<li>409 - Channel not in a Stasis application</li>
    729. 

  729. </ul>
    730. 

  730. 

  731. 

  732. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-snoopChannel"></span></p>
    733. 

  733. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/snoop">POST /channels/{channelId}/snoop</h2>
    734. 

  734. 

  735. <p>Start snooping. Snoop (spy/whisper) on a specific channel.</p>
    736. 

  736. 

  737. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.21">Path parameters</h3>
    738. 

  738. <ul>
    739. 

  739. 	<li>channelId: string - Channel's id</li>
    740. 

  740. </ul>
    741. 

  741. 

  742. 

  743. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.13">Query parameters</h3>
    744. 

  744. <ul>
    745. 

  745. 	<li>spy: string = none - Direction of audio to spy on</li>
    746. 

  746. 	<li>whisper: string = none - Direction of audio to whisper into</li>
    747. 

  747. 	<li>app: string - <strong>(required)</strong> Application the snooping channel is placed into</li>
    748. 

  748. 	<li>appArgs: string - The application arguments to pass to the Stasis application</li>
    749. 

  749. 	<li>snoopId: string - Unique ID to assign to snooping channel</li>
    750. 

  750. </ul>
    751. 

  751. 

  752. 

  753. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.22">Error Responses</h3>
    754. 

  754. <ul>
    755. 

  755. 	<li>400 - Invalid parameters</li>
    756. 

  756. 	<li>404 - Channel not found</li>
    757. 

  757. </ul>
    758. 

  758. 

  759. 

  760. <p><span class="confluence-anchor-link" id="Asterisk13ChannelsRESTAPI-snoopChannelWithId"></span></p>
    761. 

  761. <h2 id="Asterisk13ChannelsRESTAPI-POST/channels/{channelId}/snoop/{snoopId}">POST /channels/{channelId}/snoop/{snoopId}</h2>
    762. 

  762. 

  763. <p>Start snooping. Snoop (spy/whisper) on a specific channel.</p>
    764. 

  764. 

  765. <h3 id="Asterisk13ChannelsRESTAPI-Pathparameters.22">Path parameters</h3>
    766. 

  766. <ul>
    767. 

  767. 	<li>channelId: string - Channel's id</li>
    768. 

  768. 	<li>snoopId: string - Unique ID to assign to snooping channel</li>
    769. 

  769. </ul>
    770. 

  770. 

  771. 

  772. <h3 id="Asterisk13ChannelsRESTAPI-Queryparameters.14">Query parameters</h3>
    773. 

  773. <ul>
    774. 

  774. 	<li>spy: string = none - Direction of audio to spy on</li>
    775. 

  775. 	<li>whisper: string = none - Direction of audio to whisper into</li>
    776. 

  776. 	<li>app: string - <strong>(required)</strong> Application the snooping channel is placed into</li>
    777. 

  777. 	<li>appArgs: string - The application arguments to pass to the Stasis application</li>
    778. 

  778. </ul>
    779. 

  779. 

  780. 

  781. <h3 id="Asterisk13ChannelsRESTAPI-ErrorResponses.23">Error Responses</h3>
    782. 

  782. <ul>
    783. 

  783. 	<li>400 - Invalid parameters</li>
    784. 

  784. 	<li>404 - Channel not found</li>
    785. 

  785. </ul>
    786. 

  786.                     </div>
    787. 

  787. 

  788.                     
    789. 

  789.                  
    790. 

  790.                 </div>             </div> 
    791. 

  791.             <div id="footer">
    792. 

  792.                 <section class="footer-body">
    793. 

  793.                     <p>Document generated by Confluence on Aug 11, 2014 13:40</p>
    794. 

  794.                 </section>
    795. 

  795.             </div>
    796. 

  796.         </div>     </body>
    797. 

  797. </html>
    798.