4.4.7 getConference

  • Article

The getConference command is sent by the client to the focus to retrieve the current active roster state of the conference.

Following is an example of a getConference request and a corresponding response. Note the response includes the encrypted conference key and web join URLs.

INFO sip:Alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C SIP/2.0
From: <sip:bob@fabrikam.com>;tag=958d8a3fbc;epid=c5574cd6b6
To: <sip:Alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C>
Content-Type: application/cccp+xml
Content-Length: 736
Via: SIP/2.0/TLS 10.1.2.50:4237
Max-Forwards: 70
Call-ID: ad0da39085864c768630674f17692101
CSeq: 12 INFO
Contact: <sip:bob@fabrikam.com;opaque=user:epid:HT07tI-f3F-fdDyic8rblwAA;gruu>
User-Agent: UCCP/2.0.6362.0 OC/2.0.6362.0 (Microsoft Office Communicator)
Supported: timer
ms-keep-alive: UAC;hop-hop=yes
Proxy-Authorization: NTLM qop="auth", realm="SIP Communications Service", opaque="99052D67", crand="6475c82f", cnum="82", targetname="sip/ocs.fabrikam.com", response="01000000e44de73c187afc887f8f5ef3"
 
<request C3PVersion="1"
         requestId="5" 
         from="sip:alice@contoso.com"
         to="sip:alice@contoso.com;gruu;opaque=app:conf:focus:id:5D3747C "
         xmlns="urn:ietf:params:xml:ns:cccp"
         xmlns:msci="http://schemas.microsoft.com/rtc/2005/08/confinfoextensions">
  <getConference>
    <conferenceKeys confEntity="sip:alice@contoso.com;gruu;opaque=app:conf:focus:id:5D3747C" />
<msci:encryption-key>
  <msci:x509-certificate>123213789BC234D</msci:x509-certificate>
</msci:encryption-key>
  </getConference>
</request>
 
 
INFO sip:10.54.78.109:4237;transport=tls;ms-opaque=6fb3a8330a;ms-received-cid=10A0D00;grid SIP/2.0
To: <sip:bob@fabrikam.com>;tag=958d8a3fbc;epid=c5574cd6b6
From: <sip:Alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C>
Content-Type: application/cccp+xml
Content-Length: 736
Via: SIP/2.0/TLS 10.1.2.50:4237
Max-Forwards: 70
Call-ID: ad0da39085864c768630674f17692101
CSeq: 53 INFO
Authentication-Info: NTLM rspauth="01000000180D3416377238967F8F5EF3", srand="D6CD41F7", snum="180", opaque="99052D67", qop="auth", targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service"
 
<response C3PVersion="1"
          requestId="5" 
      from="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C "
          to="sip:bob@fabrikam.com"
          code="success"
          xmlns="urn:ietf:params:xml:ns:cccp"
          xmlns="urn:ietf:params:xml:ns:conference-info"
  xmlns:msci="http://schemas.fabrikam.com/rtc/2005/08/confinfoextensions"
  xmlns:msim="http://schemas.fabrikam.com/rtc/2005/08/imconfinfoextensions"
  xmlns:ci="urn:ietf:params:xml:ns:conference-info"
 xmlns:cis="urn:ietf:params:xml:ns:conference-info-separator"
> 
  <getConference>
  <conference-info 
    entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C"
  state="full" version="4">
  <conference-description>
    <conf-uris>
      <entry>
        <uri>sip:alice@fabrikam.com;gruu;opaque=app:conf:chat:id:5D3747C</uri>
        <display-text>chat</display-text>
        <purpose>chat</purpose>
      </entry>
      <entry>
        <uri>sip:alice@fabrikam.com;gruu;opaque=app:conf:meeting:id:5D3747C</uri>
        <display-text>meeting</display-text>
        <purpose>meeting</purpose>
      </entry>
      <entry>
        <uri>sip:alice@fabrikam.com;gruu;opaque=app:conf:audio-video:id:5D3747C</uri>
        <display-text>audio-video</display-text>
        <purpose>audio-video</purpose>
      </entry>
      <entry>
        <uri>sip:alice@fabrikam.com;gruu;opaque=app:conf:applicationsharing:id:5D3747C</uri>
        <display-text>applicationsharing</display-text>
        <purpose>applicationsharing</purpose>
      </entry>
 
