名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
会議に参加するために使用する URL、出席者リスト、説明など、会議に関する情報が含まれます。
このリソースは、 変更通知のサブスクライブをサポートします。 詳細については、「 オンライン会議のサブスクライブ」を参照してください。
onlineMeetingBase から継承します。
注意
Microsoft Teamsライブ イベントをサポートする Microsoft Graph オンライン会議 API は非推奨となり、2024 年 9 月 30 日にデータの返しが停止されます。 新しい Microsoft Graph API は、2025 年の春にこれらの API を置き換えます。 詳細については、「 Microsoft Graph での Teams ライブ イベント API の廃止」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | オンライン会議 | オンライン会議を作成します。 |
| Get | オンライン会議 | onlineMeeting オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | オンライン会議 | onlineMeeting オブジェクトのプロパティを更新します。 |
| 削除 | なし | onlineMeeting オブジェクトを削除します。 |
| 作成または取得 | オンライン会議 | カスタムの外部 ID を使用してオンライン会議を作成します。 会議が既に存在する場合は、そのプロパティを取得します。 |
| 記録を一覧表示する | callRecording コレクション | onlineMeeting に関連付けられている callRecording オブジェクトの一覧を取得します。 |
| トランスクリプトを一覧表示する | callTranscript コレクション | onlineMeeting のトランスクリプトの一覧を取得します。 |
注:
- 前の表に示したすべてのメソッドの
Authorizationヘッダーにはベアラー トークンが必要です。Authorizationヘッダーのtokenを取得する方法の詳細については、「ユーザーの代わりにアクセスを取得する」を参照してください。 - オンライン会議の有効期限は、会議の開始時刻または終了時刻の 60 日後に設定されます。 会議が期限切れになる前に更新またはアクティブ化された場合、有効期限はさらに 60 日延長されます。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| allowAttendeeToEnableCamera | ブール型 | 出席者がカメラをオンにできるかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowAttendeeToEnableMic | ブール型 | 出席者がマイクをオンにできるかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowBreakoutRooms | ブール型 | ブレークアウト ルームが会議に対して有効になっているかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowCopyingAndSharingMeetingContent | ブール型 | 会議のコンテンツのコピーと共有を有効にするかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowedLobbyAdmitters | allowedLobbyAdmitterRoles | ロビーから許可できるユーザーを指定します。 使用可能な値: organizerAndCoOrganizersAndPresenters、organizerAndCoOrganizers、unknownFutureValue。
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ライブが有効になっているかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowRecording | ブール型 | 会議の記録が有効かどうかを示します。 onlineMeetingBase から継承されます。 |
| allowTeamworkReactions | ブール型 | 会議で Teams の反応が有効になっているかどうかを示します。 onlineMeetingBase から継承されます。 |
| allowTranscription | ブール型 | 会議で文字起こしが有効かどうかを示します。 onlineMeetingBase から継承されます。 |
| allowWhiteboard | ブール型 | 会議でホワイトボードが有効かどうかを示します。 onlineMeetingBase から継承されます。 |
| anonymizeIdentityForRoles | onlineMeetingRole コレクション | 会議で匿名化される ID を指定します。 使用可能な値は、 attendeeです。
attendee値は、追加後の PATCH 操作では削除できません。
onlineMeetingBase から継承されます。 |
| audioConferencing | audioConferencing | オンライン会議の電話アクセス (ダイヤルイン) 情報。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| chatInfo | chatInfo | このオンライン会議に関連付けられているチャット情報。 onlineMeetingBase から継承されます。 |
| chatRestrictions | chatRestrictions | 会議チャット制限の構成設定を指定します。 onlineMeetingBase から継承されます。 |
| creationDateTime | DateTime | UTC での会議の作成時刻。 読み取り専用です。 |
| endDateTime | DateTime | 会議の終了時刻 (UTC)。 オンライン会議を作成するときに必要です。 |
| expiryDateTime | DateTimeOffset | 会議リソースの有効期限が切れる日時を示します。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
onlineMeetingBase から継承されます。 |
| 外部ID | 文字列 | カスタム識別子である外部 ID。 省略可能。 |
| id | 文字列 | オンライン会議に関連付けられている既定の ID。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| isEndToEndEncryptionEnabled | ブール型 | オンライン会議でエンドツーエンド暗号化 (E2EE) が有効かどうかを示します。 onlineMeetingBase から継承されます。 |
| isEntryExitAnnounced | ブール型 | 呼び出し元が参加または退出するときにアナウンスするかどうかを示します。 onlineMeetingBase から継承されます。 |
| joinInformation | itemBody | 'Accept-Language' 要求 HTTP ヘッダーで指定された言語とロケールバリアントの結合情報。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| joinMeetingIdSettings | joinMeetingIdSettings | joinMeetingId、会議パスコード、パスコードの要件を指定します。 onlineMeeting が作成されると、joinMeetingIdSettings は変更できません。 このプロパティを変更するには、会議をキャンセルし、新しい会議を作成する必要があります。 onlineMeetingBase から継承されます。 |
| joinWebUrl | 文字列 | オンライン会議の参加 URL。 URL の形式が変更される場合があります。そのため、ユーザーは URL の解析から抽出された情報に依存しないでください。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| lobbyBypassSettings | lobbyBypassSettings | 会議ロビーをバイパスできる参加者を指定します。 onlineMeetingBase から継承されます。 |
| meetingOptionsWebUrl | 文字列 | 指定した会議の [Teams 会議オプション] ページの URL を提供します。 このリンクでは 、開催者のみが会議設定 を構成できます。 onlineMeetingBase から継承されます。 |
| meetingSpokenLanguageTag | 文字列 | 会議中に記録および文字起こしのために使用される音声言語を指定します。 onlineMeetingBase から継承されます。 |
| meetingTemplateId | 文字列 | 会議テンプレートの ID。 |
| participants | meetingParticipants | 開催者と出席者を含む、オンライン会議に関連付けられた参加者。 |
| recordAutomatically | ブール型 | 会議を自動的に記録するかどうかを示します。 onlineMeetingBase から継承されます。 |
| sensitivityLabelAssignment | onlineMeetingSensitivityLabelAssignment | Teams 会議に適用される秘密度ラベルを指定します。 |
| startDateTime | DateTime | UTC での会議の開始時刻。 オンライン会議を作成するときに必要です。 |
| shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | 会議チャット履歴を参加者と共有するかどうかを指定します。 使用可能な値: all、none、unknownFutureValue。
onlineMeetingBase から継承されます。 |
| subject | 文字列 | オンライン会議の件名。 onlineMeetingBase から継承されます。 |
| videoTeleconferenceId | 文字列 | ビデオ電話会議 ID。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| watermarkProtection | watermarkProtectionValues | クライアント アプリケーションがコンテンツ タイプに透かしを適用するかどうかを指定します。 onlineMeetingBase から継承されます。 |
| alternativeRecording (非推奨) | Stream | Microsoft Teamsライブ イベントの代替記録のコンテンツ ストリーム。 読み取り専用です。 |
| attendeeReport (非推奨) | Stream | Teams ライブ イベントの出席者レポートのコンテンツ ストリーム。 読み取り専用です。 |
| autoAdmittedUsers (非推奨) | 文字列 | オンライン会議に自動的に許可される参加者の種類を指定する設定。 使用可能な値: everyone、everyoneInSameAndFederatedCompany、everyoneInCompany、invitedUsersInCompany、organizer。 読み取り専用です。 |
| broadcastSettings (非推奨) | broadcastMeetingSettings | ライブ イベントに関連する設定。 |
| 機能 (非推奨) | meetingCapabilities コレクション | 会議機能の一覧。 使用可能な値は、 questionAndAnswer、unknownFutureValueです。 |
| isBroadcast (非推奨) | ブール型 | このイベントが Teams ライブ イベントであるかどうかを示します。 |
| 記録 (非推奨) | Stream | Teams ライブ イベントの記録のコンテンツ ストリーム。 読み取り専用です。 |
注意
- autoAdmittedUsers プロパティは非推奨です。 代わりに、lobbyBypassSettings の scope プロパティを使用します。
- capabilities プロパティは非推奨です。 代わりに broadcastMeetingSettings の isQuestionAndAnswerEnabled プロパティを使用します。
meetingChatHistoryDefaultMode 値
| 値 | 説明 |
|---|---|
| すべて | すべての会議チャット履歴が共有されます。 |
| none | 会議チャットの履歴は共有されません。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
meetingChatMode 値
| 値 | 説明 |
|---|---|
| enabled | 会議チャットが有効になっています。 |
| 無効 | 会議チャットが無効になっています。 |
| 狹 | 会議チャットは有効ですが、会議通話中にのみ有効になります。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
meetingLiveShareOptions 値
| 値 | 説明 |
|---|---|
| enabled | 会議ライブ共有が有効になっています。 |
| 無効 | 会議ライブ共有が無効になっています。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
onlineMeetingPresenters 値
| 値 | 説明 |
|---|---|
| 皆さん | 全員が発表者です。 既定値。 |
| 組織 | 主催者のorganizationの全員が発表者です。 |
| roleIsPresenter | 発表者が役割を果たす参加者のみが発表者です。 |
| organizer | 発表者は主催者のみです。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
ヒント
allowedPresenters が roleIsPresenter に設定されているオンライン会議を作成または更新する場合は、指定した出席者のロールが要求本文にpresenterに設定されている出席者の完全な一覧を含めます。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| aiInsights | callAiInsight コレクション | オンライン会議用に生成された AI 分析情報。 読み取り専用です。 |
| attendanceReports | meetingAttendanceReport コレクション | オンライン会議の出席レポート。 読み取り専用です。 onlineMeetingBase から継承されます。 |
| 録音 | callRecording コレクション | オンライン会議の記録。 読み取り専用です。 |
| トラン スクリプト | callTranscript コレクション | オンライン会議のトランスクリプト。 読み取り専用です。 |
| meetingAttendanceReport (非推奨) | meetingAttendanceReport | 最新のオンライン会議セッションの出席レポート。 読み取り専用です。 |
| registration (非推奨) | meetingRegistration | オンライン会議で有効になっている登録。 1 つのオンライン会議で有効にできる登録は 1 つだけです。 |
ヒント
- meetingAttendanceReport プロパティは非推奨です。 下位互換性のためにベータ版のままです。 今後は、 attendanceReports プロパティを 使用して、オンライン会議の出席レポートを取得してください。
- registration プロパティは非推奨であり、2024 年 12 月 12 日にデータの返しを停止します。 新しい ウェビナー API を使用してください。 詳細については、「 Microsoft Graph 会議登録ベータ API の廃止」を参照してください。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"allowAttendeeToEnableCamera": "Boolean",
"allowAttendeeToEnableMic": "Boolean",
"allowBreakoutRooms": "Boolean",
"allowCopyingAndSharingMeetingContent": "Boolean",
"allowedLobbyAdmitters": "String",
"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"},
"chatRestrictions":{"@odata.type": "microsoft.graph.chatRestrictions"},
"creationDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"expiryDateTime": "String (timestamp)",
"externalId": "String",
"id": "String (identifier)",
"isEndToEndEncryptionEnabled": "Boolean",
"isEntryExitAnnounced": "Boolean",
"joinInformation": {"@odata.type": "microsoft.graph.itemBody"},
"joinMeetingIdSettings": {"@odata.type": "microsoft.graph.joinMeetingIdSettings"},
"joinWebUrl": "String",
"lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"},
"meetingOptionsWebUrl": "String",
"meetingSpokenLanguageTag": "String",
"meetingTemplateId": "String",
"sensitivityLabelAssignment": {
"@odata.type": "microsoft.graph.onlineMeetingSensitivityLabelAssignment"
},
"participants": {"@odata.type": "microsoft.graph.meetingParticipants"},
"recordAutomatically": "Boolean",
"shareMeetingChatHistoryDefault": "String",
"startDateTime": "String (timestamp)",
"subject": "String",
"videoTeleconferenceId": "String",
"watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"}
}