4.4.8 setLobbyAccess

Article
05/19/2020

The setLobbyAccess command is sent by the client to the focus to admit users from the lobby into the conference or to eject users out of the lobby.

Following is an example of a setLobbyAccess request and a corresponding response.

The client sends a setLobbyAccess request to the focus to admit Bob into the conference. In this example, Bob is a presenter who has the privileges to lock the conference.

 INFO sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU SIP/2.0
 FROM: <sip:alice@fabrikam.com>;epid=C740CAAEB6;tag=3d98c7859
 TO: <sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>;tag=F16D0080
 CSEQ: 7 INFO
 CALL-ID: 1aff74e7-cfc1-4618-93f1-8367bf6ff461
 MAX-FORWARDS: 70
 VIA: SIP/2.0/TLS 157.56.65.217:3221;branch=z9hG4bK7185d26c
 AUTHORIZATION: Kerberos realm="SIP Communications Service",targetname="sip/ocs.fabrika..com",response="040400ffffffffff0000000000000000eac97e53b2595c3602614fea",crand="0a0ff851",cnum="11",opaque="F7BE5261",qop="auth"
 CONTACT: <sip:alice@fabrikam.com;opaque=user:epid:-3O_9AUDMF-qNGIrfd9GqwAA;gruu>;text;audio;video;image
 CONTENT-LENGTH: 689
 SUPPORTED: gruu-10
 USER-AGENT: RTCC/4.0.0.0 AgentForCollaborationTests
 CONTENT-TYPE: application/cccp+xml
 <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  requestId="5" C3PVersion="1" 
  from="sip:alice@fabrikam.com" 
  to="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU" 
  xmlns="urn:ietf:params:xml:ns:cccp">
  <setLobbyAccess>
   <conferenceKeys confEntity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU" />
   <userEntity>sip:bob@fabrikam.com</userEntity>
   <access>granted</access>
  </setLobbyAccess>
 </request>

The focus validates the request and then responds with a 202 Accepted, indicating that the command is being processed.

 SIP/2.0 202 Accepted
 FROM: <sip:alice@fabrikam.com>;epid=C740CAAEB6;tag=3d98c7859
 TO:<sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>;tag=F16D0080
 Via: SIP/2.0/TLS 10.1.2.50:4237
 Max-Forwards: 70
 Call-ID: 1aff74e7-cfc1-4618-93f1-8367bf6ff461
 CSeq: 10 INFO
 Contact: <sip:ocs.exchange.corp.fabrikam.com:5061;transport=tls>;isfocus
 Authentication-Info: NTLM rspauth="01000000180D3416377238967F8F5EF3",    
 srand="D6CD41F7", snum="180", opaque="99052D67", qop="auth", 
 targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service"
 Content-Length: 0

The focus admits Bob and then sends a response, as shown in the following example:

INFO sip:10.54.78.109:4237;transport=tls;ms-opaque=6fb3a8330a;ms-received-cid=10A0D00;grid SIP/2.0

 FROM: <sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>;tag=F16D0080
 TO: <sip:alice@fabrikam.com>;tag=3d98c7859;epid=C740CAAEB6
 CSEQ: 1158 INFO
 CALL-ID: 1aff74e7-cfc1-4618-93f1-8367bf6ff461
 MAX-FORWARDS: 70
 VIA: SIP/2.0/TLS 172.24.32.150:5061;branch=z9hG4bK03B71C21.61B8433131093661;branched=FALSE
 CONTENT-LENGTH: 1591
 SUPPORTED: ms-dialog-route-set-update
 CONTENT-TYPE: application/cccp+xml
 AUTHENTICATION-INFO: Kerberos qop="auth", opaque="F7BE5261", srand="E52E9F9F", snum="14", rspauth="040401ffffffffff000000000000000041f3545d7770711ff3227c6e", targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service", version=4
 <response xmlns="urn:ietf:params:xml:ns:cccp" xmlns:msacp="http://schemas.microsoft.com/rtc/2005/08/acpconfinfoextensions" xmlns:msas="http://schemas.microsoft.com/rtc/2005/08/asconfinfoextensions" xmlns:tns="http://schemas.microsoft.com/rtc/2005/08/avconfinfoextensions" xmlns:mscp="http://schemas.microsoft.com/rtc/2005/08/cccpextensions" xmlns:msci="http://schemas.microsoft.com/rtc/2005/08/confinfoextensions" xmlns:msdata="http://schemas.microsoft.com/rtc/2005/08/dataconfinfoextensions" xmlns:msim="http://schemas.microsoft.com/rtc/2005/08/imconfinfoextensions" xmlns:msci2="http://schemas.microsoft.com/rtc/2008/12/confinfoextensions" xmlns:msmcu="http://schemas.microsoft.com/rtc/2009/03/commonmcuextensions" xmlns:ci="urn:ietf:params:xml:ns:conference-info" xmlns:cis="urn:ietf:params:xml:ns:conference-info-separator" xmlns:msls="urn:ietf:params:xml:ns:msls" requestId="5" C3PVersion="1" from="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU" to="sip:alice@fabrikam.com" code="success">
 <setLobbyAccess>
 <conferenceKeys confEntity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU"/>
 <status reason="success">
 <userEntity>sip:bob@fabrikam.com</userEntity>
 </status>
 </setLobbyAccess>
 </response>

