Créer virtualAppointment (déconseillé)

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Attention

La ressource virtualAppointment et les méthodes de prise en charge sont déconseillées et cesseront de retourner des données le 30 juin 2023. Nous vous recommandons de mettre à jour les applications existantes qui utilisent cette API afin d’utiliser la nouvelle fonction Obtenir le lien de jointure .

Créez un objet virtualAppointment .

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) OnlineMeetings.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Remarque

Les rendez-vous virtuels passent des autorisations de réunion en ligne à des autorisations de rendez-vous virtuel plus spécifiques pendant la période de préversion. Cela donnera aux développeurs un contrôle plus précis sur les autorisations de rendez-vous virtuels. Nous fournirons des détails supplémentaires sur le moment où les autorisations de réunion en ligne ne seront plus prises en charge avant la fin de la période de préversion.

Requête HTTP

PUT /me/onlineMeetings/{onlineMeetingId}/virtualAppointment
PUT /users/{userId}/onlineMeetings/{onlineMeetingId}/virtualAppointment

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, fournissez une représentation JSON de l’objet virtualAppointment .

Vous pouvez spécifier les propriétés suivantes lorsque vous créez un virtualAppointment.

Propriété Type Description
appointmentClients collection virtualAppointmentUser Informations client pour le rendez-vous virtuel, y compris le nom, l’e-mail et le numéro de téléphone SMS. Optional.
appointmentClientJoinWebUrl Chaîne URL web de jointure du rendez-vous virtuel pour les clients avec salle d’attente et jonction de navigateur. Optional.
externalAppointmentId Chaîne Identificateur du rendez-vous à partir du système de planification, associé au rendez-vous virtuel actuel. Optional.
externalAppointmentUrl Chaîne URL de la ressource de rendez-vous à partir du système de planification, associée au rendez-vous virtuel actuel. Optional.
paramètres virtualAppointmentSettings Paramètres associés à la ressource de rendez-vous virtuel. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet virtualAppointment dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

PUT https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi/virtualAppointment
Content-Type: application/json
ETag: W/"ZfYdV7Meckeip07P//nwjAAADyI7NQ=="
Content-length: 379

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA="
}

Réponse

L’exemple suivant illustre la réponse.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "id": "0c7fda79-ff00-f57f-37e3-28183b6d09b5",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA=",
    "appointmentClientJoinWebUrl": "https://visit.teams.microsoft.com/webrtc-svc/api/route?tid=a796be92-&convId=19:meeting_=True"
}