MI_JSON module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module implements a JSON server that handles GET requests and generates JSON responses.
Dependencies
Section titled “Dependencies”External Libraries or Applications
Section titled “External Libraries or Applications”None
OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- httpd module.
Exported Parameters
Section titled “Exported Parameters”mi_json_root(string)
Section titled “mi_json_root(string)”Specifies the root path for JSON requests: http://[opensips_IP]:[opensips_httpd_port]/[mi_json_root]
The default value is “json”.
...modparam("mi_json", "mi_json_root", "opensips_mi_json")...trace_destination (string)
Section titled “trace_destination (string)”Trace destination as defined in the tracing module. Currently the only tracing module is proto_hep. This is where traced mi messages will go.
Default value is none(not defined).
...modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport=tcp;version=3")
modparam("mi_json", "trace_destination", "hep_dest")...trace_bwlist (string)
Section titled “trace_bwlist (string)”Filter traced mi commands based on a blacklist or a whitelist. trace_destination must be defined for this parameter to have any purpose. Whitelists can be defined using ‘w’ or ‘W’, blacklists using ‘b’ or ‘B’. The type is separate by the actual blacklist by ’:’. The mi commands in the list must be separated by ’,’.
Defining a blacklists means all the commands that are not blacklisted will be traced. Defining a whitelist means all the commands that are not whitelisted will not be traced. WARNING: One can’t define both a whitelist and a blacklist. Only one of them is allowed. Defining the parameter a second time will just overwrite the first one.
**WARNING:**A tracing module must be loaded in order for this parameter to work. (for example proto_hep).
Default value is none(not defined).
...## blacklist ps and which mi commands## all the other commands shall be tracedmodparam("mi_json", "trace_bwlist", "b: ps, which")...## allow only sip_trace mi command## all the other commands will not be tracedmodparam("mi_json", "trace_bwlist", "w: sip_trace")...Exported Functions
Section titled “Exported Functions”No function exported to be used from configuration file.
Known Issues
Section titled “Known Issues”Commands with large responses (like ul_dump) will fail if the configured size of the httpd buffer is to small (or if there isn’t enough pkg memory configured).
Future realeases of the httpd and mi_json modules will address this issue.
Examples
Section titled “Examples”This is an example showing the JSON format for the “get_statistics net: uri:” MI command. Notice how the parameters are comma-separated then URI-encoded.
GET /json/get_statistics?params=net%3A%2Curi%3A HTTP/1.1Accept: application/jsonHost: example.net
HTTP/1.1 200 OKContent-Length: 49Content-Type: application/jsonDate: Fri, 01 Nov 2013 12:00:00 GMT
["net:waiting_udp = 0", "net:waiting_tcp = 0", "uri:positive checks = 0", "uri:negative_checks = 0"]Here is another example showing the JSON format for the “ps” MI command.
GET /json/ps HTTP/1.1Accept: application/jsonHost: example.net
HTTP/1.1 200 OKContent-Length: 428Content-Type: application/jsonDate: Fri, 01 Nov 2013 12:00:00 GMT
[{"name":"Process", "value":null, "attributes":{"ID": "0", "PID": "7400", "Type": "stand-alone SIP receiver udp:127.0.0.1:5060"}}, {"name":"Process", "value":null, "attributes":{"ID": "1", "PID": "7402", "Type": "HTTPD INADDR_ANY:8888"}}, {"name":"Process", "value":null, "attributes":{"ID": "2", "PID": "7403", "Type": "time_keeper"}}, {"name":"Process", "value":null, "attributes":{"ID": "3", "PID": "7404", "Type": "timer"}}]doc copyrights:
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. | Stephane Alnet | 20 | 5 | 1270 | 238 |
| 2. | Razvan Crainea (@razvancrainea) | 16 | 12 | 220 | 84 |
| 3. | Ionut Ionita (@ionutrazvanionita) | 14 | 10 | 280 | 59 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | 14 | 8 | 245 | 141 |
| 5. | Liviu Chircu (@liviuchircu) | 9 | 7 | 31 | 37 |
| 6. | Stefan Darius (@dariusstefan) | 7 | 4 | 213 | 30 |
| 7. | Vlad Paiu (@vladpaiu) | 5 | 3 | 9 | 4 |
| 8. | Vlad Patrascu (@rvlad-patrascu) | 2 | 1 | 1 | 0 |
(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 2013 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2014 - Apr 2019 |
| 4. | Liviu Chircu (@liviuchircu) | Jul 2014 - Jun 2018 |
| 5. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - May 2017 |
| 6. | Ionut Ionita (@ionutrazvanionita) | May 2016 - Feb 2017 |
| 7. | Vlad Paiu (@vladpaiu) | Nov 2013 - Jan 2016 |
| 8. | Stephane Alnet | Oct 2013 - Nov 2013 |
(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), Liviu Chircu (@liviuchircu), Ionut Ionita (@ionutrazvanionita), Stephane Alnet.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0