ncid-page man page

ncid-page

Synopsis

ncid --no-gui --program ncid-page

Description

The ncid-page output module sends the Caller ID or message to a cell phone, pager, or any other email address.  It can have multiple email addresses.

The module always sends the information as soon as the Caller ID is received.

The ncid client can be configured  in ncid.conf to wait until a specific number of rings before sending the Caller ID to a module when using a modem that indicates RING, or it can send the Caller ID if the call was unanswered or at the completion of the call when using a SIP gateway. Do this by creating an  ncid_page variable in ncid.conf.

The module requires PageTo in ncid-page.conf to be set to the SMS gateway for your cell phone carrier.

List of SMS gateways:

https://en.wikipedia.org/wiki/List_of_SMS_gateways

Configuration

The ncid-page output module is configured in ncid-page.conf.

PageTypes

This sets the NCID message types ncid-page will send.  The different types are CID, OUT, HUP, BLK, WID, MSG, PID, and NOT.

Default: PageTypes="CID MSG"

IMPORTANT

If MSG is added to PageTypes and you are using the rn2ncid gateway, you must configure reject in the rn2ncid.conf file to avoid sending the message back to NCID.

PageTo

Required. Must be set to either the SMS gateway for your cell  phone carrier or an email address.

Default: PageTo=""

PageFrom

This variable has no effect unless root runs ncid-page. If set, it allows root to run ncid-page as another user.

Default: PageFrom=""

PageMail

This variable sets the mail program to use in sending NCID messages.

Default: PageMail="mail"

PageOpt

This variable, if set provides a Subject line for sending email.

PageOpt=""

no subject line

PageOpt="NMBR"

calling number subject line

PageOpt="NAME"

calling name subject line

PageOpt="NONA"

calling number and name subject line

PageOpt="NANO"

calling name and number subject line
Default: PageOpt=""

Requirements

mailx

Can be another mail program with an optional subject line

MTA

See https://en.wikipedia.org/wiki/Message_transfer_agent
Suggest a simple MTA like exim to send and receive mail.
The sendmail MTA is very good but hard to configure.
Use a SMTP program like SSMTP if only need to send mail.

You can use ssmtp or exim to handle mail on the Raspberry Pi.
ssmtp: https://rpi.tnet.com/project/faqs/smtp
exim: http://www.sbprojects.com/projects/raspberrypi/exim4.php

To use google for outgoing mail, you need 2-step verification:
https://support.google.com/accounts/answer/180744

Examples

If you want to call a module on a certain ring count, you need to configure the module to set ring in the ncid.conf file.
ncid command line options to call ncid-page at ring number 4

   ncid --no-gui --program ncid-page --ring 4

ncid.conf line and ncid command line to call ncid-page if no answer

   uncomment the ncid_page line in ncid.conf and change 4 to -1
   set ncid_page {set Ring -1}

   ncid command to call ncid-page if no answer
   ncid --no-gui --program  ncid-page

Files

/etc/ncid/conf.d/ncid-page.conf
/usr/share/ncid/modules/ncid-page

See Also

ncidd.8, ncid-modules.7, ncid.1, ncid.conf.5, ncid-alert.1, ncid-initmodem.1, ncid-kpopup.1, ncid-mythtv.1, ncid-notify.1, ncid-samba.1, ncid-skel.1, ncid-speak.1, ncid-wakeup.1, ncid-yac.1