diff --git a/src/modules/pua_rpc/doc/Makefile b/src/modules/pua_rpc/doc/Makefile new file mode 100644 index 00000000000..83c5232b03e --- /dev/null +++ b/src/modules/pua_rpc/doc/Makefile @@ -0,0 +1,4 @@ +docs = pua_rpc.xml + +docbook_dir = ../../../../doc/docbook +include $(docbook_dir)/Makefile.module diff --git a/src/modules/pua_rpc/doc/pua_rpc.xml b/src/modules/pua_rpc/doc/pua_rpc.xml new file mode 100644 index 00000000000..e202d4bb052 --- /dev/null +++ b/src/modules/pua_rpc/doc/pua_rpc.xml @@ -0,0 +1,44 @@ + + + +%docentities; + +]> + + + + PUA RPC + &kamailioname; + + + Juha + Heinanen + TutPro Inc. +
+ jh@tutpro.com +
+
+ + Anca-Maria + Vamanu + Voice Sistem SRL +
+ anca@voice-system.ro +
+
+
+ + 2016 + TutPro Inc. + + + 2006 + Voice Sistem SRL + +
+ + +
diff --git a/src/modules/pua_rpc/doc/pua_rpc_admin.xml b/src/modules/pua_rpc/doc/pua_rpc_admin.xml new file mode 100644 index 00000000000..b88cbb20ae8 --- /dev/null +++ b/src/modules/pua_rpc/doc/pua_rpc_admin.xml @@ -0,0 +1,225 @@ + + + +%docentities; + +]> + + + + + &adminguide; + +
+ Overview + + The pua_rpc offers the possibility to publish presence + information via RPC transport. Subscribing to presence + information has not been implemented yet. + + + Using this module you can create independent applications/scripts to + publish SIP and not SIP related information (e.g., MWI message + summary information, system resources like CPU-usage, memory, + number of active subscribers, ...). Future version of this module + may allow non-SIP speaking applications to subscribe + to presence information kept in a SIP presence server. + + + +
+ +
+ Dependencies +
+ &kamailio; Modules + + The following modules must be loaded before this module: + + + + + pua + + + +
+ +
+ External Libraries or Applications + + The following libraries or applications must be installed before running + &kamailio; with this module loaded: + + + + + none + + + +
+
+ +
+ Parameters + + none + +
+ +
+ RPC Commands +
+ + <function moreinfo="none">pua.publish</function> + + + Command parameters: + + + + + presentity_uri + - e.g. sip:jh@tutpro.com + + + + + expires + - Relative expires time in seconds (e.g. 3600). + + + + + event package + - Event package that is target of published information + (e.g. message-summary). + + + + + content type + - Content type of published information + (e.g. application/simple-message-summary) or . if no + information is enclosed. + + + + + id + - id for a series of related PUBLISHes to the same + presentity-uri or . to always use the same series. + For example dialog-info must reuse the same id for the + same call otherwise status will be lost when multiple + parallel calls to/from the same user take place. The + dialog-id from the dialog-info body qualifies as a suitable + id here. + + + + + ETag + - ETag that publish should match or . if no ETag is given. + + + + + outbound proxy + - SIP URI of outbound proxy to be used when + sending PUBLISH request or . if no outbound proxy is given. + + + + + extra_headers + - Extra headers added to PUBLISH request or . if no extra + headers. + + + + + body + - The body of the publish + request containing published information or missing if + no published information. + It has to be a single line for FIFO transport. + + + + + <function>pua.publish</function> XMLRPC example + + + + pua.publish + + + + sip:jh@test.tutpro.com + + + + + 7776000 + + + + + message-summary + + + + + application/simple-message-summary + + + + + . + + + + + a.1481534683.13958.6.7 + + + + + sip:127.0.0.1:5080;transport=tcp + + + + + P-Flags: 0 + + + + + + + Messages-Waiting: yes + +Message-Account: sip:jh@vm.test.tutpro.com + +Voice-Message: 2/0 (0/0) + + + + + + + + ]]> + + +
+
+ +
+