Skype for Business - lobby Resource

lobby

  • JSON
  • XML

Represents a view of the participants who have not yet been admitted to an onlineMeeting.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe location of this resource on the server, and the target of an HTTP operation.

Resource description

A participant in the lobby can be admitted by another participant in the organizer or presenter role. A participant in the lobby who is not admitted will eventually be disconnected. Lobby settings are controlled by the meeting organizer using the accessLevel property of onlineMeeting.

Properties

None

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.
participant Represents a remote participant in a conversation.

Events

  • added
  • deleted
Resource Priority Sender Reason
participantHighconversation Indicates that a participant was added to the lobby.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=63"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=63"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/participants/843"
          },
          "in" : {
            "rel" : "lobby",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/lobby"
          },
          "type" : "added"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
participantHighconversation Indicates that a participant was removed from the lobby.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=69"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=69"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/participants/843"
          },
          "in" : {
            "rel" : "lobby",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/lobby"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

  • GET

Returns a representation of a view of the participants who have not yet been admitted to an onlineMeeting.

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error Code Subcode Description
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/lobby HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json

  

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2061
{
  "rel" : "lobby",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/communication/conversations/314/lobby"
    }
  },
  "_embedded" : {
    "participant" : [
      {
        "rel" : "participant",
        "anonymous" : true,
        "name" : "JoeSmith",
        "organizer" : true,
        "otherPhoneNumber" : "tel : +14251111111",
        "role" : "Attendee",
        "sourceNetwork" : "SameEnterprise",
        "uri" : "sip : john@contoso.com",
        "workPhoneNumber" : "tel : +14251111111",
        "_links" : {
          "self" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843"
          },
          "admit" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/admit"
          },
          "contact" : {
            "href" : "//v1/applications/970/people/235"
          },
          "contactPhoto" : {
            "href" : "//v1/applications/970/people/235/contactPhoto"
          },
          "contactPresence" : {
            "href" : "//v1/applications/970/people/235/contactPresence"
          },
          "conversation" : {
            "href" : "//v1/applications/970/communication/conversations/314"
          },
          "demote" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/demote"
          },
          "eject" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/eject"
          },
          "me" : {
            "href" : "//v1/applications/970/me"
          },
          "participantApplicationSharing" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantApplicationSharing"
          },
          "participantAudio" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantAudio"
          },
          "participantDataCollaboration" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantDataCollaboration"
          },
          "participantMessaging" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantMessaging"
          },
          "participantPanoramicVideo" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantPanoramicVideo"
          },
          "participantVideo" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/participantVideo"
          },
          "promote" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/promote"
          },
          "reject" : {
            "href" : "//v1/applications/970/communication/conversations/314/participants/843/reject"
          }
        }
      }
    ]
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/lobby HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

  

XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 2510
<?xml version="1.0" encoding="utf-8"?>
<resource rel="lobby" href="//v1/applications/970/communication/conversations/314/lobby" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="rel">lobby</property>
  <resource rel="participant" href="//v1/applications/970/communication/conversations/314/participants/843">
    <link rel="admit" href="//v1/applications/970/communication/conversations/314/participants/843/admit" />
    <link rel="contact" href="//v1/applications/970/people/235" />
    <link rel="contactPhoto" href="//v1/applications/970/people/235/contactPhoto" />
    <link rel="contactPresence" href="//v1/applications/970/people/235/contactPresence" />
    <link rel="conversation" href="//v1/applications/970/communication/conversations/314" />
    <link rel="demote" href="//v1/applications/970/communication/conversations/314/participants/843/demote" />
    <link rel="eject" href="//v1/applications/970/communication/conversations/314/participants/843/eject" />
    <link rel="me" href="//v1/applications/970/me" />
    <link rel="participantApplicationSharing" href="//v1/applications/970/communication/conversations/314/participants/843/participantApplicationSharing" />
    <link rel="participantAudio" href="//v1/applications/970/communication/conversations/314/participants/843/participantAudio" />
    <link rel="participantDataCollaboration" href="//v1/applications/970/communication/conversations/314/participants/843/participantDataCollaboration" />
    <link rel="participantMessaging" href="//v1/applications/970/communication/conversations/314/participants/843/participantMessaging" />
    <link rel="participantPanoramicVideo" href="//v1/applications/970/communication/conversations/314/participants/843/participantPanoramicVideo" />
    <link rel="participantVideo" href="//v1/applications/970/communication/conversations/314/participants/843/participantVideo" />
    <link rel="promote" href="//v1/applications/970/communication/conversations/314/participants/843/promote" />
    <link rel="reject" href="//v1/applications/970/communication/conversations/314/participants/843/reject" />
    <property name="rel">participant</property>
    <property name="anonymous">True</property>
    <property name="name">Joe Smith</property>
    <property name="organizer">True</property>
    <property name="otherPhoneNumber">tel:+14251111111</property>
    <property name="role">Attendee</property>
    <property name="sourceNetwork">SameEnterprise</property>
    <property name="uri">sip:john@contoso.com</property>
    <property name="workPhoneNumber">tel:+14251111111</property>
  </resource>
</resource>