WebinarsApi.md

Zoom\Api\WebinarsApi

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

Method	HTTP request	Description
addBatchWebinarRegistrants()	POST /webinars/{webinarId}/batch_registrants	Perform batch registration
createWebinarBrandingNameTag()	POST /webinars/{webinarId}/branding/name_tags	Create a webinar's branding name tag
deleteWebinarBrandingNameTag()	DELETE /webinars/{webinarId}/branding/name_tags	Delete a webinar's branding name tag
deleteWebinarBrandingVB()	DELETE /webinars/{webinarId}/branding/virtual_backgrounds	Delete a webinar's branding Virtual Backgrounds
deleteWebinarBrandingWallpaper()	DELETE /webinars/{webinarId}/branding/wallpaper	Delete a webinar's branding wallpaper
deleteWebinarChatMessageById()	DELETE /live_webinars/{webinarId}/chat/messages/{messageId}	Delete a live webinar message
deleteWebinarRegistrant()	DELETE /webinars/{webinarId}/registrants/{registrantId}	Delete a webinar registrant
getTrackingSources()	GET /webinars/{webinarId}/tracking_sources	Get webinar tracking sources
getWebinarBranding()	GET /webinars/{webinarId}/branding	Get webinar's session branding
getWebinarLiveStreamDetails()	GET /webinars/{webinarId}/livestream	Get live stream details
listPastWebinarPollResults()	GET /past_webinars/{webinarId}/polls	List past webinar poll results
listPastWebinarQA()	GET /past_webinars/{webinarId}/qa	List Q&A of past webinar
listWebinarParticipants()	GET /past_webinars/{webinarId}/participants	List webinar participants
listWebinarTemplates()	GET /users/{userId}/webinar_templates	List webinar templates
pastWebinars()	GET /past_webinars/{webinarId}/instances	List past webinar instances
setWebinarBrandingVB()	PATCH /webinars/{webinarId}/branding/virtual_backgrounds	Set webinar's default branding Virtual Background
updateWebinarBrandingNameTag()	PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}	Update a webinar's branding name tag
uploadWebinarBrandingVB()	POST /webinars/{webinarId}/branding/virtual_backgrounds	Upload a webinar's branding Virtual Background
uploadWebinarBrandingWallpaper()	POST /webinars/{webinarId}/branding/wallpaper	Upload a webinar's branding wallpaper
webinar()	GET /webinars/{webinarId}	Get a webinar
webinarAbsentees()	GET /past_webinars/{WebinarUUID}/absentees	Get webinar absentees
webinarCreate()	POST /users/{userId}/webinars	Create a webinar
webinarDelete()	DELETE /webinars/{webinarId}	Delete a webinar
webinarInviteLinksCreate()	POST /webinars/{webinarId}/invite_links	Create webinar's invite links
webinarLiveStreamStatusUpdate()	PATCH /webinars/{webinarId}/livestream/status	Update Live Stream Status
webinarLiveStreamUpdate()	PATCH /webinars/{webinarId}/livestream	Update a live stream
webinarLocalRecordingJoinToken()	GET /webinars/{webinarId}/jointoken/local_recording	Get a webinar's join token for local recording
webinarPanelistCreate()	POST /webinars/{webinarId}/panelists	Add panelists
webinarPanelistDelete()	DELETE /webinars/{webinarId}/panelists/{panelistId}	Remove a panelist
webinarPanelists()	GET /webinars/{webinarId}/panelists	List panelists
webinarPanelistsDelete()	DELETE /webinars/{webinarId}/panelists	Remove panelists
webinarPollCreate()	POST /webinars/{webinarId}/polls	Create a webinar's poll
webinarPollDelete()	DELETE /webinars/{webinarId}/polls/{pollId}	Delete a webinar poll
webinarPollGet()	GET /webinars/{webinarId}/polls/{pollId}	Get a webinar poll
webinarPollUpdate()	PUT /webinars/{webinarId}/polls/{pollId}	Update a webinar poll
webinarPolls()	GET /webinars/{webinarId}/polls	List a webinar's polls
webinarRegistrantCreate()	POST /webinars/{webinarId}/registrants	Add a webinar registrant
webinarRegistrantGet()	GET /webinars/{webinarId}/registrants/{registrantId}	Get a webinar registrant
webinarRegistrantQuestionUpdate()	PATCH /webinars/{webinarId}/registrants/questions	Update registration questions
webinarRegistrantStatus()	PUT /webinars/{webinarId}/registrants/status	Update registrant's status
webinarRegistrants()	GET /webinars/{webinarId}/registrants	List webinar registrants
webinarRegistrantsQuestionsGet()	GET /webinars/{webinarId}/registrants/questions	List registration questions
webinarStatus()	PUT /webinars/{webinarId}/status	Update webinar status
webinarSurveyDelete()	DELETE /webinars/{webinarId}/survey	Delete a webinar survey
webinarSurveyGet()	GET /webinars/{webinarId}/survey	Get a webinar survey
webinarSurveyUpdate()	PATCH /webinars/{webinarId}/survey	Update a webinar survey
webinarToken()	GET /webinars/{webinarId}/token	Get webinar's token
webinarUpdate()	PATCH /webinars/{webinarId}	Update a webinar
webinars()	GET /users/{userId}/webinars	List webinars

