Sip subscribe rls

Version 5 (Adrian Georgescu, 10/26/2008 04:17 pm)

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