diff --git a/search/search_index.json b/search/search_index.json index 420e0b4..86433f1 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Getting Started","text":""},{"location":"#installation","title":"Installation","text":"
Video conferencing with zoom api
\"OR
OR
Download Plugin from WordPress.org repository.
"},{"location":"#about-plugin","title":"About Plugin","text":"Simple plugin which gives you the extensive functionality to manage zoom meetings, webinars, recordings, users, reports from your WordPress Dashboard. Now, with capability to add your own post as a meeting. Create posts as meetings directly from your WordPress dashboard to show in the frontend as a meeting page. Allow users to directly join via that page with click of a button.
"},{"location":"#video-documentation","title":"Video Documentation","text":"Sorry for the fan noise in the video !
"},{"location":"#compatibility","title":"Compatibility","text":"This allows you to link your Users to your WordPress site using the get_user_meta
function. The purpose is to reduce the need to select a host each time a new meeting is created. So, that in the case of allowing to create meetings via multiple existing users ( for example admin 1 and admin 2) they won't get confused on which host to select.
define(\"VIDEO_CONFERENCING_HOST_ASSIGN_PAGE\", true);
into your wp-config.php file to enable this menu in wp-admin side.
After completing the setup process, you should see a new option on your wp-admin portal called \"Host to WP users\". Like show below:
Goto this page and link a Zoom host to your desired WordPress user.
"},{"location":"assign_host/#how-it-works","title":"How it Works?","text":"After you link the Host to WP user - When trying to create the meeting that user will only see the details that is linked to that account. This way it won't confuse your users and they won't have to choose a host everytime they create a meeting/webinar.
"},{"location":"blocks/","title":"Blocks","text":""},{"location":"blocks/#introducing-zoom-zoom-blocks","title":"Introducing Zoom - Zoom Blocks:","text":"Easily and Conveniently add features to your site - using the Zoom Blocks. All Zoom - blocks are under the Zoom Category:
"},{"location":"blocks/#types","title":"Types:","text":"Search for List Zoom Meeting while entering the block. Will allow you to list either Meetings or Webinars that are already available on your site. (From WordPress Created or imported to WordPress)
Settings:
Example Output:
Equivalent Shortcodes:
Show live - Zoom Meetings or Webinars directly from Zoom (not from WordPress).
Settings: ;
Example Output:
Equivalent Shortcodes:
Show a Zoom Meeting/Webinar directly from Zoom:
Settings:
Example Output:
Equivalent Shortcodes:
Embed a Zoom Post(Posts are either created or imported into WordPress).
Settings:
Example Output:
Equivalent Shortcodes:
Show Recordings either by Host or By Meeting
Settings:
Example Output:
Equivalent Shortcodes:
This guideline will teach you on how to integrate Zoom Meetings with Booked Appointment Plugin by BoxyStudio
Please note: CodeManas is not affiliated with Booked Appointment Plugin by BoxyStudio
We have this guideline on implementing our Zoom Meetings for Booked Appointments with Booked - Appointment Booking for WordPress.
"},{"location":"booked-appointments/#requirements","title":"Requirements","text":"Setting up Booked plugin and more options for Booked plugin should be followed from Booked official site directly.
"},{"location":"booked-appointments/#creating-and-linking-a-meeting-to-product-first","title":"Creating and Linking a Meeting to Product First","text":"After you install all the requirements goto your WooCommerce Product page in your wp-admin > Products > Add New
New Product Test Appointment
\" to the product.Zoom
tab in product edit page.Booked Appointment Service
Enable Zoom Meting
.Guessing that you have set your appointment times and setup everything related to Booked plugin.
To link your meetings with Booked Plugin, follow below instructions:
For this demo i have added New Product Test Appointment as product name but for yours will be different probably. Something like Appointment for 1:00pm to 2:00pm /w Dr. Josh etc. For each timeslots you'll need to create different product and meetings.
Thats it ! After you linked these fields. Your Zoom Meetings is linked with your Product.
"},{"location":"booked-appointments/#preparing-zoom-meeting-link-for-emails","title":"Preparing Zoom Meeting link for Emails","text":"Follow below steps to include join links in default Booked Appointments emails.
You should see below two points added in the description section.
%zoom_meeting_link% \u2014 Display the appointment\u2019s Zoom App Link. %zoom_meeting_browser_link% \u2014 Display the appointment\u2019s Zoom Join via Browser Link.
Add these above texts accordingly to show the zoom join link as well join via browser link and they should show up in your confirmation emails.
"},{"location":"booked-appointments/#how-will-users-receive-join-links","title":"How will users receive join links ?","text":"At the moment - If you have kept your bookings to be Auto Approved they will receive join links in email. Othewise, you'll have to use [booked-appointments] shortcode to show.
It would be like like so:
"},{"location":"booked-appointments/#guidelines-on-booked-support","title":"Guidelines on Booked Support","text":"https://boxystudio.ticksy.com/article/3820/ - Linking WooCommerce Product to your Appointment and How WooCommerce works.
"},{"location":"date_types/","title":"Change DateTime","text":"To adjust your date preference when showing different times in frontend via shortcode or direct from your Post type meeting page, this plugin offers you to change date format according to your locale or your preference.
"},{"location":"date_types/#change-date-and-time-formats","title":"Change Date and Time formats","text":"To change the hour format or month label type.
Thats it ! You should see your preferred date time formats in frontend now for the Zoom Meeting shortcodes as well as for single post type meeting page.
"},{"location":"dokan/","title":"Dokan Integration for Zoom (Addon)","text":"This Addon is for Dokan you can get it here.
"},{"location":"dokan/#prerequisite","title":"Prerequisite","text":"Dokan Integration for Zoom acts as a glue plugin for Zoom integration for WooCommerce or Zoom Integration for WooCommerce Bookings and Dokan. This addon allows vendors to create and manage Zoom Meeting Products from the front end.
"},{"location":"dokan/#instructions","title":"Instructions","text":"After successfully installing all the required plugins. If you log in as a vendor - you will be first shown a Zoom Meeting section on the Dokan dashboard.
At the moment it is not possible for vendors to add their own Zoom Account - they have to be added under the admins Zoom Account. The admin of the site or the account used to connect to Zoom on the site should be a paid account. Only then will the site admin be able to add users under their Zoom account. This becomes useful when you want your vendors to be able to use different zoom accounts.
By default, Vendors will be able to select all the hosts under a Zoom Account. If you want the vendors to be only be able to create meetings with a particular Host then you will need to go to Zoom Meetings > Dokan Vendors
"},{"location":"dokan/#woocommerce-booking-integration","title":"WooCommerce Booking Integration","text":""},{"location":"dokan/#prerequisites","title":"Prerequisites","text":"These plugins are required before Zoom can be enable with Dokan + WooCommerce Bookings.
After all of the required plugins are installed. Vendors will now see a new field when creating their Bookable Products. Enabling Zoom Meeting here for a product will create a Zoom Meeting when the bookable product is booked. For more information of how it works please check out Zoom Integration for WooCommerce Bookings Documentation.
"},{"location":"faq/","title":"FAQ","text":""},{"location":"faq/#join-via-browser-signature-in-invalid-or-connection-timeout","title":"Join via Browser Signature in Invalid or Connection Timeout.","text":"In this case please check your SDK app type credential are valid and activated. Please note that the app type must be activated. You can also check if all the api credential values are correct.
If everything is ok on your side, reach out to us with your site details as this issue can not be debugged without looking at the code.
"},{"location":"faq/#embedded-join-via-web-browser-issues","title":"Embedded Join via Web Browser Issues","text":"Few of the known issues when using embed join via web browser i.e only when used with embed join via browser shortcode or Join via Browser gutenberg Block.
Above issues are caused due to the use of IFRAME html component. Currently, these issues are unsolvable so, please use this feature at your own risk i.e embed join via browser shortcode or Join via Browser gutenberg Block.
Also, note: These above issues does not affect for normal join via web browser pages.
"},{"location":"faq/#zoom-pro-plans","title":"Zoom Pro Plans","text":"If you are subscribed to Zoom PRO plans you have more benefits for your meetings as well as webinars you host. So, its worth checking out Zoom plans here https://zoom.us/pricing
Subscribing to PRO plans will only benefit your Zoom Account however, this plugin can be used for FREE ACCOUNT users as well.
"},{"location":"faq/#add-users-not-working-for-me","title":"Add users not working for me","text":"The plugin settings allow you to add and manage users. But, you should remember that you can add users in accordance with the Zoom Plans, so they will be active for the chosen plan. More information about Zoom pricing plans you can find here: https://zoom.us/pricing
"},{"location":"faq/#join-via-browser-not-working-camera-and-audio-not-detected","title":"Join via Browser not working, Camera and Audio not detected","text":"This issue is because of HTTPS protocol. You need to use HTTPS to be able to allow browser to send audio and video.
"},{"location":"faq/#blank-page-for-single-meetings-page","title":"Blank page for Single Meetings page","text":"If you face blank page in this situation you should refer to Template Overriding and see Template override section.
This happens because of the single meeting page template from the plugin not being supported by your theme and i cannot make my plugin support for every theme page template because of which you'll need to override the plugin template from my plugin to your theme's standard. ( Basically, like how WooCommerce does!! )
"},{"location":"faq/#countdown-not-showing-guess-is-undefined-error-in-my-console-log","title":"Countdown not showing/ guess is undefined error in my console log","text":"If countdown is not working for you then the first thing you'll nweed to verify is whether your meeting got created successfully or not. You can do so by going to wp-admin > Zoom Meetings > Select your created meeting and on top right check if there are \"Start Meeting\", \"join Meeting links\". If there are those links then, you are good on meeting.
However, even though meeting is created and you are not seeing countdown timer then, you might want to check your browser console and see if there is any \"guess is undefined\" error. If so, there might be a plugin conflict using the same moment.js library.
"},{"location":"faq/#how-to-show-zoom-meetings-on-front","title":"How to show Zoom Meetings on Front","text":"See https://zoomdocs.codemanas.com/shortcode/#6-embed-zoom-meeting-in-your-browser section.
"},{"location":"filters_hooks/","title":"Filter Hooks","text":"This page shows you the few filters you can use in this plugin. I won't go in full detail here but yes there are few filters which you can extend this plugin into yours.
How to use ?
add_filter('vczapi_hook', function($data) { return $data; });
add_filter('vczapi_api_redirect_join_browser', function() { return 'https://yoursiteurl.com/page'; });
Add below to your functions.php file in your theme. Change \"your-slug-name\" to the slug you want. Then flush your permalink from wp-adming > settings > permalink and save.
View Implementation
"},{"location":"filters_hooks/#join-via-browser-show-fields","title":"Join via browser show fields","text":"If you want to show extra fields or hide them, add below code to your functions.php in your theme.
add_filter('vczapi_api_join_via_browser_params', 'vczapi_jvb_fields');\nfunction vczapi_jvb_fields( $fields ) {\n $fields = [\n 'meetingInfo' => [\n 'topic',\n 'host',\n #'mn',\n #'pwd',\n #'telPwd',\n #'invite',\n #'participant',\n #'dc',\n #'enctype',\n #'report'\n ],\n 'disableRecord' => false,\n 'disableJoinAudio' => false,\n 'isSupportChat' => true, //Enable or disable chat\n 'isSupportQA' => true, //Enable or disable QA\n 'isSupportBreakout' => true, //Enable or disable breakout rooms\n 'isSupportCC' => true, //Enable or disable CC\n 'screenShare' => true //Enable or disable Screenshare\n ];\n return $fields;\n}"},{"location":"filters_hooks/#automatically-allow-users-to-join-meeting-from-browser","title":"Automatically allow users to join meeting from browser","text":"
This below code allows you to redirect your users to meeting without needing to click join button manually.
Please NOTE: If user is not logged in, this code will not work because when joining a meeting from browser - User name is a required field and since this below code directly triggers the join button on load. Users will not be able to join the meeting without a name.
The reason this would work with logged in users is because username is already selected in the join via browser page if a user is logged in.
View Implementation
"},{"location":"filters_hooks/#show-cutom-roles-in-host-to-wp-page","title":"Show cutom roles in \"HOST TO WP\" page.","text":"View Implementation
"},{"location":"filters_hooks/#before-create-a-zoom-user","title":"Before Create a Zoom User","text":"apply_filters( 'vczapi_createAUser', $data );
Usage: Used when doing API call for creating a user on Zoom.
"},{"location":"filters_hooks/#before-listing-a-zoom-user","title":"Before Listing a Zoom User","text":"apply_filters( 'vczapi_listUsers', $data );
Usage: Used when doing API call for listing users from zoom.
"},{"location":"filters_hooks/#before-getting-a-zoom-user","title":"Before getting a Zoom User","text":"apply_filters( 'vczapi_getUserInfo', $data );
Usage: Used when doing API call for getting a specific HOST ID info.
"},{"location":"filters_hooks/#before-listing-a-meeting","title":"Before listing a meeting","text":"apply_filters( 'vczapi_listMeetings', $data );
Usage: Used when doing API call for getting list of meetings for a Zoom User.
"},{"location":"filters_hooks/#before-creating-a-meeting","title":"Before Creating a meeting","text":"apply_filters( 'vczapi_createAmeeting', $data );
Usage: Used when doing API call for posting your own data when creating a Meeting.
"},{"location":"filters_hooks/#before-updating-a-meeting","title":"Before Updating a meeting","text":"apply_filters( 'vczapi_updateMeetingInfo', $data );
Usage: Used when doing API call for posting your own data when updating a Meeting.
"},{"location":"filters_hooks/#before-getting-a-meeting","title":"Before Getting a meeting","text":"apply_filters( 'vczapi_getMeetingInfo', $data );
Usage: Used when doing API call for getting a meeting info.
"},{"location":"filters_hooks/#before-getting-daily-reports-data","title":"Before getting daily reports data","text":"apply_filters( 'vczapi_getDailyReport', $data );
Usage: Used when doing API call for when pulling in reports data.
"},{"location":"filters_hooks/#enable-gutenberg-support-for-zoom-meeting-edit-page-on-backend","title":"Enable Gutenberg Support for Zoom Meeting edit page on backend.","text":"Add below code to your functions.php file
add_filter( 'vczapi_cpt_show_in_rest', '__return_true' );
This functionality allows you to import your Zoom Meetings from your Zoom Account to your WordPress site if that meeting already does not exists on your site.
If you need to import recurring meetings and webinars, PRO VERSION plugin is required.
"},{"location":"import-meetings/#how-to","title":"How to ?","text":"NOTE: You can only import 10 meetings at a time. This is done to reduce API call usage and avoiding API call exhaustion on the server side.
Here below are the steps to integrate zoom plugin into WordPress. There are no complicated processes. Just the basic steps.
Check out the video documentation if you want to see live demo.
NOTE: if you recently getting an error called \"API_CREDENTIALS_NOT_FOUDN\" this is an error from zoom side. Please contact zoom support in this case.
"},{"location":"integration/#generating-api-keys-and-secret-keys","title":"Generating API keys and Secret Keys","text":"For this plugin you\u2019ll be using JWT token method to make the API connection. Please note, this method is only account level connection.
"},{"location":"integration/#first-step-choost-app","title":"First Step ( Choost App )","text":"First goto Create Page
Click on Develop on top of the page and build app page if you directly did not go into Create Page
Click JWT and \"Create\"
On the next screen you should see\u00a0Information, App Credentials, Feature and Activation menus
Fill in your basic information about the App.
On the\u00a0Credentials Page. Copy both API key and API Secret
\u00a0after you have filled all the details in information page.
Now, copy these credentials and go into WordPress\u00a0Zoom Meetings\u00a0settings page.
Click on Check API connection
button to check if your API connection is good !
Video Conferencing with Zoom plugin easily allows your users to join your meetings or webinars using Zoom's Native WebSDK WebSDK without needing to download Zoom App on your computer.
"},{"location":"join_links/#embed-or-join-via-browser-method","title":"Embed or Join via Browser Method","text":"This section shows you on how you can embed your meeting using a simple shortcode which allows your users to directly join your meeting/webinar.
If you are facing issues with this or your plugin version is below 3.9.0: Check out this section first for known issues.
"},{"location":"join_links/#shortcode-usage","title":"Shortcode Usage","text":"[zoom_join_via_browser meeting_id=\"YOUR_MEETING_ID\" login_required=\"no\" iframe=\"no\" title=\"Test\" height=\"500px\" disable_countdown=\"yes\" passcode=\"1232132121\" webinar=\"no\" image=\"https://images.unsplash.com/photo-1459257831348-f0cdd359235f\"]
Where,
meeting_id
: Your MEETING ID.login_required
: \"yes or no\", Requires login to view or join.iframe
: \"yes or no\", Show meeting or webinar in iframe element. This is not recommeded as there are known issues with this approach. Set this to \"no\" for more robust approach.title
: Title of your Embed Sessionheight
: Height of embedded video IFRAME.disable_countdown
: \"yes or no\", enable or disable countdown.passcode
: Set password of your meeting to automatically let users join without needing them to enter password.webinar
: \"yes\" for embedding webinars.image
: Image url for your post.You can edit elements from \"join via browser\" page by overriding template from \"plugins/video-conferencing-with-zoom-api/templates/shortcode/embed-session.php\".
Copy \"plugins/video-conferencing-with-zoom-api/templates/shortcode/embed-session.php\".
to \"wp-content/themes/yourtheme/video-conferencing-zoom/shortcode/embed-session.php\"
After that you can edit the file and change the contents according to your preference.
"},{"location":"join_links/#redirecting-after-completing-the-meeting-filter","title":"Redirecting after completing the meeting filter.","text":"To redirect user after a meeting fails, after completed or if meeting is not yet started; Add below code to your functions.php file in your theme and replace it with url you want to redirect:
add_filter('vczapi_api_redirect_join_browser', function() { return 'https://yoursiteurl.com/page'; });
Check this post as well to know more on direct browser join feature https://deepenbajracharya.com.np/joining-meetings-in-zoom-directly-from-browser/
"},{"location":"join_links/#additional-informations","title":"Additional Informations","text":""},{"location":"join_links/#how-join-links-work","title":"How join links work ?","text":"Join links allow users to join meetings easily from frontend. Check below screenshot on how its used in this plugin.
"},{"location":"join_links/#you-can-disable-join-links-as-well","title":"You can disable join links as well","text":"If you do not want to allow users to directly join via browser then you can disable that link from your posts page like shown in below screenshot.
"},{"location":"join_links/#browser-compatiblity","title":"Browser Compatiblity","text":"Mobile web browsers now supported Meeting SDK for Web v2.4.0 and higher supports the major Android and iOS browsers. Note that the Meeting SDK for Web on mobile browsers does not have complete feature parity with the Meeting SDK for Web on desktop browsers. Plugin currently uses webSDK higher than 2.4.0
Official Doc here
Chrome 69+Firefox 56+Safari 11+Edge 79+Gallery View(1)\u2718\u2718(1)Pause Recording\u2713\u2713\u2713\u2713Waiting Room\u2713\u2713\u2713\u2713Share Video\u2713\u2713\u2713\u2713Share Screen\u2713\u2713\u2718\u2713Join Computer Audio\u2713\u2713(2)\u2713Join Audio by Phone\u2713\u2713\u2713\u2713Meeting Host Controls\u2713\u2713\u2713\u2713View Shared Video\u2713\u2713\u2713\u2713View Shared Screen\u2713\u2713\u2713\u2713Request Remote Control\u2713\u2713\u2713\u2713In-meeting Chat\u2713\u2713\u2713\u2713Closed Captioning\u2713\u2713\u2713\u2713Webinar Q&A\u2713\u2713\u2713\u2713End-to-end encryption (E2EE) (3)\u2718\u2718\u2718\u2718Share computer audio(4)\u2718\u2718\u2718"},{"location":"join_links/#performance-limits","title":"Performance Limits","text":"Currently, the Zoom Meeting Web SDK encodes at a maximum resolution of 720p. See Web SDK 720p video for details. If a user is in a meeting with both native and browser clients, the browser client video displayed within the native client will be of lower quality due to encoding limitations.
"},{"location":"join_links/#loading-cdn-resources","title":"Loading CDN Resources","text":"From plugin version 3.6.2 users can now decide to load the webSDK resources directly from Zoom CDN.
To do this add below code to your config.php file.
define('VCZAPI_STATIC_CDN', true);
If incase, there is problem loading your join via browser page when using CDN. You can change the \"true\" value to \"false\".
"},{"location":"join_links/#known-issues-when-embedding-join-via-browser","title":"Known issues when embedding join via browser","text":"Below are some known issues when you use [zoom_join_via_browser iframe=\"yes\"] shortcode to embed your meeting into your site. Please note that these issues are not fixable at the moment so, if you are facing these issues - please avoid using [zoom_join_via_browser iframe=\"yes\"]
Check out the video documentation if you want to see live demo.
"},{"location":"meeting_types/#basic-information","title":"Basic Information","text":"Technically, every meeting created from the Video conferencing with zoom api plugin is live meetings meaning that it will be created on Zoom but, i have divided the term into two different categories:
"},{"location":"meeting_types/#post-type-meetings","title":"Post Type Meetings","text":"This is created when you create a new post from Zoom Meetings > Add New
page. These posts are related to your site and meetings created from here are binded to your site.
So, deleting any linked meeting without deleting the POST FIRST WOULD RESULT IN FAILURE TO JOIN MEETING FOR END USER !
This allows you to view your meeting by styling your frontend pages by overriding templates. See more on template override
section.
Basically, this will create a Meeting on your Zoom Account and a Post in your WordPress site which is linked. So, if you create a Meeting from here you'll be able to show a countdown timer in the frontend.
"},{"location":"meeting_types/#actual-live-meetings","title":"Actual Live Meetings","text":"This is created from page Zoom Meetings > Live meetings
section.
Meetings created from here are not binded to your site. This will create a meeting in your Zoom Account and will not create or add any additional data on your WordPress website. Everything will be fetched directly using the Zoom API.
If you want to show these meetings from your site then you'll have to rely on using shortcode using the meeting ID value here.
See shortcode section on how to use Shortcode.
"},{"location":"migration/","title":"Migration from JWT","text":""},{"location":"migration/#reason","title":"Reason","text":"Previous versions of Video Conferencing with Zoom API ( version 3.9.7 and below) - used JWT credentials to connect and utlize zoom. As of June 2023, Zoom will deprecate JWT App type - please see JWT App Type Deprecation FAQ From version 4.0.0 and above the plugin has moved to Server-to-Server OAuth App and SDK App type for Join via Browser / Web SDK support
"},{"location":"migration/#migration-wizard","title":"Migration Wizard","text":"As of version 4.0.0 of Video Conferencing with Zoom Api users will see a migration wizard
that prompts to add Server-to-Server OAuth Keys and App SDK keys to transition to new system. Clicking on migration wizard will show you the migration wizard
"},{"location":"migration/#step-1","title":"Step 1","text":"First step is to add the OAuth App Credentials - you can follow the steps in the setup guide to generate Server-to-Server OAuth credentials. - then add the Account ID, Client ID and Client Secret to the form shown below, checking the box Delete JWT Keys - will delete the JWT keys upon successfully validating and saving OAuth keys
Once saved successfully click Next Step
"},{"location":"migration/#step-2","title":"Step 2","text":"Step 2 will prompt you to add SDK App credentials, SDK Credentials are required to use Join via Browser feature without JWT, please see steps in the setup guide to generate App SDK credentials. Then add the SDK Key and SDK Secret Key and Save App SDK Keys. Please note to test join via browser option on your site to verify you've added SDK keys correctly as it's the only way to verify you've entered the correct keys.
"},{"location":"migration/#step-3","title":"Step 3","text":"You're all done - the keys have already been saved on Step 1 and Step 2, the migration is now complete.
"},{"location":"pro-shortcode/","title":"PRO Version Shortcode","text":""},{"location":"pro-shortcode/#1-list-meeting-registrants","title":"1. List meeting registrants","text":"This shortcode can be used to list all author meeting list in frontend and to view registrants for those meeting.
Use: [vczapi_pro_author_registrants]
You can find more information for this in PRO version widget documentation..
Use: [vczapi_zoom_calendar host_id=\"\" author=\"\" show=\"\" calendar_default_view=\"dayGridMonth\" show_calendar_views=\"yes\"]
Where,
Use: [vczapi_list_meetings per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" show=\"meeting\" cols=\"3\" filter=\"yes\"]
NOTE: This shortcode will show register now button if a meeting is enabled registration.
Where,
This shortcode will display all registered events via user ID or via logged in user session ID.
Use: [vczapi_registered_meetings user_id=\"\" show=\"upcoming\"]
Where,
Display registration form in any page you want.
Use: [vczapi_pro_registration_form post_id='']
Where,
Here below are the steps to setup Zoom into WordPress.
"},{"location":"setup/#getting-started","title":"Getting Started","text":"For Video Conferening with Zoom plugin to work you will be using Server-to-Server OAuth app type.
In order to setup the plugin you'll first need a Zoom Account. So, sign up if you don't have a Zoom account already or just sign in with your existing Zoom Account and follow the next steps.
"},{"location":"setup/#setup-server-to-server-oauth","title":"Setup Server-to-Server OAuth","text":"In order for you to setup the plugin, carefully follow all the steps below:
"},{"location":"setup/#creating-server-to-server-app-type","title":"Creating Server to Server App type","text":"OR you can simply click this https://marketplace.zoom.us/develop/create and this will open a modal like in below screenshot.
Click on Server to Server OAuth App and click create.
"},{"location":"setup/#setting-up-api-credentials","title":"Setting Up API Credentials:","text":"After you click on \"Create\" button in the popup you will be asked few details to fill up.
"},{"location":"setup/#1-app-name","title":"1. App Name","text":"Add you app name to anything of your Preference so that you can remember that this app type is for your WordPress website.
"},{"location":"setup/#2-app-credentials","title":"2. App Credentials","text":"Once App is created - you will be taken to an App Overview page where you can see App Credentials. These highlighted credentials will be used in our WordPress Video conferencing Zoom plugin to connect with your account. We'll get back to this in next steps. Click Continue for now.
"},{"location":"setup/#3-information-page","title":"3. Information Page","text":"In this next step you will need to add Contact name, Contact email and Company name on the information page in order to activate this app type. Fill in the details according to your needs.
"},{"location":"setup/#4-scopes-page","title":"4. Scopes Page","text":"Ignore \"Feature\" page - After you've added details from previous step - Goto Scopes page from the left navigation menu and Click on \"Add Scopes\" as highlighted in the screenshot.
Scopes are basically added in order to allow permissions to access your Zoom meetings into Video Conferencing Zoom plugin. So, this step is very crucial step and you should properly assign each of the defined scopes properly otherwise you will get no permission issues when trying to create,delete or access Zoom Meetings from your WordPress site.
See Required Scopes section. in order to add necessary permissions. Come back to this step after you've added all the necessary permissions.
"},{"location":"setup/#5-activation","title":"5. Activation","text":"Finally, click on Activate your App button and your activated.
"},{"location":"setup/#required-scopes","title":"Required Scopes:","text":"These below are the scopes required from step 4 when setting up the scopes for your application.
Note: Not adding any of the below permissions may result in permission issue error notices when trying to create your meeting/webinars.
"},{"location":"setup/#meetings","title":"Meetings","text":"Login to your WordPress site as an Administrator and goto WordPress admin dashboard page and goto Zoom Events > Settings page.
Click save to verify your credentials. If credentials are invalid, there should be a invalid warning. If everything is correctly setup then you should be able to see your Zoom Users from wp-admin > Zoom Events > Users page.
Next step is to create new Zoom Events from wp-admin > Zoom Events > Add new page.
"},{"location":"setup/#setup-app-sdk-credentials","title":"Setup App SDK Credentials","text":"Purpose for creating a App SDK is required for Join via Browser/Web SDK to work properly.
"},{"location":"setup/#generating-app-sdk-credentials","title":"Generating App SDK Credentials","text":"NOTE: In case you forgot to toggle the below button(shown in screenshot) you can still use the SDK credentials however, you won't be able to complete the SDK activation step. That's completely ok.
"},{"location":"setup/#adding-sdk-credentials-to-the-plugin","title":"Adding SDK Credentials to the plugin","text":"You've not successfully connected your Zoom Account in your WordPress site. You should be able to create your Zoom meetings directly from your WordPress dashboard now.
"},{"location":"setup/#next-steps","title":"Next Steps","text":"After you've configured your keys - Zoom meetings are not automatically imported into your site. You'll need to import your meetings or create new ones from your WordPress dashboard directly.
In order to create a new Zoom Meeting goto wp-admin > Zoom Events > Add new page and this should create a new meeting both in Zoom and as a post in your WordPress site as well.
"},{"location":"shortcode/","title":"Shortcode","text":"All these shortcodes are available as elementor and gutenberg modules.
"},{"location":"shortcode/#types","title":"Types","text":"[zoom_api_link meeting_id=\"1234567890\" link_only=\"no\"]
[zoom_meeting_post post_id=\"ZOOM MEETING POST ID\" template=\"none\"]
[zoom_list_meetings per_page=\"5\" category=\"test,test2,test3\" filter=\"no\" type=\"upcoming\" cols=\"3\"]
[zoom_list_webinars per_page=\"5\" category=\"test,test2,test3\" filter=\"no\" type=\"upcoming\" cols=\"3\"]
[zoom_list_host_meetings host=\"YOUR_HOST_ID\"]
[zoom_api_webinar meeting_id=\"YOUR_WEBINAR_ID\" link_only=\"no\"]
[zoom_list_host_webinars host=\"YOUR_HOST_ID\"]
[zoom_join_via_browser meeting_id=\"1234567890\" login_required=\"no\" help=\"yes\" title=\"Test\" height=\"500px\" disable_countdown=\"yes\"]
[zoom_recordings host_id=\"YOUR_HOST_ID\" downloadable=\"yes\"]
[zoom_recordings_by_meeting meeting_id=\"1234567890\" downloadable=\"no\"]
Use: [zoom_api_link meeting_id=\"1234567890\" link_only=\"no\"]
Where,
meeting_id
= Your meeting ID.link_only
= Show only link or not. Change to \"yes\" instead of \"no\" to show link onlyYour frontend page should look like:
"},{"location":"shortcode/#2-show-a-meeting-post-with-countdown","title":"2. Show a meeting post with Countdown","text":"Use: [zoom_meeting_post post_id=\"\" template=\"none\" description=\"true\" countdown=\"true\" details=\"true\"]
Where,
post_id
= Zoom Meeting post ID.template
= \"boxed\" - changing to boxed will show meeting with timer.description
= \"false\", default is true. This will hide description field.countdown
= \"false\", default is true. This will hide countdown.details
= \"false\", default is true. This will hide detail and join links. If you just want to hide details field, you can do so with CSS.Use: [zoom_list_meetings per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" cols=\"3\"]
Where,
NOTE: This was added in version 3.3.4 so, old meetings which were created might need to be updated in order for this shortcode to work properly.
"},{"location":"shortcode/#4-list-upcoming-or-past-webinars","title":"4. List Upcoming or Past Webinars","text":"Use: [zoom_list_webinars per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" cols=\"3\"]
Where,
Use: [zoom_list_host_meetings host=\"YOUR_HOST_ID\"]
Where,
host
= Your HOST ID where you can get from wp-admin > Zoom Meeting > Users = User IDNOTE: Added from version 3.3.10. This will list all past and upcoming 300 meetings related to the defined HOST ID.
"},{"location":"shortcode/#6-show-specific-webinar-detail","title":"6. Show Specific Webinar Detail","text":"Use: [zoom_api_webinar webinar_id=\"YOUR_WEBINAR_ID\" link_only=\"no\"]
Where,
meeting_id
= Your Webinar ID which you want to show NOTE: Added in version 3.4.0
"},{"location":"shortcode/#7-show-list-of-webinars","title":"7. Show List of Webinars","text":"Use: [zoom_list_host_webinars host=\"YOUR_HOST_ID\"]
Where,
host
= Your HOST ID where you can get from wp-admin > Zoom Meeting > Users = User ID NOTE: Added from version 3.4.0
"},{"location":"shortcode/#8-embed-zoom-meeting-in-your-browser","title":"8. Embed Zoom Meeting in your Browser","text":"This section has been moved to another page
"},{"location":"shortcode/#9-show-recordings-based-on-host-id","title":"9. Show recordings based on HOST ID.","text":"Show recordings list in frontend based on host ID.
Usage: [zoom_recordings host_id=\"YOUR_HOST_ID\" downloadable=\"yes\"]
Where,
host_id
: YOUR HOST ID.downloadable
: Default is set to false. If you want your users to be able to download your recordings.Show recordings list based on your meeting ID
Usage: [zoom_recordings_by_meeting meeting_id=\"1234567890\"]
Where,
meeting_id
: YOUR MEETING ID to pull.With new version, its possible to override the display of output from default plugin layout. You can do so by following method.
wp-admin/plugins/video-conferencing-with-zoom-api/templates/shortcode
folderyourtheme/video-conferencing-zoom/shortcode/zoom-shortcode.php
From version 3.4.0 - Plugin is fully compatible with Elementor modules as well Gutenberg Blocks.
"},{"location":"support/","title":"Support","text":"Support for this plugin is free! If you encounter any issues or have any queries please use the support forums. We will reply to you at the earliest possible.
"},{"location":"support/#premium-support-ticket-for-premium-users","title":"Premium Support Ticket for premium users","text":"Create a ticket or view if your queries are already answered in Support forum.
"},{"location":"support/#facebook-group","title":"Facebook Group","text":"Join our facebook group which we have created in order to stay up to date with updates and common issues faced. Join here
"},{"location":"template_override/","title":"Template Override","text":"Overriding the template means to change the layout of how the content is displayed in frontend.
"},{"location":"template_override/#overriding-the-parent","title":"Overriding the Parent","text":"Video conferencing with zoom api
main plugin templates folder.public_html/wp-content/plugins/video-conferencing-with-zoom-api/templates/
folder.To override, copy files from public_html/wp-content/plugins/video-conferencing-with-zoom-api/templates/
folder to public_html/wp-content/yourtheme/video-conferencing-zoom/
folder.
Check out the video documentation if you want to see basic live demo on Template Overrides.
"},{"location":"template_override/#content-not-showing","title":"Content not showing?","text":"If you are facing an issue with content not being shown on your single meetings page i.e yourwesite/zoom-meetings/your-meetings page then follow below steps:
Like said above, you'll need to find out the div structure from your theme. You can do so by going to your yoursite.com/zoom-meetings/yourmeetings-page > Right Click > Click on inspect. Check what your theme is outputting in other pages of your site
You Should see below image on your screen now.
Match the classes accordingly in the file content-single-meeting.php now. Replacing the \"dpn-zvc-single-content-wrapper dpn-zvc-single-content-wrapper-<?php echo get_the_id(); ?>\"
usually does the trick !!
Hope this helps !
You're Done !
You can change the layout of the pages anyway you want.
"},{"location":"vanity_url/","title":"Vanity URL","text":"Vanity URL is a way to change your zoom links from the default one. This is a case when you as a user have purchased a custom URL in zoom to join or start your meetings.
Read Here for more details https://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-Requests
"},{"location":"vanity_url/#basic-usage","title":"Basic Usage","text":"In the settings page, you will find an option called \"Vanity URL
\".
** Changing or adding new values in the \"Vanity URL\" field will change the way how links are displayed on frontend.**
"},{"location":"vanity_url/#example","title":"Example","text":"example.zoom.us/j/12312321
instead of the default zoom.us/j/1232321
zoom.us/j/21321
linkEasy right ?
"},{"location":"vczapi-pro/","title":"Video Conferencing with Zoom Pro","text":""},{"location":"vczapi-pro/#introduction","title":"Introduction","text":"Provides:
Please refer to Zoom Documentation to learn a bit more :
https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-
;
Use Personal Meeting ID instead of an automatically generated meeting ID. It can only be used for scheduled meetings, instant meetings and recurring meetings with no fixed time.
"},{"location":"vczapi-pro/#recurring-meetings","title":"Recurring Meetings:","text":"Recurring Meetings are meetings that can be set to repeat over a course of time. We have provided the option of Occurrence to set the number of occurrences from 1 - 20 for a meeting.
Recurring Meetings can have a maximum of 20 occurrences
"},{"location":"vczapi-pro/#meeting-join-links","title":"Meeting Join Links:","text":"A Zoom Meeting Join Link for any recurring meeting created via these methods will always be the same. That is meeting links will not change for each occurrence.
"},{"location":"vczapi-pro/#how-to-set-a-recurring-meeting","title":"How to set a recurring meeting:","text":"Below we outline the various ways recurring meetings can be set
"},{"location":"vczapi-pro/#recurring-meeting-options","title":"Recurring Meeting Options","text":"There are various options tp set a recurring Meeting:
These meetings can be scheduled on a daily basis or with a time difference of once every 3 days - this allows the user to select a time range between 1 - 3 days. An example can be if a user schedules a meeting for August 1 and keeps a gap of 3 days then the next occurrence of the meeting would be on August 4
"},{"location":"vczapi-pro/#weekly","title":"Weekly","text":"Meetings can be scheduled per a weekly basis - you would need to select the day of the week and how many occurrences ( 1 - 20 ). The first occurrence will be the day of the week (sun - friday) according to the meeting start date selected - the rest will follow suit. You can choose how frequently a meeting can be repeated i.e once every week or once every ( 2 - 12 ) weeks.
For example if you select Start Date: August 2, 2020 - 5:00PM as the start date Occurrences: 3
Day of the week: Sunday\nRepeat: Every 1 week\n
Then the dates for meeting will be:
August 2, 2020 - Sunday\nAugust 9, 2020 - Sunday\nAugust 16, 2020 - Sunday\n
However, please note if you select July 29, 2020 as the start date i.e your selection is as follows:
Start Date: July 29th, 2020 (Thursday)\nDay of the week: Sunday\nOccurrences: 3\nRepeat Every 1 week\n
Then the dates for the meetings will be same i.e:
August 2, 2020 - Sunday\nAugust 9, 2020 - Sunday\nAugust 16, 2020 - Sunday\n
"},{"location":"vczapi-pro/#monthly","title":"Monthly","text":"You can select - Meeting Frequency / Repeat Every : ( 1 - 3 ) months
Occurs on:
This is for a always available meeting - this meeting will be always available for any user that has access to it.
Note: Meeting needs to be started by Host - otherwise user will be on standby,
"},{"location":"vczapi-pro/#registration","title":"Registration","text":""},{"location":"vczapi-pro/#prerequisites","title":"Prerequisites:","text":"To enable Registration on Meetings requires a paid Zoom plan https://zoom.us/pricing as of the writing of this document ( July 29th 2020 ) this means at least a Pro user account.
Excerpt taken from Zoom: https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings
Scheduling a meeting that requires registration will allow participants to register with their e-mail, name, other questions, and custom questions. You can also generate meeting registration reports if you want to download a list of people that registered.
Note: Participants joining meetings with registration, must use the Zoom desktop client or mobile app. They will not be able to join using the web client. \u201c
One thing to Note is that Registered users will be required to login from their Zoom Apps - they will not be able to join via browser / web client.
"},{"location":"vczapi-pro/#how-to-enable-registration-on-a-meeting","title":"How to Enable Registration on a Meeting:","text":"Registration can be enabled on a meeting by ticking the box marked \u201cRegistration\u201d. This will enable unique join links for each user that has registered and the link will be sent via Zoom if not explicitly turned off.
"},{"location":"vczapi-pro/#register-without-login","title":"Register Without Login:","text":"This option dictates if a user needs to be logged into the site ( WordPress site ) to be able to register.
"},{"location":"vczapi-pro/#registration-flow","title":"Registration Flow","text":"Any user (visitor / customer) who visits the Meeting page will be shown a register now button
"},{"location":"vczapi-pro/#register-now-call-to-action","title":"Register Now - Call to Action","text":""},{"location":"vczapi-pro/#registration-form","title":"Registration Form","text":"Once user clicks register now - they will be taken to the registration form page:
"},{"location":"vczapi-pro/#registration-e-mail","title":"Registration E-mail","text":"Once the registration form is filled - user will be registered to the meeting and if enabled setting ( Zoom Meetings > Settings > PRO ) user will receive a confirmation e-mail - this is optional as Zoom does send confirmation e-mail to registered user as well - but we have provided options to customize this e-mail.
Registration E-mail content can be change via the E-mail tab on ( Zoom Meetings > Settings > PRO )
Registration E-mail Sample:
"},{"location":"vczapi-pro/#calendar-widget","title":"Calendar Widget","text":""},{"location":"vczapi-pro/#default-use","title":"Default Use","text":"
By using the shortcode [vczapi_zoom_calendar] - you can show a calendar that shows all meetings and webinars that are under \"Zoom Meetings > All Meetings\" If a meeting is clicked - it will show you more of the events details.
Use: [vczapi_zoom_calendar author=\"\" show=\"\" calendar_default_view=\"dayGridMonth\" show_calendar_views=\"yes\" category=\"all\"]
Where,
category=\"category-slug\"
or comma separated category=\"category1,category2\"
Simply create a Zoom Recurring Meeting and then enable purchase of the product. You can use follow the same steps as here : https://zoomdocs.codemanas.com/woocommerce/#1-product-linked-with-zoom-meeting or if you want a more visual representation please check out the video https://www.youtube.com/watch?v=V6SfMFatOH8
Once a recurring Product is Purchased - the customer if logged in will be able to view the meeting details on their my accounts > meetings https://examplle.com/my-account/wc-zoom-meetings/ Only the next occurrence of meeting will be shown here, To see all occurrences you will need to go the meeting details page:
Meeting Detals on My Account Page :
Recurring Meeting Details :
"},{"location":"vczapi-pro/#meeting-registration-woocommerce","title":"Meeting Registration + WooCommerce","text":"Once a meeting has been created with registration enabled and linked with a WooCommerce product - the flow of registration slightly differs from basic registration. Users will not be directed to the registration - rather the WooCommerce checkout process will continue as normal. The Billing Email Address and Billing First Name and Last Name used during the checkout process will be used to register the user to the meeting.
"},{"location":"wcfm/","title":"WCFM (Addon)","text":"This Addon is for WCFM \u2013 Frontend Manager for WooCommerce you can get it here.
"},{"location":"wcfm/#zoom-integration-for-woocommerce","title":"Zoom Integration for WooCommerce","text":""},{"location":"wcfm/#introduction","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and WCFM. This addon allows vendors to create and manage Zoom Meeting Products from the front end.
"},{"location":"wcfm/#demo-video","title":"Demo Video","text":""},{"location":"wcfm/#prerequisites","title":"Prerequisites","text":"After successfully installing all the required plugins. If you login as a vendor - you will be first shown a Zoom Meeting section on the WCFM dashboard.
Please see instructions for normal products Zoom Integration for WooCommerce
"},{"location":"wcfm/#introduction_1","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and Bookings and WCFM. This addon allows vendors/shop owners to create bookable products and create a zoom meeting when a booking is made.
"},{"location":"wcfm/#prerequisites-for-bookable-product","title":"Prerequisites for Bookable Product:","text":"Once all the required plugins are installed and activated. The ability to enable Zoom Meetings for Bookable Products will be available.
When you select bookable product via the WCFM frontend interface
"},{"location":"wcfm/#_1","title":"WCFM (Addon)","text":"You will see a new Zoom Setting Tab for the Bookable Product.
For detailed information on how Bookings and Zoom for WooCommerce and Bookings will work please see Zoom for WooCommerce Bookings
"},{"location":"wcfm/#zoom-integration-for-woocommerce-appointments","title":"Zoom Integration for WooCommerce Appointments","text":""},{"location":"wcfm/#introduction_2","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and WooCommerce Appointments and WCFM. This addon allows vendors/shop owners to create appointable products and create a zoom meeting when an appointment is made.
"},{"location":"wcfm/#prerequisites-for-bookable-product_1","title":"Prerequisites for Bookable Product:","text":"Once all the required plugins are installed and activated. The ability to enable Zoom Meetings for Appointable Products will be available.
When you select Appointable product via the WCFM frontend interface:
"},{"location":"wcfm/#_2","title":"WCFM (Addon)","text":"You will see a new Zoom Setting Tab for the Appointable Product.
For detailed information on how Bookings and Zoom for WooCommerce Appointments will work please see Zoom for WooCommerce Appointments
"},{"location":"webhooks/","title":"WebHooks","text":"PLEASE READ: Webhook feature is currently in beta stage. So, we are gathering your feedbacks. Currently, only certain events are allowed to be used. We'll increase this as time goes by.
"},{"location":"webhooks/#what-is-web-hook","title":"What is Web Hook ?","text":"Zoom utilizes webhooks as a medium to notify this plugin (consumer application) about events that occur in a Zoom account. Instead of making repeated calls to pull data frequently from the Zoom API, you can use webhooks to get information on events that happen in a Zoom account.
In simple terms, webhook functionality can be used to notify your WordPress site to do something when a certain event is triggered in Zoom website. For example: if a user creates a meeting in Zoom website, it will be automatically created on your WordPress site as well.
"},{"location":"webhooks/#requirements","title":"Requirements","text":"This requires PRO version of Video Conferencing with Zoom plugin.
Some Events might need a Zoom PRO account as well. For example webinars, recurrings and PMI features.
This section assumes that you have successfully setup Server-to-Server Oauth and credentials have been added and successfully connected to your WordPress site. If you have not created Server-to-Server OAuth yet then please visit this tutorial.
Copy Secret Token Key.
After that click on Add new Event Subscription button - to complete the steps you will first need to go to your WordPress admin panel and see the step described below
Enter your Subscription name to anything you want, and add the Event Notification endpoint URL like:
https://yoursite.com/wp-json/vczapi/v1/meeting - Replace https://yoursite.com with your site url. Complete url would be something like
https://yoursite.com/wp-json/vczapi/v1/meeting
Goto wp-admin > Zoom Meetings > Settings > Webhooks
Each endpoint for certain events are defined in this page. All you need to do is copy it from here to Zoom side. See below for where to copy these URLs.
"},{"location":"webhooks/#automate-meeting-flow","title":"Automate Meeting Flow","text":"\"Meeting has been created\", \"Meeting has been updated\", \"Meeting has been deleted\"
Goto Webinars
Select 3 events which are \"Webinar has been created\", \"Webinar has been updated\", \"Webinar has been deleted\"
Please note that choosing any additional events will not work.
"},{"location":"webinars/","title":"Webinars","text":""},{"location":"webinars/#requirements","title":"Requirements","text":"In order to use this functionality, your Zoom Account must be eligible with Zoom Webinars plan. Without Webinar enabled from Zoom side you cannot use this functionality. See Zoom Pricing
"},{"location":"webinars/#basic-information","title":"Basic Information","text":"From version 3.6.0 you can now create Webinars as post type which means that you can bind your Zoom Webinars to your WordPress posts and show them in frontend accordingly.
"},{"location":"webinars/#how-to-create-a-webinar","title":"How to create a Webinar ?","text":"To create webinars from your site.
You should see above type of page on your side. Choose Webinar in meeting type and create the meeting. Your meeting now should be a Zoom Webinar.
"},{"location":"webinars/#showing-webinars-via-shortcode","title":"Showing Webinars via Shortcode","text":"You can show your individual webinars via shortcode or from single post type page. To show your webinar via shortcode refer to this section.
"},{"location":"woocommerce-appointments/","title":"WooCommerce Appointments (addon)","text":"This Addon is for WooCommerce Appoitments Plugin it acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce-appointments/#prerequisite","title":"Prerequisite","text":"Zoom for WooCommerce Appointments allows you to automate your zoom meetings directly from your WordPress dashboard by linking zoom meetings to an appointment made via an appointable plugin using WooCommerce Appointments plugin. Users will receive join links in their Appointment confirmation emails. Admin can directly start meetings from wp-admin > Appointments list page.
"},{"location":"woocommerce-appointments/#demo-video-of-implementation","title":"Demo Video of Implementation","text":"Implementaion of the plugin video above.
"},{"location":"woocommerce-appointments/#features","title":"Features","text":"Below are few features listed.
"},{"location":"woocommerce-appointments/#create-automated-zoom-meetings-without-configurations","title":"Create Automated zoom meetings without configurations","text":"With this plugin, your zoom meeting creation is automated. A zoom meeting is created once an Appointment is made from the customer side. It happens automatically with minimal configurations.
"},{"location":"woocommerce-appointments/#configure-you-appointable-product","title":"Configure you Appointable Product","text":"When you create an Appointable product, you will need to Enable Zoom Meeting and assign a host(if multiple hosts are available you can choose which one to assign).
"},{"location":"woocommerce-appointments/#join-links-and-start-links-in-email-as-well-as-your-frontend-my-account-section","title":"Join links and start links in email as well as your frontend my-account section.","text":"After an Appointment is either confirmed or paid for (depending on the settings). Users will be able to join their Appointments from email link. Zoom meeting will be included in the Appointment email as well as inside the users my-account > appointments frontend table section.
My Accounts > Appointments
Order Complete Email
"},{"location":"woocommerce-appointments/#assign-staff-host-id","title":"Assign Staff Host ID","text":"You can assing your staff with a host ID (if you have multiple Zoom Users under your account). Once a Zoom User is assigned to a staff - all Appointments created with that host selected will create meetings using that user i.e. the meeting will come under their Zoom Meetings. (if you are still unclear please refer to our video above)
"},{"location":"woocommerce-booking/","title":"WooCommerce Bookings (Addon)","text":"This Addon is for WooCommerce Booking Plugin which acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce-booking/#prerequisite","title":"Prerequisite","text":"Zoom Integration for WooCommerce Booking allows you to automate your zoom meetings directly from your WordPress dashboard by linking zoom meetings to your WooCommerce Booking products automatically when a Booking Product is created. Users will receive join links in their booking confirmation emails. Admin can directly start meetings from wp-admin > Bookings list page.
"},{"location":"woocommerce-booking/#demo-video-of-implementation","title":"Demo Video of Implementation","text":"Implementaion of the plugin video above.
"},{"location":"woocommerce-booking/#how-to-link-meetingswebinar-to-booking-product","title":"How to link meetings/webinar to booking product?","text":"Note: You must either select hour(s) or minute(s) only otherwise the meeting/webinar won't be created.
Now, your users should be able to book from the frontend.
"},{"location":"woocommerce-booking/#features","title":"Features","text":"Below are few features listed.
"},{"location":"woocommerce-booking/#create-automated-zoom-meetings-without-configurations","title":"Create Automated zoom meetings without configurations","text":"With this plugin, your zoom meetings are automated when a booking product is booked. A zoom meeting is created once a booking is booked from a customer side. It happens automatically without any configurations.
"},{"location":"woocommerce-booking/#manually-select-which-host-to-assign-for-the-booking","title":"Manually Select which host to assign for the Booking","text":"When you create a booking product, you'll be able to select which host to assign that booking product so that the host can manually start the meeting when a booking is booked.
"},{"location":"woocommerce-booking/#join-links-and-start-links-in-email-as-well-as-your-frontend-my-account-section","title":"Join links and start links in email as well as your frontend my-account section.","text":"After a booking is done. Users will be able to join their bookings from email link. Zoom meeting will be included in the booking email as well as inside the users my-account > bookings frontend table section.
"},{"location":"woocommerce-booking/#product-vendors-support","title":"Product Vendors Support","text":"Zoom for WooCommerce Bookings supports Product Vendors since version 2.1.7 . Each vendor can be assigned a Zoom User / Host ID. When the vendor creates a Booking Product the host is automatically selected based on which host they have been assigned.
Note: The host(s) need to be under the Zoom account that has been configured - this is a paid Zoom feature. Assign Zoom Host To assign Zoom Host to a Vendor. Goto Products > Zoom Vendors here you will be shown a screen of available vendors and ability to assign a host to them.
Once Zoom host is assigned to vendor. When the vendor in question when creates a Bookable Product - the selected Host will be used to create the Zoom Meeting.
"},{"location":"woocommerce-product-vendors/","title":"WooCommerce Product Vendors (Addon)","text":"With the release of version 2.1.0 for WooCommerce Integration with Zoom plugin, It will now support Requirements
Please note: that to do this you'll need to add multiple hosts to your Zoom Account. You can do this from Users section on your Zoom Account.
If you have not added other users to your Zoom Account then only your name will show up.
Now goto wp-admin > Products > Zoom Vendors page.
From the above table. Select your Vendor and which Zoom Account you would like to assign for that vendor.
"},{"location":"woocommerce-product-vendors/#what-happens-after-vendor-with-zoom-account-is-linked","title":"What happens after Vendor with Zoom Account is Linked ?","text":"So, recommended way is to link a Zoom Account for Every Vendor everytime.
"},{"location":"woocommerce/","title":"WooCommerce (Addon)","text":"This Addon is for WooCommerce Plugin which acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce/#purpose","title":"Purpose","text":"There are 2 ways you can create a Zoom Product
In this method - you can create a normal WooCommerce Product and simply connect it to a Zoom Meeting.
Let's take an example of a Simple Product Type
Create a product as you normally would then you will see the Zoom Connection tab on the product tabs
After clicking the Zoom Meeting tab, you can see the Enable Zoom Connection Checkbox. Checking this box will allow to link this product to a Zoom Meeting. Please note the meeting needs to be created first via Zoom Meeting > All Meetings
.
After ticking Enable Zoom Connection - you will see further options:
You can link to Zoom Meeting by searching - after a meeting has been selected it's meeting details will be shown.
Now when the product is purchased - the customer will get the option to join the meeting. They will see this in:
This method should be used to link Zoom Meeting with a Product. The product created using this method will not be shown on shop and search pages. The meeting created using this method is designed to be directly purchased via the zoom meeting single page. See image below.
"},{"location":"woocommerce/#how-to-create-a-zoom-meeting","title":"How to create a Zoom Meeting","text":"From version 2.6.0 the ability to sell recording was added to Zoom Integration for WooCommerce. The steps are very similar to selling meetings, but instead of meetings recordings are being sold.
To do this go to Products > Add New and create a simple virtual product as you would do for a normal woocommerce product, then go to Zoom Connection tab which should look like the following.
We then need to select the host / year and month when the recording took place, and click get recordings. This will retrieve the list of recording for that month. You can then add multiple recordings to be associated with this product.
Now save the product and once the user purchases the product - the recording links will be sent to them after purchase has been completed.
"},{"location":"woocommerce/#shortcode","title":"Shortcode","text":"[vczapi_wc_show_purchasable_meetings per_page=\"10\" type=\"table\" order=\"DESC\" upcoming_only=\"no\"]
This allows you to show your purchasable meeting lists. Show in DESC or ASC format as well as show upcoming only or not.
"},{"location":"woocommerce/#parameters","title":"Parameters:","text":"per_page:
Allows you to define how many list to show per page.type
: Allows you to show the list in table format or boxed format. Change to type=\"boxed\"
to show in boxed formatorder
: Show list in ASC
or DESC
formatupcoming_only
: Show only upcoming meetings based on start time or show all list. Change to \"yes\" for upcoming onlyMeeting email reminders can be configured from Zoom > WooCommerce > Email tab. You can either choose to send emails 24 hours before the meeting or 3 hours before.
"},{"location":"woocommerce/#meeting-reminder-worklow","title":"Meeting Reminder Worklow:","text":"Video conferencing with zoom api
\"OR
OR
Download Plugin from WordPress.org repository.
"},{"location":"#about-plugin","title":"About Plugin","text":"Simple plugin which gives you the extensive functionality to manage zoom meetings, webinars, recordings, users, reports from your WordPress Dashboard. Now, with capability to add your own post as a meeting. Create posts as meetings directly from your WordPress dashboard to show in the frontend as a meeting page. Allow users to directly join via that page with click of a button.
"},{"location":"#video-documentation","title":"Video Documentation","text":"Sorry for the fan noise in the video !
"},{"location":"#compatibility","title":"Compatibility","text":"This allows you to link your Users to your WordPress site using the get_user_meta
function. The purpose is to reduce the need to select a host each time a new meeting is created. So, that in the case of allowing to create meetings via multiple existing users ( for example admin 1 and admin 2) they won't get confused on which host to select.
define(\"VIDEO_CONFERENCING_HOST_ASSIGN_PAGE\", true);
into your wp-config.php file to enable this menu in wp-admin side.
After completing the setup process, you should see a new option on your wp-admin portal called \"Host to WP users\". Like show below:
Goto this page and link a Zoom host to your desired WordPress user.
"},{"location":"assign_host/#how-it-works","title":"How it Works?","text":"After you link the Host to WP user - When trying to create the meeting that user will only see the details that is linked to that account. This way it won't confuse your users and they won't have to choose a host everytime they create a meeting/webinar.
"},{"location":"blocks/","title":"Blocks","text":""},{"location":"blocks/#introducing-zoom-zoom-blocks","title":"Introducing Zoom - Zoom Blocks:","text":"Easily and Conveniently add features to your site - using the Zoom Blocks. All Zoom - blocks are under the Zoom Category:
"},{"location":"blocks/#types","title":"Types:","text":"Search for List Zoom Meeting while entering the block. Will allow you to list either Meetings or Webinars that are already available on your site. (From WordPress Created or imported to WordPress)
Settings:
Example Output:
Equivalent Shortcodes:
Show live - Zoom Meetings or Webinars directly from Zoom (not from WordPress).
Settings: ;
Example Output:
Equivalent Shortcodes:
Show a Zoom Meeting/Webinar directly from Zoom:
Settings:
Example Output:
Equivalent Shortcodes:
Embed a Zoom Post(Posts are either created or imported into WordPress).
Settings:
Example Output:
Equivalent Shortcodes:
Show Recordings either by Host or By Meeting
Settings:
Example Output:
Equivalent Shortcodes:
This guideline will teach you on how to integrate Zoom Meetings with Booked Appointment Plugin by BoxyStudio
Please note: CodeManas is not affiliated with Booked Appointment Plugin by BoxyStudio
We have this guideline on implementing our Zoom Meetings for Booked Appointments with Booked - Appointment Booking for WordPress.
"},{"location":"booked-appointments/#requirements","title":"Requirements","text":"Setting up Booked plugin and more options for Booked plugin should be followed from Booked official site directly.
"},{"location":"booked-appointments/#creating-and-linking-a-meeting-to-product-first","title":"Creating and Linking a Meeting to Product First","text":"After you install all the requirements goto your WooCommerce Product page in your wp-admin > Products > Add New
New Product Test Appointment
\" to the product.Zoom
tab in product edit page.Booked Appointment Service
Enable Zoom Meting
.Guessing that you have set your appointment times and setup everything related to Booked plugin.
To link your meetings with Booked Plugin, follow below instructions:
For this demo i have added New Product Test Appointment as product name but for yours will be different probably. Something like Appointment for 1:00pm to 2:00pm /w Dr. Josh etc. For each timeslots you'll need to create different product and meetings.
Thats it ! After you linked these fields. Your Zoom Meetings is linked with your Product.
"},{"location":"booked-appointments/#preparing-zoom-meeting-link-for-emails","title":"Preparing Zoom Meeting link for Emails","text":"Follow below steps to include join links in default Booked Appointments emails.
You should see below two points added in the description section.
%zoom_meeting_link% \u2014 Display the appointment\u2019s Zoom App Link. %zoom_meeting_browser_link% \u2014 Display the appointment\u2019s Zoom Join via Browser Link.
Add these above texts accordingly to show the zoom join link as well join via browser link and they should show up in your confirmation emails.
"},{"location":"booked-appointments/#how-will-users-receive-join-links","title":"How will users receive join links ?","text":"At the moment - If you have kept your bookings to be Auto Approved they will receive join links in email. Othewise, you'll have to use [booked-appointments] shortcode to show.
It would be like like so:
"},{"location":"booked-appointments/#guidelines-on-booked-support","title":"Guidelines on Booked Support","text":"https://boxystudio.ticksy.com/article/3820/ - Linking WooCommerce Product to your Appointment and How WooCommerce works.
"},{"location":"date_types/","title":"Change DateTime","text":"To adjust your date preference when showing different times in frontend via shortcode or direct from your Post type meeting page, this plugin offers you to change date format according to your locale or your preference.
"},{"location":"date_types/#change-date-and-time-formats","title":"Change Date and Time formats","text":"To change the hour format or month label type.
Thats it ! You should see your preferred date time formats in frontend now for the Zoom Meeting shortcodes as well as for single post type meeting page.
"},{"location":"dokan/","title":"Dokan Integration for Zoom (Addon)","text":"This Addon is for Dokan you can get it here.
"},{"location":"dokan/#prerequisite","title":"Prerequisite","text":"Dokan Integration for Zoom acts as a glue plugin for Zoom integration for WooCommerce or Zoom Integration for WooCommerce Bookings and Dokan. This addon allows vendors to create and manage Zoom Meeting Products from the front end.
"},{"location":"dokan/#instructions","title":"Instructions","text":"After successfully installing all the required plugins. If you log in as a vendor - you will be first shown a Zoom Meeting section on the Dokan dashboard.
At the moment it is not possible for vendors to add their own Zoom Account - they have to be added under the admins Zoom Account. The admin of the site or the account used to connect to Zoom on the site should be a paid account. Only then will the site admin be able to add users under their Zoom account. This becomes useful when you want your vendors to be able to use different zoom accounts.
By default, Vendors will be able to select all the hosts under a Zoom Account. If you want the vendors to be only be able to create meetings with a particular Host then you will need to go to Zoom Meetings > Dokan Vendors
"},{"location":"dokan/#woocommerce-booking-integration","title":"WooCommerce Booking Integration","text":""},{"location":"dokan/#prerequisites","title":"Prerequisites","text":"These plugins are required before Zoom can be enable with Dokan + WooCommerce Bookings.
After all of the required plugins are installed. Vendors will now see a new field when creating their Bookable Products. Enabling Zoom Meeting here for a product will create a Zoom Meeting when the bookable product is booked. For more information of how it works please check out Zoom Integration for WooCommerce Bookings Documentation.
"},{"location":"faq/","title":"FAQ","text":""},{"location":"faq/#join-via-browser-signature-in-invalid-or-connection-timeout","title":"Join via Browser Signature in Invalid or Connection Timeout.","text":"In this case please check your SDK app type credential are valid and activated. Please note that the app type must be activated. You can also check if all the api credential values are correct.
If everything is ok on your side, reach out to us with your site details as this issue can not be debugged without looking at the code.
"},{"location":"faq/#embedded-join-via-web-browser-issues","title":"Embedded Join via Web Browser Issues","text":"Few of the known issues when using embed join via web browser i.e only when used with embed join via browser shortcode or Join via Browser gutenberg Block.
Above issues are caused due to the use of IFRAME html component. Currently, these issues are unsolvable so, please use this feature at your own risk i.e embed join via browser shortcode or Join via Browser gutenberg Block.
Also, note: These above issues does not affect for normal join via web browser pages.
"},{"location":"faq/#zoom-pro-plans","title":"Zoom Pro Plans","text":"If you are subscribed to Zoom PRO plans you have more benefits for your meetings as well as webinars you host. So, its worth checking out Zoom plans here https://zoom.us/pricing
Subscribing to PRO plans will only benefit your Zoom Account however, this plugin can be used for FREE ACCOUNT users as well.
"},{"location":"faq/#add-users-not-working-for-me","title":"Add users not working for me","text":"The plugin settings allow you to add and manage users. But, you should remember that you can add users in accordance with the Zoom Plans, so they will be active for the chosen plan. More information about Zoom pricing plans you can find here: https://zoom.us/pricing
"},{"location":"faq/#join-via-browser-not-working-camera-and-audio-not-detected","title":"Join via Browser not working, Camera and Audio not detected","text":"This issue is because of HTTPS protocol. You need to use HTTPS to be able to allow browser to send audio and video.
"},{"location":"faq/#blank-page-for-single-meetings-page","title":"Blank page for Single Meetings page","text":"If you face blank page in this situation you should refer to Template Overriding and see Template override section.
This happens because of the single meeting page template from the plugin not being supported by your theme and i cannot make my plugin support for every theme page template because of which you'll need to override the plugin template from my plugin to your theme's standard. ( Basically, like how WooCommerce does!! )
"},{"location":"faq/#countdown-not-showing-guess-is-undefined-error-in-my-console-log","title":"Countdown not showing/ guess is undefined error in my console log","text":"If countdown is not working for you then the first thing you'll nweed to verify is whether your meeting got created successfully or not. You can do so by going to wp-admin > Zoom Meetings > Select your created meeting and on top right check if there are \"Start Meeting\", \"join Meeting links\". If there are those links then, you are good on meeting.
However, even though meeting is created and you are not seeing countdown timer then, you might want to check your browser console and see if there is any \"guess is undefined\" error. If so, there might be a plugin conflict using the same moment.js library.
"},{"location":"faq/#how-to-show-zoom-meetings-on-front","title":"How to show Zoom Meetings on Front","text":"See https://zoomdocs.codemanas.com/shortcode/#6-embed-zoom-meeting-in-your-browser section.
"},{"location":"filters_hooks/","title":"Filter Hooks","text":"This page shows you the few filters you can use in this plugin. I won't go in full detail here but yes there are few filters which you can extend this plugin into yours.
How to use ?
add_filter('vczapi_hook', function($data) { return $data; });
add_filter('vczapi_api_redirect_join_browser', function() { return 'https://yoursiteurl.com/page'; });
Add below to your functions.php file in your theme. Change \"your-slug-name\" to the slug you want. Then flush your permalink from wp-adming > settings > permalink and save.
View Implementation
"},{"location":"filters_hooks/#join-via-browser-show-fields","title":"Join via browser show fields","text":"If you want to show extra fields or hide them, add below code to your functions.php in your theme.
add_filter('vczapi_api_join_via_browser_params', 'vczapi_jvb_fields');\nfunction vczapi_jvb_fields( $fields ) {\n $fields = [\n 'meetingInfo' => [\n 'topic',\n 'host',\n #'mn',\n #'pwd',\n #'telPwd',\n #'invite',\n #'participant',\n #'dc',\n #'enctype',\n #'report'\n ],\n 'disableRecord' => false,\n 'disableJoinAudio' => false,\n 'isSupportChat' => true, //Enable or disable chat\n 'isSupportQA' => true, //Enable or disable QA\n 'isSupportBreakout' => true, //Enable or disable breakout rooms\n 'isSupportCC' => true, //Enable or disable CC\n 'screenShare' => true //Enable or disable Screenshare\n ];\n return $fields;\n}"},{"location":"filters_hooks/#automatically-allow-users-to-join-meeting-from-browser","title":"Automatically allow users to join meeting from browser","text":"
This below code allows you to redirect your users to meeting without needing to click join button manually.
Please NOTE: If user is not logged in, this code will not work because when joining a meeting from browser - User name is a required field and since this below code directly triggers the join button on load. Users will not be able to join the meeting without a name.
The reason this would work with logged in users is because username is already selected in the join via browser page if a user is logged in.
View Implementation
"},{"location":"filters_hooks/#show-cutom-roles-in-host-to-wp-page","title":"Show cutom roles in \"HOST TO WP\" page.","text":"View Implementation
"},{"location":"filters_hooks/#before-create-a-zoom-user","title":"Before Create a Zoom User","text":"apply_filters( 'vczapi_createAUser', $data );
Usage: Used when doing API call for creating a user on Zoom.
"},{"location":"filters_hooks/#before-listing-a-zoom-user","title":"Before Listing a Zoom User","text":"apply_filters( 'vczapi_listUsers', $data );
Usage: Used when doing API call for listing users from zoom.
"},{"location":"filters_hooks/#before-getting-a-zoom-user","title":"Before getting a Zoom User","text":"apply_filters( 'vczapi_getUserInfo', $data );
Usage: Used when doing API call for getting a specific HOST ID info.
"},{"location":"filters_hooks/#before-listing-a-meeting","title":"Before listing a meeting","text":"apply_filters( 'vczapi_listMeetings', $data );
Usage: Used when doing API call for getting list of meetings for a Zoom User.
"},{"location":"filters_hooks/#before-creating-a-meeting","title":"Before Creating a meeting","text":"apply_filters( 'vczapi_createAmeeting', $data );
Usage: Used when doing API call for posting your own data when creating a Meeting.
"},{"location":"filters_hooks/#before-updating-a-meeting","title":"Before Updating a meeting","text":"apply_filters( 'vczapi_updateMeetingInfo', $data );
Usage: Used when doing API call for posting your own data when updating a Meeting.
"},{"location":"filters_hooks/#before-getting-a-meeting","title":"Before Getting a meeting","text":"apply_filters( 'vczapi_getMeetingInfo', $data );
Usage: Used when doing API call for getting a meeting info.
"},{"location":"filters_hooks/#before-getting-daily-reports-data","title":"Before getting daily reports data","text":"apply_filters( 'vczapi_getDailyReport', $data );
Usage: Used when doing API call for when pulling in reports data.
"},{"location":"filters_hooks/#enable-gutenberg-support-for-zoom-meeting-edit-page-on-backend","title":"Enable Gutenberg Support for Zoom Meeting edit page on backend.","text":"Add below code to your functions.php file
add_filter( 'vczapi_cpt_show_in_rest', '__return_true' );
This functionality allows you to import your Zoom Meetings from your Zoom Account to your WordPress site if that meeting already does not exists on your site.
If you need to import recurring meetings and webinars, PRO VERSION plugin is required.
"},{"location":"import-meetings/#how-to","title":"How to ?","text":"NOTE: You can only import 10 meetings at a time. This is done to reduce API call usage and avoiding API call exhaustion on the server side.
Here below are the steps to integrate zoom plugin into WordPress. There are no complicated processes. Just the basic steps.
Check out the video documentation if you want to see live demo.
NOTE: if you recently getting an error called \"API_CREDENTIALS_NOT_FOUDN\" this is an error from zoom side. Please contact zoom support in this case.
"},{"location":"integration/#generating-api-keys-and-secret-keys","title":"Generating API keys and Secret Keys","text":"For this plugin you\u2019ll be using JWT token method to make the API connection. Please note, this method is only account level connection.
"},{"location":"integration/#first-step-choost-app","title":"First Step ( Choost App )","text":"First goto Create Page
Click on Develop on top of the page and build app page if you directly did not go into Create Page
Click JWT and \"Create\"
On the next screen you should see\u00a0Information, App Credentials, Feature and Activation menus
Fill in your basic information about the App.
On the\u00a0Credentials Page. Copy both API key and API Secret
\u00a0after you have filled all the details in information page.
Now, copy these credentials and go into WordPress\u00a0Zoom Meetings\u00a0settings page.
Click on Check API connection
button to check if your API connection is good !
Video Conferencing with Zoom plugin easily allows your users to join your meetings or webinars using Zoom's Native WebSDK WebSDK without needing to download Zoom App on your computer.
"},{"location":"join_links/#embed-or-join-via-browser-method","title":"Embed or Join via Browser Method","text":"This section shows you on how you can embed your meeting using a simple shortcode which allows your users to directly join your meeting/webinar.
If you are facing issues with this or your plugin version is below 3.9.0: Check out this section first for known issues.
"},{"location":"join_links/#shortcode-usage","title":"Shortcode Usage","text":"[zoom_join_via_browser meeting_id=\"YOUR_MEETING_ID\" login_required=\"no\" iframe=\"no\" title=\"Test\" height=\"500px\" disable_countdown=\"yes\" passcode=\"1232132121\" webinar=\"no\" image=\"https://images.unsplash.com/photo-1459257831348-f0cdd359235f\"]
Where,
meeting_id
: Your MEETING ID.login_required
: \"yes or no\", Requires login to view or join.iframe
: \"yes or no\", Show meeting or webinar in iframe element. This is not recommeded as there are known issues with this approach. Set this to \"no\" for more robust approach.title
: Title of your Embed Sessionheight
: Height of embedded video IFRAME.disable_countdown
: \"yes or no\", enable or disable countdown.passcode
: Set password of your meeting to automatically let users join without needing them to enter password.webinar
: \"yes\" for embedding webinars.image
: Image url for your post.You can edit elements from \"join via browser\" page by overriding template from \"plugins/video-conferencing-with-zoom-api/templates/shortcode/embed-session.php\".
Copy \"plugins/video-conferencing-with-zoom-api/templates/shortcode/embed-session.php\".
to \"wp-content/themes/yourtheme/video-conferencing-zoom/shortcode/embed-session.php\"
After that you can edit the file and change the contents according to your preference.
"},{"location":"join_links/#redirecting-after-completing-the-meeting-filter","title":"Redirecting after completing the meeting filter.","text":"To redirect user after a meeting fails, after completed or if meeting is not yet started; Add below code to your functions.php file in your theme and replace it with url you want to redirect:
add_filter('vczapi_api_redirect_join_browser', function() { return 'https://yoursiteurl.com/page'; });
Check this post as well to know more on direct browser join feature https://deepenbajracharya.com.np/joining-meetings-in-zoom-directly-from-browser/
"},{"location":"join_links/#additional-informations","title":"Additional Informations","text":""},{"location":"join_links/#how-join-links-work","title":"How join links work ?","text":"Join links allow users to join meetings easily from frontend. Check below screenshot on how its used in this plugin.
"},{"location":"join_links/#you-can-disable-join-links-as-well","title":"You can disable join links as well","text":"If you do not want to allow users to directly join via browser then you can disable that link from your posts page like shown in below screenshot.
"},{"location":"join_links/#browser-compatiblity","title":"Browser Compatiblity","text":"Mobile web browsers now supported Meeting SDK for Web v2.4.0 and higher supports the major Android and iOS browsers. Note that the Meeting SDK for Web on mobile browsers does not have complete feature parity with the Meeting SDK for Web on desktop browsers. Plugin currently uses webSDK higher than 2.4.0
Official Doc here
Chrome 69+Firefox 56+Safari 11+Edge 79+Gallery View(1)\u2718\u2718(1)Pause Recording\u2713\u2713\u2713\u2713Waiting Room\u2713\u2713\u2713\u2713Share Video\u2713\u2713\u2713\u2713Share Screen\u2713\u2713\u2718\u2713Join Computer Audio\u2713\u2713(2)\u2713Join Audio by Phone\u2713\u2713\u2713\u2713Meeting Host Controls\u2713\u2713\u2713\u2713View Shared Video\u2713\u2713\u2713\u2713View Shared Screen\u2713\u2713\u2713\u2713Request Remote Control\u2713\u2713\u2713\u2713In-meeting Chat\u2713\u2713\u2713\u2713Closed Captioning\u2713\u2713\u2713\u2713Webinar Q&A\u2713\u2713\u2713\u2713End-to-end encryption (E2EE) (3)\u2718\u2718\u2718\u2718Share computer audio(4)\u2718\u2718\u2718"},{"location":"join_links/#performance-limits","title":"Performance Limits","text":"Currently, the Zoom Meeting Web SDK encodes at a maximum resolution of 720p. See Web SDK 720p video for details. If a user is in a meeting with both native and browser clients, the browser client video displayed within the native client will be of lower quality due to encoding limitations.
"},{"location":"join_links/#loading-cdn-resources","title":"Loading CDN Resources","text":"From plugin version 3.6.2 users can now decide to load the webSDK resources directly from Zoom CDN.
To do this add below code to your config.php file.
define('VCZAPI_STATIC_CDN', true);
If incase, there is problem loading your join via browser page when using CDN. You can change the \"true\" value to \"false\".
"},{"location":"join_links/#known-issues-when-embedding-join-via-browser","title":"Known issues when embedding join via browser","text":"Below are some known issues when you use [zoom_join_via_browser iframe=\"yes\"] shortcode to embed your meeting into your site. Please note that these issues are not fixable at the moment so, if you are facing these issues - please avoid using [zoom_join_via_browser iframe=\"yes\"]
Check out the video documentation if you want to see live demo.
"},{"location":"meeting_types/#basic-information","title":"Basic Information","text":"Technically, every meeting created from the Video conferencing with zoom api plugin is live meetings meaning that it will be created on Zoom but, i have divided the term into two different categories:
"},{"location":"meeting_types/#post-type-meetings","title":"Post Type Meetings","text":"This is created when you create a new post from Zoom Meetings > Add New
page. These posts are related to your site and meetings created from here are binded to your site.
So, deleting any linked meeting without deleting the POST FIRST WOULD RESULT IN FAILURE TO JOIN MEETING FOR END USER !
This allows you to view your meeting by styling your frontend pages by overriding templates. See more on template override
section.
Basically, this will create a Meeting on your Zoom Account and a Post in your WordPress site which is linked. So, if you create a Meeting from here you'll be able to show a countdown timer in the frontend.
"},{"location":"meeting_types/#actual-live-meetings","title":"Actual Live Meetings","text":"This is created from page Zoom Meetings > Live meetings
section.
Meetings created from here are not binded to your site. This will create a meeting in your Zoom Account and will not create or add any additional data on your WordPress website. Everything will be fetched directly using the Zoom API.
If you want to show these meetings from your site then you'll have to rely on using shortcode using the meeting ID value here.
See shortcode section on how to use Shortcode.
"},{"location":"migration/","title":"Migration from JWT","text":""},{"location":"migration/#reason","title":"Reason","text":"Previous versions of Video Conferencing with Zoom API ( version 3.9.7 and below) - used JWT credentials to connect and utlize zoom. As of June 2023, Zoom will deprecate JWT App type - please see JWT App Type Deprecation FAQ From version 4.0.0 and above the plugin has moved to Server-to-Server OAuth App and SDK App type for Join via Browser / Web SDK support
"},{"location":"migration/#migration-wizard","title":"Migration Wizard","text":"As of version 4.0.0 of Video Conferencing with Zoom Api users will see a migration wizard
that prompts to add Server-to-Server OAuth Keys and App SDK keys to transition to new system. Clicking on migration wizard will show you the migration wizard
"},{"location":"migration/#step-1","title":"Step 1","text":"First step is to add the OAuth App Credentials - you can follow the steps in the setup guide to generate Server-to-Server OAuth credentials. - then add the Account ID, Client ID and Client Secret to the form shown below, checking the box Delete JWT Keys - will delete the JWT keys upon successfully validating and saving OAuth keys
Once saved successfully click Next Step
"},{"location":"migration/#step-2","title":"Step 2","text":"Step 2 will prompt you to add SDK App credentials, SDK Credentials are required to use Join via Browser feature without JWT, please see steps in the setup guide to generate App SDK credentials. Then add the SDK Key and SDK Secret Key and Save App SDK Keys. Please note to test join via browser option on your site to verify you've added SDK keys correctly as it's the only way to verify you've entered the correct keys.
"},{"location":"migration/#step-3","title":"Step 3","text":"You're all done - the keys have already been saved on Step 1 and Step 2, the migration is now complete.
"},{"location":"pro-shortcode/","title":"PRO Version Shortcode","text":""},{"location":"pro-shortcode/#1-list-meeting-registrants","title":"1. List meeting registrants","text":"This shortcode can be used to list all author meeting list in frontend and to view registrants for those meeting.
Use: [vczapi_pro_author_registrants]
You can find more information for this in PRO version widget documentation..
Use: [vczapi_zoom_calendar host_id=\"\" author=\"\" show=\"\" calendar_default_view=\"dayGridMonth\" show_calendar_views=\"yes\"]
Where,
Use: [vczapi_list_meetings per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" show=\"meeting\" cols=\"3\" filter=\"yes\"]
NOTE: This shortcode will show register now button if a meeting is enabled registration.
Where,
This shortcode will display all registered events via user ID or via logged in user session ID.
Use: [vczapi_registered_meetings user_id=\"\" show=\"upcoming\"]
Where,
Display registration form in any page you want.
Use: [vczapi_pro_registration_form post_id='']
Where,
Here below are the steps to setup Zoom into WordPress.
"},{"location":"setup/#getting-started","title":"Getting Started","text":"For Video Conferening with Zoom plugin to work you will be using Server-to-Server OAuth app type.
In order to setup the plugin you'll first need a Zoom Account. So, sign up if you don't have a Zoom account already or just sign in with your existing Zoom Account and follow the next steps.
"},{"location":"setup/#setup-server-to-server-oauth","title":"Setup Server-to-Server OAuth","text":"In order for you to setup the plugin, carefully follow all the steps below:
"},{"location":"setup/#creating-server-to-server-app-type","title":"Creating Server to Server App type","text":"OR you can simply click this https://marketplace.zoom.us/develop/create and this will open a modal like in below screenshot.
Click on Server to Server OAuth App and click create.
"},{"location":"setup/#setting-up-api-credentials","title":"Setting Up API Credentials:","text":"After you click on \"Create\" button in the popup you will be asked few details to fill up.
"},{"location":"setup/#1-app-name","title":"1. App Name","text":"Add you app name to anything of your Preference so that you can remember that this app type is for your WordPress website.
"},{"location":"setup/#2-app-credentials","title":"2. App Credentials","text":"Once App is created - you will be taken to an App Overview page where you can see App Credentials. These highlighted credentials will be used in our WordPress Video conferencing Zoom plugin to connect with your account. We'll get back to this in next steps. Click Continue for now.
"},{"location":"setup/#3-information-page","title":"3. Information Page","text":"In this next step you will need to add Contact name, Contact email and Company name on the information page in order to activate this app type. Fill in the details according to your needs.
"},{"location":"setup/#4-scopes-page","title":"4. Scopes Page","text":"Ignore \"Feature\" page - After you've added details from previous step - Goto Scopes page from the left navigation menu and Click on \"Add Scopes\" as highlighted in the screenshot.
Scopes are basically added in order to allow permissions to access your Zoom meetings into Video Conferencing Zoom plugin. So, this step is very crucial step and you should properly assign each of the defined scopes properly otherwise you will get no permission issues when trying to create,delete or access Zoom Meetings from your WordPress site.
See Required Scopes section. in order to add necessary permissions. Come back to this step after you've added all the necessary permissions.
"},{"location":"setup/#5-activation","title":"5. Activation","text":"Finally, click on Activate your App button and your activated.
"},{"location":"setup/#required-scopes","title":"Required Scopes:","text":"These below are the scopes required from step 4 when setting up the scopes for your application.
Note: Not adding any of the below permissions may result in permission issue error notices when trying to create your meeting/webinars.
"},{"location":"setup/#meetings","title":"Meetings","text":"Login to your WordPress site as an Administrator and goto WordPress admin dashboard page and goto Zoom Events > Settings page.
Click save to verify your credentials. If credentials are invalid, there should be a invalid warning. If everything is correctly setup then you should be able to see your Zoom Users from wp-admin > Zoom Events > Users page.
Next step is to create new Zoom Events from wp-admin > Zoom Events > Add new page.
"},{"location":"setup/#setup-app-sdk-credentials","title":"Setup App SDK Credentials","text":"Purpose for creating a App SDK is required for Join via Browser/Web SDK to work properly.
"},{"location":"setup/#generating-app-sdk-credentials","title":"Generating App SDK Credentials","text":"NOTE: In case you forgot to toggle the below button(shown in screenshot) you can still use the SDK credentials however, you won't be able to complete the SDK activation step. That's completely ok.
"},{"location":"setup/#adding-sdk-credentials-to-the-plugin","title":"Adding SDK Credentials to the plugin","text":"You've not successfully connected your Zoom Account in your WordPress site. You should be able to create your Zoom meetings directly from your WordPress dashboard now.
"},{"location":"setup/#next-steps","title":"Next Steps","text":"After you've configured your keys - Zoom meetings are not automatically imported into your site. You'll need to import your meetings or create new ones from your WordPress dashboard directly.
In order to create a new Zoom Meeting goto wp-admin > Zoom Events > Add new page and this should create a new meeting both in Zoom and as a post in your WordPress site as well.
"},{"location":"shortcode/","title":"Shortcode","text":"All these shortcodes are available as elementor and gutenberg modules.
"},{"location":"shortcode/#types","title":"Types","text":"[zoom_api_link meeting_id=\"1234567890\" link_only=\"no\"]
[zoom_meeting_post post_id=\"ZOOM MEETING POST ID\" template=\"none\"]
[zoom_list_meetings per_page=\"5\" category=\"test,test2,test3\" filter=\"no\" type=\"upcoming\" cols=\"3\"]
[zoom_list_webinars per_page=\"5\" category=\"test,test2,test3\" filter=\"no\" type=\"upcoming\" cols=\"3\"]
[zoom_list_host_meetings host=\"YOUR_HOST_ID\"]
[zoom_api_webinar meeting_id=\"YOUR_WEBINAR_ID\" link_only=\"no\"]
[zoom_list_host_webinars host=\"YOUR_HOST_ID\"]
[zoom_join_via_browser meeting_id=\"1234567890\" login_required=\"no\" help=\"yes\" title=\"Test\" height=\"500px\" disable_countdown=\"yes\"]
[zoom_recordings host_id=\"YOUR_HOST_ID\" downloadable=\"yes\"]
[zoom_recordings_by_meeting meeting_id=\"1234567890\" downloadable=\"no\"]
Use: [zoom_api_link meeting_id=\"1234567890\" link_only=\"no\"]
Where,
meeting_id
= Your meeting ID.link_only
= Show only link or not. Change to \"yes\" instead of \"no\" to show link onlyYour frontend page should look like:
"},{"location":"shortcode/#2-show-a-meeting-post-with-countdown","title":"2. Show a meeting post with Countdown","text":"Use: [zoom_meeting_post post_id=\"\" template=\"none\" description=\"true\" countdown=\"true\" details=\"true\"]
Where,
post_id
= Zoom Meeting post ID.template
= \"boxed\" - changing to boxed will show meeting with timer.description
= \"false\", default is true. This will hide description field.countdown
= \"false\", default is true. This will hide countdown.details
= \"false\", default is true. This will hide detail and join links. If you just want to hide details field, you can do so with CSS.Use: [zoom_list_meetings per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" cols=\"3\"]
Where,
NOTE: This was added in version 3.3.4 so, old meetings which were created might need to be updated in order for this shortcode to work properly.
"},{"location":"shortcode/#4-list-upcoming-or-past-webinars","title":"4. List Upcoming or Past Webinars","text":"Use: [zoom_list_webinars per_page=\"5\" category=\"test,test2,test3\" order=\"ASC\" type=\"upcoming\" cols=\"3\"]
Where,
Use: [zoom_list_host_meetings host=\"YOUR_HOST_ID\"]
Where,
host
= Your HOST ID where you can get from wp-admin > Zoom Meeting > Users = User IDNOTE: Added from version 3.3.10. This will list all past and upcoming 300 meetings related to the defined HOST ID.
"},{"location":"shortcode/#6-show-specific-webinar-detail","title":"6. Show Specific Webinar Detail","text":"Use: [zoom_api_webinar webinar_id=\"YOUR_WEBINAR_ID\" link_only=\"no\"]
Where,
meeting_id
= Your Webinar ID which you want to show NOTE: Added in version 3.4.0
"},{"location":"shortcode/#7-show-list-of-webinars","title":"7. Show List of Webinars","text":"Use: [zoom_list_host_webinars host=\"YOUR_HOST_ID\"]
Where,
host
= Your HOST ID where you can get from wp-admin > Zoom Meeting > Users = User ID NOTE: Added from version 3.4.0
"},{"location":"shortcode/#8-embed-zoom-meeting-in-your-browser","title":"8. Embed Zoom Meeting in your Browser","text":"This section has been moved to another page
"},{"location":"shortcode/#9-show-recordings-based-on-host-id","title":"9. Show recordings based on HOST ID.","text":"Show recordings list in frontend based on host ID.
Usage: [zoom_recordings host_id=\"YOUR_HOST_ID\" downloadable=\"yes\"]
Where,
host_id
: YOUR HOST ID.downloadable
: Default is set to false. If you want your users to be able to download your recordings.Show recordings list based on your meeting ID
Usage: [zoom_recordings_by_meeting meeting_id=\"1234567890\" passcode=\"yes\" downloadable=\"yes\"]
Where,
meeting_id
: YOUR MEETING ID to pull.passcode
: Set to \"yes\" or \"no\" to show passcode.downloadable
: Set to \"yes\" or \"no\" to show downloadable button.With new version, its possible to override the display of output from default plugin layout. You can do so by following method.
wp-admin/plugins/video-conferencing-with-zoom-api/templates/shortcode
folderyourtheme/video-conferencing-zoom/shortcode/zoom-shortcode.php
From version 3.4.0 - Plugin is fully compatible with Elementor modules as well Gutenberg Blocks.
"},{"location":"support/","title":"Support","text":"Support for this plugin is free! If you encounter any issues or have any queries please use the support forums. We will reply to you at the earliest possible.
"},{"location":"support/#premium-support-ticket-for-premium-users","title":"Premium Support Ticket for premium users","text":"Create a ticket or view if your queries are already answered in Support forum.
"},{"location":"support/#facebook-group","title":"Facebook Group","text":"Join our facebook group which we have created in order to stay up to date with updates and common issues faced. Join here
"},{"location":"template_override/","title":"Template Override","text":"Overriding the template means to change the layout of how the content is displayed in frontend.
"},{"location":"template_override/#overriding-the-parent","title":"Overriding the Parent","text":"Video conferencing with zoom api
main plugin templates folder.public_html/wp-content/plugins/video-conferencing-with-zoom-api/templates/
folder.To override, copy files from public_html/wp-content/plugins/video-conferencing-with-zoom-api/templates/
folder to public_html/wp-content/yourtheme/video-conferencing-zoom/
folder.
Check out the video documentation if you want to see basic live demo on Template Overrides.
"},{"location":"template_override/#content-not-showing","title":"Content not showing?","text":"If you are facing an issue with content not being shown on your single meetings page i.e yourwesite/zoom-meetings/your-meetings page then follow below steps:
Like said above, you'll need to find out the div structure from your theme. You can do so by going to your yoursite.com/zoom-meetings/yourmeetings-page > Right Click > Click on inspect. Check what your theme is outputting in other pages of your site
You Should see below image on your screen now.
Match the classes accordingly in the file content-single-meeting.php now. Replacing the \"dpn-zvc-single-content-wrapper dpn-zvc-single-content-wrapper-<?php echo get_the_id(); ?>\"
usually does the trick !!
Hope this helps !
You're Done !
You can change the layout of the pages anyway you want.
"},{"location":"vanity_url/","title":"Vanity URL","text":"Vanity URL is a way to change your zoom links from the default one. This is a case when you as a user have purchased a custom URL in zoom to join or start your meetings.
Read Here for more details https://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-Requests
"},{"location":"vanity_url/#basic-usage","title":"Basic Usage","text":"In the settings page, you will find an option called \"Vanity URL
\".
** Changing or adding new values in the \"Vanity URL\" field will change the way how links are displayed on frontend.**
"},{"location":"vanity_url/#example","title":"Example","text":"example.zoom.us/j/12312321
instead of the default zoom.us/j/1232321
zoom.us/j/21321
linkEasy right ?
"},{"location":"vczapi-pro/","title":"Video Conferencing with Zoom Pro","text":""},{"location":"vczapi-pro/#introduction","title":"Introduction","text":"Provides:
Please refer to Zoom Documentation to learn a bit more :
https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-
;
Use Personal Meeting ID instead of an automatically generated meeting ID. It can only be used for scheduled meetings, instant meetings and recurring meetings with no fixed time.
"},{"location":"vczapi-pro/#recurring-meetings","title":"Recurring Meetings:","text":"Recurring Meetings are meetings that can be set to repeat over a course of time. We have provided the option of Occurrence to set the number of occurrences from 1 - 20 for a meeting.
Recurring Meetings can have a maximum of 20 occurrences
"},{"location":"vczapi-pro/#meeting-join-links","title":"Meeting Join Links:","text":"A Zoom Meeting Join Link for any recurring meeting created via these methods will always be the same. That is meeting links will not change for each occurrence.
"},{"location":"vczapi-pro/#how-to-set-a-recurring-meeting","title":"How to set a recurring meeting:","text":"Below we outline the various ways recurring meetings can be set
"},{"location":"vczapi-pro/#recurring-meeting-options","title":"Recurring Meeting Options","text":"There are various options tp set a recurring Meeting:
These meetings can be scheduled on a daily basis or with a time difference of once every 3 days - this allows the user to select a time range between 1 - 3 days. An example can be if a user schedules a meeting for August 1 and keeps a gap of 3 days then the next occurrence of the meeting would be on August 4
"},{"location":"vczapi-pro/#weekly","title":"Weekly","text":"Meetings can be scheduled per a weekly basis - you would need to select the day of the week and how many occurrences ( 1 - 20 ). The first occurrence will be the day of the week (sun - friday) according to the meeting start date selected - the rest will follow suit. You can choose how frequently a meeting can be repeated i.e once every week or once every ( 2 - 12 ) weeks.
For example if you select Start Date: August 2, 2020 - 5:00PM as the start date Occurrences: 3
Day of the week: Sunday\nRepeat: Every 1 week\n
Then the dates for meeting will be:
August 2, 2020 - Sunday\nAugust 9, 2020 - Sunday\nAugust 16, 2020 - Sunday\n
However, please note if you select July 29, 2020 as the start date i.e your selection is as follows:
Start Date: July 29th, 2020 (Thursday)\nDay of the week: Sunday\nOccurrences: 3\nRepeat Every 1 week\n
Then the dates for the meetings will be same i.e:
August 2, 2020 - Sunday\nAugust 9, 2020 - Sunday\nAugust 16, 2020 - Sunday\n
"},{"location":"vczapi-pro/#monthly","title":"Monthly","text":"You can select - Meeting Frequency / Repeat Every : ( 1 - 3 ) months
Occurs on:
This is for a always available meeting - this meeting will be always available for any user that has access to it.
Note: Meeting needs to be started by Host - otherwise user will be on standby,
"},{"location":"vczapi-pro/#registration","title":"Registration","text":""},{"location":"vczapi-pro/#prerequisites","title":"Prerequisites:","text":"To enable Registration on Meetings requires a paid Zoom plan https://zoom.us/pricing as of the writing of this document ( July 29th 2020 ) this means at least a Pro user account.
Excerpt taken from Zoom: https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings
Scheduling a meeting that requires registration will allow participants to register with their e-mail, name, other questions, and custom questions. You can also generate meeting registration reports if you want to download a list of people that registered.
Note: Participants joining meetings with registration, must use the Zoom desktop client or mobile app. They will not be able to join using the web client. \u201c
One thing to Note is that Registered users will be required to login from their Zoom Apps - they will not be able to join via browser / web client.
"},{"location":"vczapi-pro/#how-to-enable-registration-on-a-meeting","title":"How to Enable Registration on a Meeting:","text":"Registration can be enabled on a meeting by ticking the box marked \u201cRegistration\u201d. This will enable unique join links for each user that has registered and the link will be sent via Zoom if not explicitly turned off.
"},{"location":"vczapi-pro/#register-without-login","title":"Register Without Login:","text":"This option dictates if a user needs to be logged into the site ( WordPress site ) to be able to register.
"},{"location":"vczapi-pro/#registration-flow","title":"Registration Flow","text":"Any user (visitor / customer) who visits the Meeting page will be shown a register now button
"},{"location":"vczapi-pro/#register-now-call-to-action","title":"Register Now - Call to Action","text":""},{"location":"vczapi-pro/#registration-form","title":"Registration Form","text":"Once user clicks register now - they will be taken to the registration form page:
"},{"location":"vczapi-pro/#registration-e-mail","title":"Registration E-mail","text":"Once the registration form is filled - user will be registered to the meeting and if enabled setting ( Zoom Meetings > Settings > PRO ) user will receive a confirmation e-mail - this is optional as Zoom does send confirmation e-mail to registered user as well - but we have provided options to customize this e-mail.
Registration E-mail content can be change via the E-mail tab on ( Zoom Meetings > Settings > PRO )
Registration E-mail Sample:
"},{"location":"vczapi-pro/#calendar-widget","title":"Calendar Widget","text":""},{"location":"vczapi-pro/#default-use","title":"Default Use","text":"
By using the shortcode [vczapi_zoom_calendar] - you can show a calendar that shows all meetings and webinars that are under \"Zoom Meetings > All Meetings\" If a meeting is clicked - it will show you more of the events details.
Use: [vczapi_zoom_calendar author=\"\" show=\"\" calendar_default_view=\"dayGridMonth\" show_calendar_views=\"yes\" category=\"all\"]
Where,
category=\"category-slug\"
or comma separated category=\"category1,category2\"
Simply create a Zoom Recurring Meeting and then enable purchase of the product. You can use follow the same steps as here : https://zoomdocs.codemanas.com/woocommerce/#1-product-linked-with-zoom-meeting or if you want a more visual representation please check out the video https://www.youtube.com/watch?v=V6SfMFatOH8
Once a recurring Product is Purchased - the customer if logged in will be able to view the meeting details on their my accounts > meetings https://examplle.com/my-account/wc-zoom-meetings/ Only the next occurrence of meeting will be shown here, To see all occurrences you will need to go the meeting details page:
Meeting Detals on My Account Page :
Recurring Meeting Details :
"},{"location":"vczapi-pro/#meeting-registration-woocommerce","title":"Meeting Registration + WooCommerce","text":"Once a meeting has been created with registration enabled and linked with a WooCommerce product - the flow of registration slightly differs from basic registration. Users will not be directed to the registration - rather the WooCommerce checkout process will continue as normal. The Billing Email Address and Billing First Name and Last Name used during the checkout process will be used to register the user to the meeting.
"},{"location":"wcfm/","title":"WCFM (Addon)","text":"This Addon is for WCFM \u2013 Frontend Manager for WooCommerce you can get it here.
"},{"location":"wcfm/#zoom-integration-for-woocommerce","title":"Zoom Integration for WooCommerce","text":""},{"location":"wcfm/#introduction","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and WCFM. This addon allows vendors to create and manage Zoom Meeting Products from the front end.
"},{"location":"wcfm/#demo-video","title":"Demo Video","text":""},{"location":"wcfm/#prerequisites","title":"Prerequisites","text":"After successfully installing all the required plugins. If you login as a vendor - you will be first shown a Zoom Meeting section on the WCFM dashboard.
Please see instructions for normal products Zoom Integration for WooCommerce
"},{"location":"wcfm/#introduction_1","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and Bookings and WCFM. This addon allows vendors/shop owners to create bookable products and create a zoom meeting when a booking is made.
"},{"location":"wcfm/#prerequisites-for-bookable-product","title":"Prerequisites for Bookable Product:","text":"Once all the required plugins are installed and activated. The ability to enable Zoom Meetings for Bookable Products will be available.
When you select bookable product via the WCFM frontend interface
"},{"location":"wcfm/#_1","title":"WCFM (Addon)","text":"You will see a new Zoom Setting Tab for the Bookable Product.
For detailed information on how Bookings and Zoom for WooCommerce and Bookings will work please see Zoom for WooCommerce Bookings
"},{"location":"wcfm/#zoom-integration-for-woocommerce-appointments","title":"Zoom Integration for WooCommerce Appointments","text":""},{"location":"wcfm/#introduction_2","title":"Introduction","text":"Zoom Integration for WCFM acts as a glue plugin for Zoom integration for WooCommerce and WooCommerce Appointments and WCFM. This addon allows vendors/shop owners to create appointable products and create a zoom meeting when an appointment is made.
"},{"location":"wcfm/#prerequisites-for-bookable-product_1","title":"Prerequisites for Bookable Product:","text":"Once all the required plugins are installed and activated. The ability to enable Zoom Meetings for Appointable Products will be available.
When you select Appointable product via the WCFM frontend interface:
"},{"location":"wcfm/#_2","title":"WCFM (Addon)","text":"You will see a new Zoom Setting Tab for the Appointable Product.
For detailed information on how Bookings and Zoom for WooCommerce Appointments will work please see Zoom for WooCommerce Appointments
"},{"location":"webhooks/","title":"WebHooks","text":"PLEASE READ: Webhook feature is currently in beta stage. So, we are gathering your feedbacks. Currently, only certain events are allowed to be used. We'll increase this as time goes by.
"},{"location":"webhooks/#what-is-web-hook","title":"What is Web Hook ?","text":"Zoom utilizes webhooks as a medium to notify this plugin (consumer application) about events that occur in a Zoom account. Instead of making repeated calls to pull data frequently from the Zoom API, you can use webhooks to get information on events that happen in a Zoom account.
In simple terms, webhook functionality can be used to notify your WordPress site to do something when a certain event is triggered in Zoom website. For example: if a user creates a meeting in Zoom website, it will be automatically created on your WordPress site as well.
"},{"location":"webhooks/#requirements","title":"Requirements","text":"This requires PRO version of Video Conferencing with Zoom plugin.
Some Events might need a Zoom PRO account as well. For example webinars, recurrings and PMI features.
This section assumes that you have successfully setup Server-to-Server Oauth and credentials have been added and successfully connected to your WordPress site. If you have not created Server-to-Server OAuth yet then please visit this tutorial.
Copy Secret Token Key.
After that click on Add new Event Subscription button - to complete the steps you will first need to go to your WordPress admin panel and see the step described below
Enter your Subscription name to anything you want, and add the Event Notification endpoint URL like:
https://yoursite.com/wp-json/vczapi/v1/meeting - Replace https://yoursite.com with your site url. Complete url would be something like
https://yoursite.com/wp-json/vczapi/v1/meeting
Goto wp-admin > Zoom Meetings > Settings > Webhooks
Each endpoint for certain events are defined in this page. All you need to do is copy it from here to Zoom side. See below for where to copy these URLs.
"},{"location":"webhooks/#automate-meeting-flow","title":"Automate Meeting Flow","text":"\"Meeting has been created\", \"Meeting has been updated\", \"Meeting has been deleted\"
Goto Webinars
Select 3 events which are \"Webinar has been created\", \"Webinar has been updated\", \"Webinar has been deleted\"
Please note that choosing any additional events will not work.
"},{"location":"webinars/","title":"Webinars","text":""},{"location":"webinars/#requirements","title":"Requirements","text":"In order to use this functionality, your Zoom Account must be eligible with Zoom Webinars plan. Without Webinar enabled from Zoom side you cannot use this functionality. See Zoom Pricing
"},{"location":"webinars/#basic-information","title":"Basic Information","text":"From version 3.6.0 you can now create Webinars as post type which means that you can bind your Zoom Webinars to your WordPress posts and show them in frontend accordingly.
"},{"location":"webinars/#how-to-create-a-webinar","title":"How to create a Webinar ?","text":"To create webinars from your site.
You should see above type of page on your side. Choose Webinar in meeting type and create the meeting. Your meeting now should be a Zoom Webinar.
"},{"location":"webinars/#showing-webinars-via-shortcode","title":"Showing Webinars via Shortcode","text":"You can show your individual webinars via shortcode or from single post type page. To show your webinar via shortcode refer to this section.
"},{"location":"woocommerce-appointments/","title":"WooCommerce Appointments (addon)","text":"This Addon is for WooCommerce Appoitments Plugin it acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce-appointments/#prerequisite","title":"Prerequisite","text":"Zoom for WooCommerce Appointments allows you to automate your zoom meetings directly from your WordPress dashboard by linking zoom meetings to an appointment made via an appointable plugin using WooCommerce Appointments plugin. Users will receive join links in their Appointment confirmation emails. Admin can directly start meetings from wp-admin > Appointments list page.
"},{"location":"woocommerce-appointments/#demo-video-of-implementation","title":"Demo Video of Implementation","text":"Implementaion of the plugin video above.
"},{"location":"woocommerce-appointments/#features","title":"Features","text":"Below are few features listed.
"},{"location":"woocommerce-appointments/#create-automated-zoom-meetings-without-configurations","title":"Create Automated zoom meetings without configurations","text":"With this plugin, your zoom meeting creation is automated. A zoom meeting is created once an Appointment is made from the customer side. It happens automatically with minimal configurations.
"},{"location":"woocommerce-appointments/#configure-you-appointable-product","title":"Configure you Appointable Product","text":"When you create an Appointable product, you will need to Enable Zoom Meeting and assign a host(if multiple hosts are available you can choose which one to assign).
"},{"location":"woocommerce-appointments/#join-links-and-start-links-in-email-as-well-as-your-frontend-my-account-section","title":"Join links and start links in email as well as your frontend my-account section.","text":"After an Appointment is either confirmed or paid for (depending on the settings). Users will be able to join their Appointments from email link. Zoom meeting will be included in the Appointment email as well as inside the users my-account > appointments frontend table section.
My Accounts > Appointments
Order Complete Email
"},{"location":"woocommerce-appointments/#assign-staff-host-id","title":"Assign Staff Host ID","text":"You can assing your staff with a host ID (if you have multiple Zoom Users under your account). Once a Zoom User is assigned to a staff - all Appointments created with that host selected will create meetings using that user i.e. the meeting will come under their Zoom Meetings. (if you are still unclear please refer to our video above)
"},{"location":"woocommerce-booking/","title":"WooCommerce Bookings (Addon)","text":"This Addon is for WooCommerce Booking Plugin which acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce-booking/#prerequisite","title":"Prerequisite","text":"Zoom Integration for WooCommerce Booking allows you to automate your zoom meetings directly from your WordPress dashboard by linking zoom meetings to your WooCommerce Booking products automatically when a Booking Product is created. Users will receive join links in their booking confirmation emails. Admin can directly start meetings from wp-admin > Bookings list page.
"},{"location":"woocommerce-booking/#demo-video-of-implementation","title":"Demo Video of Implementation","text":"Implementaion of the plugin video above.
"},{"location":"woocommerce-booking/#how-to-link-meetingswebinar-to-booking-product","title":"How to link meetings/webinar to booking product?","text":"Note: You must either select hour(s) or minute(s) only otherwise the meeting/webinar won't be created.
Now, your users should be able to book from the frontend.
"},{"location":"woocommerce-booking/#features","title":"Features","text":"Below are few features listed.
"},{"location":"woocommerce-booking/#create-automated-zoom-meetings-without-configurations","title":"Create Automated zoom meetings without configurations","text":"With this plugin, your zoom meetings are automated when a booking product is booked. A zoom meeting is created once a booking is booked from a customer side. It happens automatically without any configurations.
"},{"location":"woocommerce-booking/#manually-select-which-host-to-assign-for-the-booking","title":"Manually Select which host to assign for the Booking","text":"When you create a booking product, you'll be able to select which host to assign that booking product so that the host can manually start the meeting when a booking is booked.
"},{"location":"woocommerce-booking/#join-links-and-start-links-in-email-as-well-as-your-frontend-my-account-section","title":"Join links and start links in email as well as your frontend my-account section.","text":"After a booking is done. Users will be able to join their bookings from email link. Zoom meeting will be included in the booking email as well as inside the users my-account > bookings frontend table section.
"},{"location":"woocommerce-booking/#product-vendors-support","title":"Product Vendors Support","text":"Zoom for WooCommerce Bookings supports Product Vendors since version 2.1.7 . Each vendor can be assigned a Zoom User / Host ID. When the vendor creates a Booking Product the host is automatically selected based on which host they have been assigned.
Note: The host(s) need to be under the Zoom account that has been configured - this is a paid Zoom feature. Assign Zoom Host To assign Zoom Host to a Vendor. Goto Products > Zoom Vendors here you will be shown a screen of available vendors and ability to assign a host to them.
Once Zoom host is assigned to vendor. When the vendor in question when creates a Bookable Product - the selected Host will be used to create the Zoom Meeting.
"},{"location":"woocommerce-product-vendors/","title":"WooCommerce Product Vendors (Addon)","text":"With the release of version 2.1.0 for WooCommerce Integration with Zoom plugin, It will now support Requirements
Please note: that to do this you'll need to add multiple hosts to your Zoom Account. You can do this from Users section on your Zoom Account.
If you have not added other users to your Zoom Account then only your name will show up.
Now goto wp-admin > Products > Zoom Vendors page.
From the above table. Select your Vendor and which Zoom Account you would like to assign for that vendor.
"},{"location":"woocommerce-product-vendors/#what-happens-after-vendor-with-zoom-account-is-linked","title":"What happens after Vendor with Zoom Account is Linked ?","text":"So, recommended way is to link a Zoom Account for Every Vendor everytime.
"},{"location":"woocommerce/","title":"WooCommerce (Addon)","text":"This Addon is for WooCommerce Plugin which acts as an automation process in creating zoom meetings which is available here.
"},{"location":"woocommerce/#purpose","title":"Purpose","text":"There are 2 ways you can create a Zoom Product
In this method - you can create a normal WooCommerce Product and simply connect it to a Zoom Meeting.
Let's take an example of a Simple Product Type
Create a product as you normally would then you will see the Zoom Connection tab on the product tabs
After clicking the Zoom Meeting tab, you can see the Enable Zoom Connection Checkbox. Checking this box will allow to link this product to a Zoom Meeting. Please note the meeting needs to be created first via Zoom Meeting > All Meetings
.
After ticking Enable Zoom Connection - you will see further options:
You can link to Zoom Meeting by searching - after a meeting has been selected it's meeting details will be shown.
Now when the product is purchased - the customer will get the option to join the meeting. They will see this in:
This method should be used to link Zoom Meeting with a Product. The product created using this method will not be shown on shop and search pages. The meeting created using this method is designed to be directly purchased via the zoom meeting single page. See image below.
"},{"location":"woocommerce/#how-to-create-a-zoom-meeting","title":"How to create a Zoom Meeting","text":"From version 2.6.0 the ability to sell recording was added to Zoom Integration for WooCommerce. The steps are very similar to selling meetings, but instead of meetings recordings are being sold.
To do this go to Products > Add New and create a simple virtual product as you would do for a normal woocommerce product, then go to Zoom Connection tab which should look like the following.
We then need to select the host / year and month when the recording took place, and click get recordings. This will retrieve the list of recording for that month. You can then add multiple recordings to be associated with this product.
Now save the product and once the user purchases the product - the recording links will be sent to them after purchase has been completed.
"},{"location":"woocommerce/#shortcode","title":"Shortcode","text":"[vczapi_wc_show_purchasable_meetings per_page=\"10\" type=\"table\" order=\"DESC\" upcoming_only=\"no\"]
This allows you to show your purchasable meeting lists. Show in DESC or ASC format as well as show upcoming only or not.
"},{"location":"woocommerce/#parameters","title":"Parameters:","text":"per_page:
Allows you to define how many list to show per page.type
: Allows you to show the list in table format or boxed format. Change to type=\"boxed\"
to show in boxed formatorder
: Show list in ASC
or DESC
formatupcoming_only
: Show only upcoming meetings based on start time or show all list. Change to \"yes\" for upcoming onlyMeeting email reminders can be configured from Zoom > WooCommerce > Email tab. You can either choose to send emails 24 hours before the meeting or 3 hours before.
"},{"location":"woocommerce/#meeting-reminder-worklow","title":"Meeting Reminder Worklow:","text":"Show recordings list based on your meeting ID
-Usage: [zoom_recordings_by_meeting meeting_id="1234567890"]
Usage: [zoom_recordings_by_meeting meeting_id="1234567890" passcode="yes" downloadable="yes"]
Where,
meeting_id
: YOUR MEETING ID to pull.passcode
: Set to "yes" or "no" to show passcode.downloadable
: Set to "yes" or "no" to show downloadable button.