- Spelling checked
[sip-router] / doc / seruser / voicemail.sgml
1 <!-- <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ ]> -->
2 <section>
3 <title>Introduction</title>
4 <para>
5         The voicemail system provides <application>ser</application>
6         with voice announcement and recording capabilities. Voice
7         messages may then be mailed to the called user. The system
8         relies on <application>ser</application> for implementing
9         the <acronym>SIP</acronym> stack and communicate with it
10         through <acronym>FIFO</acronym>. It implements the dialog and media
11         handling as described in RFC 3264 (An Offer/Answer Model with
12         the Session Description Protocol) and RFC 1889 (Real time
13         transport protocol) to realize its goal.
14 </para>
15 </section>
16 <section>
17
18 <title>Advantages</title>
19 <para>
20         <itemizedlist>
21                 <listitem>
22                         <para>
23                             Anyone deploying <application>ser</application> and
24                             <acronym>VoIP</acronym> should profit from this 'ready-to-run'
25                             application. It plugs into <application>ser</application> as
26                             easy as configuring the database location, announce file path
27                             and SMTP server address. 
28                         </para>
29                 </listitem>
30                 <listitem>
31                         <para>
32                             Further,
33                             <application>voicemail</application>
34                             integrates the most popular free codecs
35                             (G.711ulaw, G.711alaw and GSM 06.10) and
36                             its own SMTP client, which means that you
37                             don't need to install anything else as
38                             <application>ser</application> and
39                             <application>voicemail</application>. 
40                         </para>
41                 </listitem>
42                 <listitem>
43                         <para>
44                             If you want your voicemail system to support
45                             other codecs, a simple plugin system with
46                             SDK allows you to integrate them fast and
47                             simply (see the basis plugins for examples). 
48                         </para>
49                 </listitem>
50         </itemizedlist>
51 </para>
52 </section>
53 <section>
54
55 <title>Technical limitations</title>
56 <para>
57         <itemizedlist>
58                 <listitem>
59                     <para>
60                             The sound conversion engine doesn't
61                             support yet re-sampling. It means that
62                             input and output files have to be
63                             compatible with the sampling rate of the
64                             codec. All codecs included with the
65                             distribution work at 8kHz, which means
66                             that all the input and output files MUST
67                             be sampled at the rate of 8kHz.
68                     </para>
69                 </listitem>
70                 <listitem>
71                     <para>
72                             At the moment, voicemail only support the
73                             Microsoft Wav file format with PCM 16 bit,
74                             Mu-law and A-law 8 bit encoding.
75                     </para>
76                 </listitem>
77         </itemizedlist>
78 </para>
79 </section>
80 <section>
81
82 <title>Compilation and installation</title>
83 <para>
84         <itemizedlist>
85                 <listitem>
86                         <para>
87                         First, you need to compile Ser with voicemail
88                         support. Therefore, you must edit Ser's
89                         Makefile.defs file and uncomment the line with
90                         '-DVOICE_MAIL' and '-D_TOTAG'.
91                         </para>
92                 </listitem>
93                 <listitem>
94                         <para>
95                         Then do 'make all' in Ser's root directory.
96                         </para>
97                 </listitem>
98                 <listitem>
99                         <para>
100                         Configure Ser to fit your needs. You can
101                         report to voicemail example config file to
102                         know what your configuration file should
103                         include. Note that voicemail
104                         only needs to know the user database location
105                         in order to work. Report to the README file in
106                         the vm module directory for description of the
107                         functions and variable that are used by
108                         voicemail and how they work.
109                         </para>
110                 </listitem>
111                 <listitem>
112                         <para>
113                         Finally, compile the voicemail application:
114
115                         <programlisting>
116                         [~/voicemail]$ cd ortp-0.5.0
117                         [~/voicemail/ortp-0.5.0]$ ./configure
118                         [~/voicemail/ortp-0.5.0]$ make all
119                         [~/voicemail/ortp-0.5.0]$ cd ..
120                         [~/voicemail]$ cd plug-in/gsm/gsm-????
121                         [~/voicemail/plug-in/gsm/gsm-????]$ make all
122                         [~/voicemail/plug-in/gsm/gsm-????]$ cd ../..
123                         [~/voicemail]$ make all
124                         </programlisting>
125
126                         You can then start voicemail with following
127                         command <command>ans_machine</command> and
128                         look if the default fit your needs. If not,
129                         type <command>ans_machine -h</command> to see
130                         how to change the default parameters.
131
132                           <!--<note>-->
133                           If <application>ans_machine</application> is
134                           not started or can't be joined while
135                           <application>ser</application> tries to
136                           communicate with it, the caller will become
137                           a '500 internal server error' with a comment
138                           saying what the trouble is.
139                           <!--</note>-->
140                         </para>
141                 </listitem>
142         </itemizedlist>
143 </para>
144 </section>
145
146 <section>
147 <title>Example ser Config File</title>
148 <para>
149         <example>
150                 <title>Example ser Config File</title>
151                 <programlisting>
152 &voicemailcfg;
153                 </programlisting>
154         </example>
155 </para>
156 </section>
157 <section>
158
159 <title>Availability, report bugs, contact the author</title>
160 <para>
161         Ser's Voicemail's home page is hosted at
162         http://sems.berlios.de. A snapshot may be downloaded directly
163         from the CVS tree. A pre-configured version of 
164         <application>ser</application> including
165         <application>voicemail</application> will be soon available
166         (from version 0.8.11). Bugs can be reported at the voicemail's
167         home page. If you want to contact the author, use the contact
168         email at the home page.
169 </para>
170 </section>