wehub-resource-sync
15184 lines
989 KiB
JSON
15184 lines
989 KiB
JSON
[
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - Group: groupSCIM2List",
|
|
"api_call": "GET /scim2/Groups",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"startIndex": "integer: The start index of the records to be returned.",
|
|
"count": "integer: The number of records returned in a single API call.",
|
|
"filter": "string: The type of query: \n* `displayName eq {groupName}` \u2014 Provide the group's name to filter the response to a specific group."
|
|
},
|
|
"functionality": "List all groups. Use additional query parameters to filter specific groups.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - Group: groupScim2Create",
|
|
"api_call": "POST /scim2/Groups",
|
|
"api_version": "1.0",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new group.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - Group: groupSCIM2Get",
|
|
"api_call": "GET /scim2/Groups/{groupId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID."
|
|
},
|
|
"functionality": "Get the specific group's information.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - Group: groupSCIM2Delete",
|
|
"api_call": "DELETE /scim2/Groups/{groupId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID."
|
|
},
|
|
"functionality": "Delete a group.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - Group: groupSCIM2Update",
|
|
"api_call": "PATCH /scim2/Groups/{groupId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID."
|
|
},
|
|
"functionality": "Update a group's information.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userSCIM2List",
|
|
"api_call": "GET /scim2/Users",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"startIndex": "integer: The start index of records to be returned.",
|
|
"count": "integer: The number of records returned in a single API call.",
|
|
"filter": "string: The query type: \n* `userName eq {userEmail}` \u2014 Provide the user's email address to filter the response to a specific user. \n* `externalId eq {userId}` \u2014 Filter the response by the user's ID (`userId`)."
|
|
},
|
|
"functionality": "Lists all users. You can use additional query parameters to filter specific users.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userScim2Create",
|
|
"api_call": "POST /scim2/Users",
|
|
"api_version": "1.0",
|
|
"api_arguments": {},
|
|
"functionality": "Creates a new user.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userSCIM2Get",
|
|
"api_call": "GET /scim2/Users/{userId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's Zoom ID."
|
|
},
|
|
"functionality": "Returns information about a specific user.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userSCIM2Update",
|
|
"api_call": "PUT /scim2/Users/{userId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's Zoom ID."
|
|
},
|
|
"functionality": "Updates a user's information. \n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userSCIM2Delete",
|
|
"api_call": "DELETE /scim2/Users/{userId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's Zoom ID."
|
|
},
|
|
"functionality": "Delete a user.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom SCIM2 API - User: userADSCIM2Deactivate",
|
|
"api_call": "PATCH /scim2/Users/{userId}",
|
|
"api_version": "1.0",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's Zoom ID."
|
|
},
|
|
"functionality": "Activate or deactivate a user.\n\n**Scopes:** `scim2`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: getUserLevelChannel",
|
|
"api_call": "GET /chat/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel's unique identifier."
|
|
},
|
|
"functionality": "Returns information about a specific channel.\n\nZoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups. \n\nThe [**Get a channel**](/docs/api-reference/chat/methods#operation/getChannel) API retrieves the channel information of other account users.\n\n**Scopes:** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: deleteUserLevelChannel",
|
|
"api_call": "DELETE /chat/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: the channel's unique identifier."
|
|
},
|
|
"functionality": "Deletes a specific channel. Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. \n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: updateUserLevelChannel",
|
|
"api_call": "PATCH /chat/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel ID."
|
|
},
|
|
"functionality": "Updates the name and settings of a specific channel owned or administrated by you. \n\nZoom chat channels allow users to communicate through chat in private or public channels.\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: listUserLevelChannelMembers",
|
|
"api_call": "GET /chat/channels/{channelId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: the channel's unique identifier.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned with a single API call."
|
|
},
|
|
"functionality": "Lists all members of a channel.\n\n\n\n**Scopes:** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: InviteUserLevelChannelMembers",
|
|
"api_call": "POST /chat/channels/{channelId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: the channel's unique identifier."
|
|
},
|
|
"functionality": "Invites members that are in a user's contact list to a channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. The maximum number of members that can be added at once with this API is 5. \n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: batchRemoveChannelMembers",
|
|
"api_call": "DELETE /chat/channels/{channelId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: the channel's unique identifier.",
|
|
"member_ids": "[REQUIRED] string: Members' member IDs. Use commas (,) to separate a supported maximum of 20 IDs.",
|
|
"user_ids": "[REQUIRED] string: Members' member IDs or user IDs. Use commas (,) to separate a supported maximum of 20 IDs."
|
|
},
|
|
"functionality": "Removes multiple members from a chat channel in a batch. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. \n \n \n \n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: joinChannel",
|
|
"api_call": "POST /chat/channels/{channelId}/members/me",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel ID."
|
|
},
|
|
"functionality": "Joins a channel that is open for anyone in the same organization to join. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or more members. You cannot use this API to join private channels that only allow invited members to be a part of them.\n\n**Note:** This API only supports **user-managed** [OAuth-app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app).\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: leaveChannel",
|
|
"api_call": "DELETE /chat/channels/{channelId}/members/me",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel's unique identifier."
|
|
},
|
|
"functionality": "Leaves a specific channel. If you're no longer interested in being a member of an existing channel, you can leave the channel at any time. After leaving the channel, you can no longer access information from that channel.\n\n**Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app)\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: removeAUserLevelChannelMember",
|
|
"api_call": "DELETE /chat/channels/{channelId}/members/{identifier}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The unique identifier of the channel from where you would like to remove a member. This can be retrieved from the [**List user's channels**](/docs/api-reference/chat/methods#operation/getChannels) API.",
|
|
"identifier": "[REQUIRED] : The email address or user ID or member ID of the member whom you would like to be remove from the channel."
|
|
},
|
|
"functionality": " Removes a member from a chat channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. \n \n \n \n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: getChannels",
|
|
"api_call": "GET /chat/users/{userId}/channels",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's unique identifier.",
|
|
"page_size": "integer: The number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Generates a list of user's chat channels. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups.\n\n**Scopes:** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels: createChannel",
|
|
"api_call": "POST /chat/users/{userId}/channels",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's unique identifier."
|
|
},
|
|
"functionality": "Creates a channel for a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. Zoom chat channels allow users to communicate through chat in private or public groups.\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): getAccountChannels",
|
|
"api_call": "GET /chat/channels",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned per page in a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Lists public chat channels that the account's users create. \n\n **Note:** This API only supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **View** or **Edit** permission for the **Chat Channels** feature.\n\n**Scopes:** `chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): getChannel",
|
|
"api_call": "GET /chat/users/{userId}/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel's unique identifier.",
|
|
"userId": "[REQUIRED] string: The unique identifier of the user who is the member of the channel."
|
|
},
|
|
"functionality": "Returns information about a specific channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nZoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups.\n\n**Scopes:** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): deleteChannel",
|
|
"api_call": "DELETE /chat/users/{userId}/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: the channel's unique identifier.",
|
|
"userId": "[REQUIRED] string: The user ID of the channel owner."
|
|
},
|
|
"functionality": "Deletes a specific channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nZoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups.\n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): updateChannel",
|
|
"api_call": "PATCH /chat/users/{userId}/channels/{channelId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel ID.",
|
|
"userId": "[REQUIRED] string: The unique identifier of the Zoom user who is the administrator of the channel."
|
|
},
|
|
"functionality": "Updates the name and settings of a specific channel owned or administrated by a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nZoom chat channels allow users to communicate through chat in private or public channels.\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): listChannelAdministrators",
|
|
"api_call": "GET /chat/users/{userId}/channels/{channelId}/admins",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID of the channel administrator.",
|
|
"channelId": "[REQUIRED] string: The channel ID.",
|
|
"page_size": "integer: The number of records returned with a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Lists all administrators of a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:read`,`chat_channel:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): promoteChannelMembersAsAdmin",
|
|
"api_call": "POST /chat/users/{userId}/channels/{channelId}/admins",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID.",
|
|
"channelId": "[REQUIRED] string: The channel ID."
|
|
},
|
|
"functionality": "Promote members to administrator role in a channel. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): batchDemoteChannelAdministrators",
|
|
"api_call": "DELETE /chat/users/{userId}/channels/{channelId}/admins",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID of the channel administrator.",
|
|
"channelId": "[REQUIRED] string: The channel ID.",
|
|
"admin_ids": "[REQUIRED] string: The member IDs with channel admin privileges. Use commas (,) to separate a maximum of 10 IDs in a call.",
|
|
"user_ids": "[REQUIRED] string: The member IDs or user IDs with channel admin privileges. Use commas (,) to separate a maximum of 10 IDs in a call."
|
|
},
|
|
"functionality": "Demotes administrators in a channel in batch. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): listChannelMembers",
|
|
"api_call": "GET /chat/users/{userId}/channels/{channelId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The channel ID.",
|
|
"page_size": "integer: The number of records returned with a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"userId": "[REQUIRED] string: The unique identifier of the user who is the owner of this channel."
|
|
},
|
|
"functionality": "Lists all members of a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): inviteChannelMembers",
|
|
"api_call": "POST /chat/users/{userId}/channels/{channelId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: Channel ID: The channel's unique identifier.",
|
|
"userId": "[REQUIRED] string: The unique identifier of the user who is the member of this channel."
|
|
},
|
|
"functionality": "Invites members that are in a user's contact list to a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Channels (Account-level): removeAChannelMember",
|
|
"api_call": "DELETE /chat/users/{userId}/channels/{channelId}/members/{identifier}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channelId": "[REQUIRED] string: The unique identifier of the channel from where you would like to remove a member. Retrieve this from the [**List user's channels**](/docs/api-reference/chat/methods#operation/getChannels) API.",
|
|
"identifier": "[REQUIRED] : The email address or user ID or member ID of the member whom you would like to be remove from the channel.",
|
|
"userId": "[REQUIRED] string: The unique identifier of the channel administrator."
|
|
},
|
|
"functionality": " Removes a member from a chat channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_channel:write`,`chat_channel:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Events: chatChannelContactControl",
|
|
"api_call": "PATCH /chat/users/{userId}/events",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Performs different operations on the contact or channel for the user. Operations include star or unstar a contact or channel user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `chat_event:write`,`chat_event:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Files: uploadAChatFile",
|
|
"api_call": "POST /chat/users/{userId}/files",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Uploads a file to chat. \n\n **Note:** \n* The base URL for this API's is `https://file.zoom.us/v2/`. \n* The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. \n* The caller must support HTTP 30x redirects. \n* All files are sent as common files except `png`,`jpg`,`jpeg` and `gif` \n* Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. \n* The caller must retain the authorization header when redirected to a different hostname. \n\n For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**. \n\n \n\n**Scopes:** `chat_message:write`,`chat_message:write:admin`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Files: sendChatFile",
|
|
"api_call": "POST /chat/users/{userId}/messages/files",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Sends a file on Zoom to either an individual user in your contact list or a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) of which you are a member. \n\n **Note:** \n* The base URL for this API is `https://file.zoom.us/v2/`. \n* The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. \n* The caller must support HTTP 30x redirects. \n* All files are sent as common files except `png`,`jpg`,`jpeg` and `gif` \n* Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. \n* The caller must retain the authorization header when redirected to a different hostname. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n For an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for **Chat Messages**. \n\n \n\n**Scopes:** `chat_message:write`,`chat_message:write:admin`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: getChatMessages",
|
|
"api_call": "GET /chat/users/{userId}/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"to_contact": "string: This field allows you to query by the email address, user ID, or member ID of a chat contact with whom the user communicated. The API only returns messages sent and received between the user and the queried contact. \n\n**Note:** \n* You must provide either the `to_contact` or the `to_channel` query parameter. \n* When you call the `search_key` and `search_type` query parameters, this query parameter is optional and **not** required.",
|
|
"to_channel": "string: This field allows you to query by the channel ID of a channel in which the user had chat conversations. The API only returns messages sent and received by the user in the queried channel. \n\n**Note:** \n* You must provide either the `to_contact` or the `to_channel` query parameter. \n* When you call the `search_key` and `search_type` query parameters, this query parameter is optional and **not** required.",
|
|
"date": "string: The query date from which to retrieve the chat messages. This value defaults to the current date. \n\n **Note:** If you do not provide the `date` or `from` query parameters, the API defaults to the `date` query parameter.",
|
|
"from": "string: The query start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.\n\n **Note:** If you provide both the `date` and `from` query parameters, the API uses the `date` value to query.",
|
|
"to": "string: The query end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This value defaults to the current date.",
|
|
"page_size": "integer: The number of records returned with a single API call. ",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"include_deleted_and_edited_message": "boolean: **Optional** \n \nThis field sets the value of this field to `true` to include edited and deleted messages in the response.",
|
|
"search_type": "string: The type of search: \n* `message` — search messages. \n* `file` — search files. \n\n**Note:** \n* If you use this query parameter, you must also include a `search_key` query parameter value. \n* The `to_contact` and the `to_channel` query parameters are **not** required when you query this parameter. If you do not call them, the API returns **all** contact and channel messages that match the `search_type` query. \n* If you query this parameter, you **cannot** also query the `include_deleted_and_edited_message` parameter. This query parameter does not support the return of deleted or updated messages.",
|
|
"search_key": "string: The query string for messages or files, up to 256 characters. \n\n**Note:** \n* If you use this query parameter, you must also include a `search_type` query parameter value. \n* The `to_contact` and the `to_channel` query parameters are **not** required when you query this parameter. If you do not call them, the API returns **all** contact and channel messages that match the `search_key` query. \n* If you query this parameter, you **cannot** also query the `include_deleted_and_edited_message` parameter. This query parameter does not support the return of deleted or updated messages.",
|
|
"exclude_child_message": "boolean: This parameter excludes returning all child messages in a chat. It leaves only the parent messages.",
|
|
"download_file_formats": "string: This field returns the download URL in the specified format for different types of files. Currently, we only support the download URL in the mp4 format for audio files. If this parameter is not specified, it returns the download URL of the file in its default format."
|
|
},
|
|
"functionality": "Searches chat messages and shared files between a user and an individual contact, or a chat channel. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. \n\n**Note:** For an [account-level OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a [user assigned to a role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) with the **Edit** permission for **Chat Messages**. \n\n\n\n**Scopes:** `chat_message:read`,`chat_message:write`,`chat_message:read:admin`,`chat_message:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: sendaChatMessage",
|
|
"api_call": "POST /chat/users/{userId}/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: Unique identifier of the user."
|
|
},
|
|
"functionality": "Send chat messages to a user in your contact list or to a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) of which you are a member. \nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo send a message to a contact, provide the contact's email address in the `to_contact` field. \nTo send a message to a channel, provide the channel's ID in `to_channel` parameter\n\n\n\n**Scopes:** `chat_message:write:admin`,`chat_message:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: getChatMessage",
|
|
"api_call": "GET /chat/users/{userId}/messages/{messageId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: Unique identifier of the user.",
|
|
"messageId": "[REQUIRED] string: Message ID: Unique Identifier of the message.",
|
|
"to_contact": "string: The user ID or member ID or email address of a chat contact to whom the message was sent. You must provide this parameter or the `to_channel` parameter.",
|
|
"to_channel": "string: The channel ID where the message was sent. You must provide this parameter or the `to_channel` parameter.",
|
|
"download_file_formats": "string: For different types of files, this field supports returning the download URL in the specified format. Currently, we only support the download URL in the mp4 format for audio files. If this parameter is not specified, will return the download URL of the file in its default format."
|
|
},
|
|
"functionality": "Gets a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nYou must provide one of the following query parameters: \n \n* `to_contact` — The email address of the Zoom contact to whom you sent the message.\n* `to_channel` — The ID of the Zoom channel where you sent the message.\n\n\n\n**Scopes:** `chat_message:read`,`chat_message:read:admin`,`chat_message:write`,`chat_message:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: editMessage",
|
|
"api_call": "PUT /chat/users/{userId}/messages/{messageId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: Thw unique identifier of the user.",
|
|
"messageId": "[REQUIRED] string: The unique identifier of the message."
|
|
},
|
|
"functionality": "Edits a chat message that you previously sent to either a contact or a channel in Zoom. It provides the ID of the message as the value of the `messageId` parameter. You can get the ID from the **List User's Chat Messages** API. Additionally, as a query parameter, you must provide either the contact's **email address** of the contact or the **Channel ID** of the channel where the message was sent.\n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Note:** For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), you can only use this API on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**.\n\n\n\n**Scopes:** `chat_message:write:admin`,`chat_message:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: deleteChatMessage",
|
|
"api_call": "DELETE /chat/users/{userId}/messages/{messageId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: Unique identifier of the user.",
|
|
"messageId": "[REQUIRED] string: Message ID: Unique Identifier of the message.",
|
|
"to_contact": ": The member ID or user ID or email address of a chat contact to whom the message was sent. You must provide this parameter or the `to_channel` parameter.",
|
|
"to_channel": "string: The channel ID where the message was sent. You must provide this parameter or the `to_channel` parameter."
|
|
},
|
|
"functionality": "Deletes a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n For an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for **Chat Messages**. \n\n \n\n**Scopes:** `chat_message:write`,`chat_message:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: reactMessage",
|
|
"api_call": "PATCH /chat/users/{userId}/messages/{messageId}/emoji_reactions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's unique ID.",
|
|
"messageId": "[REQUIRED] string: The message's unique ID."
|
|
},
|
|
"functionality": "Adds or removes an emoji to a chat message.\n\nFor an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**.\n\n\n\n**Scopes:** `chat_message:write`,`chat_message:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Messages: markMessage",
|
|
"api_call": "PATCH /chat/users/{userId}/messages/{messageId}/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"messageId": "[REQUIRED] string: The unique identifier of the message."
|
|
},
|
|
"functionality": "Marks a chat message as read or unread. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Note:** \n\nFor an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a [user assigned to a role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) with the "**Edit**" permission for **Chat Messages**. \n\n\n\n**Scopes:** `chat_message:write`,`chat_message:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Chat Sessions: getChatSessions",
|
|
"api_call": "GET /chat/users/{userId}/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID of the sessions being queried.",
|
|
"type": "string: The session queried by the chat type. The API only returns sessions of which the user is a member and of the specified chat `type`. \n\n**Note:** \n* If no `type` is provided, the response contains both group and 1:1 chats.",
|
|
"page_size": "integer: The number of records returned with a single API call. ",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"from": "string: The query start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This value defaults to the start time of today.",
|
|
"to": "string: The query end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This value defaults to the end time of today."
|
|
},
|
|
"functionality": "Retrieves a user's chat sessions. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Note:** For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), you can only use this API on behalf of a user who is assigned a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **View** or **Edit** permission for **Chat Messages**.\n\n\n**Scopes:** `chat_message:read`,`chat_message:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Contacts: getUserContacts",
|
|
"api_call": "GET /chat/users/me/contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: The type of contact. The value can be one of the following:\n`company`: Contacts from the user's organization.\n`external`: External contacts. ",
|
|
"page_size": "integer: The number of records returned with a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Lists all the contacts of a Zoom user. Zoom categorizes contacts into **company contacts** and **external contacts**. You must specify the contact type in the `type` query parameter. If you do not specify, by default, the type is set as company contact. A user under an organization's Zoom account has internal users listed under **company contacts** in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts).\n\n**Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app).\n\n\n**Scopes:** `chat_contact:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Contacts: getUserContact",
|
|
"api_call": "GET /chat/users/me/contacts/{identifier}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"identifier": "[REQUIRED] string: The contact's user ID, email address, or member ID. The contact can be either a company contact or an external contact.",
|
|
"query_presence_status": "boolean: The presence status of the contact. \nInclude this query parameter with a value of `true` to get the status of the contact in the response."
|
|
},
|
|
"functionality": "Returns information on a specific contact of the Zoom user. A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). \n**Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app).\n\n\n**Scopes:** `chat_contact:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Contacts: searchCompanyContacts",
|
|
"api_call": "GET /contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"search_key": "[REQUIRED] string: Provide the keyword - either first name, last name or email of the contact whom you have to search for.",
|
|
"query_presence_status": "boolean: Set `query_presence_status` to `true` in order to include the presence status of a contact in the response.",
|
|
"page_size": "integer: The number of records to be returned with a single API call.",
|
|
"contact_types": "integer: A comma-separated list of the type of user contact to query: \n* `1` — A Zoom user. \n* `2` — An auto receptionist. \n* `3` — A common area phone. \n* `4` — A call queue. \n * `5` — A shared line group. \n* `6` — A shared global directory. \n* `7` — A shared office contact. \n* `8` — A ZOOM Room.\n\n**Note:** \n* You must have a [phone management role with the "**View**" permission](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) to query the `2`, `3`, `4`, `5`, and `7` values. \n* You must provide a valid `search_key` value to query this parameter.",
|
|
"user_status": "string: The Zoom user's status: \n* `active` — The user exists on the account. \n* `inactive` — The user has been deactivated. \n\nThis value only work for the `contact_types` field is `1`, if not provide all users can be search.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the `search_key` query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set `query_presence_status` to `true` in order to include the presence status of a contact. \n \n \n\n\n\n**Scopes:** `contact:read:admin`,`contact:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Chat: sendimmessages",
|
|
"api_call": "POST /im/users/me/chat/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"chat_user": "string: The email address (registered with Zoom) or the userId of the chat user."
|
|
},
|
|
"functionality": "Sends the chat message to a user.\n\n**Note:** This API only supports OAuth 2.0.\n\n\n**Scopes:** `imchat:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroups",
|
|
"api_call": "GET /im/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management). \n \n \n\n\n**Scopes:** `imgroup:read:admin`,`imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupCreate",
|
|
"api_call": "POST /im/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create an IM directory group under your account. \n \n \n\n\n**Scopes:** `imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroup",
|
|
"api_call": "GET /im/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. \n \n \nScopes: `imgroup:read:admin` \n \n\n \n\n**Scopes:** `imgroup:read:admin`,`imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupDelete",
|
|
"api_call": "DELETE /im/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. \n \n \nScopes: `imgroup:write:admin` \n \n \n \n\n**Scopes:** `imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupUpdate",
|
|
"api_call": "PATCH /im/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. \n \n \n\n\n**Scopes:** `imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupMembers",
|
|
"api_call": "GET /im/groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"page_number": "integer: **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management). \n \n \n\n\n**Scopes:** `imgroup:read:admin`,`imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupMembersCreate",
|
|
"api_call": "POST /im/groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account. \n \n \n\n\n**Scopes:** `imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - IM Groups: imGroupMembersDelete",
|
|
"api_call": "DELETE /im/groups/{groupId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"memberId": "[REQUIRED] string: The member ID."
|
|
},
|
|
"functionality": "Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account. \n \n \nScopes: `imgroup:write:admin` \n \n \n \n\n**Scopes:** `imgroup:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Reports: reportChatSessions",
|
|
"api_call": "GET /report/chat/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: The start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: The end date.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Gets Zoom Chat session reports for a specified period of time. The monthly date range **must** be within the last six months.\n\n**Prerequisites:** \n* A Pro or higher plan \n* Report chat permissions.\n\n**Scopes:** `report_chat:read:admin`,`imchat:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Team Chat API - Reports: reportChatMessages",
|
|
"api_call": "GET /report/chat/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The chat session's ID.",
|
|
"from": "[REQUIRED] string: The start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: The end date.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"include_fields": "string: This field returns all edited and deleted messages. The API only returns this value if the `include_fields` query parameter contains the `edited_messages` and/or the `deleted_messages` values.\n\nTo include both edited and deleted messages, comma-separate both values.",
|
|
"include_bot_message": "boolean: Whether to return the bot message. If false, the bot_message will not be returned in the response body."
|
|
},
|
|
"functionality": "Gets Zoom Chat message reports for a specified period of time. The monthly date range must be within the last six months.\n\n**Prerequisites:** \n* A Pro or higher plan \n* Report chat permissions\n\n**Scopes:** `report_chat:read:admin`,`imchat:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom QSS API - Dashboards: dashboardMeetingParticipantsQOSSummary",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants/qos_summary",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] string: The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of the available result list exceeds the page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Return a list of meeting participants from past meetings and the summary their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name` and `email` responses when the account calling this API. \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business or a higher plan. \n* Developers must subscribe to the QSS summary event to receive data from this API.\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom QSS API - Dashboards: dashboardWebinarParticipantsQOSSummary",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants/qos_summary",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"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."
|
|
},
|
|
"functionality": "Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name` and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://marketplace.zoom.us/docs/api-reference/other-references/legacy-business-associate-agreements). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on.\n* Developers must subscribe to the QSS summary event to receive data from this API.\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom QSS API - Sessions: sessionUsersQOSSummary",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/users/qos_summary",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"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."
|
|
},
|
|
"functionality": "Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for users' `name` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. \n\n**Prerequisites:** \n* A Business or a higher plan. \n* Developers must subscribe to the QSS summary event to receive data from this API.\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Accounts: accountSettingsIndicatorsDeprecated",
|
|
"api_call": "GET /iq/settings/indicators",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"category_id": "string: The category id of indicators:",
|
|
"type": "string: The type of indicators: \n* `basic` — Identify basic keyword phrases. \n* `advanced` — Identify advanced keyword phrases. \n* `guiding_sentences` — Identify guiding sentences.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get the account's indicators settings. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:read:admin`,`account:write:admin`,`iq_account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Accounts: accountIndicatorsSettings",
|
|
"api_call": "GET /zra/settings/indicators",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"category_id": "string: The category id of indicators:",
|
|
"type": "string: The type of indicators: \n* `basic` — Identify basic keyword phrases. \n* `advanced` — Identify advanced keyword phrases. \n* `guiding_sentences` — Identify guiding sentences.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get the account's indicators settings. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n\n\n**Scopes:** `account:read:admin`,`account:write:admin`,`iq_account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: listConversationsDeprecated",
|
|
"api_call": "GET /iq/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"host_id": "string: The host user ID to query.",
|
|
"participant_id": "string: The internal participant ID to query.",
|
|
"team_id": "string: The Zoom specific team ID to query.",
|
|
"deal_id": "string: The Zoom specific deal ID to query.",
|
|
"period_type": "string: The type of period to query: \n* `meetingStartTime` — Queries conversations with meeting_start_time in the time period between the From and To parameters. \n* `iqProcessedTime` — Queries conversations with iq_processed_time in the time period between the From and To parameters.",
|
|
"from": "string: The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"to": "string: The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"conversation_type": "string: The type of conversations to query: \n* `all` — All conversations. \n* `meeting` — Meeting conversations. \n* `phone` - Phone conversations.",
|
|
"callout_type": "string: The callout type of conversations to query: \n* `engagingQuestions` — Only query conversations that include engaging questions indicator. \n* `nextSteps` — Only query conversations that include next steps indicator.",
|
|
"indicator_id": "string: The indicator id to query.",
|
|
"mentioned_topic_id": "string: The mentioned topic id to query.",
|
|
"scored": "boolean: Set to `true` to return scored conversations from the conversation list.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "List all conversations. \n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: AddConversationByFileIdOrDownloadUrlDeprecated",
|
|
"api_call": "POST /iq/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Add conversation by file ID or third party download URL.\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationInfoDeprecated",
|
|
"api_call": "GET /iq/conversations/{conversationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Get information for a specific conversation. \n\n\n\n**Scopes:** `iq_conversation:read:admin`,`iq_conversation:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: deleteConversationDeprecated",
|
|
"api_call": "DELETE /iq/conversations/{conversationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Delete conversation by conversation ID. \n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationCommentsDeprecated",
|
|
"api_call": "GET /iq/conversations/{conversationId}/comments",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get comments for a specific conversation. \n\n\n\n**Scopes:** `iq_comment:read`,`iq_comment:write`,`iq_comment:read:admin`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: addConversationCommentDeprecated",
|
|
"api_call": "POST /iq/conversations/{conversationId}/comments",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Add new comments to a specific conversation. \n\n\n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: deleteConversationCommentDeprecated",
|
|
"api_call": "DELETE /iq/conversations/{conversationId}/comments/{commentId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"commentId": "[REQUIRED] string: The comment's ID."
|
|
},
|
|
"functionality": "Delete comment from a specific conversation. \n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: editConversationCommentDeprecated",
|
|
"api_call": "PATCH /iq/conversations/{conversationId}/comments/{commentId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"commentId": "[REQUIRED] string: The comment's ID."
|
|
},
|
|
"functionality": "Edit a comment for a specific conversation. \n\n\n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationContentAnalysisDeprecated",
|
|
"api_call": "GET /iq/conversations/{conversationId}/content_analysis",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"analysis_type": "[REQUIRED] string: The content analysis type of conversations to query: \n* `topics` - Topics analysis. \n* `nextSteps` - Next steps analysis. \n* `engagingQuestions` - Engaging questions analysis. \n* `indicators` - Indicators analysis. \n* `smartChapters` - Smart Chapters analysis.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get the content analysis for a specific conversation. \n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationInteractionsDeprecated",
|
|
"api_call": "GET /iq/conversations/{conversationId}/interactions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get interactions for a specific conversation. \n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationScorecardsDeprecated",
|
|
"api_call": "GET /iq/conversations/{conversationId}/scorecards",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get scorecards for a specific conversation. \n\n\n\n**Scopes:** `iq_coaching:read:admin`,`iq_coaching:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UpdateconversationhostidtonewhostidbyconversationidDeprecated",
|
|
"api_call": "PATCH /iq/conversations/{conversationId}/update_host",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "string"
|
|
},
|
|
"functionality": "Update the conversation host id.\r\n\r\n**Prerequisite**: \r\nYou must have either `iq_conversation:write:admin` or `iq_conversation:write` permissions.\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UploadIQFileDeprecated",
|
|
"api_call": "POST /iq/files",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Upload a file to Zoom Revenue Acclerator. \n\n **Prerequisite:** \n The caller must be a Zoom Revenue Acclerator-licensed user.\n\n **Note:** \n* Base URL: `https://fileapi.zoom.us/v2/`. \n* Rate limit: 20 requests per second per user or 2000 requests per second per IP address. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the Authorization header when redirected to a different hostname. \n\n* Supported video formats: `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264`.\n* Supported transcript and file attachment format: `.json` . The `fileName` must end with `transcript.json`.\n* Supported metadata and file attachment format: `.json`. The fileName must end with `metadata.json`.\n* Required file upload sequence: main file, transcript file (if necessary), metadata file (if necessary).\n* When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n* For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**.\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UploadIqMultipartFileDeprecated",
|
|
"api_call": "POST /iq/files/multipart",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to upload a multipart file. \n\n **Note:** \n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The rate limit of this API is 20 requests per second or 2000 requests per day per IP address. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Video can be in `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264` format.\n* Transcript can be in `.vtt`, `.json` format.\n* In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n* The caller must be a iq_listened user.\n* For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **All Conversations**. \n* \n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: InitiateAndCompleteAMultipartUpload. [Deprecated]",
|
|
"api_call": "POST /iq/files/multipart/upload_events",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Initiate or complete a multipart upload. \n\n **Note:** \n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The rate limit is 20 requests per second or 2000 requests per day per IP address.\n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Once initiated the multipart upload must complete within 7 days. \n* The caller must be an iq_listened user. \n* For **account-level** [OAuth apps](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**.\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: addConversationDeprecated",
|
|
"api_call": "POST /iq/users/{userId}/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user, or the text 'me' for the current user."
|
|
},
|
|
"functionality": "Add new conversation by meeting recording URL or meeting UUID. If both recording URL and meeting UUID are passed in the request but refer to different meetings, we use the recording URL and ignore the meeting UUID.\n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getUserPlaylistDeprecated",
|
|
"api_call": "GET /iq/users/{userId}/conversations/playlists",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"type": "string: The type of the playlist to query: \n* `All` - All playlists. \n* `Normal` - Normal playlist. \n* `Smart` - Smart playlist. \n* `Favorite` - Favorite playlist.",
|
|
"following": "boolean: Whether to see Following only.",
|
|
"create_by_self": "boolean: Whether to see playlist created by self."
|
|
},
|
|
"functionality": "Get all playlists for a user. \n\n\n\n**Scopes:** `iq_playlist:read`,`iq_playlist:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: listAllConversations",
|
|
"api_call": "GET /zra/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"host_id": "string: The host user ID to query.",
|
|
"participant_id": "string: The internal participant ID to query.",
|
|
"team_id": "string: The Zoom specific team ID to query.",
|
|
"deal_id": "string: The Zoom specific deal ID to query.",
|
|
"period_type": "string: The type of period to query: \n* `meetingStartTime` — Queries conversations with meeting_start_time in the time period between the From and To parameters. \n* `iqProcessedTime` — Queries conversations with iq_processed_time in the time period between the From and To parameters.",
|
|
"from": "string: The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"to": "string: The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"conversation_type": "string: The type of conversations to query: \n* `all` — All conversations. \n* `meeting` — Meeting conversations. \n* `phone` - Phone conversations.",
|
|
"callout_type": "string: The callout type of conversations to query: \n* `engagingQuestions` — Only query conversations that include engaging questions indicator. \n* `nextSteps` — Only query conversations that include next steps indicator.",
|
|
"indicator_id": "string: The indicator id to query.",
|
|
"mentioned_topic_id": "string: The mentioned topic id to query.",
|
|
"scored": "boolean: Set to `true` to return scored conversations from the conversation list.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "List all conversations. \n\n\n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: AddConversationByFileIdOrDownloadUrl",
|
|
"api_call": "POST /zra/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Add conversation by file ID or third party download URL.\n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationDetail",
|
|
"api_call": "GET /zra/conversations/{conversationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Get information for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_conversation:read:admin`,`iq_conversation:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: deleteConversationById",
|
|
"api_call": "DELETE /zra/conversations/{conversationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Delete conversation by conversation ID. \n\n\n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationCommentsById",
|
|
"api_call": "GET /zra/conversations/{conversationId}/comments",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get comments for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_comment:read`,`iq_comment:write`,`iq_comment:read:admin`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: addConversationComments",
|
|
"api_call": "POST /zra/conversations/{conversationId}/comments",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value."
|
|
},
|
|
"functionality": "Add new comments to a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: deleteConversationCommentById",
|
|
"api_call": "DELETE /zra/conversations/{conversationId}/comments/{commentId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"commentId": "[REQUIRED] string: The comment's ID."
|
|
},
|
|
"functionality": "Delete comment from a specific conversation. \n\n\n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: editConversationCommentById",
|
|
"api_call": "PATCH /zra/conversations/{conversationId}/comments/{commentId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"commentId": "[REQUIRED] string: The comment's ID."
|
|
},
|
|
"functionality": "Edit a comment for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_comment:write`,`iq_comment:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationContentAnalysisById",
|
|
"api_call": "GET /zra/conversations/{conversationId}/content_analysis",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"analysis_type": "[REQUIRED] string: The content analysis type of conversations to query: \n* `topics` - Topics analysis. \n* `nextSteps` - Next steps analysis. \n* `engagingQuestions` - Engaging questions analysis. \n* `indicators` - Indicators analysis. \n* `smartChapters` - Smart Chapters analysis.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get the content analysis for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationInteraction",
|
|
"api_call": "GET /zra/conversations/{conversationId}/interactions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get interactions for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getConversationScorecardsById",
|
|
"api_call": "GET /zra/conversations/{conversationId}/scorecards",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string: The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the ID value.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get scorecards for a specific conversation. \n\n\n\n\n\n**Scopes:** `iq_coaching:read:admin`,`iq_coaching:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UpdateConversationhostid2NewHostidByConversationId",
|
|
"api_call": "PATCH /zra/conversations/{conversationId}/update_host",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"conversationId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Update the conversation host id to a new host id by conversation id.\r\n\r\n**Prerequisite**: \r\nYou must have either `iq_conversation:write:admin` or `iq_conversation:write` permissions.\r\n\r\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UploadZraFile",
|
|
"api_call": "POST /zra/files",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Upload a file to Zoom Revenue Acclerator. \n\n **Prerequisite:** \n The caller must be a Zoom Revenue Acclerator-licensed user.\n\n **Note:** \n* Base URL: `https://fileapi.zoom.us/v2/`. \n* Rate limit: 20 requests per second per user or 2000 requests per second per IP address. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the Authorization header when redirected to a different hostname. \n\n* Supported video formats: `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264`.\n* Supported transcript and file attachment format: `.json` . The `fileName` must end with `transcript.json`.\n* Supported metadata and file attachment format: `.json`. The fileName must end with `metadata.json`.\n* Required file upload sequence: main file, transcript file (if necessary), metadata file (if necessary).\n* When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n* For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**.\n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: UploadZraMultipartFile.",
|
|
"api_call": "POST /zra/files/multipart",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to upload a multipart file. \n\n **Note:** \n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The rate limit of this API is 20 requests per second or 2000 requests per day per IP address. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Video can be in `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264` format.\n* Transcript can be in `.vtt`, `.json` format.\n* In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n* The caller must be a iq_listened user.\n* For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **All Conversations**. \n* \n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: InitiateAndCompleteAMultipartUpload",
|
|
"api_call": "POST /zra/files/multipart/upload_events",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Initiate or complete a multipart upload. \n\n **Note:** \n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The rate limit is 20 requests per second or 2000 requests per day per IP address.\n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Once initiated the multipart upload must complete within 7 days. \n* The caller must be an iq_listened user. \n* For **account-level** [OAuth apps](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**.\n\n\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: addConversationByRecord",
|
|
"api_call": "POST /zra/users/{userId}/conversations",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user, The user's user ID or email address, or the text 'me' for the current user"
|
|
},
|
|
"functionality": "Add new conversations by meeting record URL or meeting UUID. If both recording URL and meeting UUID are passed in the request and refer to different meetings, we ignore meeting UUID.\n\n**Scopes:** `iq_conversation:write:admin`,`iq_conversation:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Conversations: getUserPlaylists",
|
|
"api_call": "GET /zra/users/{userId}/conversations/playlists",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"type": "string: The type of the playlist to query: \n* `All` - All playlists. \n* `Normal` - Normal playlist. \n* `Smart` - Smart playlist. \n* `Favorite` - Favorite playlist.",
|
|
"following": "boolean: Whether to see Following only.",
|
|
"create_by_self": "boolean: Whether to see playlist created by self."
|
|
},
|
|
"functionality": "Get all playlists for a user. \n\n\n\n\n\n**Scopes:** `iq_playlist:read`,`iq_playlist:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: listDealsDeprecated",
|
|
"api_call": "GET /iq/deals",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deal_name": "string: The deal name",
|
|
"only_show_with_analytics": "boolean: Set to `true` to return deals with analytics.",
|
|
"from": "string: The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"to": "string: The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"team_id": "string: The Zoom specific team ID to query.",
|
|
"deal_stage": "string: The stage of the deal.",
|
|
"owner_id": "string: The Zoom specific user ID to query.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"max_deal_amount": "integer: The maximum deal amount to query.",
|
|
"min_deal_amount": "string: The minimum deal amount to query."
|
|
},
|
|
"functionality": "List all deals.\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: getDealInfoDeprecated",
|
|
"api_call": "GET /iq/deals/{dealId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "[REQUIRED] string: The deal's ID."
|
|
},
|
|
"functionality": "Get information for a specific deal. (deprecated)\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: getDealActivitiesDeprecated",
|
|
"api_call": "GET /iq/deals/{dealId}/activities",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "[REQUIRED] string: The deal's ID.",
|
|
"conversation_topic": "string: The conversation topic",
|
|
"callout_type": "string: The callout type of conversations to query: \n* `engagingQuestions` — Only query conversations that include engaging questions indicator. \n* `nextSteps` — Only query conversations that include next steps indicator.",
|
|
"indicator_id": "string: The indicator id to query.",
|
|
"mentioned_topic_id": "string: The mentioned topic id to query.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get activities for a specific deal. (deprecated)\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: DeleteActivityFromTheDealDeprecated",
|
|
"api_call": "DELETE /iq/deals/{dealId}/activities",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "string: The deal's ID.",
|
|
"conversation_id": "string: The conversation ID.",
|
|
"message_id": "string: The message ID."
|
|
},
|
|
"functionality": "Delete specific activity from the deal. Either <b>conversation_id</b> or <b>message_id</b> would be required.\n\n**Scopes:** `iq_deal:write:admin`,`iq_deal:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: listAllDeals",
|
|
"api_call": "GET /zra/deals",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deal_name": "string: The deal name",
|
|
"only_show_with_analytics": "boolean: Set to `true` to return deals with analytics.",
|
|
"from": "string: The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"to": "string: The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.",
|
|
"team_id": "string: The Zoom specific team ID to query.",
|
|
"deal_stage": "string: The stage of the deal.",
|
|
"owner_id": "string: The Zoom specific user ID to query.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"max_deal_amount": "integer: The maximum deal amount to query.",
|
|
"min_deal_amount": "string: The minimum deal amount to query."
|
|
},
|
|
"functionality": "List all deals.\n\n\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: getDealDetail",
|
|
"api_call": "GET /zra/deals/{dealId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "[REQUIRED] string: The deal's ID."
|
|
},
|
|
"functionality": "Get information for a specific deal.\n\n\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: geAllActivitiesFromDeal",
|
|
"api_call": "GET /zra/deals/{dealId}/activities",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "[REQUIRED] string: The deal's ID.",
|
|
"conversation_topic": "string: The conversation topic",
|
|
"callout_type": "string: The callout type of conversations to query: \n* `engagingQuestions` — Only query conversations that include engaging questions indicator. \n* `nextSteps` — Only query conversations that include next steps indicator.",
|
|
"indicator_id": "string: The indicator id to query.",
|
|
"mentioned_topic_id": "string: The mentioned topic id to query.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Get activities for a specific deal.\n\n\n\n**Scopes:** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Deals: DeleteActivityFromDeal",
|
|
"api_call": "DELETE /zra/deals/{dealId}/activities",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dealId": "[REQUIRED] string: The deal's ID.",
|
|
"conversation_id": "string: The conversation ID.",
|
|
"message_id": "string: The message ID."
|
|
},
|
|
"functionality": "Delete specific activity from a deal. Use either <b>conversation_id</b> or <b>message_id</b>.\n\n\n\n**Scopes:** `iq_deal:write:admin`,`iq_deal:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: ListAccountTeamsDeprecated",
|
|
"api_call": "GET /iq/teams",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"parent_team_id": "string: parent team id",
|
|
"team_name": "string: the name of team",
|
|
"page_size": "integer: The number of records returned in a single API call.",
|
|
"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 the available result list exceeds the page size. The expiration period is 15 minutes."
|
|
},
|
|
"functionality": "List account teams. Filter by parent team ID or team name.\n\n**Scopes:** `iq_team:read`,`iq_team:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: CreateTeam",
|
|
"api_call": "POST /zra/team",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Please create team one by one, if your account enable hierarchical structure team. We currently do not support concurrent hierarchical team creation\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: GetTeamDetail",
|
|
"api_call": "GET /zra/team/{teamId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query. Retrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API."
|
|
},
|
|
"functionality": "Get team detail, such as team name, team description, team member size and etc.\n\n**Scopes:** `iq_team:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: DeleteTeam",
|
|
"api_call": "DELETE /zra/team/{teamId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query. Retrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API."
|
|
},
|
|
"functionality": "Please delete team one by one, if your account enable hierarchical structure team. We currently do not support concurrent hierarchical team deletion.\r\nAnd if you want to delete flat team, you should make sure that the team members of the target team are empty.\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: AssignTeamManagers",
|
|
"api_call": "POST /zra/team/{teamId}/team_managers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query. Retrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API."
|
|
},
|
|
"functionality": "Add team managers. Make sure your account support hierarchical structure team.\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: UnassignTeamManagers",
|
|
"api_call": "DELETE /zra/team/{teamId}/team_managers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query. Retrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API.",
|
|
"user_ids": "[REQUIRED] string: Zoom User Ids. Splited by comma. Max size is 3 in ZRA."
|
|
},
|
|
"functionality": "Delete team managers. Make sure your account support hierarchical structure team.\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: AssignTeamMembers",
|
|
"api_call": "POST /zra/team/{teamId}/team_members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query.\r\nRetrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API."
|
|
},
|
|
"functionality": "Add one or more users to a team.\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: UnassignTeamMembers",
|
|
"api_call": "DELETE /zra/team/{teamId}/team_members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"teamId": "[REQUIRED] string: The Zoom specific team ID to query. Retrieve by calling the [**List Account Teams**](/docs/api/rest/reference/iq/methods/#operation/ListAccountTeams) API.",
|
|
"user_ids": "[REQUIRED] string: Zoom User Ids. Splited by comma. Max size is 30"
|
|
},
|
|
"functionality": "Delete members of the team. Make sure to delete less than 30 users at one time.\n\n**Scopes:** `iq_team:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Revenue Accelerator API - Teams: ListTeams",
|
|
"api_call": "GET /zra/teams",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"parent_team_id": "string: parent team id",
|
|
"team_name": "string: the name of team",
|
|
"page_size": "integer: The number of records returned in a single API call.",
|
|
"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 the available result list exceeds the page size. The expiration period is 15 minutes."
|
|
},
|
|
"functionality": "List account teams. Filter by parent team ID or team name.\n\n\n\n**Scopes:** `iq_team:read`,`iq_team:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: listAddressBooks",
|
|
"api_call": "GET /contact_center/address_books",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"unit_id": "[REQUIRED] string: The address book unit's ID."
|
|
},
|
|
"functionality": "Use this API to return all address books. \n\n \n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: createAddressBook",
|
|
"api_call": "POST /contact_center/address_books",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create an [address book](https://support.zoom.us/hc/en-us/articles/4471544949389). An address book is a collection of consumer information like display names, phone numbers, and locations. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: listUnits",
|
|
"api_call": "GET /contact_center/address_books/units",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Use this API to return all address book units. \n\n \n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: createUnit",
|
|
"api_call": "POST /contact_center/address_books/units",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create an [address book unit](https://support.zoom.us/hc/en-us/articles/4471495629837-Managing-address-book-units). Admins can use address book units to organize several [address books](https://support.zoom.us/hc/en-us/articles/4471544949389#:~:text=An%20address%20book%20is%20a%20collection%20of%20consumer%20information%20like%20display%20names%2C%20phone%20numbers%2C%20and%20locations.). \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: getUnit",
|
|
"api_call": "GET /contact_center/address_books/units/{unitId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"unitId": "[REQUIRED] string: The address book unit's ID."
|
|
},
|
|
"functionality": "Use this API to get information about an address book unit. \n\n \n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: deleteUnit",
|
|
"api_call": "DELETE /contact_center/address_books/units/{unitId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"unitId": "[REQUIRED] string: The address book unit's ID."
|
|
},
|
|
"functionality": "Use this API to delete an address book unit. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: updateUnit",
|
|
"api_call": "PATCH /contact_center/address_books/units/{unitId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"unitId": "[REQUIRED] string: The address book unit's ID."
|
|
},
|
|
"functionality": "Use this API to update an address book unit. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: getAddressBook",
|
|
"api_call": "GET /contact_center/address_books/{addressBookId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID."
|
|
},
|
|
"functionality": "Use this API to get information about an address book. \n\n \n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: deleteAddressBook",
|
|
"api_call": "DELETE /contact_center/address_books/{addressBookId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID."
|
|
},
|
|
"functionality": "Use this API to delete an address book. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: updateAddressBook",
|
|
"api_call": "PATCH /contact_center/address_books/{addressBookId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID."
|
|
},
|
|
"functionality": "Use this API to update an address book's information. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: listContacts",
|
|
"api_call": "GET /contact_center/address_books/{addressBookId}/contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"emails": "array: The contact's email address. Multiple emails can be searched. Only an exact match is supported. Accomodates a maximum of 10 emails.",
|
|
"phone_numbers": "array: The contact's phone number. Multiple phone numbers can be searched, Only an exact match is supported. Accomodates a maximum of 10 phone numbers."
|
|
},
|
|
"functionality": "Returns all contacts in an address book.\n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: createContact",
|
|
"api_call": "POST /contact_center/address_books/{addressBookId}/contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID."
|
|
},
|
|
"functionality": "Use this API to create a new contact in an [address book](https://support.zoom.us/hc/en-us/articles/4471544949389). During an active engagement, the Zoom desktop client will display information from the address book if that customer is a contact in the address book. If the consumer is not in the address book, agents can add a new contact and choose which address book the contact belongs to. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: getContact",
|
|
"api_call": "GET /contact_center/address_books/{addressBookId}/contacts/{contactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID.",
|
|
"contactId": "[REQUIRED] string: The contact's ID."
|
|
},
|
|
"functionality": "Use this API to get information about an address book's contact. \n\n \n\n**Scopes:** `contact_center_contact:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: contactDelete",
|
|
"api_call": "DELETE /contact_center/address_books/{addressBookId}/contacts/{contactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID.",
|
|
"contactId": "[REQUIRED] string: The contact's ID."
|
|
},
|
|
"functionality": "Use this API to delete an address book's contact. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Address Books: updateContact",
|
|
"api_call": "PATCH /contact_center/address_books/{addressBookId}/contacts/{contactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"addressBookId": "[REQUIRED] string: The address book's ID.",
|
|
"contactId": "[REQUIRED] string: The contact's ID."
|
|
},
|
|
"functionality": "Use this API to update an address book's contact. \n\n \n\n**Scopes:** `contact_center_contact:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Agent Statuses: listSystemStatus",
|
|
"api_call": "GET /contact_center/system_statuses",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"status_category": "string: The status's category.\n\n* `agent_status` - User's system statuses.\n\n* `queue_opt_out_and_not_ready_status` - User's **Queue Opt-Out** and **Not Ready** reasons. **Not Ready** reasons are referenced by field `sub_status_name` in the Users APIs, such as [List users' profiles](https://developers.zoom.us/docs/contact-center/apis/#operation/users)."
|
|
},
|
|
"functionality": "Get a list of system statuses. Admins can create system statuses, such as **Maintenance**. \n\n**Scopes:** `contact_center_preference:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Agent Statuses: createSystemStatus",
|
|
"api_call": "POST /contact_center/system_statuses",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create custom statuses for the `agent_status` and `queue_opt_out_and_not_ready_status` categories. \n\n \n\n**Scopes:** `contact_center_preference:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Agent Statuses: getAStatus",
|
|
"api_call": "GET /contact_center/system_statuses/{statusId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"statusId": "[REQUIRED] string: The status ID."
|
|
},
|
|
"functionality": "Get information about a system status. \n\n \n\n**Scopes:** `contact_center_preference:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Agent Statuses: deleteSystemStatus",
|
|
"api_call": "DELETE /contact_center/system_statuses/{statusId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"statusId": "[REQUIRED] string: The status ID."
|
|
},
|
|
"functionality": "Delete a custom status for the agent_status and queue_opt_out_and_not_ready_status categories.\n\n**Scopes:** `contact_center_preference:write:admin`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Agent Statuses: updateSystemStatus",
|
|
"api_call": "PATCH /contact_center/system_statuses/{statusId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"statusId": "[REQUIRED] string: The status ID."
|
|
},
|
|
"functionality": "Update a custom status for the `agent_status` and `queue_opt_out_and_not_ready_status` categories. \n\n \n\n**Scopes:** `contact_center_preference:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: listDispositions",
|
|
"api_call": "GET /contact_center/dispositions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of available dispositions. \n\n \n\n**Scopes:** `contact_center_disposition:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: createDisposition",
|
|
"api_call": "POST /contact_center/dispositions",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new [disposition](https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). Dispositions let agents assign an outcome or topic to each engagement. After creating dispositions, you can add them to queues. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: listSets",
|
|
"api_call": "GET /contact_center/dispositions/sets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of available disposition sets. You can use sets to organize dispositions into groups. \n\n \n\n**Scopes:** `contact_center_disposition:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: createSet",
|
|
"api_call": "POST /contact_center/dispositions/sets",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new disposition set. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: getSet",
|
|
"api_call": "GET /contact_center/dispositions/sets/{dispositionSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionSetId": "[REQUIRED] string: The set's ID."
|
|
},
|
|
"functionality": "Retrieve information about a disposition set. \n\n \n\n**Scopes:** `contact_center_disposition:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: deleteSet",
|
|
"api_call": "DELETE /contact_center/dispositions/sets/{dispositionSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionSetId": "[REQUIRED] string: The set's ID."
|
|
},
|
|
"functionality": "Delete a disposition set. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: updateSet",
|
|
"api_call": "PATCH /contact_center/dispositions/sets/{dispositionSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionSetId": "[REQUIRED] string: The set's ID."
|
|
},
|
|
"functionality": "Update an existing disposition set. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: getDisposition",
|
|
"api_call": "GET /contact_center/dispositions/{dispositionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionId": "[REQUIRED] string: The disposition's ID."
|
|
},
|
|
"functionality": "Retrieve information about a disposition. \n\n \n\n**Scopes:** `contact_center_disposition:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: deleteDisposition",
|
|
"api_call": "DELETE /contact_center/dispositions/{dispositionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionId": "[REQUIRED] string: The disposition's ID."
|
|
},
|
|
"functionality": "Delete an existing disposition. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Dispositions: updateDisposition",
|
|
"api_call": "PATCH /contact_center/dispositions/{dispositionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"dispositionId": "[REQUIRED] string: The disposition's ID."
|
|
},
|
|
"functionality": "Update an existing disposition. \n\n \n\n**Scopes:** `contact_center_disposition:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Engagements: listEngagements",
|
|
"api_call": "GET /contact_center/engagements",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date, in `yyyy-mm-dd` or `yyyy-MM-dd'T'HH:mm:ss'Z'` format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in `yyyy-mm-dd` or `yyyy-MM-dd'T'HH:mm:ss'Z'` format, the same format as the `from` parameter.",
|
|
"queue_id": "string: The queue's ID.",
|
|
"user_id": "string: The agent's ID.",
|
|
"consumer_number": "string: The customer's phone number.",
|
|
"channel_types": "array: The channel's type. \n* voice \n* SMS \n* chat \n* video \n* kiosk \n* in_app_chat \n* in_app_video",
|
|
"channel": "string: The task's channel. \n* `voice` \n* `video` \n* `messaging` \n\nIt provides only a single channel. \n\nIf channel is used as an input parameter, the deprecated parameter `channel_types` is not processed.",
|
|
"channel_sources": "array: The channel's source. \n* `in_app_video` - Only applies to video channel. \n* `kiosk_video` - Only applies to video channel. \n* `web_video` - Only applies to video channel. \n* `in_app_chat` - Only applies to messaging channel. \n* `web_chat` - Only applies to messaging channel. \n* `sms` - Only applies to messaging channel. \n\nIt provides multiple channel_sources.",
|
|
"direction": "string: The engagement's direction."
|
|
},
|
|
"functionality": "Returns a list of engagements.\n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Engagements: getEngagement",
|
|
"api_call": "GET /contact_center/engagements/{engagementId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement's ID."
|
|
},
|
|
"functionality": "Returns information about an engagement. \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Engagements: engagementRecordingControl",
|
|
"api_call": "PUT /contact_center/engagements/{engagementId}/recording/{command}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "string: The engagement event's unique ID.",
|
|
"command": "string: The command for the recording control."
|
|
},
|
|
"functionality": "Controls the recording state for an engagement.\n\nOnly video and voice engagements succeed with this request. Calling this API for other channel types is invalid.\n\nAcceptance of a request and response of `HTTP 204 No Content` only ensures there were no validation errors with the request.\n\n**Scopes:** `contact_center_engagement:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Engagements: EngagementRecordingStatus",
|
|
"api_call": "GET /contact_center/engagements/{engagementId}/recordings/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "string: The engagement ID."
|
|
},
|
|
"functionality": "Polls a video or voice engagement's recordings' status.\n\n**Scopes:** `contact_center_engagement:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Flows: listFlows",
|
|
"api_call": "GET /contact_center/flows",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"status": "string: Use the status to filter the result.",
|
|
"channel_type": "string: Use the channel type to filter the result.",
|
|
"channel": "string: Use the channel to filter the result.",
|
|
"channel_source": "string: Use the channel source to filter the result. \n* `in_app_chat` - Only applies to messaging channel. \n* `web_chat` - Only applies to messaging channel. \n* `sms` - Only applies to messaging channel.\n* `facebook_messenger` - Only applies to messaging channel.\n* `whatsapp` - Only applies to messaging channel."
|
|
},
|
|
"functionality": "Return a list of flows. \n\n \n\n**Scopes:** `contact_center_flow:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Flows: getAFlow",
|
|
"api_call": "GET /contact_center/flows/{flowId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"flowId": "[REQUIRED] string: The flow's ID."
|
|
},
|
|
"functionality": "Get information about a flow. \n\n \n\n**Scopes:** `contact_center_flow:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: listInbox",
|
|
"api_call": "GET /contact_center/inboxes",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of inboxes. \n\n \n\n**Scopes:** `contact_center_inbox:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxCreate",
|
|
"api_call": "POST /contact_center/inboxes",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new inbox. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxesDelete",
|
|
"api_call": "DELETE /contact_center/inboxes",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inbox_ids": "array: List all inboxes to delete.",
|
|
"delete_all_messages_and_inboxes": "boolean: Delete all inboxes and messages provided.",
|
|
"move_to_inbox_id": "string: The ID of the inbox where messages from deleted inbox(es) will be moved."
|
|
},
|
|
"functionality": "Delete one or more inboxes. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: listInboxesMessages",
|
|
"api_call": "GET /contact_center/inboxes/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queue_ids": "array: The queue's IDs. The maximum value is 10 ",
|
|
"inbox_id": "string: The inbox's ID.",
|
|
"flow_id": "string: The flow's ID.",
|
|
"minimum_duration": "integer: The minimum duration.",
|
|
"maximum_duration": "integer: The maximum duration.",
|
|
"message_type": "string: The inbox message's type.\n* voicemail",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month maximum, as the response only includes one month's worth of data at once. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when specifying the `from` parameter. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"engagement_id": "string: Filter inbox messages by engagement ID.",
|
|
"consumer_number": "string: Filter inbox messages by consumer number.",
|
|
"status": "string: Filter inbox messages by status.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return all messages in an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxesMessagesDelete",
|
|
"api_call": "DELETE /contact_center/inboxes/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"delete_all_messages": "boolean: Whether or not to delete all inbox messages.\n\n true: Delete all inbox messages related to the filtered queues or flows. \n\n false: No inbox message is deleted.",
|
|
"queue_ids": "array: The queue's IDs. The maximum value is 10.",
|
|
"flow_ids": "array: List of flow's IDs, up to 10 separate IDs."
|
|
},
|
|
"functionality": "Delete messages. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: getInbox",
|
|
"api_call": "GET /contact_center/inboxes/{inboxId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Retrieve an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxUpdate",
|
|
"api_call": "PATCH /contact_center/inboxes/{inboxId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Update an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: listInboxMessages",
|
|
"api_call": "GET /contact_center/inboxes/{inboxId}/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID.",
|
|
"queue_ids": "array: The queue's IDs. The maximum value is 10.",
|
|
"message_type": "string: The inbox message's type.\n* voicemail",
|
|
"flow_id": "string: The flow's ID.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month maximum, as the response only includes one month's worth of data at once. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when specifying the `from` parameter. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of all messages in an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxMessagesDelete",
|
|
"api_call": "DELETE /contact_center/inboxes/{inboxId}/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID.",
|
|
"delete_all_messages": "boolean: Whether or not to delete all messages in a given inbox.\n\n true: delete all messages under an inbox."
|
|
},
|
|
"functionality": "Delete messages in an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: inboxMessageDelete",
|
|
"api_call": "DELETE /contact_center/inboxes/{inboxId}/messages/{messageId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID.",
|
|
"messageId": "[REQUIRED] string: The inbox message's ID."
|
|
},
|
|
"functionality": "Delete a single message in an inbox. \n\n \n\n**Scopes:** `contact_center_inbox:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: listInboxQueues",
|
|
"api_call": "GET /contact_center/inboxes/{inboxId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Retrieve a list of queues that have access to an inbox. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: assignInboxQueues",
|
|
"api_call": "POST /contact_center/inboxes/{inboxId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Assign queues access to an inbox. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: unassignInboxQueues",
|
|
"api_call": "DELETE /contact_center/inboxes/{inboxId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID.",
|
|
"queue_ids": "array: The queue's IDs. The maximum value is 10."
|
|
},
|
|
"functionality": "Remove queues' access to an inbox. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: listInboxUsers",
|
|
"api_call": "GET /contact_center/inboxes/{inboxId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Retrieve a list of users assigned to an inbox. \n\n \n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: assignInboxUsers",
|
|
"api_call": "POST /contact_center/inboxes/{inboxId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID."
|
|
},
|
|
"functionality": "Assign a user's access to an inbox. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Inboxes: unassignInboxUsers",
|
|
"api_call": "DELETE /contact_center/inboxes/{inboxId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"inboxId": "[REQUIRED] string: The inbox's ID.",
|
|
"user_ids": "[REQUIRED] array: A comma-separated list of user IDs to query, up to 30 user IDs."
|
|
},
|
|
"functionality": "Remove users' access to an inbox. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Logs: listSMS",
|
|
"api_call": "GET /contact_center/sms",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"from": "string: The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD').",
|
|
"country_iso_codes": "array: Two-letter ISO country [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).",
|
|
"direction": "string: The engagement's direction.",
|
|
"user_id": "string: The agent's ID.",
|
|
"engagement_id": "string: The engagement's ID.",
|
|
"consumer_number": "string: The consumer's phone number."
|
|
},
|
|
"functionality": "Returns a list of SMS. \n\n \n\n**Scopes:** `contact_center_sms:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Logs: listVoiceCall",
|
|
"api_call": "GET /contact_center/voice_calls",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"from": "string: The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'.",
|
|
"types": "array: The call's type.",
|
|
"distribution": "string: The engagement's distribution.",
|
|
"consumer_number": "string: The consumer's phone number.",
|
|
"direction": "string: The engagement's direction.",
|
|
"user_ids": "array: A comma-separated list of agents' user IDs to query, up to 20 agent IDs.",
|
|
"engagement_id": "string: The engagement's ID.",
|
|
"queue_ids": "array: A comma-separated list of queue IDs to query, up to 20 queue IDs. If user provide `none`, filter by “No queue used” in the web UI.",
|
|
"country_iso_codes": "array: Two-letter ISO country [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).",
|
|
"number_types": "array: The number's type."
|
|
},
|
|
"functionality": "Returns a list of voice call logs. \n\n \n\n**Scopes:** `contact_center_voice_call:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Notes: notes",
|
|
"api_call": "GET /contact_center/engagements/notes",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of notes. \n\n \n\n**Scopes:** `contact_center_note:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Notes: engagementNotes",
|
|
"api_call": "GET /contact_center/engagements/{engagementId}/notes",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement event's unique ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of notes under an engagement. \n\n \n\n**Scopes:** `contact_center_note:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Notes: getNote",
|
|
"api_call": "GET /contact_center/engagements/{engagementId}/notes/{noteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement event's unique ID.",
|
|
"noteId": "[REQUIRED] string: The note's ID."
|
|
},
|
|
"functionality": "Retrieve a note. \n\n \n\n**Scopes:** `contact_center_note:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Notes: noteUpdate",
|
|
"api_call": "PATCH /contact_center/engagements/{engagementId}/notes/{noteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement event's unique ID.",
|
|
"noteId": "[REQUIRED] string: The note's ID."
|
|
},
|
|
"functionality": "Update a note. \n\n \n\n**Scopes:** `contact_center_note:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listBusinessHours",
|
|
"api_call": "GET /contact_center/business_hours",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"account_default": "boolean: Default business hours or closures for the newly created queue."
|
|
},
|
|
"functionality": "Get a list of business hours. Admins can create business hours to select, such as the business hours "Default Hours". \n\n \n\n**Scopes:** `contact_center_operating_hours:read:admin`,`contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: businessHourCreate",
|
|
"api_call": "POST /contact_center/business_hours",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create new business hours. \n\n \n\n**Scopes:** `contact_center_operating_hours:write:admin`,`contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: getABusinessHour",
|
|
"api_call": "GET /contact_center/business_hours/{businessHourId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"businessHourId": "[REQUIRED] string: The business hours' ID."
|
|
},
|
|
"functionality": "Get information about business hours. \n\n \n\n**Scopes:** `contact_center_operating_hours:read:admin`,`contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: businessHourDelete",
|
|
"api_call": "DELETE /contact_center/business_hours/{businessHourId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"businessHourId": "[REQUIRED] string: The business hours' ID."
|
|
},
|
|
"functionality": "Delete business hours. \n\n \n\n**Scopes:** `contact_center_operating_hours:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: businessHourUpdate",
|
|
"api_call": "PATCH /contact_center/business_hours/{businessHourId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"businessHourId": "[REQUIRED] string: The business hours' ID."
|
|
},
|
|
"functionality": "Update business hours. \n \n \n\n\n**Scopes:** `contact_center_operating_hours:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listBusinessHourFlows",
|
|
"api_call": "GET /contact_center/business_hours/{businessHourId}/flows",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"businessHourId": "[REQUIRED] string: The business hours' ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Show a list of flows using business hours. \n\n \n\n**Scopes:** `contact_center_flow:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listBusinessHourQueues",
|
|
"api_call": "GET /contact_center/business_hours/{businessHourId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"businessHourId": "[REQUIRED] string: The business hours' ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Show a list of queues using business hours. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listClosures",
|
|
"api_call": "GET /contact_center/closures",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"account_default": "boolean: Default business hours or closures for the newly-created queue."
|
|
},
|
|
"functionality": "Get a list of closures. Admins can create closures to select. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`,`contact_center_operating_hours:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: closuresSetCreate",
|
|
"api_call": "POST /contact_center/closures",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new closure set. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`,`contact_center_operating_hours:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: getAClosureSet",
|
|
"api_call": "GET /contact_center/closures/{closureSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"closureSetId": "[REQUIRED] string: The closure set's ID."
|
|
},
|
|
"functionality": "Get information about a closure set. \n\n**Scopes:** `contact_center_queue:read:admin`,`contact_center_operating_hours:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: closureSetDelete",
|
|
"api_call": "DELETE /contact_center/closures/{closureSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"closureSetId": "[REQUIRED] string: The closure set's ID."
|
|
},
|
|
"functionality": "Delete closure sets. \n\n \n\n**Scopes:** `contact_center_operating_hours:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: closureSetUpdate",
|
|
"api_call": "PATCH /contact_center/closures/{closureSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"closureSetId": "[REQUIRED] string: The closure set's ID."
|
|
},
|
|
"functionality": "Update information about a closure set.\n\n**Scopes:** `contact_center_operating_hours:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listClosureSetFlows",
|
|
"api_call": "GET /contact_center/closures/{closureSetId}/flows",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"closureSetId": "[REQUIRED] string: The closure set's ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Show a list of flows using closures. \n\n \n\n**Scopes:** `contact_center_flow:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Operating Hours: listClosureSetQueues",
|
|
"api_call": "GET /contact_center/closures/{closureSetId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"closureSetId": "[REQUIRED] string: The closure set's ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Show a list of queues using closures. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: listQueues",
|
|
"api_call": "GET /contact_center/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"channel_type": "string: The task queue's channel types.",
|
|
"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.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Get information about all available queues. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: queueCreate",
|
|
"api_call": "POST /contact_center/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create an agent [queue](https://support.zoom.us/hc/en-us/articles/4423986595085) to determine which agents calls are routed to. Queues also link to an existing routing profile to determine how calls are routed. \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getAQueue",
|
|
"api_call": "GET /contact_center/queues/{queueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Get information about a queue. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: queueDelete",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Delete a specified queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: queueUpdate",
|
|
"api_call": "PATCH /contact_center/queues/{queueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Update a queue's description or agent list. \n \n \n\n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getQueueAgents",
|
|
"api_call": "GET /contact_center/queues/{queueId}/agents",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Retrieve the list of a queue's assigned agents. \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: assignQueueAgents",
|
|
"api_call": "POST /contact_center/queues/{queueId}/agents",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Add agents to a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: deleteQueueAgent",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}/agents/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID.",
|
|
"userId": "[REQUIRED] string: The queue user's ID."
|
|
},
|
|
"functionality": "Remove an agent from a queue. \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: updateQueueAgent",
|
|
"api_call": "PATCH /contact_center/queues/{queueId}/agents/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID.",
|
|
"userId": "[REQUIRED] string: The queue user's ID."
|
|
},
|
|
"functionality": "Update the list of agents in a queue. \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getQueueDispositions",
|
|
"api_call": "GET /contact_center/queues/{queueId}/dispositions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Return a list of queue's [dispositions](https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: assignQueueDispositions",
|
|
"api_call": "POST /contact_center/queues/{queueId}/dispositions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Add dispositions to a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getQueueDispositionSets",
|
|
"api_call": "GET /contact_center/queues/{queueId}/dispositions/sets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Return a list of queue's disposition sets(https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: assignQueueDispositionSets",
|
|
"api_call": "POST /contact_center/queues/{queueId}/dispositions/sets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Add a disposition set to a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: deleteQueueDispositionSet",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}/dispositions/sets/{dispositionSetId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID.",
|
|
"dispositionSetId": "[REQUIRED] string: The queue disposition set's ID."
|
|
},
|
|
"functionality": "Delete a disposition set from a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: deleteQueueDisposition",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}/dispositions/{dispositionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID.",
|
|
"dispositionId": "[REQUIRED] string: The queue disposition's ID."
|
|
},
|
|
"functionality": "Delete a disposition from a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getAQueueOperatingHours",
|
|
"api_call": "GET /contact_center/queues/{queueId}/operating_hours",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Get information about a queue's operating hours. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: QueueOperatingHoursUpdate",
|
|
"api_call": "PATCH /contact_center/queues/{queueId}/operating_hours",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Update a queue's operating hours. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: getQueueSupervisors",
|
|
"api_call": "GET /contact_center/queues/{queueId}/supervisors",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Return a list of a queue's assigned supervisors. \n\n \n\n**Scopes:** `contact_center_queue:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: assignQueueSupervisors",
|
|
"api_call": "POST /contact_center/queues/{queueId}/supervisors",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID."
|
|
},
|
|
"functionality": "Add supervisors to a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Queues: deleteQueueSupervisor",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}/supervisors/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The task queue's ID.",
|
|
"userId": "[REQUIRED] string: The queue user's ID."
|
|
},
|
|
"functionality": "Unassign a supervisor from a queue. \n\n \n\n**Scopes:** `contact_center_queue:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: listEngagementRecordings",
|
|
"api_call": "GET /contact_center/engagements/{engagementId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement event's unique ID.",
|
|
"channel_type": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.",
|
|
"channel": "string: The recording's channel type. \n* `voice` - Voice recording \n* `video` - Video recording\n\n If channel is used as an input parameter, the deprecated parameter `channnel_type` will not be processed.",
|
|
"from": "string: The start time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'. The defined date range should be a month, as the response only includes one month's worth of data. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD', the same format as the `from` parameter.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of all of an engagement's recordings. \n\n**Note:** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. \n\n \n\n**Scopes:** `contact_center_recording:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: deleteEngagementRecordings",
|
|
"api_call": "DELETE /contact_center/engagements/{engagementId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"engagementId": "[REQUIRED] string: The engagement's ID.",
|
|
"delete_all_recordings": "boolean: Whether to delete all recordings in this engagement. \n* `true` — Delete all recordings in this engagement"
|
|
},
|
|
"functionality": "Delete all recordings in a given engagement. \n\n**Note**: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. \n\n \n\n**Scopes:** `contact_center_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: listQueueRecordings",
|
|
"api_call": "GET /contact_center/queues/{queueId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The queue's ID.",
|
|
"channel_type": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.",
|
|
"channel": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.\n\n If channel is used as an input parameter, the deprecated parameter `channnel_type` will not be processed.",
|
|
"from": "string: The start time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'. The defined date range should be a month, as the response only includes one month's worth of data. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD', the same format as the `from` parameter.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of all recordings in a queue. \n\n**Note:** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. \n\n \n\n**Scopes:** `contact_center_recording:read:admin`,`contact_center_recording:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: deleteQueueRecordings",
|
|
"api_call": "DELETE /contact_center/queues/{queueId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The queue's ID.",
|
|
"delete_all_recordings": "boolean: Whether to delete all recordings in this queue. \n* `true` — Delete all recordings in this queue"
|
|
},
|
|
"functionality": "Delete all recordings in a queue. \n\n**Note**: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. \n\n \n\n**Scopes:** `contact_center_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: listRecordings",
|
|
"api_call": "GET /contact_center/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"query_date_type": "string: Query date type. \n* `recording_start_time` - The recording's start time.\n* `recording_end_time` - The recording's end time.",
|
|
"from": "string: The start time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'. The defined date range should be a month, as the response only includes one month's worth of data. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD', the same format as the `from` parameter.",
|
|
"recording_type": "string: The recording's type. \n* `on_demand` - Manually trigger recording. \n* `automatic` - Automatically trigger recording.",
|
|
"owner_type": "string: The recording's owner type. \n* `user` - This recording belongs to a user. \n* `queue` - This recording belongs to a queue.",
|
|
"channel_type": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.",
|
|
"channel": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.\n\n If channel is used as an input parameter, the deprecated parameter `channnel_type` will not be processed.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of available recordings. \n\n**Note** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. \n\n \n\n**Scopes:** `contact_center_recording:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: deleteRecording",
|
|
"api_call": "DELETE /contact_center/recordings/{recordingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"recordingId": "[REQUIRED] string: The recording's ID."
|
|
},
|
|
"functionality": "Delete a selected recording. \n\n**Note**: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. \n\n \n\n**Scopes:** `contact_center_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: listUserRecordings",
|
|
"api_call": "GET /contact_center/users/{userId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.",
|
|
"channel_type": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.",
|
|
"channel": "string: The recording's channel type. \n* `voice` - Voice recording. \n* `video` - Video recording.\n\n If channel is used as an input parameter, the deprecated parameter `channnel_type` will not be processed.",
|
|
"from": "string: The start time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'. The defined date range should be a month, as the response only includes one month's worth of data. If unspecified, this parameter returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in ISO 8601 format, either yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD', the same format as the `from` parameter.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Get a user's recordings. \n\n**Note** Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. \n\n \n\n**Scopes:** `contact_center_recording:read:admin`,`contact_center_recording:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Recordings: deleteUserRecordings",
|
|
"api_call": "DELETE /contact_center/users/{userId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.",
|
|
"delete_all_recordings": "boolean: Whether to delete all of this user's recordings. \n* `true` - Delete all of this user's recordings."
|
|
},
|
|
"functionality": "Delete all of a given user's recordings. \n\n**Note** Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. \n\n \n\n**Scopes:** `contact_center_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: ListRegions",
|
|
"api_call": "GET /contact_center/regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Get information about all available regions.\n\n**Scopes:** `contact_center_region:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: CreateARegion",
|
|
"api_call": "POST /contact_center/regions",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new region. \n\n**Scopes:** `contact_center_region:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: GetARegion",
|
|
"api_call": "GET /contact_center/regions/{regionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"regionId": "string: The region ID."
|
|
},
|
|
"functionality": "Get information about a region. \n\n**Scopes:** `contact_center_region:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: DeleteARegion",
|
|
"api_call": "DELETE /contact_center/regions/{regionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"regionId": "string: The region ID.",
|
|
"move_users_to_region_id": "[REQUIRED] string: ID of the region to move users to."
|
|
},
|
|
"functionality": "Delete a site and move its members to another region. \n\n**Scopes:** `contact_center_region:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: UpdateARegion",
|
|
"api_call": "PATCH /contact_center/regions/{regionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"regionId": "string: The region's ID."
|
|
},
|
|
"functionality": "Update information for a region.\n\n**Scopes:** `contact_center_region:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: ListRegion'sUsers",
|
|
"api_call": "GET /contact_center/regions/{regionId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"regionId": "string: The region's ID.",
|
|
"role_id": "string: The role's ID."
|
|
},
|
|
"functionality": "Retrieve the list of a region's assigned agents. \n\n \n\n**Scopes:** `contact_center_region:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Regions: AssignUsersToARegion",
|
|
"api_call": "POST /contact_center/regions/{regionId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"regionId": "string: The region's ID."
|
|
},
|
|
"functionality": "Assign users to a region.\n\n**Scopes:** `contact_center_region:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Reports: listAgentStatusHistory",
|
|
"api_call": "GET /contact_center/analytics/agents/status_history",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"queue_id": "string: The queue's ID.",
|
|
"user_id": "string: The agent's ID.",
|
|
"status_id": "string: The status's ID.",
|
|
"sub_status_id": "string: The sub status's ID."
|
|
},
|
|
"functionality": "Generate a list of an agent's status history reports. \n\n \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Reports: listAgentTimeSheet",
|
|
"api_call": "GET /contact_center/analytics/agents/time_sheets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"queue_id": "string: The queue's ID.",
|
|
"user_id": "string: The agent's ID.",
|
|
"interval": "string: The historical queue report's interval."
|
|
},
|
|
"functionality": "Generate a list of an agent's time sheet reports. \n\n \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Reports: listHistoricalDetailMetric",
|
|
"api_call": "GET /contact_center/analytics/historical/details/metrics",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"queue_ids": "array: A comma-separated list of queue IDs to query, up to 20 queue IDs.",
|
|
"user_id": "string: The agent's ID.",
|
|
"consumer_number": "string: The consumer's phone number.",
|
|
"consumer_id": "string: The consumer ID for video, chat, or SMS engagements.",
|
|
"direction": "string: The engagement's direction. \n\n Voice, SMS : \n* `inbound` \n* `outbound` \n\n Chat, Video: \n* `inbound`",
|
|
"results": "array: The engagement's results. \n\n Voice \n* `completed` \n* `short_abandoned` \n* `long_abandoned` \n* `hold_abandoned` \n* `overflowed_to_inbox` \n* `overflowed_to_disconnect` \n* `long_calls` \n* `short_calls` \n* `hang_up_calls` \n* `missed` \n* `declined` \n\n Video: \n* `completed` \n* `short_abandoned` \n* `long_abandoned` \n* `missed` \n* `declined` \n\n Chat, SMS: \n* `completed` \n* `auto_closed` \n* `missed` \n* `declined`",
|
|
"channel_types": "array: The channel's type. It provides only a single channel type.",
|
|
"channel": "[REQUIRED] string: The task's channel. \n* `voice` \n* `video` \n* `messaging` \n\nIt provides only a single channel. \n\nIf channel is used as an input parameter, the deprecated parameter `channel_types` is not processed.",
|
|
"channel_sources": "array: The channel's source. \n* `in_app_chat` - Only applies to messaging channel. \n* `web_chat` - Only applies to messaging channel. \n* `sms` - Only applies to messaging channel. \n\nIt provides multiple channel_sources.",
|
|
"queue_wait_type": "string: The queue's wait type. This field is applicable to voice channel.",
|
|
"required_skill_ids": "array: The required skill's ID. This field is applicable to voice channel."
|
|
},
|
|
"functionality": "Generates a list of historical detail reports. \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Reports: listHistoricalQueueMetric",
|
|
"api_call": "GET /contact_center/analytics/historical/queues/metrics",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"queue_ids": "array: A comma-separated list of queue IDs to query, up to 20 queue IDs.",
|
|
"channel_types": "array: The channel's type. Provide only a single channel type.",
|
|
"channel": "[REQUIRED] string: The task's channel. \n* `voice` \n* `video` \n* `messaging` \n\nProvide only a single channel. \n\nIf channel is used as an input parameter, the deprecated parameter `channel_types` will not be processed.",
|
|
"channel_sources": "array: The channel's source. \n* `in_app_chat` - Only applies to messaging channel. \n* `web_chat` - Only applies to messaging channel. \n* `sms` - Only applies to messaging channel. \n\nProvide multiple channel_sources",
|
|
"interval": "string: The historical queue report's interval."
|
|
},
|
|
"functionality": "Generate a list of historical queue reports. \n\n \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Reports: listQueueAgentMetric",
|
|
"api_call": "GET /contact_center/analytics/historical/queues/{queueId}/agents/metrics",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"queueId": "[REQUIRED] string: The queue's ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"timezone": "string: The call's timezone. The default is **UTC**.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"channel_types": "array: The channel's type. Provide only a single channel type.",
|
|
"channel": "[REQUIRED] string: The task's channel. \n* `voice` \n* `video` \n* `messaging` \n\nProvides only a single channel. \n\nIf channel is used as an input parameter, the deprecated parameter `channel_types` will not be processed.",
|
|
"channel_sources": "array: The channel's source. \n* `in_app_chat` - Only applies to messaging channel. \n* `web_chat` - Only applies to messaging channel. \n* `sms` - Only applies to messaging channel. \n\nProvide multiple channel_sources",
|
|
"interval": "string: The historical queue report's interval."
|
|
},
|
|
"functionality": "Generate a list of a historical queue's agent reports. \n\n**Scopes:** `contact_center_report:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: listRoles",
|
|
"api_call": "GET /contact_center/roles",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Use this API to return a list of roles. \n\n \n\n**Scopes:** `contact_center_role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: createRole",
|
|
"api_call": "POST /contact_center/roles",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create a new [role](https://support.zoom.us/hc/en-us/articles/4471054202253-Using-role-management). Admins can use the role management feature to control access to features and settings in the Zoom web portal. \n\n \n\n**Scopes:** `contact_center_role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: getRole",
|
|
"api_call": "GET /contact_center/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID."
|
|
},
|
|
"functionality": "Use this API to get information about a role. \n\n \n\n**Scopes:** `contact_center_role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: deleteRole",
|
|
"api_call": "DELETE /contact_center/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID.",
|
|
"transfer_role_id": "[REQUIRED] string: The transfer role's ID. If you deleted the role, you will need to reassign the users associated to this role to a different role."
|
|
},
|
|
"functionality": "Use this API to delete a role. \n\n \n\n**Scopes:** `contact_center_role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: updateRole",
|
|
"api_call": "PATCH /contact_center/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID."
|
|
},
|
|
"functionality": "Use this API to update a role. \n\n \n\n**Scopes:** `contact_center_role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: getRoleUsers",
|
|
"api_call": "GET /contact_center/roles/{roleId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Use this API to get information about the users assigned to a specific role. \n\n \n\n**Scopes:** `contact_center_role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: assignRoleUsers",
|
|
"api_call": "POST /contact_center/roles/{roleId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID."
|
|
},
|
|
"functionality": "Use this API to assign users to a role. Roles have unique privileges that assigned users have access to. For example, an Administrator or Agent role. \n\n \n\n**Scopes:** `contact_center_role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Roles: deleteRoleUser",
|
|
"api_call": "DELETE /contact_center/roles/{roleId}/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role's ID.",
|
|
"userId": "[REQUIRED] string: The role user's ID."
|
|
},
|
|
"functionality": "Use this API to unassign a user from a role. \n\n \n\n**Scopes:** `contact_center_role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: listSkills",
|
|
"api_call": "GET /contact_center/skills",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skill_category_id": "string: The skill category's ID.",
|
|
"skill_id": "string: The skill's ID.",
|
|
"skill_type": "string: The skill category's type.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Return a list of a skills or a skill category's assigned skills. \n\n \n\n**Scopes:** `contact_center_skill:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: skillCreate",
|
|
"api_call": "POST /contact_center/skills",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a [skill](https://support.zoom.us/hc/en-us/articles/4423986613261) for skill-based routing. Skills are agent traits that ensure they are the right person to handle a customer interaction. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: listSkillCategory",
|
|
"api_call": "GET /contact_center/skills/categories",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "List all available skill categories and their information. \n\n \n\n**Scopes:** `contact_center_skill:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: SkillCategoryCreate",
|
|
"api_call": "POST /contact_center/skills/categories",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new skill category. Skill categories let you assign several similar skills to a category, such as language skills. You can then route French-speaking callers to contact center agents that have the highest proficiency with French. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: getSkillCategory",
|
|
"api_call": "GET /contact_center/skills/categories/{skillCategoryId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillCategoryId": "[REQUIRED] string: The skill category's ID."
|
|
},
|
|
"functionality": "Return information about a specific skill category. \n\n \n\n**Scopes:** `contact_center_skill:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: SkillCategoryDelete",
|
|
"api_call": "DELETE /contact_center/skills/categories/{skillCategoryId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillCategoryId": "[REQUIRED] string: The skill category's ID."
|
|
},
|
|
"functionality": "Delete an existing skill category. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: SkillCategoryUpdate",
|
|
"api_call": "PATCH /contact_center/skills/categories/{skillCategoryId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillCategoryId": "[REQUIRED] string: The skill category's ID."
|
|
},
|
|
"functionality": "Update a skill category. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: getSkill",
|
|
"api_call": "GET /contact_center/skills/{skillId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillId": "[REQUIRED] string: The skill's ID."
|
|
},
|
|
"functionality": "Return a skill's information and its usage. \n\n \n\n**Scopes:** `contact_center_skill:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: skillDelete",
|
|
"api_call": "DELETE /contact_center/skills/{skillId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillId": "[REQUIRED] string: The skill's ID."
|
|
},
|
|
"functionality": "Delete a skill. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: skillNameUpdate",
|
|
"api_call": "PATCH /contact_center/skills/{skillId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillId": "[REQUIRED] string: The skill's ID."
|
|
},
|
|
"functionality": "Use this API to update a skill's name. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: listSkillUsers",
|
|
"api_call": "GET /contact_center/skills/{skillId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"skillId": "[REQUIRED] string: The skill's ID.",
|
|
"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.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Retrieve a list of all users assigned to a skill. \n\n**This endpoint will be deprecated in August 2024.**\n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Skills: GetASkillUser",
|
|
"api_call": "GET /contact_center/skills/{skillId}/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"skillId": "[REQUIRED] string: The skill's ID."
|
|
},
|
|
"functionality": "Retrieve information for a particular skill's user. \n\n **This endpoint will be deprecated in August 2024.** For more information, see the [Tasks and Skills deprecation FAQ](https://developers.zoom.us/docs/api/rest/contact-center-api/endpoint-deprecation-faq/#task-and-skill-endpoint-deprecations---august-2024).\n\n\n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Tasks: listTasks",
|
|
"api_call": "GET /contact_center/tasks",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"task_status": "string: The task's status: \n* `pending` \n* `reserved` \n* `assigned` \n* `canceled` \n* `completed` \n* `wrapping`",
|
|
"queue_id": "string: The task's queue ID.",
|
|
"engagement_id": "string: The task's engagement ID.",
|
|
"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."
|
|
},
|
|
"functionality": "Use this API to return a list of tasks. \n\n**This endpoint will be deprecated in August 2024.**\n\n**Scopes:** `contact_center_task:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Tasks: getATask",
|
|
"api_call": "GET /contact_center/tasks/{taskId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"taskId": "[REQUIRED] string: The task's ID."
|
|
},
|
|
"functionality": "Use this API to return information about a task. \n\n**This endpoint will be deprecated in August 2024.**\n\n**Scopes:** `contact_center_task:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Tasks: taskUpdate",
|
|
"api_call": "PATCH /contact_center/tasks/{taskId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"taskId": "[REQUIRED] string: The task's ID."
|
|
},
|
|
"functionality": "Use this API to: \n 1) update a task's priority level or \n 2) manually assign or unassign a task to an agent. \n\n**This endpoint will be deprecated in August 2024.**\n\n**Scopes:** `contact_center_task:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: users",
|
|
"api_call": "GET /contact_center/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"search_key": "string: The user's email address or username.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"region_id": "string: The region's ID.",
|
|
"user_access": "string: The user's access status. \n* `active` — The user's role permissions allow them to access the Contact Center. \n* `inactive` — The user cannot access the Contact Center."
|
|
},
|
|
"functionality": "Returns a list of users and their information. \n\n \n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: createUser",
|
|
"api_call": "POST /contact_center/users",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a profile for a user. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: batchDeleteUsers",
|
|
"api_call": "DELETE /contact_center/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"user_ids": "array: A comma-separated list of user IDs to query, up to 20 user IDs.",
|
|
"user_emails": "array: A comma-separated list of user emails to query, up to 20 user emails."
|
|
},
|
|
"functionality": "Batch delete users. \n\n**Note**: Either `user_ids` or `user_emails` needs to be provided. If both `user_ids` and `user_emails` are provided, only `user_ids` will be used, while `user_emails` will be ignored. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: BatchUpdateUsers",
|
|
"api_call": "PATCH /contact_center/users",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Batch update user profiles. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: BatchCreateUsers",
|
|
"api_call": "POST /contact_center/users/batch",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Batch create user profiles. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: userGet",
|
|
"api_call": "GET /contact_center/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Retrieve a user's profile information. \n\n \n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: userDelete",
|
|
"api_call": "DELETE /contact_center/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Delete the specified user's profile. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: userUpdate",
|
|
"api_call": "PATCH /contact_center/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Update information in a user's profile. \n\n \n\n**Scopes:** `contact_center_user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: listUserQueues",
|
|
"api_call": "GET /contact_center/users/{userId}/queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "List a user's queues. \n\n \n\n**Scopes:** `contact_center_user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: ListAUserSkills",
|
|
"api_call": "GET /contact_center/users/{userId}/skills",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"skill_category_id": "string: The skill category's ID.",
|
|
"skill_type": "string: The skill category's type."
|
|
},
|
|
"functionality": "Get a list of skills assigned to a given user. \n\n \n\n**Scopes:** `contact_center_skill:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: assignSkills",
|
|
"api_call": "POST /contact_center/users/{userId}/skills",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Assign [skills](https://support.zoom.us/hc/en-us/articles/4423986613261) to a user. Skills are user traits that ensure that a given agent is the best person to handle a given customer interaction. Proficiency ratings indicate the user's level of expertise or knowledge of that skill. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Users: deleteASkill",
|
|
"api_call": "DELETE /contact_center/users/{userId}/skills/{skillId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"skillId": "[REQUIRED] string: The skill's ID."
|
|
},
|
|
"functionality": "Delete a skill assigned to a given user. \n\n \n\n**Scopes:** `contact_center_skill:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: listVariableLogs",
|
|
"api_call": "GET /contact_center/variable_logs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"from": "string: The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss’TZD’). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss’TZD’).",
|
|
"group_type": "string: The variable group's type.",
|
|
"data_type": "string: The variable data's type.",
|
|
"engagement_id": "string: The engagement's ID.",
|
|
"flow_id": "string: The flow's ID.",
|
|
"widget_name": "string: The widget's name.",
|
|
"variable_name": "string: The variable's name.",
|
|
"variable_value": "string: The variable's value."
|
|
},
|
|
"functionality": "Return a list of variable logs.\n\n \n\n**Scopes:** `contact_center_variable_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: getVariableLog",
|
|
"api_call": "GET /contact_center/variable_logs/{variableLogId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableLogId": "[REQUIRED] string: The variable log's ID."
|
|
},
|
|
"functionality": "Get information about a variable log.\n\n \n\n**Scopes:** `contact_center_variable_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: deleteVariableLog",
|
|
"api_call": "DELETE /contact_center/variable_logs/{variableLogId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableLogId": "[REQUIRED] string: The variable log's ID."
|
|
},
|
|
"functionality": "Delete a variable log. \n\n \n\n**Scopes:** `contact_center_variable_log:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: variables",
|
|
"api_call": "GET /contact_center/variables",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variable_group_id": "[REQUIRED] string: The variable's group ID.",
|
|
"data_type": "string: The data's type. \n* `string` \n* `number` \n* `boolean` \n* `date_time` \n* `currency` \n* `percentage` \n* `email` \n* `url` \n* `phone` - ([E.164 format](https://en.wikipedia.org/wiki/E.164))",
|
|
"variable_type": "string: The variable's type. \n* `global_variable` \n* `address_book_variable`",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page."
|
|
},
|
|
"functionality": "Returns a list of variables for a specific variable group. \n\n \n\n**Scopes:** `contact_center_variable:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: createVariable",
|
|
"api_call": "POST /contact_center/variables",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new variable.\n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: listVariableGroups",
|
|
"api_call": "GET /contact_center/variables/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"variable_group_type": "string: The variable group's type."
|
|
},
|
|
"functionality": "Use thi API to return a list of variable groups.\n\n \n\n**Scopes:** `contact_center_variable:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: createVariableGroup",
|
|
"api_call": "POST /contact_center/variables/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a custom variable group. \n\n \n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: getAVariableGroup",
|
|
"api_call": "GET /contact_center/variables/groups/{variableGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableGroupId": "[REQUIRED] string: The variable group's ID."
|
|
},
|
|
"functionality": "Get information about a variable group.\n\n \n\n**Scopes:** `contact_center_variable:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: DeleteGroup",
|
|
"api_call": "DELETE /contact_center/variables/groups/{variableGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableGroupId": "[REQUIRED] string: The variable group's ID."
|
|
},
|
|
"functionality": "Delete a specified variable group. \n\n \n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: updateVariableGroup",
|
|
"api_call": "PATCH /contact_center/variables/groups/{variableGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableGroupId": "[REQUIRED] string: The variable group's ID."
|
|
},
|
|
"functionality": "Update a variable group. \n\n \n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: variableGet",
|
|
"api_call": "GET /contact_center/variables/{variableId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableId": "[REQUIRED] string: The variable's ID."
|
|
},
|
|
"functionality": "Retrieve a variable. \n\n \n\n**Scopes:** `contact_center_variable:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: variableDelete",
|
|
"api_call": "DELETE /contact_center/variables/{variableId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableId": "[REQUIRED] string: The variable's ID."
|
|
},
|
|
"functionality": "Delete a variable. \n\n \n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Contact Center API - Variables: variableUpdate",
|
|
"api_call": "PATCH /contact_center/variables/{variableId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"variableId": "[REQUIRED] string: The variable's ID."
|
|
},
|
|
"functionality": "Update a variable. \n\n \n\n**Scopes:** `contact_center_variable:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: ListApps",
|
|
"api_call": "GET /marketplace/apps",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token is used to paginate through large result sets. The API returns a next page token whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"type": "string: Types of app requests to query: \n* `active_requests` — All active app requests. \n* `past_requests` - All past app requests. \n* `public` - All public apps. \n* `account_created` - All apps created by this account. "
|
|
},
|
|
"functionality": "Use this API to list all active and past app requests, or list all public and private apps. \n\n\n\n**Scopes:** `marketplace_app:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getAppInfo",
|
|
"api_call": "GET /marketplace/apps/{appId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"appId": "[REQUIRED] string: The app's ID."
|
|
},
|
|
"functionality": "Use this API to get app information. \n\n\n\n**Scopes:** `marketplace_app:read`,`marketplace_app:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getAppUserRequests",
|
|
"api_call": "GET /marketplace/apps/{appId}/requests",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token is used to paginate through large result sets. The API returns a next page token whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"appId": "[REQUIRED] string: The app's ID.",
|
|
"status": "string: The type of app request to query: \n* `pending` — Only pending app requests. \n* `approved` — Only approved app requests. \n* `rejected` — Only rejected app requests."
|
|
},
|
|
"functionality": "Use this API to get an app's user requests and the status of their approval. \n\n\n\n**Scopes:** `marketplace_app:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: AddAppAllowRequestsForUsers",
|
|
"api_call": "POST /marketplace/apps/{appId}/requests",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"appId": "[REQUIRED] string: The app's ID."
|
|
},
|
|
"functionality": "Use this API to add app allow requests for all users, groups of users, or specific users. \n\n \n\n**Scopes:** `marketplace_app:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: updateAppRequestStatus",
|
|
"api_call": "PATCH /marketplace/apps/{appId}/requests",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"appId": "[REQUIRED] string: The app's ID."
|
|
},
|
|
"functionality": "Use this API to update an app's request status or update app status. Administrators can only agree to user-level apps.\n\n \n\n**Scopes:** `marketplace_app:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getWebhookLogs",
|
|
"api_call": "GET /marketplace/apps/{appId}/webhook_logs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"appId": "[REQUIRED] string: The app's ID.",
|
|
"next_page_token": "string: The next page token is used to paginate through large result sets. The API returns a next page token whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"from": "string: Start date in format: `yyyy-MM-dd'T'HH:mm:ss'Z'`. The "from" and "to" date range must be within 7 days.",
|
|
"to": "string: End date.",
|
|
"event": "string: The event name. All types of events are queried if the parameter is not passed.",
|
|
"type": "integer: The query type: \n* `1` — Query all webhook logs. \n* `2` — Only query failed webhook logs. \n* `3` — Only query successful webhook logs."
|
|
},
|
|
"functionality": "Get users' webhook call logs and query records from the past 7 days. \n\n\n\n**Scopes:** `marketplace_app:read:admin`,`marketplace_app:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getAppUserEntitlementRequests",
|
|
"api_call": "GET /marketplace/monetization/entitlements",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"user_id": "string: The user ID of the user who's requesting entitlement information."
|
|
},
|
|
"functionality": "Get App User Entitlement information\n\n**Scopes:** `marketplace_entitlement:read`,`marketplace_entitlement:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getUserAppRequests",
|
|
"api_call": "GET /marketplace/users/{userId}/apps",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token is used to paginate through large result sets. The API returns a next page token whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"type": "string: The type of app request to query: \n* `active_requests` — All active app requests. \n* `past_requests` - All past app requests."
|
|
},
|
|
"functionality": "Use this API to get all of a user's app requests. \n\n\n\n**Scopes:** `marketplace_app:read`,`marketplace_app:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - App: getUserEntitlementRequests",
|
|
"api_call": "GET /marketplace/users/{userId}/entitlements",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID."
|
|
},
|
|
"functionality": "Get a user's entitlements. \n\n\n\n**Scopes:** `marketplace_entitlement:read`,`marketplace_entitlement:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - Apps: Sendappnotifications",
|
|
"api_call": "POST /app/notifications",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Send app notifications to the Zoom \"Activity Center\". (Note: This API only supports OAuth 2.0.)\n\n**Scopes:** `app:notification:read`,`app:notification:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Marketplace API - Apps: generateAppDeeplink",
|
|
"api_call": "POST /zoomapp/deeplink",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create an app deeplink. \n\n \n\n**Scopes:** `app:deeplink:write`,`app:deeplink:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroups",
|
|
"api_call": "GET /contacts/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned with a single API call. ",
|
|
"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."
|
|
},
|
|
"functionality": "List [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account. \n \n\n\n**Scopes:** `contact_group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupCreate",
|
|
"api_call": "POST /contacts/groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management).\n\n**Prerequisite**: Pro or higher account. \n \n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroup",
|
|
"api_call": "GET /contacts/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The contact group ID. \n \nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API."
|
|
},
|
|
"functionality": "Get a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account. \n \n\n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupDelete",
|
|
"api_call": "DELETE /contacts/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The contact group ID. \n \nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API."
|
|
},
|
|
"functionality": "Use this API to delete a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\n\n**Prerequisite**: Pro or higher account. \n \n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupUpdate",
|
|
"api_call": "PATCH /contacts/groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The contact group ID. \n \nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API."
|
|
},
|
|
"functionality": "Update a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro or higher account. \n \n\n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupMembers",
|
|
"api_call": "GET /contacts/groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned with a single API call. ",
|
|
"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."
|
|
},
|
|
"functionality": "List members in [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account. \n \n\n\n**Scopes:** `contact_group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupMemberAdd",
|
|
"api_call": "POST /contacts/groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add members to a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management).\n\n**Prerequisite**: Pro or higher account. \n \n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Contact Groups: contactGroupMemberRemove",
|
|
"api_call": "DELETE /contacts/groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"member_ids": "[REQUIRED] string: The member's ID in a contact group. Use commas (,) to separate a maximum of 20 ids. \n \nCan be retrieved by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroupMembers) API."
|
|
},
|
|
"functionality": "Use this API to remove members in a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\n\n**Prerequisite**: Pro or higher account. \n \n\n**Scopes:** `contact_group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groups",
|
|
"api_call": "GET /groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account. \n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupCreate",
|
|
"api_call": "POST /groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management). You can add a **maximum** of 100 groups in one account per day, and a maximum of 5000 groups in one account.\n\nIf you enabled a new group via the user interface, you can also choose whether to display the group and set its privacy level.\n\n**Prerequisites**: \n* A Pro or higher account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: group",
|
|
"api_call": "GET /groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupDelete",
|
|
"api_call": "DELETE /groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Delete an entire [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisites:** * A Pro, Business, or Education account.\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupUpdate",
|
|
"api_call": "PATCH /groups/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupAdmins",
|
|
"api_call": "GET /groups/{groupId}/admins",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to return a list of [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrators under your account.\n\n**Prerequisites:** \n* A Pro, Business, or Education account\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupAdminsCreate",
|
|
"api_call": "POST /groups/{groupId}/admins",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Use this API to add administrators to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisites:** \n* A Pro, Business, or Education account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupAdminsDelete",
|
|
"api_call": "DELETE /groups/{groupId}/admins/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"userId": "[REQUIRED] : The user ID or email address of the user. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Use this API to remove a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrator in a Zoom account.\n\n**Prerequisites:** \n* A Pro, Business, or Education account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: getGroupLockSettings",
|
|
"api_call": "GET /groups/{groupId}/lock_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID.",
|
|
"option": "string: Optional query parameters. \n* `meeting_security` - Use this query parameter to view the meeting security settings applied to the user's account."
|
|
},
|
|
"functionality": "Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. \nIf you lock a setting, the group members will not be able to modify it individually. \n\n **Note:** The `force_pmi_jbh_password` field under meeting settings is to be deprecated on September 22, 2019. This field is replaced by another field that will provide the same functionality.\n\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupLockedSettings",
|
|
"api_call": "PATCH /groups/{groupId}/lock_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID.",
|
|
"option": "string: Optional query parameters.\n* `meeting_security` - View the meeting security settings applied to the user's account."
|
|
},
|
|
"functionality": "Update a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members cannot modify it individually. \n\n **Note:** The `force_pmi_jbh_password` field under meeting settings is deprecated as of September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupMembers",
|
|
"api_call": "GET /groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"page_number": "integer: **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupMembersCreate",
|
|
"api_call": "POST /groups/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Use this API to add users to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in your account.\n\n**Prerequisites:** \n* A Pro, Business, or Education account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupMembersDelete",
|
|
"api_call": "DELETE /groups/{groupId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n \nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"memberId": "[REQUIRED] string: The member ID or email address."
|
|
},
|
|
"functionality": "Use this API to remove a user from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in an account.\n\n**Prerequisites:** \n* A Pro, Business, or Education account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: updateAGroupMember",
|
|
"api_call": "PATCH /groups/{groupId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's unique ID. To get this value, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group.",
|
|
"memberId": "[REQUIRED] string: The group member's unique ID. To get this value, use the [**List group members**](/docs/api-reference/zoom-api/methods#operation/groupMembers) API."
|
|
},
|
|
"functionality": "Use this API to perform either of the following tasks: \n* Remove a group member from one group and move them to a different group. \n* Set a user's primary group. By default, the primary group is the first group that user is added to.\n\nIf a user is a member of multiple groups, you can [assign the user a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09). The user will use the primary group's settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user.\n\n**Prerequisites:** \n* A Pro or higher account\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: getGroupSettings",
|
|
"api_call": "GET /groups/{groupId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string",
|
|
"option": "string: Optional query parameters. \n* `meeting_authentication` - View the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` - View the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `meeting_security` - View the meeting security settings applied to the user's account.",
|
|
"custom_query_fields": "string: Provide the name of the field to use to filter the response. For example, if you provide `host_video` as the value of this field, you will get a response similar to this: \n\n{\n `schedule_meeting`: {\n `host_video`: false\n }\n} \n\nProvide multiple values by separating them with commas, such as `host_video,participant_video`."
|
|
},
|
|
"functionality": "Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account.\n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: updateGroupSettings",
|
|
"api_call": "PATCH /groups/{groupId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group's ID.",
|
|
"option": "string: Optional query parameters. \n* `meeting_authentication` - [Meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars). \n* `recording_authentication` - [Recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings). \n* `meeting_security` - Meeting security settings."
|
|
},
|
|
"functionality": "Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n **Note:**The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupSettingsRegistration",
|
|
"api_call": "GET /groups/{groupId}/settings/registration",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string",
|
|
"type": "string: The registration type: \n* `webinar` — webinar."
|
|
},
|
|
"functionality": "Get webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: groupSettingsRegistrationUpdate",
|
|
"api_call": "PATCH /groups/{groupId}/settings/registration",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string",
|
|
"type": "string: The registration type: \n* `webinar` — webinar."
|
|
},
|
|
"functionality": "Update webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style="background-color:#FEEFB3; color:#9F6000"> \n Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n**Prerequisite**: Pro, Business, or Education account \n \n\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: uploadGroupVB",
|
|
"api_call": "POST /groups/{groupId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. To get a group's ID, use the [**List groups**](/api-reference/zoom-api/methods#operation/groups) API."
|
|
},
|
|
"functionality": "Use this API to [upload Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users in a group to use. \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Groups: delGroupVB",
|
|
"api_call": "DELETE /groups/{groupId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. To get a group's ID, use the [**List groups**](/api-reference/zoom-api/methods#operation/groups) API.",
|
|
"file_ids": "string: A comma-separated list of the file IDs to delete."
|
|
},
|
|
"functionality": "Use this API to delete a group's [Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE). \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `group:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: users",
|
|
"api_call": "GET /users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"status": "string: The user's status. \n* `active` - The user exists on the account. \n* `inactive` - The user has been deactivated. \n* `pending` - The user exists on the account, but has not activated their account. See [Managing users](https://support.zoom.us/hc/en-us/articles/201363183) for details.\n\nThis value defaults to `active`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"role_id": "string: The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [**List roles**](/api-reference/zoom-api/methods#operation/roles) API to get a role's unique ID value.",
|
|
"page_number": "string: The page number of the current page in the returned records.",
|
|
"include_fields": "string: Use this parameter to display one of the following attributes in the API call's response: \n* `custom_attributes` — Return the user's custom attributes. \n* `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key).",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"license": "string: The user's license. Filter the response by a specific license."
|
|
},
|
|
"functionality": "Retrieve a list your account's users. \n\n\n\n**Scopes:** `user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userCreate",
|
|
"api_call": "POST /users",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Add a new user to your Zoom account. \n\n**Note** These rate limits apply when you use the `create` value for the `action` field: \n* 50 requests per day for **Free** accounts. \n* 1,500 requests per day for **Pro** accounts. \n* 10,000 requests per day for **Business+** accounts. \n\n**Prerequisites:** \n* A Pro or higher plan.\n\n**Scopes:** `user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userEmail",
|
|
"api_call": "GET /users/email",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] string: The email address to be verified."
|
|
},
|
|
"functionality": "Verify if a user's email is registered with Zoom. \n \n \n\n<b>Note: </b>You can successfully check if a user is a registered Zoom user only if the user **signed up for Zoom via email and is within your account.** If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as "Sign in with SSO", "Sign in with Google" or "Sign in with Facebook" even if they are in the same account as yours.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: bulkUpdateFeature",
|
|
"api_call": "POST /users/features",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Bulk update features. \n\n\n\n**Scopes:** `user:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userZak",
|
|
"api_call": "GET /users/me/zak",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Get the Zoom Access Key (ZAK) for the authenticated user associated with the access token in the API request. Use a ZAK to start or join a meeting on behalf of this user.\n\nZAKs obtained with this endpoint expire five minutes after receipt.\n\nTo get a ZAK for a different user or with a different expiration, use the [Get a user token](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/userToken) API with the `zak` `type` query parameter.\n\nSee [Getting a Zoom Access Key (ZAK)](https://developers.zoom.us/docs/meeting-sdk/auth/#start-meetings-and-webinars-with-a-zoom-users-zak-token) for details.\n\n\n\n**Scopes:** `user_zak:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSummary",
|
|
"api_call": "GET /users/summary",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to get a summary of users, including the number and types of users in the account.\n\n \n\n**Scopes:** `user:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userVanityName",
|
|
"api_call": "GET /users/vanity_name",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"vanity_name": "[REQUIRED] string: Personal meeting room name."
|
|
},
|
|
"functionality": "A personal meeting room is a virtual meeting room that can be permanently assigned to a user.\nUse this API to check if a personal meeting room with the given name exists or not. \n \n \n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: user",
|
|
"api_call": "GET /users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"login_type": "integer: The user's login method. \n* `0` - Facebook OAuth \n* `1` - Google OAuth. \n* `24` - Apple OAuth. \n* `27` - Microsoft OAuth. \n* `97` - Mobile device. \n* `98` - RingCentral OAuth. \n* `99` - API user. \n* `100` - Zoom Work email. \n* `101` - Single Sign-On (SSO). \n\nThese login methods are only available in China. \n* `11` - Phone number. \n* `21` - WeChat. \n* `23` - Alipay.",
|
|
"encrypted_email": "boolean: Whether the email address passed for the `userId` value is an encrypted email address. \n\n * `true` - The email address is encrypted. \n * `false` - The email address is not encrypted. \n\n If you do not query this parameter, this value defaults to null (`false`).",
|
|
"search_by_unique_id": "boolean: Whether the queried `userId` value is an employee unique ID. \n* `true` - The queried ID is an employee's unique ID. \n* `false` - The queried ID is not an employee's unique ID. \n\nThis value defaults to `false` (null)."
|
|
},
|
|
"functionality": "View a user's information on a Zoom account. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. \n\n**Note** Users who have not activated their account will have a `pending` status. These users' `created_at` timestamp will also display the time at which the API call was made, **not** the account's creation date. \n\n**Note:** The `user_info:read` scope is only available when you pass the `me` value for the `$userId` value. \n\n**Scopes:** `user:read:admin`,`user:read`,`user_info:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userDelete",
|
|
"api_call": "DELETE /users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"encrypted_email": "boolean: Whether the email address passed for the `userId` value is an encrypted email address. \n\n * `true` - The email address is encrypted. \n * `false` - The email address is not encrypted. \n\n If you do not query this parameter, this value defaults to null (`false`).",
|
|
"action": "string: Delete action options. \n `disassociate` - Disassociate a user. \n `delete`- Permanently delete a user. \n Note: To delete pending user in the account, use `disassociate`",
|
|
"transfer_email": "string: Transfer email. This field is **required** if the user has Zoom Events/Sessions feature. After you delete or disassociate the user, the user's hub assets on Zoom Events site will be transferred to the target user.",
|
|
"transfer_meeting": "boolean: Transfer meeting.",
|
|
"transfer_webinar": "boolean: Transfer webinar.",
|
|
"transfer_recording": "boolean: Transfer recording.",
|
|
"transfer_whiteboard": "boolean: When deleting a user, whether to transfer all their [Zoom Whiteboard](https://support.zoom.us/hc/en-us/articles/4410916881421) data to another user."
|
|
},
|
|
"functionality": "**Disassociate** (unlink) a user or permanently **delete** a user. \n\n**Disassociating** a user unlinks the user from the associated Zoom account and provides the user their own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An account owner or account admin can transfer the user's meetings, webinars, and cloud recordings to another user before disassociation.\n\n\n**Deleting** a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars, and cloud recordings to another Zoom user account before deleting.\n\n\nFor user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n**Note:** This API does not support the deletion requirements of a [Data Subject Access Request (DSAR)](https://dataprivacymanager.net/what-is-data-subject-access-request-dsar/). For a DSAR request, contact Zoom Support. \n\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userUpdate",
|
|
"api_call": "PATCH /users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"login_type": "integer: The user's login method. \n* `0` - Facebook OAuth. \n* `1` - Google OAuth. \n* `24` - Apple OAuth. \n* `27` - Microsoft OAuth. \n* `97` - Mobile device. \n* `98` - RingCentral OAuth. \n* `99` - API user. \n* `100` - Zoom Work email. \n* `101` - Single Sign-On (SSO). \n\nThese login methods are only available in China. \n* `11` - Phone number. \n* `21` - WeChat. \n* `23` - Alipay.",
|
|
"remove_tsp_credentials": "boolean: Whether to remove the user's TSP credentials. \n* `true` - The queried ID is an employee's unique ID. \n* `false` - The queried ID is not an employee's unique ID. \n\n This value defaults to `false` (null)."
|
|
},
|
|
"functionality": "Update a user's [Zoom profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile) information. For user-level apps, pass [the `me` value](hhttps://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userAssistants",
|
|
"api_call": "GET /users/{userId}/assistants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "List a user's assistants. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAssistants are users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meetings on behalf of the current user, as well as manage and act as an alternative host for all meetings if the admin has enabled the [co-host option](https://zoom.us/account/setting) on the account.\n\n**Prerequisites:** \n* Current user as well as the assistant must have Licensed or an On-prem license.\n* Assistants must be under the current user's account.\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userAssistantCreate",
|
|
"api_call": "POST /users/{userId}/assistants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Assign assistants to a user. In the request body, provide either the user's ID or the user's email address. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAssistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). Assistants can schedule meetings on behalf of the current user, and can also manage and act as an alternative host for all meetings if the admin has enabled the [co-host option](https://zoom.us/account/setting) on the account.\n\n**Prerequisites:** \n* The user as well as the assistant must have Licensed or an On-prem license.\n* Assistants must be under the current user's account, or the assistants' account must be in the same organization as the current user's account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userAssistantsDelete",
|
|
"api_call": "DELETE /users/{userId}/assistants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Delete all of the current user's assistants. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAssistants are the users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user, and manage and act as an alternative host for all meetings if the admin has enabled [co-host option](https://zoom.us/account/setting) on the account.\n\n**Prerequisites:** \n* The user as well as the assistant must have Licensed or an On-prem license.\n* Assistants must be under the current user's account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userAssistantDelete",
|
|
"api_call": "DELETE /users/{userId}/assistants/{assistantId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"assistantId": "[REQUIRED] string: Assistant ID."
|
|
},
|
|
"functionality": "Delete a specific assistant of a user. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAssistants are the users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [co-host option](https://zoom.us/account/setting) on the account.\n\n**Prerequisites:** \n* The user as well as the assistant must have Licensed or an On-prem license.\n* Assistants must be under the current user's account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: listCollaborationDevices",
|
|
"api_call": "GET /users/{userId}/collaboration_devices",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "List a user's collaboration devices. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: getCollaborationDevice",
|
|
"api_call": "GET /users/{userId}/collaboration_devices/{collaborationDeviceId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"collaborationDeviceId": "[REQUIRED] string: The collaboration device ID."
|
|
},
|
|
"functionality": "Get collaboration device detail. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userEmailUpdate",
|
|
"api_call": "PUT /users/{userId}/email",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The users's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Change a user's [email address](https://support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n* If the Zoom account in which the user belongs has multiple [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), then the email to be updated **must** match one of the managed domains.\n* A user's email address can be changed up to 3 times in any 24 hour period.\n\n**Prerequisites:** \n* Managed domain must be enabled in the account. \n* The new email address should not already exist in Zoom.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: getUserMeetingTemplates",
|
|
"api_call": "GET /users/{userId}/meeting_templates/{meetingTemplateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"meetingTemplateId": "[REQUIRED] string: The meeting template ID."
|
|
},
|
|
"functionality": "Retrieve a user's [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userPassword",
|
|
"api_call": "PUT /users/{userId}/password",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Update the [password](https://support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAfter this request is processed successfully, an email notification is sent to the user saying that the password was changed. \n \n**Prerequisites:** \n \n* Owner or admin of the Zoom account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userPermission",
|
|
"api_call": "GET /users/{userId}/permissions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Get permissions that have been granted to the user. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nUsers can be assigned a set of permissions that allows them to access only the pages or information that a user needs to view or edit.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userPicture",
|
|
"api_call": "POST /users/{userId}/picture",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Upload a user's profile picture. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nProvide `multipart/form-data` as the value of the `content-type` header for this request. This API supports `.jpeg` and `.png` file formats.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userPictureDelete",
|
|
"api_call": "DELETE /users/{userId}/picture",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Delete a user's profile picture. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. \n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: updatePresenceStatus",
|
|
"api_call": "PUT /users/{userId}/presence_status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Update a user's presence status. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nA user's status **cannot** be updated more than once per minute. For example, you can only submit a maximum of one update request per minute for a single user.\n\nUsers in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status informs users of their contact's availability. Users can also change their own presence status to one the following:\n* **Away**\n* **Do not disturb**\n* **Available**\n* **In a calendar event**\n* **Presenting**\n* **In a Zoom meeting**\n* **On a call**\n* **Out of Office**\n* **Busy**\n\nNote that a user's presence status **cannot** be updated via this API if the user is not logged in to the Zoom client.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSchedulers",
|
|
"api_call": "GET /users/{userId}/schedulers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "List all of a user's schedulers. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nSchedulers in this context are users who can schedule meetings for the current user. For example, if the current user, the user whose `userId` was passed in the `path` parameter, is **User A**, this API's response will list all users for whom **User A** can schedule and manage meetings. **User A** is the assistant of these users, and thus has scheduling privilege for these users.\n\n**Prerequisites** \n* Current user must be under the same account as the scheduler.\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSchedulersDelete",
|
|
"api_call": "DELETE /users/{userId}/schedulers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Delete all of a user's schedulers. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nSchedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. \n\n**Prerequisites:** \n* Current user (assistant) must be under the same account as the scheduler.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSchedulerDelete",
|
|
"api_call": "DELETE /users/{userId}/schedulers/{schedulerId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"schedulerId": "[REQUIRED] string: Scheduler's ID."
|
|
},
|
|
"functionality": "Delete a scheduler. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nSchedulers are users who the current user (assistant) can schedule meetings on their behalf. By calling this API, the current user will no longer be a scheduling assistant of this scheduler.\n\n**Prerequisites:** \n* Current user must be under the same account as the scheduler.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSettings",
|
|
"api_call": "GET /users/{userId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass the `me` value.",
|
|
"login_type": "integer: The user's login method. \n* `0` - Facebook OAuth \n* `1` - Google OAuth \n* `24` - Apple OAuth \n* `27` - Microsoft OAuth \n* `97` - Mobile device \n* `98` - RingCentral OAuth \n* `99` - API user \n* `100` - Zoom Work email \n* `101` - Single Sign-On (SSO) \n\nThese login methods are only available in China: \n* `11` - Phone number \n* `21` - WeChat \n* `23` - Alipay",
|
|
"option": "string: Optional query parameters. \n* `meeting_authentication` - Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` - Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `meeting_security` - Use this query parameter to view the meeting security settings applied to the user's account.",
|
|
"custom_query_fields": "string: Provide the name of the field to filter the response. For example, if you provide `host_video` as the value of this field, you'll get a response similar to this. \n \n{\n schedule_meeting: {\n host_video: false\n }\n}\n \n To provide multiple values, separate them with commas, like `host_video,participant_video`."
|
|
},
|
|
"functionality": "Retrieve a user's settings. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSettingsUpdate",
|
|
"api_call": "PATCH /users/{userId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"option": "string: Optional query parameters: \n* `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account."
|
|
},
|
|
"functionality": "Update a user's settings. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: uploadVBuser",
|
|
"api_call": "POST /users/{userId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID. To get a user's ID, use the [**List users**](/api-reference/zoom-api/ma#operation/users) API. For user-level apps, pass the `me` value instead of the user ID value."
|
|
},
|
|
"functionality": "Use this API to [upload a Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) to a user's profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n **Note:** \n* A user profile cannot exceed more than 10 Virtual Background files. \n* You can only upload image files that are in JPG/JPEG, GIF or PNG format. \n* Video files must be in MP4 or MOV file format with a minimum resolution of 480 by 360 pixels (360p) and a maximum resolution of 1920 by 1080 pixels (1080p). \n* The Virtual Background file size cannot exceed 15 megabytes (MB). \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: delUserVB",
|
|
"api_call": "DELETE /users/{userId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's ID. To get a user's ID, use the [**List users**](/docs/api-reference/zoom-api/ma#operation/users) API. For user-level apps, pass the `me` value instead of the user ID value.",
|
|
"file_ids": "string: A comma-separated list of the Virtual Background file IDs to delete."
|
|
},
|
|
"functionality": "Use this API to delete a user's Virtual Background files. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userStatus",
|
|
"api_call": "PUT /users/{userId}/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "[Deactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAn account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user removes all licenses associated with a user, and prevents the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to log in to their Zoom account.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userToken",
|
|
"api_call": "GET /users/{userId}/token",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value.",
|
|
"type": "string: The user token type. \n* `zak` - A Zoom Access Key (ZAK) is used to generate a URL to start meetings. See [Getting a Zoom Access Key (ZAK)](https://developers.zoom.us/docs/meeting-sdk/auth/#start-meetings-and-webinars-with-a-zoom-users-zak-token) for details. The ZAK's expiration time is two hours. For API users, the expiration time is 90 days. An API user is a user created via the `custCreate` action in the **[Create users](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/userCreate)** API. The maximum length of this value is `512`. \n* `token` - **Deprecated** A Zoom token. This token expires in 14 days. You must make the request again after expiration to receive a new token. This query parameter returns a null value if the user signed in to Zoom via Google or Facebook. The maximum length of this value is `512`. \n\n This value defaults to `token`.",
|
|
"ttl": "integer: The ZAK expiration time to live (TTL), in seconds. To update the user's ZAK TTL, use this field with the `zak` value for the `type` query parameter. \n\nDefaults to `7200` or `7776000` (90 days) for API users. The maximum value is one year."
|
|
},
|
|
"functionality": "Get a user's Zoom token or Zoom Access Key (ZAK). For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. \n\n \n\n**Scopes:** `user:read:admin`,`user:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom User API - Users: userSSOTokenDelete",
|
|
"api_call": "DELETE /users/{userId}/token",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user's user ID or email address. For user-level apps, pass the `me` value."
|
|
},
|
|
"functionality": "Revoke a user's SSO token. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.\n\nAfter calling this API, the SSO user will be logged out of their current Zoom session.\n\n\n\n**Scopes:** `user:write:admin`,`user:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Accounts: listZoomPhoneAccountSettings",
|
|
"api_call": "GET /phone/account_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"setting_types": "string: The comma separated list of the setting items you want to fetch. Allowed values: `call_live_transcription`,`local_survivability_mode`,`external_calling_on_zoom_room_common_area`, `select_outbound_caller_id`, `personal_audio_library`, `voicemail`, `voicemail_transcription`, `voicemail_notification_by_email`, `shared_voicemail_notification_by_email`, `restricted_call_hours`, `allowed_call_locations`, `check_voicemails_over_phone`, `auto_call_recording`, `ad_hoc_call_recording`, `international_calling`, `outbound_calling`, `outbound_sms`, `sms`, `sms_etiquette_tool`, `zoom_phone_on_mobile`, `zoom_phone_on_pwa`, `e2e_encryption`, `call_handling_forwarding_to_other_users`, `call_overflow`, `call_transferring`, `elevate_to_meeting`, `call_park`, `hand_off_to_room`, `mobile_switch_to_carrier`, `delegation`, `audio_intercom`, `block_calls_without_caller_id`, `block_external_calls`,`call_queue_opt_out_reason`,`auto_delete_data_after_retention_duration`,`auto_call_from_third_party_apps`, `override_default_port`,`peer_to_peer_media`,`advanced_encryption`,`display_call_feedback_survey`,`block_list_for_inbound_calls_and_messaging`,`block_calls_as_threat`."
|
|
},
|
|
"functionality": "Returns an account's Zoom phone settings.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Accounts: listCustomizeOutboundCallerNumbers",
|
|
"api_call": "GET /phone/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"selected": "boolean: The status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list",
|
|
"site_id": "string: This field filters phone numbers that belong to the site.",
|
|
"extension_type": "string: The type of extension to which the phone number belongs.",
|
|
"keyword": "string: A search keyword for phone or extension numbers.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves phone numbers that can be used as the `account-level` customized outbound caller ID. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Accounts: addOutboundCallerNumbers",
|
|
"api_call": "POST /phone/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Accounts: deleteOutboundCallerNumbers",
|
|
"api_call": "DELETE /phone/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"customize_ids": "array: The customization IDs."
|
|
},
|
|
"functionality": "Deletes the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Alerts: ListAlertSettingsWithPagingQuery",
|
|
"api_call": "GET /phone/alert_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records a single API call returns.",
|
|
"next_page_token": "string: The current page number of the returned records.",
|
|
"module": "integer: This field filters the specific alert list by the module. The module and its code mappings are shown as: \n \n`Call Queue Management`-`1`, `Route Group Management`-`2`, `Devices & Phones Management`-`3`, `Call Quality Management`-`4`, `Emergency Services Management`-`5`",
|
|
"rule": "integer: This field filters the specific alert list by the rule. The rule and its code mappings display as: \n \n`Service Level`-`1`, `Inbound Abandoned Calls`-`2`, `Inbound Overflowed Calls`-`3`, `Inbound Avg Call Waiting Time`-`4`, `Inbound Forwarded to Voicemail`-`5`, `Number of Waiting Calls`-`6`, `Member Availability (Active)`-`7`, `Member Availability (Opt-in/Opt-out)`-`8`, `Route groups status change`-`9`, `Devices go offline`-`10`, `Devices go online`-`11`, `Device offline rate`-`12`, `QoS Alert`-`13`, `Emergency Call Alert`-`14`. \n \nWhen the value of the `module` is `1`, the value of `rule` can only be in the range of `1` to `8`. \n \nWhen the value of the `module` is `2`, the value of `rule` can only be `9`. \n \nWhen the value of the `module` is `3`, the value of `rule` can only be in the range of `10` to `12`. \n \nWhen the value of the `module` is `4`, the value of `rule` can only be `13`. \n \nWhen the value of the `module` is `5`, the value of `rule` can only be `14`.",
|
|
"status": "integer: The alert's status:\n* `0` — Inactive.\n* `1` — Active."
|
|
},
|
|
"functionality": "Gets [alert settings](https://support.zoom.us/hc/en-us/articles/7146944434445) for an account with paging query.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Alerts: AddAnAlertSetting",
|
|
"api_call": "POST /phone/alert_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "[Adds an alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Alerts: GetAlertSettingDetails",
|
|
"api_call": "GET /phone/alert_settings/{alertSettingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"alertSettingId": "string"
|
|
},
|
|
"functionality": "Gets detailed information about a specific [Alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Alerts: DeleteAnAlertSetting",
|
|
"api_call": "DELETE /phone/alert_settings/{alertSettingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"alertSettingId": "[REQUIRED] string: The alert setting ID."
|
|
},
|
|
"functionality": "Deletes an [alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Alerts: UpdateAnAlertSetting",
|
|
"api_call": "PATCH /phone/alert_settings/{alertSettingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"alertSettingId": "[REQUIRED] string: The alert setting ID."
|
|
},
|
|
"functionality": "Updates information of an [Alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: GetAudioItem",
|
|
"api_call": "GET /phone/audios/{audioId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"audioId": "[REQUIRED] string: The unique identifier of the audio item."
|
|
},
|
|
"functionality": "Returns an audio item. Only the admin or user can access your audio.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read`,`phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: DeleteAudioItem",
|
|
"api_call": "DELETE /phone/audios/{audioId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"audioId": "[REQUIRED] string: Unique identifier of the audio item."
|
|
},
|
|
"functionality": "Deletes an audio item. Only the admin or user can delete your audio.\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: UpdateAudioItem",
|
|
"api_call": "PATCH /phone/audios/{audioId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"audioId": "[REQUIRED] string: Unique identifier of the audio item."
|
|
},
|
|
"functionality": "Updates an audio item. Only the admin or user can update your audio.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: ListAudioItems",
|
|
"api_call": "GET /phone/users/{userId}/audios",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Returns personal audios. Only the admin or user can query your audios and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read`,`phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: AddAnAudio",
|
|
"api_call": "POST /phone/users/{userId}/audios",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Adds an audio item for [text-to-speech conversion](https://support.zoom.us/hc/en-us/articles/4402414203533-Using-the-audio-library-to-customize-audio#h_01F8B0D2ZJBKEDH10DFZ7J2CM7). Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Audio Library: AddAudioItem",
|
|
"api_call": "POST /phone/users/{userId}/audios/batch",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Adds the audio items. You can only upload voice files at this time. Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n**Size and quantity limits for audio attachments:**\n* Up to 5 attachments\n* Each file size should be no more than 1MB\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: listAutoReceptionists",
|
|
"api_call": "GET /phone/auto_receptionists",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The total number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to list auto receptionists.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: addAutoReceptionist",
|
|
"api_call": "POST /phone/auto_receptionists",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system. Use this API to add an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone\n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: getAutoReceptionistDetail",
|
|
"api_call": "GET /phone/auto_receptionists/{autoReceptionistId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to get information on a specific auto receptionist.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: deleteAutoReceptionist",
|
|
"api_call": "DELETE /phone/auto_receptionists/{autoReceptionistId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
|
|
},
|
|
"functionality": "An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area (phone), or to a voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.\nUse this API to [delete a non-primary auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3).\n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: updateAutoReceptionist",
|
|
"api_call": "PATCH /phone/auto_receptionists/{autoReceptionistId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
|
|
},
|
|
"functionality": "An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.\nUse this API to [change information](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3) such as the display name and extension number assigned to the main auto receptionist.\n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: assignPhoneNumbersAutoReceptionist",
|
|
"api_call": "POST /phone/auto_receptionists/{autoReceptionistId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
|
|
},
|
|
"functionality": "Assign available phone numbers to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). The available numbers can be retrieved using the List Phone Numbers API with `type` query parameter set to "unassigned".\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: unassignAllPhoneNumsAutoReceptionist",
|
|
"api_call": "DELETE /phone/auto_receptionists/{autoReceptionistId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Unassign all phone numbers that were previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: unassignAPhoneNumAutoReceptionist",
|
|
"api_call": "DELETE /phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).",
|
|
"phoneNumberId": "[REQUIRED] string: Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123)."
|
|
},
|
|
"functionality": "Unassign a specific phone number that was previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: getAutoReceptionistsPolicy",
|
|
"api_call": "GET /phone/auto_receptionists/{autoReceptionistId}/policies",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
|
|
},
|
|
"functionality": "Use this API to get the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: updateAutoReceptionistPolicy",
|
|
"api_call": "PATCH /phone/auto_receptionists/{autoReceptionistId}/policies",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
|
|
},
|
|
"functionality": "Use this API to update the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: AddPolicy",
|
|
"api_call": "POST /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).",
|
|
"policyType": "[REQUIRED] string: Corresponds to the policy item you wish to add. Allowed values: `voice_mail`"
|
|
},
|
|
"functionality": "Use this API to add a policy sub-setting according to the policy type for a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). For example, you can set up shared access members.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: DeletePolicy",
|
|
"api_call": "DELETE /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).",
|
|
"policyType": "[REQUIRED] string: Corresponds to the policy item you wish to remove. Allowed values: `voice_mail`",
|
|
"shared_ids": "[REQUIRED] array: Unique identifier of the voicemail that the user can access. Required only for `voice_mail` policy type."
|
|
},
|
|
"functionality": "Use this API to remove the policy sub-setting of a [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). For example, you can remove shared access members.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Auto Receptionists: updatePolicy",
|
|
"api_call": "PATCH /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists).",
|
|
"policyType": "[REQUIRED] string: Corresponds to the policy item you wish to modify. Allowed values: `voice_mail`"
|
|
},
|
|
"functionality": "Use this API to update the policy sub-setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the policy type. For example, you can update shared access members.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Billing Account: listBillingAccount",
|
|
"api_call": "GET /phone/billing_accounts",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "A Zoom account owner or a user with admin privileges can use this API to retrieve a list of billing accounts.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Billing Account: GetABillingAccount",
|
|
"api_call": "GET /phone/billing_accounts/{billingAccountId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"billingAccountId": "[REQUIRED] string: The billing account ID."
|
|
},
|
|
"functionality": "A Zoom account owner or a user with admin privilege can use this API to get information about a billing account.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Blocked List: listBlockedList",
|
|
"api_call": "GET /phone/blocked_list",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The total number of records returned from a single API call."
|
|
},
|
|
"functionality": "A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. \nUse this API to list all the blocked lists in an acccount.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Blocked List: addAnumberToBlockedList",
|
|
"api_call": "POST /phone/blocked_list",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "A Zoom account owner or a user with the admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. Use this API to create a block list and add a number to the list.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Blocked List: getABlockedList",
|
|
"api_call": "GET /phone/blocked_list/{accountBlockedId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blockedListId": "[REQUIRED] string: Unique identifier of the blocked list."
|
|
},
|
|
"functionality": "A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\nUse this API to get information about a specific blocked list.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Blocked List: deleteABlockedList",
|
|
"api_call": "DELETE /phone/blocked_list/{accountBlockedId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blockedListId": "[REQUIRED] string: Unique identifier of the blocked list. This can be retrieved from the List Blocked List API."
|
|
},
|
|
"functionality": "A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).\n\nUse this API to delete a blocked list and therefore removing the associated number from the blocked list. The number will be unblocked after the deletion.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Blocked List: updateBlockedList",
|
|
"api_call": "PATCH /phone/blocked_list/{accountBlockedId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blockedListId": "[REQUIRED] string: Unique identifier of the blocked list."
|
|
},
|
|
"functionality": "A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\nUse this API to update the information on the blocked list.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Handling: getCallHandling",
|
|
"api_call": "GET /phone/extension/{extensionId}/call_handling/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID."
|
|
},
|
|
"functionality": "Gets information about a Zoom Phone's call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, or auto receptionist call handling at this time.** \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone enabled\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Handling: addCallHandling",
|
|
"api_call": "POST /phone/extension/{extensionId}/call_handling/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID.",
|
|
"settingType": "[REQUIRED] string: The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
|
|
},
|
|
"functionality": "Adds Zoom Phone call handling subsettings for your phone system. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, or auto receptionist call handling at this time.** \n\n**Prerequisites:** \n* A Pro or a higher account with Zoom Phone enabled\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Handling: deleteCallHandling",
|
|
"api_call": "DELETE /phone/extension/{extensionId}/call_handling/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID.",
|
|
"settingType": "[REQUIRED] string: The type of call handling setting: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`",
|
|
"call_forwarding_id": "string: The call forwarding's ID. Use this parameter if you pass the `call_forwarding_id` value for the `settingType` parameter.",
|
|
"holiday_id": "string: The holiday's ID. Use this parameter if you pass the `holiday_id` value for the `settingType` parameter."
|
|
},
|
|
"functionality": "Deletes a Zoom Phone's call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, or auto receptionist call handling at this time.** \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone enabled\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Handling: updateCallHandling",
|
|
"api_call": "PATCH /phone/extension/{extensionId}/call_handling/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID.",
|
|
"settingType": "[REQUIRED] string: The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
|
|
},
|
|
"functionality": "Updates a Zoom Phone's call handling setting. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, or auto receptionist call handling at this time.** \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone enabled\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: accountCallHistory",
|
|
"api_call": "GET /phone/call_history",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"keyword": "string: The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword.",
|
|
"directions": "array: The direction filter of the call logs.",
|
|
"connect_types": "array: The connect type filter of the call logs. \n* `internal` \n* `external` ",
|
|
"call_types": "array: The call type filter of the call logs. \n* `general` \n* `emergency`",
|
|
"extension_types": "array: The extension type filter of the call logs.",
|
|
"call_results": "array: The call result filter of the call logs.",
|
|
"group_ids": "array: The primary group filter of call logs.",
|
|
"site_ids": "array: The site filter of call logs.",
|
|
"department": "string: The department of which the call log belongs.",
|
|
"cost_center": "string: The cost center of which the call log belongs."
|
|
},
|
|
"functionality": "Returns an account's new edition [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n**Scopes:** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: getCallPath",
|
|
"api_call": "GET /phone/call_history/{callLogId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callLogId": "[REQUIRED] string: The ID of the call log."
|
|
},
|
|
"functionality": "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: accountCallLogs",
|
|
"api_call": "GET /phone/call_logs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"type": "string: The type of the call logs. The value can be either "all" or "missed".",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"path": "string: Filter the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`,\n`pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`,\n`parkTimeout`, `monitor`, `takeover`, `sipGroup`",
|
|
"time_type": "string: Enables you to search call logs by start or end time. Choose `startTime` or `endTime`.",
|
|
"site_id": "string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.",
|
|
"charged_call_logs": "boolean: Whether to filter API responses to include call logs that only have a non-zero charge."
|
|
},
|
|
"functionality": "Returns an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n\n\n**Scopes:** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: getCallLogDetails",
|
|
"api_call": "GET /phone/call_logs/{callLogId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callLogId": "[REQUIRED] string: Unique identifier of the call log. Both `callLogId` and `callId` can be used as path parameters. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or the [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)."
|
|
},
|
|
"functionality": "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: addClientCodeToCallLog",
|
|
"api_call": "PUT /phone/call_logs/{callLogId}/client_code",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callLogId": "[REQUIRED] string: Unique identifier of the call log."
|
|
},
|
|
"functionality": "Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: phoneUserCallLogs",
|
|
"api_call": "GET /phone/users/{userId}/call_logs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"type": "string",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"phone_number": "string: Filter API responses to include call logs of only the phone number defined in this field.",
|
|
"time_type": "string: Enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`."
|
|
},
|
|
"functionality": "Gets a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`,`phone_call_log:read:admin`,`phone:read`,`phone_call_log:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: syncUserCallLogs",
|
|
"api_call": "GET /phone/users/{userId}/call_logs/sync",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: User ID.",
|
|
"sync_type": "string: Options for synchronizing call log: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync",
|
|
"count": "integer: The number of records returned within a single API call.",
|
|
"sync_token": "string: The time range for returned records. Used for locating where the next retrieval will begin."
|
|
},
|
|
"functionality": "Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Logs: deleteCallLog",
|
|
"api_call": "DELETE /phone/users/{userId}/call_logs/{callLogId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user.",
|
|
"callLogId": "[REQUIRED] string: Unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)."
|
|
},
|
|
"functionality": "Deletes a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n\n\n**Scopes:** `phone:write`,`phone:write:admin`,`phone_call_log:write`,`phone_call_log:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: listCallQueues",
|
|
"api_call": "GET /phone/call_queues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned from a single API call.",
|
|
"site_id": "string: Unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.",
|
|
"cost_center": "string: The call queue's cost center.",
|
|
"department": "string: The call queue's department."
|
|
},
|
|
"functionality": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to list Call queues.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: createCallQueue",
|
|
"api_call": "POST /phone/call_queues",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "[Creates a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413). Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on.\n You can add phone users or common areas to call queues.\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: getACallQueue",
|
|
"api_call": "GET /phone/call_queues/{callQueueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue. This can be retrieved from [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues)."
|
|
},
|
|
"functionality": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to get information on a specific Call Queue.\n\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: deleteACallQueue",
|
|
"api_call": "DELETE /phone/call_queues/{callQueueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the call queue."
|
|
},
|
|
"functionality": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to delete a Call Queue.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: updateCallQueue",
|
|
"api_call": "PATCH /phone/call_queues/{callQueueId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue."
|
|
},
|
|
"functionality": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to update information of a specific Call Queue.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: listCallQueueMembers",
|
|
"api_call": "GET /phone/call_queues/{callQueueId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: The call queue ID that is retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API."
|
|
},
|
|
"functionality": "Lists the call queue members.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: addMembersToCallQueue",
|
|
"api_call": "POST /phone/call_queues/{callQueueId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue."
|
|
},
|
|
"functionality": "Add phone users and/or [common areas](https://support.zoom.us/hc/articles/4481136653709) as members to a specific call queue.\n\n**Prerequisites:**\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: unassignAllMembers",
|
|
"api_call": "DELETE /phone/call_queues/{callQueueId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Removes all members from a call queue who were previously assigned to that call queue. The members could be phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709).\n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: unassignMemberFromCallQueue",
|
|
"api_call": "DELETE /phone/call_queues/{callQueueId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue from which the member needs to be unassigned.",
|
|
"memberId": "[REQUIRED] string: Unique identifier of the member who needs to be unassigned."
|
|
},
|
|
"functionality": "Removes a member who was previously added to a call queue. The member could be a phone user or common area. Note that you cannot use this API to unassign a call queue manager. \n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: addCQPolicySubSetting",
|
|
"api_call": "POST /phone/call_queues/{callQueueId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: The call queue ID, retrievable the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API.",
|
|
"policyType": "[REQUIRED] string: The policy sub-setting item that you wish to add. Allowed values: `voice_mail`."
|
|
},
|
|
"functionality": "Use this API to add the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to set up shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: removeCQPolicySubSetting",
|
|
"api_call": "DELETE /phone/call_queues/{callQueueId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: The call queue ID, retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API.",
|
|
"policyType": "[REQUIRED] string: Corresponds to tbe policy sub-setting item you wish to remove. Allowed values: `voice_mail`",
|
|
"shared_ids": "[REQUIRED] array: Comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting."
|
|
},
|
|
"functionality": "Use this API to remove the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to remove shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: updateCQPolicySubSetting",
|
|
"api_call": "PATCH /phone/call_queues/{callQueueId}/policies/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: The call queue ID, retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API.",
|
|
"policyType": "[REQUIRED] string: Corresponds to the policy sub-setting item you wish to update. Allowed values: `voice_mail`."
|
|
},
|
|
"functionality": "Use this API to update the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to update shared access members.\n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: getCallQueueRecordings",
|
|
"api_call": "GET /phone/call_queues/{callQueueId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
|
|
},
|
|
"functionality": "Use this API to view [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091#h_cbc9f2a3-e06c-4daa-83d4-ddbceef9c77b) from the call queue.\n\n\n**Prerequisites:**\n\n* Pro or higher account with Zoom Phone license.\n* [Automatic call recordings](https://support.zoom.us/hc/en-us/articles/360033511872#h_fcb297bb-14e8-4094-91ca-dc61e1a18734) must be enabled in the Policy Settings for call queues. \n \n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: assignPhoneToCallQueue",
|
|
"api_call": "POST /phone/call_queues/{groupId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue."
|
|
},
|
|
"functionality": "After [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it, allowing callers to directly dial a number to reach a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).\n\n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: unassignAPhoneNumCallQueue",
|
|
"api_call": "DELETE /phone/call_queues/{groupId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue. This can be retrieved from List Call Queues API."
|
|
},
|
|
"functionality": "Use this API to unbind all phone numbers that are assigned to a [Call Queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues) After successful unbinding, the numbers will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. \n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n \n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Call Queues: unAssignPhoneNumCallQueue",
|
|
"api_call": "DELETE /phone/call_queues/{groupId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callQueueId": "[REQUIRED] string: Unique identifier of the Call Queue. This can be retrieved from the List Call Queues API.",
|
|
"phoneNumberId": "[REQUIRED] string: Unique identifier of the Phone Number. "
|
|
},
|
|
"functionality": "After assigning a phone number, you can unbind it if you don't want it to be assigned to a [Call Queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n\n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n \n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Carrier Reseller: listCRPhoneNumbers",
|
|
"api_call": "GET /phone/carrier_reseller/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The size of the page.",
|
|
"next_page_token": "string: The current page number of returned records.",
|
|
"assigned_status": "string: Number assignment status.",
|
|
"sub_account_id": "string: Partner account ID from sub-account.",
|
|
"keyword": "string: Partial string of the phone number."
|
|
},
|
|
"functionality": "Use this API to list phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Carrier Reseller: createCRPhoneNumbers",
|
|
"api_call": "POST /phone/carrier_reseller/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add phone numbers to a carrier reseller (master) account. Up to 200 numbers at a time. If this API is called in MA mode, it also has functions of distribution.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Carrier Reseller: activeCRPhoneNumbers",
|
|
"api_call": "PATCH /phone/carrier_reseller/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to change phone number status to 'active' in a carrier reseller's master account. Up to 200 numbers at a time.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Carrier Reseller: deleteCRPhoneNumber",
|
|
"api_call": "DELETE /phone/carrier_reseller/numbers/{number}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"number": "[REQUIRED] string: Phone number in E164 format."
|
|
},
|
|
"functionality": "Use this API to delete or unassign a phone number from a carrier reseller account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: listCommonAreas",
|
|
"api_call": "GET /phone/common_areas",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The total number of records returned from a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Lists common areas under an account.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: addCommonArea",
|
|
"api_call": "POST /phone/common_areas",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add an instance of common area. Configure devices shared by users and deployed in shared spaces.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: getACommonArea",
|
|
"api_call": "GET /phone/common_areas/{commonAreaId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID."
|
|
},
|
|
"functionality": "Use this API to get detailed information on the common area.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: deleteCommonArea",
|
|
"api_call": "DELETE /phone/common_areas/{commonAreaId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID."
|
|
},
|
|
"functionality": "Use this API to remove the common area. \n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: updateCommonArea",
|
|
"api_call": "PATCH /phone/common_areas/{commonAreaId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to update the common area information.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: assignCallingPlansToCommonArea",
|
|
"api_call": "POST /phone/common_areas/{commonAreaId}/calling_plans",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID."
|
|
},
|
|
"functionality": "Use this API to assign calling plans to a common area.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: unassignCallingPlansFromCommonArea",
|
|
"api_call": "DELETE /phone/common_areas/{commonAreaId}/calling_plans/{type}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID.",
|
|
"type": "[REQUIRED] string: Zoom Phone [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to remove.",
|
|
"billing_account_id": "string: Billing account ID. If the common area is in India, the parameter is required."
|
|
},
|
|
"functionality": "Use this API to unassign a calling plan from the common area.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:** \n* A Pro or higher account with a Zoom Phone license \n* An account owner or admin permissions \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: assignPhoneNumbersToCommonArea",
|
|
"api_call": "POST /phone/common_areas/{commonAreaId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID."
|
|
},
|
|
"functionality": "Assign phone numbers to a common area.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: unassignPhoneNumbersFromCommonArea",
|
|
"api_call": "DELETE /phone/common_areas/{commonAreaId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID.",
|
|
"phoneNumberId": "[REQUIRED] string: The phone number or the phone number ID."
|
|
},
|
|
"functionality": "Use this API to unassign a phone number from a common area.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* A Pro or a higher account with a Zoom Phone license\n* An account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: getCommonAreaSettings",
|
|
"api_call": "GET /phone/common_areas/{commonAreaId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to get common area settings.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: AddCommonAreaSetting",
|
|
"api_call": "POST /phone/common_areas/{commonAreaId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID.",
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to modify. Allowed values: `desk_phone`"
|
|
},
|
|
"functionality": "Use this API to add the common area setting according to the setting type, specifically for desk phones.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: deleteCommonAreaSetting",
|
|
"api_call": "DELETE /phone/common_areas/{commonAreaId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string: Common area ID or common area extension ID.",
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to modify. Allowed values: `desk_phone`",
|
|
"device_id": "[REQUIRED] string: Desk phone ID."
|
|
},
|
|
"functionality": "Use this API to remove the common area subsetting from desk phones. \n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Common Areas: UpdateCommonAreaSetting",
|
|
"api_call": "PATCH /phone/common_areas/{commonAreaId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "[REQUIRED] string",
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to modify. Allowed values: `desk_phone`"
|
|
},
|
|
"functionality": "Use this API to update the common area setting according to the setting type, specifically for desk phones.\n\n**Note**: For use by customers who opted for `Common Area Optimization` \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dashboard: listCallLogsMetrics",
|
|
"api_call": "GET /phone/metrics/call_logs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start date in **yyyy-mm-dd** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 1 day.",
|
|
"to": "string: This setting is **required** only when the `from` parameter is specified. The end date is in **yyyy-mm-dd** format, which is the same format as the `from` parameter.",
|
|
"site_id": "string: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.",
|
|
"quality_type": "string: This setting filters call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. \n \n The value of this field can be one of the following: \n \n* `good`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `bad`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `all`: Retrieve all call logs without filtering by voice quality. \n\n\n\n",
|
|
"page_size": "integer: The number of records returned within a single call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. 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."
|
|
},
|
|
"functionality": " Lists the monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.The call logs that provide a record of all incoming and outgoing calls over Zoom Phone in an account. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dashboard: getCallQoS",
|
|
"api_call": "GET /phone/metrics/call_logs/{callId}/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"callId": "[REQUIRED] string: The unique identifier of the call."
|
|
},
|
|
"functionality": "Gets the call quality of service (QoS) data for a call made or received by a Zoom phone user in the account. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n \n \n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dashboard: getCallLogMetricsDetails",
|
|
"api_call": "GET /phone/metrics/call_logs/{call_id}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"call_id": "[REQUIRED] string: The unique identifier of the phone call. The value of this field can be retrieved from [List Call Logs]() API."
|
|
},
|
|
"functionality": "Lists call log details of a specific call. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dashboard: listTrackedLocations",
|
|
"api_call": "GET /phone/metrics/location_tracking",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "integer: The type of response data. Supports only six responses at this time.\n`1`: Nomadic Emergency Services.\n`2`: Users Permission for Location Sharing.\n`3`: Default Emergency Address.\n`4`: Detectable Personal Location.\n`5`: Real-time Location for Users.\n`6`: Real-time Location for IP Phones.",
|
|
"site_id": "string: The site's ID.",
|
|
"location_type": "string: The location's type. 'Company' is the default value.",
|
|
"keyword": "string: The device name or device MAC address."
|
|
},
|
|
"functionality": "Lists the tracked locations. \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dashboard: listPastCallMetrics",
|
|
"api_call": "GET /phone/metrics/past_calls",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"phone_number": "string: This setting filters call logs of a specified phone number.",
|
|
"extension_number": "string: This setting filters call logs of a specified extension number",
|
|
"quality_type": "string: This setting filters call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. \n \n The value of this field can be one of the following: \n \n* `good`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `bad`: Retrieve call logs of the call(s) with good quality of voice. \n \n",
|
|
"department": "string: The department the extension belongs to.",
|
|
"cost_center": "string: The cost center the extension belongs to.",
|
|
"directions": "array: The directions of the call.",
|
|
"durations": "array: The duration of the call. \n \n* `0`: The call that lasts 1 to 5 minutes. \n \n* `1`: The call that lasts 5 to 10 minutes. \n \n* `2`: The call that lasts more than 10 minutes. \n \n* `3`: The call that lasts less than 1 minute.",
|
|
"site_id": "string: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.",
|
|
"page_size": "integer: The number of records returned within a single call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": " Returns all the call logs metrics of the account from the selected time period. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. You can use query parameters to filter the response by metrics of the call (such as date, phone number, extension number and quality type). \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Device Line Keys: listDeviceLineKeySetting",
|
|
"api_call": "GET /phone/devices/{deviceId}/line_keys",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: The device ID."
|
|
},
|
|
"functionality": "Use this API to get information on the Zoom Phone device [line keys](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) settings and position.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Device Line Keys: batchUpdateDeviceLineKeySetting",
|
|
"api_call": "PATCH /phone/devices/{deviceId}/line_keys",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: The device ID."
|
|
},
|
|
"functionality": "Use this API to batch update the Zoom Phone device [line key position](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: ListUsersFromDirectory",
|
|
"api_call": "GET /phone/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"in_directory": "boolean: Whether the user belongs to the directory.",
|
|
"site_id": "[REQUIRED] string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
|
|
},
|
|
"functionality": "Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: AddUsersToDirectory",
|
|
"api_call": "POST /phone/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: DeleteUsersFromDirectory",
|
|
"api_call": "DELETE /phone/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"site_id": "[REQUIRED] string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)",
|
|
"extension_ids": "array: Extension Ids. If the value is not specified, delete the value of `site_id` from `included sites` and delete all users related with `site_id` from directory."
|
|
},
|
|
"functionality": "Use this API to delete users from the [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: ListUsersFromDirectoryBySite",
|
|
"api_call": "GET /phone/sites/{siteId}/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites).",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"in_directory": "boolean: Whether the user belongs to the directory.",
|
|
"site_id": "string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) to which users to get belongs."
|
|
},
|
|
"functionality": "Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: AddUsersToDirectoryBySite",
|
|
"api_call": "POST /phone/sites/{siteId}/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
|
|
},
|
|
"functionality": "Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Dial by Name Directory: DeleteUsersFromDirectoryBySite",
|
|
"api_call": "DELETE /phone/sites/{siteId}/dial_by_name_directory/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites).",
|
|
"site_id": "string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) to which users to delete belongs",
|
|
"extension_ids": "array: Extension Ids. If the value is not specified, delete the value of `site_id` from `included sites` and delete all users related with `site_id` from directory"
|
|
},
|
|
"functionality": "Use this API to delete users from a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Directory Backup Routing Rules: listRoutingRule",
|
|
"api_call": "GET /phone/routing_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"site_id": "string: Unique identifier of the site."
|
|
},
|
|
"functionality": "Use this API to return a list of directory backup routing rules. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN. \n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Directory Backup Routing Rules: addRoutingRule",
|
|
"api_call": "POST /phone/routing_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create a directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Directory Backup Routing Rules: getRoutingRule",
|
|
"api_call": "GET /phone/routing_rules/{routingRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"routingRuleId": "[REQUIRED] string: Unique identifier of the routing rule."
|
|
},
|
|
"functionality": "Use this API to get directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Directory Backup Routing Rules: deleteRoutingRule",
|
|
"api_call": "DELETE /phone/routing_rules/{routingRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"routingRuleId": "[REQUIRED] string: Unique identifier of the routing rule."
|
|
},
|
|
"functionality": "Use this API to delete directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Directory Backup Routing Rules: updateRoutingRule",
|
|
"api_call": "PATCH /phone/routing_rules/{routingRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"routingRuleId": "[REQUIRED] string: Unique identifier of the routing rule."
|
|
},
|
|
"functionality": "Use this API to update directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Addresses: listEmergencyAddresses",
|
|
"api_call": "GET /phone/emergency_addresses",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"site_id": "string: The emergency address site ID.",
|
|
"user_id": "string: User ID to which the personal emergency address belongs.",
|
|
"level": "integer: The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address.",
|
|
"status": "integer: The emergency address verification status: \n* `1` — Verification not Required. \n* `2` — Unverified. \n* `3` — Verification requested. \n* `4` — Verified. \n* `5` — Rejected. \n* `6` — Verification failed.",
|
|
"address_keyword": "string: Keyword(s) to filter emergency addresses. You can filter by either: \n* Address Line 1. \n* Address Line 2. \n* City. \n* State Abbreviation. \n* Zip Code.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Lists the emergency addresses.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Addresses: addEmergencyAddress",
|
|
"api_call": "POST /phone/emergency_addresses",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds an emergency address. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Addresses: getEmergencyAddress",
|
|
"api_call": "GET /phone/emergency_addresses/{emergencyAddressId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"emergencyAddressId": "[REQUIRED] string: The emergency address ID."
|
|
},
|
|
"functionality": "Gets the emergency address information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions \n \n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Addresses: deleteEmergencyAddress",
|
|
"api_call": "DELETE /phone/emergency_addresses/{emergencyAddressId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"emergencyAddressId": "[REQUIRED] string: The emergency address ID."
|
|
},
|
|
"functionality": "Removes an emergency address.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Addresses: updateEmergencyAddress",
|
|
"api_call": "PATCH /phone/emergency_addresses/{emergencyAddressId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"emergencyAddressId": "[REQUIRED] string: The ID of the emergency address."
|
|
},
|
|
"functionality": "Updates an emergency address information. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: batchAddLocations",
|
|
"api_call": "POST /phone/batch_locations",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Batches the add emergency service locations.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: listLocations",
|
|
"api_call": "GET /phone/locations",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"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.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"site_id": "string: The unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. \n\n**Note:** When the account has been enabled Multiple Sites, this field is required."
|
|
},
|
|
"functionality": "Returns emergency service locations. \n**Note**: When you enable [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites), the `site_id` parameter is required.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: addLocation",
|
|
"api_call": "POST /phone/locations",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds an emergency service location.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: getLocation",
|
|
"api_call": "GET /phone/locations/{locationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"locationId": "[REQUIRED] string: The emergency service location's ID."
|
|
},
|
|
"functionality": "Returns an emergency service location's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: deleteLocation",
|
|
"api_call": "DELETE /phone/locations/{locationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"locationId": "[REQUIRED] string: The emergency service location's ID."
|
|
},
|
|
"functionality": "Removes an emergency location.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Emergency Service Locations: updateLocation",
|
|
"api_call": "PATCH /phone/locations/{locationId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"locationId": "[REQUIRED] string: The emergency service location's ID."
|
|
},
|
|
"functionality": "Updates an emergency location's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - External Contacts: listExternalContacts",
|
|
"api_call": "GET /phone/external_contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Lists the external contacts.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - External Contacts: addExternalContact",
|
|
"api_call": "POST /phone/external_contacts",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds an external contact.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - External Contacts: getAExternalContact",
|
|
"api_call": "GET /phone/external_contacts/{externalContactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"externalContactId": "[REQUIRED] string: The external contact's ID."
|
|
},
|
|
"functionality": "Gets an external contact's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions \n \n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - External Contacts: deleteAExternalContact",
|
|
"api_call": "DELETE /phone/external_contacts/{externalContactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"externalContactId": "[REQUIRED] string: The external contact's ID."
|
|
},
|
|
"functionality": "Removes an external contact.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - External Contacts: updateExternalContact",
|
|
"api_call": "PATCH /phone/external_contacts/{externalContactId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"externalContactId": "[REQUIRED] string: The external contact ID."
|
|
},
|
|
"functionality": "Updates an external contact's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: ListFirmwareRules",
|
|
"api_call": "GET /phone/firmware_update_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"site_id": "string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Required if multiple sites are enabled.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to get [firmware update rules](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: AddFirmwareRule",
|
|
"api_call": "POST /phone/firmware_update_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add a [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: GetFirmwareRuleDetail",
|
|
"api_call": "GET /phone/firmware_update_rules/{ruleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"ruleId": "[REQUIRED] string: Unique identifier of the firmware update rule."
|
|
},
|
|
"functionality": "Use this API to get the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules) information.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: DeleteFirmwareUpdateRule",
|
|
"api_call": "DELETE /phone/firmware_update_rules/{ruleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"ruleId": "[REQUIRED] string: Unique identifier of the firmware update rule.",
|
|
"restart_type": "integer: Restart type: `1` - Restart the devices immediately. `2` - Restart with the next resync or auto pull."
|
|
},
|
|
"functionality": "Use this API to delete the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: UpdateFirmwareRule",
|
|
"api_call": "PATCH /phone/firmware_update_rules/{ruleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"ruleId": "[REQUIRED] string: Unique identifier of the firmware update rule."
|
|
},
|
|
"functionality": "Use this API to update a specific [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Firmware Update Rules: ListFirmwares",
|
|
"api_call": "GET /phone/firmwares",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"is_update": "boolean: Firmware update rule enabled. \n `true` - Get all firmwares that can have firmware update rules added \n `false` - Get all firmwares whether or not you can add firmware update rules to it",
|
|
"site_id": "string: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Required if multiple sites are enabled."
|
|
},
|
|
"functionality": "Use this API to get updatable [firmwares](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: listGCP",
|
|
"api_call": "GET /phone/group_call_pickup",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"site_id": "string: Unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
|
|
},
|
|
"functionality": "Use this API to retrieve a list of [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) objects in an account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: addGCP",
|
|
"api_call": "POST /phone/group_call_pickup",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) instance to the account that has the Zoom Phone license assigned. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: GetGCP",
|
|
"api_call": "GET /phone/group_call_pickup/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to retrieve information on a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object in an account. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: deleteGCP",
|
|
"api_call": "DELETE /phone/group_call_pickup/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to remove a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: updateGCP",
|
|
"api_call": "PATCH /phone/group_call_pickup/{groupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to update a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object information.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: listGCPMembers",
|
|
"api_call": "GET /phone/group_call_pickup/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"groupId": "[REQUIRED] string",
|
|
"site_id": "string: Unique identifier of the site.",
|
|
"extension_type": "string: Type of the assignee."
|
|
},
|
|
"functionality": "Use this API to retrieve members of a [call pickup group](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) in an account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: addGCPMembers",
|
|
"api_call": "POST /phone/group_call_pickup/{groupId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to add members to the specified [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Group Call Pickup: removeGCPMembers",
|
|
"api_call": "DELETE /phone/group_call_pickup/{groupId}/members/{extensionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string",
|
|
"extensionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to remove member from the [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Groups: getGroupPhoneSettings",
|
|
"api_call": "GET /phone/groups/{groupId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"groupId": "[REQUIRED] string: The group ID. \n\nIt can be retrieved from the [List groups](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/groups) API.",
|
|
"setting_types": "string: This setting corresponds to the setting item you want to modify. \n\nIt is separated by a comma. \n\nAllowed values:\n `call_live_transcription`, `local_survivability_mode`, `select_outbound_caller_id`, `personal_audio_library`, `voicemail`, `voicemail_transcription`, `voicemail_notification_by_email`, `shared_voicemail_notification_by_email`, `restricted_call_hours`, `allowed_call_locations`, `check_voicemails_over_phone`, `connect_to_operator`, `auto_call_recording`, `ad_hoc_call_recording`, `outbound_calling`, `outbound_sms`, `international_calling`, `sms`, `zoom_phone_on_mobile`, `zoom_phone_on_pwa`, `sms_etiquette_tool`, `e2e_encryption`, `call_handling_forwarding`, `call_overflow`, `call_transferring`, `elevate_to_meeting`, `call_park`, `hand_off_to_room`, `mobile_switch_to_carrier`, `delegation`, `audio_intercom`, `block_list_for_inbound_calls_and_messaging`, `block_calls_without_caller_id`, `block_external_calls`, `peer_to_peer_media`, `advanced_encryption`, `display_call_feedback_survey`."
|
|
},
|
|
"functionality": "Returns group phone settings.\n\n**Prerequisites:**\n * Account must have a Pro or a higher plan with Zoom Phone license.\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - IVR: getAutoReceptionistIVR",
|
|
"api_call": "GET /phone/auto_receptionists/{autoReceptionistId}/ivr",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The unique identifier of the auto receptionist. It can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.",
|
|
"hours_type": "string: The query hours type: `business_hours` or `closed_hours`, default `business_hours`.",
|
|
"holiday_id": "string: The auto receptionist holiday hours ID. If both `holiday_id` and `hours_type` are passed, `holiday_id` has a high priority and `hours_type` is invalid."
|
|
},
|
|
"functionality": "Gets an [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - IVR: updateAutoReceptionistIVR",
|
|
"api_call": "PATCH /phone/auto_receptionists/{autoReceptionistId}/ivr",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"autoReceptionistId": "[REQUIRED] string: The auto receptionist id."
|
|
},
|
|
"functionality": "Updates the [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: ListExtensionLevelInboundBlockRules",
|
|
"api_call": "GET /phone/extension/{extensionId}/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID for the inbound blocked rules to fetch.",
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type for the block rule:\n* `phoneNumber`: Only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: All numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Only a specific SMS short code that is shown in the `blocked_number` field is blocked.",
|
|
"type": "string: The block type for the block rule:\n* `block_for_other_reasons`\n* `block_as_threat`",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns a list of the given extension's block rule for inbound calls and messaging. \n\nit lists inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room, or User.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: AddExtensiontLevelInboundBlockRules",
|
|
"api_call": "POST /phone/extension/{extensionId}/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID for the inbound blocked rules to fetch."
|
|
},
|
|
"functionality": "Adds the given extension's block rule for inbound calls and messaging. \n\nIt adds the inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: DeleteExtensiontLevelInboundBlockRules",
|
|
"api_call": "DELETE /phone/extension/{extensionId}/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID for the inbound blocked rules to fetch.",
|
|
"blocked_rule_id": "[REQUIRED] string: The unique identifier of the blocked rule. "
|
|
},
|
|
"functionality": "Deletes the given extension's blocked rule for inbound calls and messaging. \n\nUse this API to delete inbound blocked rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User.\n\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: ListAccountLevelInboundBlockedStatistics",
|
|
"api_call": "GET /phone/inbound_blocked/extension_rules/statistics",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type for the block rule:\n* `phoneNumber`: Only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: All numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Only a specific SMS short code that is shown in the `blocked_number` field is blocked.",
|
|
"type": "string: The block type for the block rule:\n* block_for_other_reasons\n* block_as_threat",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns the list of the statistics of the extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User)\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: DeleteAccountLevelInboundBlockedStatistics",
|
|
"api_call": "DELETE /phone/inbound_blocked/extension_rules/statistics",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blocked_statistic_id": "[REQUIRED] string: The unique identifier of the blocked statistic."
|
|
},
|
|
"functionality": "Deletes the statistic of extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User)\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: MarkPhoneNumberAsBlockedForAllExtensions",
|
|
"api_call": "PATCH /phone/inbound_blocked/extension_rules/statistics/blocked_for_all",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Promotes and applies the phone number blocked from the extension level blocked rule to the account level blocked rule. This action is contingent on the statistics of extensions blocked rule. All extensions under the current account block this phone number.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: ListAccountLevelInboundBlockRules",
|
|
"api_call": "GET /phone/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type for the block rule:\n* `phoneNumber`: Indicates that only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: Indicates that all numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Indicates that only a specific SMS short code that is shown in the `blocked_number` field is blocked.",
|
|
"type": "string: The block type for the block rule:\n* block_for_other_reasons\n* block_as_threat",
|
|
"status": "string: Whether the block rule is active or inactive.\n* `active`: The block rule is active.\n* `inactive`: The block rule is inactive.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns a list of account level inbound block rule for inbound calls and messaging.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: AddAccountLevelInboundBlockRules",
|
|
"api_call": "POST /phone/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds an account level block rule for inbound calls and messaging from a phone number. As a result, all extensions block calls and messages to the phone number.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: DeleteAccountLevelInboundBlockRules",
|
|
"api_call": "DELETE /phone/inbound_blocked/rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blocked_rule_id": "[REQUIRED] string: The unique identifier of the blocked rule. "
|
|
},
|
|
"functionality": "Deletes the account level blocked rule for inbound calls and messaging.\n\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Inbound Blocked List: UpdateAccountLevelInboundBlockRule",
|
|
"api_call": "PATCH /phone/inbound_blocked/rules/{blockedRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"blockedRuleId": "[REQUIRED] string: The unique identifier of the blocked rule."
|
|
},
|
|
"functionality": "Updates the account level block rule for inbound calls and messaging.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Line Keys: listLineKeySetting",
|
|
"api_call": "GET /phone/extension/{extensionId}/line_keys",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID."
|
|
},
|
|
"functionality": "Use this API to get the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Line Keys: BatchUpdateLineKeySetting",
|
|
"api_call": "PATCH /phone/extension/{extensionId}/line_keys",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID."
|
|
},
|
|
"functionality": "Use this API to batch update the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Line Keys: DeleteLineKey",
|
|
"api_call": "DELETE /phone/extension/{extensionId}/line_keys/{lineKeyId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"extensionId": "[REQUIRED] string: The extension ID.",
|
|
"lineKeyId": "[REQUIRED] string: Line key ID."
|
|
},
|
|
"functionality": "Use this API to delete the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: listMonitoringGroup",
|
|
"api_call": "GET /phone/monitoring_groups",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "integer: Monitoring group's type.",
|
|
"site_id": "string: Unique identifier of the monitoring group's site.",
|
|
"page_size": "integer: The size of the page.",
|
|
"next_page_token": "string: The current page number of returned records."
|
|
},
|
|
"functionality": "Use this API to return an account's [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711) list.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: createMonitoringGroup",
|
|
"api_call": "POST /phone/monitoring_groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to create a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: getMonitoringGroupById",
|
|
"api_call": "GET /phone/monitoring_groups/{monitoringGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID."
|
|
},
|
|
"functionality": "Use this API to return a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711) for the specified ID.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: deleteMonitoringGroup",
|
|
"api_call": "DELETE /phone/monitoring_groups/{monitoringGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID."
|
|
},
|
|
"functionality": "Use this API to delete a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: updateMonitoringGroup",
|
|
"api_call": "PATCH /phone/monitoring_groups/{monitoringGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID."
|
|
},
|
|
"functionality": "Use this API to update a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: listMembers",
|
|
"api_call": "GET /phone/monitoring_groups/{monitoringGroupId}/monitor_members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID.",
|
|
"member_type": "[REQUIRED] string: Member type",
|
|
"page_size": "integer: The size of the page.",
|
|
"next_page_token": "string: The current page number of returned records."
|
|
},
|
|
"functionality": "Use this API to return members list of a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: addMembers",
|
|
"api_call": "POST /phone/monitoring_groups/{monitoringGroupId}/monitor_members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID.",
|
|
"member_type": "[REQUIRED] string: Member type"
|
|
},
|
|
"functionality": "Use this API to add members to a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: removeMembers",
|
|
"api_call": "DELETE /phone/monitoring_groups/{monitoringGroupId}/monitor_members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID.",
|
|
"member_type": "[REQUIRED] string: Member type"
|
|
},
|
|
"functionality": "Use this API to remove all monitor or monitored members from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Monitoring Groups: removeMember",
|
|
"api_call": "DELETE /phone/monitoring_groups/{monitoringGroupId}/monitor_members/{memberExtensionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"monitoringGroupId": "[REQUIRED] string: Monitoring group ID.",
|
|
"memberExtensionId": "[REQUIRED] string: Member's extension ID.",
|
|
"member_type": "string: Member type"
|
|
},
|
|
"functionality": "Use this API to remove a member from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: GetCommonAreaOutboundCallingCountriesAndRegions",
|
|
"api_call": "GET /phone/common_areas/{commonAreaId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns the common area level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateCommonAreaOutboundCallingCountriesOrRegions",
|
|
"api_call": "PATCH /phone/common_areas/{commonAreaId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area."
|
|
},
|
|
"functionality": "Updates the common area level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: listCommonAreaOutboundCallingExceptionRule",
|
|
"api_call": "GET /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area.",
|
|
"country": "string: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).",
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type of an exception rule.",
|
|
"status": "string: The status of an exception rule.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Lists the common area level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with Zoom phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: AddCommonAreaOutboundCallingExceptionRule",
|
|
"api_call": "POST /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area."
|
|
},
|
|
"functionality": "Adds the common area level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: deleteCommonAreaOutboundCallingExceptionRule",
|
|
"api_call": "DELETE /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area.",
|
|
"exceptionRuleId": "[REQUIRED] string: The exception rule ID."
|
|
},
|
|
"functionality": "Deletes the common area level outbound calling exception rule.\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateCommonAreaOutboundCallingExceptionRule",
|
|
"api_call": "PATCH /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"commonAreaId": "string: The ID of the common area.",
|
|
"exceptionRuleId": "string: The exception rule ID."
|
|
},
|
|
"functionality": "Updates the common area level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: GetAccountOutboundCallingCountriesAndRegions",
|
|
"api_call": "GET /phone/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns the account level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateAccountOutboundCallingCountriesOrRegions",
|
|
"api_call": "PATCH /phone/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Updates the account level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: listAccountOutboundCallingExceptionRule",
|
|
"api_call": "GET /phone/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"country": "string: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).",
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type of an exception rule.",
|
|
"status": "string: The status of an exception rule.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Lists the account level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with Zoom phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: AddAccountOutboundCallingExceptionRule",
|
|
"api_call": "POST /phone/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds the account level outbound calling policy exception rule for country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: deleteAccountOutboundCallingExceptionRule",
|
|
"api_call": "DELETE /phone/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"exceptionRuleId": "[REQUIRED] string: The exception rule ID."
|
|
},
|
|
"functionality": "Deletes the account level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateAccountOutboundCallingExceptionRule",
|
|
"api_call": "PATCH /phone/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"exceptionRuleId": "[REQUIRED] string: The exception rule ID."
|
|
},
|
|
"functionality": "Updates the account level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: GetSiteOutboundCallingCountriesAndRegions",
|
|
"api_call": "GET /phone/sites/{siteId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns the site level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateSiteOutboundCallingCountriesOrRegions",
|
|
"api_call": "PATCH /phone/sites/{siteId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site."
|
|
},
|
|
"functionality": "Updates the site level outbound calling policy country or region.\n\n**Prerequisites:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: listSiteOutboundCallingExceptionRule",
|
|
"api_call": "GET /phone/sites/{siteId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site.",
|
|
"country": "string: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).",
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type of an exception rule.",
|
|
"status": "string: The status of an exception rule.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Lists site level outbound calling policy exception rules.*\n\n**Prerequisite:**\n* Pro or higher account plan with Zoom phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: AddSiteOutboundCallingExceptionRule",
|
|
"api_call": "POST /phone/sites/{siteId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site."
|
|
},
|
|
"functionality": "Adds the site level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: deleteSiteOutboundCallingExceptionRule",
|
|
"api_call": "DELETE /phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site.",
|
|
"exceptionRuleId": "[REQUIRED] string: The exception rule ID."
|
|
},
|
|
"functionality": "Deletes the site level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateSiteOutboundCallingExceptionRule",
|
|
"api_call": "PATCH /phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "string: The ID of the site.",
|
|
"exceptionRuleId": "string: The exception rule ID."
|
|
},
|
|
"functionality": "Updates the site level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: GetUserOutboundCallingCountriesAndRegions",
|
|
"api_call": "GET /phone/users/{userId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Returns the user level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateUserOutboundCallingCountriesOrRegions",
|
|
"api_call": "PATCH /phone/users/{userId}/outbound_calling/countries_regions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user."
|
|
},
|
|
"functionality": "Updates the user level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: listUserOutboundCallingExceptionRule",
|
|
"api_call": "GET /phone/users/{userId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user.",
|
|
"country": "string: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).",
|
|
"keyword": "string: The partial string of a phone number.",
|
|
"match_type": "string: The match type of an exception rule.",
|
|
"status": "string: The status of an exception rule.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records in a single API call."
|
|
},
|
|
"functionality": "Lists the user level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with Zoom phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: AddUserOutboundCallingExceptionRule",
|
|
"api_call": "POST /phone/users/{userId}/outbound_calling/exception_rules",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user"
|
|
},
|
|
"functionality": "Adds an user level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: deleteUserOutboundCallingExceptionRule",
|
|
"api_call": "DELETE /phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user.",
|
|
"exceptionRuleId": "[REQUIRED] string: The exception rule ID."
|
|
},
|
|
"functionality": "Deletes the user level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Outbound Calling: UpdateUserOutboundCallingExceptionRule",
|
|
"api_call": "PATCH /phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "string: The ID of the user.",
|
|
"exceptionRuleId": "string: The exception rule ID."
|
|
},
|
|
"functionality": "Updates the user level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: listPhoneDevices",
|
|
"api_call": "GET /phone/devices",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "[REQUIRED] string: The device status: `assigned` or `unassigned` to list device status in Zoom account.",
|
|
"assignee_type": "string: The type of the assignee. It's available if `type = assigned`. It's unavailable if the account has not enabled the common area feature. It also returns devices of the specified `assignee_type`. If unspecified, it returns all assigned devices.",
|
|
"device_source": "string: The device source. `hotDesking` is only available when `type = assigned`.",
|
|
"location_status": "string: The status of device location. It's available if `type = assigned`.",
|
|
"site_id": "string: The site of the assignee.",
|
|
"device_type": "string: The manufacturer name or device type.",
|
|
"keyword": "string: The user, extension, MAC address, or IP address to filter the results.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Lists all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account.\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: addPhoneDevice",
|
|
"api_call": "POST /phone/devices",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "[Adda a desk phone and assigns it](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da) to a user, if a desk phone is required.\n\nBy default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. \n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices) \n \n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: syncPhoneDevice",
|
|
"api_call": "POST /phone/devices/sync",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to resync all online zero-touch or assisted-provisioning devices in an account or a site. Only allows sending one request every 15 minutes.\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: getADevice",
|
|
"api_call": "GET /phone/devices/{deviceId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: Unique Identifier of the device."
|
|
},
|
|
"functionality": "Gets detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: deleteADevice",
|
|
"api_call": "DELETE /phone/devices/{deviceId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: Unique identifier of the device."
|
|
},
|
|
"functionality": "Remove a [desk phone device or ATA (Analog Telephone Adapter)](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* Device must not have been assigned to a user.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: updateADevice",
|
|
"api_call": "PATCH /phone/devices/{deviceId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: The unique identifier of the device."
|
|
},
|
|
"functionality": "Updates the information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).**Prerequisites:*** Pro or a higher account with Zoom Phone license* Account owner or admin permissions\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: addExtensionsToADevice",
|
|
"api_call": "POST /phone/devices/{deviceId}/extensions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: Unique identifier of the device."
|
|
},
|
|
"functionality": "By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to [add a desk phone and assign it to a user](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: deleteExtensionFromADevice",
|
|
"api_call": "DELETE /phone/devices/{deviceId}/extensions/{extensionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: Unique identifier of the device from which to unassign an assignee.",
|
|
"extensionId": "[REQUIRED] string: Extension ID of the assignee (`user` or `common area`)"
|
|
},
|
|
"functionality": "Use this API to unassign a specific assignee from the device.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions. \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: updateProvisionTemplateToDevice",
|
|
"api_call": "PUT /phone/devices/{deviceId}/provision_templates",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: The device ID."
|
|
},
|
|
"functionality": "Use this API to [assign a provision template to a device](https://support.zoom.us/hc/en-us/articles/360035817952#h_6b52ef26-d070-40ed-a3fa-520571944afc) or [remove a provision template from the device](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) by leaving `templateId` empty.\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360029698771#note) \n \n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Devices: rebootPhoneDevice",
|
|
"api_call": "POST /phone/devices/{deviceId}/reboot",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"deviceId": "[REQUIRED] string: Unique identifier of the device."
|
|
},
|
|
"functionality": "Use this API to reboot an online zero-touch or assisted-provisioning device. You can only send one request every second.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions. \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: addBYOCNumber",
|
|
"api_call": "POST /phone/byoc_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to add BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.\n\n**Prerequisites:** \n* A Business or Enterprise plan \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: listAccountPhoneNumbers",
|
|
"api_call": "GET /phone/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"type": "string: The query response by number assignment. The value can be one of the following:\n \n \n`assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area in an account. \n `unassigned`: The number is not assigned to anyone. \n \n`all`: Include both assigned and unassigned numbers in the response. \n \n`byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response.",
|
|
"extension_type": "string: The type of assignee to whom the number is assigned. The parameter can be set only if `type` parameter is set as `assigned`. The value can be one of the following: \n \n`user` \n `callQueue` \n `autoReceptionist` \n \n`commonAreaPhone`",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"number_type": "string: The type of phone number. The value can be either `toll` or `tollfree`.",
|
|
"pending_numbers": "boolean: Include or exclude pending numbers in the response. The value can be either `true` or `false`.",
|
|
"site_id": "string: Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details."
|
|
},
|
|
"functionality": "Lists all Zoom Phone numbers in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: deleteUnassignedPhoneNumbers",
|
|
"api_call": "DELETE /phone/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"phone_numbers": "[REQUIRED] array: Comma seperated list of unassigned phone numbers in E164 format or phone number IDs."
|
|
},
|
|
"functionality": "Deletes unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be removed in a single request.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: updateSiteForUnassignedPhoneNumbers",
|
|
"api_call": "PATCH /phone/numbers/sites/{siteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: Unique identifier of the site"
|
|
},
|
|
"functionality": "Updates a site's unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be updated in a single request. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: getPhoneNumberDetails",
|
|
"api_call": "GET /phone/numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"phoneNumberId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about an account's Zoom Phone number.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: updatePhoneNumberDetails",
|
|
"api_call": "PATCH /phone/numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"numberId": "[REQUIRED] string: Phone number ID."
|
|
},
|
|
"functionality": "Updates a Zoom Phone number's information.\n\n**Prerequisites:** \n* A Paid account\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: assignPhoneNumber",
|
|
"api_call": "POST /phone/users/{userId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Assigns a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Numbers: UnassignPhoneNumber",
|
|
"api_call": "DELETE /phone/users/{userId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: Provide either userId or email address of the user.",
|
|
"phoneNumberId": "[REQUIRED] string: Provide either phone number or phoneNumberId of the user. "
|
|
},
|
|
"functionality": "Unassigns Zoom Phone user's [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6).\n\nAfter assigning a phone number, you can remove it if you do not want it to be assigned to anyone.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Plans: listCallingPlans",
|
|
"api_call": "GET /phone/calling_plans",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to return all of an account's Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans).\n\n**Prerequisites:** \n* A Pro or a higher account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Plans: listPhonePlans",
|
|
"api_call": "GET /phone/plans",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to return all of an account's Zoom Phone [plan package](https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans-and-codes), phone number usage and availability.\n\n**Prerequisites:** \n* A Pro or a higher account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: ListPhoneRoles",
|
|
"api_call": "GET /phone/roles",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to get phone roles.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: DuplicatePhoneRole",
|
|
"api_call": "POST /phone/roles",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to duplicate a phone role.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: getRoleInformation",
|
|
"api_call": "GET /phone/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role ID."
|
|
},
|
|
"functionality": "Use this API to get information on a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: DeletePhoneRole",
|
|
"api_call": "DELETE /phone/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
|
|
},
|
|
"functionality": "Use this API to delete a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: UpdatePhoneRole",
|
|
"api_call": "PATCH /phone/roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
|
|
},
|
|
"functionality": "Use this API to update a role.\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: ListRoleMembers",
|
|
"api_call": "GET /phone/roles/{roleId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user.",
|
|
"in_role": "boolean: Whether the user belongs to the role: default is `false`."
|
|
},
|
|
"functionality": "Use this API to get members (not) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: AddRoleMembers",
|
|
"api_call": "POST /phone/roles/{roleId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
|
|
},
|
|
"functionality": "Use this API to add members to [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management#h_01EFHY1R4QWAYTA6Z661NM9Q27).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Phone Roles: DelRoleMembers",
|
|
"api_call": "DELETE /phone/roles/{roleId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user.",
|
|
"user_ids": "[REQUIRED] array: The user IDs or email addresses of the user"
|
|
},
|
|
"functionality": "Use this API to delete member(s) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provider Exchange: listCarrierPeeringPhoneNumbers",
|
|
"api_call": "GET /phone/carrier_peering/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The total number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"phone_number": "string: To filter results by the given phone number."
|
|
},
|
|
"functionality": "Returns phone numbers pushed by the carrier to different customers.\nTo become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provider Exchange: listPeeringPhoneNumbers",
|
|
"api_call": "GET /phone/peering/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The total number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"phone_number": "string: The sender's or receiver's phone number that limits the list of SMS sessions.",
|
|
"carrier_code": "integer: The carrier's code. The `clientId` that maps to a carrier peered with Zoom.\n\nThis parameter is required if you do **not** use an OAuth token or the OAuth token does not contain the `clientId`."
|
|
},
|
|
"functionality": "Returns phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provider Exchange: addPeeringPhoneNumbers",
|
|
"api_call": "POST /phone/peering/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone_peering:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provider Exchange: deletePeeringPhoneNumbers",
|
|
"api_call": "DELETE /phone/peering/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Removes phone numbers added to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone_peering:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provider Exchange: updatePeeringPhoneNumbers",
|
|
"api_call": "PATCH /phone/peering/numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Updates phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone_peering:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provision Templates: listAccountProvisionTemplate",
|
|
"api_call": "GET /phone/provision_templates",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to list all [provision templates](https://support.zoom.us/hc/en-us/articles/360035817952) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provision Templates: addProvisionTemplate",
|
|
"api_call": "POST /phone/provision_templates",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to [create a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_8266cb40-58fc-4c1a-8da2-885d72167234) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provision Templates: GetProvisionTemplate",
|
|
"api_call": "GET /phone/provision_templates/{templateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"templateId": "[REQUIRED] string: The template ID."
|
|
},
|
|
"functionality": "Use this API to get a specific [provision template](https://support.zoom.us/hc/en-us/articles/360035817952).\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provision Templates: deleteProvisionTemplate",
|
|
"api_call": "DELETE /phone/provision_templates/{templateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"templateId": "[REQUIRED] string: The template ID."
|
|
},
|
|
"functionality": "Use this API to [delete a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Provision Templates: updateProvisionTemplate",
|
|
"api_call": "PATCH /phone/provision_templates/{templateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"templateId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to update a [provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: getPhoneRecordingsByCallIdOrCallLogId",
|
|
"api_call": "GET /phone/call_logs/{id}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] string: This field gets the unique ID of the call log. You can use `callLogId` and `callId` as path parameters. You can find the value for this field with the **[Get account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs)** API or the **[Get user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)** API."
|
|
},
|
|
"functionality": "Returns an account's [call recording](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) by the recording's `callId` or `callLogId` ID. \n\n**Note**: This API returns the `file_url` in the JSON query results.\n\n**Prerequisites:** \n* A Pro or higher account with Zoom Phone license \n* Account owner or admin privileges\n\n**Scopes:** `phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: phoneDownloadRecordingTranscript",
|
|
"api_call": "GET /phone/recording_transcript/download/{recordingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"recordingId": "[REQUIRED] string: The phone recording ID."
|
|
},
|
|
"functionality": "Downloads the phone recording transcript. \n\n**Prerequisites:**\n\n* A Business or Enterprise account\n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: getPhoneRecordings",
|
|
"api_call": "GET /phone/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call. \n\nThe default is **30** and the maximum is **300**.",
|
|
"next_page_token": "string: The current page number of the returned records.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd T HH:mm:ssZ** format. \n\nThe date range defined in the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days.",
|
|
"to": "string: This field is **required** only when the `from` parameter is specified. \n\nThe end time and date display in **yyyy-mm-dd** or **yyyy-MM-dd T HH:mm:ssZ** format, which is the same format as the `from` parameter.",
|
|
"owner_type": "string: The owner type. \n\nThe allowed values are `null`, `user`, or `callQueue`. \n\nThe default value is `null`. If the value is `null`, it returns all owner types.",
|
|
"recording_type": "string: The recording type. The allowed values are `null`, `OnDemand`, or `Automatic`. The default value is `null`. If `null`, it returns all recording types.",
|
|
"site_id": "string: The site ID. \n\nThe default value is `All sites`.",
|
|
"query_date_type": "string: The query date type, which can be `start_time` or `end_time`. \n\nThe default value is `start_time`.",
|
|
"group_id": "string: The group ID. \n\nThe default value is `All groups`."
|
|
},
|
|
"functionality": "Returns an account's [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings). \n\n**Prerequisites:** \n* A Pro or higher account plan \n * A Zoom Phone license \n * Account owner or admin privileges\n\n**Scopes:** `phone:read:admin`,`phone_recording:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: deleteCallRecording",
|
|
"api_call": "DELETE /phone/recordings/{recordingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"recordingId": "[REQUIRED] string: The unique identifier of the recording."
|
|
},
|
|
"functionality": "Deletes a call recording.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: UpdateAutoDeleteField",
|
|
"api_call": "PATCH /phone/recordings/{recordingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"recordingId": "[REQUIRED] string: The unique identifier of the recording."
|
|
},
|
|
"functionality": "Updates the auto delete field for recording. It only updates if you enable the **Auto Delete Data After Retention Duration** setting in the account settings for recordings. \n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license.\n\n**Scopes:** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: UpdateRecordingStatus",
|
|
"api_call": "PUT /phone/recordings/{recordingId}/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"recordingId": "string: The recording ID."
|
|
},
|
|
"functionality": "Updates the status of a single recording in account. \n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Recordings: phoneUserRecordings",
|
|
"api_call": "GET /phone/users/{userId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
|
|
},
|
|
"functionality": "Gets a user's [Zoom Phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone_recording:read:admin`,`phone_recording:read`,`phone:read`,`phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Reports: GetCallChargesUsageReport",
|
|
"api_call": "GET /phone/reports/call_charges",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"page_size": "integer: The number of records returned within a single API call. The default is **30**, and the maximum is **300**.",
|
|
"next_page_token": "string: The current page number of the returned records.",
|
|
"billing_account_id": "string: The billing account ID.",
|
|
"show_charges_only": "boolean: This field shows calls with charges only. The default value is false."
|
|
},
|
|
"functionality": "Retrieves the **Phone Call Charges Report**. The **Call charges usage report** allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information when they log into their Zoom accounts and navigate to [Call Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=1).\n\n **Prerequisites:** \n\n* Account must be enrollled in Pro or a higher plan\n* Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Reports: getPSOperationLogs",
|
|
"api_call": "GET /phone/reports/operationlogs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data within the 24 hours.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"category_type": "string: Filter the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period. \n \n To only include response for a specific category type, provide a value for `category_type` from this [table](https://marketplace.zoom.us/docs/api-reference/other-references/phone-operation-categories).",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "The **Phone System operation logs report** allows account owners and admins to view monthly Zoom phone related admin operation details. \n\nUse this API to retrieve the **Phone System Operation Logs Report**. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to [Phone System Operation Logs](https://zoom.us/pbx/page/report/operations#/report/operation-logs). \n \n **Prerequisites:** \n \n* Account must be enrollled in Pro or a higher plan\n* Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Reports: GetSMSChargesUsageReport",
|
|
"api_call": "GET /phone/reports/sms_charges",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days.",
|
|
"to": "string: This field is **required** only when you specify the `from` parameter. End time and date is in a **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The `from` parameter uses the the same format.",
|
|
"page_size": "integer: The number of records returned within a single API call. The default is **30**, and the maximum is **300**.",
|
|
"next_page_token": "string: The current page number of returned records.",
|
|
"show_charges_only": "boolean: This field shows sms/mms with charges only. Defaults to false."
|
|
},
|
|
"functionality": "Retrieves the **SMS/MMS Charges Report**. The **SMS/MMS charges usage report** allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information by when they log into their Zoom accounts and navigate to [ SMS/MMS Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=2). **Prerequisites:** * Account must be enrolled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: accountSmsSession",
|
|
"api_call": "GET /phone/sms/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The current page number of returned records.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days.",
|
|
"to": "string: This field is required only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"session_type": "string: This field filters the specific session list by a session type.\n\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`",
|
|
"phone_number": "string: The sender's or receiver's phone number that limits the list of SMS sessions.",
|
|
"filter_type": "string: This field filters by `sent_message_time`, `received_message_time`, or `last_message_time` for the From and To dates.\n* `last_message_time`: queries which sessions last messages between From and To dates.\n* `sent_message_time`: queries which sessions have sent messages between From and To dates.\n* `received_message_time`: queries which sessions have received messages between From and To dates."
|
|
},
|
|
"functionality": "Returns details about SMS sessions for an account.\n\n**Prerequisites**\n* Paid account\n* User-enabled Zoom phone\n\n\n\n**Scopes:** `phone:read:admin`,`phone_sms:read:admin`,`phone_sms:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: smsSessionDetails",
|
|
"api_call": "GET /phone/sms/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: SMS session ID.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The current page number of returned records.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter.",
|
|
"sort": "integer: Order of SMS to return based on creation time. `1`: ascending `2`: descending"
|
|
},
|
|
"functionality": "Get details about an SMS session.\n\n**Prerequisites**\n* Paid account\n* User-enabled Zoom phone\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: smsByMessageId",
|
|
"api_call": "GET /phone/sms/sessions/{sessionId}/messages/{messageId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The SMS session ID.",
|
|
"messageId": "[REQUIRED] string: The SMS message ID."
|
|
},
|
|
"functionality": "Get details about a specific message in an SMS session.\n\n**Prerequisites**\n* Paid account\n* User-enabled Zoom phone\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: smsSessionSync",
|
|
"api_call": "GET /phone/sms/sessions/{sessionId}/sync",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: SMS session ID.",
|
|
"sync_type": "string: Options for synchronizing sms message: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync",
|
|
"count": "integer: The number of records returned within a single API call.",
|
|
"sync_token": "string: The time range for returned records. Used for locating where the next retrieval will begin."
|
|
},
|
|
"functionality": "Use this API to sync SMS messages in a session. \n\n**Prerequisites**\n* Paid account\n* User-enabled Zoom phone\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: userSmsSession",
|
|
"api_call": "GET /phone/users/{userId}/sms/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID, user email, or “me” when using OAuth token.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The current page number of returned records.",
|
|
"session_type": "string: This field filters the specific session list by a session type.\n\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days.",
|
|
"to": "string: This field is required only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter.",
|
|
"phone_number": "string: The sender's or receiver's phone number that limits the list of SMS sessions.",
|
|
"filter_type": "string: This field filters by `sent_message_time`, `received_message_time`, or `last_message_time` for the From and To dates.\n* `last_message_time`: can query which sessions last messages between From and To dates.\n* `sent_message_time`: can query which sessions have sent messages between From and To dates.\n* `received_message_time`: can query which sessions have received messages between From and To dates."
|
|
},
|
|
"functionality": "Returns details about SMS sessions for a user. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* Paid account \n* User-enabled Zoom phone\n\n**Scopes:** `phone:read:admin`,`phone:read`,`phone_sms:read:admin`,`phone_sms:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS: GetSmsSessions",
|
|
"api_call": "GET /phone/users/{userId}/sms/sessions/sync",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID, user email, or “me” when using OAuth token.",
|
|
"sync_type": "[REQUIRED] string: FSync: Full sync BSync: Backward sync ISync: Forward sync",
|
|
"sync_token": "string: The sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync.",
|
|
"count": "integer: The record count of each query",
|
|
"session_type": "string: This field filters the specific session list by a session type.\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`"
|
|
},
|
|
"functionality": "Retrieves the user's SMS sessions in descending order. Mirrors the ZP client behavior with the most recent on top.\n\n**Prerequisites:**\n* Paid account \n* User-enabled Zoom phone \n \n \n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`,`phone_sms:read:admin`,`phone_sms:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS Campaign: listAccountSMSCampaigns",
|
|
"api_call": "GET /phone/sms_campaigns",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to list all SMS campaigns in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS Campaign: GetSMSCampaign",
|
|
"api_call": "GET /phone/sms_campaigns/{smsCampaignId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"smsCampaignId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to get a specific SMS campaign.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS Campaign: assignCampaignPhoneNumbers",
|
|
"api_call": "POST /phone/sms_campaigns/{smsCampaignId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"smsCampaignId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to [assign a phone number to the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVQM1WMW5JD48YNY3J581B).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - SMS Campaign: unassignCampaignPhoneNumber",
|
|
"api_call": "DELETE /phone/sms_campaigns/{smsCampaignId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"smsCampaignId": "[REQUIRED] string",
|
|
"phoneNumberId": "[REQUIRED] string: Provide either phone number (in E164 format) or phoneNumberId of the campaign. "
|
|
},
|
|
"functionality": "Use this API to [unassign a phone number from the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVSPVM8MZN4Y9EW5690QHH).\nRemove the assigned phone number from the campaign.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The campaign must have been previously assigned a Zoom Phone number\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Setting Templates: listSettingTemplates",
|
|
"api_call": "GET /phone/setting_templates",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: Number of records returns within a single API call.",
|
|
"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.",
|
|
"site_id": "string: Unique identifier of the site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) for details. If this is not provided, the response lists the account level setting templates."
|
|
},
|
|
"functionality": "Gets a list of all the created phone template settings.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Setting Templates: addSettingTemplate",
|
|
"api_call": "POST /phone/setting_templates",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Creates a Zoom Phone setting template for an account. After creating a phone template, the defined settings will become the default settings for an account.\n\n**Prerequisites:** \n* A Business or enterprise Zoom account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Setting Templates: getSettingTemplate",
|
|
"api_call": "GET /phone/setting_templates/{templateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"templateId": "[REQUIRED] string: The unique identifier of the template.",
|
|
"custom_query_fields": "string: This field provides the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {“description”: “template description”}."
|
|
},
|
|
"functionality": "Returns information about an account's phone template.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Setting Templates: updateSettingTemplate",
|
|
"api_call": "PATCH /phone/setting_templates/{templateId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"templateId": "[REQUIRED] string: The Template ID."
|
|
},
|
|
"functionality": "Updates or modifies a phone template's settings.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: listPortedNumbers",
|
|
"api_call": "GET /phone/ported_numbers/orders",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Use this API to list ported numbers in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: getPortedNumbersDetails",
|
|
"api_call": "GET /phone/ported_numbers/orders/{orderId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"orderId": "[REQUIRED] string: Order ID of the ported numbers. This can be retrieved from the List Ported Numbers API."
|
|
},
|
|
"functionality": "Use this API to get details on the ported numbers by specifying `order_id`.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom phone license\n\n**Scopes:** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: phoneSetting",
|
|
"api_call": "GET /phone/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Returns an account's settings.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: updatePhoneSettings",
|
|
"api_call": "PATCH /phone/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Updates Zoom Phone [account settings](https://support.zoom.us/hc/en-us/articles/360025846692).\n\n**Prerequisites:** \n* A Business or Enterprise account\n\n**Scopes:** `phone:write:admin`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: listSipGroups",
|
|
"api_call": "GET /phone/sip_groups",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Use this API to list SIP (Session Initiation Protocol) groups.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Settings: listBYOCSIPTrunk",
|
|
"api_call": "GET /phone/sip_trunk/trunks",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "Use this API to return a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf).\n\n**Prerequisites:** \n* A Business or Enterprise account\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Appearance: listSharedLineAppearances",
|
|
"api_call": "GET /phone/shared_line_appearances",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to list [shared line appearance](https://support.zoom.us/hc/en-us/articles/4406753208461-Enabling-or-disabling-shared-lines-privacy-mode) instances.\n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license \n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: listSharedLineGroups",
|
|
"api_call": "GET /phone/shared_line_groups",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Lists all the shared line groups. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This capability gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: createASharedLineGroup",
|
|
"api_call": "POST /phone/shared_line_groups",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Creates a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: getASharedLineGroup",
|
|
"api_call": "GET /phone/shared_line_groups/{sharedLineGroupId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the Shared Line Group."
|
|
},
|
|
"functionality": " Lists all the shared line groups. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: deleteASharedLineGroup",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group that you would like to delete."
|
|
},
|
|
"functionality": "Deletes a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. \n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: updateASharedLineGroup",
|
|
"api_call": "PATCH /phone/shared_line_groups/{slgId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group that is to be updated."
|
|
},
|
|
"functionality": " Updates information of a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. \n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: addMembersToSharedLineGroup",
|
|
"api_call": "POST /phone/shared_line_groups/{slgId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group."
|
|
},
|
|
"functionality": "[Adds members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. Note that a member can only be added to one shared line group. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: deleteMembersOfSLG",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group that you would like to delete."
|
|
},
|
|
"functionality": "Unassigns **all** existing members from a Shared Line Group.Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: deleteAMemberSLG",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group from which you would like to remove a member.",
|
|
"memberId": "[REQUIRED] string: The unique identifier of the member who is to be removed."
|
|
},
|
|
"functionality": "Unassigns **a specific member** from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: assignPhoneNumbersSLG",
|
|
"api_call": "POST /phone/shared_line_groups/{slgId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group."
|
|
},
|
|
"functionality": "Assigns phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: deletePhoneNumbersSLG",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the Shared Line Group."
|
|
},
|
|
"functionality": "Unassigns all the phone numbers that have been assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: deleteAPhoneNumberSLG",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The unique identifier of the shared line group from which you would like to unassign a phone number.",
|
|
"phoneNumberId": "[REQUIRED] string: The unique identifier of the phone number which is to be unassigned. This can be retrieved from Get a Shared Line Group API."
|
|
},
|
|
"functionality": "Unassigns a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: addSLGPolicySubSetting",
|
|
"api_call": "POST /phone/shared_line_groups/{slgId}/policy/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The shared line group ID.",
|
|
"policyType": "[REQUIRED] string: This field corresponds to the policy item you wish to add. Allowed values: `voice_mail`."
|
|
},
|
|
"functionality": "Adds the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to set up shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: removeSLGPolicySubSetting",
|
|
"api_call": "DELETE /phone/shared_line_groups/{slgId}/policy/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The shared line group ID.",
|
|
"policyType": "[REQUIRED] string: This field corresponds to the policy item you wish to remove. Allowed values: `voice_mail`.",
|
|
"shared_ids": "[REQUIRED] array: This field is a comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting."
|
|
},
|
|
"functionality": "Removes the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to remove shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Shared Line Group: updateSLGPolicySubSetting",
|
|
"api_call": "PATCH /phone/shared_line_groups/{slgId}/policy/{policyType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sharedLineGroupId": "[REQUIRED] string: The shared line group ID.",
|
|
"policyType": "[REQUIRED] string: This field corresponds to the policy item you wish to update. Allowed values: `voice_mail`."
|
|
},
|
|
"functionality": "Updates the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to update shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: listPhoneSites",
|
|
"api_call": "GET /phone/sites",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account. \n \n**Prerequisites:** \n \n* Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n* Pro or a higher account with Zoom Phone enabled.\n\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: createPhoneSite",
|
|
"api_call": "POST /phone/sites",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Creates a [site](https://support.zoom.us/hc/en-us/articles/360020809672) that allows you to organize the Zoom Phone users in your organization.\n\n**Prerequisites:**\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n* Pro or a higher account with Zoom Phone enabled.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: getASite",
|
|
"api_call": "GET /phone/sites/{siteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The unique identifier of the site."
|
|
},
|
|
"functionality": "Returns information on a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). Sites allow you to organize Zoom Phone users in your organization. \n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: deletePhoneSite",
|
|
"api_call": "DELETE /phone/sites/{siteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The unique identifier of the site.",
|
|
"transfer_site_id": "[REQUIRED] string: The site ID of another site where the assets of the current site (users, numbers and phones) can be transferred."
|
|
},
|
|
"functionality": " Use this API to delete a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) in a Zoom account. To delete a site, in the query parameter, you must provide the site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license. \n* [Multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) must be enabled.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: updateSiteDetails",
|
|
"api_call": "PATCH /phone/sites/{siteId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The unique identifier of the site."
|
|
},
|
|
"functionality": "Updates information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). It allows you to organize Zoom Phone users in your organization. \n\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: listSiteCustomizeOutboundCallerNumbers",
|
|
"api_call": "GET /phone/sites/{siteId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"selected": "boolean: Status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list",
|
|
"site_id": "string: For filtering phone numbers that belong to the site.",
|
|
"extension_type": "string: The type of the extension to which the phone number belongs.",
|
|
"keyword": "string: A search keyword for phone or extension numbers.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to retrieve phone numbers that can be used as the `site-level` customized outbound caller ID. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: addSiteOutboundCallerNumbers",
|
|
"api_call": "POST /phone/sites/{siteId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID."
|
|
},
|
|
"functionality": "Use this API to add the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: deleteSiteOutboundCallerNumbers",
|
|
"api_call": "DELETE /phone/sites/{siteId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"customize_ids": "array: The customization IDs."
|
|
},
|
|
"functionality": "Use this API to remove the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: getSiteSettingForType",
|
|
"api_call": "GET /phone/sites/{siteId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"settingType": "[REQUIRED] string: The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours` \n* `security` \n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`"
|
|
},
|
|
"functionality": "Sites allow you to organize Zoom Phone users in your organization. Use this API to get site setting about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: addSiteSetting",
|
|
"api_call": "POST /phone/sites/{siteId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"settingType": "[REQUIRED] string: The site setting type: \n* `holiday_hours` \n* `security`."
|
|
},
|
|
"functionality": "Sites allow you to organize Zoom Phone users in your organization. Use this API to add a site setting to a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: deleteSiteSetting",
|
|
"api_call": "DELETE /phone/sites/{siteId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"settingType": "[REQUIRED] string: The site setting type: \n* `holiday_hours` \n* `security`.",
|
|
"device_type": "string: The device type. Enable SRTP AES-256 encryption on the site for the specified device type. Used for `security` setting type.",
|
|
"holiday_id": "string: The holiday hour setting ID. Used for `holiday_hours` setting type."
|
|
},
|
|
"functionality": "Sites allow you to organize Zoom Phone users in your organization. Use this API to delete the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672).\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Sites: updateSiteSetting",
|
|
"api_call": "PATCH /phone/sites/{siteId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"siteId": "[REQUIRED] string: The site ID.",
|
|
"settingType": "[REQUIRED] string: The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`\n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`"
|
|
},
|
|
"functionality": "Sites allow you to organize Zoom Phone users in your organization. Use this API to update the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: listPhoneUsers",
|
|
"api_call": "GET /phone/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"site_id": "string: The unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.",
|
|
"calling_type": "integer: The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of calling plan.",
|
|
"status": "string: The status of the Zoom Phone user. \n\n `pending`: The users have been assigned the Zoom One license, but not been assigned Zoom Phone feature.",
|
|
"department": "string: The department where the user belongs.",
|
|
"cost_center": "string: The cost center where the user belongs.",
|
|
"keyword": "string: The partial string of user's name, extension number, or phone number."
|
|
},
|
|
"functionality": "Returns a list of all of an account's users who are assigned a Zoom Phone license.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: updateUsersPropertiesInBatch",
|
|
"api_call": "PUT /phone/users/batch",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Updates multiple users' properties in batch. For example, you can update the users' [site](https://support.zoom.us/hc/en-us/articles/360020809672) when `batchType` is equal to `move_site`. You can update 10 users at a time. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: batchAddUsers",
|
|
"api_call": "POST /phone/users/batch",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Adds phone users in batch. You can add up to 10 users at a time.\n\n**Prerequisites:**\n* The users must be active in your [Zoom account](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#tag/Users/operation/users). \n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: phoneUser",
|
|
"api_call": "GET /phone/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
|
|
},
|
|
"functionality": "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: updateUserProfile",
|
|
"api_call": "PATCH /phone/users/{userId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
|
|
},
|
|
"functionality": "Updates a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo add, update or remove the shared access members for voicemail and call recordings, use the [Add](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/addUserSetting)/[Update](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/updateUserSetting)/[Delete](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/deleteUserSetting) a user's shared access setting API. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: updateCallingPlan",
|
|
"api_call": "PUT /phone/users/{userId}/calling_plans",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Switches [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: assignCallingPlan",
|
|
"api_call": "POST /phone/users/{userId}/calling_plans",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Assigns a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: unassignCallingPlan",
|
|
"api_call": "DELETE /phone/users/{userId}/calling_plans/{planType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string",
|
|
"type": "[REQUIRED] string: The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)\n",
|
|
"billing_account_id": "string: The billing account ID. If the user is located in India, the parameter is required."
|
|
},
|
|
"functionality": "Unassigns a a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user's [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: listUserCustomizeOutboundCallerNumbers",
|
|
"api_call": "GET /phone/users/{userId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"selected": "boolean: The status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list",
|
|
"site_id": "string: This field filters phone numbers that belong to the site.",
|
|
"extension_type": "string: The type of extension to which the phone number belongs.",
|
|
"keyword": "string: A search keyword for phone or extension numbers.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves phone numbers that can be the `user-level` customized outbound caller ID. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: addUserOutboundCallerNumbers",
|
|
"api_call": "POST /phone/users/{userId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user."
|
|
},
|
|
"functionality": "Adds users' customized outbound caller ID phone numbers. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: deleteUserOutboundCallerNumbers",
|
|
"api_call": "DELETE /phone/users/{userId}/outbound_caller_id/customized_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"customize_ids": "array: The customization IDs."
|
|
},
|
|
"functionality": "Removes the users' customized outbound caller ID phone numbers. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: phoneUserSettings",
|
|
"api_call": "GET /phone/users/{userId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
|
|
},
|
|
"functionality": "Gets the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: updateUserSettings",
|
|
"api_call": "PATCH /phone/users/{userId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
|
|
},
|
|
"functionality": "Updates the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write`,`phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: addUserSetting",
|
|
"api_call": "POST /phone/users/{userId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`"
|
|
},
|
|
"functionality": "Adds the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail, and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Click **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**.\n\n To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Click the **Users** tab and select **User Settings**\n\n **Prerequisites:** \n* A Business or Enterprise account\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: deleteUserSetting",
|
|
"api_call": "DELETE /phone/users/{userId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The unique identifier of the user.",
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to remove. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`",
|
|
"shared_id": "string: This field is required only for voicemail, auto_call_recording, and ad_hoc_call_recording setting type.",
|
|
"assistant_extension_id": "string: This field deletes the delegation assistant, used for delegation setting type.",
|
|
"device_id": "string: This field deletes the assigned device, used for `desk_phone` setting type.",
|
|
"intercom_extension_id": "string: This field deletes the intercom connection for the `intercom` setting type."
|
|
},
|
|
"functionality": "Removes the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Click **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**.\n\n To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Click the **Users** tab and select **User Settings**\n\n **Prerequisites:** \n* A Business or Enterprise account\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Users: updateUserSetting",
|
|
"api_call": "PATCH /phone/users/{userId}/settings/{settingType}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"settingType": "[REQUIRED] string: Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`",
|
|
"userId": "[REQUIRED] string: The unique identifier of the user."
|
|
},
|
|
"functionality": "Updates the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Click **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**.\n\n To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Click the **Users** tab and select **User Settings**\n\n **Prerequisites:** \n* A Business or Enterprise account\n\n**Scopes:** `phone:write:admin`,`phone:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Voicemails: getVoicemailDetailsByCallIdOrCallLogId",
|
|
"api_call": "GET /phone/users/{userId}/call_logs/{id}/voice_mail",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user.",
|
|
"id": "[REQUIRED] string: Gets the unique ID of the call log. You can use `callLogId` or `callId` as path parameters.\n\nYou can find the value for this field with in **[Get account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs)** API or **[Get user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)** API."
|
|
},
|
|
"functionality": "Use this API to return detailed information on a voicemail associated with a call log ID. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**Scopes:** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Voicemails: phoneUserVoiceMails",
|
|
"api_call": "GET /phone/users/{userId}/voice_mails",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"status": "string: Status of the voice mail",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"from": "string: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days.",
|
|
"to": "string: **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
|
|
},
|
|
"functionality": "Use this API to get a user's Zoom Phone voicemails. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read`,`phone:read:admin`,`phone_voicemail:read:admin`,`phone_voicemail:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Voicemails: GetPhoneUserVoiceMails",
|
|
"api_call": "GET /phone/users/{userId}/voice_mails/sync",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"userId": "[REQUIRED] string: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.",
|
|
"sync_type": "[REQUIRED] string: FSync: Full sync \nBSync: Backward sync \nISync: Forward sync",
|
|
"sync_token": "string: Sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync.",
|
|
"count": "integer: Record count of each query."
|
|
},
|
|
"functionality": "Use this API to retrieve a user's Zoom Phone voicemails in descending order. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`,`phone:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Voicemails: updateVoicemailReadStatus",
|
|
"api_call": "PATCH /phone/voice_mails/{voicemailId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"voicemailId": "[REQUIRED] string: The unique identifier of the voicemail. It retrieves the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/phoneUserVoiceMails) API.",
|
|
"read_status": "[REQUIRED] string: The voicemail status. The `Unread` feature must enable **Mark Voicemail as Unread**."
|
|
},
|
|
"functionality": "Updates the status of [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`,`phone:write`,`phone_voicemail:write`,`phone_voicemail:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: listZoomRooms",
|
|
"api_call": "GET /phone/rooms",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned from a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"site_id": "string: The site ID retrievable from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.",
|
|
"calling_type": "integer: The type of calling plan.",
|
|
"keyword": "string: The Zoom room name or phone number from which to filter the results ."
|
|
},
|
|
"functionality": "Retrieves a list of [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) under the account that has the Zoom Phone license assigned.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: addZoomRoom",
|
|
"api_call": "POST /phone/rooms",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to associate a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a Zoom Phone license. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: listUnassignedZoomRooms",
|
|
"api_call": "GET /phone/rooms/unassigned",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"keyword": "string: A search keyword for Zoom Room's name."
|
|
},
|
|
"functionality": "Use this API to retrieve [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) that are not assigned a Zoom Phone.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: getZoomRoom",
|
|
"api_call": "GET /phone/rooms/{roomId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to get a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account that has the Zoom Phone license assigned.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: RemoveZoomRoom",
|
|
"api_call": "DELETE /phone/rooms/{roomId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to remove [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037) from a Zoom Phone account.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: updateZoomRoom",
|
|
"api_call": "PATCH /phone/rooms/{roomId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to update a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account that has the Zoom Phone license assigned.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: assignCallingPlanToRoom",
|
|
"api_call": "POST /phone/rooms/{roomId}/calling_plans",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to assign [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc). Up to 200 numbers at a time.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: unassignCallingPlanFromRoom",
|
|
"api_call": "DELETE /phone/rooms/{roomId}/calling_plans/{type}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string",
|
|
"type": "[REQUIRED] integer: The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to the Zoom Room. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)\n",
|
|
"billing_account_id": "string: The billing account ID. If the zoom room is located in India, the parameter is required."
|
|
},
|
|
"functionality": "Use this API to unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: assignPhoneNumberToZoomRoom",
|
|
"api_call": "POST /phone/rooms/{roomId}/phone_numbers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Use this API to [assign phone numbers to a Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711). Up to 200 numbers at a time.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Phone API - Zoom Rooms: UnassignPhoneNumberFromZoomRoom",
|
|
"api_call": "DELETE /phone/rooms/{roomId}/phone_numbers/{phoneNumberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roomId": "[REQUIRED] string: Provide roomId of the Zoom Room.",
|
|
"phoneNumberId": "[REQUIRED] string: Provide phoneNumberId of the Zoom Room. "
|
|
},
|
|
"functionality": "Use this API to unassign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The Zoom Room must have been previously assigned a Zoom Phone number\n\n**Scopes:** `phone:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Chatbot API - Chatbot Messages: sendChatbot",
|
|
"api_call": "POST /im/chat/messages",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to send messages from your Marketplace Chatbot app. \n\n **Authorization Flow:** Client Credentials Flow \n\n To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. \n\n You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret}`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. \n\n For more information about authorizing Chatbots, read the Chatbot [**Installation and Authentication**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation.\n\n**Scopes:** `imchat:bot`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Chatbot API - Chatbot Messages: editChatbotMessage",
|
|
"api_call": "PUT /im/chat/messages/{message_id}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"message_id": "[REQUIRED] string: The message ID. You can get this value from the [**Send Chatbot message**](/docs/api/rest/reference/chatbot/methods/#operation/sendChatbot) API."
|
|
},
|
|
"functionality": "Use this API to edit a message [sent](/api-reference/chatbot/methods#operation/sendChatbot) by your Chatbot app. \n\n After sending a message via the [**Send Chatbot message**](/api-reference/chatbot/methods#operation/sendChatbot) API, you must store the `messageId` value returned in the API response in order to make edits to the associated message using this API. \n\n **Authorization Flow:** Client Credentials Flow \n\n To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. \n\n You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret}`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. \n\n For more information about authorizing Chatbots, read the Chatbot [**Installation and Authentication**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation.\n\n**Scopes:** `imchat:bot`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Chatbot API - Chatbot Messages: deleteAChatbotMessage",
|
|
"api_call": "DELETE /im/chat/messages/{message_id}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"message_id": "[REQUIRED] string: The message ID. You can get this value from the [**Send Chatbot message**](/docs/api/rest/reference/chatbot/methods/#operation/sendChatbot) API.",
|
|
"account_id": "[REQUIRED] string: The account ID to which the message was sent. You can get this value from the [Chatbot request sent to your server](/docs/team-chat-apps/send-edit-and-delete-messages/#send-messages).",
|
|
"user_jid": "string: The JID of the user on whose behalf the message is being sent. This is used to prevent members of a channel from getting notifications that were set up by a user who has left the channel.",
|
|
"robot_jid": "[REQUIRED] string: The robot JID. This is created when enabling Chatbot features on your Marketplace app."
|
|
},
|
|
"functionality": "Use this API to delete a message sent by your Chatbot app. \n\n **Authorization Flow:** Client Credentials Flow \n\n To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. \n\n You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret}`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. \n\n For more information about authorizing Chatbots, read the Chatbot [**Installation and Authentication**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation.\n\n**Scopes:** `imchat:bot`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Attendee Actions: ListEventAttendeeActions",
|
|
"api_call": "GET /zoom_events/events/{eventId}/attendee_action",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"email": "string: The email of attendee.\n",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300"
|
|
},
|
|
"functionality": "Use this API to retrieve the attendee actions performed by host for an event.\n\n**Scopes:** `zoom_events_attendee_actions:read:admin`,`zoom_events_attendee_actions:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Attendee Actions: UpdateEventAttendeeActions",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/attendee_action",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Use this API to perform attendee onsite action for an event. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation.In the case of a batch operation, the API response can be partial success. Any errors are returned in the **errors** object.\n\n**Scopes:** `zoom_events_attendee_actions:write:admin`,`zoom_events_attendee_actions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Attendee Actions: ListSessionAttendeeActions",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}/attendee_action",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session.",
|
|
"email": "string: The email of attendee.\n",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300"
|
|
},
|
|
"functionality": "Use this API to retrieve the attendee actions performed by host for an event session.\n\n**Scopes:** `zoom_events_attendee_actions:read:admin`,`zoom_events_attendee_actions:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Attendee Actions: UpdateSessionAttendeeActions",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/sessions/{sessionId}/attendee_action",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Use this API to perform attendee onsite action for an event session. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation.In the case of a batch operation, the API response can be partial success. Any errors are returned in the **errors** object.\n\n**Scopes:** `zoom_events_attendee_actions:write:admin`,`zoom_events_attendee_actions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Co Editors: getCoEditors",
|
|
"api_call": "GET /zoom_events/events/{eventId}/coeditors",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Retrieves the list of co-editors and their edit permissions for an event. Co-editors can make changes to the event details. Co-editors have view permission to all sections of the event.\n\n**Scopes:** `zoom_events_coeditors:read:admin`,`zoom_events_coeditors:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: getEvents",
|
|
"api_call": "GET /zoom_events/events",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"role_type": "string: The user role type:\n* `Host` - All hosted events.\n* `Attendee` - All non-hosted ticketed events.",
|
|
"event_status_type": "string: The type of event status:\n* `Upcoming` - All upcoming events.\n* `Past` - All past events.\n* `Draft` - All events marked as draft.\n* `Cancelled` - All cancelled events.\n\nFor the `ATTENDEE` role type, only `upcoming` and `past` are valid status types. As a `HOST`, all status types are valid.",
|
|
"page_size": "integer: The number of records returned in a single API call. The maximum is 300.",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves all events associated with the user.\n\n\n\n**Scopes:** `zoom_events_basic:read`,`zoom_events_basic:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: createEvent",
|
|
"api_call": "POST /zoom_events/events",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Creates an event.\n\n**Scopes:** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: getEventInfo",
|
|
"api_call": "GET /zoom_events/events/{eventId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Returns information on a specified event.\n\n \n\n**Scopes:** `zoom_events_basic:read`,`zoom_events_basic:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: deleteEvent",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Delete a draft event.\n\n**Scopes:** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: updateEvent",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Updates an event.\n\n**Scopes:** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Events: EventActions",
|
|
"api_call": "POST /zoom_events/events/{eventId}/event_actions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Updates the event actions that the host performs for an event.\n\n**Scopes:** `zoom_events_basic:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: getExhibitors",
|
|
"api_call": "GET /zoom_events/events/{eventId}/exhibitors",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Lists all exhibitors associated with an event.\n\n\n\n**Scopes:** `zoom_events_exhibitors:read`,`zoom_events_exhibitors:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: createExhibitor",
|
|
"api_call": "POST /zoom_events/events/{eventId}/exhibitors",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Use this API to create an exhibitor for an event.\n\n**Scopes:** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: getExhibitorInfo",
|
|
"api_call": "GET /zoom_events/events/{eventId}/exhibitors/{exhibitorId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"exhibitorId": "[REQUIRED] string: The ID of the exhibitor."
|
|
},
|
|
"functionality": "Returns the exhibitor information of a specified event.\n\n \n\n**Scopes:** `zoom_events_exhibitors:read`,`zoom_events_exhibitors:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: deleteExhibitor",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}/exhibitors/{exhibitorId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"exhibitorId": "[REQUIRED] string: The ID of the exhibitor."
|
|
},
|
|
"functionality": "Deletes an exhibitor.\n\n\n\n**Scopes:** `zoom_events_exhibitors:write:admin`,`zoom_events_exhibitors:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: updateExhibitor",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/exhibitors/{exhibitorId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"exhibitorId": "[REQUIRED] string: The ID of the exhibitor."
|
|
},
|
|
"functionality": "Updates the exhibitor for an event ID. This operation is only allowed for multi session event type.\n\n**Scopes:** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Exhibitors: ListSponsorTiers",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sponsor_tiers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Lists all sponsor tiers associated with an event.\n\n\n**Scopes:** `zoom_events_exhibitors:read`,`zoom_events_exhibitors:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Hubs: getHubList",
|
|
"api_call": "GET /zoom_events/hubs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"role_type": "[REQUIRED] string: The user role type:\n* `Host` — All hosted Hubs.\n* `Attendee` — All related Hubs."
|
|
},
|
|
"functionality": "Retrieve a list of event hubs.\n\n**Scopes:** `zoom_events_hubs:read:admin`,`zoom_events_hubs:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Registrants: getRegistrants",
|
|
"api_call": "GET /zoom_events/events/{eventId}/registrants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves event registrants.\n\n**Scopes:** `zoom_events_registrants:read:admin`,`zoom_events_registrants:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Registrants: getSessionAttendeeList",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}/attendees",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves session attendees.\n\n**Scopes:** `zoom_events_registrants:read:admin`,`zoom_events_registrants:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Reports: ChatTranscriptsReport",
|
|
"api_call": "GET /zoom_events/events/{eventId}/reports/chat_transcripts",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "string: The event ID.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300.",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves chat transcripts report for an event. \n Please note at this present time, this API returns data only for users who enabled [meeting and webinar cloud archiving feature](https://support.zoom.us/hc/en-us/articles/360061037572-Configuring-archival-settings-for-meetings-and-webinars). \n Whether users can download in-meeting, private 1:1 and private group chats depends on the meeting and webinar cloud archiving feature. \n Below chat types data is returned based on the event type and the archiving feature. \n * `If cloud archiving is enabled`: \n **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat, Private 1: 1 Chat, Private Group Chat, In-meeting and webinar Chat . \n **For single session & recurring events** - In-meeting or webinar Chat. \n * `If cloud archiving is not enabled` :\n **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat. \n **For single session & recurring events** - None. \n \n\n**Scopes:** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Reports: EventAttendanceReport",
|
|
"api_call": "GET /zoom_events/events/{eventId}/reports/event_attendance",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves event attendance report.\n\n**Scopes:** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Reports: EventSurveyReportApi",
|
|
"api_call": "GET /zoom_events/events/{eventId}/reports/survey",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "string: The ID of the event.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to retrieve Event and session survey information\n\n**Scopes:** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Reports: EventRegistrationsReport",
|
|
"api_call": "GET /zoom_events/events/{eventId}/reports/ticket_registration",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
|
|
},
|
|
"functionality": "Retrieves event ticket registrations.\n\n**Scopes:** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: getEventSessionList",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Retrieves the sessions in an event.\n\n**Scopes:** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: createEventSession",
|
|
"api_call": "POST /zoom_events/events/{eventId}/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Creates a session. This operation is not available for single session event type.\n\n**Scopes:** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: getEventSessionInfo",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Returns the session information.\n\n\n\n**Scopes:** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: deleteEventSession",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Delete a session. This API is not allowed for single session event type.\n\n**Scopes:** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: updateEventSession",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Updates an existing session in an event. \n\n**Scopes:** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: getSessionInterpreterList",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}/interpreters",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Retrieves interpreters in a session.\n\n**Scopes:** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: updateSessionInterpreters",
|
|
"api_call": "PUT /zoom_events/events/{eventId}/sessions/{sessionId}/interpreters",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Use this API to create or update the list of interpreters for the session.\n\n\n\n**Scopes:** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: getSessionJoinToken",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}/join_token",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Retrieves the join token to join an event session.\n\n\n\n**Scopes:** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: getSessionPolls",
|
|
"api_call": "GET /zoom_events/events/{eventId}/sessions/{sessionId}/polls",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "List all the polls of a session.\n\n\n\n**Scopes:** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Sessions: updateSessionPolls",
|
|
"api_call": "PUT /zoom_events/events/{eventId}/sessions/{sessionId}/polls",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"sessionId": "[REQUIRED] string: The ID of the session."
|
|
},
|
|
"functionality": "Create or update the list of polls for the session.\n\n**Scopes:** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Speakers: getSpeakers",
|
|
"api_call": "GET /zoom_events/events/{eventId}/speakers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Retrieves a list of speakers for an event.\n\n**Scopes:** `zoom_events_speakers:read:admin`,`zoom_events_speakers:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Speakers: createSpeaker",
|
|
"api_call": "POST /zoom_events/events/{eventId}/speakers",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Creates a speaker for an event.\n\n**Scopes:** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Speakers: getSpeaker",
|
|
"api_call": "GET /zoom_events/events/{eventId}/speakers/{speakerId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"speakerId": "[REQUIRED] string: The ID of the speaker."
|
|
},
|
|
"functionality": "Returns information on a specific speaker.\n\n\n\n**Scopes:** `zoom_events_speakers:read:admin`,`zoom_events_speakers:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Speakers: deleteSpeaker",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}/speakers/{speakerId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"speakerId": "[REQUIRED] string: The ID of the speaker."
|
|
},
|
|
"functionality": "Deletes a speaker.\n\n\n\n**Scopes:** `zoom_events_speakers:write:admin`,`zoom_events_speakers:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Speakers: updateSpeaker",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/speakers/{speakerId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"speakerId": "[REQUIRED] string: The ID of the speaker."
|
|
},
|
|
"functionality": "Updates the speaker information.\n\n**Scopes:** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: getRegistrationQuestionsForEvent",
|
|
"api_call": "GET /zoom_events/events/{eventId}/questions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "List registration questions and fields that are to be answered by users while registering for an event. These questions are setup during the event level.\n\n**Scopes:** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: updateRegistrationQuestionsForEvent",
|
|
"api_call": "PUT /zoom_events/events/{eventId}/questions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at event level.\n\n**Scopes:** `zoom_events_ticket_types:write:admin`,`zoom_events_ticket_types:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: getEventTicketTypes",
|
|
"api_call": "GET /zoom_events/events/{eventId}/ticket_types",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Lists all ticket types associated with an event.\n\n\n\n**Scopes:** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: createTicketType",
|
|
"api_call": "POST /zoom_events/events/{eventId}/ticket_types",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Creates a ticket type for the event ID. This API is not allowed for single session and recurring event type.\n\n**Scopes:** `zoom_events_ticket_types:write:admin`,`zoom_events_ticket_types:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: deleteEventTicketType",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketTypeId": "[REQUIRED] string: The ID of the ticket type."
|
|
},
|
|
"functionality": "Deletes a ticket type of an event. This API is not allowed for single session event type.\n\n**Scopes:** `zoom_events_ticket_types:write:admin`,`zoom_events_ticket_types:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: updateTicketType",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketTypeId": "[REQUIRED] string: The ID of the ticket type."
|
|
},
|
|
"functionality": "Updates the ticket type for an event ID. This API is not allowed for single session event type.\n\n**Scopes:** `zoom_events_ticket_types:write:admin`,`zoom_events_ticket_types:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: getRegistrationQuestionsForTicketType",
|
|
"api_call": "GET /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}/questions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketTypeId": "[REQUIRED] string: The ID of the ticket type."
|
|
},
|
|
"functionality": "List registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level.\n\n**Scopes:** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Ticket Types: updateRegistrationQuestionsForTicketType",
|
|
"api_call": "PUT /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}/questions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketTypeId": "[REQUIRED] string: The ID of the ticket type."
|
|
},
|
|
"functionality": "Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level. This API is not allowed for single session event type.\n\n**Scopes:** `zoom_events_ticket_types:write:admin`,`zoom_events_ticket_types:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Tickets: getTickets",
|
|
"api_call": "GET /zoom_events/events/{eventId}/tickets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"external_ticket_id": "string: The ID of the external ticket.",
|
|
"email": "string: The email of registrant.\n",
|
|
"ticket_type_id": "string: The ID of the ticket type.",
|
|
"next_page_token": "string: The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"page_size": "integer: The number of records returned in a single API call. Max 300"
|
|
},
|
|
"functionality": "Retrieves the ticket information of an event.\n\n**Scopes:** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Tickets: createTickets",
|
|
"api_call": "POST /zoom_events/events/{eventId}/tickets",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event."
|
|
},
|
|
"functionality": "Create tickets for an event. You can add a single ticket or up to 30 tickets in a batch operation. Please note that this request uses the `pre-registration`(https://support.zoom.us/hc/en-us/articles/13475985512973-Pre-registering-Zoom-Events-guests) flow. \n\n**Scopes:** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Tickets: getTicketDetails",
|
|
"api_call": "GET /zoom_events/events/{eventId}/tickets/{ticketId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketId": "[REQUIRED] string: The ID of the registered ticket."
|
|
},
|
|
"functionality": "Retrieves information on a specific ticket.\n\n**Scopes:** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Tickets: deleteTicket",
|
|
"api_call": "DELETE /zoom_events/events/{eventId}/tickets/{ticketId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "[REQUIRED] string: The ID of the event.",
|
|
"ticketId": "[REQUIRED] string: The ID of the registered ticket."
|
|
},
|
|
"functionality": "Use this API to delete a ticket.\n\n\n\n**Scopes:** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Events API - Tickets: Updateticket",
|
|
"api_call": "PATCH /zoom_events/events/{eventId}/tickets/{ticketId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"eventId": "string: The ID of the event.",
|
|
"ticketId": "string: The ID of the ticket."
|
|
},
|
|
"functionality": "Update ticket questions for the given ticket ID and event ID.\n\n**Scopes:** `zoom_events_tickets:write`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingsList",
|
|
"api_call": "GET /videosdk/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"trash": "boolean: Query trash.\n`true`: List recordings from trash. \n `false`: Do not list recordings from the trash. \n The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve. ",
|
|
"trash_type": "string: The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following: \n \n `session_recordings`: List all session recordings from the trash. \n \n `recording_file`: List all individual recording files from the trash. ",
|
|
"from": "string: The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the `from` and `to` parameters, by default the value of `from` field will be "2020-06-30" and the value of the `to` field will be "2020-07-01". \n\n**Note**: Files designated as trash cannot be filtered by date range and thus, the `from` and `to` fields should not be used for files designated as trash.",
|
|
"to": "string: End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format. "
|
|
},
|
|
"functionality": "List **Video SDK Cloud Recordings** available on an Account.\n\n> To access a password protected cloud recording, add an `access_token` parameter to the download URL and provide your [Video SDK API JWT](https://developers.zoom.us/docs/video-sdk/auth/#generate-a-video-sdk-jwt) as the value of the `access_token`.\n \n \n\n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingGet",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"include_fields": "string: Get the `download_access_token` field for downloading session recordings.",
|
|
"ttl": "integer: Time to live (TTL) of the `download_access_token`. This is only valid if the `include_fields` query parameter contains `download_access_token`. The range is between 0-604800."
|
|
},
|
|
"functionality": "Get all the **recordings** from a session instance. The recording files can be downloaded via the `download_url` property listed in the response.\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingDelete",
|
|
"api_call": "DELETE /videosdk/sessions/{sessionId}/recordings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"action": "string: The recording delete actions: \n `trash` - Move recording to trash. \n `delete` - Delete recording permanently."
|
|
},
|
|
"functionality": "Delete all recording files of a session. \n \n \n\n **Prerequisites**:\n* Cloud Recording should be enabled on the user's account. \n \n\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingStatusUpdate",
|
|
"api_call": "PUT /videosdk/sessions/{sessionId}/recordings/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Zoom allows users to recover recordings from trash for up to 30 days from the deletion date.\n \n **Prerequisites**: \n \n* Video SDK account with Cloud Recording enabled.\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingDeleteOne",
|
|
"api_call": "DELETE /videosdk/sessions/{sessionId}/recordings/{recordingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"recordingId": "[REQUIRED] string: The recording ID.",
|
|
"action": "string: The recording delete actions: \n `trash` - Move recording to trash. \n `delete` - Delete recording permanently."
|
|
},
|
|
"functionality": "Delete a specific recording file from a session. **Note:** To use this API, you must enable the **The host can delete cloud recordings** setting.\n\n\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Cloud Recording: recordingStatusUpdateOne",
|
|
"api_call": "PUT /videosdk/sessions/{sessionId}/recordings/{recordingId}/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"recordingId": "[REQUIRED] string: The recording ID."
|
|
},
|
|
"functionality": "Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the session. \n \n \n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessions",
|
|
"api_call": "GET /videosdk/sessions",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: The type of session to query:\n* `past` — A past session that occurred during the specified date range.\n* `live` — A live sessions.\n\nThis parameter defaults to `live`.",
|
|
"from": "[REQUIRED] string: The start date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"to": "[REQUIRED] string: The end date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"session_key": "string: A value that identifies the session. See [Video SDK Authorization session payload](https://developers.zoom.us/docs/video-sdk/auth/#payload) for details.",
|
|
"session_name": "string: The session's name."
|
|
},
|
|
"functionality": "Use this API to display the total live or past sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months.\n\nThe response displays whether features such as audio, video, screen sharing, and recording were used during the session.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionDetail",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"type": "string: The session types: \n* `past` — A past session. \n* `live` — A live session.\n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Use this API to return information about live or past sessions. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months.\n\nThe overview response displays whether features such as audio, video, screen sharing, and recording were used during the session.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: inSessionEventsControl",
|
|
"api_call": "PATCH /videosdk/sessions/{sessionId}/events",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Use this API to control in-session events such as the **recording controls** to start a recording, stop a recording, pause a recording, and resume a recording, and **invitation control** to invite participants. The recording controls only work for cloud recordings and not for local recordings.\n\n\n**Prerequisite:**\n* The session must be a live session.\n* Cloud recording must be enabled for recording controls.\n* The user using this API must either be the host or alternative host of the session.\n\n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: getLiveStreamDetails",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/livestream",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Use this API to return a session's live stream configuration details, such as the stream's URL, key, and page URL.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionLiveStreamUpdate",
|
|
"api_call": "PATCH /videosdk/sessions/{sessionId}/livestream",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Use this API to update a session's live stream information.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionLiveStreamStatusUpdate",
|
|
"api_call": "PATCH /videosdk/sessions/{sessionId}/livestream/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Use this API to update a session's live stream status.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionStatus",
|
|
"api_call": "PUT /videosdk/sessions/{sessionId}/status",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value."
|
|
},
|
|
"functionality": "Use this API to update a session's status.\n\n**Prerequisites:** \n* A Video SDK account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionUsers",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/users",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"type": "string: The session types: \n* `past` — A past session. \n* `live` — A live session.\n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Use this API to return a list of users from live or past sessions. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months.\n\n* If you do **not** provide the `type` query parameter, the API defaults to the `live` value and the API will only return metrics for users in a live session, if a session is currently in progress.\n* To view metrics on past session users, provide the `past` value for the `type` query parameter.\n\n**Prerequisites:** \n* A Video SDK account.\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionUsersQOS",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/users/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"type": "string: The session types: \n* `past` — A past session. \n* `live` — A live session.\n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"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."
|
|
},
|
|
"functionality": "Use this API to return a list of session users from live or past sessions along with the quality of service (QoS) they received during the session. For example, connection quality for sending and receiving video, audio, and shared content. You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.\n\n* If you do **not** provide the `type` query parameter, the API defaults to the `live` value and the API will only return metrics for users in a live session, if a session is currently in progress.\n* To view metrics on past session users, provide the `past` value for the `type` query parameter.\n\n**Prerequisites:** \n* A Video SDK Account\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionParticipantShare",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/users/sharing",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"type": "string: The session types: \n* `past` — A past session. \n* `live` — A live session.\n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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."
|
|
},
|
|
"functionality": "Retrieve the sharing and recording details of participants from live or past sessions. \n \n **Prerequisites:** \n \n* A Video SDK Account.\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Sessions: sessionUserQOS",
|
|
"api_call": "GET /videosdk/sessions/{sessionId}/users/{userId}/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"sessionId": "[REQUIRED] string: The session's ID. If the ID begins with a `/` character or contains `//` characters, you must **double-encode** the ID value.",
|
|
"userId": "[REQUIRED] string: The user's ID.",
|
|
"type": "string: The session types: \n* `past` — A past session. \n* `live` — A live session.\n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Use this API to retrieve the quality of service (QoS) for users from live or past sessions. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.\n* This API will **not** return data if there is no data being sent or received at the time of request.\n\n\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Video SDK Reports: vsdkReportCloudRecording",
|
|
"api_call": "GET /videosdk/report/cloud_recording",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: The start date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"to": "[REQUIRED] string: The end date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data."
|
|
},
|
|
"functionality": "Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for up to 6 months prior to the current date. The date gap between from and to dates should be smaller or equal to 30 days. \n \n \n**Prerequisites** \n \n* A Video SDK account. \n \n \n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Video SDK Reports: vsdkReportDaily",
|
|
"api_call": "GET /videosdk/report/daily",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"year": "integer: Year for this report.",
|
|
"month": "integer: Month for this report."
|
|
},
|
|
"functionality": "Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of sessions, users, and session minutes. \n \n**Prerequisites** \n \n* A Video SDK account. \n \n \n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Video SDK Reports: vsdkReportOperationLogs",
|
|
"api_call": "GET /videosdk/report/operationlogs",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: The start date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"to": "[REQUIRED] string: The end date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"category_type": "string"
|
|
},
|
|
"functionality": "The operations logs report allows you to audit admin and user activity, such as changing account settings, and deleting recordings. \n Use this API to retrieve operation logs report for a specified period of time. See [Using Admin Activity Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) for similar usage in Zoom Meetings. \n \n \n**Prerequisites** \n \n* A Video SDK account. \n \n \n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Video SDK API - Video SDK Reports: vsdkReportTelephone",
|
|
"api_call": "GET /videosdk/report/telephone",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: The start date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"to": "[REQUIRED] string: The end date to query, in `yyyy-mm-dd` format.\n\nThe ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"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.",
|
|
"type": "string: Audio types: \n `1` - Toll-free Call-in & Call-out. \n `2` - Toll \n \n`3` - SIP Connected Audio",
|
|
"query_date_type": "string: The type of date to query: \n* `start_time` — Query by call start time. \n* `end_time` — Query by call end time. \n* `session_start_time` — Query by session start time. \n* `session_end_time` — Query by session end time. \n\nThis value defaults to `start_time`."
|
|
},
|
|
"functionality": "The telephone report allows you to view who dialed into sessions via phone (Audio Conferencing or SIP Connected Audio), which number they dialed into, and other details. Use this API to get the telephone report for a specified period of time. See [Accessing audio conferencing reports](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) for similar usage in Zoom Meetings. \n \n \n**Prerequisites** \n \n* A Video SDK account. \n \n \n \n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: getAccountLockSettings",
|
|
"api_call": "GET /accounts/{accountId}/lock_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string",
|
|
"option": "string: Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.",
|
|
"custom_query_fields": "string: Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: \n \n{\n "schedule_meeting": {\n "host_video": false\n }\n}\n \n You can provide multiple values by separating them with commas(example: "host_video,participant_video”)."
|
|
},
|
|
"functionality": "Retrieve an account's locked settings. \n\n Account admins and account owners can use [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) to toggle settings on or off for all users in their account. \n\n\n**Note:** You can use Account Locked Settings with accounts that have master and sub accounts enabled. \n \n \n**Prerequisites:**\n* Pro or a higher paid account. \n \n\n\n\n**Scopes:** `account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: UpdateLockedSettings",
|
|
"api_call": "PATCH /accounts/{accountId}/lock_settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string"
|
|
},
|
|
"functionality": "Update an account's locked settings.\n\n[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allows account admins and account owners to toggle settings on or off for all users in your account. \n\n**Note:** Yout must have a Pro or a higher plan and enabled master and sub accounts options. \n \n \n**Prerequisites:** \n \n* Pro or a higher paid account. \n \n\n\n\n**Scopes:** `account:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountManagedDomain",
|
|
"api_call": "GET /accounts/{accountId}/managed_domains",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "[REQUIRED] string: The account's ID. For master accounts, pass the `me` value for this parameter."
|
|
},
|
|
"functionality": "Retrieve a list of an account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the master account's managed domains, pass the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* A Pro or a higher paid account with the Master account option enabled.\n\n**Scopes:** `account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: UpdateTheAccountOwner",
|
|
"api_call": "PUT /accounts/{accountId}/owner",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string"
|
|
},
|
|
"functionality": "Change an account's owner.\n\nAn account's current owner can [change the account's owner](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.\n\n**Prerequisites:** \n* An account owner or admin permissions of an account \n* The account making this API request must be on a Pro or a higher account plan with [Master account](https://developers.zoom.us/docs/api/rest/master-account-apis/) privileges\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountSettings",
|
|
"api_call": "GET /accounts/{accountId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string",
|
|
"option": "string: Optional query parameters. \n* `meeting_authentication` - View the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` - View the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `security` - View the account's security settings. For example, passcode requirements for user login or two-factor authentication. \n* `meeting_security` - View the meeting security settings applied to the user's account.",
|
|
"custom_query_fields": "string: The name of the field to use to filter the response. For example, if you provide the `host_video` value for this field, you will get a response similar to. \n\n `{ schedule_meeting: { host_video: false } }` \n\n To use multiple values, comma-separate each value, like `host_video,participant_video`."
|
|
},
|
|
"functionality": "Get an account's settings. \n\nTo get settings for a master account, use the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountSettingsUpdate",
|
|
"api_call": "PATCH /accounts/{accountId}/settings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string",
|
|
"option": "string: Optional query parameters. \n* `meeting_authentication` - View the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` - View the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `security` - View the account's security settings. For example, passcode requirements for user login or two-factor authentication. \n* `meeting_security` - View the meeting security settings applied to the user's account."
|
|
},
|
|
"functionality": "Update an account's settings. \nTo update the settings for a master account, pass the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountSettingsRegistration",
|
|
"api_call": "GET /accounts/{accountId}/settings/registration",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "[REQUIRED] string: The account's ID. For master accounts, pass the `me` value for this parameter.",
|
|
"type": "string: The registration's type.\n* `webinar` — webinar."
|
|
},
|
|
"functionality": "Get an account's webinar registration settings. To get the master account's webinar registration settings, use the `me` value for the `accountId` path parameter. \n\n**Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountSettingsRegistrationUpdate",
|
|
"api_call": "PATCH /accounts/{accountId}/settings/registration",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "[REQUIRED] string: The account's ID. For master accounts, pass the `me` value for this parameter.",
|
|
"type": "string: The registration's type.\n* `webinar` — webinar."
|
|
},
|
|
"functionality": "Update an account's webinar registration settings. To update the master account's webinar registration settings, pass the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: uploadVB",
|
|
"api_call": "POST /accounts/{accountId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string"
|
|
},
|
|
"functionality": "[Upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users on the account to use. \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `account:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: delVB",
|
|
"api_call": "DELETE /accounts/{accountId}/settings/virtual_backgrounds",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "string",
|
|
"file_ids": "string: A comma-separated list of file IDs to delete."
|
|
},
|
|
"functionality": "Delete an account's existing virtual background files. \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.\n\n**Scopes:** `account:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Accounts: accountTrustedDomain",
|
|
"api_call": "GET /accounts/{accountId}/trusted_domains",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"accountId": "[REQUIRED] string: The account's ID. For master accounts, pass the `me` value for this parameter."
|
|
},
|
|
"functionality": "Retrieve an account's [trusted domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the master account's trusted domains, use the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**Scopes:** `account:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardChat",
|
|
"api_call": "GET /metrics/chat",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) for how users are utilizing Zoom Chat to send messages.\n\nUse the `from` and `to` query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.\n\n> **Note:** To query chat metrics from July 1, 2021 and later, use this endpoint instead of the [**Get IM metrics**](/docs/api-reference/zoom-api/methods#operation/dashboardIM) API.\n\n**Prerequisites:**\n\n* Business or a higher plan\n\n**Scopes:** `dashboard_im:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardClientFeedback",
|
|
"api_call": "GET /metrics/client/feedback",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date."
|
|
},
|
|
"functionality": "Use this API to return [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf) survey results. You can specify a monthly date range for the Dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. \n\n**Prerequisites:** \n* A Business or higher account. \n* The "[**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023)" option enabled.\n\n**Scopes:** `dashboard_home:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardClientFeedbackDetail",
|
|
"api_call": "GET /metrics/client/feedback/{feedbackId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"feedbackId": "[REQUIRED] string: Feedback Detail Id",
|
|
"from": "string",
|
|
"to": "string",
|
|
"page_size": "integer",
|
|
"next_page_token": "string"
|
|
},
|
|
"functionality": "Retrieve detailed information on a [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). \n You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.\n\n**Prerequisites:**\n* Business or higher account\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled.\n\n\n\n**Scopes:** `dashboard_home:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: listMeetingSatisfaction",
|
|
"api_call": "GET /metrics/client/satisfaction",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "string: The start date for the query in “yyyy-mm-dd” format. ",
|
|
"to": "string: The end date for the query in “yyyy-mm-dd” format. "
|
|
},
|
|
"functionality": "If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months.\n\nTo get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [**Get Zoom meetings client feedback**](/docs/api-reference/zoom-api/methods#operation/dashboardClientFeedbackDetail) API. \n \n\n\n**Scopes:** `dashboard:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: getClientVersions",
|
|
"api_call": "GET /metrics/client_versions",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Use this API to list all the client versions and its count. \n\n **Prerequisites:** \n* A Business or a higher plan.\n\n**Scopes:** `dashboard:read:admin,dashboard_home:read:admin,zms:dashboard:read`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardCRC",
|
|
"api_call": "GET /metrics/crc",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date."
|
|
},
|
|
"functionality": "A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. \n\nUse this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".</aside> \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan.\n* Room Connector must be enabled on the account. \n \n \n\n\n**Scopes:** `dashboard_crc:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardIssueZoomRoom",
|
|
"api_call": "GET /metrics/issues/zoomrooms",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date."
|
|
},
|
|
"functionality": "Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and "to" range should fall within the last six months. \n \n**Prerequisites:** \n \n* Business or a higher plan.\n* Zoom Room must be enabled in the account.\n\n**Scopes:** `dashboard_home:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardIssueDetailZoomRoom",
|
|
"api_call": "GET /metrics/issues/zoomrooms/{zoomroomId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"zoomroomId": "[REQUIRED] string: The Zoom room ID.",
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. You can specify a monthly date range for the Dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. \n\n**Prerequisites:** \n* A Business or a higher plan. \n* A Zoom Room must be enabled in the account.\n\n**Scopes:** `dashboard_home:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetings",
|
|
"api_call": "GET /metrics/meetings",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: A value to get the response for the corresponding meeting type. \n \n `past` - Meetings that already occurred in the specified date range. \n `pastOne` - Past meetings that were attended by only one user. \n `live` - Live meetings. \n \n \n\nIf you do not provide this field, the default value will be `live` and the API will only query responses for live meetings.",
|
|
"from": "[REQUIRED] string: The start date in 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format. The date range defined by the `from` and `to` parameters should only be one month, as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"group_id": "string: The group ID. To get a group ID, use the [**List groups**](/api-reference/zoom-api/methods#operation/groups) API. \n\n **Note:** The API response will only contain meetings where the host is a member of the queried group ID if the "group_include_participant" is false.",
|
|
"group_include_participant": "boolean: Whether the response will contain meetings where the participant is a member of the queried group ID.",
|
|
"include_fields": "string: Set the value of this field to `tracking_fields` if you want to include tracking fields of each meeting in the response.",
|
|
"query_date_type": "string: The type of date to query. This field is only supported when `type` is `past`. \n* `start_time` - Query by call start time. \n* `end_time` - Query by call end time. \n\nThis value defaults to `start_time`."
|
|
},
|
|
"functionality": "Lists the total live or past meetings that occurred during a specified period of time. This overview shows if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account. Specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites:** * Business or a higher plan. \n\n**Scopes:** `dashboard_meetings:read:admin`,`dashboard:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetingDetail",
|
|
"api_call": "GET /metrics/meetings/{meetingId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] string: The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.",
|
|
"type": "string: The type of meeting to query: \n* `past` — All past meetings. \n* `pastOne` — All past one-user meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account. \n You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. \n \n**Prerequisites:** \n \n* Business or a higher plan.\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetingParticipants",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] string: The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API returns a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.",
|
|
"type": "string: The type of meeting to query. \n* `past` - All past meetings. \n* `pastOne` - All past one-user meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"include_fields": "string: This field provides `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. \n\nA registrant ID is a unique identifier of a [meeting registrant](/docs/api-reference/zoom-api/methods#operation/meetingRegistrants), which is not supported for `live` meeting types."
|
|
},
|
|
"functionality": "Return a list of participants from live or past meetings. \n If you don't provide the `type` query parameter, the default value is set to the `live` value. This API only returns metrics for participants in a live meeting, if any exist. You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](/docs/api-reference/other-references/legacy-business-associate-agreements). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](/docs/api-reference/using-zoom-apis#email-address) for details. \n\n**Prerequisites:** \n* A Business or higher plan.\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetingParticipantsQOS",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] string: The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.",
|
|
"type": "string: The type of meeting to query. \n* `past` - All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API. \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business or a higher plan.\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: participantFeedback",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants/satisfaction",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] : The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.",
|
|
"type": "string: Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: \n \n `past` - Meeting that already occurred in the specified date range. \n `pastOne` - Past meetings that were attended by only one user. \n `live` - Live meetings. \n \n \n\nIf you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020.\n\n**Prerequisites:**\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.\n* The user making the API request must be enrolled in a Business or a higher plan.\n\n \n \n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetingParticipantShare",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants/sharing",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] : The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.",
|
|
"type": "string: The type of meeting to query: \n* `past` — All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceed the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Retrieve the sharing and recording details of participants from live or past meetings. \n \n**Prerequisites:** \n \n* Business or a higher plan.\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardMeetingParticipantQOS",
|
|
"api_call": "GET /metrics/meetings/{meetingId}/participants/{participantId}/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"meetingId": "[REQUIRED] string: The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.",
|
|
"participantId": "[REQUIRED] string: The participant's ID.",
|
|
"type": "string: The type of meeting to query. \n* `past` - All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Return the quality of service (QoS) report for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. \n\nWhen the sender sends data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. \n\n This API will **not** return data if there is no data being sent or received at the time of request. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n\n\n**Scopes:** `dashboard_meetings:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardQuality",
|
|
"api_call": "GET /metrics/quality",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date.",
|
|
"type": "string: The type of meeting quality score to query: \n* `meeting` — Query by meetings. \n* `participants` — Query by meeting participants."
|
|
},
|
|
"functionality": "Use this API to return [meeting quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Meeting-quality-scores-and-network-alerts-on-Dashboard) information. Meeting quality scores are based on the mean opinion score (MOS). The MOS measures a meeting's quality on a scale of "Good" (5-4), "Fair" (4-3), "Poor" (3-2), or "Bad" (2-1). \n\n**Prerequisites:** \n* A Business or a higher plan.\n\n**Scopes:** `dashboard_home:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinars",
|
|
"api_call": "GET /metrics/webinars",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.",
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"group_id": "string: The group ID. To get a group ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. \n\n **Note:** The API response will only contain meetings where the host is a member of the queried group ID."
|
|
},
|
|
"functionality": "List all the live or past webinars from a specified period of time. \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinarDetail",
|
|
"api_call": "GET /metrics/webinars/{webinarId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the webinar UUID before making an API request.",
|
|
"type": "string: The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Retrieve details from live or past webinars. \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinarParticipants",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API returns a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.",
|
|
"type": "string: The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.",
|
|
"include_fields": "string: The additional fields to include in the query. \n* `registrant_id` - Includes the webinar registrant's ID. The registrant ID is the [webinar registrant's unique ID](/docs/api-reference/zoom-api/methods#operation/webinarRegistrants)."
|
|
},
|
|
"functionality": "Returns information about participants from live or past webinars. \nDisplays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Note:** This API might return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calls this API. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on.\n\n* Any [**legacy** HIPAA BAA account](/docs/api-reference/other-references/legacy-business-associate-agreements). \n* No signed HIPAA business associate agreement (BAA).\n\n\n\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinarParticipantsQOS",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.",
|
|
"type": "string: The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of items returned per page.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Show a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on.\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: participantWebinarFeedback",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants/satisfaction",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: \n \n `past` - Meeting that already occurred in the specified date range. \n `pastOne` - Past meetings that were attended by only one user. \n `live` - Live meetings. \n \n \n\nIf you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the webinar UUID before making an API request."
|
|
},
|
|
"functionality": "When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020.\n\n**Prerequisites:**\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.\n* The user making the API request must be enrolled in a Business or a higher plan.\n\n\n \n \n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinarParticipantShare",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants/sharing",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the webinar UUID before making an API request.",
|
|
"type": "string: The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceed the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "Retrieve the sharing and recording details of participants from live or past webinars. \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardWebinarParticipantQOS",
|
|
"api_call": "GET /metrics/webinars/{webinarId}/participants/{participantId}/qos",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"webinarId": "[REQUIRED] string: The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.",
|
|
"participantId": "[REQUIRED] string: The participant's ID.",
|
|
"type": "string: The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`."
|
|
},
|
|
"functionality": "Return the quality of service (QoS) for participants during live or past webinars. This data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. \n\nWhen the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. \n\nThis API will **not** return data if there is no data being sent or received at the time of request. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Zoom Rooms set up.\n\n**Scopes:** `dashboard_webinars:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardZoomRooms",
|
|
"api_call": "GET /metrics/zoomrooms",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"page_number": "integer: The page number of the current page in the returned records.",
|
|
"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."
|
|
},
|
|
"functionality": "List information on all Zoom Rooms in an account. \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n\n\n**Scopes:** `dashboard_zr:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardZoomRoomIssue",
|
|
"api_call": "GET /metrics/zoomrooms/issues",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date."
|
|
},
|
|
"functionality": "Get top 25 issues of Zoom Rooms. \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n\n**Scopes:** `dashboard_zr:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Dashboards: dashboardZoomRoom",
|
|
"api_call": "GET /metrics/zoomrooms/{zoomroomId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"zoomroomId": "[REQUIRED] string: The Zoom room ID.",
|
|
"from": "[REQUIRED] string: Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.",
|
|
"to": "[REQUIRED] string: End date.",
|
|
"page_size": "integer: The number of records returned within a single API call.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
|
|
},
|
|
"functionality": "The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. \n\nUse this API to retrieve information on a specific room. \n \n \n**Prerequisites:** \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n**Scopes:** `dashboard_zr:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Information Barriers: InformationBarriersList",
|
|
"api_call": "GET /information_barriers/policies",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Return a list of all [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and their information. \n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**Scopes:** `information_barriers:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Information Barriers: InformationBarriersCreate",
|
|
"api_call": "POST /information_barriers/policies",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Create a new Information Barrier policy. [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) help customers control communication policies and meet regulatory requirements at scale. Use information barriers to prevent specific groups of users who possess sensitive information from communicating with others who should not know this information. \n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**Scopes:** `information_barriers:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Information Barriers: InformationBarriersGet",
|
|
"api_call": "GET /information_barriers/policies/{policyId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"policyId": "[REQUIRED] string: The Information Barrier policy's ID."
|
|
},
|
|
"functionality": "Return an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy by its ID. \n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**Scopes:** `information_barriers:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Information Barriers: InformationBarriersDelete",
|
|
"api_call": "DELETE /information_barriers/policies/{policyId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"policyId": "[REQUIRED] string: The Information Barriers policy's ID."
|
|
},
|
|
"functionality": "Remove an [Information Barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**Scopes:** `information_barriers:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Information Barriers: InformationBarriersUpdate",
|
|
"api_call": "PATCH /information_barriers/policies/{policyId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"policyId": "[REQUIRED] string: The Information Barriers policy's ID."
|
|
},
|
|
"functionality": "Update an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**Scopes:** `information_barriers:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: roles",
|
|
"api_call": "GET /roles",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"type": "string: Specify a value to get the response for the corresponding role type. \n \n `common` - common roles of Zoom. \n `iq` - roles of Zoom IQ Sales"
|
|
},
|
|
"functionality": "List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account\n\n**Prerequisites** :\n* Pro or higher plan. \n* For setting the initial role, you must be the Account Owner. \n* For subsequent role management, you must be the Account Owner or user with role management permissions.\n\n**Scopes:** `role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: createRole",
|
|
"api_call": "POST /roles",
|
|
"api_version": "2",
|
|
"api_arguments": {},
|
|
"functionality": "Each Zoom user automatically has a role which can either be owner, administrator, or member. \n\n**Pre-requisites** \n \n* Pro or higher plan.\n* To set the initial role, you must be the account owner. \n \n* For subsequent role management, you must be either the account owner or user with role management permissions. \n \n\n\n**Scopes:** `role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: getRoleInformation",
|
|
"api_call": "GET /roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role ID. "
|
|
},
|
|
"functionality": "Each Zoom user automatically has a role which can either be owner, administrator, or member. Account owners and users with edit privileges for role management can add customized roles with a list of privileges.\n\nUse this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control). \n \n**Pre-requisites** \n \n* A Pro or higher plan. \n \n* For role management and updates, you must be either the account owner or a user with role management permissions.\n\n\n\n**Scopes:** `role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: deleteRole",
|
|
"api_call": "DELETE /roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to delete a role. \n \n**Pre-requisite:** \n \n* A Pro or higher plan. \n \n* For role management and updates, you must be the Account Owner or user with role management permissions.\n\n\n\n**Scopes:** `role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: updateRole",
|
|
"api_call": "PATCH /roles/{roleId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to change the privileges, name and description of a specific role. \n \n**Pre-requisite:** \n \n* A Pro or higher plan. \n \n* For role management and updates, you must be the Account Owner or user with role management permissions. \n \n\n**Scopes:** `role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: roleMembers",
|
|
"api_call": "GET /roles/{roleId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role ID",
|
|
"page_count": "string: The number of pages returned for this request.",
|
|
"page_number": "integer: **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.",
|
|
"next_page_token": "string: Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.",
|
|
"page_size": "integer: The number of records returned within a single API call."
|
|
},
|
|
"functionality": "User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.\n\n**Prerequisites:** \n \n* A Pro or a higher plan.\n\n**Scopes:** `role:read:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: AddRoleMembers",
|
|
"api_call": "POST /roles/{roleId}/members",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role ID"
|
|
},
|
|
"functionality": "User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members.\n\n**Prerequisites:** \n \n* A Pro or a higher plan.\n\n**Scopes:** `role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom Account API - Roles: roleMemberDelete",
|
|
"api_call": "DELETE /roles/{roleId}/members/{memberId}",
|
|
"api_version": "2",
|
|
"api_arguments": {
|
|
"roleId": "[REQUIRED] string: The role ID",
|
|
"memberId": "[REQUIRED] string: Member's ID"
|
|
},
|
|
"functionality": "User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role.\n\n**Prerequisites:** \n \n* A Pro or a higher plan.\n\n**Scopes:** `role:write:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Chat: chatGet",
|
|
"api_call": "POST /chat/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"access_token": "[REQUIRED] : Archived chat messages access token. Admin who has the view privilege of Archived chat messages will get it.",
|
|
"session_id": "[REQUIRED] : Session Id of chat messages.",
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 30 records.",
|
|
"next_page_token": ": Used to paginate through large result sets. A next page token will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes."
|
|
},
|
|
"functionality": "Get chat messages for a specified period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Chat: chatList",
|
|
"api_call": "POST /chat/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"access_token": "[REQUIRED] : Archived chat messages access token. Admin who has the view privilege of Archived chat messages will get it.",
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 30 records.",
|
|
"email": ": Email query condition.",
|
|
"next_page_token": ": Used to paginate through large result sets. A next page token will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes."
|
|
},
|
|
"functionality": "Get chat history list for a specified time period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupCreate",
|
|
"api_call": "POST /group/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"name": "[REQUIRED] : Group name, must be unique in one account."
|
|
},
|
|
"functionality": "Create a group on Zoom, return the new group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupDelete",
|
|
"api_call": "POST /group/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID."
|
|
},
|
|
"functionality": "Delete a group on Zoom, return the deleted group ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupEdit",
|
|
"api_call": "POST /group/edit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"name": ": Group name, must be unique in one account."
|
|
},
|
|
"functionality": "Edit a group on Zoom, return the new group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupGet",
|
|
"api_call": "POST /group/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID."
|
|
},
|
|
"functionality": "Get a group on Zoom via ID, return the group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupList",
|
|
"api_call": "POST /group/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"api_key": "[REQUIRED] : Your API Key",
|
|
"api_secret": "[REQUIRED] : Your API Secret"
|
|
},
|
|
"functionality": "List all groups on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupMemberAdd",
|
|
"api_call": "POST /group/member/add",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"member_ids": "[REQUIRED] : The member IDs, separated by comma"
|
|
},
|
|
"functionality": "Add members to a group on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupMemberDelete",
|
|
"api_call": "POST /group/member/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"member_ids": "[REQUIRED] : The member IDs, separated by comma"
|
|
},
|
|
"functionality": "Delete members of a group on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Group: groupMemberList",
|
|
"api_call": "POST /group/member/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Lists the members of a group on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Device: deviceDeviceCreate",
|
|
"api_call": "POST /h323/device/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"name": "[REQUIRED] : Display Name.",
|
|
"ip": "[REQUIRED] : IP Address or H.323 Extension.",
|
|
"protocol_type": ": Protocol type. 1 means H.323, 2 means SIP.",
|
|
"encryption_type": ": Encryption type. 0 means No, 1 means Yes, 2 means Auto."
|
|
},
|
|
"functionality": "Create a H.323/SIP Device on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Device: deviceDeviceDelete",
|
|
"api_call": "POST /h323/device/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Device ID."
|
|
},
|
|
"functionality": "Delete a H.323/SIP Device on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Device: deviceDeviceList",
|
|
"api_call": "POST /h323/device/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List H.323/SIP Devices on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Device: deviceDeviceUpdate",
|
|
"api_call": "POST /h323/device/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Device ID.",
|
|
"name": ": Display Name.",
|
|
"ip": ": IP Address or H.323 Extension.",
|
|
"protocol_type": ": Protocol type. 1 means H.323, 2 means SIP.",
|
|
"encryption_type": ": Encryption type. 0 means No, 1 means Yes, 2 means Auto."
|
|
},
|
|
"functionality": "Update a H.323/SIP Device on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupCreate",
|
|
"api_call": "POST /im/group/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"name": "[REQUIRED] : Group name, must be unique in one account.",
|
|
"type": ": Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group.",
|
|
"option_search_by_domain": ": Others in the same email domain can search members.",
|
|
"option_search_by_account": ": Others under same account can search members.",
|
|
"option_search_by_ma": ": Others under same master account, including all sub accounts can search members."
|
|
},
|
|
"functionality": "Create a IM group on Zoom, return the new group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupDelete",
|
|
"api_call": "POST /im/group/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID."
|
|
},
|
|
"functionality": "Delete a IM group on Zoom, return the deleted group ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupEdit",
|
|
"api_call": "POST /im/group/edit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"name": ": Group name, must be unique in one account.",
|
|
"type": ": Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group.",
|
|
"option_search_by_domain": ": Others in the same email domain can search members.",
|
|
"option_search_by_account": ": Others under same account can search members.",
|
|
"option_search_by_ma": ": Others under same master account, including all sub accounts can search members."
|
|
},
|
|
"functionality": "Edit a IM group on Zoom, return the new group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupGet",
|
|
"api_call": "POST /im/group/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID."
|
|
},
|
|
"functionality": "Get a IM group on Zoom via ID, return the group info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupList",
|
|
"api_call": "POST /im/group/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"api_key": "[REQUIRED] : Your API Key",
|
|
"api_secret": "[REQUIRED] : Your API Secret"
|
|
},
|
|
"functionality": "List all IM groups on your Zoom account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupMemberDelete",
|
|
"api_call": "POST /im/group/member/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"member_ids": "[REQUIRED] : The member IDs, separated by comma"
|
|
},
|
|
"functionality": "Delete members of a IM group on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - IM Group: imGroupGroupMemberList",
|
|
"api_call": "POST /im/group/member/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Group ID.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Lists the members of a IM group on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountBillingUpdate",
|
|
"api_call": "POST /ma/account/billing/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID.",
|
|
"first_name": ": Sold To Contact\u2019s first name.",
|
|
"last_name": ": Sold To Contact\u2019s last name.",
|
|
"phone_number": ": Sold To Contact\u2019s phone number.",
|
|
"address": ": Sold To Contact\u2019s address.",
|
|
"apt": ": Sold To Contact\u2019s Apt/Suite.",
|
|
"city": ": Sold To Contact\u2019s city.",
|
|
"country": ": Sold To Contact\u2019s country. For this parameter value please refer to the id value in country list JSON file",
|
|
"state": ": Sold To Contact\u2019s state. If country value is \"US\" or \"CA\", for this parameter value please refer to the id value in state list JSON file",
|
|
"zip": ": Sold To Contact\u2019s zip/postal."
|
|
},
|
|
"functionality": "Update Billing Information for a sub account of the master account on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountCreate",
|
|
"api_call": "POST /ma/account/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return.",
|
|
"first_name": "[REQUIRED] : User\u2019s first name.",
|
|
"last_name": "[REQUIRED] : User\u2019s last name.",
|
|
"password": "[REQUIRED] : User\u2019s password.",
|
|
"enable_share_rc": ": Enable Share Virtual Room Connector.",
|
|
"share_rc": ": Virtual Room Connector, multiple value separated by comma.",
|
|
"enable_share_mc": ": Enable Share Meeting Connector.",
|
|
"share_mc": ": Meeting Connector, multiple value separated by comma.",
|
|
"pay_mode": ": Who will pay for this account? 0 means Sub Account Holders Pays, 1 means Master Account Holder Pays.",
|
|
"collection_method": ": Collection Method? 0 means Automatic (billing online), 1 means Manual (send invoice).",
|
|
"enable_pstn": ": The value should be true or false, by default is true.",
|
|
"enable_enforce_login": ": Only signed-in users can join this meeting.",
|
|
"enable_enforce_login_sd": ": Only signed-in users with specified domains can join meetings.",
|
|
"enforce_login_domains": ": Domains of signed-in users.",
|
|
"meeting_capacity": ": Account\u2019 meeting capacity, max of 100.",
|
|
"disable_cmr_reminder": ": Disable cloud recording reminder.",
|
|
"enable_only_host_download_cmr": ": Enable Only the host can download cloud recordings.",
|
|
"enable_same_account_access_cmr": ": Enable Only users on my account can access cloud recordings."
|
|
},
|
|
"functionality": "Create a sub account of the master account on Zoom, return the created sub account id and owner id.\n\n<aside class=\"notice\">Your account must be a master account and have this privilege to create sub account. Zoom only assign this privilege to trusted partner.</aside>\n\n<aside class=\"notice\">User will not receive the confirmation email.</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountDelete",
|
|
"api_call": "POST /ma/account/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID."
|
|
},
|
|
"functionality": "Delete the sub account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountGet",
|
|
"api_call": "POST /ma/account/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID."
|
|
},
|
|
"functionality": "Get a sub account of the master account on Zoom, return the created sub account id and owner id.\n\n<aside class=\"notice\">Your account must be a master account and have this privilege to get sub account. Zoom only assign this privilege to trusted partner.</aside>\n\n<aside class=\"notice\">This API will let the master account owner to get sub account API key pair. This is a private feature and needs to be enabled by zoom support. If you need this function, please open a case with support to enable this API.</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountList",
|
|
"api_call": "POST /ma/account/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"api_key": "[REQUIRED] : Your API Key",
|
|
"api_secret": "[REQUIRED] : Your API Secret"
|
|
},
|
|
"functionality": "List all the sub account under the master account.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountPlanAdd",
|
|
"api_call": "POST /ma/account/plan/add",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID.",
|
|
"plan": "[REQUIRED] : Additional Plan. See [Plans](#plans) for more details"
|
|
},
|
|
"functionality": "Add a plan for a sub account of the master account on Zoom.\n\n<aside class=\"notice\">Only for the sub account which is a paid account and paid by master account.</aside>\n\n<aside class=\"notice\">Only add an Additional plan for a sub account.</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountPlanGet",
|
|
"api_call": "POST /ma/account/plan/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID."
|
|
},
|
|
"functionality": "Get plans information for a sub account of the master account on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountPlanSubscribe",
|
|
"api_call": "POST /ma/account/plan/subscribe",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID.",
|
|
"first_name": "[REQUIRED] : Sold To Contact\u2019s first name.",
|
|
"last_name": "[REQUIRED] : Sold To Contact\u2019s last name.",
|
|
"phone_number": "[REQUIRED] : Sold To Contact\u2019s phone number.",
|
|
"address": "[REQUIRED] : Sold To Contact\u2019s address.",
|
|
"apt": ": Sold To Contact\u2019s Apt/Suite.",
|
|
"city": "[REQUIRED] : Sold To Contact\u2019s city.",
|
|
"country": "[REQUIRED] : Sold To Contact\u2019s country. For this parameter value please refer to the id value in country list JSON file",
|
|
"state": "[REQUIRED] : Sold To Contact\u2019s state. If country value is \"US\" or \"CA\", for this parameter value please refer to the id value in state list JSON file",
|
|
"zip": "[REQUIRED] : Sold To Contact\u2019s zip/postal.",
|
|
"plan_base": "[REQUIRED] : Base Plan. See [Plans](#plans) for more details",
|
|
"plan_zoom_rooms": ": Additional Zoom Rooms Plan. See [Plans](#plans) for more details",
|
|
"plan_room_connector": ": Additional H.323/SIP Room Connector Plan. See [Plans](#plans) for more details",
|
|
"plan_large_meeting": ": Additional Large Meeting Plan. See [Plans](#plans) for more details",
|
|
"plan_webinar": ": Additional Webinar Plan. See [Plans](#plans) for more details",
|
|
"plan_recording": ": Additional Cloud Recording Plan. See [Plans](#plans) for more details",
|
|
"plan_audio": ": Additional Audio Conferencing Plan. See [Plans](#plans) for more details"
|
|
},
|
|
"functionality": "Subscribe plans for a sub account of the master account on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountPlanUpdate",
|
|
"api_call": "POST /ma/account/plan/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID.",
|
|
"type": "[REQUIRED] : Plan Type. 1 means Base Plan, 2 means Additional Plan.",
|
|
"plan": "[REQUIRED] : A Base Plan or an Additional Plan. See [Plans](#plans) for more details"
|
|
},
|
|
"functionality": "Update a plan for a sub account of the master account on Zoom.\n\n<aside class=\"notice\">Only for the sub account which is a paid account and paid by master account.</aside>\n\n<aside class=\"notice\">Could update a base plan or an additional plan.</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Account: accountUpdate",
|
|
"api_call": "POST /ma/account/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"account_id": "[REQUIRED] : The sub account ID.",
|
|
"enable_share_rc": ": Enable Share Virtual Room Connector.",
|
|
"share_rc": ": Virtual Room Connector, multiple value separated by comma.",
|
|
"enable_share_mc": ": Enable Share Meeting Connector.",
|
|
"share_mc": ": Meeting Connector, multiple value separated by comma.",
|
|
"pay_mode": ": Who will pay for this account? 0 means Sub Account Holders Pays, 1 means Master Account Holder Pays.",
|
|
"collection_method": ": Collection Method? 0 means Automatic (billing online), 1 means Manual (send invoice).",
|
|
"enable_pstn": ": The value should be true or false, by default is true.",
|
|
"enable_call_out": ": The value should be true or false. If it is true, the user under this account will follow MA call out type.",
|
|
"enable_enforce_login": ": Only signed-in users can join this meeting.",
|
|
"enable_enforce_login_sd": ": Only signed-in users with specified domains can join meetings.",
|
|
"enforce_login_domains": ": Domains of signed-in users.",
|
|
"meeting_capacity": ": Account\u2019 meeting capacity, max of 100.",
|
|
"disable_cmr_reminder": ": Disable cloud recording reminder.",
|
|
"enable_only_host_download_cmr": ": Enable Only the host can download cloud recordings.",
|
|
"enable_same_account_access_cmr": ": Enable Only users on my account can access cloud recordings."
|
|
},
|
|
"functionality": "Update a sub account of the master account on Zoom, return the updated sub account id.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Cloud Recording: mcRecordingList",
|
|
"api_call": "POST /mc/recording/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account.",
|
|
"meeting_number": ": The meeting number.",
|
|
"from": ": The meeting start time after this date, MM/dd/yyyy hh:mm a. For example: 11/05/2014 09:05 pm. Use the host\u2019s time zone, if host has not set time zone, will use GMT.",
|
|
"to": ": The meeting start time before this date, MM/dd/yyyy hh:mm a.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Lists all the cloud recordings meetings on a Meeting Connector\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingCreate",
|
|
"api_call": "POST /meeting/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account. Cannot be updated after creation.",
|
|
"type": "[REQUIRED] : Meeting type: 1 means instant meeting (Only used for host to start it as soon as created). 2 means normal scheduled meeting. 3 means a recurring meeting with no fixed time. 8 means a recurring meeting with fixed time.",
|
|
"topic": "[REQUIRED] : Meeting topic. Max of 300 characters.",
|
|
"start_time": ": Meeting start time in ISO datetime format. For scheduled meeting and recurring meeting with fixed time. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"duration": ": Meeting duration (minutes). For scheduled meeting only.",
|
|
"timezone": ": Timezone to format start_time, like \"America/Los_Angeles\". For scheduled meeting only. For this parameter value please refer to the id value in timezone list JSON file.",
|
|
"password": ": Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _",
|
|
"recurrence": ": Recurrence Meeting Settings. For recurring meeting with fixed time only. See [Recurrence Object](#recurrence-object) for more details.",
|
|
"option_registration": ": Registration required.",
|
|
"registration_type": ": Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only.",
|
|
"option_jbh": ": Join meeting before host start the meeting. Only for scheduled or recurring meetings.",
|
|
"option_start_type": ": Meeting start type. Can be \"video\" or \"screen_share\". (deprecated)",
|
|
"option_host_video": ": Start video when host join meeting.",
|
|
"option_participants_video": ": Start video when participants join meeting.",
|
|
"option_cn_meeting": ": Host meeting in China.",
|
|
"option_in_meeting": ": Host meeting in India.",
|
|
"option_audio": ": Meeting audio options. Can be \"both\", \"telephony\", \"voip\".",
|
|
"option_enforce_login": ": Only signed-in users can join this meeting.",
|
|
"option_enforce_login_domains": ": Only signed-in users with specified domains can join meetings.",
|
|
"option_alternative_hosts": ": Alternative hosts.",
|
|
"option_alternative_host_ids": ": Alternative hosts IDs.",
|
|
"option_use_pmi": ": Use Personal Meeting ID. Only for scheduled meetings.",
|
|
"option_auto_record_type": ": Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
|
|
},
|
|
"functionality": "Create a meeting on Zoom, return the created meeting URL\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingDelete",
|
|
"api_call": "POST /meeting/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Meeting ID.",
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account.",
|
|
"occurrence_id": ": Occurrence ID, could get this value from Meeting Get API."
|
|
},
|
|
"functionality": "Delete a meeting on Zoom, return the deleted meeting ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingEnd",
|
|
"api_call": "POST /meeting/end",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Meeting ID.",
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account."
|
|
},
|
|
"functionality": "End a meeting on Zoom, return the deleted meeting ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingGet",
|
|
"api_call": "POST /meeting/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Meeting ID.",
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account."
|
|
},
|
|
"functionality": "Get a meeting on Zoom via meeting ID, return the meeting info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingList",
|
|
"api_call": "POST /meeting/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all the scheduled meetings on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingLive",
|
|
"api_call": "POST /meeting/live",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"api_key": "[REQUIRED] : Your API Key",
|
|
"api_secret": "[REQUIRED] : Your API Secret"
|
|
},
|
|
"functionality": "Lists the live meetings on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingRegister",
|
|
"api_call": "POST /meeting/register",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Meeting ID.",
|
|
"email": "[REQUIRED] : A valid email address.",
|
|
"first_name": "[REQUIRED] : User\u2019s first name.",
|
|
"last_name": "[REQUIRED] : User\u2019s last name.",
|
|
"address": ": Address.",
|
|
"city": ": City.",
|
|
"country": ": Country. For this parameter value please refer to the id value in country list JSON file",
|
|
"zip": ": Zip/Postal Code.",
|
|
"state": ": State/Province.",
|
|
"phone": ": Phone.",
|
|
"industry": ": Industry.",
|
|
"org": ": Organization.",
|
|
"job_title": ": Job Title.",
|
|
"purchasing_time_frame": ": Purchasing Time Frame, should be \"Within a month\", \"1-3 months\", \"4-6 months\", \"More than 6 months\", \"No timeframe\".",
|
|
"role_in_purchase_process": ": Role in Purchase Process, should be \"Decision Maker\", \"Evaluator/Recommender\", \"Influencer\", \"Not involved\".",
|
|
"no_of_employees": ": Number of Employees, should be \"1-20\", \"21-50\", \"51-100\", \"101-250\", \"251-500\", \"501-1,000\", \"1,001-5,000\", \"5,001-10,000\", \"More than 10,000\".",
|
|
"comments": ": Questions & Comments.",
|
|
"custom_questions": ": Custom Questions, should be JSON format: [{\"title\":\"field_name1\",\"value\":\"xxx\"},{\"title\":\"field_name2\",\"value\":\"xxx\"}].",
|
|
"language": ": Language setting of email. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\".",
|
|
"occurrence_ids": ": Occurrence IDs, could get this value from Meeting Get API."
|
|
},
|
|
"functionality": "Register for a meeting.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Meeting: meetingUpdate",
|
|
"api_call": "POST /meeting/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Meeting ID.",
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account. Used to retrieve a meeting, cannot be updated.",
|
|
"type": "[REQUIRED] : Meeting type: 1 means instant meeting (Only used for host to start it as soon as created). 2 means normal scheduled meeting. 3 means a recurring meeting with no fixed time. 8 means a recurring meeting with fixed time.",
|
|
"topic": ": Meeting topic. Max of 300 characters.",
|
|
"start_time": ": Meeting start time in ISO datetime format. For scheduled meeting only. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"duration": ": Meeting duration (minutes). For scheduled meeting only.",
|
|
"timezone": ": Timezone to format start_time, like \"America/Los_Angeles\". For scheduled meeting only. For this parameter value please refer to the id value in timezone list JSON file.",
|
|
"password": ": Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _",
|
|
"recurrence": ": Recurrence Meeting Settings. For recurring meeting with fixed time only. See [Recurrence Object](#recurrence-object) for more details.",
|
|
"option_registration": ": Registration required.",
|
|
"registration_type": ": Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only.",
|
|
"option_jbh": ": Join meeting before host start the meeting. Only for scheduled or recurring meetings.",
|
|
"option_start_type": ": Meeting start type. Can be \"video\" or \"screen_share\". (deprecated)",
|
|
"option_host_video": ": Start video when host join meeting.",
|
|
"option_participants_video": ": Start video when participants join meeting.",
|
|
"option_cn_meeting": ": Host meeting in China.",
|
|
"option_in_meeting": ": Host meeting in India.",
|
|
"option_audio": ": Meeting audio options. Can be \"both\", \"telephony\", \"voip\".",
|
|
"option_enforce_login": ": Only signed-in users can join this meeting.",
|
|
"option_enforce_login_domains": ": Only signed-in users with specified domains can join meetings.",
|
|
"option_alternative_hosts": ": Alternative hosts.",
|
|
"option_alternative_host_ids": ": Alternative hosts IDs.",
|
|
"option_use_pmi": ": Use Personal Meeting ID. Only for scheduled meetings.",
|
|
"option_auto_record_type": ": Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
|
|
},
|
|
"functionality": "Update meeting info on Zoom via meeting ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardCrc",
|
|
"api_call": "POST /metrics/crc",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date."
|
|
},
|
|
"functionality": "Get CRC Port usage hour by hour for a specified time period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardIm",
|
|
"api_call": "POST /metrics/im",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 30 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get statistics of Zoom IM\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardMeetingdetail",
|
|
"api_call": "POST /metrics/meetingdetail",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"meeting_id": "[REQUIRED] : The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03",
|
|
"type": "[REQUIRED] : Meeting type. 1 means live meeting. 2 means past meeting.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 100 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get live and past meeting details\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardMeetings",
|
|
"api_call": "POST /metrics/meetings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"type": "[REQUIRED] : Meeting list type. 1 means live meetings. 2 means past meetings.",
|
|
"from": "[REQUIRED] : Start date. Only for past meetings.",
|
|
"to": "[REQUIRED] : End date. Only for past meetings.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 100 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get Live Meetings and past meetings for a specified period\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardQos",
|
|
"api_call": "POST /metrics/qos",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"meeting_id": "[REQUIRED] : The meeting ID.",
|
|
"type": "[REQUIRED] : Meeting type. 1 means live meeting. 2 means past meeting.",
|
|
"user_id": ": The user ID to get user qos.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 10. Max of 10 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get the users quality of service in a Zoom Meeting\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardWebinardetail",
|
|
"api_call": "POST /metrics/webinardetail",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"meeting_id": "[REQUIRED] : The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03",
|
|
"type": "[REQUIRED] : Meeting type. 1 means live webinar. 2 means past webinar.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 100 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get live and past webinar details\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardWebinars",
|
|
"api_call": "POST /metrics/webinars",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"type": "[REQUIRED] : Webinar list type. 1 means live webinars. 2 means past webinars.",
|
|
"from": "[REQUIRED] : Start date. Only for past webinars.",
|
|
"to": "[REQUIRED] : End date. Only for past webinars.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 100 webinars.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get live webinars and past webinars for a specified period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardZoomroomdetail",
|
|
"api_call": "POST /metrics/zoomroomdetail",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : The zoom room ID. Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03",
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 30 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get a Zoom Room on Zoom via Zoom ID, return the Zoom Room info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Dashboard: dashboardZoomrooms",
|
|
"api_call": "POST /metrics/zoomrooms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 30 records.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all Zoom Rooms on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Cloud Recording: recordingDelete",
|
|
"api_call": "POST /recording/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"meeting_id": "[REQUIRED] : The meeting ID. Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03",
|
|
"file_id": ": The file ID, if given this, will only delete this one file, if not given this, will delete all files of the meeting"
|
|
},
|
|
"functionality": "Delete recorded meeting either on Zoom cloud or on-premise.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Cloud Recording: recordingGet",
|
|
"api_call": "POST /recording/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"meeting_id": "[REQUIRED] : The meeting ID."
|
|
},
|
|
"functionality": "Get the recorded meeting on either Zoom cloud or on-prem.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Cloud Recording: recordingList",
|
|
"api_call": "POST /recording/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Meeting host user ID. Can be any user under this account.",
|
|
"meeting_number": ": The meeting number.",
|
|
"from": ": The meeting start time after this date, MM/dd/yyyy hh:mm a. For example: 11/05/2014 09:05 pm. Use the host\u2019s time zone, if host has not set time zone, will use GMT.",
|
|
"to": ": The meeting start time before this date, MM/dd/yyyy hh:mm a.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all the cloud recording meetings on Zoom.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Report: reportGetaccountreport",
|
|
"api_call": "POST /report/getaccountreport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get account report for a specified period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Report: reportGetaudioreport",
|
|
"api_call": "POST /report/getaudioreport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"type": ": Audio type: 1 means Toll-free Call-in & Call-out. 2 means Toll.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get user report for a specified period.\n\n<aside class=\"notice\">Toll Report API is provided for enabled 'Toll Report' option.</aside>\n\n<aside class=\"notice\">We will report a maximum of one month. For example, if \"from\" is set to \"2015-08-05\" and \"to\" is \"2015-10-10\" we will adjust \"from\" to \"2015-09-10\"</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Report: reportGetdailyreport",
|
|
"api_call": "POST /report/getdailyreport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"year": "[REQUIRED] : Year for this report.",
|
|
"month": "[REQUIRED] : Month for this report."
|
|
},
|
|
"functionality": "Get daily report for one month, can only get daily report for recent 3 months.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Report: reportGetuserreport",
|
|
"api_call": "POST /report/getuserreport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"user_id": "[REQUIRED] : The user to generate the report.",
|
|
"from": "[REQUIRED] : Start date.",
|
|
"to": "[REQUIRED] : End date.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Get user report for a specified period.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userAssistantDelete",
|
|
"api_call": "POST /user/assistant/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": ": The host\u2019s user id.",
|
|
"host_email": ": The host\u2019s email address."
|
|
},
|
|
"functionality": "Delete a user's assistant.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userAssistantSet",
|
|
"api_call": "POST /user/assistant/set",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": ": The host\u2019s user id.",
|
|
"host_email": ": The host\u2019s email address. ",
|
|
"assistant_email": "[REQUIRED] : The assistant\u2019s email address."
|
|
},
|
|
"functionality": "Set a user's assistant which can schedule meeting for him.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userAutocreate",
|
|
"api_call": "POST /user/autocreate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return",
|
|
"type": "[REQUIRED] : User\u2019s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting",
|
|
"password": "[REQUIRED] : User's password",
|
|
"first_name": ": User's first name",
|
|
"last_name": ": User's last name",
|
|
"disable_chat": ": Disable in-meeting chat",
|
|
"enable_e2e_encryption": ": Enable end-to-end encryption",
|
|
"enable_silent_mode": ": Enable attendee on-hold",
|
|
"disable_group_hd": ": Disable Group HD",
|
|
"disable_recording": ": Disable recording",
|
|
"enable_cmr": ": Enable cloud meeting record",
|
|
"enable_auto_recording": ": Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true",
|
|
"enable_cloud_auto_recording": ": Enable cloud automatic recording",
|
|
"track_id": ": Referral partner track ID",
|
|
"meeting_capacity": ": User\u2019s meeting capacity, 0 means following account\u2019s meeting capacity",
|
|
"enable_webinar": ": Enable webinar feature",
|
|
"webinar_capacity": ": Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not",
|
|
"enable_large": ": Enable large meting feature",
|
|
"large_capacity": ": Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not",
|
|
"disable_feedback": ": Disable feedback",
|
|
"disable_jbh_reminder": ": Disable jbh email reminder",
|
|
"enable_breakout_room": ": Enable breakout room",
|
|
"enable_polling": ": Enable polling for meeting",
|
|
"enable_annotation": ": Enable Annotation",
|
|
"enable_share_dual_camera": ": Enable Share dual camera",
|
|
"enable_far_end_camera_control": ": Enable Far end camera control",
|
|
"disable_private_chat": ": Disable Private chat",
|
|
"enable_enter_exit_chime": ": Enable Enter/exit chime",
|
|
"option_enter_exit_chime_type": ": Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only",
|
|
"disable_cancel_meeting_notification": ": Disable email notification when a meeting is cancelled",
|
|
"enable_remote_support": ": Enable Remote support",
|
|
"enable_file_transfer": ": Enable File transfer",
|
|
"enable_virtual_background": ": Enable Virtual background",
|
|
"enable_attention_tracking": ": Enable Attention tracking",
|
|
"enable_waiting_room": ": Enable Waiting room",
|
|
"enable_closed_caption": ": Enable Closed caption",
|
|
"enable_co_host": ": Enable Co-host",
|
|
"enable_auto_saving_chats": ": Enable Auto saving chats",
|
|
"enable_phone_participants_password": ": Enable Generate and require password for participants joining by phone",
|
|
"enable_auto_delete_cmr": ": Enable Auto delete cloud recordings",
|
|
"auto_delete_cmr_days": ": Auto delete cloud recordings after days",
|
|
"dept": ": Department for user profile, use for repor",
|
|
"group_id": ": User Group ID. If set default user group, the parameter\u2019s default value is the default user group",
|
|
"imgroup_id": ": IM Group ID. If set default im group, the parameter\u2019s default value is the default im group"
|
|
},
|
|
"functionality": "Create a user on Zoom, returns the created user ID.\n\n<aside class=\"notice\">\nThe API is provided for enterprise customer who has a managed domain\n</aside>\n\n<aside class=\"warning\">\nThis feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain without notifying the user. You need to contact Zoom customer support if you want to use this API\n</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userCheckemail",
|
|
"api_call": "POST /user/checkemail",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : User email."
|
|
},
|
|
"functionality": "Check if the user email exists.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userCheckzpk",
|
|
"api_call": "POST /user/checkzpk",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"zpk": "[REQUIRED] : User zpk."
|
|
},
|
|
"functionality": "Check if the zpk is expired. The zpk is used to authenticate a user.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userCreate",
|
|
"api_call": "POST /user/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return",
|
|
"type": "[REQUIRED] : User\u2019s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting",
|
|
"first_name": ": User's first name",
|
|
"last_name": ": User's last name",
|
|
"disable_chat": ": Disable in-meeting chat",
|
|
"enable_e2e_encryption": ": Enable end-to-end encryption",
|
|
"enable_silent_mode": ": Enable attendee on-hold",
|
|
"disable_group_hd": ": Disable Group HD",
|
|
"disable_recording": ": Disable recording",
|
|
"enable_cmr": ": Enable cloud meeting record",
|
|
"enable_auto_recording": ": Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true",
|
|
"enable_cloud_auto_recording": ": Enable cloud automatic recording",
|
|
"track_id": ": Referral partner track ID",
|
|
"meeting_capacity": ": User\u2019s meeting capacity, passing 0 will inherit account\u2019s meeting capacity",
|
|
"enable_webinar": ": Enable webinar feature",
|
|
"webinar_capacity": ": Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not",
|
|
"enable_large": ": Enable large meting feature",
|
|
"large_capacity": ": Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not",
|
|
"disable_feedback": ": Disable feedback",
|
|
"disable_jbh_reminder": ": Disable jbh email reminder",
|
|
"enable_breakout_room": ": Enable breakout room",
|
|
"enable_polling": ": Enable polling for meeting",
|
|
"enable_annotation": ": Enable Annotation",
|
|
"enable_share_dual_camera": ": Enable Share dual camera",
|
|
"enable_far_end_camera_control": ": Enable Far end camera control",
|
|
"disable_private_chat": ": Disable Private chat",
|
|
"enable_enter_exit_chime": ": Enable Enter/exit chime",
|
|
"option_enter_exit_chime_type": ": Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only",
|
|
"disable_cancel_meeting_notification": ": Disable email notification when a meeting is cancelled",
|
|
"enable_remote_support": ": Enable Remote support",
|
|
"enable_file_transfer": ": Enable File transfer",
|
|
"enable_virtual_background": ": Enable Virtual background",
|
|
"enable_attention_tracking": ": Enable Attention tracking",
|
|
"enable_waiting_room": ": Enable Waiting room",
|
|
"enable_closed_caption": ": Enable Closed caption",
|
|
"enable_co_host": ": Enable Co-host",
|
|
"enable_auto_saving_chats": ": Enable Auto saving chats",
|
|
"enable_phone_participants_password": ": Enable Generate and require password for participants joining by phone",
|
|
"enable_auto_delete_cmr": ": Enable Auto delete cloud recordings",
|
|
"auto_delete_cmr_days": ": Auto delete cloud recordings after days",
|
|
"dept": ": Department for user profile, use for repor",
|
|
"group_id": ": User Group ID. If set default user group, the parameter\u2019s default value is the default user group",
|
|
"imgroup_id": ": IM Group ID. If set default im group, the parameter\u2019s default value is the default im group"
|
|
},
|
|
"functionality": "Create a user on Zoom, returns the created user ID.\n\n<aside class=\"notice\">\nYour account must have this privilege to provisioning user. Zoom only assigns this privilege to a trusted partner\n</aside>\n\n<aside class=\"notice\">\nUser will get an email sent from Zoom. There is a confirmation link in this email. User will then need to click this link to activate their account to the Zoom service. The user can set or change their password in Zoom.\n</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userCustcreate",
|
|
"api_call": "POST /user/custcreate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return",
|
|
"type": "[REQUIRED] : User\u2019s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting",
|
|
"first_name": ": User's first name",
|
|
"last_name": ": User's last name",
|
|
"disable_chat": ": Disable in-meeting chat",
|
|
"enable_e2e_encryption": ": Enable end-to-end encryption",
|
|
"enable_silent_mode": ": Enable attendee on-hold",
|
|
"disable_group_hd": ": Disable Group HD",
|
|
"disable_recording": ": Disable recording",
|
|
"enable_cmr": ": Enable cloud meeting record",
|
|
"enable_auto_recording": ": Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true",
|
|
"enable_cloud_auto_recording": ": Enable cloud automatic recording",
|
|
"track_id": ": Referral partner track ID",
|
|
"meeting_capacity": ": User\u2019s meeting capacity, 0 means following account\u2019s meeting capacity",
|
|
"enable_webinar": ": Enable webinar feature",
|
|
"webinar_capacity": ": Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not",
|
|
"enable_large": ": Enable large meting feature",
|
|
"large_capacity": ": Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not",
|
|
"disable_feedback": ": Disable feedback",
|
|
"disable_jbh_reminder": ": Disable jbh email reminder",
|
|
"enable_breakout_room": ": Enable breakout room",
|
|
"enable_polling": ": Enable polling for meeting",
|
|
"enable_annotation": ": Enable Annotation",
|
|
"enable_share_dual_camera": ": Enable Share dual camera",
|
|
"enable_far_end_camera_control": ": Enable Far end camera control",
|
|
"disable_private_chat": ": Disable Private chat",
|
|
"enable_enter_exit_chime": ": Enable Enter/exit chime",
|
|
"option_enter_exit_chime_type": ": Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only",
|
|
"disable_cancel_meeting_notification": ": Disable email notification when a meeting is cancelled",
|
|
"enable_remote_support": ": Enable Remote support",
|
|
"enable_file_transfer": ": Enable File transfer",
|
|
"enable_virtual_background": ": Enable Virtual background",
|
|
"enable_attention_tracking": ": Enable Attention tracking",
|
|
"enable_waiting_room": ": Enable Waiting room",
|
|
"enable_closed_caption": ": Enable Closed caption",
|
|
"enable_co_host": ": Enable Co-host",
|
|
"enable_auto_saving_chats": ": Enable Auto saving chats",
|
|
"enable_phone_participants_password": ": Enable Generate and require password for participants joining by phone",
|
|
"enable_auto_delete_cmr": ": Enable Auto delete cloud recordings",
|
|
"auto_delete_cmr_days": ": Auto delete cloud recordings after days",
|
|
"dept": ": Department for user profile, use for repor",
|
|
"group_id": ": User Group ID. If set default user group, the parameter\u2019s default value is the default user group",
|
|
"imgroup_id": ": IM Group ID. If set default im group, the parameter\u2019s default value is the default im group"
|
|
},
|
|
"functionality": "Create a user on Zoom, returns the created user ID.\n\n<aside class=\"notice\">\nThe API is provided for API plan only\n</aside>\n\n<aside class=\"notice\">\nUser created in this way has no password and is not able to log into the Zoom web site or client\n</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userActivate",
|
|
"api_call": "POST /user/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : User id."
|
|
},
|
|
"functionality": "Activate a user on Zoom, return the user ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userDeactivate",
|
|
"api_call": "POST /user/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : User id."
|
|
},
|
|
"functionality": "Deactivate a user on Zoom, return the user ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userDelete",
|
|
"api_call": "POST /user/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : User id.",
|
|
"type": ": 0 means existing user, 1 means pending user."
|
|
},
|
|
"functionality": "Delete a user on Zoom, return the deleted user ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userGet",
|
|
"api_call": "POST /user/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"api_key": "[REQUIRED] : API Key",
|
|
"api_secret": "[REQUIRED] : API Secret",
|
|
"id": "[REQUIRED] : User ID"
|
|
},
|
|
"functionality": "Get a user info on Zoom via user ID\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userGetbyemail",
|
|
"api_call": "POST /user/getbyemail",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : Email, String",
|
|
"login_type": "[REQUIRED] : Login type of the email, int SNS_FACEBOOK = 0; SNS_GOOGLE = 1; SNS_API = 99; SNS_ZOOM = 100; SNS_SSO = 101;"
|
|
},
|
|
"functionality": "Get a user on Zoom via user email address and login type, return the user info.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userList",
|
|
"api_call": "POST /user/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"page_size": ": The amount of records returns within a single API call. Max of 300 users.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all the users on Zoom\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userPending",
|
|
"api_call": "POST /user/pending",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"page_size": ": The amount of records returns within a single API call. Max of 300 users.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all the pending users on Zoom\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userPermanentdelete",
|
|
"api_call": "POST /user/permanentdelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": ": The user\u2019s user id.",
|
|
"email": ": The user\u2019s email address. Must have id or email, if given id, the email is ignored."
|
|
},
|
|
"functionality": "Delete a user from Zoom system permanently.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userRevoketoken",
|
|
"api_call": "POST /user/revoketoken",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": ": The SSO user\u2019s user id.",
|
|
"email": ": The SSO user\u2019s email address."
|
|
},
|
|
"functionality": "Revoke a user's SSO token.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userScheduleforhostList",
|
|
"api_call": "POST /user/scheduleforhost/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": ": The host\u2019s user id.",
|
|
"host_email": ": The host\u2019s email address."
|
|
},
|
|
"functionality": "List assigned schedule privilege for host users.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userSsocreate",
|
|
"api_call": "POST /user/ssocreate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"email": "[REQUIRED] : A valid email address. It must be unique in Zoom service.",
|
|
"type": "[REQUIRED] : User\u2019s type. 1 means it is a basic user. 2 means a pro user, 3 means a corp user. Basic user can host up to 40 minutes meeting.",
|
|
"first_name": ": User\u2019s first name.",
|
|
"last_name": ": User\u2019s last name.",
|
|
"meeting_capacity": ": User\u2019s meeting capacity, 0 means following account\u2019s meeting capacity.",
|
|
"enable_webinar": ": Enable webinar feature true or false.",
|
|
"webinar_capacity": ": Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not.",
|
|
"enable_large": ": Enable large meting feature true or false.",
|
|
"large_capacity": ": Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not.",
|
|
"pmi": ": Personal Meeting ID, long, length must be 10.",
|
|
"group_id": ": User Group ID. If set default user group, the parameter\u2019s default value is the default user group.",
|
|
"imgroup_id": ": IM Group ID. If set default im group, the parameter\u2019s default value is the default im group."
|
|
},
|
|
"functionality": "Create a SSO user on Zoom, return the created user ID.\n\n<aside class=\"notice\">The API is provided for enabled 'Pre-provisioning SSO User' option. User created in this way has no password. If it is not a basic user, will generate a Personal Vanity URL using user name (no domain) of the provisioning email. If user name or pmi is invalid or occupied, will use random number/random personal vanity URL.</aside>\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userUpdate",
|
|
"api_call": "POST /user/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : User id.",
|
|
"type": ": User\u2019s type. 1 means it is a basic user. 2 means a pro user, 3 means a corp user. Basic user can host up to 40 minutes meeting.",
|
|
"first_name": ": User\u2019s first name.",
|
|
"last_name": ": User\u2019s last name.",
|
|
"disable_chat": ": Disable in-meeting chat.",
|
|
"enable_e2e_encryption": ": Enable end-to-end encryption.",
|
|
"enable_silent_mode": ": Enable attendee on-hold.",
|
|
"disable_group_hd": ": Disable Group HD.",
|
|
"disable_recording": ": Disable recording.",
|
|
"enable_cmr": ": Enable cloud meeting record.",
|
|
"enable_record_speaker_view": ": Enable record the active speaker view.",
|
|
"enable_record_gallery_view": ": Enable record the gallery view.",
|
|
"enable_record_audio_file": ": Enable record an audio only file.",
|
|
"enable_auto_recording": ": Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true.",
|
|
"enable_cloud_auto_recording": ": Enable cloud automatic recording.",
|
|
"track_id": ": Referral partner track ID.",
|
|
"meeting_capacity": ": User\u2019s meeting capacity, passing 0 will inherit account\u2019s meeting capacity",
|
|
"enable_webinar": ": Enable webinar feature true or false.",
|
|
"webinar_capacity": ": Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not.",
|
|
"enable_large": ": Enable large meting feature true or false.",
|
|
"large_capacity": ": Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not.",
|
|
"disable_feedback": ": Disable feedback.",
|
|
"disable_jbh_reminder": ": Disable jbh email reminder.",
|
|
"enable_breakout_room": ": Enable breakout room.",
|
|
"enable_polling": ": Enable polling for meeting.",
|
|
"enable_annotation": ": Enable Annotation.",
|
|
"enable_share_dual_camera": ": Enable Share dual camera.",
|
|
"enable_far_end_camera_control": ": Enable Far end camera control.",
|
|
"disable_private_chat": ": Disable Private chat.",
|
|
"enable_enter_exit_chime": ": Enable Enter/exit chime.",
|
|
"option_enter_exit_chime_type": ": Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only.",
|
|
"disable_cancel_meeting_notification": ": Disable email notification when a meeting is cancelled.",
|
|
"enable_remote_support": ": Enable Remote support.",
|
|
"enable_file_transfer": ": Enable File transfer.",
|
|
"enable_virtual_background": ": Enable Virtual background.",
|
|
"enable_attention_tracking": ": Enable Attention tracking.",
|
|
"enable_waiting_room": ": Enable Waiting room.",
|
|
"enable_use_pmi": ": Enable Use Personal Meeting ID for instant meetings.",
|
|
"enable_closed_caption": ": Enable Closed caption.",
|
|
"enable_co_host": ": Enable Co-host.",
|
|
"enable_auto_saving_chats": ": Enable Auto saving chats.",
|
|
"enable_phone_participants_password": ": Enable Generate and require password for participants joining by phone.",
|
|
"enable_auto_delete_cmr": ": Enable Auto delete cloud recordings.",
|
|
"auto_delete_cmr_days": ": Auto delete cloud recordings after days.",
|
|
"pmi": ": Personal Meeting ID, long, length must be 10.",
|
|
"dept": ": Department for user profile, use for report.",
|
|
"timezone": ": The time zone id for user profile.",
|
|
"vanity_name": ": Personal meeting room name.",
|
|
"host_key": ": Host Key should be 6-digit number.",
|
|
"group_id": ": User Group ID. If set default user group, the parameter\u2019s default value is the default user group.",
|
|
"imgroup_id": ": IM Group ID. If set default im group, the parameter\u2019s default value is the default im group.",
|
|
"cms_user_id": ": User ID on external CMS"
|
|
},
|
|
"functionality": "Update user info on Zoom via user ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - User: userUpdatepassword",
|
|
"api_call": "POST /user/updatepassword",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : User id.",
|
|
"pic_file": "[REQUIRED] : User picture file, must be a jpg/jpeg file."
|
|
},
|
|
"functionality": "Upload and update user's profile picture on Zoom via user ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarAttendeesList",
|
|
"api_call": "POST /webinar/attendees/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"uuid": ": Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
|
|
},
|
|
"functionality": "Get ended webinar attendees\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarCreate",
|
|
"api_call": "POST /webinar/create",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user under this account. Cannot be updated after creation.",
|
|
"topic": "[REQUIRED] : Webinar topic. Max of 300 characters.",
|
|
"type": "[REQUIRED] : 5 webinar, 6 recurrence webinar, 9 recurring webinar(With Fixed Time)",
|
|
"start_time": ": Webinar start time in ISO datetime format. For scheduled webinar only. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"duration": ": Webinar duration (minutes). For scheduled webinar only.",
|
|
"timezone": ": Timezone to format start_time, like \"America/Los_Angeles\". For scheduled Webinar only. For this parameter value please refer to the id value in timezone list JSON file.",
|
|
"password": ": Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _",
|
|
"recurrence": ": Recurrence Webinar Settings. For recurring webinar with fixed time only. <br><br>\"type\": Recurrence Webinar Type. 1 means Daily, 2 means Weekly, 3 means Monthly. <br>\"repeat_interval\": Recurrence Webinar Repeat Interval. Defaults to 1. For a Daily Webinar, max of 90. For a Weekly Webinar, max of 12. For a Monthly Webinar, max of 3. <br>\"weekly_days\": Recurrence Webinar Occurs on week days, multiple value separated by comma. 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. <br>\"monthly_day\": Recurrence Webinar Occurs on a month day. The value range is from 1 to 31. <br>\"monthly_week\": Recurrence Webinar Occurs on the week of a month. -1 means Last week, 1 means First week, 2 means Second week, 3 means Third week, 4 means Fourth week. <br>\"monthly_week_day\": Recurrence Webinar Occurs on the week day of a month. A single value: 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. <br>\"end_times\": Recurrence Webinar End occurrences times. Defaults to 1. Max of 50. <br>\"end_date_time\": Recurrence Webinar End Date. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"approval_type": ": Approval type. 0 means Automatically Approve. 1 means Manually Approve. 2 means No Registration Required.",
|
|
"registration_type": ": Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only.",
|
|
"agenda": ": Webinar description.",
|
|
"option_audio": ": Webinar audio options. Can be \"both\", \"telephony\", \"voip\".",
|
|
"option_host_video": ": Start video when host join Webinar.",
|
|
"option_panelist_video": ": Start video when panelist join Webinar.",
|
|
"option_practice_session": ": Enable Practice Session.",
|
|
"option_enforce_login": ": Only signed-in users can join this Webinar.",
|
|
"option_enforce_login_domains": ": Only signed-in users with specified domains can join Webinar.",
|
|
"option_alternative_hosts": ": Alternative hosts.",
|
|
"option_alternative_host_ids": ": Alternative hosts IDs.",
|
|
"option_auto_record_type": ": Automatically record type. Can be \"local\", \"cloud\" or \"none\".",
|
|
"panelists": ": Webinar Panelists, should be JSON format: [{\"name\":\"xxx\",\"email\":\"test1@zoom.us\"}, {\"name\":\"xxx\",\"email\":\"test2@zoom.us\"}].",
|
|
"language": ": Language setting of email to panelists. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
|
|
},
|
|
"functionality": "Create a webinar on Zoom, return the created webinar start and join URL.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarDelete",
|
|
"api_call": "POST /webinar/delete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"occurrence_id": ": Occurrence ID, could get this value from Webinar Get API."
|
|
},
|
|
"functionality": "Delete a webinar on Zoom, return the deleted webinar ID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarEnd",
|
|
"api_call": "POST /webinar/end",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account."
|
|
},
|
|
"functionality": "End a Webinar on Zoom, return the deleted Webinar ID\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarGet",
|
|
"api_call": "POST /webinar/get",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account."
|
|
},
|
|
"functionality": "Get a Webinar on Zoom via Webinar ID, return the Webinar info\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarList",
|
|
"api_call": "POST /webinar/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all registrationless Webinars on Zoom\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarListRegistration",
|
|
"api_call": "POST /webinar/list/registration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List all the upcoming registration-based Webinars on Zoom\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarPanelists",
|
|
"api_call": "POST /webinar/panelists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account."
|
|
},
|
|
"functionality": "Get all the Webinar Panelists on Zoom\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarPolls",
|
|
"api_call": "POST /webinar/polls",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"uuid": ": Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
|
|
},
|
|
"functionality": "Get Ended Webinar Polls\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarQuestions",
|
|
"api_call": "POST /webinar/questions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"uuid": ": Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
|
|
},
|
|
"functionality": "Get Ended Webinar Q&A\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarRegister",
|
|
"api_call": "POST /webinar/register",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"email": "[REQUIRED] : A valid email address.",
|
|
"first_name": "[REQUIRED] : User\u2019s first name.",
|
|
"last_name": "[REQUIRED] : User\u2019s last name.",
|
|
"address": ": Address.",
|
|
"city": ": City.",
|
|
"country": ": Country. For this parameter value please refer to the id value in country list JSON file",
|
|
"zip": ": Zip/Postal Code.",
|
|
"state": ": State/Province.",
|
|
"phone": ": Phone.",
|
|
"industry": ": Industry.",
|
|
"org": ": Organization.",
|
|
"job_title": ": Job Title.",
|
|
"purchasing_time_frame": ": Purchasing Time Frame, should be \"Within a month\", \"1-3 months\", \"4-6 months\", \"More than 6 months\", \"No timeframe\".",
|
|
"role_in_purchase_process": ": Role in Purchase Process, should be \"Decision Maker\", \"Evaluator/Recommender\", \"Influencer\", \"Not involved\".",
|
|
"no_of_employees": ": Number of Employees, should be \"1-20\", \"21-50\", \"51-100\", \"101-250\", \"251-500\", \"501-1,000\", \"1,001-5,000\", \"5,001-10,000\", \"More than 10,000\".",
|
|
"comments": ": Questions & Comments.",
|
|
"custom_questions": ": Custom Questions, should be JSON format: [{\"title\":\"field_name1\",\"value\":\"xxx\"},{\"title\":\"field_name2\",\"value\":\"xxx\"}].",
|
|
"language": ": Language setting of email. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\".",
|
|
"occurrence_ids": ": Occurrence IDs, could get this value from Webinar Get API."
|
|
},
|
|
"functionality": "Register for a webinar\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarRegistrantsApprove",
|
|
"api_call": "POST /webinar/registrants/approve",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"registrant_ids": "[REQUIRED] : Pending approval registrant ids."
|
|
},
|
|
"functionality": "Approve pending registrants on Zoom Webinar.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarRegistrantsList",
|
|
"api_call": "POST /webinar/registrants/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"type": ": 0 means pending approval registrants, 1 means approved registrants.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "List webinar registrants on Zoom, include pending approval registrants and approved registrants.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarRegistration",
|
|
"api_call": "POST /webinar/registration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"occurrence_id": ": Occurrence ID, could get this value from Webinar Get API.",
|
|
"page_size": ": The amount of records returns within a single API call. Defaults to 30.",
|
|
"page_number": ": Current page number of returned records. Default to 1."
|
|
},
|
|
"functionality": "Gather Webinar registrants info\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarRegistrationCancel",
|
|
"api_call": "POST /webinar/registration/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account.",
|
|
"occurrence_id": ": Occurrence ID, could get this value from Webinar Get API.",
|
|
"registrant_ids": "[REQUIRED] : Webinar registrant IDs, separated by comma. Max of 15 registrants."
|
|
},
|
|
"functionality": "Cancel Webinar Registration\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarUpdate",
|
|
"api_call": "POST /webinar/update",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user under this account. Cannot be updated after creation.",
|
|
"topic": ": Webinar topic. Max of 300 characters.",
|
|
"type": ": 5 webinar, 6 recurrence webinar, 9 recurring webinar(With Fixed Time)",
|
|
"start_time": ": Webinar start time in ISO datetime format. For scheduled webinar only. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"duration": ": Webinar duration (minutes). For scheduled webinar only.",
|
|
"timezone": ": Timezone to format start_time, like \"America/Los_Angeles\". For scheduled Webinar only. For this parameter value please refer to the id value in timezone list JSON file.",
|
|
"password": ": Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _",
|
|
"recurrence": ": Recurrence Webinar Settings. For recurring webinar with fixed time only. <br><br>\"type\": Recurrence Webinar Type. 1 means Daily, 2 means Weekly, 3 means Monthly. <br>\"repeat_interval\": Recurrence Webinar Repeat Interval. Defaults to 1. For a Daily Webinar, max of 90. For a Weekly Webinar, max of 12. For a Monthly Webinar, max of 3. <br>\"weekly_days\": Recurrence Webinar Occurs on week days, multiple value separated by comma. 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. <br>\"monthly_day\": Recurrence Webinar Occurs on a month day. The value range is from 1 to 31. <br>\"monthly_week\": Recurrence Webinar Occurs on the week of a month. -1 means Last week, 1 means First week, 2 means Second week, 3 means Third week, 4 means Fourth week. <br>\"monthly_week_day\": Recurrence Webinar Occurs on the week day of a month. A single value: 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. <br>\"end_times\": Recurrence Webinar End occurrences times. Defaults to 1. Max of 50. <br>\"end_date_time\": Recurrence Webinar End Date. Should be UTC time, such as 2012-11-25T12:00:00Z.",
|
|
"approval_type": ": Approval type. 0 means Automatically Approve. 1 means Manually Approve. 2 means No Registration Required.",
|
|
"registration_type": ": Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only.",
|
|
"agenda": ": Webinar description.",
|
|
"option_audio": ": Webinar audio options. Can be \"both\", \"telephony\", \"voip\".",
|
|
"option_host_video": ": Start video when host join Webinar.",
|
|
"option_panelist_video": ": Start video when panelist join Webinar.",
|
|
"option_practice_session": ": Enable Practice Session.",
|
|
"option_enforce_login": ": Only signed-in users can join this Webinar.",
|
|
"option_enforce_login_domains": ": Only signed-in users with specified domains can join Webinar.",
|
|
"option_alternative_hosts": ": Alternative hosts.",
|
|
"option_alternative_host_ids": ": Alternative hosts IDs.",
|
|
"option_auto_record_type": ": Automatically record type. Can be \"local\", \"cloud\" or \"none\".",
|
|
"panelists": ": Webinar Panelists, should be JSON format: [{\"name\":\"xxx\",\"email\":\"test1@zoom.us\"}, {\"name\":\"xxx\",\"email\":\"test2@zoom.us\"}].",
|
|
"language": ": Language setting of email to panelists. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
|
|
},
|
|
"functionality": "Update Webinar info on Zoom via Webinar ID\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Zoom REST API - Webinar: webinarUuidList",
|
|
"api_call": "POST /webinar/uuid/list",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"id": "[REQUIRED] : Webinar ID.",
|
|
"host_id": "[REQUIRED] : Webinar host user ID. Can be any user who enabled webinar under this account."
|
|
},
|
|
"functionality": "Get ended webinar UUID.\n\n",
|
|
"metadata": {
|
|
"documentation_link": "https://developers.zoom.us/docs/api/"
|
|
},
|
|
"env_requirements": [
|
|
"zoom-python-client"
|
|
]
|
|
}
|
|
] |