Поделиться через


onlineMeeting: createOrGet

Пространство имен: microsoft.graph

Создайте объект onlineMeeting с пользовательским указанным внешним идентификатором. Если внешний идентификатор уже существует, этот API вернет объект onlineMeeting с этим внешним идентификатором.

Примечание. Собрание не отображается в календаре пользователя.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись) OnlineMeetings.ReadWrite
Делегированные (личная учетная запись Майкрософт) Не поддерживается.
Для приложений OnlineMeetings.ReadWrite.All*

Важно!

* Администраторы должны создать политику доступа к приложениям и предоставить ее пользователю, авторизуя приложение, настроенное в политике для создания или получения собрания по сети с внешним идентификатором от имени этого пользователя (идентификатор пользователя, указанный в пути запроса).

HTTP-запрос

Чтобы вызвать API createOrGet с делегированным маркером, выполните следующие действия:

POST /me/onlineMeetings/createOrGet

Чтобы вызвать API createOrGet с маркером приложения, выполните следующие действия:

POST /users/{userId}/onlineMeetings/createOrGet

Примечание.

userId — это идентификатор объекта пользователя на странице управления пользователями Центр администрирования Microsoft Entra>. Дополнительные сведения см. в статье Политики доступа для приложений.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр Тип Описание
endDateTime DateTime Время окончания собрания в формате UTC.
externalId String Внешний идентификатор. Настраиваемый идентификатор. (Обязательный)
participants meetingParticipants Участники, связанные с собранием по сети. Сюда входят организатор и участники.
startDateTime DateTime Время начала собрания в формате UTC.
subject String Тема онлайн-собрания.

Примечания.

  • Если значения startDateTime и endDateTime не указаны, значение startDateTime по умолчанию будет иметь текущее значение dateTime, а значение endDateTime будет равно startDateTime + 1 час.
  • Если параметр startDateTime указан, а endDateTime — нет, значение endDateTime будет равно startDateTime + 1 час.
  • Ошибка возникает, если endDateTime предоставляется без startDateTime или endDateTime раньше startDateTime.
  • Если несколько пользователей в одном клиенте используют один и тот же внешний идентификатор для выполнения этого запроса, создаются разные экземпляры собраний, каждый с собственным уникальным идентификатором. Сочетание идентификаторов tenantId, userId и externalId служит идентификатором для собрания с внешним идентификатором.

Отклик

В случае успешного 201 Created выполнения этот метод возвращает код ответа при создании нового собрания или 200 OK код ответа, если извлекается существующее собрание. В обоих случаях объект onlineMeeting возвращается в тексте ответа.

Примеры

Запрос

В следующем примере показано, как создать или получить собрание по сети с внешним идентификатором.

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
    },
}