Zoom\Api\TSPApi

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

Method	HTTP request	Description
tsp()	GET /tsp	Get account's TSP information
tspUpdate()	PATCH /tsp	Update account's TSP information
tspUrlUpdate()	PATCH /users/{userId}/tsp/settings	Set global dial-in URL for a TSP user
userTSP()	GET /users/{userId}/tsp/{tspId}	Get a user's TSP account
userTSPCreate()	POST /users/{userId}/tsp	Add a user's TSP account
userTSPDelete()	DELETE /users/{userId}/tsp/{tspId}	Delete a user's TSP account
userTSPUpdate()	PATCH /users/{userId}/tsp/{tspId}	Update a TSP account
userTSPs()	GET /users/{userId}/tsp	List user's TSP accounts

`tsp()`

tsp(): \Zoom\Api\Model\Tsp200Response

Get account's TSP information

Get information on Telephony Service Provider on an account level.

Scopes: tsp:read:admin
Rate Limit Label: Light Prerequisites:
* A Pro or a 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\TSPApi(
    // 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->tsp();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->tsp: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Zoom\Api\Model\Tsp200Response

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]

`tspUpdate()`

tspUpdate($tsp_update_request)

Update account's TSP information

Update information of the Telephony Service Provider set up on an account.
Prerequisites:
TSP account option should be enabled.
Scopes: tsp: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\TSPApi(
    // 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
);
$tsp_update_request = new \Zoom\Api\Model\TspUpdateRequest(); // \Zoom\Api\Model\TspUpdateRequest | TSP Account

try {
    $apiInstance->tspUpdate($tsp_update_request);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->tspUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tsp_update_request	\Zoom\Api\Model\TspUpdateRequest	TSP Account

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]

`tspUrlUpdate()`

tspUrlUpdate($user_id, $tsp_global_dial_in)

Set global dial-in URL for a TSP user

A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.

Scopes:tsp:write:admin tsp: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\TSPApi(
    // 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 = 6dfgdfgdg444447b0egga; // string | The userId or email address of the user.
$tsp_global_dial_in = new \Zoom\Api\Model\TspGlobalDialIn(); // \Zoom\Api\Model\TspGlobalDialIn | Global dial-in URL of the user.

try {
    $apiInstance->tspUrlUpdate($user_id, $tsp_global_dial_in);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->tspUrlUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
user_id	string	The userId or email address of the user.
tsp_global_dial_in	\Zoom\Api\Model\TspGlobalDialIn	Global dial-in URL of the user.	[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]

`userTSP()`

userTSP($user_id, $tsp_id): \Zoom\Api\Model\TSPAccount

Get a user's TSP account

Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.

Scopes: tsp:read:admin tsp: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\TSPApi(
    // 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.
$tsp_id = 1; // string | TSP account ID.

try {
    $result = $apiInstance->userTSP($user_id, $tsp_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->userTSP: ', $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.
tsp_id	string	TSP account ID.

Return type

\Zoom\Api\Model\TSPAccount

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]

`userTSPCreate()`

userTSPCreate($user_id, $tsp): \Zoom\Api\Model\TSP

Add a user's TSP account

Add a user's TSP account.

Scopes: tsp:write:admin tsp: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\TSPApi(
    // 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.
$tsp = new \Zoom\Api\Model\TSP(); // \Zoom\Api\Model\TSP | TSP account.

try {
    $result = $apiInstance->userTSPCreate($user_id, $tsp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->userTSPCreate: ', $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.
tsp	\Zoom\Api\Model\TSP	TSP account.

Return type

\Zoom\Api\Model\TSP

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]

`userTSPDelete()`

userTSPDelete($user_id, $tsp_id)

Delete a user's TSP account

Delete a user's TSP account.

Scopes: tsp:write:admin tsp: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\TSPApi(
    // 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.
$tsp_id = 1; // string | TSP account ID.

try {
    $apiInstance->userTSPDelete($user_id, $tsp_id);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->userTSPDelete: ', $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.
tsp_id	string	TSP account 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]

`userTSPUpdate()`

userTSPUpdate($user_id, $tsp_id, $tsp_account1)

Update a TSP account

Update a user's TSP account.

Scopes: tsp:write:admin tsp: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\TSPApi(
    // 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.
$tsp_id = 1; // string | TSP account ID.
$tsp_account1 = new \Zoom\Api\Model\TSPAccount1(); // \Zoom\Api\Model\TSPAccount1 | TSP account.

try {
    $apiInstance->userTSPUpdate($user_id, $tsp_id, $tsp_account1);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->userTSPUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
user_id	GroupAdminsDeleteUserIdParameter	The user ID or email address of the user. For user-level apps, pass the `me` value.
tsp_id	string	TSP account ID.
tsp_account1	\Zoom\Api\Model\TSPAccount1	TSP account.

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]

`userTSPs()`

userTSPs($user_id): \Zoom\Api\Model\UserTSPs200Response

List user's TSP accounts

A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.

Scopes: tsp:read:admin tsp: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\TSPApi(
    // 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.

try {
    $result = $apiInstance->userTSPs($user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TSPApi->userTSPs: ', $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.

Return type

\Zoom\Api\Model\UserTSPs200Response

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]

Files

TSPApi.md

Latest commit

History

TSPApi.md

File metadata and controls

Zoom\Api\TSPApi

tsp()

Example

Parameters

Return type

Authorization

HTTP request headers

tspUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

tspUrlUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

userTSP()

Example

Parameters

Return type

Authorization

HTTP request headers

userTSPCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

userTSPDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

userTSPUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

userTSPs()

Example

Parameters

Return type

Authorization

HTTP request headers

`tsp()`

`tspUpdate()`

`tspUrlUpdate()`

`userTSP()`

`userTSPCreate()`

`userTSPDelete()`

`userTSPUpdate()`

`userTSPs()`