Voicemail

From Taridium

Revision as of 13:51, 12 January 2009 (view source) Webmaster (Talk | contribs) ← Older edit		Revision as of 14:24, 12 January 2009 (view source) Webmaster (Talk | contribs) (→General Settings) Newer edit →
Line 129:		Line 129:
	===E-Mail Audio File===		===E-Mail Audio File===
		+
		+	Attach causes ipbx to copy a voicemail message to an audio file and send it to the user as an attachment in an e-mail voicemail notification message. The default is not to do this. Attach takes two values yes or no.
		+
	===Delete after E-Mail Delivery===		===Delete after E-Mail Delivery===
		+
		+	If set to "yes" the message will be deleted from the voicemailbox (after having been emailed).
		+	The delete flag, when used alone (instead of with voicemail broadcast), provides functionality that allows a user to receive their voicemail via email alone.
		+
		+	* Note This settting does not always work as a global setting. It is recommended to put this as an option for each voice mailbox that's messages are to be deleted after being emailed.
		+
	===Mail Command===		===Mail Command===
		+
		+	This allows the administrator to override the default mailer command with a defined command. Mailcmd takes a string value set to the desired command line to execute when a user needs to be notified of a voice mail message. The default command line is: '/usr/sbin/sendmail -t'.
		+
	===Server E-Mail Address===		===Server E-Mail Address===
		+
		+	This setting can be used to identify the source of a voicemail notification message. The value is a string which can be encoded one of two ways. If the string is of the form someone@host.com, then the string will be used as the source address for all voicemail notification emails. If the string is of the form someone, then the host name of the ipbx system will be postpended to the string after insertion of a '@'.
		+
	===Envelope===		===Envelope===
		+
		+	Envelope controls whether or not ipbx will play the message envelope (date/time) before playing the voicemail message. This settng does not affect the operation of the envelope option in the advanced voicemail menu. Envelope takes two values yes or no. The default value is yes.
		+
	===Format===		===Format===
		+
		+	The format setting selects audio file format(s) to use when storing voice mail messages. The value is a string defining the audio format(s) of the message file. The default format string is wav49|gsm|wav, meaning that ipbx will save the voicemail message in all three supported formats. When emailing the attachment, however, it will send only the first of the formats defined here. When playing back (as with all file playback) ipbx will attempt to use the optimum format based on the codec used for the current channel, in order to provide the best sound quality and to reduce transcoding processing time.
		+
		+	* wav49: In this format, the file size will be small, the quality good, and it's a good choice for sending voicemail messages in email. The file will have a .WAV extension, which all Windows users should have no problems with, and users on other platforms should also be able to easily play these sound files.
		+	* gsm: Voicemail saved in this format will have about the same file size and same audio quality as wav49. It may be less well supported by client operating systems if sent to users in email, however.
		+	* wav: This is an uncompressed sound format with a .wav extension, so the file size is very large. Sound quality will be great, but you probably don't want to email it, and you must have adequate disk space.
		+
	===External Notify Cmd===		===External Notify Cmd===
		+
		+	Runs an external notification command after a message has been left or picked up. Leave default for standard ipbx features.
		+
	===External Password Cmd===		===External Password Cmd===
		+
		+	External Password Command takes a string value which is the command line you want to execute when the users finishes change it's password.
		+
	===Max Silence (s)===		===Max Silence (s)===
		+
		+	Maxsilence defines how long ipbx will wait for a contiguous period of silence before terminating an incoming call to voice mail. The default value is 0, which means the silence detector is disabled and the wait time is infinite. Maxsilence takes a value of zero or a positive integer value which is the number of seconds of silence to wait before disconnecting.
		+
	===Silence Threshold===		===Silence Threshold===
-	===Max Message Length (s)===	+
-	===Min Message Length (s)===	+	When using the maxsilence setting, it is sometimes necessary to adjust the silence detection threshold to eliminate false triggering on background noise.
		+
		+	Silencethreshold allows the adminstrator to do just that. The default silencethreshold value is 128. Higher numbers raise the threshold so that more background noise is needed to cause the silence detector to reset. When employing this setting, some experimentation will be necessary to find the best result.
		+
		+	===Max Message Length (s)===
		+
		+	This defines the maximum amount of time in seconds of an incoming message. Use this when there are many users and disk space is limited. The default value for this setting is 180s.
		+
		+	===Min Message Length (s)===
		+
		+	This setting can be used to eliminate messages which are shorter than a given amount of time in seconds. The default value for this setting is 3s.
		+
	===Max No. Messages===		===Max No. Messages===
		+
		+	This limits the number of messages in a voicemail folder. The maximum value is 9999 (hard coded) and the default is 100. When a mailbox has more than this number of messages in it, new messages can not be recorded and vm-mailboxfull is played to the caller. No more messages possible is also logged.
		+
	===Max Greeting Length (s)===		===Max Greeting Length (s)===
