A route can return a set of values, that can later be retrieved from the route's calling context using the [[https://www.opensips.org/Documentation/Script-CoreVar-3-6#return|$return]] variable.

Example of passing values:
[@
route {
route(query);
xlog("Query returned id $return(0) with $return(1) values\n");
}
route[query] {
# perform a query for information and store the information in $var(id) and $var(values)
return(1, $var(id), $var(values));
}
@]
Note that the first parameter of the return is always the return code, and cannot be retrieved using the $return() variable.

[[#route]]
!!!!route [[#route|🔗]]

[[#branch_route]]
!!!!branch_route [[#branch_route|🔗]]

[[#failure_route]]
!!!!failure_route [[#failure_route|🔗]]

[[#onreply_route]]
!!!!onreply_route [[#onreply_route|🔗]]

[[#error_route]]
!!!!error_route [[#error_route|🔗]]

[[#local_route]]
!!!!local_route [[#local_route|🔗]]

[[#startup_route]]
!!!!startup_route [[#startup_route|🔗]]

[[#timer_route]]
!!!!timer_route [[#timer_route|🔗]]

[[# event_route]]
!!!! event_route [[# event_route|🔗]]

* '''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] {...}'. NOTE: this route is not SIP transaction aware (the reply was not matched to the transaction), so no transactional data is available here.

IMPORTANT: as this is triggered ONLY for SIP request, OpenSIPS has to be able to correctly parse the first line of the SIP message. So any syntax error in the first line will NOT trigger this route (as OpenSIPS will not be able to tell if a reply or request).

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. The route itself is executed asynchronously with regards to the trigger moment.

'''Triggered by''' : The ''timer'' worker process.

The '''timer_route''' is a route executed periodically at a configured interval of time specified next to the name (in seconds). Similar to ''startup_route'', this route does not process a SIP message. Multiple timer routes (possibly at differing running intervals) are allowed.

The '''timer_route''' is a route executed periodically at a configured interval of time specified next to the name (in seconds). Similar to ''startup_route'', this route does not process a SIP message. Multiple timer routes (possibly at different running intervals) are allowed.

'''Triggered by''' : The time keeper worker process.

'''Processing''' : Functions that do periodic, recurring processing.

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. Multiple timer routes (possibly at different running intervals) are allowed.

%red%NOTE%%: when OpenSIPS starts, each timer_route is '''first executed after <interval>''' seconds!

%red%NOTE%%: when OpenSIPS starts, each timer_route is first executed '''after <interval>''' seconds!

sl_send_reply(200, "OK");

sl_send_reply(500, "Internal Server Error");

sl_send_reply(500, "Internal Server Error");

if($ru=~"10\.10\.10\.10") {

[[#comment1]](:nl:)>>messagehead<<
!!!!![[~Miguel Oyarzo]] &mdash; [-05 December 2015, 05:31-]
>>messageitem<<
You guys should add some graphs to explain better the routing processes, specially for SIP replies. Great works anyway.
>><<

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 3.6 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 [[http://www.opensips.org/html/docs/modules/3.6.x/event_route | event_route ]] module when an event raised by the OpenSIPS Event Interface

The error route is executed automatically when a parsing error occurs during SIP request processing, or when a script [[ http://www.opensips.org/Documentation/Script-CoreFunctions-3-6#toc2 | assert ]] fails. It allows the administrator to decide what to do in such error cases.

The error route is executed automatically when a parsing error occurrs during SIP request processing, or when a script [[ http://www.opensips.org/Documentation/Script-CoreFunctions-3-6#toc2 | assert ]] fails. It allows the administrator to decide what to do in such error cases.

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 1.12 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.

event_route[E_PIKE_BLOCKED, async] {

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 1.12 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".

xlog("The E_PIKE_BLOCKED event was raised\n");
}
@]

[@
event_route[E_PIKE_BLOCKED, "async"] {