Skip to content

Commit 580d5cd

Browse files
authored
Edits.
1 parent 907e645 commit 580d5cd

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed
Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
---
2-
title: "Virtual events webinar use cases"
2+
title: "Use cases for virtual events webinar APIs in Microsoft Graph"
33
description: "List of use cases that can be enabled using virtual events webinar APIs"
44
author: "awang119"
55
ms.localizationpriority: medium
66
ms.subservice: "cloud-communications"
77
ms.date: 11/18/2024
88
---
9-
# Virtual events webinar API overview
9+
# Virtual events webinar API use cases
10+
1011
Microsoft Graph virtual events webinar APIs allow you to get Teams webinar data and programmatically create, update, and cancel a Teams webinar.
1112

12-
To make the best use of the Graph virtual events webinar APIs, it’s helpful to understand the personas for the users who access the Teams webinar experience:
13+
For you to make the best use of the Graph virtual events webinar APIs, it’s helpful to understand the personas for the users who access the Teams webinar experience:
1314

1415
- **Organizers** are employees (in your organization) who manage the webinar. They're the authority on schedule and participants. They configure webinar attributes such as title, theme, attendee experience, and email rules.  
1516
- **Presenters** are employees (in your organization) or guests who lead the webinar.  
1617
- **Registrants** are users (in or outside of your organization) who registered for a webinar. They can be registered, waitlisted, or rejected. They can choose to cancel their webinar registration.  
1718
- **Attendees** are registrants who joined the webinar. They need to register through a portal and answer registration questions.
1819
- **Teams tenant administrator** must authorize custom applications with appropriate permissions.
1920

