更新 onlineMeeting
本文内容
命名空间:microsoft.graph
更新指定的 onlineMeeting 对象的属性。
有关支持更新的属性列表,请参阅 请求正文 部分。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
❌
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型 。 要了解有关这些权限的详细信息,请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派(工作或学校帐户)
OnlineMeetings.ReadWrite
不可用。
委派(个人 Microsoft 帐户)
不支持。
不支持。
应用程序
不支持。
不支持。
若要使用此 API 的应用程序权限,租户管理员必须创建 一个应用程序访问策略 ,并将其授予用户授权策略中配置的应用,以代表该用户更新联机会议, (请求路径) 中指定的用户 ID。
HTTP 请求
使用具有委派 () 和应用 /users/{userId}/
(/me
) 权限的会议 ID 更新指定的 onlineMeeting :
PATCH /me/onlineMeetings/{meetingId}
PATCH /users/{userId}/onlineMeetings/{meetingId}
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
Content-type
application/json. 必需。
请求正文
下表列出了可更新的属性。 在请求正文中,仅包括需要更新的属性,但有以下例外:
调整联机会议的开始或结束日期/时间始终需要请求正文中的 startDateTime 和 endDateTime 属性。
不能更新参与者 属性的组织者 字段。 创建会议后,无法修改会议组织者。
调整“参与者 ”属性的“与会者 ”字段(例如向会议添加或删除与会者),始终需要请求正文中的与会者的完整列表。
最后一列指示更新此属性是否对正在进行的会议生效。
属性
类型
说明
适用于正在进行的会议?
startDateTime
日期时间
会议开始时间(UTC)。
否
endDateTime
日期时间
会议结束时间(UTC)。
否
subject
String
联机会议的主题。
否
participants
meetingParticipants
与联机会议关联的参与者。 只能更新与会者。
否
isEntryExitAnnounced
布尔值
呼叫者加入或离开时是否报出。
是
lobbyBypassSettings
lobbyBypassSettings
指定哪些参与者可以绕过会议大厅。
是
allowedPresenters
onlineMeetingPresenters
指定谁可以成为会议中的演示者。
是
allowAttendeeToEnableCamera
布尔值
指示与会者是否可以打开其相机。
是
allowAttendeeToEnableMic
布尔值
指示与会者是否可以打开其麦克风。
是
allowMeetingChat
meetingChatMode
指定会议聊天模式。
是
allowTeamworkReactions
布尔值
指示是否为会议启用 Teams 反应。
是
recordAutomatically
布尔值
指示是否自动录制会议。
否
注意
有关 allowedPresenters 和 allowMeetingChat 的可能值列表,请参阅 onlineMeeting 。
将 allowedPresenters 的值更新为 roleIsPresenter
时,请在请求正文中包含指定与会者角色 设置为 presenter
的与会者的完整列表。
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和更新的 onlineMeeting 对象。
示例
示例 1:更新 startDateTime、endDateTime 和主题
请求
注意: 会议 ID 已缩短,以提高可读性。
PATCH https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"startDateTime": "2020-09-09T14:33:30.8546353-07:00",
"endDateTime": "2020-09-09T15:03:30.8566356-07:00",
"subject": "Patch Meeting Subject"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OnlineMeeting
{
StartDateTime = DateTimeOffset.Parse("2020-09-09T14:33:30.8546353-07:00"),
EndDateTime = DateTimeOffset.Parse("2020-09-09T15:03:30.8566356-07:00"),
Subject = "Patch Meeting Subject",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.OnlineMeetings["{onlineMeeting-id}"].PatchAsync(requestBody);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users online-meetings patch --user-id {user-id} --online-meeting-id {onlineMeeting-id} --body '{\
"startDateTime": "2020-09-09T14:33:30.8546353-07:00",\
"endDateTime": "2020-09-09T15:03:30.8566356-07:00",\
"subject": "Patch Meeting Subject"\
}\
'
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
import (
"context"
"time"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewOnlineMeeting()
startDateTime , err := time.Parse(time.RFC3339, "2020-09-09T14:33:30.8546353-07:00")
requestBody.SetStartDateTime(&startDateTime)
endDateTime , err := time.Parse(time.RFC3339, "2020-09-09T15:03:30.8566356-07:00")
requestBody.SetEndDateTime(&endDateTime)
subject := "Patch Meeting Subject"
requestBody.SetSubject(&subject)
onlineMeetings, err := graphClient.Me().OnlineMeetings().ByOnlineMeetingId("onlineMeeting-id").Patch(context.Background(), requestBody, nil)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OnlineMeeting onlineMeeting = new OnlineMeeting();
OffsetDateTime startDateTime = OffsetDateTime.parse("2020-09-09T14:33:30.8546353-07:00");
onlineMeeting.setStartDateTime(startDateTime);
OffsetDateTime endDateTime = OffsetDateTime.parse("2020-09-09T15:03:30.8566356-07:00");
onlineMeeting.setEndDateTime(endDateTime);
onlineMeeting.setSubject("Patch Meeting Subject");
OnlineMeeting result = graphClient.me().onlineMeetings().byOnlineMeetingId("{onlineMeeting-id}").patch(onlineMeeting);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
const onlineMeeting = {
startDateTime: '2020-09-09T14:33:30.8546353-07:00',
endDateTime: '2020-09-09T15:03:30.8566356-07:00',
subject: 'Patch Meeting Subject'
};
await client.api('/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi')
.update(onlineMeeting);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OnlineMeeting;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OnlineMeeting();
$requestBody->setStartDateTime(new \DateTime('2020-09-09T14:33:30.8546353-07:00'));
$requestBody->setEndDateTime(new \DateTime('2020-09-09T15:03:30.8566356-07:00'));
$requestBody->setSubject('Patch Meeting Subject');
$result = $graphServiceClient->me()->onlineMeetings()->byOnlineMeetingId('onlineMeeting-id')->patch($requestBody)->wait();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.CloudCommunications
$params = @{
startDateTime = [System.DateTime]::Parse("2020-09-09T14:33:30.8546353-07:00")
endDateTime = [System.DateTime]::Parse("2020-09-09T15:03:30.8566356-07:00")
subject = "Patch Meeting Subject"
}
# A UPN can also be used as -UserId.
Update-MgUserOnlineMeeting -UserId $userId -OnlineMeetingId $onlineMeetingId -BodyParameter $params
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
from msgraph import GraphServiceClient
from msgraph.generated.models.online_meeting import OnlineMeeting
graph_client = GraphServiceClient(credentials, scopes)
request_body = OnlineMeeting(
start_date_time = "2020-09-09T14:33:30.8546353-07:00",
end_date_time = "2020-09-09T15:03:30.8566356-07:00",
subject = "Patch Meeting Subject",
)
result = await graph_client.me.online_meetings.by_online_meeting_id('onlineMeeting-id').patch(request_body)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
响应
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id":"MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"url",
"subject":"Patch Meeting Subject",
"isBroadcast":false,
"autoAdmittedUsers":"EveryoneInCompany",
"outerMeetingAutoAdmittedUsers":null,
"participants":{
"organizer":{
"upn":"upn",
"role": "presenter",
"identity":{
"azureApplicationInstance":null,
"applicationInstance":null,
"application":null,
"device":null,
"user":{
"id":"8716745d-77a9-4be3-afff-009e4b81658e",
"displayName":null,
"tenantId":"0823831b-1f1b-424b-b90a-1caa345a742a",
"identityProvider":"AAD"
}
}
}
},
"audioConferencing":{
"conferenceId":"id",
"tollNumber":"+1-900-555-0100",
"tollFreeNumber":"+1-800-555-0100",
"dialinUrl":"url"
}
}
示例 2:更新 lobbyBypassSettings
注意: 会议 ID 已缩短,以提高可读性。
PATCH https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"lobbyBypassSettings": {
"isDialInBypassEnabled": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OnlineMeeting
{
LobbyBypassSettings = new LobbyBypassSettings
{
IsDialInBypassEnabled = true,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.OnlineMeetings["{onlineMeeting-id}"].PatchAsync(requestBody);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users online-meetings patch --user-id {user-id} --online-meeting-id {onlineMeeting-id} --body '{\
"lobbyBypassSettings": {\
"isDialInBypassEnabled": true\
}\
}\
'
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewOnlineMeeting()
lobbyBypassSettings := graphmodels.NewLobbyBypassSettings()
isDialInBypassEnabled := true
lobbyBypassSettings.SetIsDialInBypassEnabled(&isDialInBypassEnabled)
requestBody.SetLobbyBypassSettings(lobbyBypassSettings)
onlineMeetings, err := graphClient.Me().OnlineMeetings().ByOnlineMeetingId("onlineMeeting-id").Patch(context.Background(), requestBody, nil)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OnlineMeeting onlineMeeting = new OnlineMeeting();
LobbyBypassSettings lobbyBypassSettings = new LobbyBypassSettings();
lobbyBypassSettings.setIsDialInBypassEnabled(true);
onlineMeeting.setLobbyBypassSettings(lobbyBypassSettings);
OnlineMeeting result = graphClient.me().onlineMeetings().byOnlineMeetingId("{onlineMeeting-id}").patch(onlineMeeting);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
const onlineMeeting = {
lobbyBypassSettings: {
isDialInBypassEnabled: true
}
};
await client.api('/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi')
.update(onlineMeeting);
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OnlineMeeting;
use Microsoft\Graph\Generated\Models\LobbyBypassSettings;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OnlineMeeting();
$lobbyBypassSettings = new LobbyBypassSettings();
$lobbyBypassSettings->setIsDialInBypassEnabled(true);
$requestBody->setLobbyBypassSettings($lobbyBypassSettings);
$result = $graphServiceClient->me()->onlineMeetings()->byOnlineMeetingId('onlineMeeting-id')->patch($requestBody)->wait();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.CloudCommunications
$params = @{
lobbyBypassSettings = @{
isDialInBypassEnabled = $true
}
}
# A UPN can also be used as -UserId.
Update-MgUserOnlineMeeting -UserId $userId -OnlineMeetingId $onlineMeetingId -BodyParameter $params
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
from msgraph import GraphServiceClient
from msgraph.generated.models.online_meeting import OnlineMeeting
from msgraph.generated.models.lobby_bypass_settings import LobbyBypassSettings
graph_client = GraphServiceClient(credentials, scopes)
request_body = OnlineMeeting(
lobby_bypass_settings = LobbyBypassSettings(
is_dial_in_bypass_enabled = True,
),
)
result = await graph_client.me.online_meetings.by_online_meeting_id('onlineMeeting-id').patch(request_body)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
响应
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"(redacted)",
"subject":"Patch Meeting Subject",
"autoAdmittedUsers": "EveryoneInCompany",
"isEntryExitAnnounced": true,
"allowedPresenters": "everyone",
"videoTeleconferenceId": "(redacted)",
"participants": {
"organizer": {
"upn": "(redacted)",
"role": "presenter",
"identity": {
"user": {
"id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622",
"displayName": null,
"tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38",
"identityProvider": "AAD"
}
}
},
"attendees": [],
},
"lobbyBypassSettings": {
"scope": "organization",
"isDialInBypassEnabled": true
}
}