hsc/zoomkit

ZoomKit makes it easy to consume Zoom APIs from your Laravel application

v0.10 2021-11-20 15:12 UTC

Requires

• php: ^8.0
• ext-curl: *
• nesbot/carbon: ^2.0

MIT

• Gabriel Sieben

README

Consume Zoom Meeting APIs easily from a Laravel application. Licensed under MIT.

Calling an API

You must have ZOOM_KEY and ZOOM_SECRET entries in your .env file. You can get these from the Zoom developer center as the JWT app type.

Once these environment variables have been added, the APIs are modeled off of Zoom's API documentation. For example, if you wanted to use the API at Zoom's Dashboards > List Meetings, you would do the following:

use HSC\ZoomKit\Dashboards;

class MyClass {
    function listMeetings() {
        $result = Dashboards::listMeetings();
        dump($result);
    }
}

In the above example, Dashboards is the class containing all the APIs within the Dashboards section of the documentation. All functions are named similarly to their documentation titles, with the "List meetings" article being listMeetings().

Some functions support additional arguments, which is recorded in PHPdoc blocks. Dates use Carbon types, similar to other Laravel dates.

A very customized call of the same listMeetings() function might look like:

use HSC\ZoomKit\Dashboards;

class MyClass {
    function list_meetings() {
        $from = Carbon::now()->subMonth();
        $to = Carbon::now();
        
        $result = Dashboards::listMeetings(
            type: 'pastOne',
            from: $from,
            to: $to,
            page_size: 300,
        );
        
        dump($result);
    }
}

Currently implemented functions

Archiving class

• listArchivedFiles() - List archived files
• getMeetingArchivedFiles() - Get meeting archived files
• deleteMeetingArchivedFiles() - Delete meeting archived files

CloudRecordings class

• listAllRecordings() - List all recordings
• getMeetingRecordings() - Get meeting recordings
• deleteMeetingRecordings() - Delete meeting recordings
• deleteMeetingRecordingFile() - Delete meeting recording file
• recoverMeetingRecordings() - Recover meeting recordings
• recoverSingleRecording() - Recover single recording
• getMeetingRecordingSettings() - Get meeting recording settings
• updateMeetingRecordingSettings() - Update meeting recording settings
• listRecordingRegistrants() - List recording registrants
• createRecordingRegistrant() - Create recording registrant
• updateRegistrantsStatus() - Update registrants status
• getRegistrationQuestions() - Get registration questions
• updateRegistrationQuestions() - Update registration questions
• listAccountRecordings() - List account recordings

Contacts class

• searchCompanyContacts() - Search company contacts
• listUserContacts() - List user contacts
• getUserContactDetails() - Get user contact details

Dashboards class

• listMeetings() - List meetings
• getMeetingDetails() - Get meeting details
• listMeetingParticipants() - List meeting participants
• getMeetingParticipantQoS() - Get meeting participant QoS
• listMeetingParticipantsQoS() - List meeting participants QoS
• getMeetingSharingRecordingDetails() - Get sharing/recording details
• listWebinars() - List webinars
• getWebinarDetails() - Get webinar details
• getWebinarParticipants() - Get webinar participants
• getWebinarParticipantQoS() - Get webinar participant QoS
• listWebinarParticipantsQoS() - List webinar participant QoS
• getWebinarSharingRecordingDetails() - Get sharing/recording details
• listZoomRooms() - List Zoom Rooms
• getZoomRoomsDetails() - Get Zoom Rooms details
• getCRCPortUsage() - Get CRC port usage
• getChatMetrics() - Get chat metrics
• listMeetingsClientFeedback() - List Zoom meetings client feedback
• getTop25IssuesOfZoomRooms() - Get top 25 issues of Zoom Rooms
• getTop25ZoomRoomsWithIssues() - Get top 25 Zoom Rooms with issues
• getIssuesOfZoomRooms() - Get issues of Zoom Rooms
• getMeetingQualityScores() - Get meeting quality scores
• getMeetingsClientFeedback() - Get zoom meetings client feedback
• listClientMeetingSatisfaction() - List client meeting satisfaction
• getPostMeetingFeedback() - Get post meeting feedback
• getPostWebinarFeedback() - Get post webinar feedback

