Zoom\Api\GroupsApi

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

Method	HTTP request	Description
delGroupVB()	DELETE /groups/{groupId}/settings/virtual_backgrounds	Delete Virtual Background files
getGroupLockSettings()	GET /groups/{groupId}/lock_settings	Get locked settings
getGroupSettings()	GET /groups/{groupId}/settings	Get a group's settings
group()	GET /groups/{groupId}	Get a group
groupAdmins()	GET /groups/{groupId}/admins	List group admins
groupAdminsCreate()	POST /groups/{groupId}/admins	Add group admins
groupAdminsDelete()	DELETE /groups/{groupId}/admins/{userId}	Delete a group admin
groupCreate()	POST /groups	Create a group
groupDelete()	DELETE /groups/{groupId}	Delete a group
groupLockedSettings()	PATCH /groups/{groupId}/lock_settings	Update locked settings
groupMembers()	GET /groups/{groupId}/members	List group members
groupMembersCreate()	POST /groups/{groupId}/members	Add group members
groupMembersDelete()	DELETE /groups/{groupId}/members/{memberId}	Delete a group member
groupUpdate()	PATCH /groups/{groupId}	Update a group
groups()	GET /groups	List groups
updateAGroupMember()	PATCH /groups/{groupId}/members/{memberId}	Update a group member
updateGroupSettings()	PATCH /groups/{groupId}/settings	Update a group's settings
uploadGroupVB()	POST /groups/{groupId}/settings/virtual_backgrounds	Upload Virtual Background files

`delGroupVB()`

delGroupVB($group_id, $file_ids)

Delete Virtual Background files

Use this API to delete a group's Virtual Background files. Scope: group:write:admin
Rate Limit Label: Light Prerequisites: * The Virtual Background feature must be enabled on the 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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string | The group ID. To get a group's ID, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$file_ids = 6SEYvTU4SuG257lOHuJKOQ; // string | A comma-separated list of the file IDs to delete.

try {
    $apiInstance->delGroupVB($group_id, $file_ids);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->delGroupVB: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID. To get a group's ID, use the List groups API.
file_ids	string	A comma-separated list of the 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]

`getGroupLockSettings()`

getGroupLockSettings($group_id, $option): \Zoom\Api\Model\GetGroupLockSettings200Response

Get locked settings

Retrieve a group's locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style="background-color:#FEEFB3; color:#9F6000">
Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:read: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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string | Id of the group.
$option = meeting_security; // string | Optional query parameters:  * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.

try {
    $result = $apiInstance->getGroupLockSettings($group_id, $option);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroupLockSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	Id of the group.
option	string	Optional query parameters: * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.	[optional]

Return type

\Zoom\Api\Model\GetGroupLockSettings200Response

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]

`getGroupSettings()`

getGroupSettings($group_id, $option, $custom_query_fields): \Zoom\Api\Model\GetGroupSettings200Response

Get a group's settings

Get settings for a group. Prerequisite: Pro, Business, or Education account
Scopes: group:read: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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string
$option = meeting_security; // string | Optional query parameters:  * `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account.  * `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account.  * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.
$custom_query_fields = host_video; // string | Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following:   {  \"schedule_meeting\": {  \"host_video\": false  } }   You can provide multiple values by separating them with commas(example: \"host_video,participant_video\").

try {
    $result = $apiInstance->getGroupSettings($group_id, $option, $custom_query_fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroupSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string
option	string	Optional query parameters: * `meeting_authentication` — Use this query parameter to view the meeting authentication settings applied to the user's account. * `recording_authentication` — Use this query parameter to view the recording authentication settings applied to the user's account. * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.	[optional]
custom_query_fields	string	Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video").	[optional]

Return type

\Zoom\Api\Model\GetGroupSettings200Response

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]

`group()`

group($group_id): \Zoom\Api\Model\Group200Response

Get a group

Get a group under an account. Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin
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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.

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

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.

Return type

\Zoom\Api\Model\Group200Response

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]

`groupAdmins()`

groupAdmins($group_id, $page_size, $next_page_token): \Zoom\Api\Model\GroupAdmins200Response

List group admins

Use this API to return a list of group administrators under your account. Scopes: group:read:admin
Rate Limit Label: Medium Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) 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->groupAdmins($group_id, $page_size, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupAdmins: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups 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\GroupAdmins200Response

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]

`groupAdminsCreate()`

groupAdminsCreate($group_id, $group_admins_create_request)

Add group admins

Use this API to add administrators to a group under your account. Scopes: group:write:admin
Rate Limit Label: Medium Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$group_admins_create_request = new \Zoom\Api\Model\GroupAdminsCreateRequest(); // \Zoom\Api\Model\GroupAdminsCreateRequest