<ci:entry>
<ci:uri>http://schemas.microsoft.com/2008/05/confxmlenc#content</ci:uri>
<ci:purpose>web-internal</ci:purpose>
<cis:separator/>
<msci:encrypted-uri>
<msci:cms-data>MIIBxQYJKoZIhvcNAQcDoIIBtjCCAbICAQAxgd0wgdoCAQAwQzAvMS0wKwYDVQQD
HiQAVQBDAEMAUABfAEMATwBOAEYAXwBNAEcAUgBfAEMARQBSAFQCEJZl58V5VBmQ
TbGUrNBQKJIwDQYJKoZIhvcNAQEBBQAEgYAF3rI5FWWEDcrrxJGS93WC3HC4YlmQ
+D/Ti6cICFX0opLmIwwwoWIlKBAjob8/HAWxmHjns2LrOafkvdDB9s0TJF7Bhl0f
v9L5PYZmj4DhttJqYiN0SxHssSPsdWBi/JYNlno4erqeLEkRiJh5P8mz0XtooO0b
zgrMNVpf+woSlTCBzAYJKoZIhvcNAQcBMBQGCCqGSIb3DQMHBAgF+wlt0hvIRoCB
qLTZ/YMC/7B2pF+V6oBpwo66uJRh6MseJFHbdWT8ptJVx9wJ5jUjFP5lfP+vqIKd
eX8aRvXffwFZJD4Kynzfd/0gQjZMlR90GHhyNimbeehrWuPwli+G14n0s+tejJjS
mf8t9oUSEKHxoljcyaK/fptHFXpp4W0sXa5QRIxcaw6FLIJGdPclVArRw1Bkaxx+
n+f32O/1wBAq2TT2MfRlgW9qzc3sPekOrw==
</msci:cms-data>
</msci:encrypted-uri>
</ci:entry>
<ci:entry>
<ci:uri>http://schemas.microsoft.com/2008/05/confxmlenc#content</ci:uri>
<ci:purpose>web-external</ci:purpose>
<cis:separator/>
<msci:encrypted-uri>
<msci:cms-data>MIIBxQYJKoZIhvcNAQcDoIIBtjCCAbICAQAxgd0wgdoCAQAwQzAvMS0wKwYDVQQD
HiQAVQBDAEMAUABfAEMATwBOAEYAXwBNAEcAUgBfAEMARQBSAFQCEJZl58V5VBmQ
TbGUrNBQKJIwDQYJKoZIhvcNAQEBBQAEgYCaFGVjZW/VHnfp23SzJAuW/Q9OnkfB
+qbwTsH6RBkZ3kX9yzFIrZsU+2R7z+nd3JcvTkJw/mmKxTaKRZksEDwbQGt/kG/V
4Fwx/XRQP9mFI+m6YNy56jgnwTiG97ClNNe+/1tJtiy/h4cFn5lfvoz5eZXPC8MO
Ls75p7hXLPdemTCBzAYJKoZIhvcNAQcBMBQGCCqGSIb3DQMHBAjTd6Z5fKA2K4CB
qBhSEZ5JbWkQ0dLYq8pcK/tbYHfODpwUcDAglGOgrpVWjHmnzm6gwGMURlfQ4X5Y
4wYpamBqfR5XDe6MP+99gpxdAelXTgUKE2/unwAr1pn69BgeiceZlX7kCV748wU6
P7ouOzbKBbLqRGEDO09MXmEwuWSJMacVdo94WkdNKie8cyFt9Q5d0CRltvG87OT2
YOI1xotrcyNwxbJUATHDMjC3+TMaq5UAPg==
</msci:cms-data>
</msci:encrypted-uri>
</ci:entry>
    </conf-uris>
