Table of contents
me
to
TOC
Collapse the table of content
Expand the table of content

onlineMeeting

John Austin|Last Updated: 10/25/2016
|
2 Contributors

Applies to: Skype for Business 2015

        Represents a read-only version of the [onlineMeeting](onlineMeeting_ref.md) associated with this [conversation](conversation_ref.md).

For more on web links, see Web links.

NameDescription
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

NameDescription
accessLevelThe access level that controls admission to the online meeting.
attendeesThe list of online meeting attendees.
automaticLeaderAssignmentThe 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 theleader role when they join the meeting. For example, if the meeting is scheduled withautomatic promotion policy set to AutomaticLeaderAssignment.SameEnterprise, then any participants from the organizer's company are automaticallypromoted to leaders when they join the meeting. Conference leaders can still promote specific users to the leader role,including anonymous users.
conferenceIdThe conference ID for the online meeting.Attendees who dial into the online meeting by using a PSTN phone use the conference ID.
descriptionThe long description of the online meeting's purpose.
disclaimerBodyThe online meeting's disclaimer text.
disclaimerTitleThe online meeting's disclaimer title.
entryExitAnnouncementThe attendance announcements status for the online meeting.When attendance announcements are enabled, the online meeting will announce the names of the participantswho join the meeting through audio.
expirationTimeThe 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, thecurrent date and time on the server.
hostingNetworkThe online meeting's hosting network.
joinUrlThe URL that is used when the online meeting is joined from the web.
largeMeetingWhether large meeting mode is enabled or disabled for this online meeting.
leadersThe list of online meeting leaders.The organizer will automatically be added to the leaders list.
lobbyBypassForPhoneUsersThe lobby bypass setting for this online meeting.
onlineMeetingIdThe online meeting ID that identifies this meeting among the other online meetings that arescheduled by the organizer.The online meeting ID is unique within the organizer's list of scheduled online meetings.
onlineMeetingRelThe scheduling template that the organizer uses to schedule this online meeting.
onlineMeetingUriThe online meeting URI.The online meeting URI is used by participants to join this online meeting.
organizerNameThe display name of the contact who scheduled the online meeting.
organizerUriThe URI of the online meeting organizer: the person who scheduled the meeting.Organizers can enumerate or change only the conferences that they organize.
phoneUserAdmissionWhether participants can join the online meeting over the phone.Setting this property to true means that online meeting participants can join the meetingover the phone through the Conferencing Auto Attendant (CAA) service.
subjectThe subject of the online meeting.

This resource can have the following relationships.

LinkDescription
selfThe link to the current resource.
conversationRepresents the local participants perspective on a multi-modal, multi-party communication.
organizerRepresents the organizer of the online meeting.
phoneDialInInformationRepresents phone access information for an onlineMeeting.
onlineMeetingExtensionsRepresents the set of onlineMeetingExtensions for the associated onlineMeeting.

Azure Active Directory scopes for online applications

The user must have at least one of these scopes for operations on the resource to be allowed.

ScopePermissionDescription
Conversations.InitiateInitiate conversations and join meetingsAllows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user
Conversations.ReceiveReceive conversation invitesAllows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user

Events

Added

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

Updated

ResourcePrioritySenderReason
onlineMeetingHighconversationIndicates 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=1" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2" } }, "sender" : [ { "rel" : "conversation", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137", "events" : [ { "link" : { "rel" : "onlineMeeting", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/onlineMeeting" }, "in" : { "rel" : "conversation", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137" }, "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.

ErrorCodeSubcodeDescription
ServiceFailure500InvalidExchangeServerVersionInvalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict409AlreadyExistsThe already exists error.
Conflict409TooManyGroupsThe too many groups error.
Conflict409NoneUn-supported Service/Resource/API error.
Gone410CannotRedirectCannot redirect since there is no back up pool configured.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/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: 1666
{
  "rel" : "onlineMeeting",
  "accessLevel" : "Invited",
  "attendees" : [
    "sip:johndoe@contoso.com",
    "sip:janedoe@contoso.com"
  ],
  "automaticLeaderAssignment" : "Disabled",
  "conferenceId" : "12983487",
  "description" : "We\u0027ll be meeting to review the sales numbers for this past quarter and discuss projections for the next two quarters.",
  "disclaimerBody" : "The matters of this meeting are confidential.",
  "disclaimerTitle" : "Meeting Confidentiality",
  "entryExitAnnouncement" : "Disabled",
  "expirationTime" : "\/Date(1474932024507)\/",
  "hostingNetwork" : "https://meet.contoso.com",
  "joinUrl":"https : //meet.contoso.com/bmauldin/IB88RLLY","largeMeeting":"Disabled","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":"/ucwa/v1/applications/192/communication/conversations/137/onlineMeeting"},"conversation":{"href":"/ucwa/v1/applications/192/communication/conversations/137"},"organizer":{"href":"/ucwa/v1/applications/192/communication/conversations/137/onlineMeeting/organizer"},"phoneDialInInformation":{"href":"/ucwa/v1/applications/192/onlineMeetings/phoneDialInInformation"}},"_embedded":{"onlineMeetingExtension":[{"rel":"onlineMeetingExtension","id":"917823","type":"RoamedParticipantData","_links":{"self":{"href":"/ucwa/v1/applications/192/onlineMeetings/myOnlineMeetings/943/onlineMeetingExtensions/onlineMeetingExtension"}}}]}}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/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: 2431
<?xml version="1.0" encoding="utf-8"?>
<resource rel="onlineMeeting" href="/ucwa/v1/applications/192/communication/conversations/137/onlineMeeting" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="conversation" href="/ucwa/v1/applications/192/communication/conversations/137" />
  <link rel="organizer" href="/ucwa/v1/applications/192/communication/conversations/137/onlineMeeting/organizer" />
  <link rel="phoneDialInInformation" href="/ucwa/v1/applications/192/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">2016-09-26T16:20:24.5196479-07:00</property>
  <property name="hostingNetwork">https://meet.contoso.com</property>
  <property name="joinUrl">https://meet.contoso.com/bmauldin/IB88RLLY</property>
  <property name="largeMeeting">Unknown</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="/ucwa/v1/applications/192/onlineMeetings/myOnlineMeetings/943/onlineMeetingExtensions/onlineMeetingExtension">
    <property name="rel">onlineMeetingExtension</property>
    <property name="id">917823</property>
    <property name="type">RoamedParticipantData</property>
  </resource>
</resource>
© 2017 Microsoft