20-
The following resource types can be used to build your webinar solution:
21+
You can use the following resource types to build your webinar solution:
2122
- [virtualEventWebinar](/graph/api/resources/virtualeventwebinar) – Used to create, get, update, publish, cancel, and list Teams webinars.
2223
- [virtualEventRegistration](/graph/api/resources/virtualeventregistration) – Used to create, get, cancel, and list registration records of registrants of a webinar. Provides the unique Teams webinar join URL for the registered registrant.
2324
- [virtualEventRegistrationQuestion](/graph/api/resources/virtualeventregistrationquestionbase) – Used to create, list, and delete either custom registration questions or predefined registration questions for registrants to answer when they register for a webinar.
@@ -35,32 +36,36 @@ The following table lists some solutions you can build by using the Teams client
3536
| Solutions | Description |
3637
| ------------- | ------------- |
3738
| [Create/update/cancel](#createupdatecancel) | Programmatically create, update, and cancel Teams webinars.|
38-
| [Data Sync](#data-sync) | Pull Teams webinar data in a custom application (like attendees, registration questions, attendance report, and more). |
39+
| [Data sync](#data-sync) | Pull Teams webinar data in a custom application (like attendees, registration questions, attendance report, and more). |
3940
| [Registration](#registration) | Host your own registration portal experience for a Teams webinar and sync the registration data to the Teams client. |
4041
| [Email communication](#email-communication)| Use your own email infrastructure to send out webinar-related notification emails. |
4142

4243
> [!NOTE]
43-
>To build any Graph solutions, follow this guide on [how to register and give the right permissions to your application](/graph/auth/auth-concepts).
44+
> To build any Microsoft Graph solutions, you need to register and give the right permissions to your application. For more information, see [Authentication and authorization basics](/graph/auth/auth-concepts).
4445
4546
### Create/update/cancel
46-
- Use the [CREATE webinar API](/graph/api/virtualeventsroot-post-webinars) to create a draft of the event, followed by the [PUBLISH webinar API](/graph/api/virtualeventwebinar-publish) to complete the creation and make it visible to its audience.
47+
48+
- Use the [Create webinar API](/graph/api/virtualeventsroot-post-webinars) to create a draft of the event, followed by the [Publish webinar API](/graph/api/virtualeventwebinar-publish) to complete the creation and make it visible to its audience.
4749
- The webinar created via Microsoft Graph APIs is a Teams webinar that’s visible and editable in the Teams client.
48-
- Just like in Teams, only the organizer can create, publish, and cancel webinar events which is why Create webinar API only supports delegated permissions on behalf of the organizer.
49-
- Like in Teams, co-organizers can update webinars. So use the [UPDATE webinar API](/graph/api/virtualeventwebinar-update) with delegated permissions on behalf of the co-organizer.
50+
- Just like in Teams, only the organizer can create, publish, and cancel webinar events. The create webinar API only supports delegated permissions on behalf of the organizer.
51+
- Like in Teams, co-organizers can update webinars. To update webinars, use the [Update webinar API](/graph/api/virtualeventwebinar-update) with delegated permissions on behalf of the co-organizer.
5052
- Subscribe to [change notifications](/graph/changenotifications-for-virtualevent#subscribable-virtual-events) to get updates about any changes made to the webinar. 
5153

52-
### Data Sync
54+
### Data sync
55+
5356
- Subscribe to [change notifications](/graph/changenotifications-for-virtualevent#subscribable-virtual-events) to get updates about any changes made to the webinar.
54-
- To get attendance report data for a webinar, use [LIST attendance records](/graph/api/attendancerecord-list) or [GET attendance record with a query option](/graph/api/meetingattendancereport-get#example-2-get-the-attendance-report-for-a-webinar-session-by-id).
55-
- To get attendance information of a webinar attendee, after doing the above, map the `Id` property in [virtual event registration](/graph/api/resources/virtualeventregistration) to the `registrationId` property in [attendance record](/graph/api/resources/attendancerecord) (currently only available in Beta).
57+
- To get attendance report data for a webinar, use [List attendance records](/graph/api/attendancerecord-list) or [Get attendance record with a query option](/graph/api/meetingattendancereport-get#example-2-get-the-attendance-report-for-a-webinar-session-by-id).
58+
- To get attendance information of a webinar attendee, after a list or get request, map the **Id** property in [virtual event registration](/graph/api/resources/virtualeventregistration) to the **registrationId** property in [attendance record](/graph/api/resources/attendancerecord) (currently only available in the beta endpoint).
5659
- Get data for [a specific webinar](/graph/api/virtualeventwebinar-get), [list all the webinar in a tenant](/graph/api/virtualeventsroot-list-webinars), list webinars where the [user is an organizer or co-organizer](/graph/api/virtualeventwebinar-getbyuserrole), list webinars where the [specified user is either the organizer or co-organizer](/graph/api/virtualeventwebinar-getbyuseridandrole).
57-
- To get the Teams webinar registration portal URL for your webinar, use [GET webinar registration configuration](/graph/api/virtualeventwebinarregistrationconfiguration-get).
60+
- To get the Teams webinar registration portal URL for your webinar, use [Get webinar registration configuration](/graph/api/virtualeventwebinarregistrationconfiguration-get).
5861

59-
### Registration
60-
- Use [CREATE registration](/graph/api/virtualeventwebinar-post-registrations) to programmatically register users to your webinar. Organizers, co-organizers, and presenters don’t need to register. Whether or not registrants have Microsoft Entra accounts affects the permissions you need to call the API.
62+
### Registration
63+
64+
- Use [Create registration](/graph/api/virtualeventwebinar-post-registrations) to programmatically register users to your webinar. Organizers, co-organizers, and presenters don’t need to register. Whether or not registrants have Microsoft Entra accounts affects the permissions you need to call the API.
6165
- [CREATE registration questions](/graph/api/virtualeventregistrationconfiguration-post-questions) (predefined or custom) attendees have to answer required questions during registration.
62-
- After the registrant registers for the webinar, use [LIST sessions](/graph/api/virtualeventregistration-list-sessions) to get the unique `joinWebURL` for the webinar.
66+
- After the registrant registers for the webinar, use [List sessions](/graph/api/virtualeventregistration-list-sessions) to get the unique `joinWebURL` for the webinar.
6367

6468
### Email communication
65-
- To turn off email communications to attendees, it needs to be done when [creating the webinar](/graph/api/virtualeventsroot-post-webinars). In the `settings` property, set `isAttendeeEmailNotificationEnabled` to `false`. However, emails still send to organizers, co-organizers, and presenters (internal and external).
66-
- Can subscribe to [change notifications](/graph/changenotifications-for-virtualevent#subscribable-virtual-events) to build your own customized email communication system.
69+
70+
- You can turn off email communications to attendees when you [create the webinar](/graph/api/virtualeventsroot-post-webinars). In the **settings** property, set `isAttendeeEmailNotificationEnabled` to `false`. Note that emails are still send to organizers, co-organizers, and presenters (internal and external).
71+
- You can subscribe to [change notifications](/graph/changenotifications-for-virtualevent#subscribable-virtual-events) to build your own customized email communication system.

0 commit comments

Comments
 (0)