Man Linux: Main Page and Category List

NAME

       answering_machine.conf - configuration of CapiSuite answering machine

DESCRIPTION

       This  file holds all available config options for the answering machine
       provided by the default scripts distributed with CapiSuite. It is  read
       from              /etc/capisuite/answering_machine.conf              or
       /usr/local/etc/capisuite/answering_machine.conf   (depending   on   the
       installation).

       It  is  divided  into  one  or more sections. A section begins with the
       section name in square brackets like [section] while  the  options  are
       key="value" lines.

       A  special section called [GLOBAL] and one section for each user called
       [<username>] are required.The <username> must be a valid system user.

       The [GLOBAL]-section defines some global  options  like  pathnames  and
       default   settings   for   options   that  can  be  overridden  in  the
       user-sections. The user-sections hold all the options which belong to a
       particular user.

THE [GLOBAL] SECTION

       audio_dir="/path/to/audiodir/"
              The  answering  machine  script  uses  several  wave  files, for
              example a global announcement if the user hasn’t set his own and
              some  spoken  word fragments for the remote inquiry and the menu
              presented  there.  These  audio  files  are  searched  in   this
              directory.     If     user_audio_files     is    enabled    (see
              user_audio_files), each user can  also  provide  his  own  audio
              snippets in his user_dir (see voice_user_dir).

              This option is mandatory.

       voice_user_dir="/path/to/userdir/"
              This  directory  is  used to save user specific data to. It must
              exist and the user CapiSuite runs as must have write  permission
              to it. It will contain one subdirectory for each configured user
              (named like his userid). The following subdirectories  are  used
              below the user-specific dir:

              user_dir/username/
                     Here  the  user may provide his own audio_files (see also
                     option  user_audio_files   below).   The   user   defined
                     announcement is also saved here.

              user_dir/username/received/
                     Received voice calls are saved here.

              This option is mandatory.

       user_audio_files="0"
              If  set  to  1, each user may provide his own audio files in his
              user directory (see voice_user_dir).  If  set  to  0,  only  the
              audio_dir (see voice_audio_dir) will be searched.

              This  option is optional. If not set, it defaults to not reading
              own user audio files (0).

       voice_delay="15"
              Sets the default value for the delay for accepting  an  incoming
              call  in  (in  seconds).  A value of 10 means that the answering
              machine accepts incoming calls 10  seconds  after  the  incoming
              connection  request.  This  value can be overwritten in the user
              sections individually.

              This option is mandatory.

       announcement="announcement.la"
              Sets the  default  name  to  use  for  user  announcements.  The
              announcements  are  searched  in  user_dir/username/announcement
              then. If not found, a global announcement containing the  called
              MSN  will  be  played. This value can be overwritten in the user
              sections individually.

              This  option  is  optional.  If  not   set,   it   defaults   to
              "announcement.la".

       record_length="60"
              Default  setting  for the maximum record length in seconds. This
              value can be overwritten in the user sections individually.

              This option is optional. If not set, it defaults to 60  seconds.

       record_silence_timeout="5"
              Default  setting for the record silence timeout in seconds. When
              set to a value greater than 0, the recording will be aborted  if
              silence is detected for the given amount of seconds. Set this to
              0 to disable it. This value  can  be  overwritten  in  the  user
              sections individually.

              This option is optional. If not set, it defaults to 5 seconds.

       voice_email_from="<mailaddress>"
              You  can  set  a  default  originator  ("From"-address)  for the
              e-mails CapiSuite sends here.

              This option is optional. If you set this to an empty string, the
              destinator  is  used  as originator (i.e. if "gernot" receives a
              voice call, the mail comes from "gernot" to "gernot").

THE USER SECTIONS

       voice_delay
              User specific value for the corresponding global option

       announcement
              User specific value for the corresponding global option

       record_length
              User specific value for the corresponding global option

       record_silence_timeout
              User specific value for the corresponding global option

       voice_email_from
              User specific value for the corresponding global option

       voice_numbers="<number1>,<number2>,..."
              A list containing the  numbers  on  which  this  user  wants  to
              receive  incoming  voice calls. These numbers are used to differ
              between users - so the same number must not appear in more  than
              one  user  section! The numbers are separated with commas and no
              blanks are allowed.  The  answering  machine  script  does  also
              automatic  fax  detection,  so a fax can be sent to this number.
              When this list is set to *,all incoming calls will  be  accepted
              for  this user (use with care!). This is only useful for a setup
              with only one user which wants to receive any call.

              If for any reason no destination number is signalled for special
              MSNs  (austrian telecom seems to do this for the main MSN, where
              it is called "Global Call"), you can  use  the  special  sign  -
              which means "no destination number available".

              This  option  is  optional.  If  not set, the user won’t receive
              voice calls.

       voice_email=""
              If  given,  this  string  indicates  email-addresses  where  the
              received  faxes and voice calls will be sent to. If it is empty,
              they will be sent to the user account on the system CapiSuite is
              running on. More addresses are separated by commas. If you don’t
              want emails to be sent  at  all,  use  the  action  option  (see
              voice_action).

              This option is optional. If not set, the calls are mailed to the
              system account.

       pin="<your PIN>"
              The answering machine also supports a remote  inquiry  function.
              This function is used by entering a PIN (Personal Identification
              Number) while the announcement is played. This PIN can be  setup
              here. If you don’t want to use the remote inquiry function, just
              use an empty PIN setting. The PIN doesn’t have a maximal  length
              - but perhaps you should not use 200 digits or you perhaps won’t
              be able to remember them (I won’t at least). ;-)

              This option is optional. If not set, remote inquiry is disabled.

       voice_action="MailAndSave"
              Here  you  can  define  what action will be taken when a call is
              received. Currently, three possible actions are supported:

              MailAndSave
                     The received call will be mailed  to  the  given  address
                     (seevoice_email  above)  and  saved to the voice_user_dir
                     (see global options)

              SaveOnly
                     The call will be only saved to  the  voice_user_dir  (see
                     global options)

              None   Only  the  announcement  will be played - no recording is
                     done.

              This option is mandatory.

SEE ALSO

       capisuite(8), capisuite.conf(5), fax.conf(5), capisuitefax(1)

AUTHOR

       Gernot Hillier <gernot@hillier.de>.

                                                          ANSWERING_MACHINE(5)