1HANGUP-MESSAGE-SKEL(1)               NCID               HANGUP-MESSAGE-SKEL(1)
2
3
4

NAME

6       hangup-message-skel
7

SYNOPSIS

9       hangup-message-skel [-h]
10       hangup-message-skel [-v] <string>
11
12              where string is in this format:
13              *DATE*<mmddyyyy>*TIME*<hhmm>*LINE*<lineid>\
14              *NMBR*<number>*NAME*<name>*MODE*<hupmode>\
15              *FNMBR*<formatted number>*NTYPE*<type of device>\
16              *CTRY*<country code>*LOCA*<location>*CARI*<carrier>\
17              *NAME*<name>*
18

DESCRIPTION

20       Hangup-message-skel  is a template for leaving caller specific messages
21       prior to terminating a call.
22
23       Your script name should be the same name without -skel.   Script  names
24       use the format: hangup-<name>
25
26       Script is not called if caller number or name is in ncidd.whitelist.
27
28       The  example  below  assumes  you  have  copied  hangup-message-skel to
29       hangup-message for your customized version of hangup-message-skel.
30
31       Delete the caller and message lines that are in hangup-message.  If you
32       want  to  detect  a  name, comment the NMBR line and uncomment the NAME
33       line:
34
35       Add your own caller and message lines to hangup-message:
36
37              CALLER="${NMBR}"
38              caller[1]="<number>"  message[1]="<recording file>"
39              CALLER="$(NAME)"
40              caller[1]="<name>"  message[1]="<recording file>"
41
42       You can add as many caller-message lines as you want.  You  would  need
43       to  record  the  message files if you want to leave a personalized mes‐
44       sage.
45
46       Use this format for a message name for your recording: <number>.rmd
47
48       Server hangup extensions are only executed by the server  unless  test‐
49       ing.
50
51       Execute  your  custom hangup-message in a terminal window by itself for
52       testing.  Only fields used in the  script  are  needed  for  the  input
53       string.  To test your custom hangup-message script with a number:
54
55       /usr/share/ncid/extensions/hangup-message -v "*NMBR*4075551212*"
56

OPTIONS

58       -h     show help message
59
60       -v     turn  on  verbose  and  send additional data to STDOUT for trou‐
61              bleshooting
62

REQUIREMENTS

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

FILES

69       /usr/share/ncid/extensions/hangup-message-skel
70       /usr/share/ncid/recording/*.rmd
71       /etc/ncid/ncid.conf
72       /etc/ncid/ncidd.whitelist
73

SEE ALSO

75       ncidd.8,   ncidd.whitelist.5,   hangup-calls.1,   hangup-closed-skel.1,
76       hangup-skel.1, hangup-combo-skel.1, hangup-nohangup.1
77
78
79
80NCID                               2022-11-8            HANGUP-MESSAGE-SKEL(1)
Impressum