Zoom\Api\CloudRecordingApi

All URIs are relative to https://api.zoom.us/v2.

Method	HTTP request	Description
meetingRecordingRegistrantCreate()	POST /meetings/{meetingId}/recordings/registrants	Create a recording registrant
meetingRecordingRegistrantStatus()	PUT /meetings/{meetingId}/recordings/registrants/status	Update registrant's status
meetingRecordingRegistrants()	GET /meetings/{meetingId}/recordings/registrants	List recording registrants
recordingDelete()	DELETE /meetings/{meetingId}/recordings	Delete meeting recordings
recordingDeleteOne()	DELETE /meetings/{meetingId}/recordings/{recordingId}	Delete a meeting recording file
recordingGet()	GET /meetings/{meetingId}/recordings	Get meeting recordings
recordingRegistrantQuestionUpdate()	PATCH /meetings/{meetingId}/recordings/registrants/questions	Update registration questions
recordingRegistrantsQuestionsGet()	GET /meetings/{meetingId}/recordings/registrants/questions	Get registration questions
recordingSettingUpdate()	GET /meetings/{meetingId}/recordings/settings	Get meeting recording settings
recordingSettingsUpdate()	PATCH /meetings/{meetingId}/recordings/settings	Update meeting recording settings
recordingStatusUpdate()	PUT /meetings/{meetingUUID}/recordings/status	Recover meeting recordings
recordingStatusUpdateOne()	PUT /meetings/{meetingId}/recordings/{recordingId}/status	Recover a single recording
recordingsList()	GET /users/{userId}/recordings	List all recordings

`meetingRecordingRegistrantCreate()`

meetingRecordingRegistrantCreate($meeting_id, $meeting_registrant): \Zoom\Api\Model\MeetingRecordingRegistrantCreate201Response

Create a recording registrant

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered to view these recordings. Use this API to register a user to gain access to On-demand Cloud Recordings of a past meeting.
Scopes: recording:write:admin, recording:write.
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = 85746065; // int | The meeting's ID.    When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
$meeting_registrant = new \Zoom\Api\Model\MeetingRegistrant(); // \Zoom\Api\Model\MeetingRegistrant

