title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
List sessions for a virtual event |
Get a list of all virtualEventSession objects under a virtual event. |
awang119 |
medium |
cloud-communications |
apiPageType |
Namespace: microsoft.graph
Get a list of all virtualEventSession summary objects under a virtual event. A session summary contains only the endDateTime
, id
, joinWebUrl
, startDateTime
, and subject
of a virtual event session. The rest of session properties will be null.
Currently, the following virtual event types are supported:
[!INCLUDE national-cloud-support]
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.
[!INCLUDE permissions-table]
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.
To list all sessions of a webinar:
GET /solutions/virtualEvents/webinars/{webinarId}/sessions
To list all sessions of a town hall:
GET /solutions/virtualEvents/townhalls/{townhallId}/sessions
This method doesn't support the OData query parameters. For general information, see OData query parameters.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and a collection of virtualEventSession objects in the response body.
Currently, only the following properties of a virtualEventSession object contain data when the object is returned by this method. All other properties are null. To get all the properties of a virtualEventSession, use the Get virtualEventSession method.
Property | Type | Description |
---|---|---|
endDateTime | DateTimeTimeZone | The virtual event session end time. |
id | String | The unique identifier of the virtual event session. Read-only. Inherited from onlineMeetingBase. |
joinWebUrl | String | The join URL of the virtual event session. Read-only. Inherited from onlineMeetingBase. |
startDateTime | DateTimeTimeZone | The virtual event session start time. |
subject | String | The subject of the virtual event session. Inherited from onlineMeetingBase. |
The following example shows a request.
GET https://graph.microsoft.com/v1.0/solutions/virtualEvents/webinars/f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd/sessions
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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",
"isBroadcast": null,
"broadcastSettings": null,
"capabilities": [],
"audioConferencing": null,
"chatInfo": 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
}
]
}