hangup-message-skel - Man Page

Synopsis

hangup-message-skel [-h]

hangup-message-skel [-v] <string>

where string is in this format:
*DATE*<mmddyyyy>*TIME*<hhmm>*LINE*<lineid>\
*NMBR*<number>*NAME*<name>*MODE*<hupmode>\
*FNMBR*<formatted number>*NTYPE*<type of device>\
*CTRY*<country code>*LOCA*<location>*CARI*<carrier>\
*NAME*<name>*

Description

Hangup-message-skel is a template for leaving caller specific messages prior to terminating a call.

Your script name should be the same name without -skel. Script names use the format: hangup-<name>

Script is not called if caller number or name is in ncidd.whitelist.

The example below assumes you have copied hangup-message-skel to hangup-message for your customized version of hangup-message-skel.

Delete the caller and message lines that are in hangup-message. If you want to detect a name, comment the NMBR line and uncomment the NAME line:

Add your own caller and message lines to hangup-message:

CALLER="${NMBR}"

caller[1]="<number>"  message[1]="<recording file>"

CALLER="$(NAME)"

caller[1]="<name>"  message[1]="<recording file>"

You can add as many caller-message lines as you want.  You would need to record the message files if you want to leave a personalized message.

Use this format for a message name for your recording: <number>.rmd

Server hangup extensions are only executed by the server unless testing.

Execute your custom hangup-message in a terminal window by itself for testing. Only fields used in the script are needed for the input string. To test your custom hangup-message script with a number:

/usr/share/ncid/extensions/hangup-message -v "*NMBR*4075551212*"

Options

-h

show help message

-v

turn on verbose and send additional data to STDOUT for troubleshooting

Requirements

Set hupname to the name of this script ncidd.conf.
Set hupmode to 1, 2 or 3 in ncidd.conf.
Set huprmd to a unique voice file in ncidd.conf, if hupmode set to 3.

Files

/usr/share/ncid/extensions/hangup-message-skel
/usr/share/ncid/recording/*.rmd
/etc/ncid/ncid.conf
/etc/ncid/ncidd.whitelist

See Also

ncidd(8), ncidd.whitelist(5), hangup-calls(1), hangup-closed-skel(1), hangup-skel(1), hangup-combo-skel.1, hangup-nohangup(1)

Referenced By

hangup-calls(1), hangup-closed-skel(1), hangup-combo(1), hangup-nohangup(1), hangup-skel(1), ncid_extensions(7).

2022-11-8 NCID