Asterisk-13-Application_BackGround_29394699.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Application_BackGround</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_BackGround
  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_BackGround-BackGround()">BackGround()</h1>
  37. <h3 id="Asterisk13Application_BackGround-Synopsis">Synopsis</h3>
  38. <p>Play an audio file while waiting for digits of an extension to go to.</p>
  39. <h3 id="Asterisk13Application_BackGround-Description">Description</h3>
  40. <p>This application will play the given list of files <strong>(do not put extension)</strong> while waiting for an extension to be dialed by the calling channel. To continue waiting for digits after this application has finished playing files, the <code>WaitExten</code> application should be used.</p>
  41. <p>If one of the requested sound files does not exist, call processing will be terminated.</p>
  42. <p>This application sets the following channel variable upon completion:</p>
  43. <ul>
  44. <li><code>BACKGROUNDSTATUS</code> - The status of the background attempt as a text string.
  45. <ul>
  46. <li>SUCCESS</li>
  47. <li>FAILED</li>
  48. </ul>
  49. </li>
  50. </ul>
  51. <h3 id="Asterisk13Application_BackGround-Syntax">Syntax</h3>
  52. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  53. <pre>BackGround(filename1&amp;[filename2[&amp;...]],[options,[langoverride,[context]]])</pre>
  54. </div></div>
  55. <h5 id="Asterisk13Application_BackGround-Arguments">Arguments</h5>
  56. <ul>
  57. <li><code>filenames</code>
  58. <ul>
  59. <li><code>filename1</code></li>
  60. <li><code>filename2</code></li>
  61. </ul>
  62. </li>
  63. <li><code>options</code>
  64. <ul>
  65. <li><code>s</code> - Causes the playback of the message to be skipped if the channel is not in the <code>up</code> state (i.e. it hasn't been answered yet). If this happens, the application will return immediately.</li>
  66. <li><code>n</code> - Don't answer the channel before playing the files.</li>
  67. <li><code>m</code> - Only break if a digit hit matches a one digit extension in the destination context.</li>
  68. </ul>
  69. </li>
  70. <li><code>langoverride</code> - Explicitly specifies which language to attempt to use for the requested sound files.</li>
  71. <li><code>context</code> - This is the dialplan context that this application will use when exiting to a dialed extension.</li>
  72. </ul>
  73. <h3 id="Asterisk13Application_BackGround-SeeAlso">See Also</h3>
  74. <ul>
  75. <li><a href="Asterisk-13-Application_ControlPlayback_29394520.html">Asterisk 13 Application_ControlPlayback</a></li>
  76. <li><a href="Asterisk-13-Application_WaitExten_29394723.html">Asterisk 13 Application_WaitExten</a></li>
  77. <li><a href="Asterisk-13-Application_BackgroundDetect_29394399.html">Asterisk 13 Application_BackgroundDetect</a></li>
  78. <li><a href="Asterisk-13-Function_TIMEOUT_29394667.html">Asterisk 13 Function_TIMEOUT</a></li>
  79. </ul>
  80. <h3 id="Asterisk13Application_BackGround-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:44</p>
  87. </section>
  88. </div>
  89. </div> </body>
  90. </html>