Asterisk-13-Asterisk-REST-API_29394324.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Asterisk REST API</title>
  5. <link rel="stylesheet" href="styles/site.css" type="text/css" />
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </head>
  8. <body class="theme-default aui-theme-default">
  9. <div id="page">
  10. <div id="main" class="aui-page-panel">
  11. <div id="main-header">
  12. <div id="breadcrumb-section">
  13. <ol id="breadcrumbs">
  14. <li class="first">
  15. <span><a href="index.html">Asterisk Project</a></span>
  16. </li>
  17. <li>
  18. <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
  19. </li>
  20. <li>
  21. <span><a href="Asterisk-13-ARI_29394283.html">Asterisk 13 ARI</a></span>
  22. </li>
  23. </ol>
  24. </div>
  25. <h1 id="title-heading" class="pagetitle">
  26. <span id="title-text">
  27. Asterisk Project : Asterisk 13 Asterisk REST API
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created by <span class='author'> wikibot</span> on Aug 08, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13AsteriskRESTAPI-Asterisk">Asterisk</h1>
  37. <div class="table-wrap"><table class="confluenceTable"><tbody>
  38. <tr>
  39. <th class="confluenceTh"><p> Method </p></th>
  40. <th class="confluenceTh"><p> Path </p></th>
  41. <th class="confluenceTh"><p> Return Model </p></th>
  42. <th class="confluenceTh"><p> Summary </p></th>
  43. </tr>
  44. <tr>
  45. <td class="confluenceTd"><p> GET </p></td>
  46. <td class="confluenceTd"><p> <a href="Asterisk-13-Asterisk-REST-API_29394324.html">/asterisk/info</a> </p></td>
  47. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-AsteriskInfo">AsteriskInfo</a> </p></td>
  48. <td class="confluenceTd"><p> Gets Asterisk system information. </p></td>
  49. </tr>
  50. <tr>
  51. <td class="confluenceTd"><p> GET </p></td>
  52. <td class="confluenceTd"><p> <a href="Asterisk-13-Asterisk-REST-API_29394324.html">/asterisk/variable</a> </p></td>
  53. <td class="confluenceTd"><p> <a href="Asterisk-13-REST-Data-Models_29394316.html#Asterisk13RESTDataModels-Variable">Variable</a> </p></td>
  54. <td class="confluenceTd"><p> Get the value of a global variable. </p></td>
  55. </tr>
  56. <tr>
  57. <td class="confluenceTd"><p> POST </p></td>
  58. <td class="confluenceTd"><p> <a href="Asterisk-13-Asterisk-REST-API_29394324.html">/asterisk/variable</a> </p></td>
  59. <td class="confluenceTd"><p> void </p></td>
  60. <td class="confluenceTd"><p> Set the value of a global variable. </p></td>
  61. </tr>
  62. </tbody></table></div>
  63. <p><span class="confluence-anchor-link" id="Asterisk13AsteriskRESTAPI-getInfo"></span></p>
  64. <h2 id="Asterisk13AsteriskRESTAPI-GET/asterisk/info">GET /asterisk/info</h2>
  65. <p>Gets Asterisk system information.</p>
  66. <h3 id="Asterisk13AsteriskRESTAPI-Queryparameters">Query parameters</h3>
  67. <ul>
  68. <li>only: string - Filter information returned
  69. <ul>
  70. <li>Allows comma separated values.</li>
  71. </ul>
  72. </li>
  73. </ul>
  74. <p><span class="confluence-anchor-link" id="Asterisk13AsteriskRESTAPI-getGlobalVar"></span></p>
  75. <h2 id="Asterisk13AsteriskRESTAPI-GET/asterisk/variable">GET /asterisk/variable</h2>
  76. <p>Get the value of a global variable.</p>
  77. <h3 id="Asterisk13AsteriskRESTAPI-Queryparameters.1">Query parameters</h3>
  78. <ul>
  79. <li>variable: string - <strong>(required)</strong> The variable to get</li>
  80. </ul>
  81. <h3 id="Asterisk13AsteriskRESTAPI-ErrorResponses">Error Responses</h3>
  82. <ul>
  83. <li>400 - Missing variable parameter.</li>
  84. </ul>
  85. <p><span class="confluence-anchor-link" id="Asterisk13AsteriskRESTAPI-setGlobalVar"></span></p>
  86. <h2 id="Asterisk13AsteriskRESTAPI-POST/asterisk/variable">POST /asterisk/variable</h2>
  87. <p>Set the value of a global variable.</p>
  88. <h3 id="Asterisk13AsteriskRESTAPI-Queryparameters.2">Query parameters</h3>
  89. <ul>
  90. <li>variable: string - <strong>(required)</strong> The variable to set</li>
  91. <li>value: string - The value to set the variable to</li>
  92. </ul>
  93. <h3 id="Asterisk13AsteriskRESTAPI-ErrorResponses.1">Error Responses</h3>
  94. <ul>
  95. <li>400 - Missing variable parameter.</li>
  96. </ul>
  97. </div>
  98. </div> </div>
  99. <div id="footer">
  100. <section class="footer-body">
  101. <p>Document generated by Confluence on Aug 11, 2014 13:40</p>
  102. </section>
  103. </div>
  104. </div> </body>
  105. </html>