mirror of https://github.com/sipwise/sems.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
19 years ago | |
|---|---|---|
| .. | ||
| CHANGELOG | 20 years ago | |
| COMPILING | 20 years ago | |
| Configure-Sems-Ser-HOWTO | 20 years ago | |
| Makefile | 20 years ago | |
| Readme.ann_b2b | 20 years ago | |
| Readme.announce_transfer | 20 years ago | |
| Readme.announcement | 20 years ago | |
| Readme.conf_auth | 20 years ago | |
| Readme.conference | 19 years ago | |
| Readme.early_announce | 20 years ago | |
| Readme.echo | 20 years ago | |
| Readme.iLBC | 20 years ago | |
| Readme.ivr | 20 years ago | |
| Readme.mailbox | 20 years ago | |
| Readme.mp3plugin | 20 years ago | |
| Readme.pin_collect | 20 years ago | |
| Readme.py_sems | 20 years ago | |
| Readme.registrar_client | 20 years ago | |
| Readme.uac_auth | 20 years ago | |
| Readme.voicemail | 19 years ago | |
| WHATSNEW | 20 years ago | |
| doxyref.h | 19 years ago | |
Readme.voicemail
voicemail (voicemail2email) application
This application plays a greeting message to the caller, records a
voicemail and sends it out as email via SMTP.
The voicemail application looks in various paths for the greeting
message to be played, the first file found will be played:
<announce_path><domain><user>'.wav'
<announce_path><domain><language><default_announce>
<announce_path><domain><default_announce>
<announce_path><language><default_announce>
<announce_path><default_announce>
where <announce_path> and <default_announce> is set in voicemail.conf,
<domain> is the host part of the request URI, <user> the user part of
the request URI, and <language> is the App-Param 'Language' (see below).
If you have a small application record or copy the greeting to
<announce_path><domain><user>'.wav' it will be played back instead of the
default announcement.
The format of the email can be configured using email templates
(see below).
The mail server to send the email with is configured in the main
sems.conf in smtp_server/smtp_port.
further configuration items (voicemail.conf):
max_record_time - voicemail records voicemail up to the number of
seconds set here
rec_file_ext - extension of recorded voicemail file. this defines the
format of the recorded message: default is .wav, .mp3
will record a voicemail as MP3 file (the mp3 plugin needs
to be loaded so that mp3 encoding is possible)
App-Params
----------
These must be passed as headers with the INVITE request to SEMS, so that
SEMS knows at least the email address to send the email to.
Email-Address - mandatory (!): the email address to send the mail to
Language - optional: language for announcement file
Example:
P-Iptel-App: voicemail
P-App-Param: Email-Address=user@maildomain.net;Language=Latvian
old deprecated header format:
P-Email-Address: user@maildomain.net
P-Language: Latvian
Voicemail email templates
-------------------------
Email templates will help you to customize the emails
sent by Voicemail. Just configure the path where the
templates can be found and edit your template files.
You will find detailed informations in the following
sections.
Configuration parameters within voicemail.conf:
--------------------------------------------------
email_template_path:
- sets the directory which will be searched for
email template files (*.template).
- each template file stands for a different domain:
<domain>.template
Ex: iptel.org.template
- additionaly, a default template must be present in
the directory configured with that configuration
parameter. It must be named 'default.template'.
If you configured email_template_path well and turned debug informations
on, you should find in the log file during loading process following lines:
(9834) DEBUG: loadEmailTemplates (AnswerMachine.cpp:102): loading plug-in/voicemail/default.template ...
(9834) DEBUG: loadEmailTemplates (AnswerMachine.cpp:102): loading plug-in/voicemail/iptel.org.template ...
(9834) DEBUG: loadEmailTemplates (AnswerMachine.cpp:102): loading plug-in/voicemail/susie.at.template ...
Email template format:
----------------------
to: <destination email address>
from: <source email address>
subject: <subject line>
[header: <additional header>]
<empty line>
<body>
The optional header line adds a freely configurable
header to the mail. For example, the voicemail can be
securely filtered for the header X-Content if the following
is used in the voicemail template:
header: X-Content: Voicemail
This line is optional.
Variables:
----------
If you want to customize the email depending on call datas,
please use folowing syntax: %variable%
Following variables are supported:
- %to% : local URI.
- %domain% : local domain.
- %user% : local user.
- %email% : email address of the local user.
- %from% : remote URI.
- %from_user% : remote user.
- %from_domain% : remote domain.