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.
This resource supports subscribing to change notifications. For more details, see subscribe to online meetings.
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. |
| List transcripts of an onlineMeeting | callTranscript collection | Retrieve the list of transcripts of an onlineMeeting. |
| List recordings of an onlineMeeting | callRecording collection | Get the list of callRecording objects associated with an onlineMeeting. |
Properties
| Property | Type | Description |
|---|---|---|
| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. |
| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. |
| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. |
| allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. |
| allowTeamworkReactions | Boolean | Indicates if Teams reactions are enabled for the meeting. |
| allowTranscription | Boolean | Indicates whether transcription is enabled for the meeting. |
| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. |
| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. |
| alternativeRecording | Stream | The content stream of the alternative recording of a Microsoft Teams live event. Read-only. |
| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity will be anonymized in the meeting. Possible values are: attendee. The attendee value cannot be removed through a PATCH operation once added. |
| attendeeReport | Stream | The content stream of the attendee report of a Teams live event. 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. |
| 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 whether this is a Teams live event. |
| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. |
| joinInformation | itemBody | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only. |
| joinMeetingIdSettings | joinMeetingIdSettings | Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Once an onlineMeeting is created, the joinMeetingIdSettings cannot be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. |
| joinWebUrl | String | The join URL of the online meeting. 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. |
| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. |
| recording | Stream | The content stream of the recording of a Teams live event. Read-only. |
| shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | Specifies whether meeting chat history is shared with participants. Possible values are: all, none, unknownFutureValue. |
| startDateTime | DateTime | The meeting start time in UTC. |
| subject | String | The subject of the online meeting. |
| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. |
| watermarkProtection | watermarkProtectionValues | Specifies whether a watermark should be applied to a content type by the client application. |
| autoAdmittedUsers (deprecated) | 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. |
| capabilities (deprecated) | meetingCapabilities collection | The list of meeting capabilities. Possible values are: questionAndAnswer,unknownFutureValue. |
Caution
- The autoAdmittedUsers property is deprecated. Use the scope property of lobbyBypassSettings instead.
- The capabilities property is deprecated. Use the isQuestionAndAnswerEnabled property of broadcastMeetingSettings instead.
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 | Evolvable enumeration sentinel value. Do not use. |
Tip
When creating or updating an online meeting with allowedPresenters set to roleIsPresenter, include a full list of attendees with the specified attendees' role set to presenter in the request body.
meetingChatMode values
| Value | Description |
|---|---|
| enabled | Meeting chat is enabled. |
| disabled | Meeting chat is disabled. |
| limited | Meeting chat is enabled but only for the duration of the meeting call. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
meetingChatHistoryDefaultMode values
| Value | Description |
|---|---|
| all | All meeting chat history is shared. |
| none | No meeting chat history is shared. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| attendanceReports | meetingAttendanceReport collection | The attendance reports of an online meeting. Read-only. |
| recordings | callRecording collection | The recordings of an online meeting. Read-only. |
| registration | meetingRegistration | The registration that has been enabled for an online meeting. One online meeting can only have one registration enabled. |
| transcripts | callTranscript collection | The transcripts of an online meeting. Read-only. |
| meetingAttendanceReport (deprecated) | meetingAttendanceReport | The attendance report of the latest online meeting session. Read-only. |
Tip
- The meetingAttendanceReport property is deprecated. It will remain in beta for backward compatibility. Going forward, please use attendanceReports property to retrieve attendance reports of an online meeting.
- The type of registration can be meetingRegistration or externalMeetingRegistration, both of which inherit from meetingRegistrationBase.
JSON representation
{
"allowAttendeeToEnableCamera": "Boolean",
"allowAttendeeToEnableMic": "Boolean",
"allowMeetingChat": {"@odata.type": "microsoft.graph.meetingChatMode"},
"allowTeamworkReactions": "Boolean",
"allowedPresenters": "String",
"alternativeRecording": "Stream",
"anonymizeIdentityForRoles": ["String"],
"attendeeReport": "Stream",
"audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"},
"broadcastSettings": {"@odata.type": "microsoft.graph.broadcastSettings"},
"chatInfo": {"@odata.type": "microsoft.graph.chatInfo"},
"creationDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"id": "String (identifier)",
"isBroadcast": "Boolean",
"isEntryExitAnnounced": "Boolean",
"joinInformation": {"@odata.type": "microsoft.graph.itemBody"},
"joinMeetingIdSettings": {"@odata.type": "microsoft.graph.joinMeetingIdSettings"},
"joinWebUrl": "String",
"lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"},
"participants": {"@odata.type": "microsoft.graph.meetingParticipants"},
"recordAutomatically": "Boolean",
"recording": "Stream",
"shareMeetingChatHistoryDefault": "microsoft.graph.meetingChatHistoryDefaultMode",
"startDateTime": "String (timestamp)",
"subject": "String",
"videoTeleconferenceId": "String",
"watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"}
}
Feedback
Submit and view feedback for