소프트스위치

오늘:
1,984
어제:
2,178
전체:
2,982,799

고객센타 : 070-7752-2000
팩스 : 070-7752-2001
휴대폰 : 010-9513-0019
email : voipkorea@yahoo.co.kr

국민은행
(주)제이에스솔루션
047101-04-155519

Flag Counter
■ 무료 : 유선 집전화 휴대폰 ( 한국 미국 중국 카나다) ↔ (국내 해외 여행자 상사 주재원 유학생) / 가입무 무제한무료■

https://github.com/OpenSIPS/opensips/tree/master/modules/event_routing


Event (based) Routing Module

Bogdan-Andrei Iancu

Edited by

Bogdan-Andrei Iancu

   Copyright © 2017 OpenSIPS Solutions
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSIPS Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters
        1.4. Exported Functions

              1.4.1. notify_on_event(event, filter, route,
                      timeout)

        1.5. Exported Asynchronous Functions

              1.5.1. wait_for_event(event,filter,timeout)

        1.6. Usage Examples

              1.6.1. Push Notification
              1.6.2. Call pickup

   2. Developer Guide

        2.1.

   3. Frequently Asked Questions

   List of Examples

   1.1. notify_on_event() usage
   1.2. wait_for_event usage
   1.3. Push Notification script
   1.4. Call Pickup script

Chapter 1. Admin Guide

