# Zoom API ## API Docs - Accounts [List sub accounts](https://apifox.com/apidoc/docs-site/406120/api-5365772.md): List all the sub accounts that have been created by a master account.

Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. - Accounts [Create a sub account](https://apifox.com/apidoc/docs-site/406120/api-5365773.md): Create a sub account under a master account. Your account must be a master account in order to create sub accounts. - Accounts [Disassociate a sub account](https://apifox.com/apidoc/docs-site/406120/api-5365774.md): Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account.
- Accounts [Get sub account details](https://apifox.com/apidoc/docs-site/406120/api-5365775.md): Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts' details. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and create sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. - Accounts [Get locked settings](https://apifox.com/apidoc/docs-site/406120/api-5365776.md): [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. - Accounts [Update locked settings](https://apifox.com/apidoc/docs-site/406120/api-5365777.md): [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. - Accounts [Get managed domains](https://apifox.com/apidoc/docs-site/406120/api-5365778.md): Get a sub account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).

- Accounts [Update options](https://apifox.com/apidoc/docs-site/406120/api-5365779.md): Update a sub account's options under the master account.
- Accounts [Update the account owner](https://apifox.com/apidoc/docs-site/406120/api-5365780.md): 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 a sub account. - Accounts [Get settings](https://apifox.com/apidoc/docs-site/406120/api-5365781.md): Get the settings of an account.
- Accounts [Update settings](https://apifox.com/apidoc/docs-site/406120/api-5365782.md): 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.

- Accounts [Delete virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365783.md): Delete existing virtual background file(s) from an account. - Accounts [Upload virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365784.md): Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users on the account to use. - Accounts [Get trusted domains](https://apifox.com/apidoc/docs-site/406120/api-5365785.md): 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. - Billing [Get billing information](https://apifox.com/apidoc/docs-site/406120/api-5365786.md): Get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.

Only master accounts can use this API. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details.
- Billing [Update billing information](https://apifox.com/apidoc/docs-site/406120/api-5365787.md): Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.

- Billing [List billing invoices](https://apifox.com/apidoc/docs-site/406120/api-5365788.md): List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account. - Billing [Get invoice details](https://apifox.com/apidoc/docs-site/406120/api-5365789.md): Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e).
To retrieve a regular Zoom account's invoice details or a master account's invoice details, provide `me` as the value of `accountId` path parameter. To list a sub account's invoice details, provide the account ID of the sub account in the `accountId` path parameter. - Billing [Get plan Information](https://apifox.com/apidoc/docs-site/406120/api-5365790.md): Get plan information of a sub account that is managed by a master account.

This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details.

- Billing [Subscribe plans](https://apifox.com/apidoc/docs-site/406120/api-5365791.md): Subscribe a sub account to a Zoom plan using your master account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.

- Billing [Subscribe additional plan](https://apifox.com/apidoc/docs-site/406120/api-5365792.md): Subscribe a sub account to a Zoom addon plan. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.

- Billing [Update an additional plan](https://apifox.com/apidoc/docs-site/406120/api-5365793.md): Update an additional plan for a sub account. - Billing [Cancel additional plans](https://apifox.com/apidoc/docs-site/406120/api-5365794.md): [Cancel additional plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) of a sub account. The cancellation does not provide refund for the current subscription. The service remains active for the current session. - Billing [Update a base plan](https://apifox.com/apidoc/docs-site/406120/api-5365795.md): Update a base plan of a sub account. - Billing [Cancel a base plan](https://apifox.com/apidoc/docs-site/406120/api-5365796.md): [Cancel a base plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. - Billing [Get plan usage](https://apifox.com/apidoc/docs-site/406120/api-5365797.md): Get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans) of an account. This API supports regular accounts as well as master and sub accounts. To get plan usage of a regular account, use the `account:read:admin` scope and provide “me” as the value of the `accountId` path parameter.To get plan usage of a master account, provide the keyword "me" as the value of the `accountId` path parameter and use the `billing:master` scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the `accountId` path parameter and use the `billing:master` scope. - Billing [Download an invoice file](https://apifox.com/apidoc/docs-site/406120/api-5365798.md): Download a [billed](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) invoice file of a Zoom account in PDF format. To download a regular account's invoice or a master account's invoice, provide `me` as the value of `accountId` path parameter. To download a sub account's invoice, provide the account ID of the sub account in the `accountId` path parameter. - Phone [Update BYOC settings](https://apifox.com/apidoc/docs-site/406120/api-5365799.md): Only [master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this API to enable BYOC(Bring your own carrier) option for a sub account.
- Phone [Set up a Zoom Phone account](https://apifox.com/apidoc/docs-site/406120/api-5365800.md): After assigning a Zoom phone license to an account, an admin or account owner can proceed with the [initial Zoom phone set up](https://support.zoom.us/hc/en-us/articles/360001297663-Getting-started-with-Zoom-Phone-admin-#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13) using this API. - Phone [Assign SIP trunks](https://apifox.com/apidoc/docs-site/406120/api-5365801.md): Using this API, a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) owner can assign SIP trunk(s) to a sub account.
- Phone [Update SIP trunk details](https://apifox.com/apidoc/docs-site/406120/api-5365802.md): Update details of a SIP trunk that is assigned to a sub account.
- Phone [Add BYOC phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5365803.md): Use this API to add BYOC phone numbers(provided to you by your carrier) to Zoom. - Phone [Get account's call logs](https://apifox.com/apidoc/docs-site/406120/api-5365804.md): Retrieve [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs) for an account. - Phone [List calling plans](https://apifox.com/apidoc/docs-site/406120/api-5365805.md): 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.

- Phone [Change main company number](https://apifox.com/apidoc/docs-site/406120/api-5365806.md): 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.

- Phone [List phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5365807.md): 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. - Phone [Get phone number details](https://apifox.com/apidoc/docs-site/406120/api-5365808.md): 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.

- Phone [Update phone number details](https://apifox.com/apidoc/docs-site/406120/api-5365809.md): Update phone number details. - Phone [Get call recordings](https://apifox.com/apidoc/docs-site/406120/api-5365810.md): List [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) of an account.
- Phone [List setting templates](https://apifox.com/apidoc/docs-site/406120/api-5365811.md): This API lets you retrieve a list of all the phone template settings previously created. - Phone [Add a setting template](https://apifox.com/apidoc/docs-site/406120/api-5365812.md): This API lets you create a Zoom Phone setting template for an account. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. Settings include profile, policy and user settings. After creating a phone template, the settings defined via this request will become the default settings for an account. - Phone [Get setting template details](https://apifox.com/apidoc/docs-site/406120/api-5365813.md): This API lets you retrieve a specific account phone template previously created.
- Phone [Update a setting template](https://apifox.com/apidoc/docs-site/406120/api-5365814.md): Use this API to update or modify profile settings for the phone template. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. After you've modified a template, click **User Settings** to set up settings for Call Handling, Desk Phone, and Others.
- Phone [List BYOC SIP trunks](https://apifox.com/apidoc/docs-site/406120/api-5365815.md): List [BYOC SIP trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf) that are assigned to an account. - Phone [List phone users](https://apifox.com/apidoc/docs-site/406120/api-5365816.md): List all the users on an account who have been assigned Zoom Phone licenses.

- Phone [Get user's profile](https://apifox.com/apidoc/docs-site/406120/api-5365817.md): Retrieve a user's [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. - Phone [Update user's profile](https://apifox.com/apidoc/docs-site/406120/api-5365818.md): Update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user's profile. - Phone [Get user's call logs](https://apifox.com/apidoc/docs-site/406120/api-5365819.md): Retrieve a [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) user's call logs. - Phone [Delete a user's call log](https://apifox.com/apidoc/docs-site/406120/api-5365820.md): Delete a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). - Phone [Assign calling plan to a user](https://apifox.com/apidoc/docs-site/406120/api-5365821.md): 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. - Phone [Unassign user's calling plan](https://apifox.com/apidoc/docs-site/406120/api-5365822.md): 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. - Phone [Assign phone number to user](https://apifox.com/apidoc/docs-site/406120/api-5365823.md): 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. - Phone [Unassign phone number](https://apifox.com/apidoc/docs-site/406120/api-5365824.md): 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.
- Phone [Get user's recordings](https://apifox.com/apidoc/docs-site/406120/api-5365825.md): Retrieve a user's zoom [phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). - Phone [Get user's settings](https://apifox.com/apidoc/docs-site/406120/api-5365826.md): Retrieve a user's zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). - Phone [Remove shared access](https://apifox.com/apidoc/docs-site/406120/api-5365827.md): Remove the shared voicemail access settings that were previously assigned to a user. - Phone [Update shared access](https://apifox.com/apidoc/docs-site/406120/api-5365828.md): Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to update the voicemail access permissions of a user. - Phone [Set up shared access](https://apifox.com/apidoc/docs-site/406120/api-5365829.md): Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user. - Phone [Get user's voicemails](https://apifox.com/apidoc/docs-site/406120/api-5365830.md): Retrieve a user's Zoom Phone voicemails. - Phone [Delete a voicemail](https://apifox.com/apidoc/docs-site/406120/api-5365831.md): Delete a [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages) from a Zoom account. - Cloud Recording [List recordings of an account](https://apifox.com/apidoc/docs-site/406120/api-5365832.md): List [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. - Cloud Recording [List archived files](https://apifox.com/apidoc/docs-site/406120/api-5365833.md): Zoom’s [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) allows account administrators to set up an automated mechanism to record, collect and archive meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other compliance requirements.

- Cloud Recording [Delete meeting recordings](https://apifox.com/apidoc/docs-site/406120/api-5365834.md): Delete all recording files of a meeting.

- Cloud Recording [Get meeting recordings](https://apifox.com/apidoc/docs-site/406120/api-5365835.md): Get all the [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting or Webinar instance.

The recording files can be downloaded via the `download_url` property listed in the response. - Cloud Recording [List recording registrants](https://apifox.com/apidoc/docs-site/406120/api-5365836.md): Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. - Cloud Recording [Create a recording registrant](https://apifox.com/apidoc/docs-site/406120/api-5365837.md): Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. - Cloud Recording [Get registration questions](https://apifox.com/apidoc/docs-site/406120/api-5365838.md): For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. - Cloud Recording [Update registration questions](https://apifox.com/apidoc/docs-site/406120/api-5365839.md): For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. - Cloud Recording [Update registrant's status](https://apifox.com/apidoc/docs-site/406120/api-5365840.md): A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. - Cloud Recording [Get meeting recording settings](https://apifox.com/apidoc/docs-site/406120/api-5365841.md): Retrieve settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).

- Cloud Recording [Update meeting recording settings](https://apifox.com/apidoc/docs-site/406120/api-5365842.md): Update settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)

- Cloud Recording [Recover meeting recordings](https://apifox.com/apidoc/docs-site/406120/api-5365843.md): Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.

- Cloud Recording [Delete a meeting recording file](https://apifox.com/apidoc/docs-site/406120/api-5365844.md): Delete a sprecific recording file from a meeting.

- Cloud Recording [Recover a single recording](https://apifox.com/apidoc/docs-site/406120/api-5365845.md): Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
- Cloud Recording [List all recordings](https://apifox.com/apidoc/docs-site/406120/api-5365846.md): When a user records a meeting or a webinar by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud. - SIP Connected Audio [List internal call-out countries](https://apifox.com/apidoc/docs-site/406120/api-5365847.md): Retrieve the list of internal [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) countries of a master account or a sub account. To list call-out enabled countries of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list call-out enabled countries of a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [Add internal call-out countries](https://apifox.com/apidoc/docs-site/406120/api-5365848.md): Specify the list of [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) countries for a master account or a sub account. To add call-out enabled countries to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add call-out enabled countries to a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [Delete internal call-out country](https://apifox.com/apidoc/docs-site/406120/api-5365849.md): Delete a previously assigned [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) country from a master account or a sub account. To remove call-out country from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To remove call-out country from a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [List internal numbers](https://apifox.com/apidoc/docs-site/406120/api-5365850.md): This API allows a master account with SIP Connected Audio plan to list internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) assigned to a master account or a sub account.

To list internal numbers of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list internal numbers of a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [Add internal numbers](https://apifox.com/apidoc/docs-site/406120/api-5365851.md): This API allows a master account with SIP Connected Audio plan to assign internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) to a master account or a sub account.

To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [Delete an internal number](https://apifox.com/apidoc/docs-site/406120/api-5365852.md): This API allows a master account with SIP Connected Audio plan to delete a previously assigned internal phone number from a master account or a sub account.

To delete an internal number from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To delete an internal number from a master account, provide `me` as the value of the `accountId` path parameter. - SIP Connected Audio [Delete all numbers](https://apifox.com/apidoc/docs-site/406120/api-5365853.md): 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. - SIP Connected Audio [Assign numbers](https://apifox.com/apidoc/docs-site/406120/api-5365854.md): 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. - SIP Connected Audio [Assign SIP trunk configuration](https://apifox.com/apidoc/docs-site/406120/api-5365855.md): 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. - SIP Connected Audio [List SIP trunks](https://apifox.com/apidoc/docs-site/406120/api-5365856.md): 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.

- SIP Connected Audio [Assign SIP trunks](https://apifox.com/apidoc/docs-site/406120/api-5365857.md): 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 SIP trunk(s) that are available on a master account to a sub account.
Prerequisites:
- SIP Connected Audio [Delete a SIP trunk](https://apifox.com/apidoc/docs-site/406120/api-5365858.md): Use this API to remove existing SIP trunk of a sub account.
- SIP Connected Audio [List SIP trunk numbers](https://apifox.com/apidoc/docs-site/406120/api-5365859.md): 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 list all the numbers that are configured for SIP Connected Audio in a Zoom Account. - Users [Switch a user's account](https://apifox.com/apidoc/docs-site/406120/api-5365860.md): Disassociate a user from one Account and move the user to another Account under the same master account. - Users [List users](https://apifox.com/apidoc/docs-site/406120/api-5365861.md): A Zoom account can have one or more users. Use this API to list users on your account.

- Users [Create users](https://apifox.com/apidoc/docs-site/406120/api-5365862.md): A Zoom account can have one or more users. Use this API to add a new user to your account.

- Users [Check a user email](https://apifox.com/apidoc/docs-site/406120/api-5365863.md): Verify if a user's email is registered with Zoom.

- Users [Get user's ZAK](https://apifox.com/apidoc/docs-site/406120/api-5365864.md): Get User’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings. - Users [Check a user's PM room](https://apifox.com/apidoc/docs-site/406120/api-5365865.md): A personal meeting room is a virtual meeting room that can be permanently assigned to a user. - Users [Delete a user](https://apifox.com/apidoc/docs-site/406120/api-5365867.md): Deleting a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user account before deleting.

- Users [Get a user](https://apifox.com/apidoc/docs-site/406120/api-5365868.md): A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.

- Users [Update a user](https://apifox.com/apidoc/docs-site/406120/api-5365869.md): Update information on a user's Zoom [profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile).

- Users [Delete user assistants](https://apifox.com/apidoc/docs-site/406120/api-5365870.md): Delete all assistants of the current user.
Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
- Users [List user assistants](https://apifox.com/apidoc/docs-site/406120/api-5365871.md): List a user's assistants. - Users [Add assistants](https://apifox.com/apidoc/docs-site/406120/api-5365872.md): Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
Use this API to assign assistants to a user.
In the request body, provide either the User ID or the email address of the user.

- Users [Delete a user assistant](https://apifox.com/apidoc/docs-site/406120/api-5365873.md): Delete a specific assistant of a user. - Users [Update a user's email](https://apifox.com/apidoc/docs-site/406120/api-5365874.md): Change a user's [email address](https://support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up.
If the Zoom Account in which the user belongs, has multiple [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), the email to be updated must match one of the managed domains.
- Users [Update a user's password](https://apifox.com/apidoc/docs-site/406120/api-5365875.md): Update the [password](https://support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom.
After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.
- Users [Get user permissions](https://apifox.com/apidoc/docs-site/406120/api-5365876.md): Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.
- Users [Upload a user's profile picture](https://apifox.com/apidoc/docs-site/406120/api-5365877.md): Upload a user's profile picture.

- Users [Update a user's presence status](https://apifox.com/apidoc/docs-site/406120/api-5365878.md): Users in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status informs users of their contact's availability. Users can also change their own presence status to be either "Away", "Do not disturb", or "Available". - Users [Delete user schedulers](https://apifox.com/apidoc/docs-site/406120/api-5365879.md): Delete all of a user's schedulers. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. - Users [List user schedulers](https://apifox.com/apidoc/docs-site/406120/api-5365880.md): List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. - Users [Delete a scheduler](https://apifox.com/apidoc/docs-site/406120/api-5365881.md): Delete a Scheduler. - Users [Get user settings](https://apifox.com/apidoc/docs-site/406120/api-5365882.md): Retrieve a user's settings.

- Users [Update user settings](https://apifox.com/apidoc/docs-site/406120/api-5365883.md): Update a user's settings.

- Users [Delete virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365884.md): Delete existing virtual background file(s) of a user. - Users [Upload virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365885.md): Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) for a user. - Users [Update user status](https://apifox.com/apidoc/docs-site/406120/api-5365886.md): An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.
Use this API to either [deactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user .

**Scopes:** `user:write:admin` `user:write`
- Users [Revoke a user's SSO token](https://apifox.com/apidoc/docs-site/406120/api-5365887.md): Revoke a user's SSO token.

After calling this API, the SSO user will be logged out of their current Zoom session.
- Users [Get a user token](https://apifox.com/apidoc/docs-site/406120/api-5365888.md): Retrieve a user's token.

This token is used for starting meetings with the Client SDK.
- Chat Channels [Delete a channel](https://apifox.com/apidoc/docs-site/406120/api-5365889.md): 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. - Chat Channels [Get a channel](https://apifox.com/apidoc/docs-site/406120/api-5365890.md): 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. - Chat Channels [Update a channel](https://apifox.com/apidoc/docs-site/406120/api-5365891.md): 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. - Chat Channels [Leave a channel](https://apifox.com/apidoc/docs-site/406120/api-5365892.md): 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. - Chat Channels [Join a channel](https://apifox.com/apidoc/docs-site/406120/api-5365893.md): 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. - Chat Channels [Remove a member](https://apifox.com/apidoc/docs-site/406120/api-5365894.md): 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.

- Chat Channels [List user's channels](https://apifox.com/apidoc/docs-site/406120/api-5365895.md): 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. - Chat Channels [Create a channel](https://apifox.com/apidoc/docs-site/406120/api-5365896.md): Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.
- Contacts [List user's contacts](https://apifox.com/apidoc/docs-site/406120/api-5365897.md): 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. - Contacts [Get user's contact details](https://apifox.com/apidoc/docs-site/406120/api-5365898.md): 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. - Contacts [Search company contacts](https://apifox.com/apidoc/docs-site/406120/api-5365899.md): A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the `search_key` query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set `query_presence_status` to `true` in order to include the presence status of a contact.

- Chat Channels (Account-level) [Delete a channel](https://apifox.com/apidoc/docs-site/406120/api-5365900.md): 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. - Chat Channels (Account-level) [Get a channel](https://apifox.com/apidoc/docs-site/406120/api-5365901.md): 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. - Chat Channels (Account-level) [Update a channel](https://apifox.com/apidoc/docs-site/406120/api-5365902.md): Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel created by a user.

- Chat Channels (Account-level) [List channel members](https://apifox.com/apidoc/docs-site/406120/api-5365903.md): 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. - Chat Channels (Account-level) [Invite channel members](https://apifox.com/apidoc/docs-site/406120/api-5365904.md): A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to invite members that are in a user's contact list to a channel. The maximum number of members that can be added at once with this API is 5. - Chat Channels (Account-level) [Remove a member](https://apifox.com/apidoc/docs-site/406120/api-5365905.md): 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.

- Chat Messages [List user's chat messages](https://apifox.com/apidoc/docs-site/406120/api-5365906.md): 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:
- Chat Messages [Send a chat message](https://apifox.com/apidoc/docs-site/406120/api-5365907.md): 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.
- Chat Messages [Delete a message](https://apifox.com/apidoc/docs-site/406120/api-5365908.md): 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:
- Chat Messages [Update a message](https://apifox.com/apidoc/docs-site/406120/api-5365909.md): 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. - Groups [List groups](https://apifox.com/apidoc/docs-site/406120/api-5365910.md): List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. - Groups [Create a group](https://apifox.com/apidoc/docs-site/406120/api-5365911.md): Create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. - Groups [Delete a group](https://apifox.com/apidoc/docs-site/406120/api-5365912.md): Delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). - Groups [Get a group](https://apifox.com/apidoc/docs-site/406120/api-5365913.md): Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. - Groups [Update a group](https://apifox.com/apidoc/docs-site/406120/api-5365914.md): Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. - Groups [Get locked settings](https://apifox.com/apidoc/docs-site/406120/api-5365915.md): Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually.


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.

- Groups [Update locked settings](https://apifox.com/apidoc/docs-site/406120/api-5365916.md): Update a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually.


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.

- Groups [List group members ](https://apifox.com/apidoc/docs-site/406120/api-5365917.md): List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. - Groups [Add group members](https://apifox.com/apidoc/docs-site/406120/api-5365918.md): Add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. - Groups [Delete a group member](https://apifox.com/apidoc/docs-site/406120/api-5365919.md): Delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. - Groups [Update a group member](https://apifox.com/apidoc/docs-site/406120/api-5365920.md): If a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group's settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.

- Groups [Get a group's settings](https://apifox.com/apidoc/docs-site/406120/api-5365921.md): Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). - Groups [Update a group's settings](https://apifox.com/apidoc/docs-site/406120/api-5365922.md): Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).


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.

- Groups [Delete virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365923.md): Delete existing virtual background file(s) from an account. - Groups [Upload virtual background files](https://apifox.com/apidoc/docs-site/406120/api-5365924.md): Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users in a group to use. - Devices [List H.323/SIP devices](https://apifox.com/apidoc/docs-site/406120/api-5365925.md): A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.

- Devices [Create a H.323/SIP device](https://apifox.com/apidoc/docs-site/406120/api-5365926.md): A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account

- Devices [Delete a H.323/SIP device](https://apifox.com/apidoc/docs-site/406120/api-5365927.md): A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.

- Devices [Update a H.323/SIP device](https://apifox.com/apidoc/docs-site/406120/api-5365928.md): A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.

- Chatbot Messages [Send chatbot messages](https://apifox.com/apidoc/docs-site/406120/api-5365929.md): Send chatbot messages from your marketplace chatbot app.

- Chatbot Messages [Delete a chatbot message](https://apifox.com/apidoc/docs-site/406120/api-5365930.md): Delete a message that was sent by your chatbot app.

**Scopes:** `imchat:bot`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
**Authorization Flow**: Client Credentials Flow

To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`.
Use `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. - Chatbot Messages [Edit a chatbot message](https://apifox.com/apidoc/docs-site/406120/api-5365931.md): Edit a message that was [sent](https://marketplace.zoom.us/docs/api-reference/zoom-api/im-chat/sendchatbot) by your Chatbot app.
After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API. - IM Chat [Get IM chat sessions](https://apifox.com/apidoc/docs-site/406120/api-5365932.md): Retrieve IM Chat sessions for a specified period of time.
- IM Chat [Get IM chat messages](https://apifox.com/apidoc/docs-site/406120/api-5365933.md): Retrieve IM chat messages for a specified period of time.

- IM Chat [Send IM messages](https://apifox.com/apidoc/docs-site/406120/api-5365934.md): Send chat message to a user.

**Scope:** `imchat:write` - IM Chat [Get user’s IM messages](https://apifox.com/apidoc/docs-site/406120/api-5365935.md): Get IM Chat messages for a specified period of time.

- IM Groups [List IM directory groups](https://apifox.com/apidoc/docs-site/406120/api-5365936.md): List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).

- IM Groups [Create an IM directory group](https://apifox.com/apidoc/docs-site/406120/api-5365937.md): Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

- IM Groups [Delete an IM directory group](https://apifox.com/apidoc/docs-site/406120/api-5365938.md): Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

- IM Groups [Retrieve an IM directory group](https://apifox.com/apidoc/docs-site/406120/api-5365939.md): Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

- IM Groups [Update an IM directory group](https://apifox.com/apidoc/docs-site/406120/api-5365940.md): Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

- IM Groups [List IM directory group members](https://apifox.com/apidoc/docs-site/406120/api-5365941.md): List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).

- IM Groups [Add IM directory group members](https://apifox.com/apidoc/docs-site/406120/api-5365942.md): Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.

- IM Groups [Delete an IM directory group member](https://apifox.com/apidoc/docs-site/406120/api-5365943.md): Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.

- Meetings [Use in-Meeting recording controls](https://apifox.com/apidoc/docs-site/406120/api-5365944.md): Use this API to control the [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) **recording features** such as starting a recording, stopping a recording, pausing a recording, and resuming a recording. This API only works for Cloud Recordings and not for local recordings. - Meetings [Delete a meeting](https://apifox.com/apidoc/docs-site/406120/api-5365945.md): Delete a meeting.

- Meetings [Get a meeting](https://apifox.com/apidoc/docs-site/406120/api-5365946.md): Retrieve the details of a meeting.

- Meetings [Update a meeting](https://apifox.com/apidoc/docs-site/406120/api-5365947.md): Update the details of a meeting.
This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.
- Meetings [Perform batch poll creation](https://apifox.com/apidoc/docs-site/406120/api-5365948.md): Polls allow the meeting host to survey attendees. Use this API to create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.

- Meetings [Get meeting invitation](https://apifox.com/apidoc/docs-site/406120/api-5365949.md): Retrieve the meeting invite note that was sent for a specific meeting.

- Meetings [Get live stream details](https://apifox.com/apidoc/docs-site/406120/api-5365950.md): Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to get a meeting's live stream configuration details such as Stream URL, Stream Key and Page URL.

- Meetings [Update a live stream](https://apifox.com/apidoc/docs-site/406120/api-5365951.md): Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting's live stream information.

- Meetings [Update Live Stream Status](https://apifox.com/apidoc/docs-site/406120/api-5365952.md): Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting's live stream.

- Meetings [List meeting polls](https://apifox.com/apidoc/docs-site/406120/api-5365953.md): Polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.

- Meetings [Create a meeting poll](https://apifox.com/apidoc/docs-site/406120/api-5365954.md): Polls allow the meeting host to survey attendees. Use this API to create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.

- Meetings [Delete a meeting poll](https://apifox.com/apidoc/docs-site/406120/api-5365955.md): Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
- Meetings [Get a meeting poll](https://apifox.com/apidoc/docs-site/406120/api-5365956.md): Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).

- Meetings [Update a meeting poll](https://apifox.com/apidoc/docs-site/406120/api-5365957.md): Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)

- Meetings [List meeting registrants](https://apifox.com/apidoc/docs-site/406120/api-5365958.md): A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). Use this API to list users that have registered for a meeting.

- Meetings [Add meeting registrant](https://apifox.com/apidoc/docs-site/406120/api-5365959.md): Register a participant for a meeting.

Note that there is a maximum limit of 4999 registrants per meeting and users will see an error if the capacity has reached. - Meetings [List registration questions ](https://apifox.com/apidoc/docs-site/406120/api-5365960.md): List registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
- Meetings [Update registration questions](https://apifox.com/apidoc/docs-site/406120/api-5365961.md): Update registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).

- Meetings [Update registrant's status](https://apifox.com/apidoc/docs-site/406120/api-5365962.md): Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.

- Meetings [Delete a meeting registrant](https://apifox.com/apidoc/docs-site/406120/api-5365963.md): Delete a meeting registrant.

- Meetings [Update meeting status](https://apifox.com/apidoc/docs-site/406120/api-5365964.md): Update the status of a meeting.

- Meetings [List ended meeting instances](https://apifox.com/apidoc/docs-site/406120/api-5365965.md): Get a list of ended meeting instances

- Meetings [List past meeting's poll results](https://apifox.com/apidoc/docs-site/406120/api-5365966.md): [Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.

- Meetings [Get past meeting details](https://apifox.com/apidoc/docs-site/406120/api-5365967.md): Get details on a past meeting.

- Meetings [Get past meeting participants](https://apifox.com/apidoc/docs-site/406120/api-5365968.md): Retrieve information on participants from a past meeting.

- Meetings [List meeting templates](https://apifox.com/apidoc/docs-site/406120/api-5365969.md): Use this API to list [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) that are available to be used by a user. - Meetings [List meetings](https://apifox.com/apidoc/docs-site/406120/api-5365970.md): List all the meetings that were scheduled for a user (meeting host). This API only supports scheduled meetings and thus, details on instant meetings are not returned via this API.

- Meetings [Create a meeting](https://apifox.com/apidoc/docs-site/406120/api-5365971.md): [Create a meeting](https://support.zoom.us/hc/en-us/articles/201362413-Scheduling-meetings) for a user.
This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.
- Dashboards [List Zoom meetings client feedback](https://apifox.com/apidoc/docs-site/406120/api-5365972.md): Retrieve survey results from [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf).
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. - Dashboards [Get zoom meetings client feedback](https://apifox.com/apidoc/docs-site/406120/api-5365973.md): Retrieve detailed information on a [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf).
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. - Dashboards [List client meeting satisfaction](https://apifox.com/apidoc/docs-site/406120/api-5365974.md): If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months. - Dashboards [Get CRC port usage](https://apifox.com/apidoc/docs-site/406120/api-5365975.md): A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. - Dashboards [Get IM metrics](https://apifox.com/apidoc/docs-site/406120/api-5365976.md): 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. - Dashboards [Get top 25 Zoom Rooms with issues](https://apifox.com/apidoc/docs-site/406120/api-5365977.md): 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.
- Dashboards [Get issues of Zoom Rooms](https://apifox.com/apidoc/docs-site/406120/api-5365978.md): 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. - Dashboards [List meetings](https://apifox.com/apidoc/docs-site/406120/api-5365979.md): 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.
- Dashboards [Get meeting details](https://apifox.com/apidoc/docs-site/406120/api-5365980.md): 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.
- Dashboards [List meeting participants](https://apifox.com/apidoc/docs-site/406120/api-5365981.md): Get a list of participants from live or past meetings.

- Dashboards [List meeting participants QoS](https://apifox.com/apidoc/docs-site/406120/api-5365982.md): 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.

- Dashboards [Get post meeting feedback](https://apifox.com/apidoc/docs-site/406120/api-5365983.md): When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020. - Dashboards [Get sharing/recording details](https://apifox.com/apidoc/docs-site/406120/api-5365984.md): Retrieve the sharing and recording details of participants from live or past meetings.
- Dashboards [Get meeting participant QoS](https://apifox.com/apidoc/docs-site/406120/api-5365985.md): 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.

- Dashboards [List webinars](https://apifox.com/apidoc/docs-site/406120/api-5365986.md): List all the live or past webinars from a specified period of time.

- Dashboards [Get webinar details](https://apifox.com/apidoc/docs-site/406120/api-5365987.md): Retrieve details from live or past webinars.

- Dashboards [Get webinar participants](https://apifox.com/apidoc/docs-site/406120/api-5365988.md): Retrieve details on participants from live or past webinars.

- Dashboards [List webinar participant QoS](https://apifox.com/apidoc/docs-site/406120/api-5365989.md): 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.
- Dashboards [Get post webinar feedback](https://apifox.com/apidoc/docs-site/406120/api-5365990.md): When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020. - Dashboards [Get sharing/recording details](https://apifox.com/apidoc/docs-site/406120/api-5365991.md): Retrieve the sharing and recording details of participants from live or past webinars.

- Dashboards [Get webinar participant QoS](https://apifox.com/apidoc/docs-site/406120/api-5365992.md): 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.
- Dashboards [List Zoom Rooms](https://apifox.com/apidoc/docs-site/406120/api-5365993.md): List information on all Zoom Rooms in an account.

- Dashboards [Get top 25 issues of Zoom Rooms](https://apifox.com/apidoc/docs-site/406120/api-5365994.md): Get top 25 issues of Zoom Rooms.
- Dashboards [Get Zoom Rooms details](https://apifox.com/apidoc/docs-site/406120/api-5365995.md): 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. - Dashboards [List call logs](https://apifox.com/apidoc/docs-site/406120/api-5365996.md): Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. - Dashboards [Get call QoS](https://apifox.com/apidoc/docs-site/406120/api-5365997.md): Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account. - Dashboards [Get call details from call log](https://apifox.com/apidoc/docs-site/406120/api-5365998.md): Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. - Deprecated API Endpoints [List past meeting's files](https://apifox.com/apidoc/docs-site/406120/api-5365999.md): **Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.** To learn about saving the in-meeting chat files via Zoom Client, refer to the [Saving in-meeting chat](https://support.zoom.us/hc/en-us/articles/115004792763-Saving-in-meeting-chat) guide. - Deprecated API Endpoints [List past webinar files](https://apifox.com/apidoc/docs-site/406120/api-5366000.md): **Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.** - Webinars [Get webinar absentees](https://apifox.com/apidoc/docs-site/406120/api-5366001.md): List absentees of a webinar.

- Webinars [List past webinar instances](https://apifox.com/apidoc/docs-site/406120/api-5366002.md): List past webinar instances.

- Webinars [List webinar participants](https://apifox.com/apidoc/docs-site/406120/api-5366003.md): Use this API to list all the participants who attended a webinar hosted in the past.
- Webinars [List past webinar poll results](https://apifox.com/apidoc/docs-site/406120/api-5366004.md): The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. - Webinars [List Q&A of past webinar](https://apifox.com/apidoc/docs-site/406120/api-5366005.md): The [Question & Answer (Q&A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
- Webinars [List webinar templates](https://apifox.com/apidoc/docs-site/406120/api-5366006.md): When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars.

Use this API to list a user's existing [Webinar templates'](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates) information. - Webinars [List webinars](https://apifox.com/apidoc/docs-site/406120/api-5366007.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).

- Webinars [Create a webinar](https://apifox.com/apidoc/docs-site/406120/api-5366008.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to schedule a Webinar for a user (host).

- Webinars [Delete a webinar](https://apifox.com/apidoc/docs-site/406120/api-5366009.md): Delete a Webinar.

- Webinars [Get a webinar](https://apifox.com/apidoc/docs-site/406120/api-5366010.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to get details of a scheduled webinar.

- Webinars [Update a webinar](https://apifox.com/apidoc/docs-site/406120/api-5366011.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
- Webinars [Perform batch registration](https://apifox.com/apidoc/docs-site/406120/api-5366012.md): Use this API to register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration).
- Webinars [Remove panelists](https://apifox.com/apidoc/docs-site/406120/api-5366013.md): Remove all the panelists from a Webinar.
- Webinars [List panelists](https://apifox.com/apidoc/docs-site/406120/api-5366014.md): Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. - Webinars [Add panelists](https://apifox.com/apidoc/docs-site/406120/api-5366015.md): Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
Use this API to [add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.

- Webinars [Remove a panelist](https://apifox.com/apidoc/docs-site/406120/api-5366016.md): [Remove](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.
You can retrieve the `panelistId` by calling **List Panelists API**.

- Webinars [List a webinar's polls ](https://apifox.com/apidoc/docs-site/406120/api-5366017.md): List all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.

- Webinars [Create a webinar's poll](https://apifox.com/apidoc/docs-site/406120/api-5366018.md): Create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.

- Webinars [Delete a webinar poll](https://apifox.com/apidoc/docs-site/406120/api-5366019.md): Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

- Webinars [Get a webinar poll](https://apifox.com/apidoc/docs-site/406120/api-5366020.md): Get a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.

- Webinars [Update a webinar poll](https://apifox.com/apidoc/docs-site/406120/api-5366021.md): Update a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

- Webinars [List webinar registrants](https://apifox.com/apidoc/docs-site/406120/api-5366022.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
- Webinars [Add a webinar registrant](https://apifox.com/apidoc/docs-site/406120/api-5366023.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to create and submit the registration of a user for a webinar.

- Webinars [List registration questions](https://apifox.com/apidoc/docs-site/406120/api-5366024.md): Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
- Webinars [Update registration questions](https://apifox.com/apidoc/docs-site/406120/api-5366025.md): Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.

- Webinars [Update registrant's status](https://apifox.com/apidoc/docs-site/406120/api-5366026.md): Update a webinar registrant's status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.

- Webinars [Delete a webinar registrant](https://apifox.com/apidoc/docs-site/406120/api-5366027.md): Delete a webinar registrant.

- Webinars [Get a webinar registrant](https://apifox.com/apidoc/docs-site/406120/api-5366028.md): Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to get details on a specific user who has registered for the Webinar.

- Webinars [Update webinar status](https://apifox.com/apidoc/docs-site/406120/api-5366029.md): Update a webinar's status. Use this API to end an ongoing webinar.

- Webinars [Get webinar tracking sources](https://apifox.com/apidoc/docs-site/406120/api-5366030.md): [Webinar Registration Tracking Sources](https://support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
Use this API to list information on all the tracking sources of a Webinar.
- Phone Auto Receptionists [Add an auto receptionist](https://apifox.com/apidoc/docs-site/406120/api-5366031.md): Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area phone, voicemail or an IVR system. Use this API to add an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone.
- Phone Auto Receptionists [Update auto receptionist details](https://apifox.com/apidoc/docs-site/406120/api-5366032.md): 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.
- Phone Auto Receptionists [Unassign all phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5366033.md): 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-). - Phone Auto Receptionists [Assign phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5366034.md): 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". - Phone Auto Receptionists [Unassign a phone number](https://apifox.com/apidoc/docs-site/406120/api-5366035.md): 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-). - Phone Blocked List [List blocked lists](https://apifox.com/apidoc/docs-site/406120/api-5366036.md): 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.
- Phone Blocked List [Create a blocked list](https://apifox.com/apidoc/docs-site/406120/api-5366037.md): 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.
- Phone Blocked List [Delete a blocked list](https://apifox.com/apidoc/docs-site/406120/api-5366038.md): 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). - Phone Blocked List [Get blocked list details](https://apifox.com/apidoc/docs-site/406120/api-5366039.md): 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.
- Phone Blocked List [Update a blocked list](https://apifox.com/apidoc/docs-site/406120/api-5366040.md): 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.
- Phone Call Queues [List call queues](https://apifox.com/apidoc/docs-site/406120/api-5366041.md): 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.

- Phone Call Queues [Create a call queue](https://apifox.com/apidoc/docs-site/406120/api-5366042.md): 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. - Phone Call Queues [Delete a call queue](https://apifox.com/apidoc/docs-site/406120/api-5366043.md): 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.
- Phone Call Queues [Get call queue details](https://apifox.com/apidoc/docs-site/406120/api-5366044.md): 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.

- Phone Call Queues [Update call queue details](https://apifox.com/apidoc/docs-site/406120/api-5366045.md): 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.
- Phone Call Queues [Change call queue manager](https://apifox.com/apidoc/docs-site/406120/api-5366046.md): 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). - Phone Call Queues [Unassign all members](https://apifox.com/apidoc/docs-site/406120/api-5366047.md): 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). - Phone Call Queues [Add members to a call queue](https://apifox.com/apidoc/docs-site/406120/api-5366048.md): 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.

- Phone Call Queues [Unassign a member](https://apifox.com/apidoc/docs-site/406120/api-5366049.md): 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. - Phone Call Queues [Unassign all phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5366050.md): 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.
- Phone Call Queues [Assign numbers to a call queue](https://apifox.com/apidoc/docs-site/406120/api-5366051.md): 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).

- Phone Call Queues [Unassign a phone number](https://apifox.com/apidoc/docs-site/406120/api-5366052.md): 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).

- Phone Call Queues [Get call queue recordings](https://apifox.com/apidoc/docs-site/406120/api-5366053.md): Use this API to view [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091#h_cbc9f2a3-e06c-4daa-83d4-ddbceef9c77b) from the call queue.

- Common Area Phones [List common area phones](https://apifox.com/apidoc/docs-site/406120/api-5366054.md): 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:**
- Common Area Phones [Add a common area phone](https://apifox.com/apidoc/docs-site/406120/api-5366055.md): 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).

- Common Area Phones [Delete a common area phone](https://apifox.com/apidoc/docs-site/406120/api-5366056.md): 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:**
- Common Area Phones [Get common area phone details](https://apifox.com/apidoc/docs-site/406120/api-5366057.md): 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.
For the `commonAreaPhoneId`, use the unique identifier or the Mac address of the common area phone. The Mac address can be hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c).

**Prerequisites:**
- Common Area Phones [Update common area phone](https://apifox.com/apidoc/docs-site/406120/api-5366058.md): 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:**
- Phone Devices [List devices](https://apifox.com/apidoc/docs-site/406120/api-5366059.md): 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`.

- Phone Devices [Add a device](https://apifox.com/apidoc/docs-site/406120/api-5366060.md): 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. - Phone Devices [Delete a device](https://apifox.com/apidoc/docs-site/406120/api-5366061.md): Remove a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.

- Phone Devices [Get device details](https://apifox.com/apidoc/docs-site/406120/api-5366062.md): Get detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).

- Phone Devices [Update a device](https://apifox.com/apidoc/docs-site/406120/api-5366063.md): Update information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).

- Phone Reports [Get operation logs report](https://apifox.com/apidoc/docs-site/406120/api-5366064.md): The **Phone System operation logs report** allows account owners and admins to view monthly Zoom phone related admin operation details. - Phone Shared Line Groups [List shared line groups](https://apifox.com/apidoc/docs-site/406120/api-5366065.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups. - Phone Shared Line Groups [Create a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366066.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to create a shared line group. - Phone Shared Line Groups [Delete a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366067.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. Use this API to delete a Shared Line Group. - Phone Shared Line Groups [Get a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366068.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups. - Phone Shared Line Groups [Update a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366069.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to update information of a Shared Line Group. - Phone Shared Line Groups [Unassign members of a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366070.md): Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. Use this API to unassign **all** the existing members from a Shared Line Group. - Phone Shared Line Groups [Add members to a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366071.md): A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to [add members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a Shared Line Group. Note that a member can only be added to one shared line group. - Phone Shared Line Groups [Unassign a member from a shared line group](https://apifox.com/apidoc/docs-site/406120/api-5366072.md): Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. Use this API to unassign **a specific member** from a Shared Line Group. - Phone Shared Line Groups [Assign phone numbers](https://apifox.com/apidoc/docs-site/406120/api-5366073.md): Use this API to assign phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups). - Phone Shared Line Groups [Unassign a phone number](https://apifox.com/apidoc/docs-site/406120/api-5366074.md): Use this API to unassign a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups). - Phone Site [List phone sites](https://apifox.com/apidoc/docs-site/406120/api-5366075.md): 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.
- Phone Site [Create a phone site](https://apifox.com/apidoc/docs-site/406120/api-5366076.md): 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).
- Phone Site [Delete a phone site](https://apifox.com/apidoc/docs-site/406120/api-5366077.md): 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. - Phone Site [Get phone site details](https://apifox.com/apidoc/docs-site/406120/api-5366078.md): 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). - Phone Site [Update phone site details](https://apifox.com/apidoc/docs-site/406120/api-5366079.md): 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). - Reports [Get sign In / sign out activity report](https://apifox.com/apidoc/docs-site/406120/api-5366080.md): Retrieve a list of sign in / sign out activity logs [report](https://support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.
- Reports [Get cloud recording usage report](https://apifox.com/apidoc/docs-site/406120/api-5366081.md): Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.
- Reports [Get daily usage report](https://apifox.com/apidoc/docs-site/406120/api-5366082.md): Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.
- Reports [Get meeting detail reports](https://apifox.com/apidoc/docs-site/406120/api-5366083.md): Get a detailed report for a past meeting.
- Reports [Get meeting participant reports](https://apifox.com/apidoc/docs-site/406120/api-5366084.md): Get participant report for a past meeting.

- Reports [Get meeting poll reports](https://apifox.com/apidoc/docs-site/406120/api-5366085.md): Retrieve a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting.

- Reports [Get operation logs report](https://apifox.com/apidoc/docs-site/406120/api-5366086.md): The [Operations Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.
- Reports [Get telephone reports](https://apifox.com/apidoc/docs-site/406120/api-5366087.md): The [telephone report](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. - Reports [Get active/inactive host reports](https://apifox.com/apidoc/docs-site/406120/api-5366088.md): A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.
The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.
The Inactive Hosts report pulls a list of users who were not active during a specific period of time. - Reports [Get meeting reports](https://apifox.com/apidoc/docs-site/406120/api-5366089.md): Retrieve [report](https://support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on a past meeting for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. - Reports [Get webinar detail reports](https://apifox.com/apidoc/docs-site/406120/api-5366090.md): Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.

- Reports [Get webinar participant reports](https://apifox.com/apidoc/docs-site/406120/api-5366091.md): Get detailed report on each attendee of a webinar.

- Reports [Get webinar poll reports](https://apifox.com/apidoc/docs-site/406120/api-5366092.md): Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

- Reports [Get webinar Q&A report](https://apifox.com/apidoc/docs-site/406120/api-5366093.md): The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. - Roles [List roles](https://apifox.com/apidoc/docs-site/406120/api-5366094.md): List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account - Roles [Create a role](https://apifox.com/apidoc/docs-site/406120/api-5366095.md): Each Zoom user automatically has a role which can either be owner, administrator, or a member. - Roles [Delete a role](https://apifox.com/apidoc/docs-site/406120/api-5366096.md): 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. - Roles [Get role information](https://apifox.com/apidoc/docs-site/406120/api-5366097.md): 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. - Roles [Update role information](https://apifox.com/apidoc/docs-site/406120/api-5366098.md): 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. - Roles [List members in a role](https://apifox.com/apidoc/docs-site/406120/api-5366099.md): 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. - Roles [Assign a role](https://apifox.com/apidoc/docs-site/406120/api-5366100.md): 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. - Roles [Unassign a role](https://apifox.com/apidoc/docs-site/406120/api-5366101.md): 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. - Rooms [List Zoom Rooms](https://apifox.com/apidoc/docs-site/406120/api-5366102.md): 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.

- Rooms [Add a Zoom Room](https://apifox.com/apidoc/docs-site/406120/api-5366103.md): 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.

- Rooms [List digital signage contents](https://apifox.com/apidoc/docs-site/406120/api-5366104.md): List information about existing [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage) content in a Zoom account.
You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the [Digital Signage Content](https://zoom.us/digitalsignage#/) page listed under **Room Management**. - Rooms [Update E911 digital signage](https://apifox.com/apidoc/docs-site/406120/api-5366105.md): Display or hide E911 emergency alert text content from [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). - Rooms [Check-in or check-out of a Zoom Room](https://apifox.com/apidoc/docs-site/406120/api-5366106.md): The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either **check in** and confirm that you are utilizing the room reservation or to **check out** of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the [Using the Zoom Rooms check-in feature](https://support.zoom.us/hc/en-us/articles/360001147163-Using-the-Zoom-Rooms-check-in-feature) guide. - Rooms [Delete a Zoom Room](https://apifox.com/apidoc/docs-site/406120/api-5366107.md): [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.

- Rooms [Get Zoom Room profile](https://apifox.com/apidoc/docs-site/406120/api-5366108.md): - Rooms [Update a Zoom Room profile](https://apifox.com/apidoc/docs-site/406120/api-5366109.md): Update basic information on a specific Zoom Room in a Zoom account.
- Rooms [List Zoom Room devices](https://apifox.com/apidoc/docs-site/406120/api-5366110.md): 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. - Rooms [Change a Zoom Room's location](https://apifox.com/apidoc/docs-site/406120/api-5366111.md): 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. - Rooms [Get Zoom Room settings](https://apifox.com/apidoc/docs-site/406120/api-5366112.md): 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.
- Rooms [Update Zoom Room settings](https://apifox.com/apidoc/docs-site/406120/api-5366113.md): 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.
- Rooms Account [Get Zoom Room account profile](https://apifox.com/apidoc/docs-site/406120/api-5366114.md): 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. - Rooms Account [Update Zoom Room account profile](https://apifox.com/apidoc/docs-site/406120/api-5366115.md): 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. - Rooms Account [Get Zoom Room account settings](https://apifox.com/apidoc/docs-site/406120/api-5366116.md): 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.

- Rooms Account [Update Zoom Room account settings](https://apifox.com/apidoc/docs-site/406120/api-5366117.md): 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.

- Rooms Location [List Zoom Room locations](https://apifox.com/apidoc/docs-site/406120/api-5366118.md): 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.

- Rooms Location [Add a location](https://apifox.com/apidoc/docs-site/406120/api-5366119.md): 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. - Rooms Location [Get Zoom Room location structure](https://apifox.com/apidoc/docs-site/406120/api-5366120.md): 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.

- Rooms Location [Update Zoom Rooms location structure](https://apifox.com/apidoc/docs-site/406120/api-5366121.md): 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.

- Rooms Location [Get Zoom Room location profile](https://apifox.com/apidoc/docs-site/406120/api-5366122.md): 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. - Rooms Location [Update Zoom Room location profile](https://apifox.com/apidoc/docs-site/406120/api-5366123.md): 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. - Rooms Location [Change the assigned parent location](https://apifox.com/apidoc/docs-site/406120/api-5366124.md): 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.

- Rooms Location [Get location settings](https://apifox.com/apidoc/docs-site/406120/api-5366125.md): 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.

- Rooms Location [Update location settings](https://apifox.com/apidoc/docs-site/406120/api-5366126.md): 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.

- Rooms Devices [Change Zoom Rooms' app version](https://apifox.com/apidoc/docs-site/406120/api-5366127.md): [Upgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_1751c48a-644e-4a60-b96a-31ec77c616e6) or [downgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_d97349d6-9253-484c-af80-350475026524) the version of Zoom Rooms App installed in your Mac or Windows device. - SIP Phone [List SIP phones](https://apifox.com/apidoc/docs-site/406120/api-5366128.md): 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.

- SIP Phone [Enable SIP phone](https://apifox.com/apidoc/docs-site/406120/api-5366129.md): 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.

- SIP Phone [Delete SIP phone](https://apifox.com/apidoc/docs-site/406120/api-5366130.md): 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.

- SIP Phone [Update SIP phone](https://apifox.com/apidoc/docs-site/406120/api-5366131.md): 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.

- TrackingField [List tracking fields](https://apifox.com/apidoc/docs-site/406120/api-5366132.md): [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to list all the tracking fields on your Zoom account.

- TrackingField [Create a tracking field](https://apifox.com/apidoc/docs-site/406120/api-5366133.md): [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to create a new tracking field.

- TrackingField [Delete a tracking field](https://apifox.com/apidoc/docs-site/406120/api-5366134.md): [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to delete a tracking field.

- TrackingField [Get a tracking field](https://apifox.com/apidoc/docs-site/406120/api-5366135.md): [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.

When scheduling a meeting, the tracking field will be included in the meeting options.
Use this API to get information on a tracking field.

- TrackingField [Update a tracking field](https://apifox.com/apidoc/docs-site/406120/api-5366136.md): [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
Use this API to update a tracking field.

- TSP [Get account's TSP information](https://apifox.com/apidoc/docs-site/406120/api-5366137.md): Get information on Telephony Service Provider on an account level.

- TSP [Update account's TSP information](https://apifox.com/apidoc/docs-site/406120/api-5366138.md): Update information of the Telephony Service Provider set up on an account.
- TSP [List user's TSP accounts](https://apifox.com/apidoc/docs-site/406120/api-5366139.md): A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.

- TSP [Add a user's TSP account](https://apifox.com/apidoc/docs-site/406120/api-5366140.md): Add a user's TSP account.

- TSP [Set global dial-in URL for a TSP user](https://apifox.com/apidoc/docs-site/406120/api-5366141.md): A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.

- TSP [Delete a user's TSP account](https://apifox.com/apidoc/docs-site/406120/api-5366142.md): Delete a user's TSP account.

- TSP [Get a user's TSP account](https://apifox.com/apidoc/docs-site/406120/api-5366143.md): Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.

- TSP [Update a TSP account](https://apifox.com/apidoc/docs-site/406120/api-5366144.md): Update a user's TSP account.

- PAC [List a user's PAC accounts](https://apifox.com/apidoc/docs-site/406120/api-5366145.md): [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC) allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.
Use this API to list a user's PAC accounts.