Skip to content

Latest commit

 

History

History
248 lines (165 loc) · 10.4 KB

ZoomRoomsAccountApi.md

File metadata and controls

248 lines (165 loc) · 10.4 KB
Raw

Zoom\Api\ZoomRoomsAccountApi

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

Method HTTP request Description
getZRAccountProfile() GET /rooms/account_profile Get Zoom Room account profile
getZRAccountSettings() GET /rooms/account_settings Get Zoom Room account settings
updateZRAccProfile() PATCH /rooms/account_profile Update Zoom Room account profile
updateZoomRoomAccSettings() PATCH /rooms/account_settings Update Zoom Room account settings

getZRAccountProfile()

getZRAccountProfile(): \Zoom\Api\Model\GetZRAccountProfile200Response

Get Zoom Room account profile

Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual Room Profile, use the Get Zoom Room profile API. Prerequisites:
* Zoom account owner or Zoom Rooms admin permissions
Scopes: room: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\ZoomRoomsAccountApi(
    // 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->getZRAccountProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoomRoomsAccountApi->getZRAccountProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Zoom\Api\Model\GetZRAccountProfile200Response

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]

getZRAccountSettings()

getZRAccountSettings($setting_type): \Zoom\Api\Model\GetZRAccountSettings200Response

Get Zoom Room account settings

Get details on Account Settings of a Zoom Room. With this API, you can view either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notification Settings) of the Zoom Rooms account. By default, only Account Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.

Prerequisites:
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
Scopes: room: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\ZoomRoomsAccountApi(
    // 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
);
$setting_type = meeting; // string | The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> `meeting`: Meeting settings of the Zoom Rooms Account. <br> `signage`: View digital signage settings of the Zoom Rooms Account.

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

Parameters

Name Type Description Notes
setting_type string The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> `meeting`: Meeting settings of the Zoom Rooms Account. <br> `signage`: View digital signage settings of the Zoom Rooms Account. [default to 'meeting']

Return type

\Zoom\Api\Model\GetZRAccountSettings200Response

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]

updateZRAccProfile()

updateZRAccProfile($get_zr_account_profile200_response)

Update Zoom Room account profile

Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use the Update a Zoom Room profile API. Prerequisites:
* Zoom account owner or Zoom Rooms admin permissions
Scopes: room: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\ZoomRoomsAccountApi(
    // 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
);
$get_zr_account_profile200_response = new \Zoom\Api\Model\GetZRAccountProfile200Response(); // \Zoom\Api\Model\GetZRAccountProfile200Response

try {
    $apiInstance->updateZRAccProfile($get_zr_account_profile200_response);
} catch (Exception $e) {
    echo 'Exception when calling ZoomRoomsAccountApi->updateZRAccProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
get_zr_account_profile200_response \Zoom\Api\Model\GetZRAccountProfile200Response [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]

updateZoomRoomAccSettings()

updateZoomRoomAccSettings($setting_type, $update_zoom_room_acc_settings_request)

Update Zoom Room account settings

Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notification Settings) of the Zoom Rooms account by specifying the required setting type in the setting_type parameter. To update only Alert Settings, specify alert as the value of the setting_type query parameter and to update only Account Meeting Settings, specify meeting as the value of the setting_type query parameter.

Prerequisites:
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
Scopes: room: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\ZoomRoomsAccountApi(
    // 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
);
$setting_type = meeting; // string | The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> `meeting`: Meeting settings of the Zoom Rooms Account.<br> `signage`: View digital signage settings of the Zoom Rooms Account.
$update_zoom_room_acc_settings_request = new \Zoom\Api\Model\UpdateZoomRoomAccSettingsRequest(); // \Zoom\Api\Model\UpdateZoomRoomAccSettingsRequest

try {
    $apiInstance->updateZoomRoomAccSettings($setting_type, $update_zoom_room_acc_settings_request);
} catch (Exception $e) {
    echo 'Exception when calling ZoomRoomsAccountApi->updateZoomRoomAccSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
setting_type string The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> `meeting`: Meeting settings of the Zoom Rooms Account.<br> `signage`: View digital signage settings of the Zoom Rooms Account. [default to 'meeting']
update_zoom_room_acc_settings_request \Zoom\Api\Model\UpdateZoomRoomAccSettingsRequest [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]