virtualAppointment: getVirtualAppointmentJoinWebUrl

Namespace: microsoft.graph

Get a join web URL for a Microsoft Virtual Appointments. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics.

This API is supported in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) VirtualAppointment.Read, VirtualAppointment.ReadWrite
Delegated (personal Microsoft account) Not supported.
Application VirtualAppointment.Read.All, VirtualAppointment.ReadWrite.All

HTTP request

GET /me/onlineMeetings/{onlineMeetingId}/getVirtualAppointmentJoinWebUrl
GET /users/{userId}/onlineMeetings/{onlineMeetingId}/getVirtualAppointmentJoinWebUrl

Request headers

Name Description
Authorization Bearer {token}. Required.
Accept-Language Language. Optional.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and a String in the response body. The value property represents the join web URL for Microsoft Virtual Appointments.



The following is an example of a request.



The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

  "@odata.context": "$metadata#Edm.String",
  "value": ""