Skype for Business - onlineMeeting Resource

onlineMeeting

  • JSON
  • XML

Represents a read-only version of the onlineMeeting associated with this conversation.

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

The resource captures information about the meeting, including the join URL, the attendees list, and the description.

Properties

Name Description
accessLevel The access level that controls admission to the online meeting.
attendees The list of online meeting attendees.
automaticLeaderAssignment The policy that determines which participants are automatically promoted to leaders.

An online meeting organizer can schedule a meeting so that users are automatically promoted to the leader role when they join the meeting. For example, if the meeting is scheduled with automatic promotion policy set to AutomaticLeaderAssignment.SameEnterprise, then any participants from the organizer's company are automatically promoted to leaders when they join the meeting. Conference leaders can still promote specific users to the leader role, including anonymous users.

conferenceId The conference ID for the online meeting.

Attendees who dial into the online meeting by using a PSTN phone use the conference ID.

description The long description of the online meeting's purpose.
disclaimerBody The online meeting's disclaimer text.
disclaimerTitle The online meeting's disclaimer title.
entryExitAnnouncement The attendance announcements status for the online meeting.

When attendance announcements are enabled, the online meeting will announce the names of the participants who join the meeting through audio.

expirationTime The absolute Coordinated Universal Time (UTC) date and time after which the online meeting can be deleted.

The day and time must be between one year before, and ten years after, the current date and time on the server.

hostingNetwork The online meeting's hosting network.
joinUrl The URL that is used when the online meeting is joined from the web.
largeMeeting Whether large meeting mode is enabled or disabled for this online meeting.
leaders The list of online meeting leaders.

The organizer will automatically be added to the leaders list.

lobbyBypassForPhoneUsers The lobby bypass setting for this online meeting.
onlineMeetingId The online meeting ID that identifies this meeting among the other online meetings that are scheduled by the organizer.

The online meeting ID is unique within the organizer's list of scheduled online meetings.

onlineMeetingRel The scheduling template that the organizer uses to schedule this online meeting.
onlineMeetingUri The online meeting URI.

The online meeting URI is used by participants to join this online meeting.

organizerName The display name of the contact who scheduled the online meeting.
organizerUri The URI of the online meeting organizer: the person who scheduled the meeting.

Organizers can enumerate or change only the conferences that they organize.

phoneUserAdmission Whether participants can join the online meeting over the phone.

Setting this property to true means that online meeting participants can join the meeting over the phone through the Conferencing Auto Attendant (CAA) service.

subject The subject of the online meeting.

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.
conversation Represents the local participants perspective on a multi-modal, multi-party communication.
organizer Represents the organizer of the online meeting.
phoneDialInInformation Represents phone access information for an onlineMeeting.
onlineMeetingExtensions Represents the set of onlineMeetingExtensions for the associated onlineMeeting.

Events

  • added
  • updated
