Zoom
App Vendor: Zoom Video Communications
App Category: IT Services, Messaging
Connector version: v1.0.0
API Version: 1.0.0
About App
Zoom is a cloud-based video communications app that allows you to set up virtual video and audio conferencing, webinars, live chats, screen-sharing, and other collaborative capabilities.
The Zoom app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Get room details | This action retrieves the details of a room from the Zoom application. |
Get a list of rooms | This action retrieves a list of rooms from the Zoom application. |
Get user details | This action retrieves the details of a user from the Zoom application. |
Get a list of users | This action retrieves a list of users from the Zoom application. |
Get a list of meetings | This action retrieves a list of meetings from the Zoom application. |
Get meeting details | This action retrieves the details of a meeting from the Zoom application. |
Configuration Parameters
The following configuration parameters are required for the Zoom app to communicate with the Zoom enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
API key | Enter the API key. Example: "CbXXXxxjQzqmJXXXXXDg" | Text | Required | |
API secret | Enter the API secret key. Example: "a234bdxxxxxYeaFsD" | Password | Required |
Action: Get room details
This action retrieves the details of a room from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Room ID | Enter the room ID to get the details. Example: "5551112222" | Text | Required |
Example Request
[
{
"room_id": "5551112222"
}
]Action: Get a list of rooms
This action retrieves a list of rooms from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Extra params | Enter any extra parameters to filter the list of rooms. | Key Value | Optional | Allowed values:
Default value:
|
Action: Get user details
This action retrieves the details of a user from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to get the details. Example: "632925245" | Text | Required |
Example Request
[
{
"user_id": "632925245"
}
]Action: Get a list of users
This action retrieves a list of users from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Extra params | Enter the extra parameters to filter the list of users. | Key Value | Optional | Allowed values:
Default values:
|
Action: Get a list of meetings
This action retrieves a list of meetings from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to get the list of meetings. Example: "632925245" | Text | Required | |
Extra params | Enter the extra parameters to filter the list of meetings as key-value pairs. | Key Value | Optional | Allowed values:
Default values:
|
Example Request
[
{
"user_id": "632925245"
}
]Action: Get meeting details
This action retrieves the details of a meeting from the Zoom application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Meeting ID | Enter the meeting ID to get the details. Example: "632925245" | Text | Required |
Example Request
[
{
"meeting_id": "632925245"
}
]