OPTIONS module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module provides a function to answer OPTIONS requests which are directed to the server itself. This means an OPTIONS request which has the address of the server in the request URI, and no username in the URI. The request will be answered with a 200 OK which the capabilities of the server.
To answer OPTIONS request directed to your server is the easiest way for is-alive-tests on the SIP (application) layer from remote (similar to ICMP echo requests, also known as “ping”, on the network layer).
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- sl — Stateless replies.
- signaling — Stateless replies.
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”accept (string)
Section titled “accept (string)”This parameter is the content of the Accept header field. If "", the header is not added in the reply. Note: it is not clearly written in RFC3261 if a proxy should accept any content (the default ”/”) because it does not care about content. Or if it does not accept any content, which is "".
Default value is ”/“.
...modparam("options", "accept", "application/*")...accept_encoding (string)
Section titled “accept_encoding (string)”This parameter is the content of the Accept-Encoding header field. If "", the header is not added in the reply. Please do not change the default value because OpenSIPS does not support any encodings yet.
Default value is "".
...modparam("options", "accept_encoding", "gzip")...accept_language (string)
Section titled “accept_language (string)”This parameter is the content of the Accept-Language header field. If "", the header is not added in the reply. You can set any language code which you prefer for error descriptions from other devices, but presumably there are not much devices around which support other languages then the default English.
Default value is “en”.
...modparam("options", "accept_language", "de")...support (string)
Section titled “support (string)”This parameter is the content of the Support header field. If "", the header is not added in the reply. Please do not change the default value, because OpenSIPS currently does not support any of the SIP extensions registered at the IANA.
Default value is "".
...modparam("options", "support", "100rel")...Exported Functions
Section titled “Exported Functions”options_reply()
Section titled “options_reply()”This function checks if the request method is OPTIONS and if the request URI does not contain an username. If both is true the request will be answered stateless with “200 OK” and the capabilities from the modules parameters.
It sends “500 Server Internal Error” for some errors and returns false if it is called for a wrong request.
The check for the request method and the missing username is optional because it is also done by the function itself. But you should not call this function outside the myself check because in this case the function could answer OPTIONS requests which are sent to you as outbound proxy but with an other destination then your proxy (this check is currently missing in the function).
This function can be used from REQUEST_ROUTE.
...if (is_myself("$rd")) { if (is_method("OPTIONS") && (! $ru=~"sip:.*[@]+.*")) { options_reply(); }}...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. | Bogdan-Andrei Iancu (@bogdan-iancu) | 22 | 18 | 121 | 104 |
| 2. | Daniel-Constantin Mierla (@miconda) | 14 | 12 | 41 | 31 |
| 3. | Liviu Chircu (@liviuchircu) | 10 | 8 | 29 | 45 |
| 4. | Nils Ohlmeier | 10 | 3 | 630 | 4 |
| 5. | Razvan Crainea (@razvancrainea) | 9 | 6 | 91 | 94 |
| 6. | Stefan Darius (@dariusstefan) | 7 | 4 | 214 | 41 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | 5 | 3 | 9 | 6 |
| 8. | Elena-Ramona Modroiu | 4 | 2 | 4 | 4 |
| 9. | Maksym Sobolyev (@sobomax) | 4 | 2 | 3 | 4 |
| 10. | Ancuta Onofrei | 3 | 1 | 10 | 11 |
All remaining contributors: Jan Janak (@janakj), Konstantin Bokarius, Peter Lemenkov (@lemenkov), Edson Gellert Schubert.
(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) | Nov 2012 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Jul 2014 - May 2024 |
| 4. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Nov 2003 - Apr 2019 |
| 6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 7. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 8. | Daniel-Constantin Mierla (@miconda) | Jul 2006 - Mar 2008 |
| 9. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 10. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
All remaining contributors: Ancuta Onofrei, Elena-Ramona Modroiu, Jan Janak (@janakj), Nils Ohlmeier.
(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), Vlad Patrascu (@rvlad-patrascu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Jan Janak (@janakj), Nils Ohlmeier.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0