-	===Max Login Attempts===	+
		+	This setting allows the adminstrator to limit the length of the user-recordable voicemail greeting. Use this option on systems with a large number of users and limited disk space. The value is an integer defining the maximum length in seconds of a greeting message. The default value is 60s. This setting will control the lengths of the unavailable greeting, busy greeting, and user name messages.
		+
		+
		+	===Max Login Attempts===
		+
		+	This setting defines the number of retries a user has to enter voicemail passwords before ipbx will disconnect the user. The value should be a positive integer. The default value for this setting is 3.
		+
	===Skip (ms)===		===Skip (ms)===
-	===CID Internal Contexts===	+
		+	This setting defines an interval in milliseconds to use when skipping forward or reverse while a voicemail message is being played. The value entered here should be a positive integer. The default value for this setting is 3000 (3 seconds).
		+
		+	===CID Internal Contexts===
		+
		+	This setting defines the internal contexts used to determine the type of voice announcement to play when reading back the caller ID in a message envelope, or when the '''Say CID''' advanced feature is enabled. In case of an internal call the voice prompt reads "Call from extension ..." instead of "Call from 12345678". The value is a string listing the internal contexts. Each additional internal context should be separated from the previous one with a comma. The default value is an empty string, and no internal contexts defined.
		+
	===Review===		===Review===
-	===Operator===	+
		+	Sometimes it is nice to let a caller review their message before committing it to a mailbox. This setting takes a yes or no value. If set to yes, then the caller will be asked to review the message, or save it as is after they have pressed '#'. If set to no, the message will be saved and the voice maill system will disconnect the caller. The default value for review is no.
		+
		+	===Operator===
		+
		+	This setting enables the user to reach an operator during the time the voicemail message is being recorded, or once a voicemail message has been left, if the review option has been set to yes. This setting takes a yes or no value. The operator must be specified at extension 'o' in extensions.conf. This setting is only available in versions of ipbx with advanced voicemail feature support.
		+
	===Say CID===		===Say CID===
		+
		+	Read back caller's telephone number prior to playing the incoming message, and just after announcing the date and time the message was left. This setting takes a yes or no value. If the administrator wants the caller's phone number to be heard prior to playing back a voicemail message, this option should be set to yes. The default value for saycid is no.
		+
	===Dial Out Context===		===Dial Out Context===
		+
		+	Specify a context to be used from the "place an outgoing call" feature in the advanced voicemail features menu. This setting takes a string value set to the outgoing context to be used. The default value for this setting is an empty string.
		+
	===Callback Context===		===Callback Context===
-	===Next After Cmd===	+
		+	Specify a context to be used from the "return phone call" feature in the advanced voicemail features menu. This setting takes a string value set to the outgoing context to be used. The default value for this setting is an empty string.
		+
		+	===Next After Cmd===
		+
		+	If set to "yes," after deleting a voicemail message, the system will automatically play the next message.
		+
	===Exit Context===		===Exit Context===
-	PBX Skip	+
-	From String	+	Optional context to drop the user into after he/she has pressed * or 0 to exit voicemail. If not set, pressing * or 0 will return the caller to the last context they were in before being sent to voicemail (assuming that context has a 'a' or 'o' extension).
-	E-mail Subject	+
-	E-mail Body	+	===PBX Skip ===
		+
		+	This setting changes the Subject: line in a voicemail notification message. This setting takes a yes or no value. The default value is no. When set to yes the Subject: line will read "Subject: New message M in mailbox B". When set to no the Subject: line will read "Subject: [PBX]: New message M in mailbox B".
		+
		+	===From String===
		+
		+	This setting allows the adminstrator to override a portion of the From: line in the voicemail notification message.
		+
		+	===E-mail Subject===
		+
		+	This setting completely overrides Subject: line in the voicemail notification message, and substitutes its own text in place of it. The value passed is a string containing the text to send in place of the Subject: line. A list of macro-like expansion tokens are listed below. NOTE: \t and \n do not expand as you might expect in this field.
		+
		+	===E-mail Body===
		+
		+	This setting overrides the normal message text seen in the body of a voicemail notification message. It also supports variable substitution which can be used to make the message more meaningful. The format would look like this: emailbody=\n\tHi ${VM_NAME},\n\n\tYou have a ${VM_DUR} long new voicemail message (number ${VM_MSGNUM}) in mailbox ${VM_MAILBOX}\nfrom ${VM_CIDNAME} (${VM_CIDNUM}), on ${VM_DATE}\nso you might want to check it when you get a chance.\n\n
		+	Notice thats a single line without quotes... Use \n \t to do formatting. A list of macro-like expansion tokens are listed below.
	== Advanced Settings ==		== Advanced Settings ==

