Content-type: text/html Manpage of HANGUP-SKEL

HANGUP-SKEL

Section: NCID (1)
Updated: 2022-11-8
Index Return to Main Contents

NAME

hangup-skel

SYNOPSIS

hangup-skel [-h]

hangup-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-skel is a template for writing a server hangup extension. Use a new name to duplicate the file and make the necessary modifications. You need to write the code to check if a number should return the word hangup to STDOUT. You have the option of returning a recording file name to use with a hangup. Your script name should follow this format: hangup-<name>

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

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

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

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

/usr/share/ncid/extensions/hangup-myscript -v "*NMBR*0000000000*"

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-skel
/usr/share/ncid/recordings/*.rmd
/etc/ncid/ncidd.conf
/etc/ncid/ncidd.whitelist

This document was created by man2html, using the manual pages.
Time: 18:17:41 GMT, November 12, 2022