onlineMeeting resource type
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Contains information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
Methods
Method | Return Type | Description |
---|---|---|
Create | onlineMeeting | Create an online meeting. |
Get | onlineMeeting | Read the properties and relationships of an onlineMeeting object. |
Update | onlineMeeting | Update the properties of an onlineMeeting object. |
Delete | None | Delete an onlineMeeting object. |
Create or get onlineMeeting | onlineMeeting | Create an online meeting with a custom, external ID. If the meeting already exists, retrieve its properties. |
Properties
Property | Type | Description |
---|---|---|
allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. Possible values are everyone , organization , roleIsPresenter , organizer , and unknownFutureValue . |
alternativeRecording | Stream | The content stream of the alternative recording of a live event. Read-only. |
attendeeReport | Stream | The content stream of the attendee report of a live event. Read-only. |
autoAdmittedUsers | String | The setting that specifies the type of participants that will automatically be allowed into the online meeting. Possible values are: everyone , everyoneInSameAndFederatedCompany , everyoneInCompany , invitedUsersInCompany , organizer . Read-only. |
audioConferencing | audioConferencing | The phone access (dial-in) information for an online meeting. Read-only. |
broadcastSettings | broadcastMeetingSettings | Settings related to a live event* |
chatInfo | chatInfo | The chat information associated with this online meeting. |
creationDateTime | DateTime | The meeting creation time in UTC. Read-only. |
capabilities | meetingCapabilities collection | The list of meeting capabilities. Possible values are: questionAndAnswer ,unknownFutureValue . |
endDateTime | DateTime | The meeting end time in UTC. |
externalId | String | The external ID. A custom ID. Optional. |
id | String | The default ID associated with the online meeting. Read-only. |
isBroadcast | Boolean | Indicates if this is a live event. |
isEntryExitAnnounced | Boolean | Whether or not to announce when callers join or leave. |
joinWebUrl | String | The join URL of the online meeting. Read-only. |
joinInformation | itemBody | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only |
lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. |
participants | meetingParticipants | The participants associated with the online meeting. This includes the organizer and the attendees. |
recording | Stream | The content stream of the recording of a live event. Read-only. |
startDateTime | DateTime | The meeting start time in UTC. |
subject | String | The subject of the online meeting. |
videoTeleconferenceId | String | The video teleconferencing ID. Read-only. |
Important
The autoAdmittedUsers property is obsolete. Use lobbyBypassSettings.scope instead for meeting option configurations.
*\Creating live events with the broadcastSettings property is in Beta, with important limitations. Please refer to broadcastSettings for more details.
onlineMeetingPresenters values
Value | Description |
---|---|
everyone | Everyone is a presenter (This is default option). |
organization | Everyone in organizer’s organization is a presenter. |
roleIsPresenter | Only the participants whose role is presenter are presenters. |
organizer | Only the organizer is a presenter. |
unknownFutureValue | Unknown future value. |
Note: If the value of allowedPresenters is set to roleIsPresenter
, please specify each meeting participant's meeting role using role property in meetingParticipantInfo.
JSON representation
{
"audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"},
"chatInfo": {"@odata.type": "microsoft.graph.chatInfo"},
"creationDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"id": "String (identifier)",
"joinWebUrl": "String",
"participants": {"@odata.type": "microsoft.graph.meetingParticipants"},
"startDateTime": "String (timestamp)",
"subject": "String",
"capabilities": [ "questionAndAnswer" ],
"videoTeleconferenceId": "String",
"isEntryExitAnnounced": "Boolean",
"lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"},
"allowedPresenters": "String",
"isBroadcast": "Boolean",
"broadcastSettings": {"@odata.type": "microsoft.graph.broadcastSettings"}
}