---

Revision as of 14:24, 12 January 2009

To configure your voicemail system and add stand-alone mailboxes go to System → Voicemail.

Mailboxes will list all mailboxes setup on the system. Use the search box to search for mailboxes by mailbox name/extension or full user name. Any users that have been created with the User interaction will also be listed here with their corresponding mailbox.

Contents 1 Adding a Mailbox 1.1 Mailbox 1.2 Full Name 1.3 PIN 1.4 E-Mail Address 1.5 Notification Options 1.6 Context 1.7 Say Caller ID 1.8 Hide from Directory 1.9 Pager 1.10 Time Zone 1.11 Unified Access Number (optional module) 1.12 Reset PIN 1.13 random 4 digit PIN 2 Accessing Voicemail 3 DTMF Voicemail Menu 3.1 Voicemail Retrieval and Setup Menu 3.2 After recording a message 4 General Settings 4.1 E-Mail Audio File 4.2 Delete after E-Mail Delivery 4.3 Mail Command 4.4 Server E-Mail Address 4.5 Envelope 4.6 Format 4.7 External Notify Cmd 4.8 External Password Cmd 4.9 Max Silence (s) 4.10 Silence Threshold 4.11 Max Message Length (s) 4.12 Min Message Length (s) 4.13 Max No. Messages 4.14 Max Greeting Length (s) 4.15 Max Login Attempts 4.16 Skip (ms) 4.17 CID Internal Contexts 4.18 Review 4.19 Operator 4.20 Say CID 4.21 Dial Out Context 4.22 Callback Context 4.23 Next After Cmd 4.24 Exit Context 4.25 PBX Skip 4.26 From String 4.27 E-mail Subject 4.28 E-mail Body 5 Advanced Settings

Adding a Mailbox

To add a mailbox click on the add mailbox button. Enter at the least the mailbox number. The full name will also be used for any dial by name directory used in the dialplan. If you specify a voicemail PIN this will also be the PIN used to access the ipbx end-user and mobile interfaces.

Mailbox

The mailbox identifier (required). This number/name needs to be unique if to be used with the end-user panel.

Full Name

Complete name of the mailbox user.

PIN

The PIN (personal identification number) for the mailbox. If you specify a voicemail PIN this will also be the PIN used to access the ipbx end-user and mobile interfaces.

For security reasons the voicemail PIN needs to be at least 3 digits long. It is thus recommended to use 3 digit extensions if you plan to set the PIN to the same number as the extension/mailbox for initial use.

E-Mail Address

Valid E-Mail address for voicemail notifications and attachments.

Notification Options

• E-Mail Notification with Attachment

Send e-mail with attached audio file

• E-Mail Notification without Attachment

Send e-mail without audio file

• Compact E-Mail Notification

Send compact notification e-mail

• Compact E-Mail Notification with Link

Send compact notification e-mail with link to audio file

• No Notification

No e-mail notification

Context

The context is a group of mailboxes. If left empty this will default to ‘default (recommended).

Say Caller ID

Whether to say the caller ID when playing back messages. Defaults to ‘no’.

Hide from Directory

Whether to hide this mailbox from the company directory / dial-by-name. Defaults to ‘no’,

Pager

Optional pager address for voicemail notifications.

Time Zone

Time Zone of mailbox. Defaults to server time.

Unified Access Number (optional module)

Dedicated DID/DDI for voicemail access. This requires unified voicemail to be installed.

Reset PIN

Reset's the PIN and sends a new PIN to the user's e-mail address.

random 4 digit PIN

Creates a random 4 digit PIN / this is optionally set to same as mailbox. See also Advanced Setup Default PIN Mode

Accessing Voicemail

Voicemail boxes can be accessed by pressing the Voicemail button or by dialing the extension *86 (default feature map setting). If you are accessing voicemail from your own extension, the system will ask you for your PIN only.

DTMF Voicemail Menu

Voicemail Menu