Devices class

• listH323SIPDevices() - List H.323/SIP devices
• createH323SIPDevice() - Create a H.323/SIP device
• updateH323SIPDevice() - Update a H.323/SIP device
• deleteH323SIPDevice() - Delete a H.323/SIP device

Meetings class

• listMeetings() - List meetings
• getMeeting() - Get a meeting
• createMeeting() - Create a meeting
• updateMeeting() - Update a meeting
• deleteMeeting() - Delete a meeting
• updateMeetingStatus() - Update meeting status
• listMeetingRegistrants() - List meeting registrants
• addMeetingRegistrant() - Add meeting registrant
• deleteMeetingRegistrant() - Delete meeting registrant
• getMeetingRegistrant() - Get meeting registrant
• updateRegistrantStatus() - Update registrant's status
• getPastMeetingDetails() - Get past meeting details
• getPastMeetingParticipants() - Get past meeting participants
• listEndedMeetingInstance() - List ended meeting instance
• listMeetingPolls() - List meeting polls
• createMeetingPoll() - Create a meeting poll
• getMeetingPoll() - Get a meeting poll
• updateMeetingPoll() - Update a meeting poll
• deleteMeetingPoll() - Delete a meeting poll
• listRegistrationQuestions() - List registration questions
• updateRegistrationQuestions() - Update registration questions
• getMeetingInvitation() - Get meeting invitation
• updateLiveStream() - Update a live stream
• getLiveStreamDetails() - Get live stream details
• updateLiveStreamStatus() - Update Live Stream Status
• listPastMeetingPollResults() - List past meeting's poll results
• performBatchRegistration() - Perform batch registration
• useInMeetingRecordingControl() - Use in-Meeting recording control
• performBatchPollCreation() - Perform batch poll creation
• listMeetingTemplates() - List meeting templates
• createMeetingInviteLinks() - Create meeting's invite links

MeetingsExtras class

Expands the ZoomKitMeetings class with ZoomKit-exclusive API abstractions that simplify the use of some of Zoom's more complex APIs.

• createInstantMeeting() - Simplified call of ZoomKitMeetings::createMeeting() specific to Instant Meetings
• createScheduledMeeting() - Simplified call of ZoomKitMeetings::createMeeting() specific to Scheduled Meetings
• endMeeting() - Simplified call of ZoomKitMeeting::updateMeetingStatus() to simply end a meeting.

PAC class

Zoom's smallest API section (tied with the Zoom Rooms Devices section) with only one function.

• listUserPACAccounts() - List a user's PAC accounts

Reports class

• getDailyUsageReport() - Get daily usage report
• getActiveInactiveHostReports() - Get active/inactive host reports

RoomsAccount class

• getZoomRoomAccountProfile() - Get Zoom Room account profile
• updateZoomRoomAccountProfile() - Update Zoom Room account profile
• getZoomRoomAccountSettings() - Get Zoom Room account settings
• updateZoomRoomAccountSettings() - Update Zoom Room account settings

RoomsDevices class

• changeZoomRoomsAppVersion() - Change Zoom Rooms app version

Zoom API Sections

See the Zoom API documentation for more information.

The goal is to eventually support most, if not all, of Zoom's APIs for easy consumption. Currently, only the API sections marked as partially or fully implemented / complete are present.

• Accounts
• Archiving (complete)
• Billing
• Chat Channels
• Chat Channels (Account-level)
• Chat Messages
• Chatbot Messages
• Contacts (complete)
• Cloud Recording (complete)
• Dashboards (complete)
• Devices (complete)
• Groups
• IM Groups
• Meetings (complete)
• PAC (complete)
• Reports
• Roles
• SIP Connected Audio
• SIP Phone
• Tracking Field
• TSP
• Users
• Webinars
• Zoom Rooms
• Zoom Rooms Account (complete)
• Zoom Rooms Location
• Zoom Rooms Devices (complete)

I hope to eventually complete all the Zoom API sections. I will not be implementing deprecated functions (such as the IM Chat section of APIs). If APIs are deprecated after I've already implemented them, they will remain implemented until they are shut down.