onlineMeeting 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
包含有关会议的信息,包括用于加入会议的 URL、与会者列表和说明。
此资源支持订阅 更改通知。 有关详细信息,请参阅 订阅联机会议。
继承自 onlineMeetingBase。
方法
方法 | 返回类型 | 说明 |
---|---|---|
创建 | onlineMeeting | 创建联机会议。 |
Get | onlineMeeting | 读取 onlineMeeting 对象的属性和关系。 |
更新 | onlineMeeting | 更新 onlineMeeting 对象的属性。 |
删除 | None | 删除 onlineMeeting 对象。 |
创建或获取 | onlineMeeting | 使用自定义外部 ID 创建联机会议。 如果会议已存在,请检索其属性。 |
列出脚本 | callTranscript 集合 | 检索 onlineMeeting 的脚本列表。 |
列出录制内容 | callRecording 集合 | 检索与 onlineMeeting 关联的 callRecording 对象列表。 |
注意
上表中列出的所有方法的 Authorization
标头都需要持有者令牌。 有关如何获取 token
标头的 Authorization
的详细信息,请参阅 代表用户获取访问权限。
警告
支持 Microsoft Teams 实时事件的 Graph Online 会议 API 已弃用,将于 2024 年 9 月 30 日停止运行。 新的 Graph API 将在 2024 年春季替换此 API。 有关详细信息,请参阅 停用 Microsoft Graph 上的 Teams 实时事件 API。
属性
属性 | 类型 | 说明 |
---|---|---|
allowAttendeeToEnableCamera | 布尔值 | 指示与会者是否可以打开其相机。 继承自 onlineMeetingBase。 |
allowAttendeeToEnableMic | 布尔值 | 指示与会者是否可以打开其麦克风。 继承自 onlineMeetingBase。 |
allowBreakoutRooms | 布尔值 | 指示是否为会议启用分组讨论室。 继承自 onlineMeetingBase。 |
allowedPresenters | onlineMeetingPresenters | 指定谁可以成为会议中的演示者。 可取值为:everyone 、organization 、roleIsPresenter 、organizer 、unknownFutureValue 。 继承自 onlineMeetingBase。 |
allowLiveShare | meetingLiveShareOptions | 指示是否为会议启用实时共享。 可取值为:enabled 、disabled 、unknownFutureValue 。 继承自 onlineMeetingBase。 |
allowMeetingChat | meetingChatMode | 指定会议聊天模式。 可能的值是:enabled 、disabled 、limited 、unknownFutureValue 。 继承自 onlineMeetingBase。 |
allowParticipantsToChangeName | 布尔值 | 指定是否允许参与者在会议实例中重命名自己。 |
allowPowerPointSharing | 布尔值 | 指示是否为会议启用 PowerPoint live。 继承自 onlineMeetingBase。 |
allowRecording | 布尔值 | 指示是否为会议启用录制。 继承自 onlineMeetingBase。 |
allowTeamworkReactions | 布尔值 | 指示是否为会议启用 Teams 反应。 继承自 onlineMeetingBase。 |
allowTranscription | 布尔值 | 指示是否为会议启用听录。 继承自 onlineMeetingBase。 |
allowWhiteboard | 布尔值 | 指示是否为会议启用白板。 继承自 onlineMeetingBase。 |
anonymizeIdentityForRoles | onlineMeetingRole 集合 | 指定谁的标识在会议中匿名。 可能的值为: attendee 。
attendee 添加后,无法通过 PATCH 操作删除该值。 继承自 onlineMeetingBase。 |
audioConferencing | audioConferencing | 电话访问 (拨入) 联机会议的信息。 只读。 继承自 onlineMeetingBase。 |
chatInfo | chatInfo | 与此联机会议关联的聊天信息。 继承自 onlineMeetingBase。 |
chatRestrictions | chatrestrictions | 指定会议聊天限制的配置。 |
creationDateTime | 日期时间 | 会议创建时间(UTC)。 只读。 |
endDateTime | 日期时间 | 会议结束时间(UTC)。 创建联机会议时需要。 |
externalId | String | 外部 ID。 自定义 ID。 可选。 |
id | String | 与联机会议关联的默认 ID。 只读。 继承自 onlineMeetingBase。 |
isEntryExitAnnounced | 布尔值 | 指示在调用方加入或离开时是报出。 继承自 onlineMeetingBase。 |
joinInformation | itemBody | 在“Accept-Language”请求 HTTP 标头中指定的语言和区域设置变体中的联接信息。 此为只读属性。 继承自 onlineMeetingBase。 |
joinMeetingIdSettings | joinMeetingIdSettings | 指定 joinMeetingId、会议密码和密码要求。 创建 onlineMeeting 后,无法修改 joinMeetingIdSettings 。 若要对此属性进行任何更改,需要取消会议,并需要创建一个新会议。 继承自 onlineMeetingBase。 |
joinWebUrl | String | 联机会议的加入 URL。 URL 的格式可能会更改;因此,用户不应依赖从分析 URL 中提取的任何信息。 只读。 继承自 onlineMeetingBase。 |
lobbyBypassSettings | lobbyBypassSettings | 指定哪些参与者可以绕过会议大厅。 继承自 onlineMeetingBase。 |
meetingTemplateId | String | 会议模板的 ID。 |
participants | meetingParticipants | 与联机会议关联的参与者,包括组织者和与会者。 |
recordAutomatically | 布尔值 | 指示是否自动录制会议。 继承自 onlineMeetingBase。 |
startDateTime | 日期时间 | 会议开始时间(UTC)。 创建联机会议时需要。 |
shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | 指定是否与参与者共享会议聊天历史记录。 可取值为:all 、none 、unknownFutureValue 。 继承自 onlineMeetingBase。 |
subject | String | 联机会议的主题。 继承自 onlineMeetingBase。 |
videoTeleconferenceId | String | 视频电话会议 ID。 只读。 继承自 onlineMeetingBase。 |
watermarkProtection | watermarkProtectionValues | 指定客户端应用程序是否应将水印应用于内容类型。 继承自 onlineMeetingBase。 |
alternativeRecording (已弃用) | Stream | Microsoft Teams 实时事件备用录制的内容流。 只读。 |
attendeeReport (已弃用) | Stream | Teams 实时事件的与会者报告的内容流。 只读。 |
autoAdmittedUsers (已弃用) | String | 指定自动允许加入联机会议的参与者类型的设置。 可取值为:everyone 、everyoneInSameAndFederatedCompany 、everyoneInCompany 、invitedUsersInCompany 、organizer 。 只读。 |
broadcastSettings (已弃用) | broadcastMeetingSettings | 与直播活动相关的设置。 |
功能 (弃用) | meetingCapabilities 集合 | 会议功能列表。 可能的值为: questionAndAnswer 、unknownFutureValue 。 |
isBroadcast (已弃用) | 布尔值 | 指示此事件是否为 Teams 实时事件。 |
录制 (已弃用) | Stream | Teams 实时事件录制的内容流。 只读。 |
警告
- autoAdmittedUsers 属性已弃用。 请改用 lobbyBypassSettings 的scope 属性。
- 已弃用 capabilities 属性。 请改用 broadcastMeetingSettings 的 isQuestionAndAnswerEnabled 属性。
meetingChatHistoryDefaultMode 值
值 | 说明 |
---|---|
全部 | 共享所有会议聊天历史记录。 |
无 | 不共享任何会议聊天历史记录。 |
unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
meetingChatMode 值
值 | 说明 |
---|---|
已启用 | 会议聊天已启用。 |
禁用 | 会议聊天已禁用。 |
有限 | 会议聊天已启用,但仅在会议通话期间启用。 |
unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
meetingLiveShareOptions 值
值 | 说明 |
---|---|
已启用 | 已启用会议实时共享。 |
禁用 | 会议实时共享已禁用。 |
unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
onlineMeetingPresenters 值
值 | 说明 |
---|---|
每个人 都 | 每个人都是演示者。 默认值。 |
组织 | 组织者组织中的每个人都是演示者。 |
roleIsPresenter | 只有角色为演示者的参与者是演示者。 |
组织者 | 只有组织者是演示者。 |
unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
提示
创建或更新将 allowedPresenters 设置为 roleIsPresenter
的联机会议时,请在请求正文中包含具有指定与会者角色设置为 presenter
的与会者的完整列表。
关系
关系 | 类型 | 说明 |
---|---|---|
attendanceReports | meetingAttendanceReport 集合 | 联机会议的出席情况报告。 此为只读属性。 继承自 onlineMeetingBase。 |
录音 | callRecording 集合 | 联机会议的录制。 只读。 |
成绩单 | callTranscript 集合 | 联机会议的脚本。 只读。 |
meetingAttendanceReport (已弃用) | meetingAttendanceReport | 最新在线会议会议的出席报告。 只读。 |
注册 (已弃用) | meetingRegistration | 为联机会议启用的注册。 一个联机会议只能启用一个注册。 |
提示
- meetingAttendanceReport 属性已弃用。 为了向后兼容,它将保持 beta 版。 今后,请使用 attendanceReports 属性检索联机会议的出席报告。
- 注册属性已弃用,将于 2024 年 12 月 12 日停止返回数据。 请使用新的 网络研讨会 API。 有关详细信息,请参阅 弃用 Microsoft Graph 会议注册 beta API。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"allowAttendeeToEnableCamera": "Boolean",
"allowAttendeeToEnableMic": "Boolean",
"allowBreakoutRooms": "Boolean",
"allowedPresenters": "String",
"allowLiveShare": "String",
"allowMeetingChat": "String",
"allowParticipantsToChangeName": "Boolean",
"allowPowerPointSharing": "Boolean",
"allowRecording": "Boolean",
"allowTeamworkReactions": "Boolean",
"allowTranscription": "Boolean",
"allowWhiteboard": "Boolean",
"anonymizeIdentityForRoles": ["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"},
"meetingTemplateId": "String",
"participants": {"@odata.type": "microsoft.graph.meetingParticipants"},
"recordAutomatically": "Boolean",
"shareMeetingChatHistoryDefault": "String",
"startDateTime": "String (timestamp)",
"subject": "String",
"videoTeleconferenceId": "String",
"watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"}
}