Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft of ve concept doc #9435

Closed
wants to merge 23 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
372cbd2
Update toc.yml with virtual events conceptual doc names
awang119 Sep 25, 2024
616cf34
Create cloud-communications-virtual-events-overview.md
awang119 Sep 25, 2024
a5e8f79
Update cloud-communications-virtual-events-overview.md with VE overview
awang119 Sep 25, 2024
8eacaaa
Update toc.yml decreased number of virtual events md files
awang119 Sep 25, 2024
abc0666
Update toc.yml title of virtual events overview
awang119 Sep 25, 2024
c2eeb11
Update cloud-communications-virtual-events-overview.md with graph res…
awang119 Sep 25, 2024
dd8da78
Update cloud-communications-virtual-events-overview.md with edit comm…
awang119 Sep 25, 2024
e9b98ed
Update cloud-communications-virtual-events-overview.md column title
awang119 Sep 25, 2024
4ee22b9
Update cloud-communications-virtual-events-overview.md with next steps
awang119 Sep 25, 2024
dd068bf
Update cloud-communications-virtual-events-overview.md
awang119 Sep 25, 2024
3e1ff23
Create cloud-communications-virtual-events-townhall-usecases.md
awang119 Sep 25, 2024
24084ff
Create cloud-communications-virtual-events-webinar-usecases.md
awang119 Sep 25, 2024
e7f5051
Update cloud-communications-virtual-events-overview.md next step head…
awang119 Sep 25, 2024
045651d
Update cloud-communications-virtual-events-overview.md fix grammar
awang119 Sep 25, 2024
fd1e24c
Update cloud-communications-virtual-events-overview.md
awang119 Sep 25, 2024
e788678
Update cloud-communications-virtual-events-overview.md
awang119 Sep 25, 2024
4aba08d
Update cloud-communications-virtual-events-webinar-usecases.md with t…
awang119 Sep 25, 2024
d9ed63b
Update cloud-communications-virtual-events-overview.md fixed naming
awang119 Sep 25, 2024
eb6e5f3
Update cloud-communications-virtual-events-overview.md with webhooks
awang119 Sep 25, 2024
a7b177d
Update cloud-communications-virtual-events-overview.md
awang119 Sep 25, 2024
d5a2b8c
Update cloud-communications-virtual-events-webinar-usecases.md webina…
awang119 Sep 25, 2024
bbccf28
Update cloud-communications-virtual-events-webinar-usecases.md CUD se…
awang119 Sep 26, 2024
3b03bfb
Merge branch 'microsoftgraph:main' into awang119-VE-concept-doc
awang119 Oct 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions concepts/cloud-communications-virtual-events-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Choose the right meeting type"
description: "Consider when to use online meetings API, webinar API or town hall API for Teams meetings."
author: "awang119"
ms.localizationpriority: medium
ms.subservice: "cloud-communications"
---

# Choose the right meeting type

Microsoft Teams and Microsoft Graph supports multiple types of scheduled real-time voice and video experiences. These range from ad hoc meetings suitable for a small number of participants to large structured virtual events like webinars and town halls with thousands of attendees.

