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")...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 paramaters 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. | Bogdan-Andrei Iancu (@bogdan-iancu) | 13 | 7 | 243 | 140 |
| 3. | Razvan Crainea (@razvancrainea) | 11 | 7 | 214 | 77 |
| 4. | Ionut Ionita (@ionutrazvanionita) | 6 | 4 | 51 | 30 |
| 5. | Liviu Chircu (@liviuchircu) | 6 | 4 | 22 | 28 |
| 6. | Stefan Darius (@dariusstefan) | 6 | 3 | 126 | 9 |
| 7. | Vlad Paiu (@vladpaiu) | 5 | 3 | 9 | 4 |
(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. | Ionut Ionita (@ionutrazvanionita) | May 2016 - May 2016 |
| 6. | Vlad Paiu (@vladpaiu) | Nov 2013 - Jan 2016 |
| 7. | 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), Stephane Alnet.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0