ncid-page(1)

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

NAME

6       ncid-page - send a Caller ID or message to a cell phone, pager or other
7       email address
8

SYNOPSIS

10       ncid --no-gui --module ncid-page
11

DESCRIPTION

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

CONFIGURATION

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

REQUIREMENTS

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

EXAMPLES

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

FILES

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