onlineMeeting：createOrGet

  • 项目

命名空间：microsoft.graph

使用自定义指定的外部 ID 创建 onlineMeeting 对象。 如果外部 ID 已存在，则此 API 将返回具有该外部 ID 的 onlineMeeting 对象。

注释：会议不会显示在用户的日历上。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ❌

权限

要调用此 API，需要以下权限之一。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型 权限（从最低特权到最高特权）
委派（工作或学校帐户） OnlineMeetings.ReadWrite
委派（个人 Microsoft 帐户） 不支持。
应用程序 OnlineMeetings.ReadWrite.All*

重要

* 管理员必须创建 应用程序访问策略 并将其授予用户，授权策略中配置的应用代表该用户创建或获取具有外部 ID 的联机会议， (请求路径) 中指定的用户 ID。

HTTP 请求

若要使用委托的令牌调用 createOrGet API，请执行以下操作：

POST /me/onlineMeetings/createOrGet

若要使用应用程序令牌调用 createOrGet API，请执行以下操作：

POST /users/{userId}/onlineMeetings/createOrGet

注意

userId 是用户管理页Microsoft Entra 管理中心>用户的对象 ID。 有关详细信息，请参阅应用程序访问策略。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-type application/json. 必需。

请求正文

在请求正文中，提供具有以下参数的 JSON 对象。

参数 类型 说明
endDateTime 日期时间 会议结束时间（UTC）。
externalId String 外部 ID。 自定义 ID。 (必需)
participants meetingParticipants 与联机会议关联的参与者。 这包括组织者和与会者。
startDateTime 日期时间 会议开始时间（UTC）。
subject String 联机会议的主题。

注意：

  • 如果未提供 startDateTime 和 endDateTime ， 则 startDateTime 将默认为当前 dateTime 值， endDateTime 值将等于 startDateTime + 1 小时。
  • 如果提供了 startDateTime ，但 endDateTime 不是， 则 endDateTime 值将等于 startDateTime + 1 小时。
  • 如果提供的 endDateTime 没有 startDateTime，或者 endDateTime 早于 startDateTime，则会引发错误。
  • 当同一租户中的多个用户使用相同的 externalId 运行此查询时，将生成不同的会议实例，每个实例都有自己的唯一 ID。 tenantId、userId 和 externalId 的组合用作具有外部 ID 的会议标识符。

响应

如果成功，此方法在 201 Created 创建新会议时返回响应代码，如果检索到现有会议， 200 OK 则返回响应代码。 在这两种情况下，响应正文中都返回 一个 onlineMeeting 对象。

示例

请求

以下示例演示如何创建或获取具有外部 ID 的联机会议。

POST https://graph.microsoft.com/v1.0/me/onlineMeetings/createOrGet
Content-Type: application/json

{
    "startDateTime": "2020-02-06T01:49:21.3524945+00:00",
    "endDateTime": "2020-02-06T02:19:21.3524945+00:00",
    "subject": "Create a meeting with customId provided",
    "externalId": "7eb8263f-d0e0-4149-bb1c-1f0476083c56",
    "participants": {
        "attendees": [
            {
                "identity": {
                    "user": {
                        "id": "1f35f2e6-9cab-44ad-8d5a-b74c14720000"
                    }
                },
                "upn": "test1@contoso.com"
            }
        ]
    }
}

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "(redacted)",
    "creationDateTime": "2020-09-11T06:30:18.1909168Z",
    "startDateTime": "2020-09-11T06:30:18.0615989Z",
    "endDateTime": "2020-09-11T07:30:18.0615989Z",
    "joinWebUrl": "(redacted)",
    "subject": "Create a meeting with customId provided",
    "isBroadcast": false,
    "autoAdmittedUsers": "EveryoneInCompany",
    "isEntryExitAnnounced": true,
    "allowedPresenters": "everyone",
    "videoTeleconferenceId": "(redacted)",
    "externalId": "7eb8263f-d0e0-4149-bb1c-1f0476083c56",
    "participants": {
        "organizer": {
            "upn": "(redacted)",
            "role": "presenter",
            "identity": {
                "user": {
                    "id": "(redacted)",
                }
            }
        },
        "attendees": [
            {
                "upn": "test1@contoso.com",
                "role": null,
                "identity": {
                    "user": {
                        "id": "1f35f2e6-9cab-44ad-8d5a-b74c14720000",
                    }
                }
            }
        ],
        "producers": [],
        "contributors": []
    },
    "lobbyBypassSettings": {
        "scope": "organization",
        "isDialInBypassEnabled": false
    },
    "audioConferencing": {
        "conferenceId": "(redacted)",
        "tollNumber": "+1 206-485-3005",
        "tollFreeNumber": null,
        "dialinUrl": "https://dialin.teams.microsoft.com/0e73a853-1cc2-436c-b18c-9f53e0a97c24?id=(redacted)"
    },
    "chatInfo": {
        "threadId": "19:7ebda77322dd4505ac4dedb5b67df076@thread.tacv2",
        "messageId": "0",
        "replyChainMessageId": null
    },
}