Get virtualEventSession

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Read the properties and relationships of a virtualEventSession object.

Currently, the following virtual event types are supported: virtualEventTownhall and virtualEventWebinar.

This API is available in the following national cloud deployments.

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

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) VirtualEvent.Read VirtualEvent.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application VirtualEvent.Read.All Not available.

Note

To use application permissions for this API, tenant administrators must create an application access policy and assign it to a user. This allows the authorized application to access registrants' information from virtual events created by that specific user.

HTTP request

To get a session of a webinar:

GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}

To get a session of a town hall:

GET /solutions/virtualEvents/townhalls/{townhallId}/sessions/{sessionId}

Optional query parameters

This method doesn't support the OData query parameters. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a virtualEventSession object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd/sessions/8d62dd52-4dff-4c75-96a9-f905cc3ff942

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "value": {
    "@odata.type": "#microsoft.graph.virtualEventSession",
    "id": "8d62dd52-4dff-4c75-96a9-f905cc3ff942",
    "startDateTime": "2023-08-08T12:30:00Z",
    "endDateTime": "2023-08-09T22:00:00Z",
    "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_ZDVjNzk3OWEtYjc2NS00NTA1LTkyMzQtYTYzMGI5YmFmMjM5%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%221cd068e4-5b08-4e75-a7f9-7b4e067a0820%22%7d",
    "subject": "Session one",
    "participants": {
      "@odata.type": "microsoft.graph.meetingParticipants"
    },
    "isBroadcast": null,
    "broadcastSettings": null,
    "capabilities": [],
    "audioConferencing": null,
    "chatInfo": {
      "threadId": "19:meeting_ZDVjNzk3OWEtYjc2NS00NTA1LTkyMzQtYTYzMGI5YmFmMjM5@thread.v2",
      "messageId": "0",
      "replyChainMessageId": null
    },
    "videoTeleconferenceId": null,
    "externalId": null,
    "joinMeetingIdSettings": null,
    "lobbyBypassSettings": null,
    "isEntryExitAnnounced": null,
    "allowedPresenters": null,
    "allowAttendeeToEnableMic": null,
    "allowAttendeeToEnableCamera": null,
    "allowMeetingChat": null,
    "shareMeetingChatHistoryDefault": null,
    "allowTeamworkReactions": null,
    "recordAutomatically": null,
    "watermarkProtection": null,
    "allowParticipantsToChangeName": null
  }
}