Zoom\Api\IMGroupsApi

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

Method	HTTP request	Description
imGroup()	GET /im/groups/{groupId}	Retrieve an IM directory group
imGroupCreate()	POST /im/groups	Create an IM directory group
imGroupDelete()	DELETE /im/groups/{groupId}	Delete an IM directory group
imGroupMembers()	GET /im/groups/{groupId}/members	List IM directory group members
imGroupMembersCreate()	POST /im/groups/{groupId}/members	Add IM directory group members
imGroupMembersDelete()	DELETE /im/groups/{groupId}/members/{memberId}	Delete IM directory group member
imGroupUpdate()	PATCH /im/groups/{groupId}	Update an IM directory group
imGroups()	GET /im/groups	List IM directory groups

`imGroup()`

imGroup($group_id): \Zoom\Api\Model\ImGroup200Response

Retrieve an IM directory group

Retrieve an IM directory group under your account.

Scopes: imgroup: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\IMGroupsApi(
    // 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->imGroup($group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroup: ', $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\ImGroup200Response

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]

`imGroupCreate()`

imGroupCreate($im_group_create_request)

Create an IM directory group

Create an IM directory group under your account.

Scopes: imgroup: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\IMGroupsApi(
    // 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
);
$im_group_create_request = new \Zoom\Api\Model\ImGroupCreateRequest(); // \Zoom\Api\Model\ImGroupCreateRequest

try {
    $apiInstance->imGroupCreate($im_group_create_request);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
im_group_create_request	\Zoom\Api\Model\ImGroupCreateRequest

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, new

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`imGroupDelete()`

imGroupDelete($group_id)

Delete an IM directory group

Delete an IM directory group under your account.

Scopes: imgroup: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\IMGroupsApi(
    // 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->imGroupDelete($group_id);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupDelete: ', $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]

`imGroupMembers()`

imGroupMembers($group_id, $page_size, $page_number, $next_page_token): \Zoom\Api\Model\GroupMemberList

List IM directory group members

List the members of an IM directory group.

Scope: imgroup: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\IMGroupsApi(
    // 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->imGroupMembers($group_id, $page_size, $page_number, $next_page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupMembers: ', $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\GroupMemberList

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]

`imGroupMembersCreate()`

imGroupMembersCreate($group_id, $im_group_members_create_request)

Add IM directory group members

Add members to an IM directory group under an account.

Scope: imgroup: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\IMGroupsApi(
    // 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.
$im_group_members_create_request = new \Zoom\Api\Model\ImGroupMembersCreateRequest(); // \Zoom\Api\Model\ImGroupMembersCreateRequest

try {
    $apiInstance->imGroupMembersCreate($group_id, $im_group_members_create_request);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupMembersCreate: ', $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.
im_group_members_create_request	\Zoom\Api\Model\ImGroupMembersCreateRequest

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]

`imGroupMembersDelete()`

imGroupMembersDelete($group_id, $member_id)

Delete IM directory group member

Delete a member from an IM directory group under an account.

Scopes: imgroup: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\IMGroupsApi(
    // 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 = v4iyWT1LTfy8QvPG4GTvdg; // string | The member ID.

try {
    $apiInstance->imGroupMembersDelete($group_id, $member_id);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupMembersDelete: ', $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.

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]

`imGroupUpdate()`

imGroupUpdate($group_id, $im_group_update_request)

Update an IM directory group

Update an IM directory group under your account.

Scopes: imgroup: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\IMGroupsApi(
    // 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.
$im_group_update_request = new \Zoom\Api\Model\ImGroupUpdateRequest(); // \Zoom\Api\Model\ImGroupUpdateRequest

try {
    $apiInstance->imGroupUpdate($group_id, $im_group_update_request);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroupUpdate: ', $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.
im_group_update_request	\Zoom\Api\Model\ImGroupUpdateRequest

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]

`imGroups()`

imGroups(): \Zoom\Api\Model\IMGroupList

List IM directory groups

List IM directory groups.

Scopes: imgroup: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\IMGroupsApi(
    // 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->imGroups();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IMGroupsApi->imGroups: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Zoom\Api\Model\IMGroupList

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

IMGroupsApi.md

Latest commit

History

IMGroupsApi.md

File metadata and controls

Zoom\Api\IMGroupsApi

imGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupMembers()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupMembersCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupMembersDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroupUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

imGroups()

Example

Parameters

Return type

Authorization

HTTP request headers

`imGroup()`

`imGroupCreate()`

`imGroupDelete()`

`imGroupMembers()`

`imGroupMembersCreate()`

`imGroupMembersDelete()`

`imGroupUpdate()`

`imGroups()`