Asterisk-13-Application_MessageSend_29394786.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Application_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-Dialplan-Applications_29394285.html">Asterisk 13 Dialplan Applications</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 Application_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="Asterisk13Application_MessageSend-MessageSend()">MessageSend()</h1>
  37. <h3 id="Asterisk13Application_MessageSend-Synopsis">Synopsis</h3>
  38. <p>Send a text message.</p>
  39. <h3 id="Asterisk13Application_MessageSend-Description">Description</h3>
  40. <p>Send a text message. The body of the message that will be sent is what is currently set to <code>MESSAGE(body)</code>. The technology chosen for sending the message is determined based on a prefix to the <code>to</code> parameter.</p>
  41. <p>This application sets the following channel variables:</p>
  42. <ul>
  43. <li><code>MESSAGE_SEND_STATUS</code> - This is the message delivery status returned by this application.
  44. <ul>
  45. <li>INVALID_PROTOCOL - No handler for the technology part of the URI was found.</li>
  46. <li>INVALID_URI - The protocol handler reported that the URI was not valid.</li>
  47. <li>SUCCESS - Successfully passed on to the protocol handler, but delivery has not necessarily been guaranteed.</li>
  48. <li>FAILURE - The protocol handler reported that it was unabled to deliver the message for some reason.</li>
  49. </ul>
  50. </li>
  51. </ul>
  52. <h3 id="Asterisk13Application_MessageSend-Syntax">Syntax</h3>
  53. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  54. <pre>MessageSend(to,[from])</pre>
  55. </div></div>
  56. <h5 id="Asterisk13Application_MessageSend-Arguments">Arguments</h5>
  57. <ul>
  58. <li><code>to</code> - A To URI for the message.
  59. <ul>
  60. <li><strong>Technology: PJSIP</strong><br />
  61. Specifying a prefix of <code>pjsip:</code> will send the message as a SIP MESSAGE request.</li>
  62. <li><strong>Technology: SIP</strong><br />
  63. Specifying a prefix of <code>sip:</code> will send the message as a SIP MESSAGE request.</li>
  64. <li><strong>Technology: XMPP</strong><br />
  65. Specifying a prefix of <code>xmpp:</code> will send the message as an XMPP chat message.</li>
  66. </ul>
  67. </li>
  68. <li><code>from</code> - A From URI for the message if needed for the message technology being used to send this message.
  69. <ul>
  70. <li><strong>Technology: PJSIP</strong><br />
  71. The <code>from</code> parameter can be a configured endpoint or in the form of &quot;display-name&quot; &lt;URI&gt;.</li>
  72. <li><strong>Technology: SIP</strong><br />
  73. The <code>from</code> parameter can be a configured peer name or in the form of &quot;display-name&quot; &lt;URI&gt;.</li>
  74. <li><strong>Technology: XMPP</strong><br />
  75. 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>
  76. </ul>
  77. </li>
  78. </ul>
  79. <h3 id="Asterisk13Application_MessageSend-SeeAlso">See Also</h3>
  80. <h3 id="Asterisk13Application_MessageSend-ImportVersion">Import Version</h3>
  81. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  82. </div>
  83. </div> </div>
  84. <div id="footer">
  85. <section class="footer-body">
  86. <p>Document generated by Confluence on Aug 11, 2014 13:45</p>
  87. </section>
  88. </div>
  89. </div> </body>
  90. </html>