Sip subscribe presence

Version 5 (Adrian Georgescu, 10/26/2008 02:32 pm)

1 1 Adrian Georgescu
== sip_subscribe_presence ==
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 4 Adrian Georgescu
[[Image(http://www.openxcap.org/chrome/site/SIPSIMPLE-concept.png, align=right, nolink)]]
8 4 Adrian Georgescu
9 3 Adrian Georgescu
Source code: [source:scripts/sip_subscribe_presence.py scripts/sip_subscribe_presence.py]
10 3 Adrian Georgescu
11 1 Adrian Georgescu
{{{
12 1 Adrian Georgescu
adigeo@ag-imac3:~$sip_subscribe_presence -h
13 5 Adrian Georgescu
Usage: sip_subscribe_presence [options] [target-user@target-domain.com]
14 1 Adrian Georgescu
15 5 Adrian Georgescu
This script will SUBSCRIBE to the presence event published by the specified
16 5 Adrian Georgescu
SIP target. If a SIP target is not specified, it will subscribe to its own
17 5 Adrian Georgescu
address. It will then interprete PIDF bodies contained in NOTIFYs and display
18 5 Adrian Georgescu
their meaning. The program will un-SUBSCRIBE and quit when CTRL+D is pressed.
19 1 Adrian Georgescu
20 1 Adrian Georgescu
Options:
21 1 Adrian Georgescu
  -h, --help            show this help message and exit
22 1 Adrian Georgescu
  -a NAME, --account-name=NAME
23 1 Adrian Georgescu
                        The account name from which to read account settings.
24 1 Adrian Georgescu
                        Corresponds to section Account_NAME in the
25 1 Adrian Georgescu
                        configuration file. If not supplied, the section
26 1 Adrian Georgescu
                        Account will be read.
27 1 Adrian Georgescu
  --sip-address=SIP_ADDRESS
28 1 Adrian Georgescu
                        SIP address of the user in the form user@domain
29 1 Adrian Georgescu
  -p PASSWORD, --password=PASSWORD
30 1 Adrian Georgescu
                        Password to use to authenticate the local account.
31 1 Adrian Georgescu
                        This overrides the setting from the config file.
32 1 Adrian Georgescu
  -n DISPLAY_NAME, --display-name=DISPLAY_NAME
33 1 Adrian Georgescu
                        Display name to use for the local account. This
34 1 Adrian Georgescu
                        overrides the setting from the config file.
35 1 Adrian Georgescu
  -e EXPIRES, --expires=EXPIRES
36 1 Adrian Georgescu
                        "Expires" value to set in SUBSCRIBE. Default is 300
37 1 Adrian Georgescu
                        seconds.
38 1 Adrian Georgescu
  -o IP[:PORT], --outbound-proxy=IP[:PORT]
39 1 Adrian Georgescu
                        Outbound SIP proxy to use. By default a lookup of the
40 1 Adrian Georgescu
                        domain is performed based on SRV and A records. This
41 1 Adrian Georgescu
                        overrides the setting from the config file.
42 1 Adrian Georgescu
  -c CONTENT_TYPE, --content-type=CONTENT_TYPE
43 1 Adrian Georgescu
                        "Content-Type" the UA expects to receving in a NOTIFY
44 1 Adrian Georgescu
                        for this subscription. For the known events this does
45 1 Adrian Georgescu
                        not need to be specified, but may be overridden".
46 1 Adrian Georgescu
  -s, --trace-sip       Dump the raw contents of incoming and outgoing SIP
47 1 Adrian Georgescu
                        messages (disabled by default).
48 1 Adrian Georgescu
  -l, --log-pjsip       Print PJSIP logging output (disabled by default).
49 1 Adrian Georgescu
}}}
50 2 Adrian Georgescu
51 2 Adrian Georgescu
=== Example ===
52 2 Adrian Georgescu
53 2 Adrian Georgescu
{{{
54 2 Adrian Georgescu
adigeo@ag-imac3:~$sip_subscribe_presence -a umts ag@ag-projects.com
55 2 Adrian Georgescu
Accounts available: 'alice', 'ew', 'mrg', 'pbx', 'tf', 'umts', 'unet', default
56 2 Adrian Georgescu
Using account 'umts': adi@umts.ro
57 2 Adrian Georgescu
Resolved DNS SRV record "_sip._udp.umts.ro" --> proxy.sipthor.net:5060
58 2 Adrian Georgescu
Resolved DNS A record "proxy.sipthor.net" --> 81.23.228.150, 81.23.228.129, 85.17.186.7
59 2 Adrian Georgescu
Subscribing to "<sip:ag@ag-projects.com>" for the presence event, at 85.17.186.7:5060
60 2 Adrian Georgescu
Received NOTIFY:
61 2 Adrian Georgescu
----------------
62 2 Adrian Georgescu
Presence for 31208005169@ag-projects.com:
63 2 Adrian Georgescu
  Person id yipgulqr
64 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:32
65 2 Adrian Georgescu
    Activities
66 2 Adrian Georgescu
      Note(en): I am working
67 2 Adrian Georgescu
    Mood: sad, contended, mean
68 2 Adrian Georgescu
    Time offset from UTC: 60 minutes 
69 2 Adrian Georgescu
  ---
70 2 Adrian Georgescu
  Service id apgjjwtz
71 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:42
72 2 Adrian Georgescu
    Status: open
73 2 Adrian Georgescu
----------------
74 2 Adrian Georgescu
Received NOTIFY:
75 2 Adrian Georgescu
----------------
76 2 Adrian Georgescu
Presence for 31208005169@ag-projects.com:
77 2 Adrian Georgescu
  Person id ksgxtgwo
78 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:41:04
79 2 Adrian Georgescu
    Mood: impressed, flirtatious, thirsty
80 2 Adrian Georgescu
    Time offset from UTC: 60 minutes 
81 2 Adrian Georgescu
  Person id yipgulqr
82 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:32
83 2 Adrian Georgescu
    Activities
84 2 Adrian Georgescu
      Note(en): I am working
85 2 Adrian Georgescu
    Mood: sad, contended, mean
86 2 Adrian Georgescu
    Time offset from UTC: 60 minutes 
87 2 Adrian Georgescu
  ---
88 2 Adrian Georgescu
  Service id apgjjwtz
89 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:42
90 2 Adrian Georgescu
    Status: open
91 2 Adrian Georgescu
  Service id hxpzsnfp
92 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:41:00
93 2 Adrian Georgescu
    Status: open
94 2 Adrian Georgescu
----------------
95 2 Adrian Georgescu
Received NOTIFY:
96 2 Adrian Georgescu
----------------
97 2 Adrian Georgescu
Presence for 31208005169@ag-projects.com:
98 2 Adrian Georgescu
  Person id ksgxtgwo
99 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:41:04
100 2 Adrian Georgescu
    Mood: impressed, flirtatious, thirsty
101 2 Adrian Georgescu
    Time offset from UTC: 60 minutes 
102 2 Adrian Georgescu
  Person id yipgulqr
103 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:32
104 2 Adrian Georgescu
    Activities
105 2 Adrian Georgescu
      Note(en): I am working
106 2 Adrian Georgescu
    Mood: sad, contended, mean
107 2 Adrian Georgescu
    Time offset from UTC: 60 minutes 
108 2 Adrian Georgescu
  ---
109 2 Adrian Georgescu
  Service id apgjjwtz
110 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:37:42
111 2 Adrian Georgescu
    Status: open
112 2 Adrian Georgescu
  Service id hxpzsnfp
113 2 Adrian Georgescu
    Timestamp: 2008-10-26 10:41:07
114 2 Adrian Georgescu
    Status: closed
115 2 Adrian Georgescu
----------------
116 2 Adrian Georgescu
117 2 Adrian Georgescu
}}}