try {
    $apiInstance->groupAdminsCreate($group_id, $group_admins_create_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupAdminsCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
group_admins_create_request	\Zoom\Api\Model\GroupAdminsCreateRequest

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]

`groupAdminsDelete()`

groupAdminsDelete($group_id, $user_id)

Delete a group admin

Use this API to remove a group administrator in a Zoom account. Scopes: group:write:admin
Rate Limit Label: Light Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$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.

try {
    $apiInstance->groupAdminsDelete($group_id, $user_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupAdminsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
user_id	GroupAdminsDeleteUserIdParameter	The user ID or email address of the user. For user-level apps, pass the `me` value.

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]

`groupCreate()`

groupCreate($group_create_request)

Create a group

Use this API to create a group. You can add a maximum of 100 groups in one account per day, and a maximum of 5000 groups in one account. If you enabled a new group via the user interface, you can also choose whether to display the group and set its privacy level. Scopes: group:write:admin
Rate Limit Label: Light Prerequisites: * A Pro or higher 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\GroupsApi(
    // 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
);
$group_create_request = new \Zoom\Api\Model\GroupCreateRequest(); // \Zoom\Api\Model\GroupCreateRequest

try {
    $apiInstance->groupCreate($group_create_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_create_request	\Zoom\Api\Model\GroupCreateRequest

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]

`groupDelete()`

groupDelete($group_id)

Delete a group

Use this API to delete a group. Scopes: group:write:admin
Rate Limit Label: Light Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.

try {
    $apiInstance->groupDelete($group_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.

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]

`groupLockedSettings()`

groupLockedSettings($group_id, $option, $group_locked_settings_request)

Update locked settings

Update a group's locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style="background-color:#FEEFB3; color:#9F6000">
Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group: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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string | The Id of the group.
$option = meeting_security; // string | Optional query parameters:  * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.
$group_locked_settings_request = new \Zoom\Api\Model\GroupLockedSettingsRequest(); // \Zoom\Api\Model\GroupLockedSettingsRequest

try {
    $apiInstance->groupLockedSettings($group_id, $option, $group_locked_settings_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupLockedSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The Id of the group.
option	string	Optional query parameters: * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.	[optional]
group_locked_settings_request	\Zoom\Api\Model\GroupLockedSettingsRequest		[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]

`groupMembers()`

groupMembers($group_id, $page_size, $page_number, $next_page_token): \Zoom\Api\Model\GroupMembers200Response

List group members

List the members of a group under your account. Prerequisite: Pro, Business, or Education account
Scopes: group:read: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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$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->groupMembers($group_id, $page_size, $page_number, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupMembers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
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\GroupMembers200Response

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]

`groupMembersCreate()`

groupMembersCreate($group_id, $group_members_create_request)

Add group members

Use this API to add users to a group in your account. Scopes: group:write:admin
Rate Limit Label: Medium Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$group_members_create_request = new \Zoom\Api\Model\GroupMembersCreateRequest(); // \Zoom\Api\Model\GroupMembersCreateRequest

try {
    $apiInstance->groupMembersCreate($group_id, $group_members_create_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupMembersCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
group_members_create_request	\Zoom\Api\Model\GroupMembersCreateRequest

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]

`groupMembersDelete()`

groupMembersDelete($group_id, $member_id)

Delete a group member

Use this API to remove a user from a group in an account. Scopes: group:write:admin
Rate Limit Label: Light Prerequisites: * A Pro, Business, or Education 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$member_id = -cn1DHGRRTSOlnVwyZNhKw; // string | The member ID or email address.

try {
    $apiInstance->groupMembersDelete($group_id, $member_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupMembersDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
member_id	string	The member ID or email address.

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]

`groupUpdate()`

groupUpdate($group_id, $group_update_request)

Update a group

Update a group under your account. Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group ID.<br> Can be retrieved by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$group_update_request = new \Zoom\Api\Model\GroupUpdateRequest(); // \Zoom\Api\Model\GroupUpdateRequest

try {
    $apiInstance->groupUpdate($group_id, $group_update_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group ID.<br> Can be retrieved by calling the List groups API.
group_update_request	\Zoom\Api\Model\GroupUpdateRequest

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]

`groups()`

groups(): \Zoom\Api\Model\GroupList

List groups

List groups under an account. Prerequisite: Pro or higher account.
Scopes: group:read: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\GroupsApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Zoom\Api\Model\GroupList

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]

`updateAGroupMember()`

updateAGroupMember($group_id, $member_id, $update_a_group_member_request)

Update a group member

Use this API to perform either of the following tasks: * Remove a group member from one group and move them to a different group. * Set a user's primary group. By default, the primary group is the first group that user is added to. If a user is a member of multiple groups, you can assign the user a primary group. The user will use the primary group's settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user. Scopes: group:write:admin
Rate Limit Label: Medium Prerequisites: * A Pro or higher 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\GroupsApi(
    // 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
);
$group_id = SobVexyrQjqCkcxjpBWi6w; // string | The group's unique ID. To get this value, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API. * To set a user's primary group, use the `target_group_id` value for this parameter's value.  * To move a group member from one group to another, use the `groupId` of the designated group.
$member_id = v4iyWT1LTfy8QvPG4GTvdg; // string | The group member's unique ID. To get this value, use the [**List group members**](/docs/api-reference/zoom-api/methods#operation/groupMembers) API.
$update_a_group_member_request = new \Zoom\Api\Model\UpdateAGroupMemberRequest(); // \Zoom\Api\Model\UpdateAGroupMemberRequest

try {
    $apiInstance->updateAGroupMember($group_id, $member_id, $update_a_group_member_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->updateAGroupMember: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	The group's unique ID. To get this value, use the List groups API. * To set a user's primary group, use the `target_group_id` value for this parameter's value. * To move a group member from one group to another, use the `groupId` of the designated group.
member_id	string	The group member's unique ID. To get this value, use the List group members API.
update_a_group_member_request	\Zoom\Api\Model\UpdateAGroupMemberRequest		[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]

`updateGroupSettings()`

updateGroupSettings($group_id, $option, $update_group_settings_request)

Update a group's settings

Update settings for a group.<p style="background-color:#FEEFB3; color:#9F6000">
Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group: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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string | Id of the group.
$option = meeting_security; // string | Optional query parameters:  * `meeting_authentication` — [Meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).  * `recording_authentication` — [Recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).  * `meeting_security` — Meeting security settings.
$update_group_settings_request = new \Zoom\Api\Model\UpdateGroupSettingsRequest(); // \Zoom\Api\Model\UpdateGroupSettingsRequest

try {
    $apiInstance->updateGroupSettings($group_id, $option, $update_group_settings_request);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->updateGroupSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
group_id	string	Id of the group.
option	string	Optional query parameters: * `meeting_authentication` — Meeting authentication settings. * `recording_authentication` — Recording authentication settings. * `meeting_security` — Meeting security settings.	[optional]
update_group_settings_request	\Zoom\Api\Model\UpdateGroupSettingsRequest		[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]

`uploadGroupVB()`

uploadGroupVB($group_id, $file): \Zoom\Api\Model\UploadGroupVB201Response

Upload Virtual Background files

Use this API to upload Virtual Background files for all users in a group to use. Scopes: group:write:admin
Rate Limit Label: Medium Prerequisites: * The Virtual Background feature must be enabled on the 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\GroupsApi(
    // 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
);
$group_id = 0mgThLiRQH2bUHvIaL4t2g; // string | The group ID. To get a group's ID, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
$file = 'file_example'; // string | The Virtual Background file's path.

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

Parameters

Name	Type	Description	Notes
group_id	string	The group ID. To get a group's ID, use the List groups API.
file	string	The Virtual Background file's path.	[optional]

Return type

\Zoom\Api\Model\UploadGroupVB201Response

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]

Files

GroupsApi.md

Latest commit

History

GroupsApi.md

File metadata and controls

Zoom\Api\GroupsApi

delGroupVB()

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupLockSettings()

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupSettings()

Example

Parameters

Return type

Authorization

HTTP request headers

group()

Example

Parameters

Return type

Authorization

HTTP request headers

groupAdmins()

Example

Parameters

Return type

Authorization

HTTP request headers

groupAdminsCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

groupAdminsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

groupCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

groupDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

groupLockedSettings()

Example

Parameters

Return type

Authorization

HTTP request headers

groupMembers()

Example

Parameters

Return type

Authorization

HTTP request headers

groupMembersCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

groupMembersDelete()

`delGroupVB()`

`getGroupLockSettings()`

`getGroupSettings()`

`group()`

`groupAdmins()`

`groupAdminsCreate()`

`groupAdminsDelete()`

`groupCreate()`

`groupDelete()`

`groupLockedSettings()`

`groupMembers()`

`groupMembersCreate()`

`groupMembersDelete()`

`groupUpdate()`

`groups()`

`updateAGroupMember()`

`updateGroupSettings()`

`uploadGroupVB()`