1.1. Overview

   The Event (based) Routing module, or shortly the EBR module,
   provides a mechanism that allows different SIP processings (of
   messages in script) to communicate and synchronize between
   through OpenSIPS Events (see
   http://www.opensips.org/Documentation/Interface-Events-2-3).

   This mechanism is based on the Subscribe-Notify concept. Any
   SIP processing may subscribe to various OpenSIPS Events Upon
   Event raising, the subscriber will be notified, so it will be
   able to make use of the data attached to the Event. Note that
   the Event raising may take place in a completely different SIP
   processing context, completely unrelated to the subscriber
   processing.

   Also, the Events are generated either internally by OpenSIPS
   (predefined Events), either from the script level (custom
   Events). Please refer to the Event Interface documentation for
   more on how the Events are generated
   (http://www.opensips.org/Documentation/Interface-Events-2-3).

   Depending on how the notification is handled by the subscribing
   processing, we distinguish two main scenarios:
     * The subscriber waits in async. mode for the receiving the
       notification; the processing of the subscriber will suspend
       and it will be fully resumed when the notification is
       received (or a timeout occurs).
     * The subscriber continues its processing after subscription,
       without any waiting. Whenever a notification is received, a
       script route (armed by the subscription) will be executed.
       Note that this notification route is executed outside any
       context of the original processing (nothing is inherited in
       this route). The Event triggering the notification is
       exposed in the notification route, via AVP variables.

   So, EBR allows your SIP processing to synchronize or the
   exchange info between, even if these processings are completely
   unrelated from SIP, time or handling perspective.

   With the help of the EBR support, more advanced routing
   scenarios are possible now, scenarios where you need to handle
   and put together different processing as type and time, like
   the handling of various calls with the handling of
   registrations or with the DTMF extraction. For more, see the
   Examples section.

1.2. Dependencies

1.2.1. OpenSIPS Modules

   The following modules are required by this module:
     * TM - Transaction module

1.2.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running OpenSIPS with this module loaded:
     * None.

1.3. Exported Parameters

   This module does not provide any script parameters.

1.4. Exported Functions

1.4.1.  notify_on_event(event, filter, route, timeout)

   This function creates a subscription to a given Event. A filter
   can be used (over the attributes of the Event) in order to
   filter even more the needed notifications (only Events matching
   the filter will be notified to this subscriber).

   Upon Event notification, the given script route (usually called
   notification route) will be executed. No variables, SIP
   message, SIP transaction/dialog or any other context related to
   subscriber will be inherited from subscriber processing into
   this notification route.

   The Event attributes will be exposed in the notification route
   via AVP variables as $avp(attr_name) = attr_value.

   As an exception, in the notification route, the EBR module will
   make available the transaction ID from the subscriber context.
   Note that it's not the transaction itself, but its ID. There
   are some TM functions (like t_inject_branches) which can
   operate on transactions based on their ID. Of course, you need
   to have a transaction create in the subscriber processing
   before calling the notify_on_event() function.

   This function can be used from REQUEST_ROUTE.

   Parameters:
     * event -the name of the Event to subscribe for
     * filter - a AVP variable holding (as multi value array) all
       the filters to be applied on the event (before
       notification). The filter value has the format "key=value"
       where the "key" must match an attribute name of the Event.
       The "value" is the desired value for the attribute; it may
       be a shell wildcard pattern. Ex: "aor=bob@*"
     * route -the name of the script route to be executed upon
       Event notification
     * timeout - for how long the subscription is active before
       expiring (integer in seconds). Note: during its lifetime, a
       subscription may be notified several or zero times.

   Example 1.1. notify_on_event() usage
...
$avp(filter) = "aor=*@opensips.org"
notify_on_event("E_UL_AOR_INSERT","$avp(filter)","reg_done","60");
...
route[reg_done] {
        xlog("a new user $avp(aor) registered with opensips.org domain\n
");
}

1.5. Exported Asynchronous Functions

1.5.1.  wait_for_event(event,filter,timeout)

   Similar to the notify_on_event, this function creates an Event
   subscriber for the given event and filter. But this function
   will do async waiting (with suspend and resume) for receiving
   the notification on the desired Event.

   The meaning of the parameters is the same as for
   notify_on_event.

   Example 1.2. wait_for_event usage
...
# wait for callee to register
$avp(filter) = "aor="+$rU+"@"+$rd
async( wait_for_event("E_UL_AOR_INSERT","$avp(filter)", "40"),  resume_c
all);
# done
...
route[resume_call] {
        xlog("user $avp(aor) is now registered\n");
        lookup("location");
        t_relay();
}

1.6. Usage Examples

1.6.1.  Push Notification

   We use notify_on_event to capture the events on new contact
   registrations for callee. Once the call is sent to callee,
   based on the notification (for new contacts) we inject the
   newly registered contacts as new branches in the ongoing
   transaction.

   Schematics : when we send a call to a user, we subscribe to see
   any new contacts being registered by the user. On such a
   notification, we add the new contact as a new branch to the
   ongoing transaction (ringing) to user.

   Example 1.3. Push Notification script
...
route[route_to_user] {

    # prepare transaction for branch injection; it is mandatory
    # to create the transaction before the subscription, otherwise
    # the EBR module will not pass the transaction ID into the
    # notification route
    t_newtran();

    # keep the transaction alive (even if all branches will
    # terminate) until the FR INVITE timer hits (we want to wait
    # for new possible contacts being registered)
    t_wait_for_new_branches();

    # subscribe to new contact registration event,
    # but for our callee only
    $avp(filter) = "aor="+$rU;
    notify_on_event("E_UL_CONTACT_INSERT","$avp(filter)",
        "fork_call", "20");

    # fetch already registered contacts and relay if any
    if (lookup("location"))
        route(relay);
    # if there were no contacts available (so no branches
    # created so far), the created transaction will still be
    # waiting for new branches due to the usage of the
    # t_wait_for_new_branches() function

    exit;
}

route[fork_call]
{
    xlog("user $avp(aor) registered the a new "
        "contact $avp(uri), injecting\n");
    # take the contact described by the E_UL_CONTACT_INSERT
    # event and inject it as a new branch into the original
    # transaction
    t_inject_branches("event");
}
...

1.6.2.  Call pickup

   The scenario is Alice calling to bob, Bob does not pickup and
   Charlie is performing call pickup (to get the call from Alice)

   We use notify_on_event to link the two calls: the one from
   Alice to Bob and the one from Charlie to call pickup service.

   Schematics: when we send a call to a user within a pickup
   group, we subscribe to see if there is any call to the pickup
   service (from another member of the same pickup group). When we
   have a call to the pickup service, we raise from script an
   event - this event will be notified to the first call and we
   cancel the branches to Bob and inject the registered contacts
   for the user calling to pickup group (Charlie).

   Example 1.4. Call Pickup script
...
route[handle_call]
    if ($rU=="33") {
        ## this is a call to the pickup service
        ## (Charlie calling 33)

        # reject incoming call as we will generate an back call
        # from the original call (Alice to Bob)
        t_newtran();
        send_reply("480","Gone");

        # raise the pickup custom event
        # with pickup group 1 and picker being Charlie (caller)
        $avp(attr-name) = "group";
        $avp(attr-val) = "1";
        $avp(attr-name) = "picker";
        $avp(attr-val) = $fu;
        raise_event("E_CALL_PICKUP", $avp(attr-name), $avp(attr-val));

        exit;
    } else {

        ## this is a call to a subscriber
        ## (Alice calls Bob)

        # apply user location
        if (!lookup("location","m")) {
            send_reply("404", "Not Found");
            exit;
        }

        # prepare transaction for branch injection; it is mandatory
        # to create the transaction before the subscription, otherwise
        # the EBR module will not pass the transaction ID into the
        # notification route
        t_newtran();

        # subscribe to a call pickup event, but for our group only
        $avp(filter) = "group=1";
        notify_on_event("E_CALL_PICKUP","$avp(filter)",
            "handle_pickup", "20");

        t_relay();
    }
    exit;
}

route[handle_pickup]
{
    xlog("call picked by $avp(picker), fetching its contacts\n");
    if (lookup("location","", "$avp(picker)")) {
        # take the contacts retured by lookup() (for Charlie)
        # and inject them into the original call, but also cancel
        # any existing ongoing branch (ringing to Bob)
        t_inject_branches("msg","cancel");
    }
}

Chapter 2. Developer Guide

   This modules does not export any internal API.

Chapter 3. Frequently Asked Questions

   3.1.

   Where can I find more about OpenSIPS?

   Take a look at http://www.opensips.org/.

   3.2.

   Where can I post a question about this module?

   First at all check if your question was already answered on one
   of our mailing lists:
     * User Mailing List -
       http://lists.opensips.org/cgi-bin/mailman/listinfo/users
     * Developer Mailing List -
       http://lists.opensips.org/cgi-bin/mailman/listinfo/devel

   E-mails regarding any stable OpenSIPS release should be sent to
   <users@lists.opensips.org> and e-mails regarding development
   versions should be sent to <devel@lists.opensips.org>.

   If you want to keep the mail private, send it to
   <users@lists.opensips.org>.

   3.3.

   How can I report a bug?

   Please follow the guidelines provided at:
   https://github.com/OpenSIPS/opensips/issues.

조회 수 :
273
등록일 :
2017.12.20
14:17:56 (*.160.88.18)
엮인글 :
http://webs.co.kr/index.php?document_srl=3312418&act=trackback&key=74a
게시글 주소 :
http://webs.co.kr/index.php?document_srl=3312418
List of Articles
번호 제목 글쓴이 날짜 조회 수
158 List of SIP response codes admin 2017-12-20 314
» opensips/modules/event_routing/ Push Notification Call pickup admin 2017-12-20 273
156 opensips push notification How to detail file admin 2017-12-20 278
155 OpenSIPS routing logic admin 2017-12-12 310
154 OpenSIPS example configuration admin 2017-12-12 313
153 opensips log output admin 2017-12-11 319
152 opensips complete configuration example admin 2017-12-10 365
151 Opensips1.6 ebook detail configuration and SIP signal and NAT etc file admin 2017-12-10 382
150 dictionary.opensips radius admin 2017-12-09 623
149 what is record_route() in opensips ? admin 2017-12-09 609
148 what is loose_route() in opensips ? file admin 2017-12-09 627
147 in opensips what is lookup(domain [, flags [, aor]]) admin 2017-12-09 637
146 in opensips db_does_uri_exist() what is admin 2017-12-09 609
145 in opensips what is has_totag() admin 2017-12-09 631
144 opensips exec module admin 2017-12-08 671
143 opensips push notification How to admin 2017-12-07 625
142 OpenSIPS Module Interface admin 2017-12-07 651
141 opensips configuration config explain easy basic 오픈쉽스 컨피그레이션 기본 설명 file admin 2017-12-07 655
140 openssl 을 이용한 인증서 생성 절차를 정리한다. 개인키 CSR SSL 인증서 파일 생성 admin 2017-09-14 1521
139 Documentation -> Tutorials -> TLS opensips.cfg admin 2017-09-14 1545
138 Using TLS in OpenSIPS v2.2.x admin 2017-09-14 1501
137 opensips tls cfg admin 2017-09-14 1578
136 How to setup a Jabber / XMPP server on Debian 8 (jessie) using ejabberd admin 2017-09-13 1588
135 SIP to XMPP Gateway + SIP Presence Server opensips admin 2017-09-13 1507
134 OpenSIPS command line tricks admin 2017-09-13 1504
133 Fail2Ban Freeswitch How to secure admin 2017-09-12 1571
132 opensips.cfg. sample admin 2017-09-12 1509
131 Advanced SIP scenarios with Event-based-Routing admin 2017-09-11 1561
130 PUSH SERVER 푸시서버 안드로이드 애플 admin 2017-09-11 1562
129 오픈소스 (사내)메신저 서버 구축, 오픈 파이어(openfire) 설치방법과 세팅(리눅스 기준) admin 2017-09-09 1713
128 rtpengine config basic and opensips configuration and command admin 2017-09-06 1590
127 WebSocket Transport using OpenSIPS configuration 웹 소켓 컨피그레이션 기본 admin 2017-09-06 1555
126 OpenSIPS basic configuration script 기본 컨피그 admin 2017-09-05 1598
125 rtpengine install and config admin 2017-09-05 1620
124 Installing RTPEngine on Ubuntu 14.04 admin 2017-09-05 1643
123 compile only the textops module make modules=modules/textops modules admin 2017-09-05 1598
122 opensips command /sbin/opensipsctl detail admin 2017-09-04 1604
121 2017 08 31 opensips 2.32 install debian8.8 module install compile err modules admin 2017-09-04 1626
120 Build-Depends debian 8.8 opensips 2.3 admin 2017-09-04 1574
119 What is new in 2.3.0 opensips admin 2017-09-04 1747
118 ubuntu 安装配置opensips,rtpproxy,mediaproxy admin 2017-09-04 1587
117 How to install Mediaproxy 2.5.2 on CentOS 6 64 bit admin 2017-09-04 1655
116 Using TLS in OpenSIPS v2.2.x configuration admin 2017-09-04 1652
115 How to 2.3 download , OpenSIPS new apt repository. DEBs for Debian / Ubuntu admin 2017-09-02 1624
114 You can install CDRTool in the following ways: admin 2017-09-01 1667
113 How to Install OpenSIPS 2.1.2 Server on Ubuntu 15.04 admin 2017-09-01 1710
112 Opensips 2.32 download admin 2017-09-01 1607
111 OpenSIPS 2.3 install admin 2017-09-01 1735
110 JsSIP: The JavaScript SIP Library admin 2017-09-01 1666
109 WebSocket Transport using OpenSIPS admin 2017-09-01 1715
108 A2Billing and OpenSIPS – Part 1 admin 2017-08-29 1677
107 A2Billing and OpenSIPS – Part 2 admin 2017-08-29 1659
106 A2Billing and OpenSIPS – Part 3 admin 2017-08-29 1695
105 OpenSIPS 2.3 philosophy admin 2017-08-17 1877
104 The timeline for OpenSIPS 2.3 is admin 2017-08-17 2003
103 OpenSIPS Control Panel and Homer integration admin 2017-08-17 1725
102 Opensips sip capture re designed admin 2017-07-16 1923
101 WebRTC with OpenSIPS WebSocket is a protocol provides full-duplex admin 2015-04-04 6656
100 WebSocket Support in OpenSIPS 2.1 admin 2015-04-04 7229
99 OpenSIPS 2.1 (rc) is available, download now! admin 2015-03-22 6783
98 Service Provision Using Asterisk & OpenSIPS - AstriCon 2014 admin 2015-02-25 8378
97 SIP Signaling-Messages OpenSIPS Running On Multicore Server file admin 2014-11-02 16029
96 opensips.cfg for Asterisk admin 2014-10-20 18170
95 A2Billing and OpenSIPS config admin 2014-10-20 17532
94 Jitsi Videobridge meets WebRTC admin 2014-10-18 17607
93 A Survey of Open Source Products for Building a SIP Communication Platform admin 2014-10-18 17184
92 Script Function , Module Index v1.11 함수 모듈 opensips admin 2014-10-14 17373
91 Opensips TM module enables stateful processing of SIP transactions admin 2014-10-04 15096
90 kamailio.cfg configuration Example admin 2014-10-04 17260
89 opensips NAT Traversal Module admin 2014-10-02 16619
88 UAC Registrant Module admin 2014-09-28 18171
87 MediaProxy 2.3.x & OpenSIPS 1.5.x Integration admin 2014-08-24 17251
86 RTPPROXY Admin Guide admin 2014-08-24 17616
85 CANCEL MESSAGE not handled correctly admin 2014-08-23 17433
84 [Sipdroid] SIP data collection study tour admin 2014-08-23 18043
83 [OpenSIPS-Users] Opensips 1.10 NAT radius aaa admin 2014-08-23 18016
82 OpenSIPS Consultancy Pricing module install Server 판매 또는 설치및 컨설팅 가이드 admin 2014-08-23 17900
81 ICE: The ultimate way of beating NAT in SIP admin 2014-08-23 17675
80 Many OPENSIPS Configuration Examples This will Help you admin 2014-08-23 17338
79 Real-time Charging System for Telecom & ISP environments admin 2014-08-23 17948
78 OPENSIPS EBOOK admin 2014-08-21 17966
77 Opensips Documentation Function admin 2014-08-21 18142
76 Presence Tutorial OpenXCAP setup admin 2014-08-18 17193
75 Opensips Modules Documentation admin 2014-08-18 18047
74 A lightweight RPC library based on XML and HTTP admin 2014-08-18 17541
73 opensips Nat script with RTPPROXY - English Good perfect admin 2014-08-15 15675
72 OpenSIPS Control Panel (OCP) Installation Guide Good admin 2014-08-13 15553
71 Installation and configuration process record opensips opensips-cp admin 2014-08-13 28819
70 OpenSIPS as Homer Capture server admin 2014-08-13 15389
69 OpenSIPS , default script , Types of Routs , Routing in SIP, Video lecture admin 2014-08-13 17339
68 Configuracion de Kamailio 3.3 con NAT Traversal y XCAP. admin 2014-08-12 17753
67 Under RHEL6.5 install OpenSIPS 1.11.1 tls admin 2014-08-12 16665
66 OpenSIPS/OpenSER-a versatile SIP Server cfg admin 2014-08-11 18087
65 Kamailio Nat Traversal using RTPProxy admin 2014-08-11 17658
64 MediaProxy wiki page install configuration admin 2014-08-11 17670
63 오픈소스 (사내)메신저 서버 구축, 오픈 파이어(openfire) 설치방법과 세팅 admin 2014-08-11 26610
62 MediaProxy Installation Guide admin 2014-08-10 17259
61 RTPProxy 1.2.x Installation & Integration with OpenSIPS 1.5x admin 2014-08-10 18440
60 Opensips Installation, How to. Good guide wiki page admin 2014-08-10 15304
59 OpenSIPS Installation Notes admin 2014-08-09 14611
58 Installation and configuration process record opensips 1.9.1 admin 2014-08-09 17185
57 opensips 1.11.2 install Good Giide admin 2014-08-09 17253
56 fusionPBX install debian wheezy admin 2014-08-09 17546
55 opensips 1.11.2 install guide good 인스톨 가이드 admin 2014-08-09 17070
54 SigIMS IMS Platform admin 2014-05-24 18291
53 2013 2012년 분야별 최고의 오픈소스 소프트웨어 124선 admin 2014-04-05 19118
52 Video conference server OpenMCU-ru - Introduction admin 2014-04-01 20461
51 SIPSorcery admin 2014-03-18 18547
50 Ekiga (formely known as GnomeMeeting) is an open source SoftPhone admin 2014-03-12 18919
49 telepresence: Open Source SIP Telepresence/MCU admin 2014-03-12 20984
48 SIP PBX - OpenSIPS and Asterisk configuration admin 2014-03-12 16777
47 Conference Support in Kamailio (OpenSER) admin 2014-03-12 19250
46 OpenSIPS configuration for 2 or more FreeSWITCH installs admin 2014-03-12 16581
45 The Impact of TLS on SIP Server Performance file admin 2014-03-12 18733
44 book-opensips-101 / content / 3.2. SIP TLS Secure Calling.mediawiki admin 2014-03-12 17693
43 Where to check OpenSIPS does not start? admin 2014-03-09 18205
42 opensips-1.10.0_src.tar.gz experimental source code documentation admin 2014-03-09 19096
41 Kamailo OpenSIPs installation on Debian admin 2014-03-09 17567
40 Using the openSIPS Registrant Module admin 2014-03-09 19111
39 RTPproxy Frequentry Asked Questions (FAQ) ¶ admin 2014-03-07 17104
38 Building Telephony Systems with OpenSIPS 1.6 RTPProxy + OpenSIPS 1.7 admin 2014-03-07 18612
37 Installing RTPproxy Start RTPproxy in Bridged mode very good admin 2014-03-07 22759
36 OpenSIPS Control Panel (OCP) Installation Guide admin 2014-03-06 16977
35 OpenSIPS Control Panel install guide admin 2014-03-06 17873
34 rtpproxy Module admin 2014-03-06 18610
33 MediaProxy Installation Guide admin 2014-03-06 19514
32 How to install OpenSIPS on CentOS debian module add xcap admin 2014-03-06 19204
31 Problem with presence_xml module Opensips 1.9 admin 2014-03-06 18732
30 Building Telephony Systems with OpenSIPS 1.6 books file admin 2014-03-06 19622
29 Multimedia Service Platform admin 2014-03-06 18017
28 How to install OpenSIPS on CentOS Debian etc admin 2014-03-05 19010
27 Opensips Installation, How to. admin 2014-03-05 15444
26 100% CPU usage opensips admin 2014-03-05 18337
25 A2Billing and OpenSIPS admin 2014-03-04 19240
24 Opensips_1.9 install guide this is great I like this admin 2014-03-04 23424
23 Opensips install debian admin 2014-03-03 19312
22 Open Source VOIP applications, both clients and servers. admin 2013-11-20 19627
21 OfficeSIP Server is freeware VoIP, SIP server for Windows admin 2013-09-11 20293
20 My new toy: Bluebox-ng admin 2013-04-06 33688
19 Flooding Asterisk, Freeswitch and Kamailio with Metasploit admin 2013-04-06 29441
18 Asterisk Installation Asterisk Realtime configuration admin 2013-04-06 23070
17 The SIP Router Project admin 2013-04-06 22120
16 Kamailio :: A Quick Introduction admin 2013-04-06 19238
15 Welcome to the Smartvox Knowledgebase admin 2013-04-06 19925
14 Kamailio 3.3.x and Asterisk 10.7.0 Realtime Integration using Asterisk Database admin 2013-04-06 23466
13 OpenSIPS vs Asterisk admin 2013-04-06 33315
12 OpenSER_from_an_asterisk_POV file admin 2013-04-06 19854
11 Using SIP Devices behind NAT OPensip Asterisk IPPhone SIP Telephony file admin 2013-03-31 38396
10 rfc5766-turn-server admin 2013-03-21 21735
9 OpenSIPS Kick Start‎: VIDEO admin 2013-02-20 19119