PUA XMPP module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module is a gateway for presence between SIP and XMPP.
It translates one format into another and uses xmpp, pua and presence modules to manage the transmition of presence state information.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- presence.
- pua.
- xmpp.
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:
- libxml.
Exported Parameters
Section titled “Exported Parameters”server_address(str)
Section titled “server_address(str)”The IP address of the server.
...modparam("pua_xmpp", "server_address", "sip:sa@opensips.org:5060")...presence_server (str)
Section titled “presence_server (str)”The the address of the presence server. If set, it will be used as outbound proxy when sending PUBLISH requests.
...modparam("pua_xmpp", "presence_server", "sip:pa@opensips.org:5075")...Exported Functions
Section titled “Exported Functions”Functions exported to be used in configuration file.
pua_xmpp_notify()
Section titled “pua_xmpp_notify()”Function that handles Notify messages addressed to a user from an xmpp domain. It requires filtering after method and domain in configuration file. If the function is successful, a 2xx reply must be sent.
This function can be used from REQUEST_ROUTE.
... if( is_method("NOTIFY") && uri=~"sip:.+@sip-xmpp.siphub.ro") { if(Notify2Xmpp()) t_reply("200", "OK"); exit; }...pua_xmpp_req_winfo(char* request_uri, char* expires)
Section titled “pua_xmpp_req_winfo(char* request_uri, char* expires)”Function called when a Subscribe addressed to a user from a xmpp domain is received. It calls sending a Subscribe for winfo for the user, and the following Notify with dialog-info is translated into a subscription in xmpp. It also requires filtering in configuration file, after method, domain and event(only for presence).
It takes 2 parameters: request_uri and the value of Expires header field in received Subscribe.
This function can be used from REQUEST_ROUTE.
... if( is_method("SUBSCRIBE")) { handle_subscribe(); if(uri=~"sip:.+@sip-xmpp.siphub.ro" && $hdr(Event)== "presence") { pua_xmpp_req_winfo("$ruri", "$hdr(Expires)"); } t_release(); }...Filtering
Section titled “Filtering”Instead of “sip-xmpp.siphub.ro” in the example you should use the value set for the xmpp module parameter named ‘gateway_domain’.
Developer Guide
Section titled “Developer Guide”The module provides no function to be used in other OpenSIPS modules.
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. | Anca Vamanu | 61 | 17 | 3351 | 870 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 17 | 14 | 62 | 85 |
| 3. | Liviu Chircu (@liviuchircu) | 11 | 6 | 134 | 155 |
| 4. | Daniel-Constantin Mierla (@miconda) | 10 | 8 | 27 | 21 |
| 5. | Stefan Darius (@dariusstefan) | 7 | 4 | 174 | 20 |
| 6. | Razvan Crainea (@razvancrainea) | 6 | 4 | 14 | 18 |
| 7. | Ovidiu Sas (@ovidiusas) | 3 | 1 | 14 | 2 |
| 8. | Vlad Paiu (@vladpaiu) | 3 | 1 | 5 | 15 |
| 9. | Sergio Gutierrez | 3 | 1 | 5 | 5 |
| 10. | Konstantin Bokarius | 3 | 1 | 3 | 5 |
All remaining contributors: Juha Heinanen (@juha-h), Walter Doekes (@wdoekes), Edson Gellert Schubert, Stanislaw Pitucha.
(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) | Jul 2007 - Jul 2026 |
| 2. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 3. | Razvan Crainea (@razvancrainea) | Feb 2012 - Jun 2026 |
| 4. | Liviu Chircu (@liviuchircu) | Mar 2014 - Jun 2018 |
| 5. | Ovidiu Sas (@ovidiusas) | Jan 2013 - Jan 2013 |
| 6. | Vlad Paiu (@vladpaiu) | Aug 2011 - Aug 2011 |
| 7. | Stanislaw Pitucha | Jul 2010 - Jul 2010 |
| 8. | Walter Doekes (@wdoekes) | Apr 2010 - Apr 2010 |
| 9. | Anca Vamanu | Apr 2007 - Mar 2010 |
| 10. | Sergio Gutierrez | Nov 2008 - Nov 2008 |
All remaining contributors: Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Juha Heinanen (@juha-h).
(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), Anca Vamanu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0