소프트스위치

오늘:
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://www.opensips.org/Documentation/Script-Routes-2-4




OpenSIPS routing logic uses several types of routes. Each type of route is triggered by a certain event and allows you to process a certain type of message (request or reply).


1. route

Request routing block. It contains a set of actions to be taken for SIP requests.

Triggered by : receiving an external request from the network.

Processing : the triggering SIP request.

Type : initially stateless, may be forced to stateful by using TM functions.

Default action : if the request is not either forwarded nor replied, the route will simply discard the request at the end.

The main 'route' block identified by 'route{...}' or 'route[0]{...}' is executed for each SIP request.

The implicit action after execution of the main route block is to drop the SIP request. To send a reply or forward the request, explicit actions must be called inside the route block.

Example of usage:

    route {
         if(is_method("OPTIONS")) {
            # send reply for each options request
            sl_send_reply("200", "ok");
            exit();
         }
         route(1);
    }
    route[1] {
         # forward according to uri
         forward();
    }

Note that if a 'route(X)' is called from a 'branch_route[Y]' then in 'route[X]' is just processed each separate branch instead of all branches together as occurs in main route.


2. branch_route

Request's branch routing block. It contains a set of actions to be taken for each branch of a SIP request.

Triggered by : preparation a new branch (of a request); the branch is well formed, but not yet sent out.

Processing : the SIP request (with the branch particularities, like RURI, branch flags)

Type : stateful

Default action : if the branch is not dropped (via "drop" statement), the branch will be automatically sent out.

It is executed only by TM module after it was armed via t_on_branch("branch_route_index").

Example of usage:

    route {
        lookup("location");
        t_on_branch("1");
        if(!t_relay()) {
            sl_send_reply("500", "relaying failed");
        }
    }
    branch_route[1] {
        if($ru=~"10\.10\.10\.10") {
            # discard branches that go to 10.10.10.10
            drop();
        }
    }

3. failure_route

Failed transaction routing block. It contains a set of actions to be taken each transaction that received only negative replies (>=300) for all branches.

Triggered by : receiving or generation(internal) of a negative reply that completes the transaction (all branches are terminated with negative replies)

Processing : the original SIP request (that was sent out)

Type : stateful

Default action : if no new branch is generated or no reply is forced over, by default, the winning reply will be sent back to UAC.

The 'failure_route' is executed only by TM module after it was armed via t_on_failure("failure_route_index").

Note that inside the 'failure_route', the request that initiated the transaction is being processed, and not its reply.

Example of usage:

    route {
        lookup("location");
        t_on_failure("1");
        if(!t_relay()) {
            sl_send_reply("500", "relaying failed");
        }
    }
    failure_route[1] {
        if(is_method("INVITE")) {
             # call failed - relay to voice mail
             t_relay("udp:voicemail.server.com:5060");
        }
    }

4. onreply_route

Reply routing block. It contains a set of actions to be taken for SIP replies.

Triggered by : receiving of a reply from the network

Processing : the received reply

Type : stateful (if bound to a transaction) or stateless (if global reply route).

Default action : if the reply is not dropped (only provisional replies can be), it will be injected and processed by the transaction engine.

There are three types of onreply routes:

  • global - it catches all replies received by OpenSIPS and does not need any special arming (simple definition is enough) - named 'onreply_route {...}' or 'onreply_route[0] {...}'.
  • per request/transaction - it catches all received replies belonging to a certain transaction and need to be armed (via "t_on_reply()" ) at request time, in REQUEST ROUTE - named 'onreply_route[N] {...}'.
  • per branch - it catches only the replies that belong to a certain branch from a transaction. It needs to be armed (also via "t_on_reply()" ) at request time, but in BRANCH ROUTE, when a certain outgoing branch is processed - named 'onreply_route[N] {...}'.

Certain 'onreply_route' blocks can be executed by TM module for special replies. For this, the 'onreply_route' must be armed for the SIP requests whose replies should be processed within it, via t_on_reply("onreply_route_index").

route {
        seturi("sip:bob@opensips.org");  # first branch
        append_branch("sip:alice@opensips.org"); # second branch

        t_on_reply("global"); # the "global" reply route
                              # is set the whole transaction
        t_on_branch("1");

        t_relay();
}

branch_route[1] {
        if ($rU=="alice")
                t_on_reply("alice"); # the "alice" reply route
                                      # is set only for second branch
}

