Skip to content

Latest commit

 

History

History
309 lines (206 loc) · 9.89 KB

TrackingFieldApi.md

File metadata and controls

309 lines (206 loc) · 9.89 KB

Zoom\Api\TrackingFieldApi

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

Method HTTP request Description
trackingfieldCreate() POST /tracking_fields Create a tracking field
trackingfieldDelete() DELETE /tracking_fields/{fieldId} Delete a tracking field
trackingfieldGet() GET /tracking_fields/{fieldId} Get a tracking field
trackingfieldList() GET /tracking_fields List tracking fields
trackingfieldUpdate() PATCH /tracking_fields/{fieldId} Update a tracking field

trackingfieldCreate()

trackingfieldCreate($tracking_field): \Zoom\Api\Model\TrackingfieldCreate201Response

Create a tracking field

Use this API to create a new tracking field. Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options. Scope: tracking_fields:write:admin
Rate Limit Label: Light Prerequisites: * A Business, Education, API or higher 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\TrackingFieldApi(
    // 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
);
$tracking_field = new \Zoom\Api\Model\TrackingField(); // \Zoom\Api\Model\TrackingField | Tracking Field

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

Parameters

Name Type Description Notes
tracking_field \Zoom\Api\Model\TrackingField Tracking Field

Return type

\Zoom\Api\Model\TrackingfieldCreate201Response

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]

trackingfieldDelete()

trackingfieldDelete($field_id)

Delete a tracking field

Use this API to delete a tracking field. Scope: tracking_fields:write:admin
Rate Limit Label: Light Prerequisites: * A Business, Education, API or higher 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\TrackingFieldApi(
    // 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
);
$field_id = a32CJji-weJ92; // string | The Tracking Field ID

try {
    $apiInstance->trackingfieldDelete($field_id);
} catch (Exception $e) {
    echo 'Exception when calling TrackingFieldApi->trackingfieldDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
field_id string The Tracking Field 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]

trackingfieldGet()

trackingfieldGet($field_id): \Zoom\Api\Model\TrackingfieldCreate201Response

Get a tracking field

Use this API to return information about a tracking field. Scopes: tracking_fields:read:admin
Rate Limit Label: Light Prerequisites: * A Business, Education, API or higher 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\TrackingFieldApi(
    // 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
);
$field_id = a32CJji-weJ92; // string | The Tracking Field ID

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

Parameters

Name Type Description Notes
field_id string The Tracking Field ID

Return type

\Zoom\Api\Model\TrackingfieldCreate201Response

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]

trackingfieldList()

trackingfieldList(): \Zoom\Api\Model\TrackingFieldList

List tracking fields

Use this API to list all the tracking fields on your Zoom account. Tracking fields let you analyze usage by various fields within an organization. Scopes: tracking_fields:read:admin
Rate Limit Label: Medium Prerequisites: * A Business, Education, API or higher 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\TrackingFieldApi(
    // 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->trackingfieldList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingFieldApi->trackingfieldList: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Zoom\Api\Model\TrackingFieldList

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]

trackingfieldUpdate()

trackingfieldUpdate($field_id, $tracking_field)

Update a tracking field

Use this API to update a tracking field. Scope: tracking_fields:write:admin
Rate Limit Label: Light Prerequisites: * A Business, Education, API or higher 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\TrackingFieldApi(
    // 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
);
$field_id = a32CJji-weJ92; // string | The Tracking Field ID
$tracking_field = new \Zoom\Api\Model\TrackingField(); // \Zoom\Api\Model\TrackingField

try {
    $apiInstance->trackingfieldUpdate($field_id, $tracking_field);
} catch (Exception $e) {
    echo 'Exception when calling TrackingFieldApi->trackingfieldUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
field_id string The Tracking Field ID
tracking_field \Zoom\Api\Model\TrackingField

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]