Asterisk-13-Application_Directory_29394537.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Application_Directory</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_Directory
  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_Directory-Directory()">Directory()</h1>
  37. <h3 id="Asterisk13Application_Directory-Synopsis">Synopsis</h3>
  38. <p>Provide directory of voicemail extensions.</p>
  39. <h3 id="Asterisk13Application_Directory-Description">Description</h3>
  40. <p>This application will present the calling channel with a directory of extensions from which they can search by name. The list of names and corresponding extensions is retrieved from the voicemail configuration file, <code>voicemail.conf</code>.</p>
  41. <p>This application will immediately exit if one of the following DTMF digits are received and the extension to jump to exists:</p>
  42. <p>0 - Jump to the 'o' extension, if it exists.</p>
  43. <ul>
  44. <li>- Jump to the 'a' extension, if it exists.</li>
  45. </ul>
  46. <p>This application will set the following channel variable before completion:</p>
  47. <ul>
  48. <li><code>DIRECTORY_RESULT</code> - Reason Directory application exited.
  49. <ul>
  50. <li>OPERATOR - User requested operator</li>
  51. <li>ASSISTANT - User requested assistant</li>
  52. <li>TIMEOUT - User allowed DTMF wait duration to pass without sending DTMF</li>
  53. <li>HANGUP - The channel hung up before the application finished</li>
  54. <li>SELECTED - User selected a user to call from the directory</li>
  55. <li>USEREXIT - User exited with '#' during selection</li>
  56. <li>FAILED - The application failed</li>
  57. </ul>
  58. </li>
  59. </ul>
  60. <h3 id="Asterisk13Application_Directory-Syntax">Syntax</h3>
  61. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  62. <pre>Directory([vm-context,[dial-context,[options]]])</pre>
  63. </div></div>
  64. <h5 id="Asterisk13Application_Directory-Arguments">Arguments</h5>
  65. <ul>
  66. <li><code>vm-context</code> - This is the context within voicemail.conf to use for the Directory. If not specified and <code>searchcontexts=no</code> in <code>voicemail.conf</code>, then <code>default</code> will be assumed.</li>
  67. <li><code>dial-context</code> - This is the dialplan context to use when looking for an extension that the user has selected, or when jumping to the <code>o</code> or <code>a</code> extension. If not specified, the current context will be used.</li>
  68. <li><code>options</code>
  69. <ul>
  70. <li><code>e</code> - In addition to the name, also read the extension number to the caller before presenting dialing options.</li>
  71. <li><code>f</code> - Allow the caller to enter the first name of a user in the directory instead of using the last name. If specified, the optional number argument will be used for the number of characters the user should enter.
  72. <ul>
  73. <li><code>n</code></li>
  74. </ul>
  75. </li>
  76. <li><code>l</code> - Allow the caller to enter the last name of a user in the directory. This is the default. If specified, the optional number argument will be used for the number of characters the user should enter.
  77. <ul>
  78. <li><code>n</code></li>
  79. </ul>
  80. </li>
  81. <li><code>b</code> - Allow the caller to enter either the first or the last name of a user in the directory. If specified, the optional number argument will be used for the number of characters the user should enter.
  82. <ul>
  83. <li><code>n</code></li>
  84. </ul>
  85. </li>
  86. <li><code>a</code> - Allow the caller to additionally enter an alias for a user in the directory. This option must be specified in addition to the <code>f</code>, <code>l</code>, or <code>b</code> option.</li>
  87. <li><code>m</code> - Instead of reading each name sequentially and asking for confirmation, create a menu of up to 8 names.</li>
  88. <li><code>n</code> - Read digits even if the channel is not answered.</li>
  89. <li><code>p</code> - Pause for n milliseconds after the digits are typed. This is helpful for people with cellphones, who are not holding the receiver to their ear while entering DTMF.
  90. <ul>
  91. <li><code>n</code>
  92. <div class="aui-message hint shadowed information-macro">
  93. <p class="title">Note</p>
  94. <span class="aui-icon icon-hint">Icon</span>
  95. <div class="message-content">
  96. <p>Only one of the <em>f</em>, <em>l</em>, or <em>b</em> options may be specified. <strong>If more than one is specified</strong>, then Directory will act as if <em>b</em> was specified. The number of characters for the user to type defaults to <code>3</code>.</p>
  97. </div>
  98. </div>
  99. </li>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. <h3 id="Asterisk13Application_Directory-SeeAlso">See Also</h3>
  106. <h3 id="Asterisk13Application_Directory-ImportVersion">Import Version</h3>
  107. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  108. </div>
  109. </div> </div>
  110. <div id="footer">
  111. <section class="footer-body">
  112. <p>Document generated by Confluence on Aug 11, 2014 13:44</p>
  113. </section>
  114. </div>
  115. </div> </body>
  116. </html>