EVENT_ROUTE module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module provides a simple way for capturing and handling directly in the OpenSIPS script of different events triggered through the OpenSIPS Event Interface
If you want to capture and handle a certian event, you need to define a dedicated route (event_route) into the OpenSIPS script, route having as name the name/code of the desired event. The route is triggered (and executed) by the module when the corresponding event is raised by the OpenSIPS
NOTE that there is the triggered event_route is run asyncronus (and in a differen process) in regards to the code or process that generated the actual event.
NOTE that inside the event_route you should NOT rely on anything more than the content provide by the event itself (see below variable). DO NOT assume to have access to any other variable or context, not even to a SIP message.
ROUTE events parameters
Section titled “ROUTE events parameters”In order to retrieve the parameters of an event, the $param(name) variable has to be used. It’s name can be the parameter’s name, or, if an integer is specified, its index inside the parameter’s list.
Example:
xlog("first parameters is $param(1)\n");xlog("Pike Blocking IP is $param(ip)\n");NOTE: An event may be triggered within a different event, leading to nested processing. This function will retrieve the parameters of the currently processed event.
The event name can contain any non-quoted string character, but it is recommended to follow the syntax: E_MODULE_NAME_EXTRA_NAME
EVENT_ROUTE usage
Section titled “EVENT_ROUTE usage”In order to handle the E_PIKE_BLOCKED event, the following snippet can be used:
EVENT_ROUTE usage
event_route[E_PIKE_BLOCKED] { xlog("IP $param(ip) has been blocked\n"); }EVENT_ROUTE socket syntax
Section titled “EVENT_ROUTE socket syntax”As the OpenSIPS Event Interface requires, the event_route module uses a specific socket syntax: ‘route:’ event_name
Example: route:E_PIKE_BLOCKED
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- No dependencies on other OpenSIPS modules.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- none
Exported Parameters
Section titled “Exported Parameters”The module does not export parameters to be used in configuration script.
Exported Functions
Section titled “Exported Functions”The function does not export any function.
Frequently Asked Questions
Section titled “Frequently Asked Questions”Q: Can I declare more routes for handling the same event?
No, only a single event_route can be used for a particular event.
Q: What happened with the “fetch_event_params()” function?
This function has been dropped starting with OpenSIPS 3.0. Its functionality has been replaced by the “$param(name)” variable.
Q: Where can I find more about OpenSIPS?
Take a look at https://opensips.org/.
Q: 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:
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.
Q: How can I report a bug?
Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Razvan Crainea (@razvancrainea) | 36 | 21 | 984 | 313 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 15 | 7 | 116 | 374 |
| 3. | Liviu Chircu (@liviuchircu) | 11 | 9 | 24 | 45 |
| 4. | Ionut Ionita (@ionutrazvanionita) | 8 | 5 | 144 | 57 |
| 5. | Ovidiu Sas (@ovidiusas) | 7 | 2 | 393 | 18 |
| 6. | Stefan Darius (@dariusstefan) | 6 | 3 | 205 | 35 |
| 7. | Ionel Cerghit (@ionel-cerghit) | 3 | 1 | 14 | 15 |
| 8. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
| 9. | Walter Doekes (@wdoekes) | 3 | 1 | 1 | 1 |
| 10. | Vlad Patrascu (@rvlad-patrascu) | 2 | 1 | 1 | 0 |
All remaining contributors: Vlad Paiu (@vladpaiu).
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Dec 2012 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2014 - Nov 2020 |
| 4. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 5. | Liviu Chircu (@liviuchircu) | Mar 2014 - Jun 2018 |
| 6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - May 2017 |
| 7. | Vlad Paiu (@vladpaiu) | Jun 2016 - Jun 2016 |
| 8. | Ionel Cerghit (@ionel-cerghit) | Jun 2015 - Jun 2015 |
| 9. | Ionut Ionita (@ionutrazvanionita) | Oct 2014 - Oct 2014 |
| 10. | Ovidiu Sas (@ovidiusas) | Jul 2014 - Jul 2014 |
All remaining contributors: Walter Doekes (@wdoekes).
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Ionut Ionita (@ionutrazvanionita), Ovidiu Sas (@ovidiusas).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0