Partager via


onlineMeeting : createOrGet

Espace de noms: microsoft.graph

Créez un objet onlineMeeting avec un ID externe spécifié personnalisé. Si l’ID externe existe déjà, cette API retourne l’objet onlineMeeting avec cet ID externe.

Remarque: la réunion ne s’affiche pas dans le calendrier de l’utilisateur.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

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.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) OnlineMeetings.ReadWrite
Déléguée (compte Microsoft personnel) Non prise en charge.
Application OnlineMeetings.ReadWrite.All*

Importante

* Les administrateurs doivent créer une stratégie d’accès à l’application 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 l’ID externe pour le compte de cet utilisateur (ID utilisateur spécifié dans le chemin de la demande).

Requête HTTP

Pour appeler l’API createOrGet avec un jeton délégué :

POST /me/onlineMeetings/createOrGet

Pour appeler l’API createOrGet avec un jeton d’application :

POST /users/{userId}/onlineMeetings/createOrGet

Remarque

userId est l’ID d’objet d’un utilisateur dans centre d'administration Microsoft Entra > page de gestion des utilisateurs. Pour plus d’informations, voir de stratégie d’accès aux applications.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
endDateTime DateTime Heure de fin de la réunion au format UTC.
externalId Chaîne ID externe. ID personnalisé. (Obligatoire)
participants meetingParticipants Participants associés à la réunion en ligne. Cela inclut l’organisateur et les participants.
startDateTime DateTime Heure de début de la réunion au format UTC.
subject Chaîne Objet de la réunion en ligne.

Remarques :

  • Si les valeurs startDateTime et endDateTime ne sont pas fournies, startDateTime est définie par défaut sur la valeur dateTime actuelle et la valeur endDateTime est égale à startDateTime + 1 heure.
  • Si la valeur startDateTime est fournie, mais que endDateTime ne l’est pas, la valeur endDateTime est égale à startDateTime + 1 heure.
  • Une erreur est générée si endDateTime est fourni sans startDateTime ou si endDateTime est antérieur à startDateTime.
  • Lorsque plusieurs utilisateurs du même locataire utilisent le même externalId pour exécuter cette requête, différentes instances de réunion sont générées, chacune avec son propre ID unique. La combinaison de tenantId, userId et externalId sert d’identificateur pour une réunion avec un ID externe.

Réponse

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. Dans les deux cas, un objet onlineMeeting est retourné dans le corps de la réponse.

Exemples

Demande

L’exemple suivant montre comment créer ou obtenir une réunion en ligne avec un ID externe.

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

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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