addBatchWebinarRegistrants()

addBatchWebinarRegistrants($webinar_id, $add_batch_registrants_request): \Zoom\Api\Model\AddBatchWebinarRegistrants200Response

Perform batch registration

Use this API to register up to 30 registrants at once for a scheduled webinar that requires registration.
Prerequisites:
* The webinar host must be a Licensed user. * The webinar should be of type 5, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API.

Scope: webinar:write, webinar:write:admin
Rate Limit Label: Heavy

Example

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


// Configure API key authorization: Bearer
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Zoom\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

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


$apiInstance = new Zoom\Api\Api\WebinarsApi(
    // 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
);
$webinar_id = 97871060099; // string | Unique identifier of the webinar.
$add_batch_registrants_request = new \Zoom\Api\Model\AddBatchRegistrantsRequest(); // \Zoom\Api\Model\AddBatchRegistrantsRequest

try {
    $result = $apiInstance->addBatchWebinarRegistrants($webinar_id, $add_batch_registrants_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->addBatchWebinarRegistrants: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	string	Unique identifier of the webinar.
add_batch_registrants_request	\Zoom\Api\Model\AddBatchRegistrantsRequest		[optional]

Return type

\Zoom\Api\Model\AddBatchWebinarRegistrants200Response

Authorization

Bearer, 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]

createWebinarBrandingNameTag()

createWebinarBrandingNameTag($webinar_id, $create_webinar_branding_name_tag_request): \Zoom\Api\Model\CreateWebinarBrandingNameTag201Response

Create a webinar's branding name tag

Use this API to create a webinar's Session Branding name tag. There's a limit of 20 name tags per webinar. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Medium Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$create_webinar_branding_name_tag_request = new \Zoom\Api\Model\CreateWebinarBrandingNameTagRequest(); // \Zoom\Api\Model\CreateWebinarBrandingNameTagRequest

try {
    $result = $apiInstance->createWebinarBrandingNameTag($webinar_id, $create_webinar_branding_name_tag_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->createWebinarBrandingNameTag: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
create_webinar_branding_name_tag_request	\Zoom\Api\Model\CreateWebinarBrandingNameTagRequest

Return type

\Zoom\Api\Model\CreateWebinarBrandingNameTag201Response

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]

deleteWebinarBrandingNameTag()

deleteWebinarBrandingNameTag($webinar_id, $name_tag_ids)

Delete a webinar's branding name tag

Use this API to delete a webinar's Session Branding name tag. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$name_tag_ids = zazQjwDuQkS3Q2EprNd7jQ,AsfE0cx2TFSfqqKbE0BUZg; // string | A comma-separated list of the name tag IDs to delete.

try {
    $apiInstance->deleteWebinarBrandingNameTag($webinar_id, $name_tag_ids);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->deleteWebinarBrandingNameTag: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
name_tag_ids	string	A comma-separated list of the name tag IDs to delete.	[optional]

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]

deleteWebinarBrandingVB()

deleteWebinarBrandingVB($webinar_id, $ids)

Delete a webinar's branding Virtual Backgrounds

Use this API to delete a webinar's session branding Virtual Background. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$ids = zazQjwDuQkS3Q2EprNd7jQ,AsfE0cx2TFSfqqKbE0BUZg; // string | A comma-separated list of the Virtual Background file IDs to delete.

try {
    $apiInstance->deleteWebinarBrandingVB($webinar_id, $ids);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->deleteWebinarBrandingVB: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
ids	string	A comma-separated list of the Virtual Background file IDs to delete.	[optional]

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]

deleteWebinarBrandingWallpaper()

deleteWebinarBrandingWallpaper($webinar_id)

Delete a webinar's branding wallpaper

Use this API to delete a webinar's session branding wallpaper file. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

try {
    $apiInstance->deleteWebinarBrandingWallpaper($webinar_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->deleteWebinarBrandingWallpaper: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

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]

deleteWebinarChatMessageById()

deleteWebinarChatMessageById($webinar_id, $message_id)

Delete a live webinar message

Deletes a message in a live webinar based on ID. Scopes: webinar:write webinar:write:admin
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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$message_id = MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ==; // string | The live webinar chat message's unique identifier (UUID), in base64-encoded format.

try {
    $apiInstance->deleteWebinarChatMessageById($webinar_id, $message_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->deleteWebinarChatMessageById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
message_id	string	The live webinar chat message's unique identifier (UUID), in base64-encoded format.

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]

deleteWebinarRegistrant()

deleteWebinarRegistrant($webinar_id, $registrant_id, $occurrence_id)

Delete a webinar registrant

Delete a webinar registrant.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 95204914252; // int | The webinar ID.
$registrant_id = 9tboDiHUQAeOnbmudzWa5g; // string | The registrant ID.
$occurrence_id = 1648538280000; // string | The webinar occurrence ID.

try {
    $apiInstance->deleteWebinarRegistrant($webinar_id, $registrant_id, $occurrence_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->deleteWebinarRegistrant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar ID.
registrant_id	string	The registrant ID.
occurrence_id	string	The webinar occurrence ID.	[optional]

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]

getTrackingSources()

getTrackingSources($webinar_id): \Zoom\Api\Model\GetTrackingSources200Response

Get webinar tracking sources

Webinar Registration Tracking Sources allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
Use this API to list information on all the tracking sources of a Webinar.
Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium
Prerequisites:
* Webinar license. * Registration must be required for the Webinar.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\GetTrackingSources200Response

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]

getWebinarBranding()

getWebinarBranding($webinar_id): \Zoom\Api\Model\GetWebinarBranding200Response

Get webinar's session branding

Use this API to get the webinar's Session Branding information. Session branding lets hosts visually customize a webinar by setting a webinar wallpaper that displays behind video tiles. Session branding also lets hosts set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers. Scopes: webinar:read, webinar:read:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\GetWebinarBranding200Response

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]

getWebinarLiveStreamDetails()

getWebinarLiveStreamDetails($webinar_id): \Zoom\Api\Model\GetWebinarLiveStreamDetails200Response

Get live stream details

Zoom allows users to live stream a webinar to a custom platform. Use this API to get a webinar's live stream configuration details such as Stream URL, Stream Key and Page URL.

Prerequisites:
* Pro or higher plan with a Webinar Add-on.
* Live streaming details must have been configured for the webinar.

Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 95204914252; // string | The webinar's unique ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	string	The webinar's unique ID.

Return type

\Zoom\Api\Model\GetWebinarLiveStreamDetails200Response

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]

listPastWebinarPollResults()

listPastWebinarPollResults($webinar_id): \Zoom\Api\Model\ListPastWebinarPollResults200Response

List past webinar poll results

The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. Prerequisites:
* Webinar license
Scopes: webinar:read:admin, webinar: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\WebinarsApi(
    // 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
);
$webinar_id = ABCDE12345; // string | The webinar's ID or universally unique ID (UUID).  * If you provide a webinar ID, the API will return a response for the latest webinar instance.  * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.

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

Parameters

Name	Type	Description	Notes
webinar_id	string	The webinar's ID or universally unique ID (UUID). * If you provide a webinar ID, the API will return a response for the latest webinar instance. * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you must double-encode the webinar UUID before making an API request.

Return type

\Zoom\Api\Model\ListPastWebinarPollResults200Response

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]

listPastWebinarQA()

listPastWebinarQA($webinar_id): \Zoom\Api\Model\ListPastWebinarQA200Response

List Q&A of past webinar

The Question & Answer (Q&A) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
Use this API to list Q&A of a specific Webinar. Prerequisites:
* Webinar license
Scopes: webinar:read:admin, webinar: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\WebinarsApi(
    // 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
);
$webinar_id = ABCDE12345; // string | The webinar's ID or universally unique ID (UUID).  * If you provide a webinar ID, the API will return a response for the latest webinar instance.  * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.

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

Parameters

Name	Type	Description	Notes
webinar_id	string	The webinar's ID or universally unique ID (UUID). * If you provide a webinar ID, the API will return a response for the latest webinar instance. * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you must double-encode the webinar UUID before making an API request.

Return type

\Zoom\Api\Model\ListPastWebinarQA200Response

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]