Access your mailbox as described above and press 0 during the announcement to access the voicemail menu. Here you will be able to configure your mailbox, change your PIN, record busy, unavailable and temporary greetings. Follow the instructions in order to record your prompts and change your settings.

Voicemail Retrieval and Setup Menu

• 1 Read voicemail messages

• 3 Advanced options

• 1 Reply
• 2 Call back
• 3 Envelope
• 4 Outgoing call
• 5 Send Message

• 4 Play previous message
• 5 Repeat current message
• 6 Play next message
• 7 Delete current message
• 8 Forward message to another mailbox

• 1 Use Voicemailnumber
• 2 Use Voicemail Directory

• 9 Save message in a folder
• * Help; during message playback: Rewind
• # Exit; during message playback: Skip forward

• 2 Change folders

• 0 Switch to new Messages
• 1Switch to old Messages

• 3 Advanced Options

• 5 Send Message

• 1 Use Voicemailnumber
• 2 Use Voicemail Directory

• 0 Mailbox options

• 1 Record your unavailable message
• 2 Record your busy message
• 3 Record your name
• 4 Record your temporary message
• 5 Change your password
• * Return to the main menu

• * Help
• # Exit

After recording a message

(incoming message, busy/unavailable greetings, or name)

• 1 - Accept
• 2 - Review
• 3 - Re-record
• 0 - Reach operator(1) (not available when recording greetings/name)

During playback you can always press * to rewind or # to fast forward the message. Leaving Voicemail

When you leave a message you can always press # to skip immediately to the recording tone.

General Settings

E-Mail Audio File

Attach causes ipbx to copy a voicemail message to an audio file and send it to the user as an attachment in an e-mail voicemail notification message. The default is not to do this. Attach takes two values yes or no.

Delete after E-Mail Delivery

If set to "yes" the message will be deleted from the voicemailbox (after having been emailed). The delete flag, when used alone (instead of with voicemail broadcast), provides functionality that allows a user to receive their voicemail via email alone.

   * Note This settting does not always work as a global setting. It is recommended to put this as an option for each voice mailbox that's messages are to be deleted after being emailed.

Mail Command

This allows the administrator to override the default mailer command with a defined command. Mailcmd takes a string value set to the desired command line to execute when a user needs to be notified of a voice mail message. The default command line is: '/usr/sbin/sendmail -t'.

Server E-Mail Address

This setting can be used to identify the source of a voicemail notification message. The value is a string which can be encoded one of two ways. If the string is of the form someone@host.com, then the string will be used as the source address for all voicemail notification emails. If the string is of the form someone, then the host name of the ipbx system will be postpended to the string after insertion of a '@'.

Envelope

Envelope controls whether or not ipbx will play the message envelope (date/time) before playing the voicemail message. This settng does not affect the operation of the envelope option in the advanced voicemail menu. Envelope takes two values yes or no. The default value is yes.

Format

The format setting selects audio file format(s) to use when storing voice mail messages. The value is a string defining the audio format(s) of the message file. The default format string is wav49|gsm|wav, meaning that ipbx will save the voicemail message in all three supported formats. When emailing the attachment, however, it will send only the first of the formats defined here. When playing back (as with all file playback) ipbx will attempt to use the optimum format based on the codec used for the current channel, in order to provide the best sound quality and to reduce transcoding processing time.

   * wav49: In this format, the file size will be small, the quality good, and it's a good choice for sending voicemail messages in email. The file will have a .WAV extension, which all Windows users should have no problems with, and users on other platforms should also be able to easily play these sound files.
   * gsm: Voicemail saved in this format will have about the same file size and same audio quality as wav49. It may be less well supported by client operating systems if sent to users in email, however.
   * wav: This is an uncompressed sound format with a .wav extension, so the file size is very large. Sound quality will be great, but you probably don't want to email it, and you must have adequate disk space.

External Notify Cmd

Runs an external notification command after a message has been left or picked up. Leave default for standard ipbx features.

External Password Cmd

External Password Command takes a string value which is the command line you want to execute when the users finishes change it's password.

Max Silence (s)

Maxsilence defines how long ipbx will wait for a contiguous period of silence before terminating an incoming call to voice mail. The default value is 0, which means the silence detector is disabled and the wait time is infinite. Maxsilence takes a value of zero or a positive integer value which is the number of seconds of silence to wait before disconnecting.

Silence Threshold

When using the maxsilence setting, it is sometimes necessary to adjust the silence detection threshold to eliminate false triggering on background noise.

Silencethreshold allows the adminstrator to do just that. The default silencethreshold value is 128. Higher numbers raise the threshold so that more background noise is needed to cause the silence detector to reset. When employing this setting, some experimentation will be necessary to find the best result.

