git.sip-router.org Git - sip-router/blob - src/modules/pua_rpc/README

   1 PUA RPC
   2
   3 Juha Heinanen
   4
   5    TutPro Inc.
   6
   7 Anca-Maria Vamanu
   8
   9    Voice Sistem SRL
  10
  11    Copyright © 2016 TutPro Inc.
  12
  13    Copyright © 2006 Voice Sistem SRL
  14      __________________________________________________________________
  15
  16    Table of Contents
  17
  18    1. Admin Guide
  19
  20         1. Overview
  21         2. Dependencies
  22
  23               2.1. Kamailio Modules
  24               2.2. External Libraries or Applications
  25
  26         3. Parameters
  27         4. RPC Commands
  28
  29               4.1. pua.publish
  30
  31    List of Examples
  32
  33    1.1. pua.publish XMLRPC example
  34
  35 Chapter 1. Admin Guide
  36
  37    Table of Contents
  38
  39    1. Overview
  40    2. Dependencies
  41
  42         2.1. Kamailio Modules
  43         2.2. External Libraries or Applications
  44
  45    3. Parameters
  46    4. RPC Commands
  47
  48         4.1. pua.publish
  49
  50 1. Overview
  51
  52    The pua_rpc offers the possibility to publish presence information via
  53    RPC transport. Subscribing to presence information has not been
  54    implemented yet.
  55
  56    Using this module you can create independent applications/scripts to
  57    publish SIP and not SIP related information (e.g., MWI message summary
  58    information, system resources like CPU-usage, memory, number of active
  59    subscribers, ...). Future version of this module may allow non-SIP
  60    speaking applications to subscribe to presence information kept in a
  61    SIP presence server.
  62
  63 2. Dependencies
  64
  65    2.1. Kamailio Modules
  66    2.2. External Libraries or Applications
  67
  68 2.1. Kamailio Modules
  69
  70    The following modules must be loaded before this module:
  71      * pua
  72
  73 2.2. External Libraries or Applications
  74
  75    The following libraries or applications must be installed before
  76    running Kamailio with this module loaded:
  77      * none
  78
  79 3. Parameters
  80
  81    none
  82
  83 4. RPC Commands
  84
  85    4.1. pua.publish
  86
  87 4.1. pua.publish
  88
  89    Command parameters:
  90      * presentity_uri - e.g. sip:jh@tutpro.com
  91      * expires - Relative expires time in seconds (e.g. 3600).
  92      * event package - Event package that is target of published
  93        information (e.g. message-summary).
  94      * content type - Content type of published information (e.g.
  95        application/simple-message-summary) or . if no information is
  96        enclosed.
  97      * id - id for a series of related PUBLISHes to the same
  98        presentity-uri or . to always use the same series. For example
  99        dialog-info must reuse the same id for the same call otherwise
 100        status will be lost when multiple parallel calls to/from the same
 101        user take place. The dialog-id from the dialog-info body qualifies
 102        as a suitable id here.
 103      * ETag - ETag that publish should match or . if no ETag is given.
 104      * outbound proxy - SIP URI of outbound proxy to be used when sending
 105        PUBLISH request or . if no outbound proxy is given.
 106      * extra_headers - Extra headers added to PUBLISH request or . if no
 107        extra headers.
 108      * body - The body of the publish request containing published
 109        information or missing if no published information. It has to be a
 110        single line for FIFO transport.
 111
 112    Example 1.1. pua.publish XMLRPC example
 113
 114 <?xml version="1.0" ?>
 115 <methodCall>
 116  <methodName>pua.publish</methodName>
 117  <params>
 118   <param>
 119    <value>
 120     <string>sip:jh@test.tutpro.com</string>
 121    </value>
 122   </param>
 123   <param>
 124    <value>
 125     <string>7776000</string>
 126    </value>
 127   </param>
 128   <param>
 129    <value>
 130     <string>message-summary</string>
 131    </value>
 132   </param>
 133   <param>
 134    <value>
 135     <string>application/simple-message-summary</string>
 136    </value>
 137   </param>
 138   <param>
 139    <value>
 140     <string>.</string>
 141    </value>
 142   </param>
 143   <param>
 144    <value>
 145     <string>a.1481534683.13958.6.7</string>
 146    </value>
 147   </param>
 148   <param>
 149    <value>
 150     <string>sip:127.0.0.1:5080;transport=tcp</string>
 151    </value>
 152   </param>
 153   <param>
 154    <value>
 155     <string>P-Flags: 0
 156
 157 </string>
 158    </value>
 159   </param>
 160   <param>
 161    <value>
 162     <string>Messages-Waiting: yes
 163
 164 Message-Account: sip:jh@vm.test.tutpro.com
 165
 166 Voice-Message: 2/0 (0/0)
 167
 168 </string>
 169    </value>
 170   </param>
 171  </params>
 172 </methodCall>