Use wide Zoom integration

List all the Sub Accounts under the Master Account

This action list all the Sub Accounts under the Master Account.

Request parameters

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

Get a Sub Account under the Master Account

This action get a Sub Account under the Master Account.

Request parameters

• accountId^*string

  The account ID.

Get [billing information](https://support

This action get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a Sub Account under a Master Account.

**Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
**Scope**:`billing:master`

Request parameters

• accountId^*string

  The account ID.

[Account Locked Settings](https://support

This action [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's locked settings.

Note: The force_pmi_jbh_password field under meeting settings was deprecated on September 22, 2019. Use require_password_for_pmi_meetings field as an alternative for the same functionality.

Request parameters

• accountId^*string

Get a Sub Account's [managed domains](https://support

This action get a Sub Account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).

To get managed domains of the Master Account, provide `me` as the value for accountId in the path parameter. Provide the Sub Account's Account ID as the value of accountId path parameter to get managed domains of the Sub Account. **Prerequisites:**
* Pro or a higher paid account with Master Account option enabled.
**Scope:** `account:read:admin`

Request parameters

• accountId^*string

  The account ID.

Get plan information for a Sub Account under the Master account

This action get plan information for a Sub Account under the Master account.

Request parameters

• accountId^*string

  The account ID.

Get information on usage of [plans](https://marketplace

This action get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans) on a Master Account. **Prerequisite**:
Account type: Master Account on a paid Pro, Business or Enterprise plan.
**Scope:** `billing:master`

Request parameters

• accountId^*string

List [Cloud Recordings](https://support

This action list [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. **Prerequisites**:
* A Pro or a higher paid plan with Cloud Recording option enabled.
**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`.

Request parameters

• accountId^*string

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• fromstring

  The start date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

• tostring

  The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

Get the settings of a Sub Account under a Master Account

This action get the settings of a Sub Account under a Master Account.
To get the settings of a Master Account, use `me` as the value for the `accountId` path parameter.

Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Request parameters

• accountId^*string

  The account ID.

• optionstring

  `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.
  `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account.

Get trusted domains of a Sub Account

This action 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:**
* The Sub Account must be a paid account.
**Scope:** `account:read:admin`

Request parameters

• accountId^*string

  The account ID.

Create a Sub Account under the Master Account

This action create a Sub Account under the Master Account.

Subscribe plans for a Sub Account under a Master Account

This action subscribe plans for a Sub Account under a Master Account.

Request parameters

• accountId^*string

  The account ID.

Add an additional plan for a sub account

This action add an additional plan for a sub account.

**Prerequisites:**
* 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.
**Scopes**: `billing:master`

Request parameters

• accountId^*string

  The account ID.

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’s network and the Zoom cloud

This action 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’s 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' IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to assign internal numbers to a Sub Account. **Prerequisites:**
* Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
**Scopes:** `sip_trunk:master`

Request parameters

• accountId^*string

  Unique Identifier of the Sub Account.

The current account owner can [change the owner of an account](https://support

This action 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.
Use this API to change the owner of an account. **Prerequisites**:
* Account owner or admin permissions.
* Pro or a higher plan with Master Account option enabled.. **Scopes:** `account:write:admin` or `account:master`

Request parameters

• accountId^*string

  Account Id of the account.

Update an additional plan for a sub account

This action update an additional plan for a sub account.

**Prerequisites:**
* 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.
**Scopes**: `billing:master`

Request parameters

• accountId^*string

  The account ID.

Update a base plan of a Sub Account

This action update a base plan of a Sub Account.

Request parameters

• accountId^*string

  The account ID.

Disassociate a user from one Account and move the user to another Account under the same Master Account

This action 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's 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`

Request parameters

• accountId^*string

• userId^*string

Update [billing information](https://support

This action update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a Sub Account under a Master account.

Request parameters

• accountId^*string

  The account ID.

[Account Locked Settings](https://support

This action [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's locked settings.

Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Request parameters

• accountId^*string

Update a Sub Account's options under the Master Account

This action update a Sub Account's options under the Master Account.

Request parameters

• accountId^*string

  The account ID.

[Cancel additional plan](https://support

This action [Cancel additional plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a Master account holder who pays for this sub account can cancel the add-on. The cancellation does not provide refund for the current subscription. The service remains active for the current session. **Prerequisites:**
* Pro or a higher plan with Master Account option enabled. * The Sub Account must be a paid account.
**Scope:** `billing:master`

Request parameters

• accountId^*string

[Cancel a base plan](https://support

This action [Cancel a base plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a master account holder who pays for this sub account can cancel the plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session. **Scopes**: `billing:master`

Request parameters

• accountId^*string

Update the settings of a Sub Account that is under a Master Account

This action update the settings of a Sub Account that is under a Master Account.
To update the settings of the Master Account, use `me` as the value of the `accountId` path parameter.

Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Request parameters

• accountId^*string

  The account ID.

• optionstring

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’s network and the Zoom cloud

This action 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’s 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' IP telephony network, will be connected over this trunk rather than over the PSTN.

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:**
* Pro or a higher account with SIP Connected Audio plan enabled. * Master Account Owner
**Scopes:** `sip_trunk:master`

Request parameters

• accountId^*string

Disassociate a Sub Account from the Master Account

This action disassociate a Sub Account from the Master Account. This will leave the Sub Account intact but it will no longer be associated with the master account.

Request parameters

• accountId^*string

  The account ID.

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’s network and the Zoom cloud

This action 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’s 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' IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to delete all internal numbers assigned to a Sub Account. **Prerequisites:**
* Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
**Scopes:** `sip_trunk:master`

Request parameters

• accountId^*string

  Account ID of the Sub Account from which the numbers are to be deleted. This can be retrieved from [List Sub Accounts](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API.

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

This action a Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to list all the blocked lists in an acccount.
**Prerequisites:** * Pro or higher account plan with Zoom phone license
**Scope:** `phone:read:admin`

Request parameters

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• page_sizeinteger

  The total number of records returned from a single API call.

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

This action a Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to get information about a specific blocked list.
**Prerequisites:** * Pro or higher account plan with Zoom phone license
**Scope:** `phone:read:admin`

Request parameters

• blockedListId^*string

  Unique Identifier of the blocked list.

Retrieve [call logs](https://support

This action retrieve [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs) for an account. **Scopes**: `phone:read:admin`

**Prerequisite:**
1. Business or Enterprise account
2. A Zoom Phone license
3. Account Owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone Management

Request parameters

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

• fromstring

  Start date from which you would like to get the call logs. The start date should be within past six months.

• tostring

  The end date upto which you would like to get the call logs for. The end date should be within past six months.

• typestring

  The type of the call logs. The value can be either "all" or "missed".

Call queues allow you to route incoming calls to a group of users

This action 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.
Use this API to list Call queues.

**Prerequisites:**
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:read:admin`

Request parameters

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• page_sizeinteger

  The number of records returned from a single API call.

Call queues allow you to route incoming calls to a group of users

This action 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.
Use this API to get information on a specific Call Queue.

**Prerequisites:**
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:read:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue. This can be retrieved from [List Call Queues API]().

List all Zoom Phone [calling plans](https://marketplace

This action 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.

**Prerequisites:**
* Pro or a higher account with Zoom phone license.
**Scope:** `phone:read:admin`

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

This action 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't belong to a specific employees, you could add a common area phone so that any person can use it.
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.

**Prerequisites:**
* 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)
**Scopes:** `phone:read:admin`

Request parameters

• commonAreaPhoneId^*string

  Unique Identifier of the Common Area Phone. This can be retrieved from List Common Area Phones API.

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

This action 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't belong to a specific employees, you could add a common area phone so that any person can use it.
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.

**Prerequisites:**
* 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)

**Scope:** `phone:read:admin`

Request parameters

• page_sizeinteger

  The total number of records returned from a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

List all the [desk phone devices](https://support

This action 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`.

**Scopes:** `phone:read:admin`
**Prerequisites:**
* Pro or a higher account with Zoom Phone license * Account owner or admin permissions

Request parameters

• type^*string

  State of the device. The value should be either `assigned` to list devices that have been assigned to user(s) or `unassigned` to list devices that have not yet been assigned to any user in the Zoom account.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• page_sizeinteger

  The number of records returned within a single API call.

Get detailed information about a specific [desk phone device](https://support

This action get detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).

**Prerequisites:**
* Pro or a higher account with Zoom Phone license * Account owner or admin permissions
**Scopes:** `phone:write:admin`

Request parameters

• deviceId^*string

  Unique Identifier of the device.

A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users

This action 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:**
* Pro or higher plan with Zoom phone license
**Scope:** `phone:read:admin`

Request parameters

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• typestring

  Query response by number assignment. The value can be one of the following:
  `assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account.
  `unassigned`: The number is not assigned to anyone.
  `all`: Include both assigned and unassigned numbers in the response.

• extension_typestring

  The type of assignee to whom the number is assigned. The value can be one of the following:
  `user`
  `callQueue`
  `autoReceptionist`
  `commonAreaPhone`

• page_sizeinteger

  The number of records returned within a single API call.

• number_typestring

  The type of phone number. The value can be either `toll` or `tollfree`.

• pending_numbersboolean

  Include or exclude pending numbers in the response. The value can be either `true` or `false`.

A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users

This action 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.

**Prerequisites:**
* Pro or higher plan with Zoom phone license
**Scope:** `phone:read:admin`

Request parameters

• numberId^*string

  Unique Identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.

Site allow you to organize Zoom Phone users in your organization

This action 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.
**Prerequisites:**
* 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`

Request parameters

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Site allow you to organize Zoom Phone users in your organization

This action 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:**
* 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).
**Scope:** `phone:read:admin`

Request parameters

• siteId^*string

  Unique Identifier of the Site.

List all the users on an account who have been assigned Zoom Phone licenses

This action list all the users on an account who have been assigned Zoom Phone licenses.

**Prerequisites:**
* Pro or higher plan with Zoom phone license
**Scope:** `phone:read:admin`

Request parameters

• page_sizeinteger

  The number of records returned from a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• site_idstring

  Unique Identifier of the site. This can be retrieved from List Phone Sites API.

Retrieve a user's [zoom phone](https://support

This action retrieve a user's [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. **Scopes:** `phone:read`, `phone:read:admin`
**Prerequisites** : 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

  The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

Retrieve a [zoom phone](https://support

This action retrieve a [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) user's call logs. **Scopes:** `phone:read`, `phone:read:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

  The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

• typestring

Retrieve a user's zoom [phone recordings](https://support

This action retrieve a user's zoom [phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). **Scopes:** `phone:read`, `phone:read:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

  The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

Retrieve a user's zoom phone profile [settings](https://support

This action retrieve a user's zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). **Scopes:** `phone:read`, `phone:read:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

  The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

Retrieve a user's Zoom Phone voicemails

This action retrieve a user's Zoom Phone voicemails. **Scopes:** `phone:read`, `phone:read:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

  The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

• statusstring

  Status of the voice mail

Assign available phone numbers to an [auto receptionist](https://support

This action 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
**Scopes:** `phone:write:admin`

Request parameters

• autoReceptionistId^*string

  Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

This action a Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to create a blocked list and add a number to that blocked list.
**Prerequisites:** * Pro or higher account plan with Zoom phone license
**Scope:** `phone:write:admin`

Call queues allow you to route incoming calls to a group of users

This action 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.
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).
You can add phone users or common area phones to call queues. **Prerequisites:**
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Add phone users and/or [common area phones](https://support

This action 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.

**Prerequisites:**
* Pro or higher account plan. * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue.

After [buying phone number(s)](https://support

This action 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).

**Prerequisites:**
* Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue.

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

This action 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't belong to a specific employees, you could add a common area phone so that any person can use it.
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).

**Prerequisites:**
* 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)
**Scope:** `phone:write:admin`

By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications

This action 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:**
* 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)
**Scopes:** `phone:write:admin`

Site allow you to organize Zoom Phone users in your organization

This action 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).
**Prerequisites:**
* 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`

Assign [calling plan](https://marketplace

This action 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`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

Assign a [phone number](https://support

This action 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`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

A call queue manager has the privileges to maanage the call queue's voicemail inbox and recordings, change all call queue settings and call queue policy settings

This action a call queue manager has the privileges to maanage the call queue's voicemail inbox and recordings, change all call queue settings and call queue policy settings.

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:**
* Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue.

The [main company number](https://support

This action 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's extension). It can also be used by phone users in your account as their caller ID while making calls.

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.

**Prerequisites:**
* Pro or higher account plan. * Account owner or admin permissions
**Scopes:** `phone:write:admin`

An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, or voicemail

This action 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.
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.

**Prerequisites:**
* Pro or higher account with Zoom Phone license.
**Scopes:** `phone:write:admin`

Request parameters

• autoReceptionistId^*string

  Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

This action a Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to update information on the blocked list.
**Prerequisites:** * Pro or higher account plan with Zoom phone license
**Scope:** `phone:write:admin`

Request parameters

• blockedListId^*string

  Unique Identifier for the blocked list.

Call queues allow you to route incoming calls to a group of users

This action 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.
Use this API to update information of a specific Call Queue.
**Prerequisites:**
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue.

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

This action 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't belong to a specific employees, you could add a common area phone so that any person can use it.
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.

**Prerequisites:**
* 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)
**Scopes:** `phone:write:admin`

Request parameters

• commonAreaPhoneId^*string

Update information of a [desk phone device](https://support

This action update information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).

**Prerequisites:**
* Pro or a higher account with Zoom Phone license * Account owner or admin permissions
**Scopes:** `phone:write:admin`

Request parameters

• deviceId^*string

  Unique Identifier of the Device.

Site allow you to organize Zoom Phone users in your organization

This action 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:**
* Account must have a Pro or a higher plan with Zoom Phone license. * **Scope:** `phone:write:admin`

Request parameters

• siteId^*string

  Unique Identifier of the Site.

Update a [Zoom Phone](https://support

This action update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user's profile. **Scopes:** `phone:write` `phone:write:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• userId^*string

Unassign all phone numbers that were previously assigned to an [auto receptionist](https://support

This action 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
**Scopes:** `phone:write:admin`

Request parameters

• autoReceptionistId^*string

Unassign a specific phone number that was previously assigned to an [auto receptionist](https://support

This action 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
**Scopes:** `phone:write:admin`

Request parameters

• autoReceptionistId^*string

  Unique identifier of the auto receptionist. This can be retrieved from the List Phone Sites API.

• phoneNumberId^*string

  Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).

A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

This action a Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).
Use 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.
**Prerequisites:** * Pro or higher account plan with Zoom phone license
**Scope:** `phone:write:admin`

Request parameters

• blockedListId^*string

  Unique Identifier of the blocked list. This can be retrieved from the List Blocked List API.

Call queues allow you to route incoming calls to a group of users

This action 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.
Use this API to delete a Call Queue.
**Prerequisites:**
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the call queue.

Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue

This action 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:**
* Pro or higher account plan. * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

Use this API to remove a member from a Call Queue who was previously added to that Call Queue

This action 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:**
* Pro or higher account plan. * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue from which the member needs to be unassigned.

• memberId^*string

  Unique Identifier of the member who needs to be unassigned.

Use this API to unbind all phone numbers that are assigned to a [Call Queue](https://support

This action 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).
If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead.
**Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue. This can be retrieved from List Call Queues API.

After assigning a phone number, you can unbind it if you don't want it to be assigned to a [Call Queue](https://support

This action after assigning a phone number, you can unbind it if you don't want it to be assigned to a [Call Queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).

**Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license
**Scopes:** `phone:write:admin`

Request parameters

• callQueueId^*string

  Unique Identifier of the Call Queue. This can be retrieved from the List Call Queues API.

• phoneNumberId^*string

  Unique Identifier of the Phone Number.

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

This action 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't belong to a specific employees, you could add a common area phone so that any person can use it.
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.

**Prerequisites:**
* 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)
**Scopes:** `phone:write:admin`

Request parameters

• commonAreaPhoneId^*string

  Unique Identifier of the common area phone.

Remove a [desk phone device](https://support

This action remove a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.

**Prerequisites:**
* Pro or a higher account with Zoom Phone license * Account owner or admin permissions * Device must not have been assigned to a user.
**Scopes:** `phone:write:admin`

Request parameters

• deviceId^*string

  Unique Identifier of the device.

Site allow you to organize Zoom Phone users in your organization

This action 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:**
* 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.
**Scope:** `phone:write:admin`

Request parameters

• siteId^*string

  Unique Identifier of the Site.

• transfer_site_id^*string

  The Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.

Unassign a [calling plan](https://marketplace

This action 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`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

Request parameters

• type^*string

  The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)

• userId^*string

Unassign [phone number](https://support

This action 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.
After assigning a phone number, you can remove it if you don't want it to be assigned to anyone. **Scopes**: `phone:write` `phone:write:admin`

**Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license 3. User must have been previously assigned a Zoom Phone number.

Request parameters

• userId^*string

  Provide either userId or email address of the user.

• phoneNumberId^*string

  Provide either phone number or phoneNumberId of the user.

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing

This action 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.

**Prerequisites:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
**Scopes**: `room:read:admin`

Request parameters

• statusstring

  The status of the Zoom Room.

• typestring

  Type of the Zoom Rooms.

• unassigned_roomsboolean

  Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• location_idstring

  Parent location ID of the Zoom Room.

Get details on the account profile of a Zoom Room

This action 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:**
* Zoom account owner or Zoom Rooms admin permissions
**Scopes:** `room:read:admin`

Get details on Account Settings of a Zoom Room

This action 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.

**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:read:admin`

Request parameters

• setting_type^*string

  The type of setting that you would like to retrieve.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support

This action 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.

**Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher

**Scopes:** `room:read:admin`

Request parameters

• parent_location_idstring

  A unique identifier for the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

• typestring

  Use this field to filter the response by the type of location. The value can be one of the following: `country`, `states`, `city`, `campus`, `building`, `floor`.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Get the [location hierarchial structure(s)](https://support

This action 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.

**Prerequisites:**
* Zoom Rooms version 4.0 or higher * Account owner or admin permissions
**Scopes:** `room:read:admin`

Each location type of the [Zoom Rooms location hierarchy](https://support

This action 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:**
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
**Scopes:** `room:read:admin`

Request parameters

• locationId^*string

  Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

Get information on meeting or alert settings applied to Zoom Rooms located in a specific location

This action 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.

**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:read:admin`

Request parameters

• setting_type^*string

  The type of setting that you would like to retrieve.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

• locationId^*string

  Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing

This action 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:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
**Scopes**: `room:read:admin`

Request parameters

• roomId^*string

  Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.

List information about the devices that are being used for a specific [Zoom Room](https://support

This action 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:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
* Account owner or admin permissions. **Scopes**: `room:read:admin`

Request parameters

• roomId^*string

  Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.

Get information on meeting or alert settings applied to a specific Zoom Room

This action 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.
**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:read:admin`

Request parameters

• setting_type^*string

  The type of setting that you would like to retrieve.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

• roomId^*string

  Unique identifier of the Zoom Room.

Use this API to [add a Zoom Room](https://support

This action 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.

**Prerequisites:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
**Scopes**: `room:write:admin`

Add a location to the [location hierarchial structure(s)](https://support

This action 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

**Scopes:** `room:write:admin`

An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support

This action 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.

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.

**Prerequisite:**
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
**Scopes:** `room:write:admin`

/n

Request parameters

• locationId^*string

An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support

This action 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:**
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
**Scopes:** `room:write:admin`

Request parameters

• roomId^*string

  Unique Identifier of the Zoom Room.

Update information on the account profile of a Zoom Room

This action 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:**
* Zoom account owner or Zoom Rooms admin permissions
**Scopes:** `room:write:admin`

Update account settings applied for Zoom Rooms in a Zoom account

This action 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.

**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:write:admin`

Request parameters

• setting_type^*string

  The type of setting that you would like to update.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

Update the [location hierarchial structure(s)](https://support

This action 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.

**Prerequisites:**
* Zoom Rooms version 4.0 or higher * Account owner or admin permissions
**Scopes:** `room:write:admin`

Each location type of the [Zoom Rooms location hierarchy](https://support

This action 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:**
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
**Scopes:** `room:write:admin`

Request parameters

• locationId^*string

  Unique Identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location

This action 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.

**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:write:admin`

Request parameters

• setting_type^*string

  The type of setting that you would like to update.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

• locationId^*string

  Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

Update basic information on a specific Zoom Room in a Zoom account

This action update basic information on a specific Zoom Room in a Zoom account.
**Prerequisites:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
**Scopes**: `room:write:admin`

Request parameters

• roomId^*string

  Unique Identifier of a Zoom Room.

Update either meeting or alert settings applied to a specific Zoom Room

This action 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.
**Prerequisites:**
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
**Scopes:** `room:write:admin`

Request parameters

• roomId^*string

  Unique Identifier of the Zoom Room.

• setting_typestring

  The type of setting that you would like to update.
  `alert`: Alert Settings applied on the Zoom Rooms Account.
  `meeting`: Meeting settings of the Zoom Rooms Account.

[Remove](https://support

This action [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.

**Prerequisites:**
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.
**Scopes**: `room:write:admin`

Request parameters

• roomId^*string

  Unique Identifier of a Zoom Room.

List [roles](https://support

This action list [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account **Scopes:** `role:read:admin`

**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.

Each Zoom user automatically has a role which can either be owner, administrator, or a member

This action 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).
**Pre-requisite:**
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions. **Scopes:** `role:read:admin`

Request parameters

• roleId^*string

  Role Id.

User [roles](https://support

This action 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`

**Prerequisites:**
* A Pro or a higher plan.

Request parameters

• roleId^*string

  The role ID

Each Zoom user automatically has a role which can either be owner, administrator, or a member

This action each Zoom user automatically has a role which can either be owner, administrator, or a member. **Pre-requisite:**
* 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.
**Scopes:** `role:write:admin`

User [roles](https://support

This action 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`

**Prerequisites:**
* A Pro or a higher plan.

Request parameters

• roleId^*string

  The role ID

Each Zoom user automatically has a [role](https://support

This action 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.
**Pre-requisite:**
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions.
**Scopes:** `role:write:admin`

Request parameters

• roleId^*string

  Role Id

Each Zoom user automatically has a role which can either be owner, administrator, or a member

This action 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.
**Pre-requisite:**
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions. **Scopes:** `role:write:admin`

Request parameters

• roleId^*string

  Role Id.

User [roles](https://support

This action user [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role. **Scope:** `role:write:admin`

**Prerequisites:**
* A Pro or a higher plan.

Request parameters

• roleId^*string

  The role ID

• memberId^*string

  Member's ID

Zoom chat [channels](https://support

This action 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel ID: Unique Identifier of a channel.

A [channel](https://support

This action 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel Id.

• page_sizeinteger

  The number of records returned with a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Zoom chat [channels](https://support

This action 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's chat channels.

Note: This API only supports user-managed OAuth app.

Request parameters

• page_sizeinteger

  The number of records returned from a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. The expiration period for this token is 15 minutes.

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client

This action a user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• typestring

  The type of contact. The value can be one of the following: `company`: Contacts from the user's organization. `external`: External contacts.

• page_sizeinteger

  The number of records returned with a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client

This action a user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). Call this API to get information on a specific contact of the Zoom user.

Note: This API only supports user-managed OAuth app.

Request parameters

• contactId^*string

  The user's contact Id or email address. The contact can be either a company contact or an external contact.

• query_presence_statusboolean

  The presence status of the contact. Include this query parameter with a value of `true` to get the presence status of the contact in the response.

A Zoom user can have conversations with other Zoom users via chat

This action a Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user's chat messages between the user and an individual contact or a chat channel.
In the query parameter, you must provide either of the following:
* `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.
**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**.

Note: This API only supports user-managed OAuth app.

Request parameters

• userId^*string

• to_contactstring

  The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.

• to_channelstring

  The channel Id of a channel inside which current user had chat converstations. Messages that were sent and/or received between the user and the channel is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.

• date string

  The query date for which you would like to get the chat messages.

• page_sizeinteger

  The number of records returned with a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

A [channel](https://support

This action 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 your contact list to a channel. The maximum number of members that can be added at once with this API is 5.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel ID: Unique Identifier of the channel.

A [channel](https://support

This action 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel Id.

Zoom chat channels allow users to communicate via chat in private or public groups

This action zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.

Note: This API only supports user-managed OAuth app.

Send chat messages on Zoom to either an individual user who is in your contact list or to a [channel](https://support

This action 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's 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.

**Scopes:** `chat_message:write`

Note: This API only supports user-managedOAuth app.

Each chat message has a unique identifier

This action 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's 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• messageId^*string

  Message ID: Unique Identifier of the message.

Zoom chat channels allow users to communicate via chat in private or public channels

This action 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel Id.

Zoom chat [channels](https://support

This action 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel ID: Unique Identifier of a channel.

If you're no longer interested in being a member of an existing channel, you can leave the channel at any time

This action if you're 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.

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Channel ID: Unique Identifier of a channel.

A [channel](https://support

This action 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.

**Scopes:** `chat_channel:write`

Note: This API only supports user-managed OAuth app.

Request parameters

• channelId^*string

  Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the [List Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).

• memberId^*string

  Email address of the member whom you would like to be remove from the channel.

Delete a chat message that you previously sent to a contact or a channel

This action 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:
* `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.

Note: This API only supports user-managed OAuth app.

Request parameters

• messageId^*string

  Message ID

• to_contactstring

  The userId or email address of a chat contact to whom you previously sent the message. Note: You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively.

• to_channelstring

  The channel Id of the channel where you would like to send the message. You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel

Zoom’ 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

This action zoom’s 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.

**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.
**Scope:** `sip_phone:read:admin`

Request parameters

• page_numberinteger

  The current page number of returned records.

• search_keystring

  User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.

• page_sizeinteger

  The number of records returned within a single API call.

Zoom’ 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

This action zoom’s 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.

**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.
**Scope:** `sip_phone:write:admin`

Zoom’ 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

This action zoom’s 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.

**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.
**Scope:** `sip_phone:write:admin`

Request parameters

• phoneId^*string

  Unique Identifier of the SIP Phone. This can be retrieved from the List SIP Phones API.

Zoom’ 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

This action zoom’s 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.

**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.
**Scope:** `sip_phone:read:admin`

Request parameters

• phoneId^*string

  Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API.

A Cloud Room Connector allows H

This action 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.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

Get [metrics](https://support

This action 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.


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`
**Prerequisites:**
* Business or a higher plan.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Get information on top 25 Zoom Rooms with issues in a month

This action 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.
**Scope:** `dashboard_home:read:admin`

**Prerequisites:**
* Business or a higher plan. * Zoom Room must be enabled in the account.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount

This action get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount.
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`

**Prerequisites:**
* Business or a higher plan. * Zoom Room must be enabled in the account.

Request parameters

• zoomroomId^*string

  The Zoom room ID.

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

List total live or past meetings that occurred during a specified period of time

This action 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.
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`
**Prerequisites:**
* Business or a higher plan.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• typestring

  The meeting types:
  `past` - Past meetings.
  `pastOne` - Past one user meetings.
  `live` - Live meetings.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Get details on live or past meetings

This action 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.
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`

**Prerequisites:**
* Business or a higher plan.

Request parameters

• meetingId^*string

  The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

• typestring

  The meeting types:
  `past` - Past meetings.
  `pastOne` - Past one user meetings.
  `live` - Live meetings.

Get a list of participants from live or past meetings

This action get a list of participants from live or past meetings.

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`.
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`

**Prerequisites:** Business or a higher plan.

Request parameters

• meetingId^*string

  The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

• typestring

  The meeting types:
  `past` - Past meetings.
  `pastOne` - Past one user meetings.
  `live` - Live meetings.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

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

This action 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.
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`.

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`

**Prerequisites:**
* Business or a higher plan.

Request parameters

• meetingId^*string

  The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

• typestring

  The meeting types:
  `past` - Past meetings.
  `live` - Live Meetings.

• page_sizeinteger

  The number of items returned per page.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Retrieve the sharing and recording details of participants from live or past meetings

This action retrieve the sharing and recording details of participants from live or past meetings.

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:read:admin`

**Prerequisites:**
* Business or a higher plan.

Request parameters

• meetingId^*string

  The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

• typestring

  The meeting types:
  `past` - Past meetings.
  `live` - Live Meetings.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Retrieve the quality of service for participants from live or past meetings

This action 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.

**Scopes:** `dashboard:read:admin`

Request parameters

• meetingId^*string

  The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

• participantId^*string

  Participant ID.

• typestring

  The meeting types:
  `past` - Past meetings.
  `live` - Live Meetings.

List all the live or past webinars from a specified period of time

This action list all the live or past webinars from a specified period of time.

**Scopes:** `dashboard:read:admin`
**Prerequisites:**
* Business, Education or API Plan with Webinar add-on.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• typestring

  The webinar type.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Retrieve details from live or past webinars

This action retrieve details from live or past webinars.

**Scopes:** `dashboard:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Webinar add-on.

Request parameters

• webinarId^*string

  The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

• typestring

  The webinar type.

Retrieve details on participants from live or past webinars

This action retrieve details on participants from live or past webinars.

**Scopes:** `dashboard:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Webinar add-on.

Request parameters

• webinarId^*string

  The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

• typestring

  The webinar type.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Retrieve a list of participants from live or past webinars and the quality of service they received

This action retrieve a list of participants from live or past webinars and the quality of service they received.
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.
**Scopes:** `dashboard:read:admin`

**Prerequisites:** * Business, Education or API Plan with Webinar add-on.

Request parameters

• webinarId^*string

  The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

• typestring

  The webinar type.

• page_sizeinteger

  The number of items returned per page.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Retrieve the sharing and recording details of participants from live or past webinars

This action retrieve the sharing and recording details of participants from live or past webinars.

**Scopes:** `dashboard:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Webinar add-on.

Request parameters

• webinarId^*string

  The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

• typestring

  The webinar type.

• page_sizeinteger

  The number of records returned within a single API call.

• next_page_tokenstring

  The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

Retrieve details on the quality of service that participants from live or past webinars recieved

This action retrieve details on the quality of service that participants from live or past webinars recieved.
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.
**Scopes:** `dashboard:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Zoom Rooms set up.

Request parameters

• webinarId^*string

  The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

• participantId^*string

  Participant ID.

• typestring

  The webinar type.

List information on all Zoom Rooms in an account

This action list information on all Zoom Rooms in an account.

**Scopes:** `dashboard_zr:read:admin` **Prerequisites:**
* Business, Education or API Plan with Zoom Rooms set up.

Request parameters

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.

Get Top 25 issues of Zoom Rooms

This action get Top 25 issues of Zoom Rooms.
**Scopes:** `dashboard_zr:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Zoom Rooms set up.

Request parameters

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

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

This action 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.

**Scopes:** `dashboard_zr:read:admin`

**Prerequisites:**
* Business, Education or API Plan with Zoom Rooms set up.

Request parameters

• zoomroomId^*string

  The Zoom room ID.

• from^*string

  Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

• to^*string

  End date.

• page_sizeinteger

  The number of records returned within a single API call.

• page_numberinteger

  The current page number of returned records.