-
Notifications
You must be signed in to change notification settings - Fork 565
/
b2b_logic_admin.xml
1184 lines (1139 loc) · 38 KB
/
b2b_logic_admin.xml
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
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section id="overview" xreflabel="Overview">
<title>Overview</title>
<para>
The B2BUA implementation in OpenSIPS is separated in two layers:
<itemizedlist>
<listitem><para>
a lower one (implemented in the b2b_entities module) - the basic functions
of a UAS and UAC
</para></listitem>
<listitem><para>
an upper one (implemented in b2b_logic module) - which represents the logic
engine of B2BUA, responsible of actually implementing the B2BUA services
using the functions offered by the low level.
</para></listitem>
</itemizedlist>
</para>
<para>
This module is a B2BUA upper level implementation that can be used along with the
b2b_entities module in order to provide various B2BUA services (eg. PBX features).
The actual logic of the B2BUA scenarios can be implemented in dedicated script routes.
</para>
<para>
A B2B session can be triggered in two ways:
<itemizedlist>
<listitem>
from the script - at the receipt of an initial INVITE message
</listitem>
<listitem>
with an extern command (MI) command - the server will connect two
end points in a session(Third Party Call Control).
</listitem>
</itemizedlist>
</para>
<para>
High Availability for B2B sessions can be achieved by enabling the clustering support
offered by the the lower <emphasis>b2b_entities</emphasis> module (by setting the
<ulink url="https://opensips.org/docs/modules/3.1.x/b2b_entities.html#param_cluster_id">
cluster_id</ulink> modparam from <emphasis>b2b_entities</emphasis>).
</para>
</section>
<section id="scenario_logic" xreflabel="Scenario Logic">
<title>Scenario Logic</title>
<para>
After initializing a B2B session, the call legs will be handled by the b2b_logic
module and the first step will be to put the two initial entities in contact.
Requests and replies belonging to these dialogs will not enter the script through
the standard OpenSIPS routes but instead will be handled in b2b_logic dedicated routes
(defined through the <xref linkend="param_script_req_route"/> and
<xref linkend="param_script_reply_route"/> modparams or, the custom routes given as
parameters to <xref linkend="func_b2b_init_request"/>).
The further steps of the scenario can be implemented in these routes, by calling
dedicated b2b_logic script functions in order to perform various actions. Normal
"proxy-like" OpenSIPS functions should not be executed in the b2b_logic routes.
</para>
<para>
Some messages will be handled automatically by the module and will not enter the
b2b_logic routes at all (BYE requests received while in the process of bridging two
entities, ACKs/BYEs/replies for disconnected entities). Also, if no dedicated b2b_logic
reply route is defined, replies will be handled internally by the module, with the
same effects as calling <xref linkend="func_b2b_handle_reply"/> from such a route if it were defined.
</para>
</section>
<section id="dependencies" xreflabel="Dependencies">
<title>Dependencies</title>
<section>
<title>&osips; Modules</title>
<itemizedlist>
<listitem>
<para>
<emphasis>b2b_entities, a db module</emphasis>
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
No libraries or applications required before running &osips; with this module.
</para>
</section>
</section>
<section id="exported_parameters" xreflabel="Exported Parameters">
<title>Exported Parameters</title>
<section id="param_hash_size" xreflabel="hash_size">
<title><varname>hash_size</varname> (int)</title>
<para>
The size of the hash table that stores the session entities.
</para>
<para>
<emphasis>Default value is <quote>9</quote>
</emphasis>
(512 records).
</para>
<example>
<title>Set <varname>server_hsize</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "hash_size", 10)
...
</programlisting>
</example>
</section>
<section id="param_script_req_route" xreflabel="script_req_route">
<title><varname>script_req_route</varname> (str)</title>
<para>
The name of the script route to be called when requests belonging to
an ongoing B2B session are received.
</para>
<example>
<title>Set <varname>script_req_route</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "script_req_route", "b2b_request")
...
</programlisting>
</example>
</section>
<section id="param_script_reply_route" xreflabel="script_reply_route">
<title><varname>script_reply_route</varname> (str)</title>
<para>
The name of the script route to be called when replies belonging to
an ongoing B2B session are received.
</para>
<example>
<title>Set <varname>script_repl_route</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "script_reply_route", "b2b_reply")
...
</programlisting>
</example>
</section>
<section id="param_cleanup_period" xreflabel="cleanup_period">
<title><varname>cleanup_period</varname> (int)</title>
<para>
The time interval at which to search for an hanged b2b context.
A session is considered expired if the duration of a session exceeds its
defined lifetime. At that moment, BYE is sent in all the dialogs from that
context and the context is deleted.
</para>
<para>
<emphasis>Default value is <quote>100</quote>.</emphasis>
</para>
<example>
<title>Set <varname>cleanup_period</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "cleanup_period", 60)
...
</programlisting>
</example>
</section>
<section id="param_custom_headers_regexp" xreflabel="custom_headers_regexp">
<title><varname>custom_headers_regexp</varname> (str)</title>
<para>
Regexp to search SIP header by names that should be passed
from the dialog of one side to the other side. There are a number
of headers that are passed by default. They are:
<itemizedlist>
<listitem>Content-Type</listitem>
<listitem>Supported</listitem>
<listitem>Allow</listitem>
<listitem>Proxy-Require</listitem>
<listitem>Session-Expires</listitem>
<listitem>Min-SE</listitem>
<listitem>Require</listitem>
<listitem>RSeq</listitem>
</itemizedlist>
If you wish some other headers to be passed also you should define them
by setting this parameter.
</para>
<para>
It can be in forms like "regexp", "/regexp/" and "/regexp/flags".
</para>
<para>Meaning of the flags is as follows:</para>
<itemizedlist>
<listitem><para>
<emphasis>i</emphasis> - Case insensitive search.
</para></listitem>
<listitem><para>
<emphasis>e</emphasis> - Use extended regexp.
</para></listitem>
</itemizedlist>
<para>
<emphasis>Default value is <quote>NULL</quote>.</emphasis>
</para>
<example>
<title>Set <varname></varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "custom_headers_regexp", "/^x-/i")
...
</programlisting>
</example>
</section>
<section id="param_custom_headers" xreflabel="custom_headers">
<title><varname>custom_headers</varname> (str)</title>
<para>
A list of SIP header names delimited by ';' that should be passed
from the dialog of one side to the other side. There are a number
of headers that are passed by default. They are:
<itemizedlist>
<listitem>Max-Forwards (it is decreased by 1)</listitem>
<listitem>Content-Type</listitem>
<listitem>Supported</listitem>
<listitem>Allow</listitem>
<listitem>Proxy-Require</listitem>
<listitem>Session-Expires</listitem>
<listitem>Min-SE</listitem>
<listitem>Require</listitem>
<listitem>RSeq</listitem>
</itemizedlist>
If you wish some other headers to be passed also you should define them
by setting this parameter.
</para>
<para>
<emphasis>Default value is <quote>NULL</quote>.</emphasis>
</para>
<example>
<title>Set <varname></varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "custom_headers", "User-Agent;Date")
...
</programlisting>
</example>
</section>
<section id="param_use_init_sdp" xreflabel="use_init_sdp">
<title><varname>use_init_sdp</varname> (int)</title>
<para>
This parameter modifies the behaviour of the B2BUA when bridging
and a provisional media uri is set. For playing media while the callee
answers (that is connecting the caller to a media server), the bridging
with the callee must start by sending an Invite to it. The correct way
is to send an Invite without a body in this case, but it has been observed
that not many gateways support this. So, the solution is to use the sdp
received in the first Invite from the caller and put it as the body for this
invite. By setting this parameter, this behavior is enabled.
You can also set use_init_sdp per session and overwrite this global value.
</para>
<para>
<emphasis>Default value is <quote>0</quote>.</emphasis>
</para>
<example>
<title>Set <varname></varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "use_init_sdp", 1)
...
</programlisting>
</example>
</section>
<section id="param_db_url" xreflabel="db_url">
<title><varname>db_url</varname> (str)</title>
<para>
Database URL.
</para>
<example>
<title>Set <varname>db_url</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "db_url", "mysql://opensips:opensipsrw@127.0.0.1/opensips")
...
</programlisting>
</example>
</section>
<section id="param_update_period" xreflabel="update_period">
<title><varname>update_period</varname> (int)</title>
<para>
The time interval at which to update the info in database.
</para>
<para>
<emphasis>Default value is <quote>100</quote>.</emphasis>
</para>
<example>
<title>Set <varname>update_period</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "update_period", 60)
...
</programlisting>
</example>
</section>
<section id="param_max_duration" xreflabel="max_duration">
<title><varname>max_duration</varname> (int)</title>
<para>
The maximum duration of a call.
</para>
<para>
<emphasis>Default value is <quote>12 * 3600 (12 hours)</quote>.</emphasis>
</para>
<para>If you set it to 0, there will be no limitation.</para>
<example>
<title>Set <varname>max_duration</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "max_duration", 7200)
...
</programlisting>
</example>
</section>
<section id="param_b2bl_from_spec_param" xreflabel="b2bl_from_spec_param">
<title><varname>b2bl_from_spec_param</varname> (string)</title>
<para>
The name of the pseudo variable for storing the new
<quote>From</quote> header.
The PV must be set before calling <quote>b2b_init_request</quote>.
</para>
<para>
<emphasis>Default value is <quote>NULL</quote> (disabled).</emphasis>
</para>
<example>
<title>Set <varname>b2bl_from_spec_param</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "b2bl_from_spec_param", "$var(b2bl_from)")
...
route{
...
# setting the From header
$var(b2bl_from) = "\"Call ID\" <sip:user@opensips.org>";
...
b2b_init_request("top hiding");
...
}
</programlisting>
</example>
</section>
<section id="param_server_address" xreflabel="server_address">
<title><varname>server_address</varname> (str)</title>
<para>
The IP address of the machine that will be used as Contact in
the generated messages. This is compulsory only when OpenSIPS
starts a call from the middle. For scenarios triggered by received
calls, if it is not set, it is constructed dynamically from the
socket where the initiating request was received.
This socket will be used to send all the requests, replies for that
session.
</para>
<example>
<title>Set <varname>server_address</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "server_address", "sip:sa@10.10.10.10:5060")
...
</programlisting>
</example>
</section>
<section id="param_init_callid_hdr" xreflabel="init_callid_hdr">
<title><varname>init_callid_hdr</varname> (str)</title>
<para>
The module offers the possibility to insert the original callid in a header
in the generated Invites. If you want this, set this parameter to the name
of the header in which to insert the original callid.
</para>
<example>
<title>Set <varname>init_callid_hdr</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "init_callid_hdr", "Init-CallID")
...
</programlisting>
</example>
</section>
<section id="param_db_mode" xreflabel="db_mode">
<title><varname>db_mode</varname> (int)</title>
<para>
The B2B modules have support for the 3 type of database storage
</para>
<para>
<itemizedlist>
<listitem>NO DB STORAGE - set this parameter to 0</listitem>
<listitem>WRITE THROUGH (synchronous write in database) - set this parameter to 1</listitem>
<listitem>WRITE BACK (update in db from time to time) - set this parameter to 2</listitem>
</itemizedlist>
</para>
<para>
<emphasis>Default value is <quote>2</quote> (WRITE BACK).</emphasis>
</para>
<example>
<title>Set <varname>db_mode</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "db_mode", 1)
...
</programlisting>
</example>
</section>
<section id="param_db_table" xreflabel="db_table">
<title><varname>db_table</varname> (str)</title>
<para>
Name of the database table to be used
</para>
<para>
<emphasis>Default value is <quote>b2b_logic</quote> </emphasis>
</para>
<example>
<title>Set <varname>db_table</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "db_table", "some_table_name")
...
</programlisting>
</example>
</section>
<section id="param_b2bl_th_init_timeout" xreflabel="b2bl_th_init_timeout">
<title><varname>b2bl_th_init_timeout</varname> (int)</title>
<para>
Call setup timeout for topology hiding scenario.
</para>
<para>
<emphasis>Default value is <quote>60</quote> </emphasis>
</para>
<example>
<title>Set <varname>b2bl_th_init_timeout</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("b2b_logic", "b2bl_th_init_timeout", 60)
...
</programlisting>
</example>
</section>
</section>
<section id="exported_functions" xreflabel="exported_functions">
<title>Exported Functions</title>
<section id="func_b2b_init_request" xreflabel="b2b_init_request()">
<title>
<function moreinfo="none">b2b_init_request(id, [flags], [req_route],
[reply_route], [init_sdp_body], [init_sdp_ctype])</function>
</title>
<para>
This function initializes a new B2B session based on an initial INVITE.
A new server entity and a new client entity must be created before running
this function, with <xref linkend="func_b2b_server_new"/> and
<xref linkend="func_b2b_client_new"/>, respectively. These are the initial
entities to be connected and further scenario logic can be implemented in
the b2b_logic dedicated routes.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>scenario_id (string)</emphasis> - identifier for
the scenario of this B2B session. The special value <emphasis>top hiding</emphasis>
initializes an internal topology hiding scenario. This scenario will do
a simple pass-through of messages from one side to another, and no additional
scripting or dedicated routes are required.
</para></listitem>
<listitem><para>
<emphasis>flags (string, optional)</emphasis> - meanings of the flags is as follows:
<itemizedlist>
<listitem><para>
<emphasis>t[nn]</emphasis> - Call setup timeout for topology hiding scenario.
Example: t300.
</para></listitem>
<listitem><para>
<emphasis>a</emphasis> - Transparent authentication. In this mode b2b passes your 401
or 407 authentication request to destination server.
</para></listitem>
<listitem><para>
<emphasis>p</emphasis> - Preserve To: header.
</para></listitem>
<listitem><para>
<emphasis>s</emphasis> - Use init SDP (as described in the
<xref linkend="param_use_init_sdp"/> modparam) for this session.
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>
<emphasis>req_route (string, optional)</emphasis> - name of the script route
to be called when requests belonging to this B2B session are received. This
parameter will override the global <xref linkend="param_script_req_route"/>
modparam for this particular B2B session.
</para></listitem>
<listitem><para>
<emphasis>reply_route (string, optional)</emphasis> - name of the script route
to be called when replies belonging to this B2B session are received. This
parameter will override the global <xref linkend="param_script_reply_route"/>
modparam for this particular B2B session.
</para></listitem>
<listitem><para>
<emphasis>init_sdp_body (string, optional)</emphasis> - SDP body to use
as init SDP (see the <xref linkend="param_use_init_sdp"/> modparam).
</para></listitem>
<listitem><para>
<emphasis>init_sdp_ctype (string, optional)</emphasis> - Content type to use
for the init SDP (see the <xref linkend="param_use_init_sdp"/> modparam).
</para></listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<note><para>
If you have a multi interface setup and want to chance the outbound interface,
it is mandatory to use the "force_send_socket()" core function before passing
control to b2b function. If you do not do it, the requests may be correctly routed,
but the SIP pacakge may be invalid (as Contact, Via, etc).
</para></note>
<example>
<title><function>b2b_init_request</function> usage</title>
<programlisting format="linespecific">
...
if(is_method("INVITE") && !has_totag() && prepaid_user()) {
...
# create initial entities
b2b_server_new("server1");
b2b_client_new("client1", $var(media_uri));
# initialize B2B session
b2b_init_request("prepaid");
exit;
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_server_new" xreflabel="b2b_server_new()">
<title>
<function moreinfo="none">b2b_server_new(id, [extra_hdrs], [extra_hdr_bodies])</function>
</title>
<para>
This function creates a new server entity (dialog where OpenSIPS acts as a UAS)
to be used for initializing a new B2B session. It should only be
used for initial INVITES, before calling <xref linkend="func_b2b_init_request"/>.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>id (string)</emphasis> - ID used to reference this entity
in further B2B actions.
</para></listitem>
<listitem><para>
<emphasis>extra_hdrs (var, optioanl)</emphasis> - AVP variable holding a list
of extra headers (the header names) to be added for any request sent
to this entity.
</para></listitem>
<listitem><para>
<emphasis>extra_hdr_bodies (var, optional)</emphasis> - AVP variable holding a
list of extra header bodies (corresponding to the headers given in the
<emphasis>extra_hdrs</emphasis> parameter) to be added for any request
sent to this entity.
</para></listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>b2b_server_new</function> usage</title>
<programlisting format="linespecific">
...
if(is_method("INVITE") && !has_totag()) {
b2b_server_new("server1", $avp(b2b_hdrs), $avp(b2b_hdr_bodies));
...
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_client_new" xreflabel="b2b_client_new()">
<title>
<function moreinfo="none">b2b_client_new(id, dest_uri, [proxy], [from_dname],
[extra_hdrs], [extra_hdr_bodies])</function>
</title>
<para>
This function creates a new client entity (dialog where OpenSIPS acts as a UAC)
to be used for initializing a new B2B session or for a bridge action. The function
can be used before calling <xref linkend="func_b2b_init_request"/> or
<xref linkend="func_b2b_bridge"/>.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>id (string)</emphasis> - ID used to reference this entity
in further B2B actions.
</para></listitem>
<listitem><para>
<emphasis>dest_uri (string)</emphasis> - URI of the new destination.
</para></listitem>
<listitem><para>
<emphasis>proxy (string, optional)</emphasis> - URI of the outbound proxy
to send the INVITE to.
</para></listitem>
<listitem><para>
<emphasis>from_dname (string, optional)</emphasis> - Display name to
use in the From header.
</para></listitem>
<listitem><para>
<emphasis>extra_hdrs (var, optional)</emphasis> - AVP variable holding a list
of extra headers (the header names) to be added for any request sent
to this entity.
</para></listitem>
<listitem><para>
<emphasis>extra_hdr_bodies (var, optional)</emphasis> - AVP variable holding a
list of extra header bodies (corresponding to the headers given in the
<emphasis>extra_hdrs</emphasis> parameter) to be added for any request
sent to this entity.
</para></listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE and the b2b_logic request routes.
</para>
<example>
<title><function>b2b_client_new</function> usage</title>
<programlisting format="linespecific">
...
b2b_client_new("client1", "sip:alice@opensips.org");
...
</programlisting>
</example>
</section>
<section id="func_b2b_bridge" xreflabel="b2b_bridge()">
<title>
<function moreinfo="none">b2b_bridge(entity1, entity2, [provmedia_uri], [flags])</function>
</title>
<para>
This function bridges two entities, in the context of an existing B2B session
(the initial entities are already connected). At least one of the two entities
has to be a new client entity. If an existing entity is provided, the first step
will be to send it a reINVITE.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>entity1 (string)</emphasis> - ID of the first entity to bridge;
the special values: <emphasis>peer</emphasis> and <emphasis>this</emphasis>
can also be used to refer to existing entities.
</para></listitem>
<listitem><para>
<emphasis>entity2 (string)</emphasis> - ID of the second entity to bridge;
the special values: <emphasis>peer</emphasis> and <emphasis>this</emphasis>
can also be used to refer to existing entities.
</para></listitem>
<listitem><para>
<emphasis>provmedia_uri (string, optional)</emphasis> - URI of the provisional
media server to be connected with the caller while the callee answers.
</para></listitem>
<listitem><para>
<emphasis>flags (string, optional)</emphasis> - meanings of the flags is as follows:
<itemizedlist>
<listitem><para>
<emphasis>t[nn]</emphasis> - Maximum duration of the B2B
session. If the lifetime expires, the B2BUA will send BYE messages to both
ends and delete the record.
Example: t300.
</para></listitem>
<listitem><para>
<emphasis>n</emphasis> - Enable rfc3515 NOTIFY to inform the agent sending the
REFER of the status of the reference.
</para></listitem>
<listitem><para>
<emphasis>f</emphasis> - Rollback call to state before bridging in case of transfer
failed, don't hangup the call (default behaviour).
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
<para>
This function can be used from the b2b_logic request routes.
</para>
<example>
<title><function>b2b_bridge</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_request] {
...
b2b_client_new("client2", $hdr(Refer-To));
b2b_bridge("peer", "client2");
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_pass_request" xreflabel="b2b_pass_request()">
<title>
<function moreinfo="none">b2b_pass_request()</function>
</title>
<para>
This function passes a request belonging to an existing B2B session
to the peer entity. The function should be called for all requests unless
a different action is required to implement the scenario logic (eg. a
bridge action).
</para>
<para>
This function can be used from the b2b_logic request routes.
</para>
<example>
<title><function>b2b_pass_request</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_request] {
if ($rm != "BYE") {
b2b_pass_request();
exit;
} else {
# delete the current entity and bridge the peer to a new one
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_handle_reply" xreflabel="b2b_handle_reply()">
<title>
<function moreinfo="none">b2b_handle_reply()</function>
</title>
<para>
This function processes the received reply by taking the appropriate actions
for the current state of the ongoing B2B session (pass reply to peer,
send INVITE or ACK to comeplete an ongoing bridge action etc.).
The function should be called for all replies, if a b2b_logic reply
route is defined.
</para>
<para>
This function can be used from the b2b_logic reply routes.
</para>
<example>
<title><function>b2b_handle_reply</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_reply] {
xlog("B2B REPLY: [$rs $rm] from entity: $b2b_logic.entity(id)\n");
b2b_handle_reply();
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_send_reply" xreflabel="b2b_send_reply()">
<title>
<function moreinfo="none">b2b_send_reply(code, reason)</function>
</title>
<para>
This function sends a reply to the entity that sent the current
request.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>code (int)</emphasis> - reply code
</para></listitem>
<listitem><para>
<emphasis>reason (string)</emphasis> - reply reason string
</para></listitem>
</itemizedlist>
<para>
This function can be used from the b2b_logic request routes.
</para>
<example>
<title><function>b2b_send_reply</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_request] {
if ($rm == "REFER") {
b2b_send_reply(202, "Accepted");
...
}
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_delete_entity" xreflabel="b2b_delete_entity()">
<title>
<function moreinfo="none">b2b_delete_entity()</function>
</title>
<para>
This function deletes the entity that sent the current request.
</para>
<para>
This function can be used from the b2b_logic request routes.
</para>
<example>
<title><function>b2b_delete_entity</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_request] {
if ($rm == "BYE") {
b2b_send_reply(200, "OK");
b2b_delete_entity();
...
}
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_end_dlg_leg" xreflabel="b2b_end_dlg_leg()">
<title>
<function moreinfo="none">b2b_end_dlg_leg()</function>
</title>
<para>
This function sends a BYE request to the entity that sent
the current request. It is not required to also call
<xref linkend="func_b2b_delete_entity"/> in order to delete
the current entity.
</para>
<para>
This function can be used from the b2b_logic request or reply routes.
</para>
<example>
<title><function>b2b_end_dlg_leg</function> usage</title>
<programlisting format="linespecific">
...
route[b2b_logic_request] {
if ($rm == "REFER") {
b2b_send_reply(202, "Accepted");
b2b_end_dlg_leg();
}
}
...
</programlisting>
</example>
</section>
<section id="func_b2b_bridge_request" xreflabel="b2b_bridge_request()">
<title>
<function moreinfo="none">b2b_bridge_request(b2bl_key,entity_no)</function>
</title>
<para>
This function will bridge an initial INVITE with one of the
particapnts from an existing b2b session.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>b2bl_key (string)</emphasis> - a string that
contains the b2b_logic key. The key can also be in the form
of <emphasis>callid;from-tag;to-tag</emphasis>.
</para></listitem>
<listitem><para>
<emphasis>entity_no (int)</emphasis> - an integer that
holds the entity of the entity/participant to bridge.
</para></listitem>
</itemizedlist>
<example>
<title><function>b2b_bridge_request</function> usage</title>
<programlisting format="linespecific">
...
modparam("b2b_entities", "script_req_route", "b2b_request")
...
route[b2b_request]
{
# incoming requests from the B2B entities
...
if ($ci~="^B2B") { #keep this aligned with b2b_key_prefix
# request coming from the UAC side;
# the Call-ID carries the B2B key ID
if (is_method("BYE") {
$var(entity) = 1;
b2b_bridge_request($ci,$var(entity));
}
}
...
}
...
</programlisting>
</example>
</section>
</section>
<section id="exported_mi_functions" xreflabel="Exported MI Functions">
<title>Exported MI Functions</title>
<section id="mi_b2b_trigger_scenario" xreflabel="b2b_trigger_scenario">
<title>
<function moreinfo="none">b2b_trigger_scenario</function>
</title>
<para>
This command initializes a new B2B session where OpenSIPS will start
a call from the middle. The initial entities to be connected are
specified through the command's parameters and further scenario logic
can be implemented in the b2b_logic dedicated routes.
</para>
<para>
Name: <emphasis>b2b_trigger_scenario</emphasis>
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem>
<para><emphasis>senario_id</emphasis> : ID for the scenario of this B2B session.
</para>
</listitem>
<listitem>
<para><emphasis>entity1</emphasis> - first entity to be connected; specified
in the following format: <emphasis>id,dest_uri[,from_dname]</emphasis> where:</para>
<itemizedlist>
<listitem><para>
<emphasis>id</emphasis> - ID used to reference this entity
in further B2B actions
</para></listitem>
<listitem><para>
<emphasis>dest_uri</emphasis> - URI of the new destination
</para></listitem>
<listitem><para>
<emphasis>from_dname (optional)</emphasis> - Display name to
use in the From header.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<para><emphasis>entity2</emphasis> - second entity to be connected;
specified in the same format as <emphasis>entity1</emphasis></para>
</listitem>
<listitem>
<para><emphasis>context (array, optional)</emphasis> - array of B2B
context values, in the format: <emphasis>key=value</emphasis></para>
</listitem>
</itemizedlist>
<para>
MI FIFO Command Format:
</para>
<programlisting format="linespecific">
opensips-cli -x mi b2b_trigger_scenario marketing client1,sip:bob@opensips.org client2,sip:322@opensips.org:5070 agent_uri=sip:alice@opensips.org
</programlisting>
</section>
<section id="mi_b2b_bridge" xreflabel="b2b_bridge">
<title>
<function moreinfo="none">b2b_bridge</function>
</title>
<para>
This command can be used by an external application to tell B2BUA to bridge a
call party from an on going dialog to another destination. By default the caller
is bridged to the new uri and BYE is set to the callee. You can instead bridge
the callee if you send 1 as the third parameter.
</para>
<para>
Name: <emphasis>b2b_bridge</emphasis>
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem>
<para><emphasis>dialog_id</emphasis> : the <emphasis>b2b_logic key</emphasis>, or the
<emphasis>callid;from-tag;to-tag</emphasis> of the ongoing dialog.
</para>
</listitem>
<listitem>
<para><emphasis>new_uri</emphasis> - the uri of the new destination</para>
</listitem>
<listitem>
<para><emphasis>flag</emphasis> (optional) - used to specify that the callee must be bridged to the new destination. If not present the caller will be bridged. Possible values are
'0' or '1'.</para>
</listitem>
<listitem>
<para><emphasis>prov_media_uri</emphasis> (optional) - the uri of a media server able to play
provisional media starting from the beginning of the bridging scenario
to the end of it. It is optional. If not present, no other entity will be
envolved in the bridging scenario</para>
</listitem>
</itemizedlist>
<para>MI FIFO Command Format:</para>
<programlisting format="linespecific">
opensips-cli -x mi b2b_bridge 1020.30 sip:alice@opensips.org
</programlisting>
<para>opensips-cli Command Format:</para>
<programlisting format="linespecific">
opensips-cli -x mi b2b_bridge 1020.30 sip:alice@opensips.org
</programlisting>
</section>
<section id="mi_b2b_list" xreflabel="b2b_list">
<title>
<function moreinfo="none">b2b_list</function>
</title>
<para>
This command can be used to list the internals of b2b_logic entities.
</para>
<para>
Name: <emphasis>b2b_list</emphasis>
</para>