-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathextensions-pngnpbx-abc-v16g.ael2
2565 lines (2249 loc) · 104 KB
/
extensions-pngnpbx-abc-v16g.ael2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/****************************************************************************
* *
* Always Be Conferencing (ABC) *
* *
* Creator: chris @ Penguin PBX Solutions *
* Version: 16g "Great Yurts Edition" *
* Release: 12 February 2020 *
* License: Creative Commons Zero v1.0 Universal (CC0 1.0) *
* *
****************************************************************************/
/*
Howdy
=====
ABC starts your Conference Bridge(s) in ASTERISK(R) by Originating calls to up
to twenty other participants, after you dial just one (configurable) number.
Your friends, trolls and/or paladins phones will immediately be notified of your
call attempts. The caller ID information they see on their SIP phones will show
them your name; number; GPS co-ordinates including elevation, depth, room or
floor number (if configured); and the remote end destination number that you
originally dialed (the DNID).
When your friends answer their phones, they will hear some short notes (A-B-C),
and then be able to talk with you. In Simple Mode, they will even be able to
talk with you *before the remote end answers*!
Also in Simple Mode, the conference will continue until all parties disconnect
-- even if the OriGinal caller (you the OG) hang up the phone before anybody
else "really" answers and starts talking!
Instead of friends, or in addition to them, if you use paladins, they will be
placed into a separate conference -- the "palace" -- all by themselves. They
won't be able to talk with you -- like your friends in the "yurt" conference
-- but they will be able to hear you and the remote end talking, and paladins
can talk to each other to help co-ordinate the local response to your call.
Related, trolls are in the yurt with you the OG caller, the remote end, and
any friends; but trolls can only listen and not speak to anyone. Also they
only get two menu options (to change their listening volume up or down.)
ABC is tested most with PJSIP on ASTERISK certified version 16.3-cert1.
It should also work okay with other channel techs (see DAHDI in Example #2.)
Non-numeric extension numbers should work, but you should test it yourself.
Really, you should test and verify everything in ABC that you intend to use!
FEATURES
========
~ Multiple notification options: Conf Call, Page, Voicemail, Email, SMS.
~ Subnet ID based Caller ID options: currently IPv4 /24-/30 networks.
~ Dynamic temporary pool call back number <-> caller ID mapping and routing.
~ DIY phone-based geolocation update support for changing GPS info via IVR.
~ Single press DTMF options to play back Dispatachable Location in-band.
~ Same DTMF options also display the DL info on the desk phone screen.
~ Optional automated playback of GPS co-ordinates to remote end upon answer.
~ Dynamic Location Routing via RFC 6442 Geolocation (with some SIP providers.)
~ Optional full call recording of each participant leg of the conference.
~ Instant (Simple Mode) or delayed (Tin Can Mode) bridging for caller.
~ Easy integration with existing ASTERISK and FreePBX(R) installations.
~ Examples included showing usage with FreePBX emergency caller ID numbers.
~ Coming Soon: Complete Ansibile-ized build on fresh Debian 10.
Quick Start mini-HOWTO for first time ABC users on FreePBX
==========================================================
1. First, SSH into your PBX, and then run the following commands:
mkdir ~/abc
cd ~/abc
wget https://raw.githubusercontent.com/chrsmj/always-be-conferencing/master/extensions-pngnpbx-abc-v16g.ael2
echo '#include "extensions-pngnpbx-abc-v16g.ael2"' > extensions.ael
echo '[from-internal-custom]' > extensions_custom.conf
echo 'exten => _123*222,1,Goto(pngnpbx-abc-demo,${EXTEN},1)' >> extensions_custom.conf
echo 'exten => _123*222*,1,Goto(pngnpbx-abc-demo,${EXTEN},1)' >> extensions_custom.conf
echo 'exten => _123*222*.,1,Goto(pngnpbx-abc-demo,${EXTEN},1)' >> extensions_custom.conf
echo 'exten => _123*222X*.,1,Goto(pngnpbx-abc-demo,${EXTEN},1)' >> extensions_custom.conf
2. Next you need to copy these new files into your Asterisk configuration.
You'll probably need to be root or use sudo to complete this next step:
sudo cp -i ~/abc/extensions* /etc/asterisk/
If there are any errors on the copying, then you should manually inspect
the files for conflicts. Most likely, the only conflict will be with the
extensions_custom.conf files. Run this command to check your existing file:
cat /etc/asterisk/extensions_custom.conf
If it is empty, then you can try the copy again, and clobber the old file:
sudo cp ~/abc/extensions_custom.conf /etc/asterisk/
If the existing file is not empty, then you will need to manually insert the
ABC "_123*222..." config lines into the existing [from-internal-custom]
context (or create the context if it does not already exist.)
3. After completing the file copying, exit SSH and open up your PBX GUI.
Issue a full PBX reload using your GUI (sometimes you have to make a small
change to get the "Apply Changes" button to appear, so make a trivial thing
like adding ABC after your name, then "Submit", then "Apply Changes".)
4. Finally, start making test calls from your desk phone, with big dial strings:
123*2223*1000*2000*3000
...replacing 1000 with an extension acting as your "remote end" operator
and replacing 2000 and 3000 with your own local "friend" extensions.
To hear your GPS co-ordinates, any participant can press * at any time
during the call. To stop the bot playback, press #.
To silence the ring-back you hear from friend's phones, but not the
remote end, you can run the following command on the Asterisk CLI:
sirius*CLI> indication add us silent 0/15000
Note this mini-HOWTO assumes all phones are using the same channel technology
(preferably chan_PJSIP but legacy chan_SIP should also work, and maybe others.)
PREREQ: The ASTERISK Extension Language (AEL)
=============================================
This is not your standard dial plan "/etc/asterisk/extensions.conf" file!
ABC is configured in the ASTERISK Extension Language (AEL). AEL syntax is
converted into standard CONF file format when loaded in to system memory
by Asterisk. But you should not need to edit this ABC AEL file very often,
if ever. It only needs to be *included* into your dialplan.
Please copy this file into your "/etc/asterisk/" directory and set it to
read-only permission for the user/group your Asterisk process runs as (usually
"root" or "asterisk".)
To confirm you have AEL working in your version of Asterisk, you can run this
command on the Asterisk CLI:
sirius*CLI> core show help ael
...which, if loaded properly, should list "ael reload" and "ael set debug".
Otherwise, if this is your first time using AEL, then you may need to manually
load the module, or take other steps. This may include rebuilding from source
code eg. selecting the AEL module when using "make menuconfig".
After confirming AEL is active and working, edit (or create) this file:
/etc/asterisk/extensions.ael
And add this line (with no spaces at the front):
#include "extensions-pngnpbx-abc-v16g.ael2"
...then save the file. Now you should be able to load the AEL config and view
the in-memory dial plan in CONF format:
sirius*CLI> ael reload
sirius*CLI> dialplan show pngnpbx-abc-dial
If that works, and you see a bunch of dial plan looking output, Congratulations!
You are now able to use ABC from standard dial plan in "extensions.conf" file
-- or in the "extensions_custom.conf" file if you are using FreePBX.
Tin Can Mode
============
If you choose this mode, then ABC will use Dial() instead of Originate() at the
start of the call to the remote end. This is to help satisfy requirements in
some situations where it is deemed desirable to only route the call and not
answer the caller via immediate bridging. This works by adding a ChanSpy() on
the caller.
Tin Can Mode WARNING
====================
There are several potential shortcomings in Tin Can mode compared to Simple
Mode, including the following caveats:
0. In Simple Mode, everyone can always talk to each other.
In Tin Can Mode, caller cannot talk to friends until remote end answers.
But, friends can talk to each other, hear your GPS with * key, etc.
1. In Simple Mode, everyone always gets access to DTMF menu options, because
they are always in the conference.
2. In Tin Can Mode, callers will not get access to DTMF menu options until the
remote end answers. Then, everyone will get access, same as Simple Mode.
3. In Tin Can Mode, there may be a few more frames of feedback immediately
after the remote end answers. (TODO: Fix this in a future release.)
4. In Tin Can Mode ONLY, when caller hangs up before remote end answers, then
the call will drop. (TODO: Fix this in a future release.)
DTMF WARNING
============
DTMF pass through does not work. DTMF is restricted to menu options.
You can send YES DEAR if you press 9.
PRIVACY WARNING
===============
The handling of exact GPS co-ordinates of each phone presents multiple safety,
security, and privacy concerns. (See RFCs 3693, 6280, 6442 and 6772.)
ABC offers support for 5 out of 6 basic Geopriv roles introduced in RFC3693
and later refined in RFC6280 Section 3.2, to wit:
1. Target: ABC can be the Target, or Targets can be User-based or Device-based.
2. Device: ABC can be the Device, but more commonly it will be your SIP phone.
3. Rule Maker: ABC provides RM functions. (See Conference Bridge DTMF options.)
4. Location Generator: ABC can be the LG. (See DIY GPS IVR for users/admins.)
5. Location Server: ABC can perform LS. (See encrypted internal AstDB storage.)
6. Location Recipient: ABC does not (currently) fulfill the LR role.
With ABC as your LS, your personal location data is not *pre-registered* with
any 3rd-party remote/hosted/cloud/government/etc. services in large centralized
databases, with all of the associated privacy and data safety issues that can
entail. But new regulations, such as those covering finer refinements in 911
dispatchable location relay, threaten to dramatically increase the size and
scope of these centralized LS databases, opening up previously unknown employee
whereabouts to 'manual ALI query' and other attacks in the future.
In the author's opinion, too many SIP providers are complying with changing
regulatory requirements by (un)intentionally sacrificing liberty in exchange
for safety, acting as the LS when that is wholly un-necessary. While not
exactly *security theater*, the choice between exposing personal information
outside of your PBX/MLTS only at the time of an emergency vs. storing it all
of the time with the telephone company is not to be taken lightly if you value
the privacy of your users.
ABC takes a more dynamic approach (Dynamic Location Routing) instead of the
old registered address system. ABC only releases your location details
from the local PBX system when it is needed. Until then, ABC can store your data
at rest in encrypted format on the local Asterisk system's internal database
(AstDB) using a separate key file. This prevents bulk dumping of clear text data
via Asterisk CLI commands like "database show".
By default, the key is located on the filesystem in the /var/lib/asterisk/keys/
directory. When you automate backup processes, then you may want to consider
changing these slightly, for example, to not include the AstDB in directory
/var/lib/asterisk/ with /var/lib/asterisk/keys/ directory in the same tarball.
(That would be like hiding the key under the door mat.)
Or, you might consider changing the location of the default key file used for
GPS data encryption (TODO: make this easier in a future ABC revision.)
However, should you lose the key file, then users will need to manually
re-update their GPS XYZ co-ordinates, using the included IVR as the LG. Until
they do, the PBX will not know where they are, and it will fail when trying to
do things like send those co-ordinates to the remote end LR.
Steps to (re)create the key file:
sudo mkdir /var/lib/asterisk/keys
sudo touch /var/lib/asterisk/keys/pngnpbx-abc-key.txt
sudo chown asterisk.asterisk /var/lib/asterisk/keys/pngnpbx-abc-key.txt
Feel free to store 16 random alpha-numeric characters in that file,
otherwise, a somewhat random string will be used.
LOGGING
=======
Call Detail Records will be saved in files based on whatever ABC type name
you specify ie. the account code will be set to this name on (almost) all
channels. In the examples (below) it would be "abctest.csv" in the same
directory as your "Master.csv" (assuming you are using CSV for CDRs.)
Optionally you can record the call (see example #2 below).
Look for the recordings in "/var/spool/asterisk/monitor/" directory.
The ABC type name will be used to prefix the files (one file per leg.)
CAREFUL when recording eg. legal issues, drive space, privacy, etc.
EXAMPLES
========
YOU MUST CHANGE #YOUR-TRUNK-s#, the "ABCTO" number, the extension numbers, and
choose valid Call-Back numbers, whenever copy-pasta'ing these examples !!!
But please feel free to copy the next 340 lines directly into your dial plan...
;
; Example #1: Simple Mode
; -----------------------
; * PJSIP channel driver.
; * One remote end.
; * One friend to bridge in.
; * One static call back number.
; * Remapping of 922 -> 933 for testing SIP provider address verification.
[from-internal-custom-abc-example-1]
exten => 922,1,NoOp() ; Choose your own extension numbers.
exten => 922,n,NoOp(placeholder) ; TBD
exten => 922,n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com) ; Please copy and change as you wish!
exten => 922,n,Set(ABCTO=933) ; CHANGE ME! Remapping of the dial to another number (if any.)
exten => 922,n,Set(path=PJSIP/${ABCTO}@#YOUR-TRUNK#) ; CHANGE ME! Endpoint section defined in your PJSIP configuration.
exten => 922,n,Set(callback=3035557729) ; CHANGE ME! Your call-back telephone number (probably 10 digits in the USA.)
exten => 922,n,Set(friend=PJSIP/1113) ; CHANGE ME! The local PJSIP endpoint to bridge into the call.
exten => 922,n,Set(abctypename=abctest) ; CHANGE ME! Use abctest as the conf type name.
exten => 922,n,Set(ringtime=120) ; MAYBE CHANGE ME! Rings remote end / path for 2 minutes.
exten => 922,n,AELSub(pngnpbx-abc-simple,${abctypename}) ; Simple setup. (Either "abc-simple", "abc-init" or "abc-tincan" must be first.)
exten => 922,n,AELSub(pngnpbx-abc-path,1,${ringtime},${path}) ; Set the first (and only) call path to use on call to remote end.
exten => 922,n,AELSub(pngnpbx-abc-remote,${callback},static) ; Originate out the path/trunk using your call-back number as the Caller ID number.
exten => 922,n,AELSub(pngnpbx-abc-friend,1,${friend}) ; Bridge in the other attendee automatically.
exten => 922,n,AELSub(pngnpbx-abc-howdy-yall) ; Enter the conference. No more dial plan processing occurs for caller in your CONF file.
;
; Example #2: Using members of Super Awesome Company
; --------------------------------------------------
; * Adds multiple remote paths.
; * Adds call recording.
; * Adds geolocation.
; * Adds additional friend phones.
; * Adds all 15 extension numbers 1101-1115 from basic-pbx sample
; pjsip.conf file as found in Asterisk certified version 16.3-cert1
; from Dec 2019.
[from-internal-custom-abc-example-2]
exten = 922,1,NoOp()
same = n,NoOp(placeholder)
same = n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com) ; Please copy and change as you wish!
same = n,Set(ABCTO=933) ; CHANGE ME! Remapping of the dial to another number (if any.)
same = n,Set(gpsurl=https://abc.penguinpbx.com/loc/) ; CHANGE ME! URL that will be included in Geolocation SIP header.
same = n,Set(path1=DAHDI/#YOUR-TRUNK-1#/${ABCTO}) ; CHANGE ME! Endpoint section defined in your DAHDI(R) configuration.
same = n,Set(path2=PJSIP/${ABCTO}@#YOUR-TRUNK-2#) ; CHANGE ME! A PJSIP endpoint section - used if first path is down/unreachable.
same = n,Set(path3=PJSIP/${ABCTO}@#YOUR-TRUNK-3#) ; CHANGE ME! Yet another endpoint section defined in your PJSIP configuration.
same = n,AELSub(pngnpbx-abc-init,abctest,record,3600,,announce,) ; Use abctest as the conf type name, save WAVs, limit to 1 hour, and announce GPS.
same = n,AELSub(pngnpbx-abc-path,1,10,${path1}) ; Set the first call path / trunk name to use on call to remote end. Ring 10 seconds.
same = n,AELSub(pngnpbx-abc-path,2,60,${path2}) ; Set the second call path - used only on failover of first call path. Ring 1 minute.
same = n,AELSub(pngnpbx-abc-path,3,300,${path3}) ; Set the third call path - used only on failover of second call path. Ring 5 minutes.
same = n,NoOp(About to change flow based on caller ID number.)
same = n,Set(cleancid=${FILTER(a-zA-Z0-9,${CALLERID(num)})})
same = n,Set(gotdp=${DIALPLAN_EXISTS(${CONTEXT},${EXTEN},x${cleancid})})
same = n,GotoIf($[${gotdp}]?x${cleancid})
; C-Level
; These two phones are in the same 10m square open area.
same = n(x1107),NoOp()
same = n(x1111),NoOp()
same = n,AELSub(pngnpbx-abc-gps,39.739,-104.990,5280,feet,${gpsurl}) ; Set Geolocation SIP header to URL and GPS co-ordinates #1.
same = n,AELSub(pngnpbx-abc-sa,144 W Colfax Ave,Denver,CO,80202) ; Street Address, city name, state abbreviation, zip code
same = n,AELSub(pngnpbx-abc-ai,W side of Park) ; Additional Information. SA + AI = Dispatchable Location
same = n,AELSub(pngnpbx-abc-remote,3035557729,static) ; Originate out the trunk(s).
same = n,Goto(friends)
; Customer Experience - Picnic Shelter 4
; These four other phones are in another 10m square open area.
; With Different Additional Information. SA + AI = Dispatchable Location
same = n(x1101),NoOp()
same = n(x1102),NoOp()
same = n(x1115),NoOp()
same = n,AELSub(pngnpbx-abc-gps,39.739,-104.990,5280,feet,${gpsurl})
same = n,AELSub(pngnpbx-abc-sa,144 W Colfax Ave,Denver,CO,80202)
same = n,AELSub(pngnpbx-abc-ai,Picnic Shelter 4)
same = n,AELSub(pngnpbx-abc-remote,3035557729,static)
same = n,Goto(friends)
; Park Gazebo for Software Engineers
same = n(x1110),NoOp()
same = n(x1104),NoOp()
same = n(x1113),NoOp()
same = n(x1114),NoOp()
same = n,AELSub(pngnpbx-abc-gps,39.739,-104.990,5280,feet,${gpsurl})
same = n,AELSub(pngnpbx-abc-sa,144 W Colfax Ave,Denver,CO,80202)
same = n,AELSub(pngnpbx-abc-ai,Gazebo)
same = n,AELSub(pngnpbx-abc-remote,3035557729,static)
same = n,Goto(friends)
; Directors and all others sit together in the Ampitheater
same = n(x1103),NoOp()
same = n(x1106),NoOp()
same = n(x1108),NoOp()
same = n,AELSub(pngnpbx-abc-gps,39.739,-104.990,5280,feet,${gpsurl})
same = n,AELSub(pngnpbx-abc-sa,144 W Colfax Ave,Denver,CO,80202)
same = n,AELSub(pngnpbx-abc-ai,Ampitheater)
same = n,AELSub(pngnpbx-abc-remote,3035557729,static)
same = n,Goto(friends)
; Remote office location in the Mountains for Sales
same = n(x1105),NoOp()
same = n(x1109),NoOp()
same = n(x1112),NoOp()
same = n,AELSub(pngnpbx-abc-gps,39.588,-105.644,4350,meters,${gpsurl}) ; Set Geolocation SIP header to URL and GPS co-ordinates #2.
same = n,AELSub(pngnpbx-abc-sa,Mount Evans Ridge,Idaho Springs,CO,80452) ; Street Address, city name, state abbreviation, zip Code
same = n,AELSub(pngnpbx-abc-ai,Floor 42) ; Additional Information. SA + AI = Dispatchable Location
same = n,AELSub(pngnpbx-abc-remote,7205557729,static) ; Originate out the trunk(s) using a different call-back number as the Caller ID number.
same = n,Goto(friends)
same = n(friends),NoOp()
same = n,Log(VERBOSE,Remote dial started. Now adding friends to call.) ; Most critical is the remote call.
same = n,AELSub(pngnpbx-abc-friend,1,PJSIP/1113) ; Bridge in friend.
same = n,AELSub(pngnpbx-abc-friend,2,PJSIP/1111) ; Bridge in another friend.
same = n,AELSub(pngnpbx-abc-friend,3,PJSIP/1109) ; Bridge in yet another friend. (Up to 20 total participants by default.)
same = n,AELSub(pngnpbx-abc-howdy-yall) ; Enter the conference. No more dial plan processing occurs for caller.
;
; Example #3: Dynamic call back numbers for phones without DIDs
; -------------------------------------------------------------
; * Needs two contexts.
; * Adds nine Dynamic Call Back numbers.
; * Adds local call back option with 922*EXTENSION
; * Requires call backs be registered before first use
; by dialing 123*2220*NUMBER
[from-external-custom-abc-example-3]
exten = 3035551111,1,AELSub(pngnpbx-abc-reentry,1,${EXTEN},${abclo}) ; Place the dynamic call back DIDs here, one per line (copy/paste/edit.)
exten = 3035552222,1,AELSub(pngnpbx-abc-reentry,2,${EXTEN},${abclo}) ; Do not change anything except for the phone numbers and position number.
exten = 3035553333,1,AELSub(pngnpbx-abc-reentry,3,${EXTEN},${abclo}) ; You should not provision these DIDs anywhere else in your PBX.
exten = 3035554444,1,AELSub(pngnpbx-abc-reentry,4,${EXTEN},${abclo}) ; This is particularly useful for waiting area phones without call back numbers.
exten = 3035555555,1,AELSub(pngnpbx-abc-reentry,5,${EXTEN},${abclo}) ; The abclo variable is for loading new call backs into internal AstDB.
exten = 3035556666,1,AELSub(pngnpbx-abc-reentry,6,${EXTEN},${abclo})
exten = 3035557777,1,AELSub(pngnpbx-abc-reentry,7,${EXTEN},${abclo})
exten = 3035558888,1,AELSub(pngnpbx-abc-reentry,8,${EXTEN},${abclo})
exten = 3035559999,1,AELSub(pngnpbx-abc-reentry,9,${EXTEN},${abclo})
[from-internal-custom-abc-example-3]
exten = 922,1,NoOp()
same = n,NoOp(placeholder)
same = n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com) ; Please copy and change as you wish!
same = n,Set(ABCTO=933) ; CHANGE ME! Remapping of the dial to another number (if any.)
same = n,Set(path=PJSIP/${ABCTO}@#YOUR-TRUNK#) ; CHANGE ME! Endpoint section defined in your PJSIP configuration.
same = n,Set(defaultcallback=3035550000) ; CHANGE ME! Default call back number used if dynamic allocation fails.
same = n,Set(friend=PJSIP/1113) ; CHANGE ME! The local PJSIP endpoint to bridge into the call.
same = n,Set(abctypename=abctest) ; CHANGE ME! Use abctest as the conf type name.
same = n,Set(ringtime=120) ; MAYBE CHANGE ME! Rings remote end / path for 2 minutes.
same = n,AELSub(pngnpbx-abc-simple,${abctypename}) ; Simple setup. (Either "abc-simple", "abc-init" or "abc-tincan" must be first.)
same = n,AELSub(pngnpbx-abc-path,1,${ringtime},${path}) ; Set the first (and only) call path to use on call to remote end.
same = n,AELSub(pngnpbx-abc-remote,${defaultcallback},dynamic) ; Originate out the path/trunk using a dynamic call-back number as the Caller ID number.
same = n,AELSub(pngnpbx-abc-friend,1,${friend}) ; Bridge in the other attendee automatically.
same = n,AELSub(pngnpbx-abc-howdy-yall) ; Enter the conference. No more dial plan processing occurs for caller.
exten = _922*XXXX,1,NoOp(get back to conf locally) ; Useful if a friend falls off the wagon. They can get back on the bridge themselves.
exten = _922*XXXX/1113,n,NoOp() ; Check if they are your friend. Based on caller ID number.
exten = _922*XXXX/1107,s,NoOp() ; Didn't try to automatically bridge this friend but let them join later manually.
exten = _922*XXXX/1111,s,NoOp() ; Didn't try to automatically bridge this friend but let them join later manually.
exten = _922*XXXX/1103,s,NoOp() ; Didn't try to automatically bridge this friend but let them join later manually.
exten = _922*XXXX/1106,s,NoOp() ; Didn't try to automatically bridge this friend but let them join later manually.
exten = _922*XXXX,s,Hangup() ; No non-friends allowed.
exten = _922*XXXX,n,NoOp()
same = n,Set(abcconfid=${FILTER(a-zA-Z0-9,${EXTEN:4})})
same = n,Goto(pngnpbx-abc-bridge,${abcconfid},1)
exten = _123*2220*NXXNXXXXXX,1,NoOp(number loading) ; Dial this each time you change dynamic call back DIDs.
same = n,Set(abclo=yes) ; Or you could manually insert entries into AstDB.
same = n,Set(did=${CUT(EXTEN,*,2)}) ; But doing it this way on the phone is probably easier.
same = n,Goto(from-external-custom-abc-example-3,${did},1) ; Also it re-uses the other context so no double-typing of DIDs!
;
; Example #4: Tin Can Mode
; ------------------------
; * Using "Tin Can" mode for Dial to remote instead of Originate.
; * Please see "Tin Can Mode WARNING" near the top of this file.
[from-internal-custom-abc-example-4]
exten = 922,1,NoOp()
same = n,NoOp(placeholder)
same = n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com) ; Please copy and change as you wish!
same = n,Set(ABCTO=933) ; CHANGE ME! Remapping of the dial to another number (if any.)
same = n,Set(ABCTRUNK=#YOUR-TRUNK#) ; CHANGE ME! Remapping of the dial to another number (if any.)
same = n,Set(ABCPATH=PJSIP/${ABCTO}@${ABCTRUNK}) ; CHANGE ME! Endpoint section defined in your PJSIP configuration.
same = n,Set(ABCCALLBACK=3035550000) ; CHANGE ME! Default call back number used if dynamic allocation fails.
same = n,Set(ABCFRIEND=PJSIP/1113) ; CHANGE ME! The local PJSIP endpoint to bridge into the call.
same = n,Set(ABCTYPENAME=abcex4) ; CHANGE ME! Use abcex4 as the conf type name.
same = n,Set(ABCRINGTIME=120) ; MAYBE CHANGE ME! Rings remote end / path for 2 minutes.
same = n,AELSub(pngnpbx-abc-tincan,${ABCTYPENAME}) ; Tin Can mode. Uses Dial instead of Originate to the remote.
same = n,AELSub(pngnpbx-abc-path,1,${ABCRINGTIME},${ABCPATH}) ; Set the first (and only) call path to use on call to remote end.
same = n,AELSub(pngnpbx-abc-remote,${ABCCALLBACK},static) ; In Tin Can mode, this spawns Originate to a ChanSpy dummy not the remote end.
same = n,AELSub(pngnpbx-abc-friend,1,${ABCFRIEND}) ; Bridge in the other attendee automatically.
same = n,AELSub(pngnpbx-abc-howdy-yall) ; In Tin Can mode, this dials the remote and then enters the conference after they answer.
; IT DOES NOT IMMEDIATELY PUT THE CALLER INTO THE CONFERENCE BRIDGE.
; IT USES A STANDARD DIAL() TO DIRECTLY ROUTE TO THE REMOTE END.
; IF THE CALLER HANGS UP BEFORE THE REMOTE END ANSWERS IT WILL DROP ON BOTH SIDES.
;
; Example #5: More advanced FreePBX integration
; ---------------------------------------------
; * In Tin Can Mode (Again)
; * Integrates with FreePBX per-device emergency_cid numbers.
; * Copy this context into your /etc/asterisk/extensions_custom.conf file.
; * Just fill in the #XYZ# variables once for your entire system.
; * Then, create a new Custom Destination in FreePBX to point to:
; from-internal-custom-abc-example-5,s,1
; * Finally, create a new Misc Application in FreePBX to point an
; extension number to the new Custom Destination eg. 933
; * This example uses legacy chan_SIP instead of newer chan_PJSIP
;
[from-internal-custom-abc-example-5]
exten => s,1,NoOp()
exten => s,n,NoOp(placeholder)
exten => s,n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com)
exten => s,n,Set(cidnum=${FILTER(0-9A-Za-z,${CALLERID(num)})})
exten => s,n,Set(callback=${DB(DEVICE/${cidnum}/emergency_cid)})
exten => s,n,Set(ABCTO=${CALLERID(DNID)})
exten => s,n,Set(path1=SIP/${ABCTO}@#SIPTRUNK-1#)
exten => s,n,Set(path2=SIP/${ABCTO}@#SIPTRUNK-2#)
exten => s,n,Set(path3=SIP/${ABCTO}@#SIPTRUNK-3#)
exten => s,n,Set(friend1=SIP/#SECURITY-EXTENSION#)
exten => s,n,Set(friend2=SIP/#ERDOCTOR-EXTENSION#)
exten => s,n,Set(vmail1=#FRONTDESK-EXTENSION#@default)
exten => s,n,Set(vmail2=#ITDIRECTOR-EXTENSION#@default)
exten => s,n,Set(abctypename=amp)
exten => s,n,Set(ringtime=120)
exten => s,n,Set(vmsecs=3) ; make sure it exceeds minmessage!
exten => s,n,AELSub(pngnpbx-abc-tincan,${abctypename})
exten => s,n,AELSub(pngnpbx-abc-path,1,${ringtime},${path1})
exten => s,n,AELSub(pngnpbx-abc-path,2,${ringtime},${path2})
exten => s,n,AELSub(pngnpbx-abc-path,3,${ringtime},${path3})
exten => s,n,AELSub(pngnpbx-abc-remote,${callback},static)
exten => s,n,AELSub(pngnpbx-abc-friend,1,${friend})
exten => s,n,AELSub(pngnpbx-abc-friend,2,${friend})
exten => s,n,AELSub(pngnpbx-abc-vmail,${vmail1},${vmsecs});
exten => s,n,AELSub(pngnpbx-abc-vmail,${vmail2},${vmsecs});
exten => s,n,AELSub(pngnpbx-abc-howdy-yall)
;
; Example #6: No Friends just Paladins
; ------------------------------------
; * In Tin Can Mode (Again)
; * Integrates with FreePBX per-device emergency_cid numbers.
; * Creates separate conference for paladins to discuss amongst themselves.
; * Runs parallel to the existing call/conf from OG caller to remote end.
; * Does not allow paladins to interfere in call from OG caller to remote end.
; * Only feeds in audio to paladins when remote end answers the OG caller.
[from-internal-custom-abc-example-6]
exten => s,1,NoOp()
exten => s,n,NoOp(placeholder)
exten => s,n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com)
exten => s,n,Set(cidnum=${FILTER(0-9A-Za-z,${CALLERID(num)})})
exten => s,n,Set(callback=${DB(DEVICE/${cidnum}/emergency_cid)})
exten => s,n,Set(ABCTO=${CALLERID(DNID)})
exten => s,n,Set(path=SIP/${ABCTO}@#SIPTRUNK#)
exten => s,n,Set(pal1=SIP/#SHAMAN-EXTENSION#)
exten => s,n,Set(pal2=SIP/#MENTALHEALTH-EXTENSION#)
exten => s,n,Set(abctypename=amppal)
exten => s,n,Set(ringtime=120)
exten => s,n,AELSub(pngnpbx-abc-tincan,${abctypename})
exten => s,n,AELSub(pngnpbx-abc-path,1,${ringtime},${path})
exten => s,n,AELSub(pngnpbx-abc-remote,${callback},static)
exten => s,n,AELSub(pngnpbx-abc-paladin,1,${pal1})
exten => s,n,AELSub(pngnpbx-abc-paladin,2,${pal2})
exten => s,n,AELSub(pngnpbx-abc-howdy-yall)
;
; Example #7: Set outbound Caller ID number based on Subnet ID number
; -------------------------------------------------------------------
; * In Tin Can Mode (Yes, Again)
; * Paladins only.
; * Choose caller ID based on subnet ID - requires new AstDB entries eg...
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.1.0 24 3035551234
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.2.0 24 3035552222
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.3.240 30 3035553333
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.3.244 30 3035554444
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.3.248 30 3035555555
; sirius*CLI> database put pngnpbx/abc/sbntcid/192.168.4.128 28 7205550000
; * The smallest subnet found is used first (so /30 before /29, down to /24).
; * Defaults to FreePBX emergency CID if no subnet override CID is found.
[from-internal-custom-abc-example-7]
exten => s,1,NoOp()
exten => s,n,NoOp(placeholder)
exten => s,n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com)
exten => s,n,Set(cidnum=${FILTER(0-9A-Za-z,${CALLERID(num)})})
exten => s,n,Set(defaultcallback=${DB(DEVICE/${cidnum}/emergency_cid)})
exten => s,n,Set(ABCTO=${CALLERID(DNID)})
exten => s,n,Set(path=SIP/${ABCTO}@#SIPTRUNK#)
exten => s,n,Set(pal1=SIP/#FRONTDESK-EXTENSION#)
exten => s,n,Set(pal2=SIP/#SECURITY-EXTENSION#)
exten => s,n,Set(abctypename=sbntpal)
exten => s,n,Set(pathringtime=120)
exten => s,n,AELSub(pngnpbx-abc-tincan,${abctypename})
exten => s,n,AELSub(pngnpbx-abc-path,1,${pathringtime},${path})
exten => s,n,AELSub(pngnpbx-abc-remote,${defaultcallback},subnet)
exten => s,n,AELSub(pngnpbx-abc-paladin,1,${pal1})
exten => s,n,AELSub(pngnpbx-abc-paladin,2,${pal2})
exten => s,n,AELSub(pngnpbx-abc-howdy-yall)
;
; Example #8: Trolls auto-answer in half-duplex AKA "Page Group"
; --------------------------------------------------------------
; * In Tin Can Mode (Yes, Again)
; * Trolls only. They can not talk to anyone in the YURT.
; * Add "nosy" to troll if they should listen to call.
; (Without "nosy" option they will just hear an announcement.)
; * Choose caller ID based on subnet ID.
; * Defaults to FreePBX emergency CID if no subnet override CID is found.
[from-internal-custom-abc-example-8]
exten => s,1,NoOp()
exten => s,n,NoOp(placeholder)
exten => s,n,Log(VERBOSE,Always Be Conferencing - PenguinPBX.com)
exten => s,n,Set(cidnum=${FILTER(0-9A-Za-z,${CALLERID(num)})})
exten => s,n,Set(defaultcallback=${DB(DEVICE/${cidnum}/emergency_cid)})
exten => s,n,Set(ABCTO=${CALLERID(DNID)})
exten => s,n,Set(path=SIP/${ABCTO}@#SIPTRUNK#)
exten => s,n,Set(troll1=SIP/#FRONTDESK-EXTENSION#)
exten => s,n,Set(troll2=SIP/#OVERHEADSPKR-EXTENSION#)
exten => s,n,Set(abctypename=sbnttrl)
exten => s,n,Set(pathringtime=120)
exten => s,n,AELSub(pngnpbx-abc-tincan,${abctypename})
exten => s,n,AELSub(pngnpbx-abc-path,1,${pathringtime},${path})
exten => s,n,AELSub(pngnpbx-abc-remote,${defaultcallback},subnet)
exten => s,n,AELSub(pngnpbx-abc-troll,1,${troll1},nosy)
exten => s,n,AELSub(pngnpbx-abc-troll,2,${troll2},)
exten => s,n,AELSub(pngnpbx-abc-howdy-yall)
; End of Examples sub-section
Frequently Asked Questions (FAQs)
=================================
Question:
What are the conference menu options ?
Answer:
* YOU ARE HERE! Speaks GPS co-ordinates of the caller into the conference.
0 Operator (TODO: Play back all of the menu options. Just to your phone.)
1 (empty) (TODO: Might be option to pass DTMF through and/or mute/unmute)
2 "A"dditional information (eg. Room Number) is spoken into the conference.
3 "D"ecrease listening volume - only on your phone.
4 "I"ncrease listening volume - only on your phone.
5 "L"ocal extension number is spoken into the conference.
6 "N"umber to call back and reach the caller is spoken into the conference.
7 "S"treet address and additional info of caller spoken into the conference.
8 (TODO: "T"elephone - redial remote end - only for OG caller.)
9 "Y"es - Sends audio "yes dear" eg. when asked yes/no question by operator.
# Hash - "H"alts any automated message playbacks.
Question:
Who is in the "yurt" vs. the "palace" conference rooms ?
Answer:
The "yurt" is for OG caller, remote end LR, and friends (if any.)
The "palace" is for the paladins (if any.) Palaces can read audio from yurt
streams but not write back to them. Paladins can still access DTMF menu
options and talk to other paladins. They just can't talk to OG caller,
remote end LR, or any of the OG caller's friends.
Question:
Can I integrate ABC with FreePBX ?
Answer:
Yes, there are several examples which highlight this. But ABC needs to
take over the call flow very early on. It will probably not work from
something like a predial macro hook. Instead, use [from-internal-custom]
context inclusion methods; or Custom Destination & Misc Application.
Question:
Why do I hear ring back tone until the friend(s) pick up and answer ?
Answer:
You'll need to add a new line to indications.conf for each tone zone
you offer to your users in order to produce a 'silent' ringer.
(...scroll down to find the section...)
[us]
description = United States / North America
silent = 0/15000
(...the rest of the tones...)
...but to avoid a restart, for testing, on the Asterisk CLI, you can do:
sirius*CLI> indication add us silent 0/15000
Question:
Why use 922 as the example extension that users will dial to reach 933 ?
Answer:
It is currently only used for the police in Tonga. And it might help
users distinguish between competing providers of different brands of
operator services at the remote end. Any 9XX number in the following
ranges should be good to test with in most countries:
901-910
914-918
920-932
934-976
978-989
Please consult your local numbering plan rules before making changes.
Question:
Wait, could ABC be used to help open up free market competition with
existing emergency operator service monopolies in given geographic areas,
without pre-loading private personal GPS address information for every
telecommuter in the USA up in to massive centralized databases of
dispatchable location directions to the nation's critical infrastructure ?
Answer:
Maybe but that is currently beyond the scope of this technical document.
Thank you for reading!
This long descriptive AEL comment ends right here at the splat slash. */
/****************************************************************************
* BEGIN PUBLIC SECTION *
* This section contains macros and contexts that should be entered from *
* somewhere outside of this file. *
****************************************************************************/
/* PUBLIC */
/* Either "simple", "tincan" or "init" macro needs to be entered first,
* from somewhere outside of this file, in order to activate the conf room. */
macro pngnpbx-abc-simple(type_) {
&pngnpbx-abc-init(${type_},,,,,);
return;
}
/* PUBLIC */
/* SMH but IANAL */
macro pngnpbx-abc-tincan(type_) {
&pngnpbx-abc-init(${type_},,,,,tincan);
return;
}
/* PUBLIC */
/* The "init" macro (re)sets up several things for the conference room. */
macro pngnpbx-abc-init(type_,record_,conftimeout_,abcid_,announce_,tincan_) {
Set(LOCAL(startstamp)=${STRFTIME(,UTC,%F %H:%M:%S.%3q)} UTC);
local cnftmt=;
DumpChan(5);
if( ${LEN(${type_})} > 0 ) {
Set(pngnpbx_abc_type=${type_});
} else {
Set(pngnpbx_abc_type=default);
}
Set(CHANNEL(accountcode)=${pngnpbx_abc_type});
if( ${LEN(${abcid_})} > 0 ) {
Set(pngnpbx_abc_id=${FILTER(a-zA-Z0-9,${abcid_})});
} else {
// This default only works if each phone has a unique caller ID number.
// Otherwise, you'll need to specify your own conference ID number.
// (But if your extensions have matching numbers... please just stop.)
Set(pngnpbx_abc_id=${FILTER(a-zA-Z0-9,${CALLERID(num)})});
}
Set(cnftmt=${FILTER(0-9,${conftimeout_})});
if( ${LEN(${cnftmt})} == 0 ) {
Set(cnftmt=14400);
}
// TODO: Check if the conference is already/still running.
DBdeltree(pngnpbx/abc/cb/${pngnpbx_abc_id});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/init)=${startstamp});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/ogchan)=${CHANNEL(name)});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/type)=${pngnpbx_abc_type});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/cidnum)=${CALLERID(num)});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/cidname)=${CALLERID(name)});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/dnid)=${CALLERID(DNID)});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/conftimeout)=${cnftmt});
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/yurt/ttsactive)=0);
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/palace/ttsactive)=0);
if( "x${TOLOWER(${record_})}" == "xrecord" ) {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/record)=yes);
} else {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/record)=no);
}
if( "x${TOLOWER(${announce_})}" == "xannounce" ) {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/announce)=yes);
} else {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/announce)=no);
}
if( "x${TOLOWER(${tincan_})}" == "xtincan" ) {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/tincan)=yes);
} else {
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/tincan)=no);
}
return;
}
/* PUBLIC */
/* The "remote" macro should be entered once per conference.
* It is (arguably) the most important destination and (probably) what the user
* originally dialed. */
macro pngnpbx-abc-remote(cidnum_,usedynamiccid_) {
local gotdyno=no;
local gotsbnt=no;
local maybedid=;
local maybecid=;
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(LOCAL(mytincan)=${DB(${dbcb}/${pngnpbx_abc_id}/tincan)});
Set(LOCAL(pvt)=Local/${pngnpbx_abc_id}@pngnpbx-abc-bridge);
if( "x${TOLOWER(${usedynamiccid_})}" == "xdynamic" ) {
// TODO: Use LOCK function with Dynamic CID-DID.
for( i=1; ${i} <= 9; i=${i} + 1 ) {
Set(maybedid=${DB(pngnpbx/abc/dynodid/callback/${i})});
if( ${LEN(${maybedid})} > 0 ) {
Set(LOCAL(dbdyno)=pngnpbx/abc/dynodid);
Set(LOCAL(og)=${DB(${dbdyno}/ogcaller/${maybedid})});
Set(LOCAL(lastcall)=${DB(${dbdyno}/lastcall/${maybedid})});
Set(LOCAL(difftime)=$[${EPOCH}-${lastcall}]);
if( ${LEN(${og})} == 0 || ${difftime} >= 3600 ) {
Set(LOCAL(ognow)=${DB(${dbcb}/${pngnpbx_abc_id}/cidnum)});
Set(DB(${dbdyno}/lastcall/${maybedid})=${EPOCH});
Set(DB(${dbdyno}/ogcaller/${maybedid})=${ognow});
Set(gotdyno=yes);
break;
}
}
}
if( "x${gotdyno}" == "xno" ) {
Verbose(2,Dynamic CID-DID allocation based on pool failed. Using default.);
maybedid=${cidnum_};
}
} else if( "x${TOLOWER(${usedynamiccid_})}" == "xsubnet" ) {
// Only works if phone is directly contacting this PBX.
// TODO: test proxy situations
Set(LOCAL(frmipport)=${CHANNEL(pjsip,remote_addr)});
Set(LOCAL(ipx)=${CUT(frmipport,:,1)});
Set(LOCAL(ddd)=${CUT(ipx,.,4)});
Set(LOCAL(frmslash24)=${CUT(ipx,.,1-3)});
Set(LOCAL(p)=1);
Set(LOCAL(q)=);
Set(LOCAL(r)=);
Set(LOCAL(s)=);
Set(LOCAL(t)=);
// consider the most specific network first
for( s=30; ${s} >= 24; s=${s} - 1 ) {
q=${MATH(2^${INC(p)},i)};
r=${MATH(${ddd}%${q},i)};
t=${MATH(${ddd}-${r},i)};
Set(maybecid=${DB(pngnpbx/abc/sbntcid/${frmslash24}.${t}/${s})});
if( ${LEN(${maybecid})} > 0 ) {
Set(gotsbnt=yes);
break;
}
}
if( "x${gotsbnt}" == "xno" ) {
// Dynamic CID allocation based on subnet failed.
Verbose(2,Dynamic CID allocation based on subnet failed. Using default.);
maybecid=${cidnum_};
}
} else {
// static, empty or otherwise unknown - so use param as default
maybedid=${cidnum_};
}
// either one - may be cid or may be did
Set(DB(pngnpbx/abc/cb/${pngnpbx_abc_id}/outboundcidnum)=${maybedid}${maybecid});
if( "x${mytincan}" == "xyes" ) {
Originate(${pvt},exten,pngnpbx-abc-spy-barge,${pngnpbx_abc_id},1,1,a);
} else {
Originate(${pvt},exten,pngnpbx-abc-dial,${pngnpbx_abc_id}-0ABC,1,1,a);
}
return;
}
/* PUBLIC */
/* The "friend" macro can be entered multiple times, once per each
* additional participant. They will enter the SAME YURT. */
macro pngnpbx-abc-friend(pos_,dialstr_) {
local myexten=${CUT(dialstr_,/,2)};
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(LOCAL(mycidnum)=${DB(${dbcb}/${pngnpbx_abc_id}/cidnum)});
Set(LOCAL(pvt)=Local/${pngnpbx_abc_id}@pngnpbx-abc-bridge);
// TODO: more loop prevention using GROUP function
// (need to test bad forwarding scenarios)
if( "x${myexten}" != "x${mycidnum}" ) {
Set(DB(${dbcb}/${pngnpbx_abc_id}/friend/${pos_}/dialstr)=${dialstr_});
Originate(${pvt},exten,pngnpbx-abc-dial-friend,${pngnpbx_abc_id}-${pos_},1,1,a);
}
return;
}
/* PUBLIC */
/* The "troll" macro can be entered multiple times, once per each
* additional participant. They will enter the SAME YURT.
* Probably they will be in the YURT before friends and remote end.
* "nosy" trolls listen to an announcement and then the actual call.
* non-"nosy" trolls just get an announcment. */
macro pngnpbx-abc-troll(pos_,dialstr_,nosy_) {
local myexten=${CUT(dialstr_,/,2)};
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(LOCAL(mycidnum)=${DB(${dbcb}/${pngnpbx_abc_id}/cidnum)});
Set(LOCAL(pvt)=Local/${pngnpbx_abc_id}@pngnpbx-abc-bridge);
// TODO: more loop prevention using GROUP function
// (need to test bad forwarding scenarios)
if( "x${myexten}" != "x${mycidnum}" ) {
Set(DB(${dbcb}/${pngnpbx_abc_id}/troll/${pos_}/dialstr)=${dialstr_});
Set(DB(${dbcb}/${pngnpbx_abc_id}/troll/${pos_}/nosy)=${nosy_});
Originate(${pvt},exten,pngnpbx-abc-dial-troll,${pngnpbx_abc_id}-${pos_},1,1,a);
}
return;
}
/* PUBLIC */
/* The "paladin" macro can be entered multiple times, once per each
* additional participant. They will enter the SAME PALACE. From there,
* they can listen to FRIENDS and REMOTE END in the corresponding YURT
* but not talk to them. However, the paladins can talk to other paladins
* in the SAME PALACE. */
macro pngnpbx-abc-paladin(pos_,dialstr_) {
local myexten=${CUT(dialstr_,/,2)};
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(LOCAL(mycidnum)=${DB(${dbcb}/${pngnpbx_abc_id}/cidnum)});
Set(LOCAL(pvtpal)=Local/${pngnpbx_abc_id}@pngnpbx-abc-palace);
// TODO: more loop prevention using GROUP function
// (need to test bad forwarding scenarios)
if( "x${myexten}" != "x${mycidnum}" ) {
Set(DB(${dbcb}/${pngnpbx_abc_id}/paladin/${pos_}/dialstr)=${dialstr_});
Originate(${pvtpal},exten,pngnpbx-abc-dial-paladin,${pngnpbx_abc_id}-${pos_},1,1,a);
if( "x${pos_}" == "x1" ) {
Originate(${pvtpal},exten,pngnpbx-abc-spy-listen,${pngnpbx_abc_id},1,1,a);
}
}
return;
}
/* PUBLIC */
/* The "paths" macro supports multiple dial strings to try and
* reach the far end, in a failover manner, in case some routes are down. */
macro pngnpbx-abc-path(position_,timeout_,dialstr_) {
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(DB(${dbcb}/${pngnpbx_abc_id}/outpath/${position_}/dialstr)=${dialstr_});
Set(DB(${dbcb}/${pngnpbx_abc_id}/outpath/${position_}/timeout)=${timeout_});
return;
}
/* PUBLIC */
/* The "vmail" macro is optional. Sends a voicemail about the call.
* First N seconds of the call is attached as the voicemail.
* Important: make sure that vmsecs_ is greater than minmessage in your
* voicemail.conf file */
macro pngnpbx-abc-vmail(boxes_,vmsecs_) {
Set(LOCAL(dbcb)=pngnpbx/abc/cb);
Set(LOCAL(pvt)=Local/${pngnpbx_abc_id}@pngnpbx-abc-trolling);
Set(DB(${dbcb}/${pngnpbx_abc_id}/vmailboxes)=${boxes_});
Originate(${pvt},exten,pngnpbx-abc-vmdrop,${pngnpbx_abc_id}-${vmsecs_},1,1,a);
return;