listWebinarParticipants()

listWebinarParticipants($webinar_id, $page_size, $next_page_token): \Zoom\Api\Model\ListWebinarParticipants200Response

List webinar participants

Use this API to list all the participants who attended a webinar hosted in the past. Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium Prerequisites: * A Pro or higher plan with a Webinar add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 95204914252; // string | The webinar's ID. To get this value, use the [**List webinars**](/docs/api-reference/zoom-api/methods#operation/webinars) API.
$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.

try {
    $result = $apiInstance->listWebinarParticipants($webinar_id, $page_size, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->listWebinarParticipants: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	string	The webinar's ID. To get this value, use the List webinars API.
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]

Return type

\Zoom\Api\Model\ListWebinarParticipants200Response

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]

listWebinarTemplates()

listWebinarTemplates($user_id): \Zoom\Api\Model\ListWebinarTemplates200Response

List webinar templates

Use this API to list a user's webinar templates. For user-level apps, pass the me value instead of the userId parameter. When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars. To use a template when scheduling a webinar, use the id value in this API response in the template_id field of the Create a webinar API. Scopes: webinar:read, webinar:read:admin Prerequisites: * A Pro or a higher account with the Zoom Webinar plan.

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\WebinarsApi(
    // 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 = abcD3ojfdbjfg; // string | The user's ID. To get a user's ID, use the [**List users**](/docs/api-reference/zoom-api/ma#operation/users) API. For user-level apps, pass the `me` value instead of the user ID value.

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

Parameters

Name	Type	Description	Notes
user_id	string	The user's ID. To get a user's ID, use the List users API. For user-level apps, pass the `me` value instead of the user ID value.

Return type

\Zoom\Api\Model\ListWebinarTemplates200Response

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]