<msci:conference-key>
<msci:cms-data>MIIBGwYJKoZIhvcNAQcDoIIBDDCCAQgCAQAxgd0wgdoCAQAwQzAvMS0wKwYDVQQD
HiQAVQBDAEMAUABfAEMATwBOAEYAXwBNAEcAUgBfAEMARQBSAFQCEHnE9lxFzvyH
Sz3dZuY7xq4wDQYJKoZIhvcNAQEBBQAEgYATbyHXHUnm0kqBO5T7vbhkPTnx8eVJ
YAa0OBid9dh7MwOWhC27pffS83ZwLaZVHsSxAUUR5h0Weq+TU5W+7VlZaTLYaxHF
jh3qElBX9gSf+KPRKTde2tCnP2FcJJL2Ksn20P2tt0mXgBmnbrf20niJxmjY028O
qt4UURxU7M5eFzAjBgkqhkiG9w0BBwEwFAYIKoZIhvcNAwcECP++R9m7uH9QgAA=
</msci:cms-data>
</msci:conference-key>
 
<cis:separator/>
<msci:pstn-access>
<msci:id>37890</msci:id>
</msci:pstn-access>
 
</conference-description>
  <users state="full">
    <user entity="sip:alice@fabrikam.com" state="full">
      <display-text>Alice Gates</display-text>
        <roles>
          <entry>presenter</entry>
        </roles>
        <endpoint entity="{09AA504C-BA41-4458-8669-8F35470F6CA2}" msci:session-type="focus" msci:endpoint-uri="sip:alice@fabrikam.com;opaque=user:epid:HT07tI-f3F-fdDyic8rblwAA;gruu">
          <status>connected</status>
        </endpoint>
    </user>
  </users>
 
  <msci:conference-view ci:state="full">
    <msci:entity-view ci:state="full" entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C">
      <msci:entity-state>
        <msci:locked>false</msci:locked>
      </msci:entity-state>
    </msci:entity-view>
    <msci:entity-view ci:state="full" entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:audio-video:id:5D3747C">
      <msci:entity-capabilities>
        <msav:capabilities>
          <msav:supports-audio>true</msav:supports-audio>
          <msav:supports-video>true</msav:supports-video>
        </msav:capabilities>
      </msci:entity-capabilities>
      <msci:entity-state>
        <msci:media>
          <entry label="main-audio">
            <type>audio</type>
            <status>sendrecv</status>
          </entry>
          <entry label="main-video">
            <type>video</type>
            <status>sendrecv</status>
            <msci:modal-parameters>
              <msci:video-parameters>
                <msav:video-mode>dominant-speaker-switched</msav:video-mode>
              </msci:video-parameters>
            </msci:modal-parameters>
          </entry>
          <entry label="panoramic-video">
            <type>panoramic-video</type>
            <status>sendrecv</status>
          </entry>
        </msci:media>
      </msci:entity-state>
    </msci:entity-view>
    <msci:entity-view ci:state="full" entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:chat:id:5D3747C">
      <msci:entity-state>
        <msci:locked>false</msci:locked>
        <msci:media>
          <entry label="chat">
            <type>chat</type>
          </entry>
        </msci:media>
      </msci:entity-state>
    </msci:entity-view>
    <msci:entity-view ci:state="full" entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:meeting:id:5D3747C">
      <msci:entity-state application="27877e66-615c-4582-ab88-0cb2ca05d951">
      <msci:locked>false</msci:locked>
        <msci:media>
          <entry label="meeting">
            <type>meeting</type>
          </entry>
        </msci:media>
      </msci:entity-state>
    </msci:entity-view>
<msci:entity-view ci:state="full" entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:applicationsharing:id:5D3747C ">
<msci:entity-capabilities>
<cis:separator/>
<msas:capabilities>
<msas:control-permission>ActiveDirectoryUsers</msas:control-permission>
</msas:capabilities>
</msci:entity-capabilities>
<msci:entity-state>
<msci:locked>false</msci:locked>
<msci:media>
<entry label="applicationsharing">
<type>applicationsharing</type>
</entry>
</msci:media>
</msci:entity-state>
</msci:entity-view>
  </msci:conference-view>
   </conference-info>
  </getConference>
</response>