onlineMeeting: createOrGetonlineMeeting: createOrGet

Espace de noms: microsoft.graphNamespace: microsoft.graph

Important

Les API sous la /beta version de Microsoft Graph peuvent faire l’objet de modifications.APIs under the /beta version in Microsoft Graph are subject to change. L’utilisation de ces API dans des applications de production n’est pas prise en charge.Use of these APIs in production applications is not supported. Pour déterminer si une API est disponible dans la version 1.0, utilisez le sélecteur de version .To determine whether an API is available in v1.0, use the Version selector.

Créer un objet onlineMeeting avec un ID externe spécifié personnalisé.Create an onlineMeeting object with a custom specified external ID. Si l’ID externe existe déjà, cette API renverra l’objet onlineMeeting avec cet ID externe.If the external ID already exists, this API will return the onlineMeeting object with that external ID.

Remarque: la réunion ne s’affiche pas dans le calendrier de l’utilisateur.Note: The meeting does not show on the user's calendar.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) OnlineMeetings.ReadWriteOnlineMeetings.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Non pris en charge.Not Supported.
ApplicationApplication OnlineMeetings.ReadWrite.All*OnlineMeetings.ReadWrite.All*

Important

* Les administrateurs doivent créer une stratégie d’accès aux applications et l’accorder à un utilisateur en autorisant l’application configurée dans la stratégie à créer ou obtenir une réunion en ligne avec un ID externe au nom de cet utilisateur (ID d’utilisateur spécifié dans le chemin d’accès de la demande).* Administrators must create an application access policy and grant it to a user, authorizing the app configured in the policy to create or get an online meeting with external ID on behalf of that user (user ID specified in the request path).

Requête HTTPHTTP request

Demandez lorsque vous utilisez un jeton délégué :Request when using a delegated token:

POST /me/onlineMeetings/createOrGet

Demandez lorsque vous utilisez un jeton d’application :Request when using an application token:

POST /users/{userId}/onlineMeetings/createOrGet

Remarque : userId est l’ID d’objet d’un utilisateur dans portail de gestion des utilisateurs Azure.Note: userId is the object ID of a user in Azure user management portal. Pour plus d’informations, voir de stratégie d’accès aux applications.See more details in application access policy.

En-têtes de demandeRequest headers

NomName DescriptionDescription
AutorisationAuthorization Porteur {token}. Obligatoire.Bearer {token}. Required.
Content-typeContent-type application/json. Obligatoire.application/json. Required.

Corps de la demandeRequest body

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.In the request body, provide a JSON object with the following parameters.

ParamètreParameter TypeType DescriptionDescription
chatInfochatInfo chatInfochatInfo Informations de conversation associées à cette réunion en ligne.The chat information associated with this online meeting.
endDateTimeendDateTime Date/heureDateTime Heure de fin de la réunion en UTC.The meeting end time in UTC.
externalIdexternalId StringString ID externe.The external ID. ID personnalisé.A custom ID. Exige(Required)
participantsparticipants meetingParticipantsmeetingParticipants Participants associés à la réunion en ligne.The participants associated with the online meeting. Cela inclut l’organisateur et les participants.This includes the organizer and the attendees.
startDateTimestartDateTime Date/heureDateTime Heure de début de la réunion en UTC.The meeting start time in UTC.
subjectsubject StringString Objet de la réunion en ligne.The subject of the online meeting.

Remarques :Notes:

  • Si les startDateTime et endDateTime ne sont pas fournis, la valeur de la propriété startDateTime est définie par défaut sur la valeur DateTime actuelle et la valeur endDateTime est égale à la startDateTime + 1 heure.If the startDateTime and endDateTime are not provided, the startDateTime will default to the current dateTime value and endDateTime value will equal the startDateTime + 1 hour.

  • Si le startDateTime est fourni, mais que endDateTime ne l’est pas, la valeur EndDateTime est égale à l' startDateTime + 1 heure.If the startDateTime is provided, but endDateTime is not, the endDateTime value will equal the startDateTime + 1 hour.

  • Une erreur est générée si endDateTime est fourni sans startDateTime ou si l' EndDateTime est antérieure à l' startDateTime.An error will be thrown if the endDateTime is provided without the startDateTime or if the endDateTime is earlier than the startDateTime.

  • Actuellement chatInfo est uniquement pris en charge dans la version bêta.Currently chatInfo is only supported in beta.

RéponseResponse

Si elle réussit, cette méthode renvoie un 201 Created Code de réponse si une nouvelle réunion est créée ou un 200 OK Code de réponse si une réunion existante est récupérée.If successful, this method returns a 201 Created response code if a new meeting is created, or a 200 OK response code if an existing meeting is retrieved. Dans les deux cas, un objet onlineMeeting est renvoyé dans le corps de la réponse.In both cases, an onlineMeeting object is returned in the response body.

範例Examples

Exemple 1 : créer ou obtenir une réunion en ligne avec un ID externeExample 1: Create or get an online meeting with an external ID

DemandeRequest

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"
            }
        ]
    }
}

RéponseResponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.Note: The response object shown here might be shortened for readability.

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

Exemple 2 : créer ou obtenir une réunion en ligne dans un canal Microsoft teams avec un ID externeExample 2: Create or get an online meeting in a Microsoft Teams channel with an external ID

DemandeRequest

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

RéponseResponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.Note: The response object shown here might be shortened for readability.

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