Resource Priority Sender Reason
onlineMeetingHighconversation Indicates that the corresponding onlineMeeting has been added to a conversation.

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=21"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=21"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314",
      "events" : [
        {
          "link" : {
            "rel" : "onlineMeeting",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/onlineMeeting"
          },
          "in" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314"
          },
          "type" : "added"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
onlineMeetingHighconversation Indicates that the corresponding onlineMeeting has been updated in a conversation.

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=77"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=77"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314",
      "events" : [
        {
          "link" : {
            "rel" : "onlineMeeting",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/onlineMeeting"
          },
          "in" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Operations

  • GET

Returns a read-only version of the onlineMeeting associated with this conversation.

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/onlineMeeting 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: 1647
{
  "rel" : "onlineMeeting",
  "accessLevel" : "Locked",
  "attendees" : [
    "sip : johndoe@contoso.com",
    "sip : janedoe@contoso.com"
  ],
  "automaticLeaderAssignment" : "Disabled",
  "conferenceId" : "12983487",
  "description" : "We\u0027llbemeetingtoreviewthesalesnumbersforthispastquarteranddiscussprojectionsforthenexttwoquarters.",
  "disclaimerBody" : "Themattersofthismeetingareconfidential.",
  "disclaimerTitle" : "MeetingConfidentiality",
  "entryExitAnnouncement" : "Unsupported",
  "expirationTime" : "\/Date(1430220844589)\/",
  "hostingNetwork" : "https : //meet.contoso.com",
  "joinUrl" : "https : //meet.contoso.com/bmauldin/IB88RLLY",
  "largeMeeting" : "Unknown",
  "leaders" : [
    "sip : aikc@contoso.com",
    "sip : lenea@contoso.com"
  ],
  "lobbyBypassForPhoneUsers" : "Disabled",
  "onlineMeetingId" : "IB88RLLY",
  "onlineMeetingRel" : "myOnlineMeetings",
  "onlineMeetingUri" : "sip : bmauldin@contoso.com;gruu;opaque=app : conf : focus : id : IB88RLLY",
  "organizerName" : "BillMauldin",
  "organizerUri" : "sip : bmauldin@contoso.com",
  "phoneUserAdmission" : "Disabled",
  "subject" : "Quarterlysalesnumbers",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/communication/conversations/314/onlineMeeting"
    },
    "conversation" : {
      "href" : "//v1/applications/970/communication/conversations/314"
    },
    "organizer" : {
      "href" : "//v1/applications/970/communication/conversations/314/onlineMeeting/organizer"
    },
    "phoneDialInInformation" : {
      "href" : "//v1/applications/970/onlineMeetings/phoneDialInInformation"
    }
  },
  "_embedded" : {
    "onlineMeetingExtension" : [
      {
        "rel" : "onlineMeetingExtension",
        "id" : "917823",
        "type" : "RoamedParticipantData",
        "_links" : {
          "self" : {
            "href" : "//v1/applications/970/onlineMeetings/myOnlineMeetings/617/onlineMeetingExtensions/onlineMeetingExtension"
          }
        }
      }
    ]
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/onlineMeeting 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: 2412
<?xml version="1.0" encoding="utf-8"?>
<resource rel="onlineMeeting" href="//v1/applications/970/communication/conversations/314/onlineMeeting" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="conversation" href="//v1/applications/970/communication/conversations/314" />
  <link rel="organizer" href="//v1/applications/970/communication/conversations/314/onlineMeeting/organizer" />
  <link rel="phoneDialInInformation" href="//v1/applications/970/onlineMeetings/phoneDialInInformation" />
  <property name="rel">onlineMeeting</property>
  <property name="accessLevel">Invited</property>
  <propertyList name="attendees">
    <item>sip:johndoe@contoso.com</item>
    <item>sip:janedoe@contoso.com</item>
  </propertyList>
  <property name="automaticLeaderAssignment">SameEnterprise</property>
  <property name="conferenceId">12983487</property>
  <property name="description">We'll be meeting to review the sales numbers for this past quarter and discuss projections for the next two quarters.</property>
  <property name="disclaimerBody">The matters of this meeting are confidential.</property>
  <property name="disclaimerTitle">Meeting Confidentiality</property>
  <property name="entryExitAnnouncement">Unsupported</property>
  <property name="expirationTime">2015-04-28T04:34:04.6053431-07:00</property>
  <property name="hostingNetwork">https://meet.contoso.com</property>
  <property name="joinUrl">https://meet.contoso.com/bmauldin/IB88RLLY</property>
  <property name="largeMeeting">Disabled</property>
  <propertyList name="leaders">
    <item>sip:aikc@contoso.com</item>
    <item>sip:lenea@contoso.com</item>
  </propertyList>
  <property name="lobbyBypassForPhoneUsers">Disabled</property>
  <property name="onlineMeetingId">IB88RLLY</property>
  <property name="onlineMeetingRel">myOnlineMeetings</property>
  <property name="onlineMeetingUri">sip:bmauldin@contoso.com;gruu;opaque=app:conf:focus:id:IB88RLLY</property>
  <property name="organizerName">Bill Mauldin</property>
  <property name="organizerUri">sip:bmauldin@contoso.com</property>
  <property name="phoneUserAdmission">Disabled</property>
  <property name="subject">Quarterly sales numbers</property>
  <resource rel="onlineMeetingExtension" href="//v1/applications/970/onlineMeetings/myOnlineMeetings/617/onlineMeetingExtensions/onlineMeetingExtension">
    <property name="rel">onlineMeetingExtension</property>
    <property name="id">917823</property>
    <property name="type">RoamedParticipantData</property>
  </resource>
</resource>