한국어

소프트스위치

온누리070 플레이스토어 다운로드
    acrobits softphone
     온누리 070 카카오 프러스 친구추가온누리 070 카카오 프러스 친구추가친추
     카카오톡 채팅 상담 카카오톡 채팅 상담카톡
    
     라인상담
     라인으로 공유

     페북공유

   ◎위챗 : speedseoul


  
     PAYPAL
     
     PRICE
     

pixel.gif

    before pay call 0088 from app


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.

조회 수 :
13738
등록일 :
2017.12.20
14:17:56 (*.160.88.18)
엮인글 :
http://webs.co.kr/index.php?document_srl=3312418&act=trackback&key=9e8
게시글 주소 :
http://webs.co.kr/index.php?document_srl=3312418
List of Articles
번호 제목 글쓴이 날짜 조회 수
168 opensips basic route script configuration admin 2023-08-13 6261
167 opensips-cli command admin 2023-08-07 6698
166 string trans opensips admin 2023-08-05 4896
165 opensips Push Notification configuration admin 2023-07-29 4966
164 opensips Call pickup configuration admin 2023-07-27 4874
163 t_relay opensips admin 2023-07-25 4774
162 debian 11 opensips 3.2 install command admin 2023-06-25 9102
161 Opensips Gateway between SIP and SMPP messages admin 2019-02-19 265066
160 smpp sms opensips admin 2019-02-19 11001
159 Busy Lamp Field (BLF) feature on Opensips 2.4.0 with Zoiper configuration admin 2018-05-29 20532
158 Documentation -> Tutorials -> WebSocket Transport using OpenSIPS admin 2018-05-17 17103
157 List of SIP response codes admin 2017-12-20 40753
» opensips/modules/event_routing/ Push Notification Call pickup admin 2017-12-20 13738
155 opensips push notification How to detail file admin 2017-12-20 23923
154 OpenSIPS routing logic admin 2017-12-12 45546
153 OpenSIPS example configuration admin 2017-12-12 17698
152 opensips complete configuration example admin 2017-12-10 40806
151 Opensips1.6 ebook detail configuration and SIP signal and NAT etc file admin 2017-12-10 71070
150 dictionary.opensips radius admin 2017-12-09 93819
149 what is record_route() in opensips ? admin 2017-12-09 23541
148 what is loose_route() in opensips ? file admin 2017-12-09 22953
147 in opensips what is lookup(domain [, flags [, aor]]) admin 2017-12-09 90090
146 in opensips db_does_uri_exist() what is admin 2017-12-09 17481
145 in opensips what is has_totag() admin 2017-12-09 21228
144 opensips exec module admin 2017-12-08 17892
143 opensips push notification How to admin 2017-12-07 20697
142 OpenSIPS Module Interface admin 2017-12-07 41327
141 opensips configuration config explain easy basic 오픈쉽스 컨피그레이션 기본 설명 file admin 2017-12-07 21118
140 openssl 을 이용한 인증서 생성 절차를 정리한다. 개인키 CSR SSL 인증서 파일 생성 admin 2017-09-14 22931
139 Documentation -> Tutorials -> TLS opensips.cfg admin 2017-09-14 23981