The client responds with a 200 OK to indicate that the INFO response was received.

 SIP/2.0 200 OK
 TO: <sip:alice@fabrikam.com>;epid=C740CAAEB6;tag=3d98c7859
 FROM:<sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>;tag=F16D0080
 Via: SIP/2.0/TLS 10.1.2.50:4237
 Max-Forwards: 70
 Call-ID: 1aff74e7-cfc1-4618-93f1-8367bf6ff461
 CSeq: 10 INFO
 Contact: <sip:ocs.exchange.corp.fabrikam.com:5061;transport=tls>;isfocus
 Authentication-Info: NTLM rspauth="01000000180D3416377238967F8F5EF3",    
 srand="D6CD41F7", snum="180", opaque="99052D67", qop="auth", 
 targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service"
 Content-Length: 0

All watchers receive a notification from the focus, indicating that Bob was admitted to the conference and that Cathy was ejected.

 BENOTIFY sip:10.1.2.50:2383;transport=tls;ms-opaque=02e9ae1f28;ms-received-cid=00031600;grid SIP/2.0
 To: <sip:alice@fabrikam.com>;epid=C740CAAEB6;tag=3d98c7859
 From: <sip:Alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>
 Content-Length: 2373
 Content-Type: application/conference-info+xml
 Event: conference
 Call-ID: 72d6a36a36784cf58e7e7ab1a51deca2
 CSeq: 4 BENOTIFY
 Authentication-Info: NTLM rspauth="01000000180D3416377238967F8F5EF3", srand="D6CD41F7", snum="180", opaque="99052D67", qop="auth", targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service"
 Max-Forwards: 70
 Via: SIP/2.0/TLS 10.54.67.185:5061;branch=z9hG4bK86DA089F.780A7BCA;branched=FALSE
 subscription-state: active;expires=3600
  
 <conference-info 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"
   entity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU"
   state="partial" version="8">
   <users state="partial">
     <user entity="sip:bob@fabrikam.com" state="full">
       <display-text>Bob</display-text>
         <roles>
           <entry>presenter</entry>
         </roles>
         <endpoint entity="{09AA504C-BA41-4458-8669-8F35470F6CA2}" msci:session-type="focus" msci:endpoint-uri="sip:bob@fabrikam.com;opaque=user:epid:HT07tI-f3F-fdDyic8rblwAA;gruu">
           <status>connected</status>
         </endpoint>
     </user>
   </users>
 </conference-info>

Assume that Cathy was also a lobby participant, but was denied access into the conference by Alice. Cathy receives a BYE, as shown in the following example:

 BENOTIFY sip:10.1.2.50:2383;transport=tls;ms-opaque=02e9ae1f28;ms-received-cid=00031600;grid SIP/2.0
 FROM: < sip:Alice@fabrikam.com;gruu;opaque=app:conf:focus:id:SI1NZFAU>
 >;tag=47150080
 TO: <sip:cathy@fabrikam.com>;tag=cec49c86e1;epid=732A323248
 CSEQ: 2 BENOTIFY
 CALL-ID: 5a749d9794cb4639ab290033b9332a57
 MAX-FORWARDS: 70
 VIA: SIP/2.0/TLS 172.24.32.150:5061;branch=z9hG4bKDDA0E5C6.F0433D83D36FE063;branched=FALSE
 CONTENT-LENGTH: 0
 EVENT: conference
 EXPIRES: 0
 SUBSCRIPTION-STATE: terminated;expires=0;reason=ParticipantDenied
 AUTHENTICATION-INFO: Kerberos qop="auth", opaque="D211BAF4", srand="0F7C511D", snum="7", rspauth="040401ffffffffff000000000000000008b2eea6f1b43bd4abe390a9", targetname="sip/ocs.fabrikam.com", realm="SIP Communications Service", version=4
 ms-diagnostics-public: 3119;reason="Participant Denied

4.4.8 setLobbyAccess

Additional resources