https://github.com/abdullahghanem/laravel-zoom
laravel-zoom
https://github.com/abdullahghanem/laravel-zoom
Last synced: 9 months ago
JSON representation
laravel-zoom
- Host: GitHub
- URL: https://github.com/abdullahghanem/laravel-zoom
- Owner: AbdullahGhanem
- License: mit
- Created: 2023-08-07T10:29:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-07T17:50:30.000Z (over 2 years ago)
- Last Synced: 2025-03-24T00:34:02.554Z (9 months ago)
- Language: PHP
- Size: 505 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel package for Zoom
Laravel Zoom API Package
## Installation
You can install the package via composer:
```bash
composer require Ghanem/zoom-laravel
```
### Configuration file
Publish the configuration file
```bash
php artisan vendor:publish --provider="Ghanem\Zoom\ZoomServiceProvider"
```
#### then add config/app.php
```php
'providers' => [
// ...
Ghanem\Zoom\ZoomServiceProvider::class,
];
```
#### then add config/app.php
```php
'aliases' => [
// ...
'Zoom' => Ghanem\Zoom\Facades\Zoom::class,
];
```
This will create a zoom.php config file within your config directory for common user settings:-
```php
return [
'client_id' => env('ZOOM_CLIENT_KEY'),
'client_secret' => env('ZOOM_CLIENT_SECRET'),
'account_id' => env('ZOOM_ACCOUNT_ID'),
'base_url' => 'https://api.zoom.us/v2/',
];
```
for a user specific user zoom configuration add User model:
```php
public static function clientID()
{
return 'zoom_client_of_user';
}
public static function clientSecret()
{
return 'zoom_client_secret_of_user';
}
public static function accountID()
{
return 'zoom_account_id_of_user';
}
```
### How to get Zoom API credentials
- to see that how to create zoom api and get credentials click [here](configuration.md)
## Usage
At present we cover the following modules
- Users
- Meetings
- Past Meetings
- Webinars
- Past Webinars
- Recordings
- Past Recordings
## Common get functions
### Create a meeting
```php
$meetings = Zoom::createMeeting([
"agenda" => 'your agenda',
"topic" => 'your topic',
"type" => 2, // 1 => instant, 2 => scheduled, 3 => recurring with no fixed time, 8 => recurring with fixed time
"duration" => 60, // in minutes
"timezone" => 'Asia/Dhaka', // set your timezone
"password" => 'set your password',
"start_time" => 'set your start time', // set your start time
"template_id" => 'set your template id', // set your template id Ex: "Dv4YdINdTk+Z5RToadh5ug==" from https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingtemplates
"pre_schedule" => false, // set true if you want to create a pre-scheduled meeting
"schedule_for" => 'set your schedule for profile email ', // set your schedule for
"settings" => [
'join_before_host' => false, // if you want to join before host set true otherwise set false
'host_video' => false, // if you want to start video when host join set true otherwise set false
'participant_video' => false, // if you want to start video when participants join set true otherwise set false
'mute_upon_entry' => false, // if you want to mute participants when they join the meeting set true otherwise set false
'waiting_room' => false, // if you want to use waiting room for participants set true otherwise set false
'audio' => 'both', // values are 'both', 'telephony', 'voip'. default is both.
'auto_recording' => 'none', // values are 'none', 'local', 'cloud'. default is none.
'approval_type' => 0, // 0 => Automatically Approve, 1 => Manually Approve, 2 => No Registration Required
],
]);
```
### Get a meeting
```php
$meeting = Zoom::getMeeting($meetingId);
```
### Update a meeting
```php
$meeting = Zoom::updateMeeting($meetingId, [
"agenda" => 'your agenda',
"topic" => 'your topic',
"type" => 2, // 1 => instant, 2 => scheduled, 3 => recurring with no fixed time, 8 => recurring with fixed time
"duration" => 60, // in minutes
"timezone" => 'Asia/Dhaka', // set your timezone
"password" => 'set your password',
"start_time" => 'set your start time', // set your start time
"template_id" => 'set your template id', // set your template id Ex: "Dv4YdINdTk+Z5RToadh5ug==" from https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingtemplates
"pre_schedule" => false, // set true if you want to create a pre-scheduled meeting
"schedule_for" => 'set your schedule for profile email ', // set your schedule for
"settings" => [
'join_before_host' => false, // if you want to join before host set true otherwise set false
'host_video' => false, // if you want to start video when host join set true otherwise set false
'participant_video' => false, // if you want to start video when participants join set true otherwise set false
'mute_upon_entry' => false, // if you want to mute participants when they join the meeting set true otherwise set false
'waiting_room' => false, // if you want to use waiting room for participants set true otherwise set false
'audio' => 'both', // values are 'both', 'telephony', 'voip'. default is both.
'auto_recording' => 'none', // values are 'none', 'local', 'cloud'. default is none.
'approval_type' => 0, // 0 => Automatically Approve, 1 => Manually Approve, 2 => No Registration Required
],
]);
```
### Delete a meeting
```php
$meeting = Zoom::deleteMeeting($meetingId);
```
### Get all meetings
```php
$meetings = Zoom::getAllMeeting();
```
### Get a meeting
```php
$meeting = Zoom::getMeeting($meetingId);
```
### Get all upcoming meetings
```php
$meetings = Zoom::getUpcomingMeeting();
```
### Get all past meetings
```php
$meetings = Zoom::getPreviousMeetings();
```
### reschedule meeting
```php
$meetings = Zoom::rescheduleMeeting($meetingId, [
"agenda" => 'your agenda',
"topic" => 'your topic',
"type" => 2, // 1 => instant, 2 => scheduled, 3 => recurring with no fixed time, 8 => recurring with fixed time
"duration" => 60, // in minutes
"timezone" => 'Asia/Dhaka', // set your timezone
"password" => 'set your password',
"start_time" => 'set your start time', // set your start time
"template_id" => 'set your template id', // set your template id Ex: "Dv4YdINdTk+Z5RToadh5ug==" from https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingtemplates
"pre_schedule" => false, // set true if you want to create a pre-scheduled meeting
"schedule_for" => 'set your schedule for profile email ', // set your schedule for
"settings" => [
'join_before_host' => false, // if you want to join before host set true otherwise set false
'host_video' => false, // if you want to start video when host join set true otherwise set false
'participant_video' => false, // if you want to start video when participants join set true otherwise set false
'mute_upon_entry' => false, // if you want to mute participants when they join the meeting set true otherwise set false
'waiting_room' => false, // if you want to use waiting room for participants set true otherwise set false
'audio' => 'both', // values are 'both', 'telephony', 'voip'. default is both.
'auto_recording' => 'none', // values are 'none', 'local', 'cloud'. default is none.
'approval_type' => 0, // 0 => Automatically Approve, 1 => Manually Approve, 2 => No Registration Required
],
]);
```
### end meeting
```php
$meetings = Zoom::endMeeting($meetingId);
```
### delete meeting
```php
$meetings = Zoom::deleteMeeting($meetingId);
```
### recover meeting
```php
$meetings = Zoom::recoverMeeting($meetingId);
```
### Create a Users
```php
$meetings = Zoom::createUsers([
'action' => 'create',
'user_info' => [
'email' => 'email@gmail.com',
"type" => 1,
],
]);
```
### Get all users
```php
$users = Zoom::getUsers(['status' => 'active']); // values are 'active', 'inactive', 'pending'. default is active. and you can pass page_size and page_number as well
```
### check User Email
```php
$users = Zoom::checkUserEmail('email@email.com');
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
### Security
If you discover any security related issues, please email Ghanem01.cse@gmail.com instead of using the issue tracker.
## Credits
- [Abdullah Ghanem](https://github.com/AbdullahGhanem)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Sponsor
[💚️ Become a Sponsor](https://github.com/sponsors/AbdullahGhanem)