====== Voicemail ======
The Internet Gate can record voice messages left by callers to an attached [[misc:usb|USB memory stick]], and [[web_gui:e-mail_page|e-mail]] it to the recepients' e-mail accounts.

^ :!: NOTE! ^
| To be able to send the e-mail message the unit needs access to an SMTP server. \\ Configure SMTP settings on the [[web_gui:e-mail_page|e-mail configuration page]]. \\ To be able to record voicemail messages a [[misc:usb|USB memory]] must be attached to the unit. \\ **Without USB memory and SMTP server voicemail cannot function!** |

Read more about the voice mail unit [[sip:voicemail|here]].

===== Create internal voice mail unit =====
Before you can start using voicemail you need to create the Internet Gate internal voicemail handler component, and initialize it.

Clicking the **Create** button creates the necessary /voicemail directory on the attached USB memory stick, and initializes the voicemail handler. You must reboot your Internet Gate before you can start using voicemail.

===== Voicemail default announcements =====
If a call is forwarded to the voicemail unit (recepient did not answer call) the **recording announcement** ("please leave a message after the tone") is played.

You can either use a wav file stored on the USB memory stick, a URL pointing to a wav file on the Internet, or record your own message:
  * The default URL points to a default message on our web server: [[http://ivr.igmanual.com/upfiles/rec_standard.wav|Listen to it.]]
  * By entering a SIP address into the **Client to call** field you can record your own message by pressing the **Record** button. The specified SIP client will then be called and recording starts as soon as you answer the phone. Talk your message then hang up. You can retry as many times as you like.
  * You can also put wav file containing the message directly on the USB memory stick. Name the file FIXME and make sure it is 8kHz mono sampled using u-law.

The **referral announcement** is used when the voicemail answers the call but does not record anything ("the person you called is not available for now"). This announcement is also used if the person's voicemailbox is full.

===== Audio prompts when listening to your voice messages =====
Users can [[sip:listen_to_voicemail|call]] the voice mail unit to access their voicemail inbox and listen to received messages. There are a number of recorded audio prompts that help them through the process (like "To listen to your oldest message press 3, to listen to your newest
 message press 1"). Those audio prompts can be changed using these fields.

===== Voicemail template =====
After a message has been recorded to the USB memory stick it can be sent using e-mail to the recepient. The voicemail template fields configure how that sent e-mail should look like. If the fields are left empty a default e-mail message is generated.

**From**: the e-mail address the voicemail e-mail message is sent from. If non-empty, this field overrides the **From** field on the [[web_gui:e-mail page]].\\
:!: Some SMTP servers allow only e-mails sent from existing accounts. In such case make sure the address entered is an address for a real existing account.

**Subject**: the subject of the e-mail message sent

**Message**: the message body (text) of the e-mail message sent.

==== Tags ====
To create dynamic voicemail e-mail messages, **all** the above fields can use tags to personalize the sent messages:
^ tag ^ meaning ^ example output ^
| $(date) | current date in year-month-date format | 11-09-23 |
| $(date=x) | current date, argument x is in [[http://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#Formatting-Calendar-Time|StrFTime format]] | $(date=%A) => Tuesday |
| $(time) | current time in 24h hour:minute format | 18:23 |
| $(time=x) | current time, argument x is in [[http://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#Formatting-Calendar-Time|StrFTime format]]. | $(time=%p) => PM |
| $(from) | full SIP address call was made from | adam@company.com |
| $(from.user) | first half of SIP address call was made from | adam |
| $(from.domain) | second half of SIP address call was made from | company.com |
| $(to) | full e-mail address mail is sent to | eva@company.com |
| $(to.user) | first half of e-mail address mail is sent to | eva |
| $(to.domain) | second half of e-mail address mail is sent to | company.com |
| $(path) | path to voicemail file | /ld00/voicemail/eva@company.com/call03181215.wav |
| $(path.dir) | directory voicemail file was saved in (same as SIP adress call was made to) | eva@company.com |
| $(path.file) | filename of recorded voicemail file \\ (Filename is "call" + date + time ".wav") | call03181215.wav |
| $(length) | length of recorded message, in seconds | 13 |
Each occurrence of a tag is replaced with the value the tag resolves to.

==== Example ====
**From:** voicemail@company.com \\
**Subject:** $(from.user) has left you a $(length)s message \\
**Message:** Hi!\\
$(from) has left you a $(length)s long message at $(date) $(time).\\
Listen to the attached file to hear it.

===== Voice mail storage =====
The recorded messages are stored in the USB memory stick folder /voicemail

Each call recepient has its own subfolder with her SIP address as foldername.

Each recorded message is stored in a separate wav file. The files are called "call" followed by date and time, eg "call03171415.wav"

Thus if john did not answer a call at 14:15 March 17:th the full path on the memory stick would be:\\
/voicemail/john@company.com/call03171415.wav

You can adjust the maximum number of received messages stored for each user. By default it is 20.\\ 
Once a user's inbox becomes full no further messages will be recorded. The voice mail starts using the **referral announcement** instead of the **recording announcement** and callers can no longer leave messages.

===== Advanced =====
The **Voice Mail Advanced** link at the bottom of the page opens some additional advanced settings for the voice mail:

The account settings specify the SIP address of the voice mail client. Users [[sip:listen_to_voicemail|listening to recorded messages using their phones]] shall call this SIP address, or the extension specified for it on the [[web_gui:SIP Switch Overview page]].

The ringing duration sets how many seconds the **voice mail client** will wait before answering. This timeout is added on top of the timeout already spent on waiting for the user to pick up the phone.

===== Read more =====
Read more about the voice mail unit [[sip:voicemail|here]].

Read more about using phone to listen to recorded messages [[sip:listen_to_voicemail|here]].