pastWebinars()

pastWebinars($webinar_id): \Zoom\Api\Model\WebinarInstances

List past webinar instances

List past webinar instances.

Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\WebinarInstances

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]

setWebinarBrandingVB()

setWebinarBrandingVB($webinar_id, $id, $set_default_for_all_panelists)

Set webinar's default branding Virtual Background

Use this API to set a webinar's default session branding Virtual Background. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$id = zazQjwDuQkS3Q2EprNd7jQ; // string | The Virtual Background file ID to update.
$set_default_for_all_panelists = true; // bool | Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background.

try {
    $apiInstance->setWebinarBrandingVB($webinar_id, $id, $set_default_for_all_panelists);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->setWebinarBrandingVB: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
id	string	The Virtual Background file ID to update.	[optional]
set_default_for_all_panelists	bool	Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background.	[optional]

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]

updateWebinarBrandingNameTag()

updateWebinarBrandingNameTag($webinar_id, $name_tag_id, $update_webinar_branding_name_tag_request)

Update a webinar's branding name tag

Use this API to update a webinar's Session Branding name tag. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Medium Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$name_tag_id = J0sFXN2PSOCGrqTqLRwgAQ; // string | The name tag's ID.
$update_webinar_branding_name_tag_request = new \Zoom\Api\Model\UpdateWebinarBrandingNameTagRequest(); // \Zoom\Api\Model\UpdateWebinarBrandingNameTagRequest

try {
    $apiInstance->updateWebinarBrandingNameTag($webinar_id, $name_tag_id, $update_webinar_branding_name_tag_request);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->updateWebinarBrandingNameTag: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
name_tag_id	string	The name tag's ID.
update_webinar_branding_name_tag_request	\Zoom\Api\Model\UpdateWebinarBrandingNameTagRequest

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]

uploadWebinarBrandingVB()

uploadWebinarBrandingVB($webinar_id, $file, $default, $set_default_for_all_panelists): \Zoom\Api\Model\UploadWebinarBrandingVB201Response

Upload a webinar's branding Virtual Background

Use this API to upload a webinar's session branding Virtual Background. Hosts and panelists can select and use these Virtual Backgrounds during the webinar. Branding Virtual Background files have the following restrictions: * A webinar cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * The Virtual Background file size cannot exceed 15 megabytes (MB). Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Medium Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$file = "/path/to/file.txt"; // \SplFileObject | The Virtual Background's file path, in binary format.
$default = false; // bool | Whether set the file as the default Virtual Background file.
$set_default_for_all_panelists = true; // bool | Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background.