Use the following table to choose the right meeting type for your use case.
| **Teams Meeting type** |**Microsoft Graph** | **Use cases** |
| ------------- | ------------- | ------------- |
| [Online meeting](https://support.microsoft.com/en-us/office/meetings-in-microsoft-teams-e0b0ae21-53ee-4462-a50d-ca9b9e217b67) |[onlineMeeting](../api-reference/v1.0/resources/onlinemeeting.md) <br> [attendanceReport](../api-reference/v1.0/resources/meetingattendancereport.md) <br> [attendanceRecord](../api-reference/v1.0/resources/attendancerecord.md) <br> [online meeting webhooks](/concepts/changenotifications-for-onlinemeeting.md) | <ul><li>Hosting a meeting for up to 1,000 participants who can be inside or outside of your organization. Everyone can interact via audio, video, chat, and screensharing. </li><li>Meetings are either scheduled, ad hoc, or channel meetings. </li></ul> |
| [Webinar](https://support.microsoft.com/en-us/office/get-started-with-microsoft-teams-webinars-42f3f874-22dc-4289-b53f-bbc1a69013e3) |[virtualEventWebinar](../api-reference/v1.0/resources/virtualeventwebinar.md) <br> [virtualEventRegistration](../api-reference/v1.0/resources/virtualeventregistration.md) <br> [virtualEventRegistrationConfiguration](../api-reference/v1.0/resources/virtualeventregistrationconfiguration.md) <br> [virtualEventRegistrationQuestion](../api-reference/v1.0/resources/virtualeventregistrationquestionbase.md) <br> [meetingAttendanceReport](../api-reference/v1.0/resources/meetingattendancereport.md) <br> [attendanceRecord](../api-reference/v1.0/resources/attendancerecord.md) <br> [virtualEventSession](../api-reference/v1.0/resources/virtualeventsession.md) <br> [virtualEventPresenter](../api-reference/v1.0/resources/virtualeventpresenter.md) <br> [virtual event webhooks](/concepts/changenotifications-for-virtualevent.md)| <ul><li>Hosting a meeting where one or several experts (presenters) share their ideas or provide training to an audience (attendees inside or outside of your organization) with a maximum of 1,000 participants on the call.</li><li>Registration is needed before attendees can join the meeting.</li></ul> |
| [Town hall](https://support.microsoft.com/en-us/office/get-started-with-town-hall-in-microsoft-teams-33baf0c6-0283-4c15-9617-3013e8d4804f) | [virtualEventTownhall](../api-reference/v1.0/resources/virtualeventtownhall.md) <br> [virtualEventSession](../api-reference/v1.0/resources/virtualeventsession.md) <br> [virtualEventPresenter](../api-reference/v1.0/resources/virtualeventpresenter.md) | <ul><li>Automatic streaming event for a limited number of presenters to a large group of attendees, capping at 10,000 or 20,000 participants (with Teams Premium). </li><li>Attendees don’t need to register for the event but are invited and use Q&A to engage with presenters and organizers instead of direct interaction via chat or audio.
</li></ul>

To learn more about the differences between each meeting type to help you choose the one that is best suited for your use case, see the [feature comparison chart](https://learn.microsoft.com/en-us/microsoftteams/meeting-webinar-town-hall-feature-comparison).


## Next Steps
- [Create or join online meetings](cloud-communications-online-meetings.md) - Learn about how to use online meetings APIs.
- [Webinar use cases](cloud-communications-virtual-events-webinar-usecases.md) - Learn how to create solutions with webinar APIs.
- [Town hall use cases](cloud-communications-virtual-events-townhall-usecases.md) - Learn how to create solutions with town hall APIs.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

62 changes: 62 additions & 0 deletions concepts/cloud-communications-virtual-events-webinar-usecases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Virtual events webinar use cases"
description: "List of use cases that can be enabled using virtual events webinar APIs"
author: "awang119"
ms.localizationpriority: medium
ms.subservice: "cloud-communications"
---
# Virtual events webinar API overview
Microsoft Graph virtual events webinar APIs allows you to get Teams webinar data and programmatically create, update and delete a Teams webinar.

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:

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

**[INSERT TABLE OF DIFF PERSONAS AND PERMISSIONS]**

The following resource types can be used to build your webinar solution
- [virtualEventWebinar](../api-reference/v1.0/resources/virtualeventwebinar.md) – Used to create, get, update, publish, cancel, and list Teams webinars.
- [virtualEventRegistration](../api-reference/v1.0/resources/virtualeventregistration.md) – 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.
- [virtualEventRegistrationQuestion](../api-reference/v1.0/resources/virtualeventregistrationquestionbase.md) – Used to create, list, and delete either custom registration questions or predefined registration questions for registrants to answer when they register for a webinar.
- [virtualEventRegistrationConfiguration](../api-reference/v1.0/resources/virtualeventregistrationconfiguration.md) – Contains information about a webinar registration configuration that stores the registration portal URL of the webinar.
- [virtualEventPresenter](../api-reference/v1.0/resources/virtualeventpresenter.md) – Used to create, get, list, update and delete a presenter for a Teams webinar.
- [virtualEventSession](../api-reference/v1.0/resources/virtualeventsession.md) – A webinar created via Microsoft Graph APIs only has one session that inherits the properties of online meetings.
- [meetingAttendanceReport](../api-reference/v1.0/resources/meetingattendancereport.md) – Each time a webinar ends, an attendance report is generated for the session but doesn’t include attendee data.
- [attendanceRecord](../api-reference/v1.0/resources/attendancerecord.md) – Provides webinar attendee data in the attendance report.
- [virtual event webhooks](/concepts/changenotifications-for-virtualevent.md) – Can receive notifications for changes to a webinar, webinar registration, session, attendance report, and so on.


## Solutions you can build
The following table lists some solutions you can build by using the Teams client and Microsoft Graph webinar APIs and webhooks.
| **Solutions** | **Description** |
| ------------- | ------------- |
| [Create/update/delete](#createupdatedelete) | Programmatically create, update, and delete Teams webinars.|
| [Data Sync](#data-sync) | Pull Teams webinar data in a custom application (i.e. attendees, registration questions, attendance report, and more). |
| [Registration](#registration) | Host your own registration portal experience for a Teams webinar and sync the registration data to the Teams client. |
| [Email communication](#email-communication)| Use your own email infrastructure to send out webinar-related notification emails. |

> [!NOTE]
>To build any Graph solutions, follow this guide on [how to register and give the right permissions to your application](/concepts/auth/auth-concepts.md).

### Create/update/delete

1. Use the Create webinar API to create a draft of the event, followed by the Publish webinar API to complete the creation and make it visible to its audience.

The webinar created via Microsoft Graph APIs will be a Teams webinar that’s visible and editable in the Teams client

Just like in Teams, organizers can only create webinar events. The Create webinar API can only be called with delegated permissions on behalf of the organizer.

3. Only organizers and co-organizers can update and delete webinars.

4. Subscribe to change notifications to get updates about any changes made to the webinar. 

### Data Sync


### Registration

### Email communication
8 changes: 8 additions & 0 deletions concepts/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -923,6 +923,14 @@ items:
href: cloud-communications-identifylargegalleryview.md
- name: Manage watermarks for sensitive meetings
href: cloud-communications-watermark-meeting.md
- name: Virtual events
items:
- name: Choose the right meeting type
href: cloud-communications-virtual-events-overview.md
- name: Town hall use cases
href: cloud-communications-virtual-events-townhall-usecases.md
- name: Webinar use cases
href: cloud-communications-virtual-events-webinar-usecases.md
- name: Change notifications
items:
- name: Subscribe to teams, chats, channels
Expand Down
Loading