Zoom API MCP Server

{ "server": { "url": "https://api.zoom.us/v2" }, "authentication": [ { "schema_parameters": { "in": "header" }, "type": "apiKey", "value": "API_KEY" } ], "operations": [ { "description": "List all the sub accounts that have been created by a master account.\u003cbr\u003e\u003cbr\u003eZoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:read:admin` \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "accounts" }, { "description": "Create a sub account under a master account. Your account must be a master account in order to create sub accounts. \u003cbr\u003e\u003cbr\u003eZoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us. for more details. Please note that the created account user will receive a confirmation email.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_create" }, { "description": "Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account.\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis).\u003cbr\u003e\u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_disassociate" }, { "description": "Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts\u0027 details. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and create sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account" }, { "description": "Get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.\u003cbr\u003e\u003cbr\u003eOnly master accounts can use this API. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "account_billing" }, { "description": "Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.\u003cbr\u003e\u003cbr\u003e This API can only be used by master accounts that pay all billiing charges of their associated sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "account_billing_update" }, { "description": "List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account. To list a regular Zoom account\u0027s invoices or a master account\u0027s invoices, provide `me` as the value of the `accountId` path parameter. To list a sub account\u0027s invoices, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan.\u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Additional Rate Limit:** You can make **one** API request per account(`accountId`) every **five** minutes until the daily limit is reached. This API has a daily limit of **6** requests per account(`accountId`).", "name": "account_billing_invoices" }, { "description": "Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e). \u003cbr\u003eTo retrieve a regular Zoom account\u0027s invoice details or a master account\u0027s invoice details, provide `me` as the value of `accountId` path parameter. To list a sub account\u0027s invoice details, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Additional Rate Limit:** You can make **one** API request every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**.", "name": "get_account_billing_invoice" }, { "description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account. \u003cbr\u003e **Scope**: `account:read:admin`. \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Scope:** account:read:admin", "name": "get_account_lock_settings" }, { "description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "update_account_lock_settings" }, { "description": "Get a sub account\u0027s [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).\u003cbr\u003e\u003cbr\u003e **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e To get managed domains of the master account, provide `me` as the value for accountId in the path parameter. Provide the sub account\u0027s Account ID as the value of accountId path parameter to get managed domains of the sub account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_managed_domain" }, { "description": "Update a sub account\u0027s options under the master account.\u003cbr\u003e \u003caside\u003eYour account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners. \u003c/aside\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis).\u003cbr\u003e\u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_options_update" }, { "description": "The current account owner can [change the owner of an account](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.\u003cbr\u003e Use this API to change the owner of a sub account. **Prerequisites**: \u003cbr\u003e * Account owner or admin permissions of an account. * The account making this API request must be on a pro or a hiigher plan with [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) privilege.\u003cbr\u003e\u003cbr\u003e **Scopes:** `account:write:admin` or `account:master`\u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e \u003cbr\u003e", "name": "update_account_owner" }, { "description": "Only [master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this API to enable BYOC(Bring your own carrier) option for a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**: \u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e", "name": "update_phone_settings" }, { "description": "After assigning a Zoom phone license to an account, an admin or account owner can proceed with the [initial Zoom phone set up](https://support.zoom.us/hc/en-us/articles/360001297663-Getting-started-with-Zoom-Phone-admin-#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13) using this API. **Scope**:\u003cbr\u003e * `phone:write:admin` `phone:write` **Prerequisites**: \u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "set_up_account" }, { "description": "Using this API, a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) owner can assign SIP trunk(s) to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "post_phone_s_i_p_trunk" }, { "description": "Update details of a SIP trunk that is assigned to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e Business or Enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "update_phone_s_i_p_trunk" }, { "description": "Get plan information of a sub account that is managed by a master account. \u003cbr\u003e\u003cbr\u003eThis API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Scopes:** `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "account_plans" }, { "description": "Subscribe a sub account to a Zoom plan using your master account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e", "name": "account_plan_create" }, { "description": "Subscribe a sub account to a Zoom addon plan. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher plan with master account option enabled. * The sub account must be a paid account. The billing charges for the sub account must be paid by its master account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "account_plan_addon_create" }, { "description": "Update an additional plan for a sub account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher plan with master account enabled. * The sub account must be a paid account. The billing charges for the sub account must be paid by the master account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "account_plan_addon_update" }, { "description": "[Cancel additional plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) of a sub account. The cancellation does not provide refund for the current subscription. The service remains active for the current session. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with master account option enabled. * The sub account must be a paid account.\u003cbr\u003e **Scope:** `billing:master`\u003cbr\u003e", "name": "account_plan_addon_cancel" }, { "description": "Update a base plan of a sub account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Scopes:** `billing:master`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The sub account must have a Pro or a higher plan.", "name": "account_plan_base_update" }, { "description": "[Cancel a base plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The sub account must have a Pro or a higher plan.", "name": "account_plan_base_delete" }, { "description": "Get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans) of an account. This API supports regular accounts as well as master and sub accounts. To get plan usage of a regular account, use the `account:read:admin` scope and provide \u201cme\u201d as the value of the `accountId` path parameter.To get plan usage of a master account, provide the keyword \"me\" as the value of the `accountId` path parameter and use the `billing:master` scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the `accountId` path parameter and use the `billing:master` scope. **Prerequisite**:\u003cbr\u003e Account type: master account on a paid Pro, Business or Enterprise plan.\u003cbr\u003e **Scope:** `billing:master` for master and sub accounts. `account:read:admin` for regular Zoom accounts.\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "get_plan_usage" }, { "description": "List [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. \u003e To access a password protected cloud recording, add an \"access_token\" parameter to the download URL and provide [JWT](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app) as the value of the \"access_token\". \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * A Pro or a higher paid plan with Cloud Recording option enabled.\u003cbr\u003e **Scopes**: `recording:read:admin` or `account:read:admin` If the scope `recording:read:admin` is used, the Account ID of the Account must be provided in the `accountId` path parameter to list recordings that belong to the Account. This scope only works for sub accounts. To list recordings of a master account, the scope must be `account:read:admin` and the value of `accountId` should be `me`.\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "get_account_cloud_recording" }, { "description": "Get the settings of an account.\u003cbr\u003e To get the settings of a master account, use `me` as the value for the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The account must be a paid account.\u003cbr\u003e **Scopes**: `account:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "account_settings" }, { "description": "Update the settings of a sub account that is under a master account.\u003cbr\u003e To update the settings of the master account, use `me` as the value of the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The sub account must be a paid account.\u003cbr\u003e **Scopes**: `account:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "account_settings_update" }, { "description": "Delete existing virtual background file(s) from an account. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "del_v_b" }, { "description": "Use this API to [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. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "upload_v_b" }, { "description": "Retrieve the list of internal [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) countries of a master account or a sub account. To list call-out enabled countries of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list call-out enabled countries of a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "list_internal_callout_countries" }, { "description": "Specify the list of [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) countries for a master account or a sub account. To add call-out enabled countries to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add call-out enabled countries to a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "add_callout_countries" }, { "description": "Delete a previously assigned [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) country from a master account or a sub account. To remove call-out country from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To remove call-out country from a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "delete_internal_call_out_country" }, { "description": "This API allows a master account with SIP Connected Audio plan to list internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) assigned to a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo list internal numbers of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list internal numbers of a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "list_internal_numbers" }, { "description": "This API allows a master account with SIP Connected Audio plan to assign internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) to a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "add_internal_numbers" }, { "description": "This API allows a master account with SIP Connected Audio plan to delete a previously assigned internal phone number from a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo delete an internal number from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To delete an internal number from a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "delete_internal_number" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u0027 IP telephony network, will be connected over this trunk rather than over the PSTN. \u003cbr\u003e\u003cbr\u003eUse this API to delete all internal numbers assigned to a sub account. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a master account\u003cbr\u003e **Scopes:** `sip_trunk:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_all_sip_numbers" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u0027 IP telephony network, will be connected over this trunk rather than over the PSTN. \u003cbr\u003e\u003cbr\u003eUse this API to assign internal numbers to a sub account. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a master account\u003cbr\u003e **Scopes:** `sip_trunk:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "assign_sip_trunk_numbers" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u0027 IP telephony network, will be connected over this trunk rather than over the PSTN. \u003cbr\u003e\u003cbr\u003e Using this API, a master account owner can copy the SIP Connected Audio configurations applied on the master account and enable those configurations on a sub account. The owner can also disable the configuration in the sub account where it was previously enabled. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * master account Owner\u003cbr\u003e **Scopes:** `sip_trunk:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "assign_s_i_p_config" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u2019 IP telephony network, will be connected over this trunk rather than over the PSTN.\u003cbr\u003e\u003cbr\u003e Use this API to list all the SIP trunks assigned to a master account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To retrieve SIP trunks of a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:read:admin` \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account must either be a master account or a sub account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.", "name": "list_s_i_p_trunks" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u2019 IP telephony network, will be connected over this trunk rather than over the PSTN.\u003cbr\u003e\u003cbr\u003eUse this API to assign SIP trunk(s) that are available on a master account to a sub account. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a master account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "assign_s_i_p_trunks" }, { "description": "Use this API to remove existing SIP trunk of a sub account.\u003cbr\u003e \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a master account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`", "name": "delete_s_i_p_trunk" }, { "description": "Get trusted domains of a sub account. To get the trusted domains of a master account, use `me` as the value for the `accountId` path parameter. **Prerequisites:**\u003cbr\u003e * The sub account must be a paid account.\u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "account_trusted_domain" }, { "description": "Disassociate a user from one Account and move the user to another Account under the same master account. With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use `me` as the value for `accountId`. In this scenario, \"me\" refers to the Account ID of the master account. To move a user from one sub account to another sub account, provide the sub account\u0027s Account ID as the value for `accountId`. **Prerequisites**: * The account should have Pro or a higher plan with master account option enabled. * The user whose account needs to be switched should not be an admin or an owner of that account. * The user should not have the same [managed domain](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner. **Scope:** `user:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "switch_user_account" }, { "description": "Download a [billed](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) invoice file of a Zoom account in PDF format. To download a regular account\u0027s invoice or a master account\u0027s invoice, provide `me` as the value of `accountId` path parameter. To download a sub account\u0027s invoice, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan.\u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **Rate Limit:** You can make **one** request to this API every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**.", "name": "download_invoice_p_d_f" }, { "description": "Zoom\u2019s [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) allows account administrators to set up an automated mechanism to record, collect and archive meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other compliance requirements.\u003cbr\u003e\u003cbr\u003e Use this API to retrieve archived meeting or webinar files of an account. **Scope:** `recording:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Enable cloud recording. * Follow the [enablement process](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data#h_01ENPBD3WR68D7FAKTBY92SG45) to access the archiving feature.", "name": "list_archived_files" }, { "description": "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. Use this API to delete a specific channel. **Scope:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e", "name": "delete_user_level_channel" }, { "description": "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. Use this API to get information about a specific channel. **Scope:** `chat_channel:read`\t\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e", "name": "get_user_level_channel" }, { "description": "Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created. **Scope:** `chat_channel:write`\t\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e", "name": "update_user_level_channel" }, { "description": "If you\u0027re no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eThis API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "leave_channel" }, { "description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eThis API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "join_channel" }, { "description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e", "name": "remove_a_user_level_channel_member" }, { "description": "A user under an organization\u2019s 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). Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized 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 will be set as company contact. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope**: `chat_contact:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_user_contacts" }, { "description": "A user under an organization\u2019s 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). Call this API to get information on a specific contact of the Zoom user. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eThis API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope**: `chat_contact:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_user_contact" }, { "description": "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. Use this API to list a user\u0027s chat channels. **Scope**: `chat_channel:read` or `chat_channel:read:admin`\u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API supports both user-managed apps and account-level apps. However, in an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, to list channels of another user in the same Zoom account, the user calling this API must have a \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003erole\u003c/a\u003e that has \u003cb\u003eView or Edit\u003c/b\u003e permission for the Chat channels feature.\u003c/p\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_channels" }, { "description": "Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.\u003cbr\u003e **Scopes**:`chat_channel:write` or `chat_channel:write:admin`\u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API supports both user-managed apps and account-level apps. However, in an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003erole\u003c/a\u003e that has \u003cb\u003eEdit\u003c/b\u003e permission for the Chat channels feature.\u003c/p\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "create_channel" }, { "description": "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. Use this API to delete a specific channel. **Scope:** `chat_channel:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e", "name": "delete_channel" }, { "description": "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. Use this API to get information about a specific channel. **Scope:** `chat_channel:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has View or Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e", "name": "get_channel" }, { "description": "Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel created by a user. \u003cbr\u003e\u003cbr\u003e **Scope:** `chat_channel:write:admin`\t\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channel\u003c/b\u003e.\u003c/p\u003e", "name": "update_channel" }, { "description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. List all the members of a channel using this API. \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has View or Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e **Scopes:** `chat_channel:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_channel_members" }, { "description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to invite members that are in a user\u0027s contact list to a channel. The maximum number of members that can be added at once with this API is 5. **Scope:** `chat_channel:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e", "name": "invite_channel_members" }, { "description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e", "name": "remove_a_channel_member" }, { "description": "A Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user\u0027s chat messages between the user and an individual contact or a chat channel.\u003cbr\u003e In the query parameter, you must provide either of the following:\u003cbr\u003e * `to_contact`: The email address of the contact with whom the user conversed by sending/receiving messages. * `to_channel`: The channel ID of the channel to/from which the user has sent and/or received messages. \u003cbr\u003e **Specify a date** in the `date` query parameter to view messages from that date. If a date is not provided, the default value for the query will be the **current date**.\u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003erole\u003c/a\u003e that has \u003cb\u003eView or Edit\u003c/b\u003e permission for Chat Messages.\u003c/p\u003e\u003cbr\u003e \u003cbr\u003e**Scopes:** `chat_message:read`, `chat_message:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_chat_messages" }, { "description": "Send chat messages on Zoom to either an individual user who is 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. To send a message to a contact, provide the contact\u0027s email address in the `to_contact` field. Similary, to send a message to a channel, provide the Channel Id of the Channel in `to_channel` field.\u003cbr\u003e \u003cbr\u003e**Scopes:** `chat_message:write`, `chat_message:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Messages\u003c/b\u003e.\u003c/p\u003e", "name": "senda_chat_message" }, { "description": "Delete a chat message that you previously sent to a contact or a channel. In the query parameter, you must provide either of the following:\u003cbr\u003e * `to_contact`: The email address of the contact to whom you sent the message. Use this parameter to delete a message sent to an individual contact in Zoom. * `to_channel`: The channel ID of the channel where you sent the message. Use this parameter to delete a message sent to a channel in Zoom. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Messages\u003c/b\u003e.\u003c/p\u003e **Scope:** `chat_message:write`, `chat_message:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "delete_chat_message" }, { "description": "Each chat message has a unique identifier. Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the `messageId` parameter. The ID can be retrieved from List User\u0027s Chat Messages API. Additionally, as a query parameter, you must provide either the **email address** of the contact or the **Channel ID** of the channel where the message was sent. **Scope:** `chat_message:write`,`chat_message:write:admin`\t\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Messages\u003c/b\u003e.\u003c/p\u003e **Scope:** `chat_message:write`, `chat_message:write:admin`\u003cbr\u003e", "name": "edit_message" }, { "description": "A user under an organization\u0027s 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. \u003cbr\u003e\u003cbr\u003e **Scopes:** `contact:read:admin`, `contact:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "search_company_contacts" }, { "description": "List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account.\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "groups" }, { "description": "Create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. You can add a maximum of 100 groups in one account per day. If you go over, you will get an error. You can add a maximum of 5000 groups in one account. **Prerequisite**: Pro or higher account.\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "group_create" }, { "description": "Delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "group_delete" }, { "description": "Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "group" }, { "description": "Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "group_update" }, { "description": "Retrieve a [group\u0027s](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. \u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e 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.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_group_lock_settings" }, { "description": "Update a [group\u0027s](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. \u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e 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.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "group_locked_settings" }, { "description": "List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "group_members" }, { "description": "Add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "group_members_create" }, { "description": "Delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "group_members_delete" }, { "description": "If a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group\u0027s settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.\u003cbr\u003e\u003cbr\u003e Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or higher account\u003cbr\u003e **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_a_group_member" }, { "description": "Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_group_settings" }, { "description": "Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e 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.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_group_settings" }, { "description": "Delete existing virtual background file(s) from an account. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `group:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "del_group_v_b" }, { "description": "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. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `group:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e `", "name": "upload_group_v_b" }, { "description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "device_list" }, { "description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cbr\u003e", "name": "device_create" }, { "description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "device_delete" }, { "description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:write:admin`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "device_update" }, { "description": "Send chatbot messages from your marketplace chatbot app.\u003cbr\u003e\u003cbr\u003e **Scopes:** `imchat:bot`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Authorization Flow**: Client Credentials Flow\u003cbr\u003e\u003cbr\u003e To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`. \u003cbr\u003eUse `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`\u003cbr\u003e\u003cbr\u003e Next, use the token recieved (access_token) as a bearer token while making the POST /im/chat/messages request to send chatbot messages.\u003cbr\u003e\u003cbr\u003e Learn more about how to authorize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.", "name": "sendchatbot" }, { "description": "Delete a message that was sent by your chatbot app.\u003cbr\u003e\u003cbr\u003e **Scopes:** `imchat:bot`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e**Authorization Flow**: Client Credentials Flow\u003cbr\u003e\u003cbr\u003eTo get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`. \u003cbr\u003eUse `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`\u003cbr\u003e\u003cbr\u003e Next, use the token received (access_token) as a bearer token while making the DELETE /im/chat/messages/{message_id} request to delete a message.\u003cbr\u003e\u003cbr\u003e Learn more about how to authotize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.", "name": "delete_a_chatbot_message" }, { "description": "Edit a message that was [sent](https://marketplace.zoom.us/docs/api-reference/zoom-api/im-chat/sendchatbot) by your Chatbot app.\u003cbr\u003e After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API. **Scope:** `imchat:bot`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Authorization Flow**: Client Credentials Flow\u003cbr\u003e\u003cbr\u003e To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`. \u003cbr\u003eUse `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`\u003cbr\u003e\u003cbr\u003e Next, use the token received (access_token) as a bearer token while making the PUT /im/chat/messages/{message_id} request to edit a chatbot message.\u003cbr\u003e\u003cbr\u003e Learn more about how to authotize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.", "name": "edit_chatbot_message" }, { "description": "Retrieve IM Chat sessions for a specified period of time. \u003caside\u003eNote: This API only supports Oauth2.\u003c/aside\u003e\u003cbr\u003e **Scopes:** `imchat:read, imchat:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` Please see our [announcements page related to this deprecation](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice).", "name": "im_chat_sessions" }, { "description": "Retrieve IM chat messages for a specified period of time. \u003caside\u003eNote: This API only supports oauth2.\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e **Scopes:** `imchat:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e Please see our [announcements page related to this deprecation](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice).", "name": "im_chat_messages" }, { "description": "List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).\u003cbr\u003e\u003cbr\u003e **Scopes**: `imgroup:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "im_groups" }, { "description": "Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "im_group_create" }, { "description": "Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.\u003cbr\u003e\u003cbr\u003e Scopes: `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "im_group_delete" }, { "description": "Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.\u003cbr\u003e\u003cbr\u003e Scopes: `imgroup:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "im_group" }, { "description": "Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "im_group_update" }, { "description": "List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).\u003cbr\u003e\u003cbr\u003e **Scope:** `imgroup:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "im_group_members" }, { "description": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.\u003cbr\u003e\u003cbr\u003e **Scope:** `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "im_group_members_create" }, { "description": "Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.\u003cbr\u003e\u003cbr\u003e Scopes: `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "im_group_members_delete" }, { "description": "Send chat message to a user. \u003caside\u003eNote: This API only supports OAuth 2.0.\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e**Scope:** `imchat:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "sendimmessages" }, { "description": "Get IM Chat messages for a specified period of time. \u003caside\u003eNote: This API only supports Oauth2.\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e **Scopes:** `imchat:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e Please see the [announcements page related to this deprecation.](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice)", "name": "listimmessages" }, { "description": "Use this API to control the [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) **recording features** such as starting a recording, stopping a recording, pausing a recording, and resuming a recording. This API only works for Cloud Recordings and not for local recordings. **Prerequisite:** * The meeting must be a live meeting. * Cloud Recording must be enabled. * The user using this API must either be the host or alternative host of the meeting. **Scopes:** `meeting:write`, `meeting:write:admin`, `meeting:master`", "name": "in_meeting_recording_control" }, { "description": "Delete a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_delete" }, { "description": "Retrieve the details of a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting" }, { "description": "Update the details of a meeting.\u003cbr\u003eThis API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_update" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Host user type must be **Pro** or higher plan. * Polling feature must be enabled in the host\u0027s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.", "name": "create_batch_polls" }, { "description": "Retrieve the meeting invite note that was sent for a specific meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_invitation" }, { "description": "Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to get a meeting\u0027s live stream configuration details such as Stream URL, Stream Key and Page URL.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Meeting host must be a licensed user with a Pro or higher plan.\u003cbr\u003e * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_live_stream_details" }, { "description": "Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting\u0027s live stream information.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Meeting host must have a Pro license.\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_live_stream_update" }, { "description": "Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting\u0027s live stream.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Meeting host must have a Pro license.\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_live_stream_status_update" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Host user type must be **Pro** or higher plan. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.", "name": "meeting_polls" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Host user type must be **Pro** or higher plan. * Polling feature must be enabled in the host\u0027s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.", "name": "meeting_poll_create" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).\u003cbr\u003e **Scopes**: `meeting:write:admin` `meeting:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Host user type must be **Pro**. * Polling feature should be enabled in the host\u0027s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.", "name": "meeting_poll_delete" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_poll_get" }, { "description": "Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:write:admin` `meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_poll_update" }, { "description": "Delete all recording files of a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `recording:write:admin` `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**: * Cloud Recording should be enabled on the user\u0027s account.\u003cbr\u003e", "name": "recording_delete" }, { "description": "Get all the [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting or Webinar instance.\u003cbr\u003e\u003cbr\u003e The recording files can be downloaded via the `download_url` property listed in the response. \u003e To access a password protected cloud recording, add an \"access_token\" parameter to the download URL and provide OAuth access token or [JWT](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app) as the value of the \"access_token\". \u003cbr\u003e **Scopes:** `recording:read:admin` `recording:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "recording_get" }, { "description": "Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to list registrants of **On-demand Cloud Recordings** of a past meeting.\u003cbr\u003e **Scopes:** `recording:read:admin`, `recording:read`.\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meeting_recording_registrants" }, { "description": "Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.\u003cbr\u003e **Scopes:** `recording:write:admin`, `recording:write`.\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_recording_registrant_create" }, { "description": "For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.\u003cbr\u003e **Scopes:** `recording:read:admin`, `recording:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "recording_registrants_questions_get" }, { "description": "For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording.\u003cbr\u003e **Scopes:** `recording:write:admin`, `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "recording_registrant_question_update" }, { "description": "A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. Use this API to update a registrant\u0027s status. **Scopes:** `recording:write:admin`, `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meeting_recording_registrant_status" }, { "description": "Retrieve settings applied to a meeting\u0027s [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).\u003cbr\u003e\u003cbr\u003e **Scopes**: `recording:read:admin` `recording:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cbr\u003e", "name": "recording_setting_update" }, { "description": "Update settings applied to a meeting\u0027s [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)\u003cbr\u003e\u003cbr\u003e **Scopes**: `recording:write:admin` `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cbr\u003e", "name": "recording_settings_update" }, { "description": "Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `recording:write:admin` `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * A Pro user with Cloud Recording enabled.", "name": "recording_status_update" }, { "description": "Delete a sprecific recording file from a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `recording:write:admin` `recording:write`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "recording_delete_one" }, { "description": "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 meeting.\u003cbr\u003e **Scopes:** `recording:write:admin` `recording:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "recording_status_update_one" }, { "description": "A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). Use this API to list users that have registered for a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meeting_registrants" }, { "description": "Register a participant for a meeting.\u003cbr\u003e\u003cbr\u003e Note that there is a maximum limit of 4999 registrants per meeting and users will see an error if the capacity has reached. **Prerequisite:**\u003cbr\u003e * Host user type must be \"Licensed\". **Scopes:** `meeting:write:admin` `meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_registrant_create" }, { "description": "List registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\u003cbr\u003e **Scopes:** `meeting:read`, `meeting:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_registrants_questions_get" }, { "description": "Update registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:write`, `meeting:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_registrant_question_update" }, { "description": "Update a meeting registrant\u0027s status by either approving, cancelling or denying a registrant from joining the meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meeting_registrant_status" }, { "description": "Delete a meeting registrant.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:write:admin` `meeting:write`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meetingregistrantdelete" }, { "description": "Update the status of a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:write:admin` `meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "meeting_status" }, { "description": "Retrieve survey results from [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). \u003cbr\u003e 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. **Prerequisites:** * Business or higher account * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled. **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "dashboard_client_feedback" }, { "description": "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). \u003cbr\u003e 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. **Prerequisites:** * Business or higher account * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled. **Scope:** `dashboard_home:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` `", "name": "dashboard_client_feedback_detail" }, { "description": "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\u0027 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. To get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [Get Zoom Meetings Client Feedback API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).\u003cbr\u003e **Scopes:** `dashboard:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "list_meeting_satisfaction" }, { "description": "A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. \u003caside class=\u0027notice\u0027\u003eWe 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\".\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan. * Room Connector must be enabled on the account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_crc:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "dashboard_c_r_c" }, { "description": "Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat Client.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e 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. **Scope:** `dashboard_im:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business or a higher plan.", "name": "dashboard_i_m" }, { "description": "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.\u003cbr\u003e **Scope:** `dashboard_home:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business or a higher plan. * Zoom Room must be enabled in the account.", "name": "dashboard_issue_zoom_room" }, { "description": "Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount. \u003cbr\u003e 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. **Scope:** `dashboard_home:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan. * Zoom Room must be enabled in the account.", "name": "dashboard_issue_detail_zoom_room" }, { "description": "List total live or past meetings that occurred during a specified period of time. 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.\u003cbr\u003e 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.\u003cbr\u003e **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan.\u003cbr\u003e\u003cbr\u003e", "name": "dashboard_meetings" }, { "description": "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.\u003cbr\u003e 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. \u003cbr\u003e **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan.", "name": "dashboard_meeting_detail" }, { "description": "Get a list of participants from live or past meetings.\u003cbr\u003e\u003cbr\u003e If you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`. \u003cbr\u003e 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. **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** Business or a higher plan.", "name": "dashboard_meeting_participants" }, { "description": "Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.\u003cbr\u003eIf you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.\u003cbr\u003e \u003cbr\u003e 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.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan.", "name": "dashboard_meeting_participants_q_o_s" }, { "description": "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. **Prerequisites:** * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting. * The user making the API request must be enrolled in a Business or a higher plan. \u003cbr\u003e **Scope:** `dashboard_meetings:read:admiin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "participant_feedback" }, { "description": "Retrieve the sharing and recording details of participants from live or past meetings.\u003cbr\u003e **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan.", "name": "dashboard_meeting_participant_share" }, { "description": "Retrieve the quality of service for participants from live or past meetings. This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields. \u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_meetings:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "dashboard_meeting_participant_q_o_s" }, { "description": "List all the live or past webinars from a specified period of time. \u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.", "name": "dashboard_webinars" }, { "description": "Retrieve details from live or past webinars.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.", "name": "dashboard_webinar_detail" }, { "description": "Retrieve details on participants from live or past webinars.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.", "name": "dashboard_webinar_participants" }, { "description": "Retrieve a list of participants from live or past webinars and the quality of service they received.\u003cbr\u003eThis data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** * Business, Education or API Plan with Webinar add-on.", "name": "dashboard_webinar_participants_q_o_s" }, { "description": "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. **Prerequisites:** * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting. * The user making the API request must be enrolled in a Business or a higher plan. \u003cbr\u003e **Scope:** `dashboard_webinars:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "participant_webinar_feedback" }, { "description": "Retrieve the sharing and recording details of participants from live or past webinars. \u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.", "name": "dashboard_webinar_participant_share" }, { "description": "Retrieve details on the quality of service that participants from live or past webinars recieved.\u003cbr\u003eThis data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.", "name": "dashboard_webinar_participant_q_o_s" }, { "description": "List information on all Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_zr:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.", "name": "dashboard_zoom_rooms" }, { "description": "Get top 25 issues of Zoom Rooms.\u003cbr\u003e **Scopes:** `dashboard_zr:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.", "name": "dashboard_zoom_room_issue" }, { "description": "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. Use this API to retrieve information on a specific room.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_zr:read:admin`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`**Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.", "name": "dashboard_zoom_room" }, { "description": "**Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.** To learn about saving the in-meeting chat files via Zoom Client, refer to the [Saving in-meeting chat](https://support.zoom.us/hc/en-us/articles/115004792763-Saving-in-meeting-chat) guide. List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. \u003cbr\u003e\u003cbr\u003e **Scope:** `meeting:read`, `meeting:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_past_meeting_files" }, { "description": "Get a list of ended meeting instances\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "past_meetings" }, { "description": "[Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.\u003cbr\u003e\u003cbr\u003e **Scopes**: `meeting:read:admin`, `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.", "name": "list_past_meeting_polls" }, { "description": "Get details on a past meeting. \u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003e **Note**: Please double encode your UUID when using this API if the UUID begins with a \u0027/\u0027or contains \u0027//\u0027 in it.", "name": "past_meeting_details" }, { "description": "Retrieve information on participants from a past meeting. \u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` **Prerequisites:**\u003cbr\u003e * Paid account on a Pro or higher plan. \u003cbr\u003e \u003cbr\u003e **Note**: Please double encode your UUID when using this API if the UUID begins with a \u0027/\u0027or contains \u0027//\u0027 in it.", "name": "past_meeting_participants" }, { "description": "List absentees of a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "webinar_absentees" }, { "description": "**Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.** List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. \u003cbr\u003e\u003cbr\u003e **Scope:** `webinar:read`, `webinar:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "list_past_webinar_files" }, { "description": "List past webinar instances.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "past_webinars" }, { "description": "Use this API to list all the participants who attended a webinar hosted in the past. \u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "list_webinar_participants" }, { "description": "The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. **Prerequisites:**\u003cbr\u003e * [Webinar license](https://zoom.us/webinar)\u003cbr\u003e **Scopes**: `webinar:read:admin`, `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_past_webinar_poll_results" }, { "description": "The [Question \u0026 Answer (Q\u0026A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.\u003cbr\u003e Use this API to list Q\u0026A of a specific Webinar. **Prerequisites:**\u003cbr\u003e * [Webinar license](https://zoom.us/webinar)\u003cbr\u003e **Scopes**: `webinar:read:admin`, `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_past_webinar_q_a" }, { "description": "Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area phone, 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.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account with Zoom Phone license.\u003cbr\u003e **Scopes:** `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_auto_receptionist" }, { "description": "An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, 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.\u003cbr\u003e Use 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 display name and extension number assigned to the main auto receptionist.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account with Zoom Phone license.\u003cbr\u003e **Scopes:** `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_auto_receptionist" }, { "description": "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-). **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "unassign_all_phone_nums_auto_receptionist" }, { "description": "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\". **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "assign_phone_numbers_auto_receptionist" }, { "description": "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-). **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "unassign_a_phone_num_auto_receptionist" }, { "description": "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\u0027t be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\u003cbr\u003eUse this API to list all the blocked lists in an acccount.\u003cbr\u003e **Prerequisites:** * Pro or higher account plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_blocked_list" }, { "description": "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\u0027t be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\u003cbr\u003eUse this API to create a blocked list and add a number to that blocked list.\u003cbr\u003e **Prerequisites:** * Pro or higher account plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_anumber_to_blocked_list" }, { "description": "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\u0027t be able to dial those numbers). \u003cbr\u003eUse 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.\u003cbr\u003e **Prerequisites:** * Pro or higher account plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_blocked_list" }, { "description": "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\u0027t be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\u003cbr\u003eUse this API to get information about a specific blocked list.\u003cbr\u003e **Prerequisites:** * Pro or higher account plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_blocked_list" }, { "description": "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\u0027t be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\u003cbr\u003eUse this API to update information on the blocked list.\u003cbr\u003e **Prerequisites:** * Pro or higher account plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_blocked_list" }, { "description": "Use this API to add BYOC phone numbers(provided to you by your carrier) to Zoom. **Scope:** `phone:write:admin` or `phone:write` or `phone:master` **Prerequisites:**\u003cbr\u003e * The account must hold a business or enterprise plan and Zoom Phone license. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "add_b_y_o_c_number" }, { "description": "Retrieve [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs) for an account. **Scopes**: `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisite:**\u003cbr\u003e 1. Business or Enterprise account\u003cbr\u003e 2. A Zoom Phone license\u003cbr\u003e 3. Account Owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone Management\u003cbr\u003e", "name": "account_call_logs" }, { "description": "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.\u003cbr\u003e Use this API to list Call queues.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_call_queues" }, { "description": "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.\u003cbr\u003e Use this API to [create a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413).\u003cbr\u003e You can add phone users or common area phones to call queues. **Prerequisites:**\u003cbr\u003e * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "create_call_queue" }, { "description": "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.\u003cbr\u003e Use this API to delete a Call Queue.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_call_queue" }, { "description": "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.\u003cbr\u003e Use this API to get information on a specific Call Queue.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_call_queue" }, { "description": "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.\u003cbr\u003e Use this API to update information of a specific Call Queue.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_call_queue" }, { "description": "A call queue manager has the privileges to maanage the call queue\u0027s voicemail inbox and recordings, change all call queue settings and call queue policy settings.\u003cbr\u003e\u003cbr\u003e Use this API to to set another phone user as the [call queue manager](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_db06854b-e6a3-4afe-ba15-baf58f31f90c). **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "change_call_queue_manager" }, { "description": "Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "unassign_all_members" }, { "description": "Add phone users and/or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) as members to a specific Call Queue.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_members_to_call_queue" }, { "description": "Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "unassign_member_from_call_queue" }, { "description": "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).\u003cbr\u003e If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. \u003cbr\u003e **Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license \u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "unassign_a_phone_num_call_queue" }, { "description": "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).\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "assign_phone_to_call_queue" }, { "description": "After assigning a phone number, you can unbind it if you don\u0027t 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).\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license \u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "un_assign_phone_num_call_queue" }, { "description": "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.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account with Zoom Phone license. * [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. \u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_call_queue_recordings" }, { "description": "List all Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that are enabled for a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom phone license. \u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_calling_plans" }, { "description": "A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don\u0027t belong to a specific employees, you could add a common area phone so that any person can use it.\u003cbr\u003e Use this API to [list all common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.\u003cbr\u003e\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_common_area_phones" }, { "description": "A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don\u0027t belong to a specific employees, you could add a common area phone so that any person can use it.\u003cbr\u003e Use this API to [add a common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones#h_2d0da347-c35a-4993-9771-e21aaa568deb).\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_common_area_phone" }, { "description": "A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don\u0027t belong to a specific employees, you could add a common area phone so that any person can use it.\u003cbr\u003e Use this API to remove the [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) from Zoom Phone System in an account.\u003cbr\u003e\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_common_area_phone" }, { "description": "A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don\u0027t belong to a specific employees, you could add a common area phone so that any person can use it.\u003cbr\u003e Use this API to get details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.\u003cbr\u003eFor the `commonAreaPhoneId`, use the unique identifier or the Mac address of the common area phone. The Mac address can be hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c).\u003cbr\u003e\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e **Scopes:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_common_area_phone" }, { "description": "A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don\u0027t belong to a specific employees, you could add a common area phone so that any person can use it.\u003cbr\u003e Use this API to update details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.\u003cbr\u003e\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_common_area_phone" }, { "description": "The [main company number](https://support.zoom.us/hc/en-us/articles/360028553691) can be used by external callers to reach your phone users (by dialing the main company number and the user\u0027s extension). It can also be used by phone users in your account as their caller ID while making calls.\u003cbr\u003e\u003cbr\u003e Use this API to [change the main company number](https://support.zoom.us/hc/en-us/articles/360028553691#h_82414c34-9df2-428a-85a4-efcf7f9e0d72) of an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "change_main_company_number" }, { "description": "List all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account. To view devices that have not yet been assigned to a user, set the value of the `type` query parameter as `unassigned` and to view devices that have been assigned, set the value as `assigned`.\u003cbr\u003e\u003cbr\u003e **Scopes:** `phone:read:admin` \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license * Account owner or admin permissions\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_phone_devices" }, { "description": "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](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da) to a user. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_phone_device" }, { "description": "Remove a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * Device must not have been assigned to a user.\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_device" }, { "description": "Get detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_device" }, { "description": "Update information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Phone license * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_a_device" }, { "description": "Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call. **Prerequisites:** * Business, or Education account * Zoom Phone license \u003cbr\u003e\u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin`\u003cbr\u003e **Rate Limit Label:** `Heavy`", "name": "list_call_logs_metrics" }, { "description": "Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account. **Prerequisites:** * Business, or Education account * Zoom Phone license \u003cbr\u003e\u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin`\u003cbr\u003e **Rate Limit Label:** `Light`", "name": "get_call_qo_s" }, { "description": "Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. Use this API to list call log details of a specific call. **Prerequisites:** * Business, or Education account * Zoom Phone license \u003cbr\u003e\u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin`\u003cbr\u003e **Rate Limit Label:** `Light`", "name": "get_call_log_metrics_details" }, { "description": "A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters. **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_account_phone_numbers" }, { "description": "A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to get details on a specific Phone number in a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_phone_number_details" }, { "description": "Update phone number details. **Scopes:** * `phone:write` `phone:write:admin` * `phone:master` **Prerequisite:** * Paid account **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_phone_number_details" }, { "description": "List [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) of an account.\u003cbr\u003e **Scopes:**\u003cbr\u003e * `phone:read:admin` `phone:write:admin` **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges.", "name": "get_phone_recordings" }, { "description": "The **Phone System operation logs report** allows account owners and admins to view monthly Zoom phone related admin operation details. Use 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).\u003cbr\u003e\u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e \u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Account must be enrollled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan", "name": "get_p_s_operation_logs" }, { "description": "This API lets you retrieve a list of all the phone template settings previously created. \u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:read:admin` or `phone:read` \u003cbr\u003e**Prerequisites**: \u003cbr\u003e 1. Business or enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "list_setting_templates" }, { "description": "This API lets you create a Zoom Phone setting template for an account. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. Settings include profile, policy and user settings. After creating a phone template, the settings defined via this request will become the default settings for an account. \u003cbr\u003e\u003cbr\u003e **Scope**: * `phone:write:admin` `phone:write` **Prerequisites**: 1. Business or enterprise Zoom account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e \u003cbr\u003e", "name": "add_setting_template" }, { "description": "This API lets you retrieve a specific account phone template previously created. \u003cbr\u003e **Scope**: \u003cbr\u003e * `phone:write:admin` or `phone:write` **Prerequisites**: \u003cbr\u003e 1. Business or Enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "get_setting_template" }, { "description": "Use this API to update or modify profile settings for the phone template. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. After you\u0027ve modified a template, click **User Settings** to set up settings for Call Handling, Desk Phone, and Others. \u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:write:admin` or `phone:write` **Prerequisites**: \u003cbr\u003e 1. Business or Enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "update_setting_template" }, { "description": "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 area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to list all the Shared Line Groups. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges \u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_shared_line_groups" }, { "description": "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 area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to create a shared line group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "create_a_shared_line_group" }, { "description": "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 area phones. Use this API to delete a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_shared_line_group" }, { "description": "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 area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to list all the Shared Line Groups. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **Scopes:** `phone:read:admin` or `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_shared_line_group" }, { "description": "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 area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to update information of a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_a_shared_line_group" }, { "description": "Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group\u0027s phone number and voicemail. Use this API to unassign **all** the existing members from a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_members_of_s_l_g" }, { "description": "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 area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to [add 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. Note that a member can only be added to one shared line group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_members_to_shared_line_group" }, { "description": "Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group\u0027s phone number and voicemail. Use this API to unassign **a specific member** from a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_member_s_l_g" }, { "description": "Use this API to assign 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). **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "assign_phone_numbers_s_l_g" }, { "description": "Use this API to unassign 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). **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_phone_number_s_l_g" }, { "description": "List [BYOC SIP trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf) that are assigned to an account. **Scopes**:\u003cbr\u003e * `phone:write:admin` or `phone:master`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or Enterprise Account \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "list_b_y_o_c_s_i_p_trunk" }, { "description": "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.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). * Pro or a higher account with Zoom Phone enabled. **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_phone_sites" }, { "description": "Sites allow you to organize Zoom Phone users in your organization. Use this API to create a [Site](https://support.zoom.us/hc/en-us/articles/360020809672).\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). * Pro or a higher account with Zoom Phone enabled. **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "create_phone_site" }, { "description": "Sites allow you to organize Zoom Phone users in your organization. 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. **Prerequisites:** \u003cbr\u003e * Account must have a Pro or a higher plan with Zoom Phone license. * [Multiple Sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) must be enabled.\u003cbr\u003e **Scope:** `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_phone_site" }, { "description": "Sites allow you to organize Zoom Phone users in your organization. Use this API to get information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). **Prerequisites:** \u003cbr\u003e * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_a_site" }, { "description": "Sites allow you to organize Zoom Phone users in your organization. Use this API to update information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). **Prerequisites:** \u003cbr\u003e * Account must have a Pro or a higher plan with Zoom Phone license. * **Scope:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_site_details" }, { "description": "List all the users on an account who have been assigned Zoom Phone licenses.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "list_phone_users" }, { "description": "Retrieve a user\u0027s [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` **Prerequisites** : 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user" }, { "description": "Update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user\u0027s profile. **Scopes:** `phone:write` `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "update_user_profile" }, { "description": "Retrieve a [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) user\u0027s call logs. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_call_logs" }, { "description": "Delete a user\u0027s [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). **Scopes:** `phone:write`, `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** 1. User must belong to a Business or an Enterprise account. 2. User must hold a Zoom Phone license.", "name": "delete_call_log" }, { "description": "Assign [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. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "assign_calling_plan" }, { "description": "Unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that was previously assigned to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "unassign_calling_plan" }, { "description": "Assign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "assign_phone_number" }, { "description": "Unassign [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) of a Zoom phone user. \u003cbr\u003e After assigning a phone number, you can remove it if you don\u0027t want it to be assigned to anyone. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license 3. User must have been previously assigned a Zoom Phone number.", "name": "unassign_phone_number" }, { "description": "Retrieve a user\u0027s zoom [phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_recordings" }, { "description": "Retrieve a user\u0027s zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_settings" }, { "description": "Remove the shared voicemail access settings that were previously assigned to a user. To view these settings in your Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**: `phone:write:admin`\u003cbr\u003e\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "delete_user_setting" }, { "description": "Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to update the voicemail access permissions of a user. To view these settings in the Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**: \u003cbr\u003e`phone:write:admin`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e Business or Enterprise Account", "name": "update_user_setting" }, { "description": "Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user. To view these settings in the Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**:`phone:write:admin`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**: \u003cbr\u003e Business or Enterprise Account", "name": "add_user_setting" }, { "description": "Retrieve a user\u0027s Zoom Phone voicemails. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_voice_mails" }, { "description": "Delete a [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages) from a Zoom account. **Scope:** `phone:write:admin` or `phone:write` **Prerequisite**: * The account must have activted Zoom Phone license. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "delete_voicemail" }, { "description": "Retrieve a list of sign in / sign out activity logs [report](https://support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.\u003cbr\u003e **Prerequisites**\u003cbr\u003e * Pro or higher plan.\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "report_sign_in_sign_out_activities" }, { "description": "Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days. \u003cbr\u003e **Prerequisites**\u003cbr\u003e * Pro or higher plan.\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "report_cloud_recording" }, { "description": "Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.\u003cbr\u003e **Prerequisites**\u003cbr\u003e * Pro or higher plan.\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "report_daily" }, { "description": "Get a detailed report for a past meeting. \u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan.\u003cbr\u003e", "name": "report_meeting_details" }, { "description": "Get participant report for a past meeting.\u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan.\u003cbr\u003e", "name": "report_meeting_participants" }, { "description": "Retrieve a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan.\u003cbr\u003e", "name": "report_meeting_polls" }, { "description": "The [Operations Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.\u003cbr\u003e Use this API to retrieve operation logs report for a specified period of time.\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan.", "name": "report_operation_logs" }, { "description": "The [telephone report](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or higher plan.", "name": "report_telephone" }, { "description": "A user is considered to be an active host during the month specified in the \"from\" and \"to\" range, if the user has hosted at least one meeting during this period. If the user didn\u0027t host any meetings during this period, the user is considered to be inactive.\u003cbr\u003eThe Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.\u003cbr\u003eThe Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. \u003cbr\u003eYou can specify the type of report and date range using the query parameters.\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan.", "name": "report_users" }, { "description": "Retrieve [report](https://support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on a past meeting for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. Meetings will only be returned in the response if the meeting has two or more unique participants. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan.", "name": "report_meetings" }, { "description": "Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Webinar add-on.", "name": "report_webinar_details" }, { "description": "Get detailed report on each attendee of a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.", "name": "report_webinar_participants" }, { "description": "Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).\u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.", "name": "report_webinar_polls" }, { "description": "The Question \u0026 Answer (Q\u0026A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.", "name": "report_webinar_q_a" }, { "description": "List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account **Scopes:** `role:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites** : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions.", "name": "roles" }, { "description": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. **Pre-requisite:**\u003cbr\u003e * Pro or higher plan. * For setting the initial role, you must be the Account Owner.\u003cbr\u003e * For subsequent role management, you must be the Account Owner or user with role management permissions.\u003cbr\u003e **Scopes:** `role:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "create_role" }, { "description": "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. Use this API to delete a role.\u003cbr\u003e **Pre-requisite:**\u003cbr\u003e * A Pro or higher plan.\u003cbr\u003e * For role management and updates, you must be the Account Owner or user with role management permissions. **Scopes:** `role:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_role" }, { "description": "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 of privileges. Use 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).\u003cbr\u003e **Pre-requisite:**\u003cbr\u003e * A Pro or higher plan.\u003cbr\u003e * For role management and updates, you must be the Account Owner or user with role management permissions. **Scopes:** `role:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_role_information" }, { "description": "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. Use this API to change the privileges, name and description of a specific role.\u003cbr\u003e **Pre-requisite:**\u003cbr\u003e * A Pro or higher plan.\u003cbr\u003e * For role management and updates, you must be the Account Owner or user with role management permissions.\u003cbr\u003e**Scopes:** `role:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_role" }, { "description": "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. **Scope:** `role:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e**Prerequisites:**\u003cbr\u003e * A Pro or a higher plan.", "name": "role_members" }, { "description": "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. **Scopes:** `role:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * A Pro or a higher plan.", "name": "add_role_members" }, { "description": "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\u0027s role. **Scope:** `role:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * A Pro or a higher plan.", "name": "role_member_delete" }, { "description": "Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_zoom_rooms" }, { "description": "Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "add_a_room" }, { "description": "Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual Room Profile, use [Get Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/getzrprofile) instead. **Prerequisites:**\u003cbr\u003e * Zoom account owner or Zoom Rooms admin permissions\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_account_profile" }, { "description": "Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use [Update Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. **Prerequisites:**\u003cbr\u003e * Zoom account owner or Zoom Rooms admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_acc_profile" }, { "description": "Get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_account_settings" }, { "description": "Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_zoom_room_acc_settings" }, { "description": "List information about existing [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage) content in a Zoom account.\u003cbr\u003e You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the [Digital Signage Content](https://zoom.us/digitalsignage#/) page listed under **Room Management**. **Prerequisites:** * Pro or a higher account with Zoom Rooms. * Existing content files or folder in [Digital Signage Content](https://zoom.us/digitalsignage#/) page.", "name": "list_digital_signage_content" }, { "description": "Display or hide E911 emergency alert text content from [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). **Scope:** `room:write:admin` **Prerequisites:**\u003cbr\u003e * [Zoom Rooms](https://zoom.us/zoomrooms/software) 5.3.0 or higher * Zoom Rooms digital signage must be [enabled](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-Digital-Signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd)", "name": "manage_e911signage" }, { "description": "A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher\u003cbr\u003e\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_z_r_locations" }, { "description": "Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher\u003cbr\u003e\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "add_a_z_r_location" }, { "description": "Get the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Rooms version 4.0 or higher * Account owner or admin permissions\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_z_r_location_structure" }, { "description": "Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Rooms version 4.0 or higher * Account owner or admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_zoom_rooms_location_structure" }, { "description": "Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_location_profile" }, { "description": "Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_location_profile" }, { "description": "An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location. \u003cbr\u003e\u003cbr\u003e For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of `parent_location_id` in the request body.\u003cbr\u003e\u003cbr\u003e **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "change_parent_location" }, { "description": "Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_location_settings" }, { "description": "Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_location_settings" }, { "description": "The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either **check in** and confirm that you are utilizing the room reservation or to **check out** of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the [Using the Zoom Rooms check-in feature](https://support.zoom.us/hc/en-us/articles/360001147163-Using-the-Zoom-Rooms-check-in-feature) guide. **Prerequisites:** * [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-started-with-Zoom-Rooms#:~:text=Zoom%20Rooms%20is%20a%20software,or%20from%20their%20mobile%20device) must have been set up for use for the account and must be online. * You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room. **Scope:** `room:write:admin`", "name": "check_in_rooms" }, { "description": "[Remove](https://support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_a_zoom_room" }, { "description": "Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account. **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_profile" }, { "description": "Update basic information on a specific Zoom Room in a Zoom account.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_room_profile" }, { "description": "List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account. **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e * Account owner or admin permissions. **Scopes**: `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_z_r_devices" }, { "description": "[Upgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_1751c48a-644e-4a60-b96a-31ec77c616e6) or [downgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_d97349d6-9253-484c-af80-350475026524) the version of Zoom Rooms App installed in your Mac or Windows device. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Rooms. * Zoom Rooms software must be installed either on a Mac or a Windows device. This API does not support other devices.", "name": "change_zoom_rooms_app_version" }, { "description": "An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accress various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "change_z_r_location" }, { "description": "Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "get_z_r_settings" }, { "description": "Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_settings" }, { "description": "Zoom\u2019s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.\u003cbr\u003e **Scope:** `sip_phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "list_sip_phones" }, { "description": "Zoom\u2019s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to enable a user to use SIP phone.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.\u003cbr\u003e **Scope:** `sip_phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "create_s_i_p_phone" }, { "description": "Zoom\u2019s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to delete a specific SIP phone on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.\u003cbr\u003e **Scope:** `sip_phone:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_s_i_p_phone" }, { "description": "Zoom\u2019s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to update information of a specific SIP Phone on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.\u003cbr\u003e **Scope:** `sip_phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_s_i_p_phone" }, { "description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u0027 IP telephony network, will be connected over this trunk rather than over the PSTN. \u003cbr\u003e\u003cbr\u003eUse this API to list all the numbers that are configured for SIP Connected Audio in a Zoom Account. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a master account\u003cbr\u003e **Scopes:** `sip_trunk:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "list_sip_trunk_numbers" }, { "description": "[Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.\u003cbr\u003e Use this API to list all the tracking fields on your Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `trackingfield:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:** * Business, Education, API or higher plan", "name": "trackingfield_list" }, { "description": "[Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.\u003cbr\u003e Use this API to create a new tracking field.\u003cbr\u003e\u003cbr\u003e **Scope:** `trackingfield:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Business, Education, API or higher plan", "name": "trackingfield_create" }, { "description": "[Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.\u003cbr\u003e Use this API to delete a tracking field.\u003cbr\u003e\u003cbr\u003e **Scope:** `trackingfield:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Business, Education, API or higher plan", "name": "trackingfield_delete" }, { "description": "[Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.\u003cbr\u003e\u003cbr\u003e When scheduling a meeting, the tracking field will be included in the meeting options.\u003cbr\u003eUse this API to get information on a tracking field.\u003cbr\u003e\u003cbr\u003e **Scopes:** `trackingfield:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Business, Education, API or higher plan", "name": "trackingfield_get" }, { "description": "[Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.\u003cbr\u003e Use this API to update a tracking field.\u003cbr\u003e\u003cbr\u003e **Scope:** `trackingfield:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Business, Education, API or higher plan", "name": "trackingfield_update" }, { "description": "Get information on Telephony Service Provider on an account level.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` **Prerequisites:**\u003cbr\u003e * A Pro or a higher plan.", "name": "tsp" }, { "description": "Update information of the Telephony Service Provider set up on an account.\u003cbr\u003e **Prerequisites**:\u003cbr\u003e TSP account option should be enabled.\u003cbr\u003e **Scopes:** `tsp:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "tsp_update" }, { "description": "A Zoom account can have one or more users. Use this API to list users on your account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "users" }, { "description": "A Zoom account can have one or more users. Use this API to add a new user to your account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_create" }, { "description": "Verify if a user\u0027s email is registered with Zoom.\u003cbr\u003e\u003cbr\u003e \u003cb\u003eNote: \u003c/b\u003eYou 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. **Scopes:** `user:read:admin` `user:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_email" }, { "description": "Get User\u2019s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings. **Scope:** `user_zak:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_zak" }, { "description": "A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_vanity_name" }, { "description": "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.\u003cbr\u003e\u003cbr\u003e This API disassociates (unlinks) a user from the associated Zoom account and provides the user their own basic free Zoom account, and the user can purchase their own licenses. You can transfer the user\u0027s data (meetings, webinars and cloud recordings) to another user before disassociation.\u003cbr\u003e To permanently delete a user, specify \"delete\" as the value of the `action` query parameter. **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_delete" }, { "description": "A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eIf a user\u0027s status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.\u003c/p\u003e", "name": "user" }, { "description": "Update information on a user\u0027s Zoom [profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile).\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_update" }, { "description": "Delete all assistants of the current user.\u003cbr\u003e Assistants are the users to whom 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.\u003cbr\u003e **Prerequisite**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_assistants_delete" }, { "description": "List a user\u0027s assistants. Assistants are the users to whom 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.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: \u003cbr\u003e * Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_assistants" }, { "description": "Assistants are the users to whom 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.\u003cbr\u003eUse this API to assign assistants to a user. \u003cbr\u003e In the request body, provide either the User ID or the email address of the user.\u003cbr\u003e\u003cbr\u003e **Prerequisite**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_assistant_create" }, { "description": "Delete a specific assistant of a user. Assistants are the users to whom 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.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_assistant_delete" }, { "description": "Change a user\u0027s [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.\u003cbr\u003eIf 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-), the email to be updated must match one of the managed domains.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e \u003e Note: A user\u0027s email address can only be changed for a maximum of 3 times in a day(24 hours). **Prerequisite:**\u003cbr\u003e * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom.", "name": "user_email_update" }, { "description": "Use this API to list [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) that are available to be used by a user. **Scope:** `meeting:read` or `meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_meeting_templates" }, { "description": "List all the meetings that were scheduled for a user (meeting host). This API only supports scheduled meetings and thus, details on instant meetings are not returned via this API.\u003cbr\u003e\u003cbr\u003e **Scopes:** `meeting:read:admin` `meeting:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meetings" }, { "description": "[Create a meeting](https://support.zoom.us/hc/en-us/articles/201362413-Scheduling-meetings) for a user. \u003cbr\u003eThis API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.\u003cbr\u003e \u003caside\u003eThe \u003ccode\u003estart_url\u003c/code\u003e of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the \u003ccode\u003estart_url\u003c/code\u003e field is two hours for all regular users. \t For custCreate meeting hosts( i.e., users created using the \u003ccode\u003ecustCreate\u003c/code\u003e option via the [Create Users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API), the expiration time of the \u003ccode\u003estart_url\u003c/code\u003e field is 90 days from the generation of the \u003ccode\u003estart_url\u003c/code\u003e. \t For security reasons, the recommended way to retrieve the updated value for the \u003ccode\u003estart_url\u003c/code\u003e field programmatically (after expiry) is by calling the [Retrieve a Meeting API](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and referring to the value of the \u003ccode\u003estart_url\u003c/code\u003e field in the response.\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e Scopes: `meeting:write:admin` `meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "meeting_create" }, { "description": "[Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC) allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.\u003cbr\u003eUse this API to list a user\u0027s PAC accounts.\u003cbr\u003e\u003cbr\u003e **Scopes:** `pac:read:admin` `pac:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * A Pro or higher plan with [Premium Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) add-on. * Personal Audio Conference must be enabled in the user\u0027s profile.", "name": "user_p_a_cs" }, { "description": "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.\u003cbr\u003e After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` **Prerequisites:**\u003cbr\u003e * Owner or admin of the Zoom account.", "name": "user_password" }, { "description": "Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.\u003cbr\u003e Use this API to get permissions that have been granted to the user.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_permission" }, { "description": "Upload a user\u0027s profile picture.\u003cbr\u003e\u003cbr\u003e Provide `multipart/form-data` as the value of the `content-type` header for this request. This API supports JPEG and PNG file formats. **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_picture" }, { "description": "Users 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\u0027s availability. Users can also change their own presence status to be either \"Away\", \"Do not disturb\", or \"Available\". Use this API to update a user\u0027s presence status. A user\u0027s status can not be updated more than once per minute, i.e., you can only submit a maximum of 1 update request/minute for a single user.\u003cbr\u003eNote that a user\u0027s presence status can not be updated using this API if the user is not logged in to the Zoom client. **Scopes:** `user:write`, `user:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "update_presence_status" }, { "description": "When a user records a meeting or a webinar by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud. Use this API to list all [Cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a user.\u003cbr\u003e \u003e To access a user\u0027s password protected cloud recording, add an \"access_token\" parameter to the download URL and provide either the [JWT](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app) or the user\u0027s OAuth access token as the value of the \"access_token\" parameter. \u003cbr\u003e **Scopes:** `recording:read:admin` `recording:read` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:** * Pro or a higher plan. * Cloud Recording must be enabled on the user\u0027s account.", "name": "recordings_list" }, { "description": "Delete all of a user\u0027s schedulers. Schedulers 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. **Prerequisite**: Current user (assistant) must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_schedulers_delete" }, { "description": "List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). **Prerequisites**: * Current user must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:read:admin` `user:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_schedulers" }, { "description": "Delete a Scheduler. Schedulers 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 this scheduler. **Prerequisite**: Current user must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_scheduler_delete" }, { "description": "Retrieve a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_settings" }, { "description": "Update a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_settings_update" }, { "description": "Delete existing virtual background file(s) of a user. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `user:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "del_user_v_b" }, { "description": "Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) for a user. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `user:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "upload_v_buser" }, { "description": "An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.\u003cbr\u003e Use this API to either [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 .\u003cbr\u003e\u003cbr\u003e**Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_status" }, { "description": "Revoke a user\u0027s SSO token.\u003cbr\u003e\u003cbr\u003e After calling this API, the SSO user will be logged out of their current Zoom session.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_s_s_o_token_delete" }, { "description": "Retrieve a user\u0027s token.\u003cbr\u003e\u003cbr\u003e This token is used for starting meetings with the Client SDK.\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.", "name": "user_token" }, { "description": "A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:read:admin` `tsp:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_t_s_ps" }, { "description": "Add a user\u0027s TSP account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:write:admin` `tsp:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_t_s_p_create" }, { "description": "A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. \u003cp\u003e\u003c/p\u003e **Scopes:**`tsp:write:admin` `tsp:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "tsp_url_update" }, { "description": "Delete a user\u0027s TSP account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:write:admin` `tsp:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_t_s_p_delete" }, { "description": "Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:read:admin` `tsp:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_t_s_p" }, { "description": "Update a user\u0027s TSP account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `tsp:write:admin` `tsp:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_t_s_p_update" }, { "description": "When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars. \u003cbr\u003e\u003cbr\u003eUse this API to list a user\u0027s existing [Webinar templates\u0027](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates) information. **Prerequisites:** * Pro or a higher account with Webinar plan enabled.", "name": "list_webinar_templates" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003e Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` **Prerequisites:** * Pro or higher plan with a Webinar Add-on.", "name": "webinars" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003eUse this API to schedule a Webinar for a user (host).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.", "name": "webinar_create" }, { "description": "Delete a Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on.", "name": "webinar_delete" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003eUse this API to get details of a scheduled webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e**Prerequisites:** * Pro or higher plan with a Webinar Add-on.", "name": "webinar" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003e Use this API to make updates to a scheduled Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on.", "name": "webinar_update" }, { "description": "Use this API to register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration). \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The webinar host must be a Licensed user. * The webinar should be of type `5`, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API.\u003cbr\u003e\u003cbr\u003e **Scope:** `webinar:write`, `webinar:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e", "name": "add_batch_webinar_registrants" }, { "description": "Remove all the panelists from a Webinar.\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e", "name": "webinar_panelists_delete" }, { "description": "Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e", "name": "webinar_panelists" }, { "description": "Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.\u003cbr\u003eUse this API to [add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e", "name": "webinar_panelist_create" }, { "description": "[Remove](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.\u003cbr\u003e You can retrieve the `panelistId` by calling **List Panelists API**.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e", "name": "webinar_panelist_delete" }, { "description": "List all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_polls" }, { "description": "Create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_poll_create" }, { "description": "Delete a webinar\u0027s [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_poll_delete" }, { "description": "Get a webinar\u0027s [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_poll_get" }, { "description": "Update a webinar\u0027s [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_poll_update" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.\u003cbr\u003e Use this API to list all the users that have registered for a webinar.\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "webinar_registrants" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.\u003cbr\u003eUse this API to create and submit the registration of a user for a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.", "name": "webinar_registrant_create" }, { "description": "Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.\u003cbr\u003eUse this API to list registration questions and fields that are to be answered by users while registering for a Webinar.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "webinar_registrants_questions_get" }, { "description": "Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.\u003cbr\u003eUse this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "webinar_registrant_question_update" }, { "description": "Update a webinar registrant\u0027s status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "webinar_registrant_status" }, { "description": "Delete a webinar registrant.\u003cbr\u003e\u003cbr\u003e **Scopes**: `webinar:write:admin` `webinar:write`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "delete_webinar_registrant" }, { "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.\u003cbr\u003eUse this API to get details on a specific user who has registered for the Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The account must have a Webinar plan.", "name": "webinar_registrant_get" }, { "description": "Update a webinar\u0027s status. Use this API to end an ongoing webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The account must hold a valid [Webinar plan](https://zoom.us/webinar).", "name": "webinar_status" }, { "description": "[Webinar Registration Tracking Sources](https://support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.\u003cbr\u003e Use this API to list information on all the tracking sources of a Webinar.\u003cbr\u003e **Scopes:** `webinar:read:admin`, `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * [Webinar license](https://zoom.us/webinar). * Registration must be required for the Webinar.", "name": "get_tracking_sources" } ] }