try {
    $result = $apiInstance->uploadWebinarBrandingVB($webinar_id, $file, $default, $set_default_for_all_panelists);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->uploadWebinarBrandingVB: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
file	\SplFileObject**\SplFileObject**	The Virtual Background's file path, in binary format.
default	bool	Whether set the file as the default Virtual Background file.	[optional] [default to false]
set_default_for_all_panelists	bool	Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background.	[optional] [default to true]

Return type

\Zoom\Api\Model\UploadWebinarBrandingVB201Response

Authorization

OAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

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

uploadWebinarBrandingWallpaper()

uploadWebinarBrandingWallpaper($webinar_id, $file): \Zoom\Api\Model\UploadWebinarBrandingWallpaper201Response

Upload a webinar's branding wallpaper

Use this API to upload a webinar's session branding wallpaper file. Webinar branding wallpaper files have the following requirements: * A webinar can only have one wallpaper file. * You can only upload image files that are in JPG/JPEG, GIF, or PNG format. * Image files must be 16:9 ratio. The recommended image size is 1920 x 1080 pixels (px). * The wallpaper file size cannot exceed 15 megabytes (MB). Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Medium Prerequisites: * The Webinar Session Branding setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$file = "/path/to/file.txt"; // \SplFileObject | The wallpaper's file path, in binary format.

try {
    $result = $apiInstance->uploadWebinarBrandingWallpaper($webinar_id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->uploadWebinarBrandingWallpaper: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
file	\SplFileObject**\SplFileObject**	The wallpaper's file path, in binary format.

Return type

\Zoom\Api\Model\UploadWebinarBrandingWallpaper201Response

Authorization

OAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

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

webinar()

webinar($webinar_id, $occurrence_id, $show_previous_occurrences): \Zoom\Api\Model\Webinar200Response

Get a webinar

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to get details of a scheduled webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light
Prerequisites: * Pro or higher plan with a Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 95204914252; // string | The webinar's ID or universally unique ID (UUID).
$occurrence_id = 1648538280000; // string | Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [**Create a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API, you can retrieve the Occurrence ID from the response of the API call.
$show_previous_occurrences = true; // bool | Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

try {
    $result = $apiInstance->webinar($webinar_id, $occurrence_id, $show_previous_occurrences);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinar: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	string	The webinar's ID or universally unique ID (UUID).
occurrence_id	string	Unique Identifier that identifies an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences. When you create a recurring Webinar using Create a webinar API, you can retrieve the Occurrence ID from the response of the API call.	[optional]
show_previous_occurrences	bool	Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar.	[optional]

Return type

\Zoom\Api\Model\Webinar200Response

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]

webinarAbsentees()

webinarAbsentees($webinar_uuid, $occurrence_id, $page_size, $next_page_token): \Zoom\Api\Model\WebinarRegistrantList

Get webinar absentees

List absentees of a webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Heavy

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\WebinarsApi(
    // 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
);
$webinar_uuid = Bznyg8KZTdCVbQxvS/oZ7w==; // string | The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it.
$occurrence_id = 1648194360000; // string | The meeting or webinar occurrence ID.
$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.

try {
    $result = $apiInstance->webinarAbsentees($webinar_uuid, $occurrence_id, $page_size, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarAbsentees: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_uuid	string	The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it.
occurrence_id	string	The meeting or webinar occurrence ID.	[optional]
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]

Return type

\Zoom\Api\Model\WebinarRegistrantList

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]

webinarCreate()

webinarCreate($user_id, $webinar_create_request): \Zoom\Api\Model\WebinarCreate201Response

Create a webinar

Use this API to schedule a webinar for a user (webinar host). For user-level apps, pass the me value instead of the userId parameter. Zoom users with a Webinar plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light * This API has a daily rate limit of 100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request. Prerequisites: * A Pro or higher plan with a Webinar add-on.

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\WebinarsApi(
    // 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.
$webinar_create_request = new \Zoom\Api\Model\WebinarCreateRequest(); // \Zoom\Api\Model\WebinarCreateRequest

try {
    $result = $apiInstance->webinarCreate($user_id, $webinar_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarCreate: ', $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.
webinar_create_request	\Zoom\Api\Model\WebinarCreateRequest

Return type

\Zoom\Api\Model\WebinarCreate201Response

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]

webinarDelete()

webinarDelete($webinar_id, $occurrence_id, $cancel_webinar_reminder)

Delete a webinar

Delete a Webinar.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light
Prerequisites:
* Pro or higher plan with a Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$occurrence_id = 1648194360000; // string | The meeting or webinar occurrence ID.
$cancel_webinar_reminder = true; // bool | `true`: Notify panelists and registrants about the webinar cancellation via email.   `false`: Do not send any email notification to webinar registrants and panelists.   The default value of this field is `false`.

try {
    $apiInstance->webinarDelete($webinar_id, $occurrence_id, $cancel_webinar_reminder);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
occurrence_id	string	The meeting or webinar occurrence ID.	[optional]
cancel_webinar_reminder	bool	`true`: Notify panelists and registrants about the webinar cancellation via email. `false`: Do not send any email notification to webinar registrants and panelists. The default value of this field is `false`.	[optional]

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]

webinarInviteLinksCreate()

webinarInviteLinksCreate($webinar_id, $meeting_invite_links_create_request): \Zoom\Api\Model\MeetingInviteLinksCreate201Response

Create webinar's invite links

Use this API to create a batch of invitation links for a webinar. Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light Prerequisites: * Business, Education or API Plan with Webinar add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$meeting_invite_links_create_request = new \Zoom\Api\Model\MeetingInviteLinksCreateRequest(); // \Zoom\Api\Model\MeetingInviteLinksCreateRequest | Webinar invite link object

try {
    $result = $apiInstance->webinarInviteLinksCreate($webinar_id, $meeting_invite_links_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarInviteLinksCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
meeting_invite_links_create_request	\Zoom\Api\Model\MeetingInviteLinksCreateRequest	Webinar invite link object

Return type

\Zoom\Api\Model\MeetingInviteLinksCreate201Response

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]

webinarLiveStreamStatusUpdate()

webinarLiveStreamStatusUpdate($webinar_id, $webinar_live_stream_status)

Update Live Stream Status

Zoom allows users to live stream a webinar to a custom platform. Use this API to update the status of a webinar's live stream.

Prerequisites:
* Pro or higher plan with a Webinar Add-on.
* Live streaming details must have been configured for the webinar.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_live_stream_status = new \Zoom\Api\Model\WebinarLiveStreamStatus(); // \Zoom\Api\Model\WebinarLiveStreamStatus | Webinar

try {
    $apiInstance->webinarLiveStreamStatusUpdate($webinar_id, $webinar_live_stream_status);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarLiveStreamStatusUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_live_stream_status	\Zoom\Api\Model\WebinarLiveStreamStatus	Webinar

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]

webinarLiveStreamUpdate()

webinarLiveStreamUpdate($webinar_id, $webinar_live_stream)

Update a live stream

Zoom allows users to live stream a webinar to a custom platform. Use this API to update a webinar's live stream information.

Prerequisites:
* Pro or higher plan with a Webinar Add-on.
* Live streaming details must have been configured for the webinar.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_live_stream = new \Zoom\Api\Model\WebinarLiveStream(); // \Zoom\Api\Model\WebinarLiveStream | Webinar

try {
    $apiInstance->webinarLiveStreamUpdate($webinar_id, $webinar_live_stream);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarLiveStreamUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_live_stream	\Zoom\Api\Model\WebinarLiveStream	Webinar

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]

webinarLocalRecordingJoinToken()

webinarLocalRecordingJoinToken($webinar_id): \Zoom\Api\Model\WebinarLocalRecordingJoinToken200Response

Get a webinar's join token for local recording

Use this API to get a webinar's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom webinar. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types. Scopes: webinar_token:read:admin:local_recording, webinar_token:read:local_recording
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with a Webinar Add-on. * The Local recording user setting enabled in the Zoom web portal.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\WebinarLocalRecordingJoinToken200Response

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]

webinarPanelistCreate()

webinarPanelistCreate($webinar_id, $webinar_panelist)

Add panelists

Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
Use this API to add panelists to a scheduled webinar.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Medium
Prerequisites: * Pro or a higher plan with Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_panelist = new \Zoom\Api\Model\WebinarPanelist(); // \Zoom\Api\Model\WebinarPanelist

try {
    $apiInstance->webinarPanelistCreate($webinar_id, $webinar_panelist);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPanelistCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_panelist	\Zoom\Api\Model\WebinarPanelist

Return type

void (empty response body)

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]

webinarPanelistDelete()

webinarPanelistDelete($webinar_id, $panelist_id)

Remove a panelist

Remove a single panelist from a webinar.
You can retrieve the panelistId by calling List Panelists API.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light
Prerequisites:
* Pro or a higher plan with Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$panelist_id = Tg2b6GhcQKKbV7nSCbDKug; // string | The panelist ID or panelist email.

try {
    $apiInstance->webinarPanelistDelete($webinar_id, $panelist_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPanelistDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
panelist_id	string	The panelist ID or panelist email.

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]

webinarPanelists()

webinarPanelists($webinar_id): \Zoom\Api\Model\WebinarPanelistList

List panelists

Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Medium
Prerequisites:
* Pro or a higher plan with Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\WebinarPanelistList

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]

webinarPanelistsDelete()

webinarPanelistsDelete($webinar_id)

Remove panelists

Remove all the panelists from a Webinar.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light
Prerequisites:
* Pro or a higher plan with Webinar Add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

try {
    $apiInstance->webinarPanelistsDelete($webinar_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPanelistsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

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]

webinarPollCreate()

webinarPollCreate($webinar_id, $meeting_poll_create_request): \Zoom\Api\Model\WebinarPollCreate201Response

Create a webinar's poll

Create a poll for a webinar.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$meeting_poll_create_request = new \Zoom\Api\Model\MeetingPollCreateRequest(); // \Zoom\Api\Model\MeetingPollCreateRequest | Webinar poll object

try {
    $result = $apiInstance->webinarPollCreate($webinar_id, $meeting_poll_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPollCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
meeting_poll_create_request	\Zoom\Api\Model\MeetingPollCreateRequest	Webinar poll object

Return type

\Zoom\Api\Model\WebinarPollCreate201Response

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]

webinarPollDelete()

webinarPollDelete($webinar_id, $poll_id)

Delete a webinar poll

Delete a webinar's poll.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$poll_id = QalIoKWLTJehBJ8e1xRrbQ; // string | The poll ID

try {
    $apiInstance->webinarPollDelete($webinar_id, $poll_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPollDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
poll_id	string	The poll ID

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]

webinarPollGet()

webinarPollGet($webinar_id, $poll_id): \Zoom\Api\Model\WebinarPollCreate201Response

Get a webinar poll

Get a webinar's poll details.

Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$poll_id = QalIoKWLTJehBJ8e1xRrbQ; // string | The poll ID

try {
    $result = $apiInstance->webinarPollGet($webinar_id, $poll_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPollGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
poll_id	string	The poll ID

Return type

\Zoom\Api\Model\WebinarPollCreate201Response

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]

webinarPollUpdate()

webinarPollUpdate($webinar_id, $poll_id, $meeting_poll_create_request)

Update a webinar poll

Update a webinar's poll.

Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$poll_id = QalIoKWLTJehBJ8e1xRrbQ; // string | The poll ID
$meeting_poll_create_request = new \Zoom\Api\Model\MeetingPollCreateRequest(); // \Zoom\Api\Model\MeetingPollCreateRequest | Webinar Poll

try {
    $apiInstance->webinarPollUpdate($webinar_id, $poll_id, $meeting_poll_create_request);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPollUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
poll_id	string	The poll ID
meeting_poll_create_request	\Zoom\Api\Model\MeetingPollCreateRequest	Webinar Poll

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]

webinarPolls()

webinarPolls($webinar_id, $anonymous): \Zoom\Api\Model\PollList

List a webinar's polls

List all the polls of a Webinar.

Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$anonymous = true; // bool | Whether to query for polls with the **Anonymous** option enabled:  * `true` — Query for polls with the **Anonymous** option enabled.  * `false` — Do not query for polls with the **Anonymous** option enabled.

try {
    $result = $apiInstance->webinarPolls($webinar_id, $anonymous);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarPolls: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
anonymous	bool	Whether to query for polls with the Anonymous option enabled: * `true` — Query for polls with the Anonymous option enabled. * `false` — Do not query for polls with the Anonymous option enabled.	[optional]

Return type

\Zoom\Api\Model\PollList

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]

webinarRegistrantCreate()

webinarRegistrantCreate($webinar_id, $webinar_registrant_create_request, $occurrence_ids): \Zoom\Api\Model\WebinarRegistrantCreate201Response

Add a webinar registrant

Use this API to create and submit a user's registration for a webinar. Zoom users with a Webinar plan have access to creating and managing webinars. Webinars allow hosts to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a webinar with registration requires your registrants to complete a brief form before receiving the link to join the webinar. Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_registrant_create_request = new \Zoom\Api\Model\WebinarRegistrantCreateRequest(); // \Zoom\Api\Model\WebinarRegistrantCreateRequest
$occurrence_ids = 1648538280000; // string | A comma-separated list of webinar occurrence IDs. You can get this value with the [Get a webinar](/docs/api-reference/zoom-api/methods/#operation/webinarUpdate) API.

try {
    $result = $apiInstance->webinarRegistrantCreate($webinar_id, $webinar_registrant_create_request, $occurrence_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarRegistrantCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_registrant_create_request	\Zoom\Api\Model\WebinarRegistrantCreateRequest
occurrence_ids	string	A comma-separated list of webinar occurrence IDs. You can get this value with the Get a webinar API.	[optional]

Return type

\Zoom\Api\Model\WebinarRegistrantCreate201Response

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]

webinarRegistrantGet()

webinarRegistrantGet($webinar_id, $registrant_id, $occurrence_id): \Zoom\Api\Model\WebinarRegistrant

Get a webinar registrant

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to get details on a specific user who has registered for the Webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light
Prerequisites:
* The account must have a Webinar plan.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$registrant_id = 9tboDiHUQAeOnbmudzWa5g; // string | The registrant ID.
$occurrence_id = 1648194360000; // string | The meeting or webinar occurrence ID.

try {
    $result = $apiInstance->webinarRegistrantGet($webinar_id, $registrant_id, $occurrence_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarRegistrantGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
registrant_id	string	The registrant ID.
occurrence_id	string	The meeting or webinar occurrence ID.	[optional]

Return type

\Zoom\Api\Model\WebinarRegistrant

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]

webinarRegistrantQuestionUpdate()

webinarRegistrantQuestionUpdate($webinar_id, $webinar_registrants_questions_get200_response)

Update registration questions

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.

Prerequisites:
* Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. Scopes: webinar:write:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_registrants_questions_get200_response = new \Zoom\Api\Model\WebinarRegistrantsQuestionsGet200Response(); // \Zoom\Api\Model\WebinarRegistrantsQuestionsGet200Response | Webinar Registrant Questions

try {
    $apiInstance->webinarRegistrantQuestionUpdate($webinar_id, $webinar_registrants_questions_get200_response);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarRegistrantQuestionUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_registrants_questions_get200_response	\Zoom\Api\Model\WebinarRegistrantsQuestionsGet200Response	Webinar 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]

webinarRegistrantStatus()

webinarRegistrantStatus($webinar_id, $webinar_registrant_status_request, $occurrence_id)

Update registrant's status

Use this API to update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval. Scopes: webinar:write:admin, webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_registrant_status_request = new \Zoom\Api\Model\WebinarRegistrantStatusRequest(); // \Zoom\Api\Model\WebinarRegistrantStatusRequest
$occurrence_id = 1648194360000; // string | The meeting or webinar occurrence ID.

try {
    $apiInstance->webinarRegistrantStatus($webinar_id, $webinar_registrant_status_request, $occurrence_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarRegistrantStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_registrant_status_request	\Zoom\Api\Model\WebinarRegistrantStatusRequest
occurrence_id	string	The meeting or webinar occurrence ID.	[optional]

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]

webinarRegistrants()

webinarRegistrants($webinar_id, $occurrence_id, $status, $tracking_source_id, $page_size, $page_number, $next_page_token): \Zoom\Api\Model\WebinarRegistrantList

List webinar registrants

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to list all the users that have registered for a webinar.

Prerequisites: * Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$occurrence_id = 1648194360000; // string | The meeting or webinar occurrence ID.
$status = pending; // string | Query by the registrant's status:  * `pending` — The registration is pending.  * `approved` — The registrant is approved.  * `denied` — The registration is denied.
$tracking_source_id = 5516482804110; // string | The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See [Creating source tracking links for webinar registration](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-source-tracking-links-for-webinar-registration) for details.
$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->webinarRegistrants($webinar_id, $occurrence_id, $status, $tracking_source_id, $page_size, $page_number, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarRegistrants: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
occurrence_id	string	The meeting or webinar occurrence ID.	[optional]
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']
tracking_source_id	string	The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details.	[optional]
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\WebinarRegistrantList

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]

webinarRegistrantsQuestionsGet()

webinarRegistrantsQuestionsGet($webinar_id): \Zoom\Api\Model\WebinarRegistrantsQuestionsGet200Response

List registration questions

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
Prerequisites:
* Pro or higher plan with a Webinar Add-on. Scopes: webinar:read:admin webinar: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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\WebinarRegistrantsQuestionsGet200Response

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]

webinarStatus()

webinarStatus($webinar_id, $webinar_status_request)

Update webinar status

Update a webinar's status. Use this API to end an ongoing webinar.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light
Prerequisites:
* The account must hold a valid Webinar plan.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_status_request = new \Zoom\Api\Model\WebinarStatusRequest(); // \Zoom\Api\Model\WebinarStatusRequest

try {
    $apiInstance->webinarStatus($webinar_id, $webinar_status_request);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_status_request	\Zoom\Api\Model\WebinarStatusRequest

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]

webinarSurveyDelete()

webinarSurveyDelete($webinar_id)

Delete a webinar survey

Use this API to delete a webinar survey. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar Add-on. * The Webinar Survey feature enabled in the host'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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

try {
    $apiInstance->webinarSurveyDelete($webinar_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarSurveyDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

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]

webinarSurveyGet()

webinarSurveyGet($webinar_id): \Zoom\Api\Model\WebinarSurveyGet200Response

Get a webinar survey

Use this API to return information about a webinar survey. Scopes: webinar:read, webinar:read:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Webinar Survey feature enabled in the host'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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.

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

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.

Return type

\Zoom\Api\Model\WebinarSurveyGet200Response

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]

webinarSurveyUpdate()

webinarSurveyUpdate($webinar_id, $webinar_survey_get200_response)

Update a webinar survey

Use this API to update a webinar survey. Scopes: webinar:write, webinar:write:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Webinar Survey feature enabled in the host'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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_survey_get200_response = new \Zoom\Api\Model\WebinarSurveyGet200Response(); // \Zoom\Api\Model\WebinarSurveyGet200Response

try {
    $apiInstance->webinarSurveyUpdate($webinar_id, $webinar_survey_get200_response);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarSurveyUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_survey_get200_response	\Zoom\Api\Model\WebinarSurveyGet200Response

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]

webinarToken()

webinarToken($webinar_id, $type): \Zoom\Api\Model\WebinarToken200Response

Get webinar's token

Use this API to get a webinar's closed caption token (caption URL). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom webinar. Scopes: webinar:read, webinar:read:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Closed captioning setting enabled in the Zoom web portal. * * The Allow use of caption API Token to integrate with 3rd-party Closed Captioning services setting 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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$type = closed_caption_token; // string | The webinar token type:  * `closed_caption_token` — The third-party closed caption API token.   This defaults to `closed_caption_token`.

try {
    $result = $apiInstance->webinarToken($webinar_id, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
type	string	The webinar token type: * `closed_caption_token` — The third-party closed caption API token. This defaults to `closed_caption_token`.	[optional] [default to 'closed_caption_token']

Return type

\Zoom\Api\Model\WebinarToken200Response

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]

webinarUpdate()

webinarUpdate($webinar_id, $webinar_update, $occurrence_id)

Update a webinar

Use this API to make updates to a scheduled webinar. Scopes: webinar:write:admin, webinar:write
Rate Limit Label: Light * This API has a daily rate limit of 100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request. Prerequisites: * A Pro or higher plan with a Webinar add-on.

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\WebinarsApi(
    // 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
);
$webinar_id = 99289110036; // int | The webinar's ID.
$webinar_update = new \Zoom\Api\Model\WebinarUpdate(); // \Zoom\Api\Model\WebinarUpdate | Webinar.
$occurrence_id = 1648538280000; // string | Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}

try {
    $apiInstance->webinarUpdate($webinar_id, $webinar_update, $occurrence_id);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinarUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webinar_id	int	The webinar's ID.
webinar_update	\Zoom\Api\Model\WebinarUpdate	Webinar.
occurrence_id	string	Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}	[optional]

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]

webinars()

webinars($user_id, $page_size, $page_number): \Zoom\Api\Model\WebinarList

List webinars

Use this API to list all the webinars scheduled by or on-behalf a user (webinar host). For user-level apps, pass the me value instead of the userId parameter. Zoom users with a Webinar Plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. Note: This API only returns a user's unexpired webinars. Scopes: webinar:read:admin, webinar:read
Rate Limit Label: Medium Prerequisites: * A Pro or higher plan with the Webinar add-on.

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\WebinarsApi(
    // 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.
$page_number = 1; // int | **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.

try {
    $result = $apiInstance->webinars($user_id, $page_size, $page_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebinarsApi->webinars: ', $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]
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]

Return type

\Zoom\Api\Model\WebinarList

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]