summaryrefslogtreecommitdiffstats
path: root/doc/README.VoiceBox
blob: 885742aacbcf6f86f838d0467444638c61ca1751 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
In the voice box spool directory the following files may be used to
adjust configuration options:

./RECORD_TIME
        
        Specify the time in seconds when message recording is stopped.

        Defaults to "60".

./PIN

        Specify the PIN for the voice box when queried over the phone
        line. This should be a string capable of being entered via DTMF
        tones, thus consisting of 0-9, *, # only. The length is up to you.

        Two special PINs may be set: an empty string disables all
        authentication, "-" will deny all authentication attempts.

        Defaults to "-".

./newmessage

        This should be a link pointing to a script which is called
        whenever a new message is recorded. It is run with a single
        argument: the filename of the recorded message. Special
        environment variables are passed:

                    RINGMSN

                        The local number of the voice box

                    CALLERMSN
                    
                        The remote number the message originates from

                    LENGTH

                        The length in bytes of the uncompressed voice
                        message. Since the sampling rate of the ISDN
                        is fixed to 8000Hz divide this value by 8000
                        to get the length in seconds.

                    SEC_LENGTH

                        The length in seconds of the voice message
                        written as fixed point number. This is the
                        same as LENGTH/8000.

                    SPOOLDIR

                        The spool directory where the configuration of
                        the voice box resides.

./EMAIL

       Specify the email address of the owner of this voice box. This
       address ist notified whenever a new message is recorded. It is
       interpreted by the default newmessage script. If you change
       that script this file may become useless.

       Defaults to "root".

./*.ulaw.gz

        These are audio files which are used by the voice box
        automaton. You may replace them with your on recordings.

        ./welcome.ulaw.gz           -- The welcome message
        ./authok.ulaw.gz            -- "Authentication successful"
        ./beep.ulaw.gz              -- A beep
        ./nomoremessages.ulaw.gz    -- "No more messages available"
        ./auth.ulaw.gz              -- "Please authenticate"
        ./empty.ulaw.gz             -- "The voice box is empty"
        ./removed.ulaw.gz           -- "Message deleted successfully"

./messages/

        This is not a configuration item but where the recorded
        messages are stored. You are free to delete any message from
        the voice box by issuing standard Unix commands like 'rm'
        inside this directory. The file names inside the directory
        include the Unix time, the local number and the originating
        number seperated by colons.