Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
Roles
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
Deprecated API Endpoints

All Recordings have completed


The All Recordings have completed event is triggered every time a recording of a meeting or webinar becomes available to view and/or download.

All users with a Pro or a higher plan have access to cloud recordings. An account owner or account admin can enable cloud recording for all account members and members that belong to a certain group. Users can also enable cloud recordings for their own use.

Only a meeting/webinar host or a co-host can start and complete a cloud recording. A recording is considered complete after the host or co-host ends the meeting/webinar.

Prerequisites

  • A Pro or higher plan.
  • Cloud recording must be enabled on the users’ account.
  • Event Subscriptions must be enabled for your Marketplace app with the following configurations:
    • A valid Event notification endpoint URL.
    • The All Recordings have completed subscription must be enabled under the Recording event.

The tabs below display the complete schema, payload with data types, and an example of the recording.completed event notification:

recording.completed event notification
recording.completed
object
event
string

The name of the event.

event_ts
integer

A timestamp at which the event occurred.

1 validation
payload
object
download_token
string

Use this token along with the download_url to download the Cloud Recording via an OAuth app. This token only lasts for 24 hours after generation and thus, you can only download the file within 24 hours of receiving the “recording.completed” event notification.

You can either include the download_token as a query parameter or pass it as a Bearer token in the Authorization header of your HTTP request.

Using Authorization Header (Recommended)

curl --request GET \
  --url {download_url} \
  --header 'authorization: Bearer {download_token} \
  --header 'content-type: application/json'

Using Query Parameter

The URL to download this type of recording will follow this structure: {download_url}/?access_token={download_token}

Example: https://zoom.us/recording/download/bdfdgdg?access_token=abvdoerbfg