onlineMeeting: createOrGet

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein onlineMeeting-Objekt mit einer benutzerdefinierten angegebenen externen ID. Wenn die externe ID bereits vorhanden ist, gibt diese API das onlineMeeting-Objekt mit dieser externen ID zurück.

Hinweis: Die Besprechung wird im Kalender des Benutzers nicht angezeigt.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) OnlineMeetings.ReadWrite
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt.
Anwendung OnlineMeetings.ReadWrite.All*

Wichtig

* Administratoren müssen eine Anwendungszugriffsrichtlinie erstellen und sie einem Benutzer gewähren, wobei die in der Richtlinie konfigurierte App autorisiert wird, eine Onlinebesprechung mit externer ID im Namen dieses Benutzers zu erstellen oder abzurufen (Benutzer-ID, die im Anforderungspfad angegeben ist).

HTTP-Anforderung

So rufen Sie die createOrGet-API mit delegiertem Token auf:

POST /me/onlineMeetings/createOrGet

So rufen Sie die createOrGet-API mit Anwendungstoken auf:

POST /users/{userId}/onlineMeetings/createOrGet

Hinweis

userId ist die Objekt-ID eines Benutzers auf Microsoft Entra Admin Center > Benutzerverwaltungsseite. Weitere Details finden Sie unter Richtlinie für den Anwendungszugriff.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter Typ Beschreibung
chatInfo chatInfo Die Chatinformationen, die dieser Onlinebesprechung zugeordnet sind.
endDateTime DateTime Die Endzeit der Besprechung in UTC.
externalId Zeichenfolge Die externe ID. Eine benutzerdefinierte ID. (Erforderlich)
participants meetingParticipants Die Teilnehmer, die der Onlinebesprechung zugeordnet sind. Dies schließt den Organisator und die Teilnehmer ein.
startDateTime DateTime Die Startzeit der Besprechung in UTC.
subject Zeichenfolge Das Thema der Onlinebesprechung.

Hinweise:

  • Wenn startDateTime und endDateTime nicht angegeben werden, wird startDateTime standardmäßig auf den aktuellen dateTime-Wert und endDateTime-Wert entspricht startDateTime + 1 Stunde.
  • Wenn startDateTime angegeben wird, endDateTime jedoch nicht, entspricht der endDateTime-WertstartDateTime + 1 Stunde.
  • Ein Fehler wird ausgelöst, wenn endDateTime ohne startDateTime angegeben wird oder wenn endDateTime vor dem startDateTime-Wert liegt.
  • Derzeit wird chatInfo nur in der Beta unterstützt.
  • Wenn mehrere Benutzer innerhalb desselben Mandanten dieselbe externalId verwenden, um diese Abfrage auszuführen, werden unterschiedliche Besprechungsinstanzen mit jeweils eigener eindeutiger ID generiert. Die Kombination aus tenantId, userId und externalId dient als Bezeichner für eine Besprechung mit einer externen ID.

Antwort

Bei erfolgreicher Ausführung gibt die Methode einen 201 Created Antwortcode zurück, wenn eine neue Besprechung erstellt wird, oder einen 200 OK Antwortcode, wenn eine vorhandene Besprechung abgerufen wird. In beiden Fällen wird ein onlineMeeting-Objekt im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Erstellen oder Abrufen einer Onlinebesprechung mit einer externen ID

Anforderung

POST https://graph.microsoft.com/beta/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"
                    }
                },
                "role": "presenter",
                "upn": "test1@contoso.com"
            }
        ]
    }
}

Antwort

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

Beispiel 2: Erstellen oder Abrufen einer Onlinebesprechung in einem Microsoft Teams-Kanal mit einer externen ID

Anforderung

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

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

Antwort

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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": "1599805818399",
        "replyChainMessageId": null
    },
}