onlineMeeting resource type
Namespace: microsoft.graph
Contains information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
Caution
Microsoft Graph online meeting APIs that support Microsoft Teams live events are deprecated and stopped returning data on September 30, 2024. New Microsoft Graph APIs will replace these APIs in spring of 2025. For more information, see Retirement of Teams live events API on Microsoft Graph.
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 | Create an onlineMeeting object with a custom, external ID. If the meeting already exists, retrieve its properties. |
| List transcripts | callTranscript collection | Retrieve the list of transcripts of an onlineMeeting. |
| List recordings | callRecording collection | Retrieve the list of recordings of an onlineMeeting. |
Note
- A bearer token is required for the
Authorizationheader for all the methods listed in the previous table. For details about how to get thetokenfor theAuthorizationheader, see Get access on behalf of a user. - The expiry time for online meetings is set to 60 days after the meeting's start or end time. If the meeting is updated or activated before it expires, the expiry time will be extended by another 60 days.
Properties
| Property | Type | Description |
|---|---|---|
| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from onlineMeetingBase. |
| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from onlineMeetingBase. |
| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. Possible values are listed in the following table. Inherited from onlineMeetingBase. |
| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. Inherited from onlineMeetingBase. |
| allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. Inherited from onlineMeetingBase. |
| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from onlineMeetingBase. |
| audioConferencing | audioConferencing | The phone access (dial-in) information for an online meeting. Read-only. Inherited from onlineMeetingBase. |
| chatInfo | chatInfo | The chat information associated with this online meeting. Inherited from onlineMeetingBase. |
| creationDateTime | DateTime | The meeting creation time in UTC. Read-only. |
| endDateTime | DateTime | The meeting end time in UTC. Required when you create an online meeting. |
| joinWebUrl | String | The join URL of the online meeting. The format of the URL may change; therefore, users shouldn't rely on any information extracted from parsing the URL. Read-only. Inherited from onlineMeetingBase. |
| participants | meetingParticipants | The participants associated with the online meeting, including the organizer and the attendees. |
| subject | String | The subject of the online meeting. Required when you create an online meeting. |
| id | String | The default ID associated with the online meeting. Read-only. Inherited from onlineMeetingBase. |
| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from onlineMeetingBase. |
| joinInformation | itemBody | The join information in the language and locale variant specified in the Accept-Language request HTTP header. Read-only. Inherited from onlineMeetingBase. |
| joinMeetingIdSettings | joinMeetingIdSettings | Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Once an onlineMeeting is created, the joinMeetingIdSettings can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from onlineMeetingBase. |
| lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. Inherited from onlineMeetingBase. |
| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from onlineMeetingBase. |
| shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | Specifies whether meeting chat history is shared with participants. Possible values are: all, none, unknownFutureValue. Inherited from onlineMeetingBase. |
| startDateTime | DateTime | The meeting start time in UTC. |
| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from onlineMeetingBase. |
| watermarkProtection | watermarkProtectionValues | Specifies whether the client application should apply a watermark a content type. Inherited from onlineMeetingBase. |
| attendeeReport (deprecated) | Stream | The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| broadcastSettings (deprecated) | broadcastMeetingSettings | Settings related to a live event. |
| isBroadcast (deprecated) | Boolean | Indicates whether this meeting is a Teams live event. |
onlineMeetingPresenters values
| Value | Description |
|---|---|
| everyone | Everyone is a presenter. Default. |
| 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. Don't 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 during the meeting call. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
meetingChatHistoryDefaultMode values
| Value | Description |
|---|---|
| all | All meeting chat history is shared. |
| none | No meeting chat history is shared. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| attendanceReports | meetingAttendanceReport collection | The attendance reports of an online meeting. Read-only. Inherited from onlineMeetingBase. |
| recordings | callRecording collection | The recordings of an online meeting. Read-only. |
| transcripts | callTranscript collection | The transcripts of an online meeting. Read-only. |
JSON representation
The following JSON representation shows the resource type.
{
"allowAttendeeToEnableCamera": "Boolean",
"allowAttendeeToEnableMic": "Boolean",
"allowMeetingChat": {"@odata.type": "microsoft.graph.meetingChatMode"},
"allowTeamworkReactions": "Boolean",
"allowedPresenters": "String",
"audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"},
"chatInfo": {"@odata.type": "microsoft.graph.chatInfo"},
"creationDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"id": "String (identifier)",
"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",
"startDateTime": "String (timestamp)",
"subject": "String",
"videoTeleconferenceId": "String",
}