Sip subscribe rls

Version 16 (Adrian Georgescu, 03/14/2009 09:54 am)

1 10 Adrian Georgescu
== sip_subscribe_rls ==
2 14 Adrian Georgescu
[[TOC(SipTesting*, sip_*,xcap*, depth=2)]]
3 1 Adrian Georgescu
4 15 Adrian Georgescu
To use this script you must to have a valid [wiki:SipSettingsAPI configuration]. The SIP Presence agent and XCAP server must have support for RLS services.
5 1 Adrian Georgescu
6 10 Adrian Georgescu
=== Description ===
7 1 Adrian Georgescu
8 16 Adrian Georgescu
[[Image(http://www.openxcap.org/chrome/site/SIMPLE-RLS-services.png, align=right)]]
9 4 Adrian Georgescu
10 8 Adrian Georgescu
A Resource List Server (RLS) services application is a Session Initiation Protocol (SIP) application whereby a server receives SUBSCRIBE requests for a resource, and generates subscriptions towards a resource list. The received NOTIFY messages are the  aggregated downstream to the original subscriber generating less traffic to the subscriber end-user device.
11 7 Adrian Georgescu
12 7 Adrian Georgescu
This script implements sending SUBSCRIBE to a RLS server and receiving NOTIFY messages from it.
13 6 Adrian Georgescu
14 2 Adrian Georgescu
Source code: [source:scripts/sip_subscribe_rls.py scripts/sip_subscribe_rls.py]
15 1 Adrian Georgescu
16 1 Adrian Georgescu
{{{
17 3 Adrian Georgescu
adigeo@ag-imac3:~$sip_subscribe_rls -h
18 3 Adrian Georgescu
Usage: sip_subscribe_rls [options] [target-user@target-domain.com]
19 1 Adrian Georgescu
20 1 Adrian Georgescu
This script will SUBSCRIBE to the presence event published by the specified
21 3 Adrian Georgescu
SIP target assuming it is a resource list handled by a RLS server. The RLS
22 3 Adrian Georgescu
server will then SUBSCRIBE in behalf of the account, collect NOTIFYs with the
23 3 Adrian Georgescu
presence information of the recipients and provide periodically aggregated
24 3 Adrian Georgescu
NOTIFYs back to the subscriber. If a target address is not specified, it will
25 3 Adrian Georgescu
subscribe to the account's own address. It will then interprete PIDF bodies
26 1 Adrian Georgescu
contained in NOTIFYs and display their meaning. The program will un-SUBSCRIBE
27 1 Adrian Georgescu
and quit when CTRL+D is pressed.
28 1 Adrian Georgescu
29 1 Adrian Georgescu
Options:
30 1 Adrian Georgescu
  -h, --help            show this help message and exit
31 1 Adrian Georgescu
  -a NAME, --account-name=NAME
32 1 Adrian Georgescu
                        The account name from which to read account settings.
33 1 Adrian Georgescu
                        Corresponds to section Account_NAME in the
34 1 Adrian Georgescu
                        configuration file. If not supplied, the section
35 1 Adrian Georgescu
                        Account will be read.
36 1 Adrian Georgescu
  --sip-address=SIP_ADDRESS
37 1 Adrian Georgescu
                        SIP address of the user in the form user@domain
38 1 Adrian Georgescu
  -p PASSWORD, --password=PASSWORD
39 1 Adrian Georgescu
                        Password to use to authenticate the local account.
40 1 Adrian Georgescu
                        This overrides the setting from the config file.
41 1 Adrian Georgescu
  -n DISPLAY_NAME, --display-name=DISPLAY_NAME
42 1 Adrian Georgescu
                        Display name to use for the local account. This
43 1 Adrian Georgescu
                        overrides the setting from the config file.
44 1 Adrian Georgescu
  -e EXPIRES, --expires=EXPIRES
45 1 Adrian Georgescu
                        "Expires" value to set in SUBSCRIBE. Default is 300
46 1 Adrian Georgescu
                        seconds.
47 1 Adrian Georgescu
  -o IP[:PORT], --outbound-proxy=IP[:PORT]
48 1 Adrian Georgescu
                        Outbound SIP proxy to use. By default a lookup of the
49 1 Adrian Georgescu
                        domain is performed based on SRV and A records. This
50 1 Adrian Georgescu
                        overrides the setting from the config file.
51 1 Adrian Georgescu
  -c CONTENT_TYPE, --content-type=CONTENT_TYPE
52 1 Adrian Georgescu
                        "Content-Type" the UA expects to receving in a NOTIFY
53 1 Adrian Georgescu
                        for this subscription. For the known events this does
54 1 Adrian Georgescu
                        not need to be specified, but may be overridden".
55 1 Adrian Georgescu
  -s, --trace-sip       Dump the raw contents of incoming and outgoing SIP
56 1 Adrian Georgescu
                        messages (disabled by default).
57 1 Adrian Georgescu
  -l, --log-pjsip       Print PJSIP logging output (disabled by default).
58 1 Adrian Georgescu
}}}