Max Message Length (s)

This defines the maximum amount of time in seconds of an incoming message. Use this when there are many users and disk space is limited. The default value for this setting is 180s.

Min Message Length (s)

This setting can be used to eliminate messages which are shorter than a given amount of time in seconds. The default value for this setting is 3s.

Max No. Messages

This limits the number of messages in a voicemail folder. The maximum value is 9999 (hard coded) and the default is 100. When a mailbox has more than this number of messages in it, new messages can not be recorded and vm-mailboxfull is played to the caller. No more messages possible is also logged.

Max Greeting Length (s)

This setting allows the adminstrator to limit the length of the user-recordable voicemail greeting. Use this option on systems with a large number of users and limited disk space. The value is an integer defining the maximum length in seconds of a greeting message. The default value is 60s. This setting will control the lengths of the unavailable greeting, busy greeting, and user name messages.

Max Login Attempts

This setting defines the number of retries a user has to enter voicemail passwords before ipbx will disconnect the user. The value should be a positive integer. The default value for this setting is 3.

Skip (ms)

This setting defines an interval in milliseconds to use when skipping forward or reverse while a voicemail message is being played. The value entered here should be a positive integer. The default value for this setting is 3000 (3 seconds).

CID Internal Contexts

This setting defines the internal contexts used to determine the type of voice announcement to play when reading back the caller ID in a message envelope, or when the Say CID advanced feature is enabled. In case of an internal call the voice prompt reads "Call from extension ..." instead of "Call from 12345678". The value is a string listing the internal contexts. Each additional internal context should be separated from the previous one with a comma. The default value is an empty string, and no internal contexts defined.

Review

Sometimes it is nice to let a caller review their message before committing it to a mailbox. This setting takes a yes or no value. If set to yes, then the caller will be asked to review the message, or save it as is after they have pressed '#'. If set to no, the message will be saved and the voice maill system will disconnect the caller. The default value for review is no.

Operator

This setting enables the user to reach an operator during the time the voicemail message is being recorded, or once a voicemail message has been left, if the review option has been set to yes. This setting takes a yes or no value. The operator must be specified at extension 'o' in extensions.conf. This setting is only available in versions of ipbx with advanced voicemail feature support.

Say CID

Read back caller's telephone number prior to playing the incoming message, and just after announcing the date and time the message was left. This setting takes a yes or no value. If the administrator wants the caller's phone number to be heard prior to playing back a voicemail message, this option should be set to yes. The default value for saycid is no.

Dial Out Context

Specify a context to be used from the "place an outgoing call" feature in the advanced voicemail features menu. This setting takes a string value set to the outgoing context to be used. The default value for this setting is an empty string.

Callback Context

Specify a context to be used from the "return phone call" feature in the advanced voicemail features menu. This setting takes a string value set to the outgoing context to be used. The default value for this setting is an empty string.

Next After Cmd

If set to "yes," after deleting a voicemail message, the system will automatically play the next message.

Exit Context

Optional context to drop the user into after he/she has pressed * or 0 to exit voicemail. If not set, pressing * or 0 will return the caller to the last context they were in before being sent to voicemail (assuming that context has a 'a' or 'o' extension).

PBX Skip

This setting changes the Subject: line in a voicemail notification message. This setting takes a yes or no value. The default value is no. When set to yes the Subject: line will read "Subject: New message M in mailbox B". When set to no the Subject: line will read "Subject: [PBX]: New message M in mailbox B".

From String

This setting allows the adminstrator to override a portion of the From: line in the voicemail notification message.

E-mail Subject

This setting completely overrides Subject: line in the voicemail notification message, and substitutes its own text in place of it. The value passed is a string containing the text to send in place of the Subject: line. A list of macro-like expansion tokens are listed below. NOTE: \t and \n do not expand as you might expect in this field.

E-mail Body

This setting overrides the normal message text seen in the body of a voicemail notification message. It also supports variable substitution which can be used to make the message more meaningful. The format would look like this: emailbody=\n\tHi ${VM_NAME},\n\n\tYou have a ${VM_DUR} long new voicemail message (number ${VM_MSGNUM}) in mailbox ${VM_MAILBOX}\nfrom ${VM_CIDNAME} (${VM_CIDNUM}), on ${VM_DATE}\nso you might want to check it when you get a chance.\n\n Notice thats a single line without quotes... Use \n \t to do formatting. A list of macro-like expansion tokens are listed below.

Advanced Settings