NCID-PAGE(1)

💖 NCID-PAGE 💖

okay so bestie, gather round, because this is the ncid-page page from the NCID manual and it's genuinely one of the most useful little gremlins in the whole toolkit. it sends your Caller ID (or a message) straight to a cell phone, a pager, or honestly any email address you want. let's get into it 🫶

---

✨ NAME ✨

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

---

🌸 SYNOPSIS 🌸

ncid --no-gui --module ncid-page

---

🦋 DESCRIPTION 🦋

so the ncid-page output module sends the Caller ID, or a message, to a cell phone, a pager, or literally any other email address. and yes, it can have multiple email addresses, because why would we limit ourselves 💅

the module always sends the info the second the Caller ID comes in. no waiting around, no suspense, it's giving instant.

now, the ncid-page module can be configured in ncid.conf to wait until a specific number of rings before sending the Caller ID to a module, if you're using a modem that indicates RING. or, if you're on a SIP gateway, it can send the Caller ID if the call was unanswered or at the completion of the call. how do you do that? create an ncid_page variable in ncid.conf. that's it, that's the whole trick.

also, heads up: the module requires PageTo in ncid-page.conf to be set to the SMS gateway for your cell phone carrier. non-negotiable, it's the main character of the config.

list of SMS gateways, bookmark this:

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

---

🎀 CONFIGURATION 🎀

the ncid-page output module gets configured in ncid-page.conf. here's the whole menu:

• allowed_types — this sets the NCID call and/or message types that ncid-page will send. peep ncid-page.conf for a complete list.
  • Default: allowed_types="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. like, do not skip this one bestie, it's a whole loop situation 😭

• 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 lets root run ncid-page as another user.
  • Default: PageFrom=""
• PageMail — this variable sets the mail program to use when sending NCID messages.
  • Default: PageMail="mail"
• PageOpt — this variable, if set, provides a Subject line for sending email. options are:
  • 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, as long as it supports 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 an SMTP program like SSMTP if you only need to send mail.
  • you can use ssmtp or exim to handle mail on the Raspberry Pi.
  • ssmtp: https://web.archive.org/web/20140831073557/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 --module 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 --module  ncid-page

---

💜 FILES 💜

prefix3=/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

---

and that's the whole page, bestie, no cap 💖 this was the NCID manual, dated 2022-11-8 — go forth and page someone, you absolute icon 🎀✨