Skip to content

Latest commit

 

History

History
254 lines (171 loc) · 8.99 KB

DevicesApi.md

File metadata and controls

254 lines (171 loc) · 8.99 KB
Raw

Zoom\Api\DevicesApi

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

Method HTTP request Description
deviceCreate() POST /h323/devices Create a H.323/SIP device
deviceDelete() DELETE /h323/devices/{deviceId} Delete a H.323/SIP device
deviceList() GET /h323/devices List H.323/SIP devices
deviceUpdate() PATCH /h323/devices/{deviceId} Update a H.323/SIP device

deviceCreate()

deviceCreate($device)

Create a H.323/SIP device

A H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account

Scopes: h323: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\DevicesApi(
    // 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
);
$device = new \Zoom\Api\Model\Device(); // \Zoom\Api\Model\Device | H.323/SIP device.

try {
    $apiInstance->deviceCreate($device);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deviceCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
device \Zoom\Api\Model\Device H.323/SIP device.

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]

deviceDelete()

deviceDelete($device_id)

Delete a H.323/SIP device

A H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.

Scopes: h323: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\DevicesApi(
    // 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
);
$device_id = abceHewahkrehwiK; // string | The device ID.

try {
    $apiInstance->deviceDelete($device_id);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deviceDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
device_id string The device 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]

deviceList()

deviceList($page_size, $page_number, $next_page_token): \Zoom\Api\Model\DeviceList

List H.323/SIP devices

A H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.

Scopes: h323: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\DevicesApi(
    // 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
);
$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->deviceList($page_size, $page_number, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deviceList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
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\DeviceList

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]

deviceUpdate()

deviceUpdate($device_id, $device)

Update a H.323/SIP device

A H.323 or SIP device can make a video call to a Room Connector to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.

Scopes: h323: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\DevicesApi(
    // 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
);
$device_id = abceHewahkrehwiK; // string | The device ID.
$device = new \Zoom\Api\Model\Device(); // \Zoom\Api\Model\Device

try {
    $apiInstance->deviceUpdate($device_id, $device);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deviceUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
device_id string The device ID.
device \Zoom\Api\Model\Device

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]