ncid-page(1)

1NCID-PAGE(1)                         NCID                         NCID-PAGE(1)
2
3
4

NAME

6       ncid-page
7

SYNOPSIS

9       ncid --no-gui --module ncid-page
10

DESCRIPTION

12       The  ncid-page  output  module sends the Caller ID or message to a cell
13       phone, pager, or any other email address.  It can have  multiple  email
14       addresses.
15
16       The  module  always  sends  the information as soon as the Caller ID is
17       received.
18
19       The ncid client can be configured  in ncid.conf to wait  until  a  spe‐
20       cific  number  of  rings  before sending the Caller ID to a module when
21       using a modem that indicates RING, or it can send the Caller ID if  the
22       call  was  unanswered or at the completion of the call when using a SIP
23       gateway. Do this by creating an ncid_page variable in ncid.conf.
24
25       The module requires PageTo in ncid-page.conf to be set to the SMS gate‐
26       way for your cell phone carrier.
27
28       List of SMS gateways:
29                 https://en.wikipedia.org/wiki/List_of_SMS_gateways
30

CONFIGURATION

32       The ncid-page output module is configured in ncid-page.conf.
33
34       allowed_types
35                 This  sets  the NCID call and/or message types ncid-page will
36                 send.  See ncid-page.conf for a complete list.
37
38                 Default: allowed_types="CID MSG"
39
40
41                 IMPORTANT
42                        If MSG is added to PageTypes and  you  are  using  the
43                        rn2ncid  gateway,  you  must  configure  reject in the
44                        rn2ncid.conf file to avoid sending the message back to
45                        NCID.
46
47       PageTo    Required. Must be set to either the SMS gateway for your cell
48                 phone carrier or an email address.
49
50                 Default: PageTo=""
51
52       PageFrom  This variable has no effect unless root runs  ncid-page.   If
53                 set, it allows root to run ncid-page as another user.
54
55                 Default: PageFrom=""
56
57       PageMail  This  variable  sets  the mail program to use in sending NCID
58                 messages.
59
60                 Default: PageMail="mail"
61
62       PageOpt   This variable, if set provides a  Subject  line  for  sending
63                 email.
64                 PageOpt=""       no subject line
65                 PageOpt="NMBR"   calling number subject line
66                 PageOpt="NAME"   calling name subject line
67                 PageOpt="NONA"   calling number and name subject line
68                 PageOpt="NANO"   calling name and number subject line
69
70                 Default: PageOpt=""
71

REQUIREMENTS

73       mailx  Can be another mail program with an optional subject line
74
75
76       MTA    See https://en.wikipedia.org/wiki/Message_transfer_agent
77              Suggest a simple MTA like exim to send and receive mail.
78              The sendmail MTA is very good but hard to configure.
79              Use an SMTP program like SSMTP if you only need to send mail.
80
81              You can use ssmtp or exim to handle mail on the Raspberry Pi.
82              ssmtp:                                           https://web.ar‐
83              chive.org/web/20140831073557/https://rpi.tnet.com/project/faqs/smtp
84              exim: http://www.sbprojects.com/projects/raspberrypi/exim4.php
85
86              To use google for outgoing mail, you need 2-step verification:
87              https://support.google.com/accounts/answer/180744
88

EXAMPLES

90       If  you want to call a module on a certain ring count, you need to con‐
91       figure the module to set ring in the ncid.conf file.
92
93       ncid command line options to call ncid-page at ring number 4
94
95           ncid --no-gui --module ncid-page --ring 4
96
97       ncid.conf line and ncid command line to call ncid-page if no answer
98
99           uncomment the ncid_page line in ncid.conf and change 4 to -1
100           set ncid_page {set Ring -1}
101
102           ncid command to call ncid-page if no answer
103           ncid --no-gui --module  ncid-page
104

FILES

106       /etc/ncid/conf.d/ncid-page.conf
107       /usr/share/ncid/modules/ncid-page
108