!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsPapPa | Presence]] -> Presence User Agent Extensions
%block text-align=right% '''written by Anca Vamanu'''

OpenSIPS has some presence extensions that offer some very interesting features:
* Get presence status from Register
* Gateway to xmpp presence
* Sending Publish and Subscribe messages using the MI interface
* Bridge Line Appearance (BLA, event: dialog;sla)
* Busy Lamp Field (BLF, event:dialog)

They are implemented as presence user agent in modules named pua_<extension>:
# [[#pua_usrloc| pua_usrloc]]
# [[#pua_mi| pua_mi]]
# [[#pua_xmpp| pua_xmpp]]
# [[#pua_bla| pua_bla]]
# [[#pua_dialoginfo| pua_dialoginfo]]

----

[[#pua_usrloc]]
!pua_usrloc

There are still many SIP phones( especially hard phones) that do not implement presence, or not presence with a
central server. Even so, the server is aware if the phone is online or not from whether the phone is registered or
not. This information is used by this module to send basic presence information to the Presence Server about any
phone.
The modules parameters that can be configured are the following:
* default_domain : (compulsory) the default domain to use when constructing the presentity uri if it is missing from
recorded aor
* entity_prefix : the prefix when constructing entity attribute to be added to presence node in xml pidf. (ex:
'pres').
You can filter for which users or phones to have this feature enabled. In the configuration file you must call the
function '''pua_set_publish''' exported by the module when a Register for one ot the users is being processed.

See here a [[pua_usrloc_config|configuration file example]].

It is not compulsory for the presence server to run on the same machine as the pua_usrloc extension, as the
communication is through PUBLISH SIP messages.
You can read the [[ http://www.opensips.org/html/docs/modules/1.5.x/pua_usrloc.html| modules readme here]].

----

[[#pua_mi]]
!!pua_mi

OpenSIPS offers the possibility to publish any kind of information to the Presence Server or subscribe to the
presence state of a resource through the MI interface. This module requires the '''pua''' core and an mi module:
* '''mi_fifo''': local commands through fifo
* '''mi_xmlrpc''': local and remote commands
* '''mi_datagram''': UNIX/UDP SOCKET transport

The commands and their parameters:

1. '''pua_publish'''
[@
<presentity_uri>
<expires>
<event package>
<content_type> - body type if body of a type different from default event content-type or .
<ETag> - ETag that publish should match or . if no ETag
<extra_headers> - extra headers to be added to the request or .
<publish_body> - may not be present in case of update for expire
@]
Example:
[@
:pua_publish:fifo_reply
sip:system@192.168.2.132
3600
presence
application/pidf+xml
.
.
<?xml version='1.0'?><presence xmlns='urn:ietf:params:xml:ns:pidf' xmlns:dm='urn:ietf:params:xml:ns:pidf:data-model'
xmlns:rpid='urn:ietf:params:xml:ns:pidf:rpid' xmlns:c='urn:ietf:params:xml:ns:pidf:cipid'
entity='system@domain'><tuple id='0x81475a0'><status><basic>open</basic></status></tuple><dm:person
id='pdd748945'><rpid:activities><rpid:away/>away</rpid:activities><dm:note>CPU:16
MEM:476</dm:note></dm:person></presence>
@]
This example publishes the state of a system( CPU/MEM). This feature can be used in many applications, one example is
advertising and publishing news and offers through the presence status of a dummy SIP account.

2. '''pua_subscribe'''
[@
<presentity_uri>
<watcher_uri>
<event_package>
<expires>
@]
You can read the [[http://www.opensips.org/html/docs/modules/1.5.x/pua_mi.html| modules readme here]].

----

[[#pua_xmpp]]
!!pua_xmpp

This module implements a presence gateway between XMPP and SIP. It requires '''pua''' and '''xmpp''' modules.
You have to respect the uri format rules described in [link| xmpp-sip tutorial].
The module has one compulsory module parameter:
* '''server_address''' - the IP address of the machine where the OpenSIPS XMPP gateway is running
Ex: modparam( "pua_xmpp", "server_address", "sip:xmppgw@10.10.10.10")

The operations performed by '''pua_xmpp''' module consist in translating the presence information format from xmpp
to sip and back and also dealing with logic incompatibilities( SIP is time based while XMPP is not).
In the SIP part, the module sends Subscribe messages on behalf of the xmpp users and catches Notifies in the script.
Also it detects Subscribes to users in XMPP domains and sends Subscribes with event presence.winfo to on behalf of
those users to be notified when others Subscribe to its presence.

This is achieved by calling the following functions in the script:
* '''pua_xmpp_notify()'''
* '''pua_xmpp_req_winfo(char* request_uri, char* expires)'''

See a [[pua_xmpp_config| configuration example here]].

You can read the [[http://www.opensips.org/html/docs/modules/1.5.x/pua_xmpp.html|module readme here]].

----

[[#pua_bla]]
!!pua_bla

This module implements BLA( Bridge Line Appearance ) according to draft [[http://tools.ietf.org/draft/draft-anil-sipping-bla/draft-anil-sipping-bla-03.txt| draft-anil-sipping-bla-03.txt]].
The implementation is compatible with Polycom phones SoundPoint IP430 SIP.

The module requires central '''pua''' module and a presence server( either collocated with the BLA server or remote).
It also requires to monitor Register messages which means that as pua_usrloc, it has to be collocated with the registrar or Register messages has to be forwarded to the server.

The BLA server works as a central entity that gathers bridge line information from the phones and then distributes it
to all the phones registered to the line.
The gathering part is done by the pua_bla module, with functionalities provided by the pua module. It is achieved by
sending Subscribe messages to the phones when registering and then catching the Notifies from the phones. The Notify
is then transformed in a Publish message and sent to the presence server.
The presence server is the one that will deal with the distributing part. It will receive the subscribe messages from
the phones and using the published information sent by the pua_bla module, it will send Notifies with the state of the line.
To configure the pua_bla module you can set these parameters:

* '''default_domain(str)''' - (compulsory) the default domain
* '''header_name(str)''' - (compulsory) the header name to be used for comprising information about the sender of the Notify in the generated Publish message; in the configuration file of the presence server the content of this header has to be given as a parameter for the handle_publish function
* '''outbound_proxy(str)''' - the address of the outbound proxy if one is used
* '''server_address(str)''' - (compulsory) the IP address of the bla server

To achieved the functionalities described above, the following functions exported by the pua_bla module have to be used in the script:
* '''bla_set_flag''': should be called upon receiving a Register message for those registrations that are addressed to a BLA
* '''bla_handle_notify''': Should be called when receiving a Notify with a BLA information ( event: dialog;sla).
See here a [[pua_bla_config | configuration file example]].

You can read the [[|http://www.opensips.org/html/docs/modules/1.5.x/pua_bla.htmlmodule readme here]].

[[#pua_dialoginfo]]
!pua_dialoginfo

This module enables BLF feature in the server by monitoring and publishing dialog information to the presence server. Basically this module uses the 'dialog' module, which is a tracker for dialogs and registers callback that are called whenever a call dialog SIP message is received. These callbacks code the new state of the dialog into an application/dialog-info+xml data format text and send these to the presence server as a body for a Publish message.

Then, the rest of the job is done by the presence server. To enable handling for this event in the presence server you need to load the 'presence_dialoginfo' module that will register the 'dialog-info' event to the presence server. The presence server will receive Subscribe messages from the UA's and generate Notifies with the information received in Publish messages sent by the pua_dialoginfo module.


See here a [[pua_dialoinfo_config | configuration file example]].


(:commentboxchrono:)

[[#comment1]](:nl:)>>messagehead<<
!!!!![[~Foge]] &mdash; [-24 October 2012, 12:05-]
>>messageitem<<
It's great to read something that's both enjyoalbe and provides pragmatisdc solutions.
>><<

[[#comment1]](:nl:)>>messagehead<<
!!!!![[~Julie]] &mdash; [-22 October 2012, 17:40-]
>>messageitem<<
آقا ببخشید اگه اعصابتونو خورد میکنم، ولی من از روش آلتر استفاده می کنم وقتی روی aIW2 می زنم ارور می ده. شاید مشکل از همین جاست؟؟ آخه من هم با آلتر و هم با آلتر رولوشن انجام دادم، توی هر دو تا روی connecting to IWNet sveerr گیر می کنه.لطفا کمک!
>><<

[[#comment1]](:nl:)>>messagehead<<
!!!!![[~Marcelo]] &mdash; [-22 October 2012, 08:11-]
>>messageitem<<
Warning: fopen(wp-config.php) [function.fopen]: failed to open staerm: Permission denied in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 462Warning: fwrite(): supplied argument is not a valid staerm resource in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 502Warning: fwrite(): supplied argument is not a valid staerm resource in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 502Warning: fclose(): supplied argument is not a valid staerm resource in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 506Warning: chmod() [function.chmod]: No such file or directory in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 507Warning: include_once(./wp-config.php) [function.include-once]: failed to open staerm: No such file or directory in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 663Warning: include_once() [function.include]: Failed opening ./wp-config.php' for inclusion (include_path='.;./includes;./pear') in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocsindex-install.php on line 663Warning: require_once(ABSPATHwp-admin/includes/admin.php) [function.require-once]: failed to open staerm: No such file or directory in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocswp-adminincludesupgrade.php on line 16Fatal error: require_once() [function.require]: Failed opening required ABSPATHwp-admin/includes/admin.php' (include_path='.;./includes;./pear') in D:inetpubvhostskhondoi.comsubdomainspa-ohhttpdocswp-adminincludesupgrade.php on line 16
>><<

[[#comment1]](:nl:)>>messagehead<<
!!!!![[~Kiana]] &mdash; [-10 May 2011, 07:09-]
>>messageitem<<
AFAICT you've coveerd all the bases with this answer!
>><<

[[#comment2]](:nl:)>>messagehead<<
!!!!![[~Louisa]] &mdash; [-10 May 2011, 07:09-]
>>messageitem<<
THX that's a great anwser!
>><<

You can read the [[http://www.opensips.org/html/pua_mi.html| modules readme here]].

You can read the [[ http://www.opensips.org/html/pua_usrloc.html| modules readme here]].

You can read the [[http://www.opensips.org/html/pua_xmpp.html|module readme here]].

You can read the [[http://www.opensips.org/html/pua_bla.html|module readme here]].

* Busy Lamp Field (BLF, event:dialoginfo)

# [[#dialoginfo| pua_dialoginfo]]

* Publish info from non SIP devices
* Bridge Line Appearance (BLA)

# [[#pua_usrloc| Getting presence from registrar information]]
# [[#pua_mi| Pushing Publish/Subscribe requests using MI interface]]
# [[#pua_xmpp| Presence gateway to XMPP]]
# [[#pua_bla| Bridge Line Appearance (BLA, event: dialog;sla)]]
# [[#dialoginfo| Busy Lamp Field (BLF, event:dialoginfo)]]

# [[#pua_usrloc| pua_usrloc]]
# [[#pua_mi| pua_mi]]
# [[#pua_xmpp| pua_xmpp]]
# [[#pua_bla| pua_bla]]

not. This information is used by this module to send basical presence information to the Presence Server about any

* entity_prefix : the prefix when construstructing entity attribute to be added to presence node in xml pidf. (ex:

function '''pua_set_publish''' exported by the module when a Register for one ot the users is beeing processed.

<content_type> - body type if body of a type different from defaultevent content-type or .

The operations perfromed by '''pua_xmpp''' module consist in translating the presence information format from xmpp

This is achived by calling th efollowing functions in the script:

The gathering part is done by the pua_bla module, with functionalities provided by the pua module. It is achived by

To achived the functionalities described above, the following functions exported by the pua_bla module have to be used in the script:

You can read the [[http://www.opensips.org/html/pua_bla.html|module readme here]].

You can read the [[http://www.opensips.org/html/pua_bla.html|module readme here]].

You can see here a [[pua_bla_config | configuration file example]].

recorded aor

those users to be notified when others Subscribe to its presence.

to all the phones registered to the line.

is then transformed in a Publish message and sent to the presence server.

]]

[[<<

!!pua_usrloc

There are still many SIP phones( especially hard phones) that do not implement presence, or not presence with a central server. Even so, the server is aware if the phone is online or not from whether the phone is registered or not. This information is used by this module to send basical presence information to the Presence Server about any phone.

* default_domain : (compulsory) the default domain to use when constructing the presentity uri if it is missing from recorded aor
* entity_prefix : the prefix when construstructing entity attribute to be added to presence node in xml pidf. (ex: 'pres').
You can filter for which users or phones to have this feature enabled. In the configuration file you must call the function '''pua_set_publish''' exported by the module when a Register for one ot the users is beeing processed.

It is not compulsory for the presence server to run on the same machine as the pua_usrloc extension, as the communication is through PUBLISH SIP messages.

OpenSIPS offers the possibility to publish any kind of information to the Presence Server or subscribe to the presence state of a resource through the MI interface. This module requires the '''pua''' core and an mi module:

<?xml version='1.0'?><presence xmlns='urn:ietf:params:xml:ns:pidf' xmlns:dm='urn:ietf:params:xml:ns:pidf:data-model' xmlns:rpid='urn:ietf:params:xml:ns:pidf:rpid' xmlns:c='urn:ietf:params:xml:ns:pidf:cipid' entity='system@domain'><tuple id='0x81475a0'><status><basic>open</basic></status></tuple><dm:person id='pdd748945'><rpid:activities><rpid:away/>away</rpid:activities><dm:note>CPU:16 MEM:476</dm:note></dm:person></presence>

This example publishes the state of a system( CPU/MEM). This feature can be used in many applications, one example is advertising and publishing news and offers through the presence status of a dummy SIP account.

The operations perfromed by '''pua_xmpp''' module consist in translating the presence information format from xmpp to sip and back and also dealing with logic incompatibilities( SIP is time based while XMPP is not).

Also it detects Subscribes to users in XMPP domains and sends Subscribes with event presence.winfo to on behalf of those users to be notified when others Subscribe to its presence.

The module requires central '''pua''' module and a presence server( either collocated with the BLA server or remote). It also requires to monitor Register messages which means that as pua_usrloc, it has to be collocated with the registrar or Register messages has to be forwarded to the server.

The BLA server works as a central entity that gathers bridge line information from the phones and then distributes it to all the phones registered to the line.
The gathering part is done by the pua_bla module, with functionalities provided by the pua module. It is achived by sending Subscribe messages to the phones when registering and then catching the Notifies from the phones. The Notify is then transformed in a Publish message and sent to the presence server.
The presence server is the one that will deal with the distributing part. It will receive the subscribe messages from the phones and using the published information sent by the pua_bla module, it will send Notifies with the state of the line.

You can read the [[http://www.opensips.org/html/pua_bla.html|module readme here]].

!!!pua_usrloc

!!!pua_mi

!!!pua_xmpp

!!!pua_bla

* '''bla_handle_notify'': Should be called when receiving a Notify with a BLA information ( event: dialog;sla).

* '''header_name(str)''' - the header name to be used for comprising information about the sender of the Notify in the generated Publish message (default value:'Sender'); in the configuration file of the presence server the content of this header has to be given as a parameter for the handle_publish function

* server_address - the IP address of the machine where the OpenSIPS XMPP gateway is running

* pua_xmpp_notify()
* pua_xmpp_req_winfo(char* request_uri, char* expires)

To configure the

This module implements BLA( Bridge Line Appearance ) according to draft [[http://tools.ietf.org/draft/draft-anil-sipping-bla/draft-anil-sipping-bla-03.txt| draft-anil-sipping-bla-03.txt]].

You can read the [[http://www.opensips.org/html/pua_xmpp.html|module readme here]].

# '''pua_publish'''

@]This example publishes the state of a system( CPU/MEM). This feature can be used in many applications, one example is advertising and publishing news and offers through the presence status of a dummy SIP account.

# '''pua_subscribe'''

[@ <presentity_uri>

@]
This example publishes the state of a system( CPU/MEM). This feature can be used in many applications, one example is advertising and publishing news and offers through the presence status of a dummy SIP account.

<presentity_uri>

This module implements a presence gateway between XMPP and SIP. It requires '''pua''' and '''xmpp'' modules.

You can read the [[link | modules readme here]].

You can read the [[link | modules readme here]].

You can read the [[http://www.opensips.org/html/pua_xmpp.html |module readme here]].

You can read the [[link | modules readme here]].

There are many SIP phones( especially hard phones) that do not implement presence, or not presence with a central server. Even so, the server is aware if the phone is online or not from whether the phone is registered or not. This information is used by this module to send basical presence information to the Presence Server about any phone.

There are many SIP phones( especially hard phones) that do not implement presence, or not presence with a central server. Even so, the server is aware if the phone is online or not from whether the phone is registered or not. This information is used by this module to

# [[#pua_bla| pua_bla]]