Zoom Integration Setup Guide

Streaming Zoom into CrowdComms

If you prefer to live stream a Zoom session straight into the CrowdComms video player which benefits from recording the session on demand in the CrowdComms video library, you can see steps to live stream Zoom here. Details on how to use the CrowdComms live stream module can be found here, this supports being able to include a stream from Zoom.

This is an alternative approach that bypasses the integration between CrowdComms and Zoom and uses stream keys to host the Zoom meeting in the CrowdComms platform. 

Zoom Integration Guide

This guide covers how to integrate your Zoom account to link both your Zoom Meetings and Zoom Webinars to seamlessly sit within the CrowdComms player. Please note, you can run a maximum of two parallel Zoom sessions at once using the integration.

Important: Zoom integration requires the sessions and webinars to be recorded on Zoom. The recordings will not automatically be available in the CrowdComms video library, however the Zoom recording can be uploaded after the session to the CrowdComms video library for on demand viewing. 

To integrate Zoom into our platform, you will need access to the following; 

The Zoom API and Client SDKs are not available to Basic Accounts. If you have a basic account and want to set up an integration with our platform, you will need to speak to Zoom directly to discuss upgrading your account. If you are not the account owner or an admin on the account, you may also need to check that you have been given developer privileges.


Step 1. Zoom Developer Platform
  1. Once you are logged into Zoom Marketplace, you will need to navigate to ‘Develop’ at the top right-hand menu of the page and click ‘Build App’ from the dropdown.

Screenshot 2023-05-30 at 11.58.03.png










2. You will be brought to the Basic Information Page, select 'Admin-Managed' for how the app is managed. 

3. Please note the Client ID and the Client Secret to paste into the CMS later.

4. Add the following redirect URL: https://api-cms.crowdcomms.com/cms/integrations/zoom/redirect-callback/

5. Click continue until you reach the 'Embed' page Toggle on Meeting SDK and click continue.

6. You will then be brough to the 'Scopes' page, click the plus to 'add scope'. Select the following options


image.png


7. Click 'Continue'

8. Now the app should be configured for integration. Scheduling the meetings/webinars to be imported into the CrowdComms platform will be done through the normal Zoom process.

Please note: As the integration is set up by one central person's Zoom account, we recommend using the 'alternative hosts' option, so that whoever is running each specific meeting is able to start it. You will need to then communicate the meeting link with them as you would outside of the platform.


Step 2. CMS

1. Log into the CrowdComms CMS Dashboard with your credentials.
2. Select the App you wish to create the Zoom integration.
3. Click on Integrations
4. Then, click on Zoom

Screenshot 2023-05-30 at 13.06.53.png

If you have an existing integration, created via the old integration setup using JWT keys, you do not need to unlink your integration. To avoid losing existing data, simply update the Client ID and Client Secret fields using the new credentials obtained in Step 1 and click 'Save changes'

5. Paste the Client ID (API Key) and Client Secret (API Secret) you took note of earlier
Please note: If you forgot to make a note of this earlier, you can go back to the developer platform and find them here.
6. Click on 'Authorise' 
Please note: Your browser will need to allow popups in order for the authorisation to work. This is to generate the success message. Without this, the CMS will generate an error and you won't be able to import your meetings.
7. You will receive a successful authorisation message (If authentication has failed, see troubleshooting section) 
8. Click on 'Libraries' 
9. Click on 'Zoom meetings and Webinars'

SG1.png

10. Click on 'Import Events' and choose to either Import Meetings or Import Webinars

SG2.png

11. Select the meeting(s) and or Webinar(s) you wish to import (Example shown for Import meetings)

SG3.png

12. Click 'Submit' (At this point, you can select the pencil edit icon to edit a meeting/Webinar. You can update the title, add a Poster image and/or change the description - this change will only be visible in CC)

SG4.png

13. Click on 'Modules' 
14. Click on 'Agenda' 
15. Select your agenda session and click on the 'Edit' icon 
16. Click on the 'Features' tab

SG5.png

17. Within Content Features, use the drop-down menu under 'select a zoom webinar' or 'select a zoom meeting' to select your webinar/meeting

SG6.png

18. Click 'Save Changes'. Your integration is now set up and ready to test via the front-end Event App.

SG8.png


Step 3. Event App Platform
  1. Log into FE (Front-end) using your credentials 
    2. Go to the Agenda module 
    3. Click on the meeting/Webinar (NOTE; if you are hosting the meeting/Webinar, you will need to return to Zoom to start the session) 
    4. Click on "Join meeting"

We advise that hosts join ONLY via zoom as normal to avoid any feedback loops/repeated audio. Zoom session details should be pre-filled for participants, allowing them to join the session.

FE-Join.PNG

The host will have to start the meeting before anyone else is let in the meeting, and zoom controls on microphones and cameras etc will be there also, same as normal. Once the session is over you can simply 'leave meeting' in the usual fashion. 


Best Practices


Notes

Troubleshooting 

If you are have an error message when authorising the integration via the plugins page, please check the below with your setup in zoom:

CMS

Front End

If you still face trouble after going through this guide, please contact your support agent.



Developer Accounts
https://marketplace.zoom.us/docs/sdk/native-sdks/developer-accounts

User Role Management:
https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control

Zoom User Types & Roles:
https://support.zoom.us/hc/en-us/articles/201363173-Account-types



Revision #27
Created 20 August 2021 10:25:41
Updated 25 July 2024 09:46:48