try {
    $result = $apiInstance->meetingRecordingRegistrantCreate($meeting_id, $meeting_registrant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->meetingRecordingRegistrantCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	int	The meeting's ID. When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.
meeting_registrant	\Zoom\Api\Model\MeetingRegistrant

Return type

\Zoom\Api\Model\MeetingRecordingRegistrantCreate201Response

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`meetingRecordingRegistrantStatus()`

meetingRecordingRegistrantStatus($meeting_id, $recording_registrant_status)

Update registrant's status

A registrant can either be approved or denied from viewing the on-demand recording. Use this API to update a registrant's status. Scopes: recording:write:admin, recording:write
Rate Limit Label: Medium

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = 85746065; // int | The meeting's ID.    When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
$recording_registrant_status = new \Zoom\Api\Model\RecordingRegistrantStatus(); // \Zoom\Api\Model\RecordingRegistrantStatus

try {
    $apiInstance->meetingRecordingRegistrantStatus($meeting_id, $recording_registrant_status);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->meetingRecordingRegistrantStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	int	The meeting's ID. When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.
recording_registrant_status	\Zoom\Api\Model\RecordingRegistrantStatus

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`meetingRecordingRegistrants()`

meetingRecordingRegistrants($meeting_id, $status, $page_size, $page_number, $next_page_token): \Zoom\Api\Model\MeetingRecordingRegistrantList

List recording registrants

Use this API to list registrants of a past meeting's on-demand cloud recordings. Users must register to view the recordings. Scopes: recording:read:admin, recording:read
Rate Limit Label: Medium

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = 85746065; // int | The meeting's ID.    When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
$status = pending; // string | Query by the registrant's status:  * `pending` — The registration is pending.  * `approved` — The registrant is approved.  * `denied` — The registration is denied.
$page_size = 30; // int | The number of records returned within a single API call.
$page_number = 1; // int | **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.
$next_page_token = IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2; // string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

try {
    $result = $apiInstance->meetingRecordingRegistrants($meeting_id, $status, $page_size, $page_number, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->meetingRecordingRegistrants: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	int	The meeting's ID. When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.
status	string	Query by the registrant's status: * `pending` — The registration is pending. * `approved` — The registrant is approved. * `denied` — The registration is denied.	[optional] [default to 'approved']
page_size	int	The number of records returned within a single API call.	[optional] [default to 30]
page_number	int	Deprecated. We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.	[optional] [default to 1]
next_page_token	string	The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.	[optional]

Return type

\Zoom\Api\Model\MeetingRecordingRegistrantList

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingDelete()`

recordingDelete($meeting_id, $action)

Delete meeting recordings

Delete all recording files of a meeting.

Scopes: recording:write:admin recording:write
Rate Limit Label: Light
Prerequisites: * Cloud Recording should be enabled on the user's account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$action = trash; // string | The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.

try {
    $apiInstance->recordingDelete($meeting_id, $action);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
action	string	The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.	[optional] [default to 'trash']

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingDeleteOne()`

recordingDeleteOne($meeting_id, $recording_id, $action)

Delete a meeting recording file

Delete a specific recording file from a meeting.<p style="background-color:#e1f5fe; color:#01579b; padding:8px"> Note: To use this API, you must enable the The host can delete cloud recordings setting. You can find this setting in the Recording tab of the Settings interface in the Zoom web portal.

Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$recording_id = a2f19f96-9294-4f51-8134-6f0eea108eb2; // string | The recording ID.
$action = trash; // string | The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.

try {
    $apiInstance->recordingDeleteOne($meeting_id, $recording_id, $action);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingDeleteOne: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
recording_id	string	The recording ID.
action	string	The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.	[optional] [default to 'trash']

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingGet()`

recordingGet($meeting_id, $include_fields, $ttl): \Zoom\Api\Model\RecordingGet200Response

Get meeting recordings

Use this API to return all of a meeting's recordings. The recording files can be downloaded via the download_url property listed in the response. To access a password-protected cloud recording, add an access_token parameter to the download URL and provide OAuth access token or JWT as the access_token value. Scopes: recording:read:admin, recording:read
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$include_fields = a2f19f96-9294-4f51-8134-6f0eea108eb2; // string | The `download_access_token` value for downloading the meeting's recordings.
$ttl = 1; // int | The `download_access_token` Time to Live (TTL) value. This parameter is only valid if the `include_fields` query parameter contains the `download_access_token` value.

try {
    $result = $apiInstance->recordingGet($meeting_id, $include_fields, $ttl);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
include_fields	string	The `download_access_token` value for downloading the meeting's recordings.	[optional]
ttl	int	The `download_access_token` Time to Live (TTL) value. This parameter is only valid if the `include_fields` query parameter contains the `download_access_token` value.	[optional]

Return type

\Zoom\Api\Model\RecordingGet200Response

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingRegistrantQuestionUpdate()`

recordingRegistrantQuestionUpdate($meeting_id, $recording_registrant_question_update_request)

Update registration questions

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording.
Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$recording_registrant_question_update_request = new \Zoom\Api\Model\RecordingRegistrantQuestionUpdateRequest(); // \Zoom\Api\Model\RecordingRegistrantQuestionUpdateRequest | Recording Registrant Questions

try {
    $apiInstance->recordingRegistrantQuestionUpdate($meeting_id, $recording_registrant_question_update_request);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingRegistrantQuestionUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
recording_registrant_question_update_request	\Zoom\Api\Model\RecordingRegistrantQuestionUpdateRequest	Recording Registrant Questions

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingRegistrantsQuestionsGet()`

recordingRegistrantsQuestionsGet($meeting_id): \Zoom\Api\Model\RecordingRegistrantQuestions

Get registration questions

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
Scopes: recording:read:admin, recording:read
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.

try {
    $result = $apiInstance->recordingRegistrantsQuestionsGet($meeting_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingRegistrantsQuestionsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Return type

\Zoom\Api\Model\RecordingRegistrantQuestions

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingSettingUpdate()`

recordingSettingUpdate($meeting_id): \Zoom\Api\Model\RecordingSettings

Get meeting recording settings

Retrieve settings applied to a meeting's Cloud Recording.

Scopes: recording:read:admin recording:read
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.

try {
    $result = $apiInstance->recordingSettingUpdate($meeting_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingSettingUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Return type

\Zoom\Api\Model\RecordingSettings

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingSettingsUpdate()`

recordingSettingsUpdate($meeting_id, $recording_settings)

Update meeting recording settings

Update settings applied to a meeting's Cloud Recording

Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$recording_settings = new \Zoom\Api\Model\RecordingSettings(); // \Zoom\Api\Model\RecordingSettings

try {
    $apiInstance->recordingSettingsUpdate($meeting_id, $recording_settings);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingSettingsUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
recording_settings	\Zoom\Api\Model\RecordingSettings

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingStatusUpdate()`

recordingStatusUpdate($meeting_uuid, $recording_status_update_request)

Recover meeting recordings

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted Cloud Recordings of a specific meeting.

Scopes: recording:write:admin recording:write
Rate Limit Label: Light
Prerequisites:
* A Pro user with Cloud Recording enabled.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_uuid = 4444AAAiAAAAAiAiAiiAii==; // string | The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.  If the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls.
$recording_status_update_request = new \Zoom\Api\Model\RecordingStatusUpdateRequest(); // \Zoom\Api\Model\RecordingStatusUpdateRequest

try {
    $apiInstance->recordingStatusUpdate($meeting_uuid, $recording_status_update_request);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingStatusUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
meeting_uuid	string	The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a `/` character or contains a `//` character, you must double-encode the meeting UUID when using the meeting UUID for other API calls.
recording_status_update_request	\Zoom\Api\Model\RecordingStatusUpdateRequest

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingStatusUpdateOne()`

recordingStatusUpdateOne($meeting_id, $recording_id, $recording_status_update_request)

Recover a single recording

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
Scopes: recording:write:admin recording:write
Rate Limit Label: Light

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$meeting_id = atsXxhSEQWit9t+U02HXNQ==; // string | To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.   To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.   If a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
$recording_id = a2f19f96-9294-4f51-8134-6f0eea108eb2; // string | The recording ID.
$recording_status_update_request = new \Zoom\Api\Model\RecordingStatusUpdateRequest(); // \Zoom\Api\Model\RecordingStatusUpdateRequest

try {
    $apiInstance->recordingStatusUpdateOne($meeting_id, $recording_id, $recording_status_update_request);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingStatusUpdateOne: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
meeting_id	string	To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.
recording_id	string	The recording ID.
recording_status_update_request	\Zoom\Api\Model\RecordingStatusUpdateRequest

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`recordingsList()`

recordingsList($user_id, $page_size, $next_page_token, $mc, $trash, $from, $to, $trash_type, $meeting_id): \Zoom\Api\Model\RecordingMeetingList

List all recordings

Use this API to list all cloud recordings of a user. For user-level apps, pass the me value instead of the userId parameter. <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> Note: To access a user's password protected cloud recording, add an access_token parameter to the download URL and provide either the <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app\">JWT or the user's OAuth access token as the value of the access_token parameter.

When a user records a meeting or a webinar by choosing the Record to the Cloud option, the video, audio, and chat text are recorded in the Zoom cloud. Scopes: recording:read:admin, recording:read
Rate Limit Label: Medium Prerequisites: * Pro or a higher plan. * Cloud Recording must be enabled on the user's account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\CloudRecordingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = new \Zoom\Api\Model\GroupAdminsDeleteUserIdParameter(); // GroupAdminsDeleteUserIdParameter | The user ID or email address of the user. For user-level apps, pass the `me` value.
$page_size = 30; // int | The number of records returned within a single API call.
$next_page_token = IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2; // string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
$mc = false; // string | Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.
$trash = false; // bool | Query trash. `true`: List recordings from trash.<br> `false`: Do not list recordings from the trash.<br> The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve.
$from = Mon Jun 29 20:00:00 EDT 2020; // \DateTime | The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”.   **Note**: The \"trash\" files cannot be filtered by date range and thus, the \"from\" and \"to\" fields should not be used for trash files.
$to = Mon Jun 29 20:00:00 EDT 2020; // \DateTime | End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.
$trash_type = meeting_recordings; // string | The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:<br>     `meeting_recordings`: List all meeting recordings from the trash.<br>     `recording_file`: List all individual recording files from the trash.
$meeting_id = 6840331990; // int | The meeting ID.

try {
    $result = $apiInstance->recordingsList($user_id, $page_size, $next_page_token, $mc, $trash, $from, $to, $trash_type, $meeting_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudRecordingApi->recordingsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
user_id	GroupAdminsDeleteUserIdParameter	The user ID or email address of the user. For user-level apps, pass the `me` value.
page_size	int	The number of records returned within a single API call.	[optional] [default to 30]
next_page_token	string	The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.	[optional]
mc	string	Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.	[optional] [default to 'false']
trash	bool	Query trash. `true`: List recordings from trash.<br> `false`: Do not list recordings from the trash.<br> The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve.	[optional] [default to false]
from	\DateTime	The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”. Note: The "trash" files cannot be filtered by date range and thus, the "from" and "to" fields should not be used for trash files.	[optional]
to	\DateTime	End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.	[optional]
trash_type	string	The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:<br> `meeting_recordings`: List all meeting recordings from the trash.<br> `recording_file`: List all individual recording files from the trash.	[optional] [default to 'meeting_recordings']
meeting_id	int	The meeting ID.	[optional]

Return type

\Zoom\Api\Model\RecordingMeetingList

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CloudRecordingApi.md

Latest commit

History

CloudRecordingApi.md

File metadata and controls

Zoom\Api\CloudRecordingApi

meetingRecordingRegistrantCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

meetingRecordingRegistrantStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

meetingRecordingRegistrants()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingDeleteOne()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingGet()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingRegistrantQuestionUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingRegistrantsQuestionsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingSettingUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingSettingsUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingStatusUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingStatusUpdateOne()

Example

Parameters

Return type

Authorization

HTTP request headers

recordingsList()

`meetingRecordingRegistrantCreate()`

`meetingRecordingRegistrantStatus()`

`meetingRecordingRegistrants()`

`recordingDelete()`

`recordingDeleteOne()`

`recordingGet()`

`recordingRegistrantQuestionUpdate()`

`recordingRegistrantsQuestionsGet()`

`recordingSettingUpdate()`

`recordingSettingsUpdate()`

`recordingStatusUpdate()`

`recordingStatusUpdateOne()`

`recordingsList()`