document the new context argument for privacymanager
[asterisk/asterisk.git] / doc / tex / privacy.tex
1 So, you want to avoid talking to pesky telemarketers/charity
2 seekers/poll takers/magazine renewers/etc?
3
4 \subsection{First of all}
5
6  the FTC "Don't call" database, this alone will reduce your
7 telemarketing call volume considerably.  (see:
8 \url{https://www.donotcall.gov/default.aspx} ) But, this list won't protect
9 from the Charities, previous business relationships, etc.
10
11 \subsection{Next, Fight against autodialers!!}
12
13 Zapateller detects if callerid is present, and if not, plays the
14 da-da-da tones that immediately precede messages like, "I'm sorry,
15 the number you have called is no longer in service."
16
17 Most humans, even those with unlisted/callerid-blocked numbers, will
18 not immediately slam the handset down on the hook the moment they hear
19 the three tones. But autodialers seem pretty quick to do this.
20
21 I just counted 40 hangups in Zapateller over the last year in my
22 CDR's.  So, that is possibly 40 different telemarketers/charities that have
23 hopefully slashed my back-waters, out-of-the-way, humble home phone
24 number from their lists.
25
26 I highly advise Zapateller for those seeking the nirvana of "privacy".
27
28
29 \subsection{Next, Fight against the empty CALLERID!}
30
31 A considerable percentage of the calls you don't want, come from
32 sites that do not provide CallerID.
33
34 Null callerid's are a fact of life, and could be a friend with an
35 unlisted number, or some charity looking for a handout. The
36 PrivacyManager application can help here. It will ask the caller to
37 enter a 10-digit phone number. They get 3 tries(configurable), and this is
38 configurable, with control being passed to next priority where you can
39 check the channelvariable PRIVACYMGRSTATUS. If the callerid was valid this
40 variable will have the value SUCCESS, otherwise it will have the value
41 FAILED.
42
43 PrivacyManager can't guarantee that the number they supply is any
44 good, tho, as there is no way to find out, short of hanging up and
45 calling them back. But some answers are obviously wrong. For instance,
46 it seems a common practice for telemarketers to use your own number
47 instead of giving you theirs. A simple test can detect this. More
48 advanced tests would be to look for -555- numbers, numbers that count
49 up or down, numbers of all the same digit, etc.
50
51 PrivacyManager can be told about a context where you can have patterns
52 that describe valid phone numbers. If none of the patterns match the
53 input, it will be considered a non-valid phonenumber and the user
54 can try again until the retry counter is reached.
55 This helps in resolving the issues stated in the previous paragraph.
56
57 My logs show that 39 have hung up in the PrivacyManager script over
58 the last year.
59
60 (Note: Demanding all unlisted incoming callers to enter their CID may
61 not always be appropriate for all users. Another option might be to
62 use call screening. See below.)
63
64
65 \subsection{Next, use a WELCOME MENU !}
66
67 Experience has shown that simply presenting incoming callers with
68 a set of options, no matter how simple, will deter them from calling
69 you. In the vast majority of situations, a telemarketer will simply
70 hang up rather than make a choice and press a key.
71
72 This will also immediately foil all autodialers that simply belch a
73 message in your ear and hang up.
74
75 \subsubsection{Example usage of Zapateller and PrivacyManager}
76
77 \begin{astlisting}
78 \begin{verbatim}
79 [homeline]
80 exten => s,1,Answer
81 exten => s,2,SetVar,repeatcount=0
82 exten => s,3,Zapateller,nocallerid
83 exten => s,4,PrivacyManager
84      ;; do this if they don't enter a number to Privacy Manager
85 exten => s,105,Background(tt-allbusy)
86 exten => s,106,Background(tt-somethingwrong)
87 exten => s,107,Background(tt-monkeysintro)
88 exten => s,108,Background(tt-monkeys)
89 exten => s,109,Background(tt-weasels)
90 exten => s,110,Hangup
91 exten => s,5,GotoIf($[ "${CALLERID(num)}"  = "7773334444" & "${CALLERID(name)}" : "Privacy Manager" ]?callerid-liar,s,1:s,7)
92 \end{verbatim}
93 \end{astlisting}
94
95 I suggest using Zapateller at the beginning of the context, before
96 anything else, on incoming calls.This can be followed by the
97 PrivacyManager App.
98
99 Make sure, if you do the PrivacyManager app, that you take care of the
100 error condition! or their non-compliance will be rewarded with access
101 to the system. In the above, if they can't enter a 10-digit number in
102 3 tries, they get the humorous "I'm sorry, but all household members
103 are currently helping other telemarketers...", "something is terribly
104 wrong", "monkeys have carried them away...", various loud monkey
105 screechings, "weasels have...", and a hangup. There are plenty of
106 other paths to my torture scripts, I wanted to have some fun.
107
108 In nearly all cases now, the telemarketers/charity-seekers that
109 usually get thru to my main intro, hang up. I guess they can see it's
110 pointless, or the average telemarketer/charity-seeker is instructed
111 not to enter options when encountering such systems. Don't know.
112
113
114 \subsection{Next: Torture Them!}
115
116 I have developed an elaborate script to torture Telemarketers, and
117 entertain friends. (See
118 \url{http://www.voip-info.org/wiki-Asterisk+Telemarketer+Torture} )
119
120 While mostly those that call in and traverse my teletorture scripts
121 are those we know, and are doing so out of curiosity, there have been
122 these others from Jan 1st,2004 thru June 1st, 2004:
123 (the numbers may or may not be correct.)
124
125 \begin{itemize}
126     \item 603890zzzz -- hung up telemarket options.
127     \item "Integrated Sale" -- called a couple times. hung up in telemarket options
128     \item "UNITED STATES GOV" -- maybe a military recruiter, trying to lure one of my sons.
129     \item 800349zzzz -- hung up in charity intro
130     \item 800349zzzz -- hung up in charity choices, intro, about the only one who actually travelled to the bitter bottom of the scripts!
131     \item 216377zzzz -- hung up the magazine section
132     \item 626757zzzz = "LIR    " (pronounced "Liar"?) hung up in telemarket intro, then choices
133     \item 757821zzzz -- hung up in new magazine subscription options.
134 \end{itemize}
135
136 That averages out to maybe 1 a month. That puts into question whether
137 the ratio of the amount of labor it took to make the scripts versus
138 the benefits of lower call volumes was worth it, but, well, I had fun,
139 so what the heck.
140
141 but, that's about it. Not a whole lot. But I haven't had to say "NO"
142 or "GO AWAY" to any of these folks for about a year now ...!
143
144 \subsection{Using Call Screening}
145
146 Another option is to use call screening in the Dial command. It has
147 two main privacy modes, one that remembers the CID of the caller, and
148 how the callee wants the call handled, and the other, which does not
149 have a "memory".
150
151 Turning on these modes in the dial command results in this sequence of
152 events, when someone calls you at an extension:
153
154 \begin{enumerate}
155 \item The caller calls the Asterisk system, and at some point, selects an
156 option or enters an extension number that would dial your extension.
157
158 \item Before ringing your extension, the caller is asked to supply an
159 introduction. The application asks them: "After the tone, say your
160 name". They are allowed 4 seconds of introduction.
161
162 \item After that, they are told "Hang on, we will attempt to connect you
163 to your party. Depending on your dial options, they will hear ringing
164 indications, or get music on hold. I suggest music on hold.
165
166 \item Your extension is then dialed. When (and if) you pick up, you are
167 told that a caller presenting themselves as $<$their recorded intro is
168 played$>$ is calling, and you have options, like being connected,
169 sending them to voicemail, torture, etc.
170
171 \item You make your selection, and the call is handled as you chose.
172 \end{enumerate}
173
174 There are some variations, and these will be explained in due course.
175
176
177 To use these options, set your Dial to something like:
178 \begin{astlisting}
179 \begin{verbatim}
180 exten => 3,3,Dial(DAHDI/5r3&DAHDI/6r3,35,tmPA(beep))
181     or
182 exten => 3,3,Dial(DAHDI/5r3&DAHDI/6r3,35,tmP(something)A(beep))
183     or
184 exten => 3,3,Dial(DAHDI/5r3&DAHDI/6r3,35,tmpA(beep))
185 \end{verbatim}
186 \end{astlisting}
187
188 The 't' allows the dialed party to transfer the call using '\#'. It's
189 optional.
190
191 The 'm' is for music on hold. I suggest it. Otherwise, the calling
192 party gets to hear all the ringing, and lack thereof. It is generally
193 better to use Music On Hold. Lots of folks hang up after the 3rd or
194 4th ring, and you might lose the call before you can enter an option!
195
196 The 'P' option alone will database everything using the extension as a
197 default 'tree'. To get multiple extensions sharing the same database, use
198 P(some-shared-key). Also, if the same person has multiple extensions,
199 use P(unique-id) on all their dial commands.
200
201 Use little 'p' for screening. Every incoming call will include a
202 prompt for the callee's choice.
203
204 the A(beep), will generate a 'beep' that the callee will hear if they
205 choose to talk to the caller. It's kind of a prompt to let the callee
206 know that he has to say 'hi'. It's not required, but I find it
207 helpful.
208
209 When there is no CallerID, P and p options will always record an intro
210 for the incoming caller. This intro will be stored temporarily in the
211 \path{/var/lib/asterisk/sounds/priv-callerintros} dir, under the name
212 NOCALLERID\_$<$extension$>$ $<$channelname$>$ and will be erased after the
213 callee decides what to do with the call.
214
215 Of course, NOCALLERID is not stored in the database. All those with no
216 CALLERID will be considered "Unknown".
217
218 \subsection{The 'N' and 'n' options}
219
220 Two other options exist, that act as modifiers to the privacy options
221 'P' and 'p'. They are 'N' and 'n'. You can enter them as dialing
222 options, but they only affect things if P or p are also in the
223 options.
224
225 'N' says, "Only screen the call if no CallerID is present". So, if a
226 callerID were supplied, it will come straight thru to your extension.
227
228 'n' says, "Don't save any introductions". Folks will be asked to
229 supply an introduction ("At the tone, say your name") every time they
230 call. Their introductions will be removed after the callee makes a
231 choice on how to handle the call. Whether the P option or the p option
232 is used, the incoming caller will have to supply their intro every
233 time they call.
234
235
236 \subsection{Recorded Introductions}
237
238 \subsubsection{Philosophical Side Note}
239 The 'P' option stores the CALLERID in the database, along with the
240 callee's choice of actions, as a convenience to the CALLEE, whereas
241 introductions are stored and re-used for the convenience of the CALLER.
242
243 \subsubsection{Introductions}
244 Unless instructed to not save introductions (see the 'n' option above),
245 the screening modes will save the recordings of the caller's names in
246 the directory \path{/var/lib/asterisk/sounds/priv-callerintros}, if they have
247 a CallerID.  Just the 10-digit callerid numbers are used as filenames,
248 with a ".gsm" at the end.
249
250 Having these recordings around can be very useful, however...
251
252 First of all, if a callerid is supplied, and a recorded intro for that
253 number is already present, the caller is spared the inconvenience of
254 having to supply their name, which shortens their call a bit.
255
256 Next of all, these intros can be used in voicemail, played over
257 loudspeakers, and perhaps other nifty things. For instance:
258
259 \begin{astlisting}
260 \begin{verbatim}
261 exten => s,6,Set(PATH=/var/lib/asterisk/sounds/priv-callerintros)
262 exten => s,7,System(/usr/bin/play ${PATH}/${CALLERID(num)}.gsm&,0)
263 \end{verbatim}
264 \end{astlisting}
265
266 When a call comes in at the house, the above priority gets executed,
267 and the callers intro is played over the phone systems speakers. This
268 gives us a hint who is calling.
269
270 (Note: the ,0 option at the end of the System command above, is a
271 local mod I made to the System command. It forces a 0 result code to
272 be returned, whether the play command successfully completed or
273 not. Therefore, I don't have to ensure that the file exists or
274 not. While I've turned this mod into the developers, it hasn't been
275 incorporated yet. You might want to write an AGI or shell script to
276 handle it a little more intelligently)
277
278 And one other thing. You can easily supply your callers with an option
279 to listen to, and re-record their introductions. Here's what I did in
280 the home system's extensions.conf. (assume that a
281 Goto(home-introduction,s,1) exists somewhere in your main menu as an
282 option):
283
284 \begin{astlisting}
285 \begin{verbatim}
286 [home-introduction]
287 exten => s,1,Background(intro-options) ;; Script:
288      ;; To hear your Introduction, dial 1.
289      ;;    to record a new introduction, dial 2.
290      ;;    to return to the main menu, dial 3.
291      ;;    to hear what this is all about, dial 4.
292 exten => 1,1,Playback,priv-callerintros/${CALLERID(num)}
293 exten => 1,2,Goto(s,1)
294 exten => 2,1,Goto(home-introduction-record,s,1)
295 exten => 3,1,Goto(homeline,s,7)
296 exten => 4,1,Playback(intro-intro)
297      ;; Script:
298      ;; This may seem a little strange, but it really is a neat
299      ;; thing, both for you and for us. I've taped a short introduction
300      ;; for many of the folks who normally call us. Using the Caller ID
301      ;; from each incoming call, the system plays the introduction
302      ;; for that phone number over a speaker, just as the call comes in.
303      ;; This helps the folks
304      ;; here in the house more quickly determine who is calling.
305      ;; and gets the right ones to gravitate to the phone.
306      ;; You can listen to, and record a new intro for your phone number
307      ;; using this menu.
308 exten => 4,2,Goto(s,1)
309 exten => t,1,Goto(s,1)
310 exten => i,1,Background(invalid)
311 exten => i,2,Goto(s,1)
312 exten => o,1,Goto(s,1)
313
314 [home-introduction-record]
315 exten => s,1,Background(intro-record-choices)    ;; Script:
316      ;; If you want some advice about recording your
317      ;; introduction, dial 1.
318      ;; otherwise, dial 2, and introduce yourself after
319      ;; the beep.
320 exten => 1,1,Playback(intro-record)
321      ;; Your introduction should be short and sweet and crisp.
322      ;; Your introduction will be limited to 4 seconds.
323      ;; This is NOT meant to be a voice mail message, so
324      ;; please, don't say anything about why you are calling.
325      ;; After we are done making the recording, your introduction
326      ;; will be saved for playback.
327      ;; If you are the only person that would call from this number,
328      ;; please state your name.  Otherwise, state your business
329      ;; or residence name instead. For instance, if you are
330      ;; friend of the family, say, Olie McPherson, and both
331      ;; you and your kids might call here a lot, you might
332      ;; say: "This is the distinguished Olie McPherson Residence!"
333      ;; If you are the only person calling, you might say this:
334      ;; "This is the illustrious Kermit McFrog! Pick up the Phone, someone!!"
335      ;; If you are calling from a business, you might pronounce a more sedate introduction,like,
336      ;; "Fritz from McDonalds calling.", or perhaps the more original introduction:
337      ;; "John, from the Park County Morgue. You stab 'em, we slab 'em!".
338      ;; Just one caution: the kids will hear what you record every time
339      ;; you call. So watch your language!
340      ;; I will begin recording after the tone.
341      ;; When you are done, hit the # key. Gather your thoughts and get
342      ;; ready. Remember, the # key will end the recording, and play back
343      ;; your intro. Good Luck, and Thank you!"
344 exten => 1,2,Goto(2,1)
345 exten => 2,1,Background(intro-start)
346      ;;  OK, here we go! After the beep, please give your introduction.
347 exten => 2,2,Background(beep)
348 exten => 2,3,Record(priv-callerintros/${CALLERID(num)}:gsm,4)
349 exten => 2,4,Background(priv-callerintros/${CALLERID(num)})
350 exten => 2,5,Goto(home-introduction,s,1)
351 exten => t,1,Goto(s,1)
352 exten => i,1,Background(invalid)
353 exten => i,2,Goto(s,1)
354 exten => o,1,Goto(s,1)
355 \end{verbatim}
356 \end{astlisting}
357
358 In the above, you'd most likely reword the messages to your liking,
359 and maybe do more advanced things with the 'error' conditions (i,o,t priorities),
360 but I hope it conveys the idea.
361
362