-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
9782 lines (8996 loc) · 337 KB
/
index.html
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
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="icon" href="images/favicon-2405a0e6.png">
<meta
name="description"
content="Open Source Telephony/Programmable Voice API platform built on top of FreeSWITCH"
>
<meta
name="keywords"
content="eqivo, telephony api, programmable voice, freeswitch api"
>
<title>Eqivo | Open Source Telephony API Platform</title>
<script>
window.goatcounter = {no_onload: true};
window.addEventListener('hashchange', function(e) {
window.goatcounter.count({
path: location.pathname + location.search + location.hash,
})
});
</script>
<script data-goatcounter="https://eqivo.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
<script defer src="https://use.fontawesome.com/releases/v6.1.1/js/all.js" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.3/gh-fork-ribbon.min.css">
<style media="screen">
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight .gh {
color: #999999;
}
.highlight .sr {
color: #f6aa11;
}
.highlight .go {
color: #888888;
}
.highlight .gp {
color: #555555;
}
.highlight .gs {
}
.highlight .gu {
color: #aaaaaa;
}
.highlight .nb {
color: #f6aa11;
}
.highlight .cm {
color: #75715e;
}
.highlight .cp {
color: #75715e;
}
.highlight .c1 {
color: #75715e;
}
.highlight .cs {
color: #75715e;
}
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
color: #75715e;
}
.highlight .err {
color: #960050;
}
.highlight .gr {
color: #960050;
}
.highlight .gt {
color: #960050;
}
.highlight .gd {
color: #49483e;
}
.highlight .gi {
color: #49483e;
}
.highlight .ge {
color: #49483e;
}
.highlight .kc {
color: #66d9ef;
}
.highlight .kd {
color: #66d9ef;
}
.highlight .kr {
color: #66d9ef;
}
.highlight .no {
color: #66d9ef;
}
.highlight .kt {
color: #66d9ef;
}
.highlight .mf {
color: #ae81ff;
}
.highlight .mh {
color: #ae81ff;
}
.highlight .il {
color: #ae81ff;
}
.highlight .mi {
color: #ae81ff;
}
.highlight .mo {
color: #ae81ff;
}
.highlight .m, .highlight .mb, .highlight .mx {
color: #ae81ff;
}
.highlight .sc {
color: #ae81ff;
}
.highlight .se {
color: #ae81ff;
}
.highlight .ss {
color: #ae81ff;
}
.highlight .sd {
color: #e6db74;
}
.highlight .s2 {
color: #e6db74;
}
.highlight .sb {
color: #e6db74;
}
.highlight .sh {
color: #e6db74;
}
.highlight .si {
color: #e6db74;
}
.highlight .sx {
color: #e6db74;
}
.highlight .s1 {
color: #e6db74;
}
.highlight .s, .highlight .sa, .highlight .dl {
color: #e6db74;
}
.highlight .na {
color: #a6e22e;
}
.highlight .nc {
color: #a6e22e;
}
.highlight .nd {
color: #a6e22e;
}
.highlight .ne {
color: #a6e22e;
}
.highlight .nf, .highlight .fm {
color: #a6e22e;
}
.highlight .vc {
color: #ffffff;
}
.highlight .nn {
color: #ffffff;
}
.highlight .ni {
color: #ffffff;
}
.highlight .bp {
color: #ffffff;
}
.highlight .vg {
color: #ffffff;
}
.highlight .vi {
color: #ffffff;
}
.highlight .nv, .highlight .vm {
color: #ffffff;
}
.highlight .w {
color: #ffffff;
}
.highlight {
color: #ffffff;
}
.highlight .n, .highlight .py, .highlight .nx {
color: #ffffff;
}
.highlight .nl {
color: #f92672;
}
.highlight .ow {
color: #f92672;
}
.highlight .nt {
color: #f92672;
}
.highlight .k, .highlight .kv {
color: #f92672;
}
.highlight .kn {
color: #f92672;
}
.highlight .kp {
color: #f92672;
}
.highlight .o {
color: #f92672;
}
</style>
<style media="print">
* {
-webkit-transition:none!important;
transition:none!important;
}
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight, .highlight .w {
color: #586e75;
}
.highlight .err {
color: #002b36;
background-color: #dc322f;
}
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
color: #657b83;
}
.highlight .cp {
color: #b58900;
}
.highlight .nt {
color: #b58900;
}
.highlight .o, .highlight .ow {
color: #93a1a1;
}
.highlight .p, .highlight .pi {
color: #93a1a1;
}
.highlight .gi {
color: #859900;
}
.highlight .gd {
color: #dc322f;
}
.highlight .gh {
color: #268bd2;
background-color: #002b36;
font-weight: bold;
}
.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
color: #6c71c4;
}
.highlight .kc {
color: #cb4b16;
}
.highlight .kt {
color: #cb4b16;
}
.highlight .kd {
color: #cb4b16;
}
.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
color: #859900;
}
.highlight .sa {
color: #6c71c4;
}
.highlight .sr {
color: #2aa198;
}
.highlight .si {
color: #d33682;
}
.highlight .se {
color: #d33682;
}
.highlight .nn {
color: #b58900;
}
.highlight .nc {
color: #b58900;
}
.highlight .no {
color: #b58900;
}
.highlight .na {
color: #268bd2;
}
.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
color: #859900;
}
.highlight .ss {
color: #859900;
}
</style>
<link href="stylesheets/screen-997d5047.css" rel="stylesheet" media="screen" />
<link href="stylesheets/print-953e3353.css" rel="stylesheet" media="print" />
<script src="javascripts/all_nosearch-18c3ed8e.js"></script>
<script>
$(function() { setupCodeCopy(); });
</script>
</head>
<body class="index" data-languages="["shell"]">
<a href="#" id="nav-button">
<span>
NAV
<img src="images/navbar-cad8cdcb.png" alt="" />
</span>
</a>
<div class="toc-wrapper">
<img src="images/logo-9163fa4f.png" class="logo" alt="" />
<div class="lang-selector">
<a href="#" data-language-name="shell"></a>
</div>
<ul id="toc" class="toc-list-h1">
<li>
<a href="#overview" class="toc-h1 toc-link" data-title="Overview">Overview</a>
</li>
<li>
<a href="#getting-started" class="toc-h1 toc-link" data-title="Getting Started">Getting Started</a>
<ul class="toc-list-h2">
<li>
<a href="#installation" class="toc-h2 toc-link" data-title="Installation">Installation</a>
</li>
<li>
<a href="#configuration" class="toc-h2 toc-link" data-title="Configuration">Configuration</a>
</li>
</ul>
</li>
<li>
<a href="#configuration" class="toc-h1 toc-link" data-title="Configuration">Configuration</a>
<ul class="toc-list-h2">
<li>
<a href="#daemonize" class="toc-h2 toc-link" data-title="daemonize">daemonize</a>
</li>
<li>
<a href="#username" class="toc-h2 toc-link" data-title="userName">userName</a>
</li>
<li>
<a href="#groupname" class="toc-h2 toc-link" data-title="groupName">groupName</a>
</li>
<li>
<a href="#appprefix" class="toc-h2 toc-link" data-title="appPrefix">appPrefix</a>
</li>
<li>
<a href="#pidfile" class="toc-h2 toc-link" data-title="pidFile">pidFile</a>
</li>
<li>
<a href="#configfile" class="toc-h2 toc-link" data-title="configFile">configFile</a>
</li>
<li>
<a href="#cores" class="toc-h2 toc-link" data-title="cores">cores</a>
</li>
<li>
<a href="#defaulthttpmethod" class="toc-h2 toc-link" data-title="defaultHttpMethod">defaultHttpMethod</a>
</li>
<li>
<a href="#defaultanswerurl" class="toc-h2 toc-link" data-title="defaultAnswerUrl">defaultAnswerUrl</a>
</li>
<li>
<a href="#defaulthangupurl" class="toc-h2 toc-link" data-title="defaultHangupUrl">defaultHangupUrl</a>
</li>
<li>
<a href="#extrachannelvars" class="toc-h2 toc-link" data-title="extraChannelVars">extraChannelVars</a>
</li>
<li>
<a href="#verifypeer" class="toc-h2 toc-link" data-title="verifyPeer">verifyPeer</a>
</li>
<li>
<a href="#verifypeername" class="toc-h2 toc-link" data-title="verifyPeerName">verifyPeerName</a>
</li>
<li>
<a href="#restserverbindip" class="toc-h2 toc-link" data-title="restServerBindIp">restServerBindIp</a>
</li>
<li>
<a href="#restserverbindport" class="toc-h2 toc-link" data-title="restServerBindPort">restServerBindPort</a>
</li>
<li>
<a href="#restserveradvertisedhost" class="toc-h2 toc-link" data-title="restServerAdvertisedHost">restServerAdvertisedHost</a>
</li>
<li>
<a href="#restservermaxhandlers" class="toc-h2 toc-link" data-title="restServerMaxHandlers">restServerMaxHandlers</a>
</li>
<li>
<a href="#restservermaxrequestsize" class="toc-h2 toc-link" data-title="restServerMaxRequestSize">restServerMaxRequestSize</a>
</li>
<li>
<a href="#restserverloglevel" class="toc-h2 toc-link" data-title="restServerLogLevel">restServerLogLevel</a>
</li>
<li>
<a href="#restallowedips" class="toc-h2 toc-link" data-title="restAllowedIps">restAllowedIps</a>
</li>
<li>
<a href="#restauthid" class="toc-h2 toc-link" data-title="restAuthId">restAuthId</a>
</li>
<li>
<a href="#restauthtoken" class="toc-h2 toc-link" data-title="restAuthToken">restAuthToken</a>
</li>
<li>
<a href="#recordurl" class="toc-h2 toc-link" data-title="recordUrl">recordUrl</a>
</li>
<li>
<a href="#outboundserverbindip" class="toc-h2 toc-link" data-title="outboundServerBindIp">outboundServerBindIp</a>
</li>
<li>
<a href="#outboundserverbindport" class="toc-h2 toc-link" data-title="outboundServerBindPort">outboundServerBindPort</a>
</li>
<li>
<a href="#outboundserveradvertisedip" class="toc-h2 toc-link" data-title="outboundServerAdvertisedIp">outboundServerAdvertisedIp</a>
</li>
<li>
<a href="#outboundserveradvertisedport" class="toc-h2 toc-link" data-title="outboundServerAdvertisedPort">outboundServerAdvertisedPort</a>
</li>
<li>
<a href="#outboundserverloglevel" class="toc-h2 toc-link" data-title="outboundServerLogLevel">outboundServerLogLevel</a>
</li>
<li>
<a href="#inboundserverloglevel" class="toc-h2 toc-link" data-title="inboundServerLogLevel">inboundServerLogLevel</a>
</li>
<li>
<a href="#callheartbeaturl" class="toc-h2 toc-link" data-title="callHeartbeatUrl">callHeartbeatUrl</a>
</li>
</ul>
</li>
<li>
<a href="#restxml" class="toc-h1 toc-link" data-title="RestXML">RestXML</a>
<ul class="toc-list-h2">
<li>
<a href="#conference" class="toc-h2 toc-link" data-title="Conference">Conference</a>
</li>
<li>
<a href="#dial" class="toc-h2 toc-link" data-title="Dial">Dial</a>
</li>
<li>
<a href="#getdigits" class="toc-h2 toc-link" data-title="GetDigits">GetDigits</a>
</li>
<li>
<a href="#getspeech" class="toc-h2 toc-link" data-title="GetSpeech">GetSpeech</a>
</li>
<li>
<a href="#hangup" class="toc-h2 toc-link" data-title="Hangup">Hangup</a>
</li>
<li>
<a href="#play" class="toc-h2 toc-link" data-title="Play">Play</a>
</li>
<li>
<a href="#preanswer" class="toc-h2 toc-link" data-title="PreAnswer">PreAnswer</a>
</li>
<li>
<a href="#record" class="toc-h2 toc-link" data-title="Record">Record</a>
</li>
<li>
<a href="#redirect" class="toc-h2 toc-link" data-title="Redirect">Redirect</a>
</li>
<li>
<a href="#siptransfer" class="toc-h2 toc-link" data-title="SIPTransfer">SIPTransfer</a>
</li>
<li>
<a href="#speak" class="toc-h2 toc-link" data-title="Speak">Speak</a>
</li>
<li>
<a href="#wait" class="toc-h2 toc-link" data-title="Wait">Wait</a>
</li>
</ul>
</li>
<li>
<a href="#restapi" class="toc-h1 toc-link" data-title="RestAPI">RestAPI</a>
<ul class="toc-list-h2">
<li>
<a href="#eqivo-api-call" class="toc-h2 toc-link" data-title="Call">Call</a>
</li>
<li>
<a href="#v0-1-bulkcall" class="toc-h2 toc-link" data-title="/v0.1/BulkCall/">/v0.1/BulkCall/</a>
</li>
<li>
<a href="#v0-1-call" class="toc-h2 toc-link" data-title="/v0.1/Call/">/v0.1/Call/</a>
</li>
<li>
<a href="#v0-1-cancelscheduledhangup" class="toc-h2 toc-link" data-title="/v0.1/CancelScheduledHangup/">/v0.1/CancelScheduledHangup/</a>
</li>
<li>
<a href="#v0-1-cancelscheduledplay" class="toc-h2 toc-link" data-title="/v0.1/CancelScheduledPlay/">/v0.1/CancelScheduledPlay/</a>
</li>
<li>
<a href="#v0-1-groupcall" class="toc-h2 toc-link" data-title="/v0.1/GroupCall/">/v0.1/GroupCall/</a>
</li>
<li>
<a href="#v0-1-hangupallcalls" class="toc-h2 toc-link" data-title="/v0.1/HangupAllCalls/">/v0.1/HangupAllCalls/</a>
</li>
<li>
<a href="#v0-1-hangupcall" class="toc-h2 toc-link" data-title="/v0.1/HangupCall/">/v0.1/HangupCall/</a>
</li>
<li>
<a href="#v0-1-play" class="toc-h2 toc-link" data-title="/v0.1/Play/">/v0.1/Play/</a>
</li>
<li>
<a href="#v0-1-playstop" class="toc-h2 toc-link" data-title="/v0.1/PlayStop/">/v0.1/PlayStop/</a>
</li>
<li>
<a href="#v0-1-recordstart" class="toc-h2 toc-link" data-title="/v0.1/RecordStart/">/v0.1/RecordStart/</a>
</li>
<li>
<a href="#v0-1-recordstop" class="toc-h2 toc-link" data-title="/v0.1/RecordStop/">/v0.1/RecordStop/</a>
</li>
<li>
<a href="#v0-1-schedulehangup" class="toc-h2 toc-link" data-title="/v0.1/ScheduleHangup/">/v0.1/ScheduleHangup/</a>
</li>
<li>
<a href="#v0-1-scheduleplay" class="toc-h2 toc-link" data-title="/v0.1/SchedulePlay/">/v0.1/SchedulePlay/</a>
</li>
<li>
<a href="#v0-1-senddigits" class="toc-h2 toc-link" data-title="/v0.1/SendDigits/">/v0.1/SendDigits/</a>
</li>
<li>
<a href="#v0-1-soundtouch" class="toc-h2 toc-link" data-title="/v0.1/SoundTouch/">/v0.1/SoundTouch/</a>
</li>
<li>
<a href="#v0-1-soundtouchstop" class="toc-h2 toc-link" data-title="/v0.1/SoundTouchStop/">/v0.1/SoundTouchStop/</a>
</li>
<li>
<a href="#v0-1-transfercall" class="toc-h2 toc-link" data-title="/v0.1/TransferCall/">/v0.1/TransferCall/</a>
</li>
<li>
<a href="#eqivo-api-conference" class="toc-h2 toc-link" data-title="Conference">Conference</a>
</li>
<li>
<a href="#v0-1-conferencedeaf" class="toc-h2 toc-link" data-title="/v0.1/ConferenceDeaf/">/v0.1/ConferenceDeaf/</a>
</li>
<li>
<a href="#v0-1-conferencehangup" class="toc-h2 toc-link" data-title="/v0.1/ConferenceHangup/">/v0.1/ConferenceHangup/</a>
</li>
<li>
<a href="#v0-1-conferencehold" class="toc-h2 toc-link" data-title="/v0.1/ConferenceHold/">/v0.1/ConferenceHold/</a>
</li>
<li>
<a href="#v0-1-conferencekick" class="toc-h2 toc-link" data-title="/v0.1/ConferenceKick/">/v0.1/ConferenceKick/</a>
</li>
<li>
<a href="#v0-1-conferencelist" class="toc-h2 toc-link" data-title="/v0.1/ConferenceList/">/v0.1/ConferenceList/</a>
</li>
<li>
<a href="#v0-1-conferencelistmembers" class="toc-h2 toc-link" data-title="/v0.1/ConferenceListMembers/">/v0.1/ConferenceListMembers/</a>
</li>
<li>
<a href="#v0-1-conferencemute" class="toc-h2 toc-link" data-title="/v0.1/ConferenceMute/">/v0.1/ConferenceMute/</a>
</li>
<li>
<a href="#v0-1-conferenceplay" class="toc-h2 toc-link" data-title="/v0.1/ConferencePlay/">/v0.1/ConferencePlay/</a>
</li>
<li>
<a href="#v0-1-conferencerecordstart" class="toc-h2 toc-link" data-title="/v0.1/ConferenceRecordStart/">/v0.1/ConferenceRecordStart/</a>
</li>
<li>
<a href="#v0-1-conferencerecordstop" class="toc-h2 toc-link" data-title="/v0.1/ConferenceRecordStop/">/v0.1/ConferenceRecordStop/</a>
</li>
<li>
<a href="#v0-1-conferencespeak" class="toc-h2 toc-link" data-title="/v0.1/ConferenceSpeak/">/v0.1/ConferenceSpeak/</a>
</li>
<li>
<a href="#v0-1-conferenceundeaf" class="toc-h2 toc-link" data-title="/v0.1/ConferenceUndeaf/">/v0.1/ConferenceUndeaf/</a>
</li>
<li>
<a href="#v0-1-conferenceunhold" class="toc-h2 toc-link" data-title="/v0.1/ConferenceUnhold/">/v0.1/ConferenceUnhold/</a>
</li>
<li>
<a href="#v0-1-conferenceunmute" class="toc-h2 toc-link" data-title="/v0.1/ConferenceUnmute/">/v0.1/ConferenceUnmute/</a>
</li>
<li>
<a href="#schemas" class="toc-h2 toc-link" data-title="Schemas">Schemas</a>
</li>
<li>
<a href="#errors" class="toc-h2 toc-link" data-title="Errors">Errors</a>
</li>
</ul>
</li>
<li>
<a href="#security" class="toc-h1 toc-link" data-title="Security">Security</a>
<ul class="toc-list-h2">
<li>
<a href="#api-tokens" class="toc-h2 toc-link" data-title="API Tokens">API Tokens</a>
</li>
<li>
<a href="#allowed-ip-cidr" class="toc-h2 toc-link" data-title="Allowed IP/CIDR">Allowed IP/CIDR</a>
</li>
<li>
<a href="#restxml-requests" class="toc-h2 toc-link" data-title="RestXML Requests">RestXML Requests</a>
</li>
<li>
<a href="#input-sanitation" class="toc-h2 toc-link" data-title="Input Sanitation">Input Sanitation</a>
</li>
</ul>
</li>
</ul>
<ul class="toc-footer">
<li><a href='https://github.com/rtckit/eqivo' data-goatcounter-click='ext-github-menu'><i class='fab fa-github'></i> Source code on GitHub</a></li>
<li><a href='https://hub.docker.com/r/rtckit/eqivo' data-goatcounter-click='ext-dockerhub-menu'><i class='fab fa-docker'></i> OCI image on DockerHub</a></li>
<li><a href='https://github.com/rtckit/eqivo-sandbox' data-goatcounter-click='ext-github-menu'><i class='fab fa-github'></i> Integration Examples</a></li>
<li><a href='https://rtckit.zulipchat.com/#narrow/stream/414323-eqivo' data-goatcounter-click='ext-chat-menu'><i class='fa fa-comment'></i> Community Chat</a></li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1>Eqivo | Open Source Telephony API Platform</h1>
<p><strong>Eqivo</strong> is an open source telephony/real time communications API platform.</p>
<blockquote>
<p><strong>Eqivo</strong> started as a tribute project/reimplementation of the discontinued <a href="https://github.com/plivo/plivoframework">Plivo Framework</a>, not to be confused with the cloud offering by the <a href="https://plivo.com">same company</a>; there is no affiliation between the latter company and the Eqivo developers. For clarity, the original (now discontinued) project shall be referred to as the <strong><em>legacy framework</em></strong>.</p>
<p>To learn more about it, read the project's <a href="https://web.archive.org/web/20171022083017/http://www.plivo.com/open-source/">mission statement</a> and its <a href="https://web.archive.org/web/20171127130133/http://docs.plivo.org/">documentation</a>, as archived by the Wayback Machine circa 2017.</p>
<p>Join us on the <a href="https://rtckit.zulipchat.com/#narrow/stream/414323-eqivo">community chat</a> or <a href="https://github.com/rtckit/eqivo/discussions">GitHub discussions</a>.</p>
</blockquote>
<p>It relies on <a href="https://github.com/signalwire/freeswitch">FreeSWITCH</a> for signalling (SIP, Verto, etc.) and media (RTP) handling. Eqivo sits between FreeSWITCH and your application and interacts with the latter by accepting inbound API calls as well as issuing outgoing webhook calls to your designated endpoints.</p>
<p>Being a reimplementation of the legacy Plivo framework, Eqivo can function as a drop-in replacement for <em>most</em> use cases. It also features several extensions, including M:N (Eqivo:FreeSWITCH) deployment configurations and answering machine detection.</p>
<h1 id='overview'>Overview</h1>
<blockquote>
<p><img src="images/eqivo-diagram-afb688e2.png" title="Eqivo Diagram" alt="Eqivo Diagram" /></p>
</blockquote>
<p>Out of the box, the legacy framework was intended to be deployed alongside FreeSWITCH, seemingly at host level as containers were not as popular back then. Fast forward a decade later, Eqivo is optimized for container based deployments and breaks away from the 1-to-1 relationship with FreeSWITCH. Internally, Eqivo follows most (yet not all) design principles of the legacy framework. A great deal of terminology is also borrowed for the latter project.</p>
<p><strong>Initiating Actions</strong></p>
<p>In order to initiate various actions, your application will invoke the Eqivo <strong>RestAPI</strong>. It's <a href="https://web.archive.org/web/20171216211358/http://docs.plivo.org/docs/restapis">backwards compatible</a> and the interactions are fairly straightforward, all requests must:</p>
<ul>
<li>employ RFC 7617 Basic authentication, the <code>Authorization</code> header must be included in every request;</li>
<li>use <code>POST</code> method for all calls. Parameters must be <code>application/x-www-form-urlencoded</code> endcoded;</li>
<li>expect a JSON response for successful requests as well as application-level errors.</li>
</ul>
<p><strong>Handling Events</strong></p>
<p>Your application must expose endpoints Eqivo will invoke when certain events occur. For example, when an inbound call lands on a FreeSWITCH instance, Eqivo will hit a designated endpoint on your application expecting a well formatted XML response describing how the call in question should be handled. The <strong>RestXML</strong> implementation is <a href="https://web.archive.org/web/20171207052719/http://docs.plivo.org/docs/restxml">backwards compatible</a>.</p>
<h1 id='getting-started'>Getting Started</h1><h2 id='installation'>Installation</h2><h3 id='oci-container'>OCI Container</h3><div class="highlight"><pre class="highlight sh tab-shell"><code>docker pull rtckit/eqivo
docker run rtckit/eqivo
</code></pre></div>
<p>Container deployment is the recommended method for integrating Eqivo in your applications; ready-made OCI images are available on <a href="https://hub.docker.com/r/rtckit/eqivo">DockerHub</a>. Configuration via environment variables is ideal for this approach, and orchestration systems such as Kubernetes can transparently handle secret management on your behalf.</p>
<p>For every release, there are two images available, the production one (using version tags) which contains only Eqivo and the PHP runtime and its dependencies. There is also a debug image (tagged with the <code>-full</code> suffix) which includes a complete Debian userland to facilitate troubleshooting.</p>
<h3 id='phar-package'>Phar Package</h3>
<p>Direct download:</p>
<div class="highlight"><pre class="highlight sh tab-shell"><code>curl <span class="nt">-Ls</span> https://github.com/rtckit/eqivo/releases/download/v0.6.2/eqivo.phar <span class="nt">-o</span> eqivo
<span class="nb">chmod</span> +x eqivo
<span class="nb">sudo mv </span>eqivo /usr/local/bin
eqivo
</code></pre></div>
<p>The project is also available as a standalone <a href="https://github.com/rtckit/eqivo/releases">Phar package</a>, in which case the environment must be properly configured, i.e.: PHP 8.1+ as well as <a href="https://github.com/rtckit/eqivo/blob/main/composer.json#L27-L33">required extensions</a> (typically bundled with the PHP core).</p>
<p>During startup, Eqivo will check if its dependencies are met and it will complain if something is wrong.</p>
<h3 id='phive'>PHIVE</h3>
<p>You can also install Eqivo using <a href="https://phar.io/">PHIVE</a>:</p>
<div class="highlight"><pre class="highlight sh tab-shell"><code>phive <span class="nb">install </span>eqivo
</code></pre></div><h3 id='git-repository'>Git Repository</h3>
<p>Lastly, you can clone the GitHub repository and launch Eqivo manually:</p>
<div class="highlight"><pre class="highlight sh tab-shell"><code>git clone https://github.com/rtckit/eqivo.git
<span class="nb">cd </span>eqivo
composer update
./bin/eqivo
</code></pre></div><h2 id='configuration'>Configuration</h2>
<p>The default <a href="#configuration">configuration</a> values alone will not result in a meaningful Eqivo running instance. Furthermore, there is no boilerplate configuration template as each integrating application is unique. All options are documented in their <a href="#configuration">respective chapter</a>, however it is important to understand how Eqivo interacts with your application and FreeSWITCH so one can configure it properly.</p>
<h3 id='eqivo-8646-freeswitch'>Eqivo ⇆ FreeSWITCH</h3>
<p>At least one running FreeSWITCH instance (aka <a href="#cores">core</a>) must be configured, which consists of a host name, a port number, a password and an optional user name. It's important to note your network/firewall settings <em>must</em> allow Eqivo to connect to the configured host:port pair over TCP.</p>
<p>For the reverse control flow, Eqivo exposes a service (referred to as the outbound server) which intakes notifications from FreeSWITCH. <a href="#outboundserverbindip">outboundServerBindIp</a> and <a href="#outboundserverbindport">outboundServerBindPort</a> are defining the socket address pair where Eqivo is listening at and the network/firewall settings <em>must</em> ensure FreeSWITCH is allowed access to it.</p>
<h3 id='eqivo-8646-integrating-application'>Eqivo ⇆ Integrating application</h3>
<p>Eqivo forwards various events by invoking webhooks managed by your application. These are either predefined (such as <a href="#defaultanswerurl">defaultAnswerUrl</a>, <a href="#defaulthangupurl">defaultHangupUrl</a>, <a href="#recordurl">recordUrl</a> or <a href="#callheartbeaturl">callHeartbeatUrl</a>) or set dynamically as API request parameters. The network/firewall settings <em>must</em> ensure Eqivo is able to access the configured webhooks.</p>
<p>For the reverse control flow, Eqivo exposes a service (referred to as the REST server) which intakes API requests from your application. <a href="#restserverbindip">restServerBindIp</a> and <a href="#restserverbindport">restServerBindPort</a> are defining the socket address pair where Eqivo is listening at and the network/firewall settings <em>must</em> ensure your application is allowed access to it.</p>
<p>Several common scenarios and a sample Docker Compose configuration are available in the <a href="https://github.com/rtckit/eqivo-sandbox">rtckit/eqivo-sandbox</a> repository.</p>
<h1 id='configuration'>Configuration</h1>
<p>From a drop-in replacement perspective, Eqivo can function out of the box using legacy framework configuration files. It is however capable of more modern configuration intake facilitating both development as well as production deployment.</p>
<p>Eqivo is able to read configuration from static files (JSON and YAML format, resolving to the same schema), command line arguments and environment variables. Furthermore, one can mix these configuration channels as they see fit. For example when developing locally, one could set the <code>EQIVO_VERIFY_PEER</code> environment variable to <code>false</code> to bypass certificate validation yet retaining the baseline configuration which will eventually be used in production.</p>
<p>Sample configuration files can be found in the git repository: <a href="https://github.com/rtckit/eqivo/blob/main/etc/default.yaml">current YAML file</a>, <a href="https://github.com/rtckit/eqivo/blob/main/etc/default.json">current JSON file</a> and <a href="https://github.com/rtckit/eqivo/blob/main/etc/default.conf">legacy configuration file</a>.</p>
<h2 id='daemonize'>daemonize</h2>
<p>When enabled, Eqivo will run in background.</p>
<ul>
<li>Type: bool (default: <em>false</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--daemon</code></li>
<li>Environment variable: <code>EQIVO_DAEMONIZE</code></li>
</ul>
<h2 id='username'>userName</h2>
<p>Runs Eqivo as an alternate user.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>rest_server.USER</code></li>
<li>Command line argument: <code>--user <user></code></li>
<li>Environment variable: <code>EQIVO_USER</code></li>
</ul>
<h2 id='groupname'>groupName</h2>
<p>Runs Eqivo as a member of an alternate group.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>rest_server.GROUP</code></li>
<li>Command line argument: <code>--group <group></code></li>
<li>Environment variable: <code>EQIVO_GROUP</code></li>
</ul>
<h2 id='appprefix'>appPrefix</h2>
<p>String used in naming custom FreeSWITCH variables. Set to <code>plivo</code> to mimic the legacy framework.</p>
<ul>
<li>Type: string (default: <em>eqivo</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--app-prefix <prefix></code></li>
<li>Environment variable: <code>EQIVO_APP_PREFIX</code></li>
</ul>
<h2 id='pidfile'>pidFile</h2>
<p>Path to a file containing Eqivo's process identification number (or PID).</p>
<ul>
<li>Type: string (default: <em>/tmp/eqivo.pid</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--pidfile <path></code></li>
<li>Environment variable: <code>EQIVO_PID_FILE</code></li>
</ul>
<h2 id='configfile'>configFile</h2>
<p>Path to a static configuration file. Please note the file's extension will determine how the file will be parsed. If it's <code>.json</code> or <code>.yaml</code>, the configuration file will be processes as per the usual. For any other extension, the file will be interpreted as being compatible with the format used by the legacy framework.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--config <path></code></li>
<li>Environment variable: <code>_n/a_</code></li>
</ul>
<h2 id='cores'>cores</h2><div class="highlight"><pre class="highlight yaml tab-yaml"><code><span class="na">cores</span><span class="pi">:</span>
<span class="pi">-</span> <span class="na">eslHost</span><span class="pi">:</span> <span class="s1">'</span><span class="s">127.0.0.1'</span>
<span class="na">eslPort</span><span class="pi">:</span> <span class="m">8021</span>
<span class="na">eslPassword</span><span class="pi">:</span> <span class="s1">'</span><span class="s">secret'</span>
<span class="pi">-</span> <span class="na">eslHost</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2nd-freeswitch.example.com'</span>
<span class="na">eslPort</span><span class="pi">:</span> <span class="m">8021</span>
<span class="na">eslUser</span><span class="pi">:</span> <span class="s1">'</span><span class="s">esluser'</span> <span class="c1"># if defined in event_socket.conf</span>
<span class="na">eslPassword</span><span class="pi">:</span> <span class="s1">'</span><span class="s">bfrx738'</span>
</code></pre></div>
<p>One or more FreeSWITCH instances (or cores) which will work in tandem with Eqivo. Please note the legacy framework is designed to integrate against a single FreeSWITCH instance, so the legacy configuration file is not capable of defining more cores.</p>
<ul>
<li>Type: array (default: <em>[]</em>)</li>
<li>Legacy configuration file properties:
<ul>
<li><code>rest_server.FS_INBOUND_ADDRESS</code></li>
<li><code>rest_server.FS_INBOUND_PASSWORD</code></li>
</ul></li>
<li>Command line argument: <code>--core <corespec></code> (can be used multiple times)</li>
<li>Environment variable: <code>EQIVO_CORE_0</code>, <code>EQIVO_CORE_1</code> and so forth</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>--core [email protected]:8021 --core esluser:[email protected]:8021
</code></pre></div><div class="highlight"><pre class="highlight sh tab-shell"><code><span class="nb">export </span><span class="nv">EQIVO_CORE_0</span><span class="o">=</span>[email protected]:8021
<span class="nb">export </span><span class="nv">EQIVO_CORE_1</span><span class="o">=</span>esluser:[email protected]:8021
</code></pre></div>
<p>The <em>corespec</em> for CLI arguments and environment variables must be formatted as follows:</p>
<p><code>[user:]password@host:port</code></p>
<h2 id='defaulthttpmethod'>defaultHttpMethod</h2>
<p>HTTP method Eqivo will employ when designated RestXML or notification endpoints are being invoked.</p>
<ul>
<li>Type: string (default: <em>POST</em>)</li>
<li>Legacy configuration file property: <code>common.DEFAULT_HTTP_METHOD</code></li>
<li>Command line argument: <code>--default-http-method <method></code></li>
<li>Environment variable: <code>EQIVO_DEFAULT_HTTP_METHOD</code></li>
</ul>
<h2 id='defaultanswerurl'>defaultAnswerUrl</h2>
<p>URL to an endpoint exposed by your application responsible for providing RestXML for handling inbound calls.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>common.DEFAULT_ANSWER_URL</code></li>
<li>Command line argument: <code>--default-answer-url <url></code></li>
<li>Environment variable: <code>EQIVO_DEFAULT_ANSWER_URL</code></li>
</ul>
<h2 id='defaulthangupurl'>defaultHangupUrl</h2>
<p>URL to an endpoint where hangup notifications will be sent. If not set, the default answer URL will be used instead.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>common.DEFAULT_HANGUP_URL</code></li>
<li>Command line argument: <code>--default-hangup-url <url></code></li>
<li>Environment variable: <code>EQIVO_DEFAULT_HANGUP_URL</code></li>
</ul>
<h2 id='extrachannelvars'>extraChannelVars</h2>
<p>Additional FreeSWITCH channel variables to be appended to HTTP payloads when RestXML is requested or when notifications are being sent.</p>
<p>For legacy configuration files, CLI arguments and environment variables use a comma separated string instead of an array.</p>
<ul>
<li>Type: array (default: <em>[]</em>)</li>
<li>Legacy configuration file property: <code>common.EXTRA_FS_VARS</code></li>
<li>Command line argument: <code>--extra-channel-vars <list></code></li>
<li>Environment variable: <code>EQIVO_EXTRA_CHANNEL_VARS</code></li>
</ul>
<h2 id='verifypeer'>verifyPeer</h2>
<p>Requires verification of TLS certificates presented by remote endpoints.</p>
<ul>
<li>Type: bool (default: <em>true</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--verify-peer <bool></code></li>
<li>Environment variable: <code>EQIVO_VERIFY_PEER</code></li>
</ul>
<h2 id='verifypeername'>verifyPeerName</h2>
<p>Requires verification of host names found in TLS certificates presented by remote endpoints.</p>
<ul>
<li>Type: bool (default: <em>true</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--verify-peer-name <bool></code></li>
<li>Environment variable: <code>EQIVO_VERIFY_PEER_NAME</code></li>
</ul>
<h2 id='restserverbindip'>restServerBindIp</h2>
<p>IP address Eqivo's REST server will be bound to.</p>
<ul>
<li>Type: string (default: <em>0.0.0.0</em>)</li>
<li>Legacy configuration file property: IP portion of <code>rest_server.HTTP_ADDRESS</code></li>
<li>Command line argument: IP portion of <code>--rest-bind-address <ip:port></code></li>
<li>Environment variable: IP portion of <code>EQIVO_REST_BIND_ADDRESS</code></li>
</ul>
<h2 id='restserverbindport'>restServerBindPort</h2>
<p>TCP port Eqivo's REST server will be bound to.</p>
<ul>
<li>Type: int (default: <em>8088</em>)</li>
<li>Legacy configuration file property: port portion of <code>rest_server.HTTP_ADDRESS</code></li>
<li>Command line argument: port portion of <code>--rest-bind-address <ip:port></code></li>
<li>Environment variable: port portion of <code>EQIVO_REST_BIND_ADDRESS</code></li>
</ul>
<h2 id='restserveradvertisedhost'>restServerAdvertisedHost</h2>
<p>Unique identifier for each running REST server instance (defaults to machine's/container's host name). This is useful when multiple Eqivo instances sit behind a load balancer and your application needs to know which Eqivo instance handled the request.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--rest-advertised-host <host></code></li>
<li>Environment variable: <code>EQIVO_REST_ADVERTISED_HOST</code></li>
</ul>
<h2 id='restservermaxhandlers'>restServerMaxHandlers</h2>
<p>Number of concurrent request buffering handles for the REST server.</p>
<ul>
<li>Type: int (default: <em>1024</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--rest-max-handlers <int></code></li>
<li>Environment variable: <code>EQIVO_REST_MAX_HANDLERS</code></li>
</ul>
<h2 id='restservermaxrequestsize'>restServerMaxRequestSize</h2>
<p>Maximum buffering size per REST request.</p>
<ul>
<li>Type: int (default: <em>16384</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: <code>--rest-max-request-size <int></code></li>
<li>Environment variable: <code>EQIVO_REST_MAX_REQUEST_SIZE</code></li>
</ul>
<h2 id='restserverloglevel'>restServerLogLevel</h2>
<p>REST server RFC 5424 logging verbosity level, can be one of DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT or EMERGENCY.</p>
<p>Please note the legacy <code>LOG_TYPE</code> property will be ignored, the logging output is limited to STDOUT.</p>
<ul>
<li>Type: string (default: <em>DEBUG</em>)</li>
<li>Legacy configuration file property: <code>rest_server.LOG_LEVEL</code></li>
<li>Command line argument: <code>--rest-log-level <level></code></li>
<li>Environment variable: <code>EQIVO_REST_LOG_LEVEL</code></li>
</ul>
<h2 id='restallowedips'>restAllowedIps</h2>
<p>List of IPs allowed to connect to the REST server. Unlike the legacy framework, Eqivo also accepts CIDR ranges.</p>
<p>For legacy configuration files, CLI arguments and environment variables use a comma separated string instead of an array.</p>
<ul>
<li>Type: array (default: <em>[]</em>)</li>
<li>Legacy configuration file property: <code>rest_server.ALLOWED_IPS</code></li>
<li>Command line argument: <code>--rest-allowed-ips <list></code></li>
<li>Environment variable: <code>EQIVO_REST_ALLOWED_IPS</code></li>
</ul>
<h2 id='restauthid'>restAuthId</h2>
<p>User portion of the Basic Authentication required by the REST server.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>common.AUTH_ID</code></li>
<li>Command line argument: <code>--rest-auth-id <secret></code></li>
<li>Environment variable: <code>EQIVO_REST_AUTH_ID</code></li>
</ul>
<h2 id='restauthtoken'>restAuthToken</h2>
<p>Password portion of the Basic Authentication required by the REST server. Also used for signing outgoing RestXML and notification requests.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>common.AUTH_TOKEN</code></li>
<li>Command line argument: <code>--rest-auth-token <secret></code></li>
<li>Environment variable: <code>EQIVO_REST_AUTH_TOKEN</code></li>
</ul>
<h2 id='recordurl'>recordUrl</h2>
<p>URL where notifications will be sent when FreeSWITCH recordings are completed.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>rest_server.RECORD_URL</code></li>
<li>Command line argument: <code>--record-url <url></code></li>
<li>Environment variable: <code>EQIVO_RECORD_URL</code></li>
</ul>
<h2 id='outboundserverbindip'>outboundServerBindIp</h2>
<p>IP address the Outbound server will be bound to.</p>
<ul>
<li>Type: string (default: <em>0.0.0.0</em>)</li>
<li>Legacy configuration file property: IP portion of <code>outbound_server.FS_OUTBOUND_ADDRESS</code></li>
<li>Command line argument: IP portion of <code>--outbound-bind-address <ip:port></code></li>
<li>Environment variable: IP portion of <code>EQIVO_OUTBOUND_BIND_ADDRESS</code></li>
</ul>
<h2 id='outboundserverbindport'>outboundServerBindPort</h2>
<p>TCP port the Outbound server will be bound to.</p>
<ul>
<li>Type: int (default: <em>8084</em>)</li>
<li>Legacy configuration file property: port portion of <code>outbound_server.FS_OUTBOUND_ADDRESS</code></li>
<li>Command line argument: port portion of <code>--outbound-bind-address <ip:port></code></li>
<li>Environment variable: port portion of <code>EQIVO_OUTBOUND_BIND_ADDRESS</code></li>
</ul>
<h2 id='outboundserveradvertisedip'>outboundServerAdvertisedIp</h2>
<p>IP address relayed to FreeSWITCH. Can be useful for more complex network layouts and/or when multiple Outbound servers are placed behind a load balancer.</p>
<ul>
<li>Type: string (default: <em>127.0.0.1</em>)</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: IP portion of <code>--outbound-advertised-address <ip:port></code></li>
<li>Environment variable: IP portion of <code>EQIVO_OUTBOUND_ADVERTISED_ADDRESS</code></li>
</ul>
<h2 id='outboundserveradvertisedport'>outboundServerAdvertisedPort</h2>
<p>TCP port relayed to FreeSWITCH. See <a href="#outboundserveradvertisedip">outboundServerAdvertisedPort</a>.</p>
<ul>
<li>Type: int</li>
<li>Legacy configuration file property: <em>n/a</em></li>
<li>Command line argument: port portion of <code>--outbound-advertised-address <ip:port></code></li>
<li>Environment variable: port portion of <code>EQIVO_OUTBOUND_ADVERTISED_ADDRESS</code></li>
</ul>
<h2 id='outboundserverloglevel'>outboundServerLogLevel</h2>
<p>Outbound server RFC 5424 logging verbosity level, can be one of DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT or EMERGENCY.</p>
<p>Please note the legacy <code>LOG_TYPE</code> property will be ignored, the logging output is limited to STDOUT.</p>
<ul>
<li>Type: string (default: <em>DEBUG</em>)</li>
<li>Legacy configuration file property: <code>outbound_server.LOG_LEVEL</code></li>
<li>Command line argument: <code>--outbound-log-level <level></code></li>
<li>Environment variable: <code>EQIVO_OUTBOUND_LOG_LEVEL</code></li>
</ul>
<h2 id='inboundserverloglevel'>inboundServerLogLevel</h2>
<p>Inbound server RFC 5424 logging verbosity level, can be one of DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT or EMERGENCY.</p>
<p>Please note the legacy <code>LOG_TYPE</code> property will be ignored, the logging output is limited to STDOUT. Also, the Inbound server does not exist as a separate entity in the legacy framework, it's part of the REST server so it will follow the latter's configuration.</p>
<ul>
<li>Type: string (default: <em>DEBUG</em>)</li>
<li>Legacy configuration file property: <code>rest_server.LOG_LEVEL</code></li>
<li>Command line argument: <code>--inbound-log-level <level></code></li>
<li>Environment variable: <code>EQIVO_INBOUND_LOG_LEVEL</code></li>
</ul>
<h2 id='callheartbeaturl'>callHeartbeatUrl</h2>
<p>URL to which call (session) FreeSWITCH heartbeat events will be sent to.</p>
<ul>
<li>Type: string</li>
<li>Legacy configuration file property: <code>rest_server.CALL_HEARTBEAT_URL</code></li>
<li>Command line argument: <code>--call-heartbeat-url <url></code></li>
<li>Environment variable: <code>EQIVO_CALL_HEARTBEAT_URL</code></li>
</ul>
<h1 id='restxml'>RestXML</h1>
<p>Inherited from the legacy framework, RestXML refers to a small set of specialized XML elements describing how calls should be handled. In a way, you can think of RestXML being an evolved dialplan, one that's easier to program in dynamic contexts. On each occasion when Eqivo needs RestXML in order to control a call, it will fire an HTTP(S) request to a designated endpoint, typically via <code>POST</code> although <code>GET</code> is also possible.</p>
<div class="highlight"><pre class="highlight xml tab-xml"><code><span class="cp"><?xml version="1.0" encoding="UTF-8" ?></span>
<span class="nt"><Response></span>
<span class="nt"><Speak></span>Welcome!<span class="nt"></Speak></span>
<span class="nt"><Speak></span>To whom do I have the pleasure of speaking with?<span class="nt"></Speak></span>
<span class="nt"><Record</span> <span class="na">action=</span><span class="s">"https://example.com/endpoint/got_name/"</span> <span class="na">fileName=</span><span class="s">"caller_name"</span> <span class="nt">/></span>
<span class="nt"><Speak></span>I'm sorry, I didn't get that!<span class="nt"></Speak></span>