kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-19 11:42:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

clean up descriptions for the voicemail applications

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@7075 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2005-11-11 17:14:13 +00:00
parent 36315b865b
commit 00de2bc78b
1 changed files with 72 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
apps/app_voicemail.c
View File

@@ -5,15 +5,6 @@
* *
* Mark Spencer <markster@digium.com> * Mark Spencer <markster@digium.com>
* *
* 12-16-2004 : Support for Greek added by InAccess Networks (work funded by HOL, www.hol.gr)
* George Konstantoulakis <gkon@inaccessnetworks.com>
*
* 05-10-2005 : Support for Swedish and Norwegian added by Daniel Nylander, http://www.danielnylander.se/
*
* 05-11-2005 : An option for maximum number of messsages per mailbox added by GDS Partners (www.gdspartners.com)
* 07-11-2005 : An issue with voicemail synchronization has been fixed by GDS Partners (www.gdspartners.com)
* Stojan Sljivic <stojan.sljivic@gdspartners.com>
*
* See http://www.asterisk.org for more information about * See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact * the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance; * any of the maintainers of this project for assistance;
@@ -34,6 +25,18 @@
* \ingroup applications * \ingroup applications
*/ */
/*
* 12-16-2004 : Support for Greek added by InAccess Networks (work funded by HOL, www.hol.gr)
* George Konstantoulakis <gkon@inaccessnetworks.com>
*
* 05-10-2005 : Support for Swedish and Norwegian added by Daniel Nylander, http://www.danielnylander.se/
*
* 05-11-2005 : An option for maximum number of messsages per mailbox added by GDS Partners (www.gdspartners.com)
* 07-11-2005 : An issue with voicemail synchronization has been fixed by GDS Partners (www.gdspartners.com)
* Stojan Sljivic <stojan.sljivic@gdspartners.com>
*
*/
#include <stdlib.h> #include <stdlib.h>
#include <errno.h> #include <errno.h>
#include <unistd.h> #include <unistd.h>
@@ -100,10 +103,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#define VM_ENVELOPE (1 << 4) #define VM_ENVELOPE (1 << 4)
#define VM_SAYDURATION (1 << 5) #define VM_SAYDURATION (1 << 5)
#define VM_SKIPAFTERCMD (1 << 6) #define VM_SKIPAFTERCMD (1 << 6)
#define VM_FORCENAME (1 << 7) /* Have new users record their name */ #define VM_FORCENAME (1 << 7) /*!< Have new users record their name */
#define VM_FORCEGREET (1 << 8) /* Have new users record their greetings */ #define VM_FORCEGREET (1 << 8) /*!< Have new users record their greetings */
#define VM_PBXSKIP (1 << 9) #define VM_PBXSKIP (1 << 9)
#define VM_DIRECFORWARD (1 << 10) /* directory_forward */ #define VM_DIRECFORWARD (1 << 10) /*!< directory_forward */
#define VM_ATTACH (1 << 11) #define VM_ATTACH (1 << 11)
#define VM_DELETE (1 << 12) #define VM_DELETE (1 << 12)
#define VM_ALLOCED (1 << 13) #define VM_ALLOCED (1 << 13)
@@ -111,12 +114,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#define ERROR_LOCK_PATH -100 #define ERROR_LOCK_PATH -100
enum { enum {
OPT_SILENT =(1 << 0), OPT_SILENT = (1 << 0),
OPT_BUSY_GREETING = (1 << 1), OPT_BUSY_GREETING = (1 << 1),
OPT_UNAVAIL_GREETING = (1 << 2), OPT_UNAVAIL_GREETING = (1 << 2),
OPT_RECORDGAIN = (1 << 3), OPT_RECORDGAIN = (1 << 3),
OPT_PREPEND_MAILBOX = (1 << 4), OPT_PREPEND_MAILBOX = (1 << 4),
OPT_PRIORITY_JUMP = (1 << 5), OPT_PRIORITY_JUMP = (1 << 5),
} vm_option_flags; } vm_option_flags;
enum { enum {
@@ -289,70 +292,74 @@ static char *tdesc = "Comedian Mail (Voicemail System)";
static char *addesc = "Comedian Mail"; static char *addesc = "Comedian Mail";
static char *synopsis_vm = static char *synopsis_vm =
"Leave a voicemail message"; "Leave a Voicemail message";
static char *descrip_vm = static char *descrip_vm =
" VoiceMail(mailbox[@context][&mailbox[@context]][...][|options]): Leaves" " VoiceMail(mailbox[@context][&mailbox[@context]][...][|options]): This\n"
"voicemail for a given mailbox (must be configured in voicemail.conf).\n" "application allows the calling party to leave a message for the specified\n"
" If the options contain: \n" "list of mailboxes. When multiple mailboxes are specified, the greeting will\n"
"* 'b' the \"busy\" greeting will be played.\n" "be taken from the first mailbox specified. Dialplan execution will stop if the\n"
"* 'g(#)' the specified amount of gain will be requested during message\n" "specified mailbox does not exist.\n"
" recording (units are whole-number decibels (dB))\n" " The Voicemail application will exit if any of the following DTMF digits are\n"
"* 's' instructions for leaving the message will be skipped.\n" "received:\n"
"* 'u' the \"unavailable\" greeting will be played.\n" " 0 - Jump to the 'o' extension in the current dialplan context.\n"
"* 'j' jump to n+101 priority when mailbox not found or on error\n" " * - Jump to the 'a' extension in the current dialplan context.\n"
"If the caller presses '0' (zero) during the prompt, the call jumps to\n" " This application will set the following channel variable upon completion:\n"
"extension 'o' in the current context.\n" " VMSTATUS - This indicates the status of the execution of the VoiceMail\n"
"If the caller presses '*' during the prompt, the call jumps to\n" " application. The possible values are:\n"
"extension 'a' in the current context.\n" " SUCCESS | USEREXIT | FAILED\n\n"
"When multiple mailboxes are specified, the unavailable or busy message\n" " Options:\n"
"will be taken from the first mailbox specified.\n" " b - Play the 'busy' greeting to the calling party.\n"
"This application sets the following channel variable upon completion:\n" " g(#) - Use the specified amount of gain when recording the voicemail\n"
"VMSTATUS The status of the VoiceMail call, a text string that is either:\n" " message. The units are whole-number decibels (dB).\n"
"SUCCESS | USEREXIT | FAILED \n" " s - Skip the playback of instructions for leaving a message to the\n"
"Execution will fail if the mailbox does not exist, or if the user disconnects.\n"; " calling party.\n"
" u - Play the 'unavailble greeting.\n"
" j - Jump to priority n+101 if the mailbox is not found or some other\n"
" error occurs.\n";
static char *synopsis_vmain = static char *synopsis_vmain =
"Enter voicemail system"; "Check Voicemail messages";
static char *descrip_vmain = static char *descrip_vmain =
" VoiceMailMain([mailbox][@context][|options]): Enters the main voicemail system\n" " VoiceMailMain([mailbox][@context][|options]): This application allows the\n"
"for the checking of voicemail. The mailbox can be passed in,\n" "calling party to check voicemail messages. A specific mailbox, and optional\n"
"which will stop the voicemail system from prompting the user for the mailbox.\n" "corresponding context, may be specified. If a mailbox is not provided, the\n"
"If the options contain: \n" "calling party will be prompted to enter one. If a context is not specified,\n"
"* 'p' the supplied mailbox is prepended to the user's entry and\n" "the 'default' context will be used.\n\n"
" the resulting string is used as the mailbox number. This can\n" " Options:\n"
" be useful for virtual hosting of voicemail boxes.\n" " p - Consider the mailbox parameter as a prefix to the mailbox that\n"
"* 'g(#)' the specified amount of gain will be requested during message\n" " is entered by the caller.\n"
" recording (units are whole-number decibels (dB))\n" " g(#) - Use the specified amount of gain when recording a voicemail\n"
"* 's' the password check will be skipped.\n" " message. The units are whole-number decibels (dB).\n"
"If a context is specified, mailboxes are considered in that voicemail context only.\n" " s - Skip checking the passcode for the mailbox.\n";
"Returns -1 if the user hangs up or 0 otherwise.\n";
static char *synopsis_vm_box_exists = static char *synopsis_vm_box_exists =
"Check if vmbox exists"; "Check to see if Voicemail mailbox exists";
static char *descrip_vm_box_exists = static char *descrip_vm_box_exists =
" MailboxExists(mailbox[@context][|options]): Check to see if the mailbox \n" " MailboxExists(mailbox[@context][|options]): Check to see if the specified\n"
" exists\n" "mailbox exists. If no voicemail context is specified, the 'default' context\n"
"If the options contain: \n" "will be used.\n"
"* 'j' jump to n+101 priority when the mailbox is found.\n" " This application will set the following channel variable upon completion:\n"
"This application sets the following channel variable upon completion:\n" " VMBOXEXISTSSTATUS - This will contain the status of the execution of the\n"
" VMBOXEXISTSSTATUS The status of the mailbox exists call, a text\n" " MailboxExists application. Possible values include:\n"
" string that is either:\n" " SUCCESS | FAILED\n\n"
" SUCCESS | FAILED\n"; " Options:\n"
" j - Jump to priority n+101 if the mailbox is found.\n";
static char *synopsis_vmauthenticate = static char *synopsis_vmauthenticate =
"Authenticate off voicemail passwords"; "Authenticate with Voicemail passwords";
static char *descrip_vmauthenticate = static char *descrip_vmauthenticate =
" VMAuthenticate([mailbox][@context][|options]): Behaves identically to\n" " VMAuthenticate([mailbox][@context][|options]): This application behaves the\n"
"the Authenticate application, with the exception that the passwords are\n" "same way as the Authenticate application, but the passwords are taken from\n"
"taken from voicemail.conf.\n" "voicemail.conf.\n"
" If the mailbox is specified, only that mailbox's password will be considered\n" " If the mailbox is specified, only that mailbox's password will be considered\n"
"valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will\n" "valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will\n"
"be set with the authenticated mailbox.\n" "be set with the authenticated mailbox.\n\n"
"If the options contain 's' then no initial prompts will be played.\n"; " Options:\n"
" s - Skip playing the initial prompts.\n";
/* Leave a message */ /* Leave a message */
static char *app = "VoiceMail"; static char *app = "VoiceMail";