SCRIPT HELPER module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”The purpose of the Script Helper module is to simplify the scripting process in OpenSIPS when doing basic scenarios. At the same time, it is useful to script writers as it contains basic SIP routing logic, and thus it allows them to focus more on the particular aspects of their OpenSIPS routing code.
How it works
Section titled “How it works”By simply loading the module, the following default logic will be embedded:
- for initial SIP requests, the module will perform record routing before running the main request route
- sequential SIP requests will be transparently handled - the module will perform loose routing, and the request route will not be run at all
Currently, the module may be further configured to embed the following optional logic:
- dialog support (dialog module dependency - must be loaded before this module)
- an additional route to be run before relaying sequential requests
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- dialog (only if use dialog is enabled).
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”use_dialog (integer)
Section titled “use_dialog (integer)”Enables dialog support. Note that the dialog module must be loaded before this module when setting this parameter.
Default value is 0 (disabled)
...modparam("script_helper", "use_dialog", 1)...create_dialog_flags (string)
Section titled “create_dialog_flags (string)”Flags used when creating dialogs. For details on these flags, please refer to the create_dialog() function of the dialog module.
Default value is "" (no flags are set)
...modparam("script_helper", "create_dialog_flags", "options-ping-caller,options-ping-callee,bye-on-timeout")...sequential_route (string)
Section titled “sequential_route (string)”Optional route to be run just before sequential requests are relayed. If the exit script statement is used inside this route, the module assumes that the relaying logic has been handled.
By default, this parameter is not set
...modparam("script_helper", "sequential_route", "sequential_handling")...route [sequential_handling]{...}...Known Issues
Section titled “Known Issues”The Max-Forwards header is currently not handled at all.
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. | Liviu Chircu (@liviuchircu) | 20 | 14 | 500 | 48 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 12 | 6 | 492 | 10 |
| 3. | Razvan Crainea (@razvancrainea) | 8 | 6 | 11 | 9 |
| 4. | Stefan Darius (@dariusstefan) | 7 | 4 | 147 | 17 |
| 5. | Vlad Patrascu (@rvlad-patrascu) | 6 | 4 | 9 | 13 |
| 6. | Maksym Sobolyev (@sobomax) | 5 | 3 | 3 | 4 |
| 7. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
(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. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2014 - Jul 2026 |
| 2. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 3. | Razvan Crainea (@razvancrainea) | Aug 2015 - Jun 2026 |
| 4. | Liviu Chircu (@liviuchircu) | Mar 2014 - Mar 2026 |
| 5. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 7. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0