onreply_route {
        xlog("OpenSIPS received a reply from $si\n");
}


onreply_route[alice] {
        xlog("received reply on the branch from alice\n");
}

onreply_route[global] {
        if (t_check_status("1[0-9][0-9]")) {
                setflag(1);
                log("provisional reply received\n");
                if (t_check_status("183"))
                        drop;
        }
}


5. error_route

The error route is executed automatically when a parsing error occurs during SIP request processing, or when a script assert fails. It allows the administrator to decide what to do in such error cases.

Triggered by : parsing error in "route"

Processing : failed request

Type : stateless (recommended)

Default action : discard request.

In error_route, the following pseudo-variables are available to get access to error details:

  • $(err.class) - the class of error (now is '1' for parsing errors)
  • $(err.level) - severity level for the error
  • $(err.info) - text describing the error
  • $(err.rcode) - recommended reply code
  • $(err.rreason) - recommended reply reason phrase
  error_route {
     xlog("--- error route class=$(err.class) level=$(err.level)
            info=$(err.info) rcode=$(err.rcode) rreason=$(err.rreason) ---\n");
     xlog("--- error from [$si:$sp]\n+++++\n$mb\n++++\n");
     sl_send_reply("$err.rcode", "$err.rreason");
     exit;
  }

6. local_route

The local route is executed automatically when a new SIP request is generated by TM, internally (no UAC side). This is a route intended to be used for message inspection, accounting and for applying last changes on the message headers. Routing and signaling functions are not allowed.

Triggered by : TM generating a brand new request

Processing : the new request

Type : stateful

Default action : send the request out

  local_route {
     if (is_method("INVITE") && $ru=~"@foreign.com") {
        append_hf("P-hint: foreign request\r\n");
        exit;
     }
     if (is_method("BYE") ) {
        acc_log_request("internally generated BYE");
     }
  }

7. startup_route

The startup_route is executed only once when OpenSIPS is started and before the processing of SIP messages begins. This is useful if some initiation actions are needed, like loading some data in the cache, to ease up the future processing. Notice that this route, compared to the others is not triggered at the receipt of a message, so the functions that can be called here must not do processing on the message.

Triggered : At startup, before the listener processes are started.

Processing : Initializing functions.

  startup_route {
    avp_db_query("select gwlist where ruleid==1",$avp(i:100));
    cache_store("local", "rule1", "$avp(i:100)");
  }

8. timer_route

The timer_route is as the name suggests, a route executed periodically at a configured interval of time specified next to the name(in seconds). The same as the startup_route, this route does not process a message. You can defined more timer routes.

Triggered by : The time keeper.

Processing : Functions that do refresh actions.

  timer_route[gw_update, 300] {
    avp_db_query("select gwlist where ruleid==1",$avp(i:100));
    $shv(i:100) =$avp(i:100);
  }

9.  event_route

The event_route is used by the OpenSIPS Event Interface to execute script code when an event is triggered. The name of the route is the event that has to be handled by that route. Since version 2.4 the event handling way can be specified from route definition as will be shown in the example below. If no way to handle the event specified, default will be synchronously. The keywords that can be used are sync and async.

Triggered by : the event_route module when an event raised by the OpenSIPS Event Interface

Processing : the event triggered

Type : stateless (recommended)

Default action : no script code is executed when the event is raised.

  event_route[E_PIKE_BLOCKED] {
    xlog("The E_PIKE_BLOCKED event was raised\n");
  }
  event_route[E_PIKE_BLOCKED, async] {
    xlog("The E_PIKE_BLOCKED event was raised\n");
  }
조회 수 :
310
등록일 :
2017.12.12
17:26:36 (*.160.88.18)
엮인글 :
http://webs.co.kr/index.php?document_srl=3312399&act=trackback&key=f5a
게시글 주소 :
http://webs.co.kr/index.php?document_srl=3312399
List of Articles
번호 제목 글쓴이 날짜 조회 수
158 List of SIP response codes admin 2017-12-20 314
157 opensips/modules/event_routing/ Push Notification Call pickup admin 2017-12-20 274
156 opensips push notification How to detail file admin 2017-12-20 278
» OpenSIPS routing logic admin 2017-12-12 310
154 OpenSIPS example configuration admin 2017-12-12 314
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 610
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 18088
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 18611
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