Asterisk-13-ManagerAction_MessageSend_29394787.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 ManagerAction_MessageSend</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-AMI-Actions_29394279.html">Asterisk 13 AMI Actions</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 ManagerAction_MessageSend
  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="Asterisk13ManagerAction_MessageSend-MessageSend">MessageSend</h1>
  37. <h3 id="Asterisk13ManagerAction_MessageSend-Synopsis">Synopsis</h3>
  38. <p>Send an out of call message to an endpoint.</p>
  39. <h3 id="Asterisk13ManagerAction_MessageSend-Description">Description</h3>
  40. <h3 id="Asterisk13ManagerAction_MessageSend-Syntax">Syntax</h3>
  41. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  42. <pre>Action: MessageSend
  43. ActionID: &lt;value&gt;
  44. To: &lt;value&gt;
  45. From: &lt;value&gt;
  46. Body: &lt;value&gt;
  47. Base64Body: &lt;value&gt;
  48. Variable: &lt;value&gt;
  49. </pre>
  50. </div></div>
  51. <h5 id="Asterisk13ManagerAction_MessageSend-Arguments">Arguments</h5>
  52. <ul>
  53. <li><code>ActionID</code> - ActionID for this transaction. Will be returned.</li>
  54. <li><code>To</code> - The URI the message is to be sent to.
  55. <ul>
  56. <li><strong>Technology: PJSIP</strong><br />
  57. Specifying a prefix of <code>pjsip:</code> will send the message as a SIP MESSAGE request.</li>
  58. <li><strong>Technology: SIP</strong><br />
  59. Specifying a prefix of <code>sip:</code> will send the message as a SIP MESSAGE request.</li>
  60. <li><strong>Technology: XMPP</strong><br />
  61. Specifying a prefix of <code>xmpp:</code> will send the message as an XMPP chat message.</li>
  62. </ul>
  63. </li>
  64. <li><code>From</code> - A From URI for the message if needed for the message technology being used to send this message.
  65. <ul>
  66. <li><strong>Technology: PJSIP</strong><br />
  67. The <code>from</code> parameter can be a configured endpoint or in the form of &quot;display-name&quot; &lt;URI&gt;.</li>
  68. <li><strong>Technology: SIP</strong><br />
  69. The <code>from</code> parameter can be a configured peer name or in the form of &quot;display-name&quot; &lt;URI&gt;.</li>
  70. <li><strong>Technology: XMPP</strong><br />
  71. Specifying a prefix of <code>xmpp:</code> will specify the account defined in <code>xmpp.conf</code> to send the message from. Note that this field is required for XMPP messages.</li>
  72. </ul>
  73. </li>
  74. <li><code>Body</code> - The message body text. This must not contain any newlines as that conflicts with the AMI protocol.</li>
  75. <li><code>Base64Body</code> - Text bodies requiring the use of newlines have to be base64 encoded in this field. Base64Body will be decoded before being sent out. Base64Body takes precedence over Body.</li>
  76. <li><code>Variable</code> - Message variable to set, multiple Variable: headers are allowed. The header value is a comma separated list of name=value pairs.</li>
  77. </ul>
  78. <h3 id="Asterisk13ManagerAction_MessageSend-SeeAlso">See Also</h3>
  79. <h3 id="Asterisk13ManagerAction_MessageSend-ImportVersion">Import Version</h3>
  80. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  81. </div>
  82. </div> </div>
  83. <div id="footer">
  84. <section class="footer-body">
  85. <p>Document generated by Confluence on Aug 11, 2014 13:39</p>
  86. </section>
  87. </div>
  88. </div> </body>
  89. </html>