⚡️ zoom-recording-downloader ⚡️

☁️ Now with Google Drive support ☁️

Zoom Recording Downloader is a cross-platform Python app that utilizes Zoom's API (v2) to download and organize all cloud recordings from a Zoom Business account to local storage or Google Drive.

Screenshot

Installation

Attention: You will need Python 3.11 or greater

$ git clone https://github.com/ricardorodrigues-ca/zoom-recording-downloader
$ cd zoom-recording-downloader
$ pip3 install -r requirements.txt

Usage

Attention: You will need a Zoom Developer account in order to create a Server-to-Server OAuth app with the required credentials

1. Create a server-to-server OAuth app, set up your app and collect your credentials (Account ID, Client ID, Client Secret). For questions on this, reference the docs on creating a server-to-server app. Make sure you activate the app. Follow Zoom's set up documentation or this video for a more complete walk through.

2. Add the necessary scopes to your app. In your app's Scopes tab, add the following scopes:

   cloud_recording:read:list_user_recordings:admin, user:read:user:admin, user:read:list_users:admin.

3. Copy zoom-recording-downloader.conf.template to a new file named zoom-recording-downloader.conf and fill in your Server-to-Server OAuth app credentials:

      {
	      "OAuth": {
		      "account_id": "<ACCOUNT_ID>",
		      "client_id": "<CLIENT_ID>",
		      "client_secret": "<CLIENT_SECRET>"
	      }
      }

4. You can optionally add other options to the configuration file:

• Specify the base download_dir under which the recordings will be downloaded (default is 'downloads')
• Specify the completed_log log file that will store the ID's of downloaded recordings (default is 'completed-downloads.log')

      {
              "Storage": {
                      "download_dir": "downloads",
                      "completed_log": "completed-downloads.log"
              }
      }

• Specify the start_date from which to start downloading meetings (default is Jan 1 of this year)
• Specify the end_date at which to stop downloading meetings (default is today)
• Dates are specified as YYYY-MM-DD

      {
              "Recordings": {
                      "start_date": "2024-01-01",
                      "end_date": "2024-12-31"
              }
      }

• If you don't specify the start_date you can specify the year, month, and day seperately
• Specify the day of the month to start as start_day (default is 1)
• Specify the month to start as start_month (default is 1)
• Specify the year to start as start_year (default is this year)

      {
              "Recordings": {
                      "start_year": "2024",
                      "start_month": "1",
                      "start_day": "1"
              }
      }

• Specify the timezone for the saved meeting times saved in the filenames (default is 'UTC')
• You can use any timezone supported by ZoneInfo
• Specify the time format for the saved meeting times in the filenames (default is '%Y.%m.%d - %I.%M %p UTC')
• You can use any of the strftime format codes supported by datetime

      {
              "Recordings": {
                      "timezone": "America/New_York",
                      "strftime": "%Y.%m.%d-%H.%M%z"
              }
      }

• Specify the format for the filenames of saved meetings (default is '{meeting_time} - {topic} - {rec_type} - {recording_id}.{file_extension}')
• Specify the format for the folder name (under the download folder) for saved meetings (default is '{topic} - {meeting_time}')

      {
              "Recordings": {
                      "filename": "{meeting_time}-{topic}-{rec_type}-{recording_id}.{file_extension}",
                      "folder": "{year}/{month}/{meeting_time}-{topic}"
              }
      }

For the previous formats you can use the following values

• {file_extension} is the lowercase version of the file extension
• {meeting_time} is the time in the format of strftime and timezone
• {day} is the day from meeting_time
• {month} is the month from meeting_time
• {year} is the year from meeting_time
• {recording_id} is the recording id from zoom
• {rec_type} is the type of the recording
• {topic} is the title of the zoom meeting

Google Drive Setup (Optional)

To enable Google Drive upload support:

1. Create a Google Cloud Project:

   • Go to Google Cloud Console
   • Create a new project or select an existing one
   • Enable the Google Drive API for your project (Click to enable ↗)

2. Create OAuth 2.0 credentials:

   • In Cloud Console, go to "APIs & Services" > "Credentials"
   • Click "Create Credentials" > "OAuth client ID"
   • Choose "Desktop application" as the application type
   • Give it a name (e.g., "Zoom Recording Downloader")
   • Download the JSON file and save as client_secrets.json in the script directory

3. Configure OAuth consent screen:

   • Go to "OAuth consent screen"
   • Select "External" user type
   • Set application name to "Zoom Recording Downloader"
   • Add required scopes:
     • https://www.googleapis.com/auth/drive.file
     • https://www.googleapis.com/auth/drive.metadata
     • https://www.googleapis.com/auth/drive.appdata

4. Update your config:

   {
   	"GoogleDrive": {
   		"client_secrets_file": "client_secrets.json",
   		"token_file": "token.json",
   		"root_folder_name": "zoom-recording-downloader",
   		"retry_delay": 5,
   		"max_retries": 3,
   		"failed_log": "failed-uploads.log"
       }
   }

Important: Keep your OAuth credentials file secure and never commit it to version control. Consider adding client_secrets.json to your .gitignore file.

Note: When you first run the script with Google Drive enabled, it will open your default browser for authentication. After authorizing the application, the token will be saved locally and reused for future runs.

5. Run command:

$ python zoom-recording-downloader.py

When prompted, choose your preferred storage method:

1. Local Storage - Saves recordings to your local machine
2. Google Drive - Uploads recordings to your Google Drive account

Note: For Google Drive uploads, files are temporarily downloaded to local storage before being uploaded, then automatically deleted after successful upload.