The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applicatixons on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide.\nAll endpoints are available via https and are located at api.zoom.us/v2/.
For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Contact Support:\n Name: Zoom Developers\n Email: developersupport@zoom.us
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3710052","collectionId":"2649dc16-086e-40a2-8292-b6401001c7d9","publishedId":"TVKBYJTq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-19T08:25:51.000Z"},"item":[{"name":"phone","item":[{"name":"numbers","item":[{"name":"https://api.zoom.us/v2/phone/numbers","id":"008a4e10-1847-4b7b-9827-6bc7e5e5dd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://api.zoom.us/v2/phone/numbers?next_page_token=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.
\nPrerequisites:
phone:read:adminMediumThe next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"Query response by number assignment. The value can be one of the following:
\nassigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. unassigned: The number is not assigned to anyone.
all: Include both assigned and unassigned numbers in the response.
The type of assignee to whom the number is assigned. The value can be one of the following:
\nuser
callQueue
autoReceptionist
\ncommonAreaPhone
The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"The type of phone number. The value can be either toll or tollfree.
Include or exclude pending numbers in the response. The value can be either true or false.
Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site.
\n","type":"text/plain"},"key":"site_id","value":"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.
\nPrerequisites:
phone:read:admin Rate Limit Label: Light
(Required) Unique Identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.
\n","type":"text/plain"},"type":"string","value":"Sites allow you to organize Zoom Phone users in your organization. Use this API to get information about a specific site.
\nPrerequisites:
phone:read:adminLight(Required) Unique Identifier of the Site.
\n","type":"text/plain"},"type":"string","value":"Sites allow you to organize Zoom Phone users in your organization. Use this API to delete a specific site 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.
\nPrerequisites:
phone:write:admin(Required) The Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.
\n","type":"text/plain"},"key":"transfer_site_id","value":"(Required) Unique Identifier of the Site.
\n","type":"text/plain"},"type":"string","value":"Name of the site.
\n"},{"key":"site_code","value":"Sites allow you to organize Zoom Phone users in your organization. Use this API to update information about a specific site.
\nPrerequisites:
phone:write:adminLight(Required) Unique Identifier of the Site.
\n","type":"text/plain"},"type":"string","value":"Name of the Site.
\n"},{"key":"auto_receptionist_name","value":"Display name of the auto-receptionist for the site.
\n"},{"key":"site_code","value":"Identifier for a site. If site code is enabled, this field is required.
\n"},{"key":"default_emergency_address","value":"{\"country\":\"(Required)
\n"},{"key":"short_extension","value":"{\"length\":3}","type":"text","description":"Short extension of the phone site.
\n"}]},"url":"https://api.zoom.us/v2/phone/sites","description":"Sites allow you to organize Zoom Phone users in your organization. Use this API to create a Site.
\nPrerequisites:
phone:write:admin Rate Limit Label: Light
Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the sites that have been created for an account.
\nPrerequisites:
Scope: phone:read:admin
\n Rate Limit Label: Medium
The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"Assign a phone number to a user who has already enabled Zoom Phone.
\nScopes: phone:write phone:write:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required)
\n","type":"text/plain"},"type":"string","value":"Unassign phone number of a Zoom phone user.
After assigning a phone number, you can remove it if you don't want it to be assigned to anyone.
\nScopes: phone:write phone:write:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required) Provide either userId or email address of the user.
\n","type":"text/plain"},"type":"string","value":"(Required) Provide either phone number or phoneNumberId of the user.
\n","type":"text/plain"},"type":"string","value":"Assign calling plan to a Zoom Phone user.
\nScopes: phone:write phone:write:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required)
\n","type":"text/plain"},"type":"string","value":"Unassign a calling plan that was previously assigned to a Zoom Phone user.
\nScopes: phone:write phone:write:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required) The type of the calling plan that was assigned to user. (e.g: The value of type would be \"200\" for Unlimited US/Canada calling plan.)
\n","type":"text/plain"},"type":"string","value":"(Required)
\n","type":"text/plain"},"type":"string","value":"Retrieve a user's zoom phone profile.
\nScopes: phone:read, phone:read:admin
\n Rate Limit Label: Light
Prerequisites :
\n(Required) The user ID or email address of the user. For user-level apps, pass me as the value for userId.
The extension number of the user. The number must be complete (i.e. site number + short extension).
\n"},{"key":"site_id","value":"Unique identifier of the site where the user should be moved/assigned.
\n"}]},"url":"https://api.zoom.us/v2/phone/users/:userId","description":"Update a Zoom Phone user's profile.
\nScopes: phone:write phone:write:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required)
\n","type":"text/plain"},"type":"string","value":"Retrieve a user's zoom phone profile settings.
\nScopes: phone:read, phone:read:admin
\n Rate Limit Label: Light
\nPrerequisite:
(Required) The user ID or email address of the user. For user-level apps, pass me as the value for userId.
Retrieve a zoom phone user's call logs.
\nScopes: phone:read, phone:read:admin
\n Rate Limit Label: Heavy
\nPrerequisite:
The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.
\n","type":"text/plain"},"key":"from","value":"(Required) End date.
\n","type":"text/plain"},"key":"to","value":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"(Required) The user ID or email address of the user. For user-level apps, pass me as the value for userId.
Retrieve a user's zoom phone recordings.\nScopes: phone:read, phone:read:admin
Rate Limit Label: Medium
\nPrerequisite:
The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"(Required) The user ID or email address of the user. For user-level apps, pass me as the value for userId.
Retrieve a user's Zoom Phone voicemails.
\nScopes: phone:read, phone:read:admin
\n Rate Limit Label: Medium
\nPrerequisite:
The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"Status of the voice mail
\n","type":"text/plain"},"key":"status","value":"all"},{"description":{"content":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"(Required) The user ID or email address of the user. For user-level apps, pass me as the value for userId.
List all the users on an account who have been assigned Zoom Phone licenses.
\nPrerequisites:
phone:read:adminLightThe number of records returned from a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"Unique Identifier of the site. This can be retrieved from List Phone Sites API.
\n","type":"text/plain"},"key":"site_id","value":"Display name of the desk phone.
\n"},{"key":"mac_address","value":"The MAC address of the desk phone.
\nNote: If you're using a wireless phone, enter the wired MAC address, not the wireless MAC address.
User ID or email address of the user to whom this device is to be assigned. The User ID and the email of the user can be retrieved using the List Users API.
\n"}]},"url":"https://api.zoom.us/v2/phone/devices/:deviceId","description":"Update information of a desk phone device.
\nPrerequisites:
phone:write:admin Rate Limit Label: Light
(Required) Unique Identifier of the Device.
\n","type":"text/plain"},"type":"string","value":"Remove a desk phone device from the Zoom Phone System Management.
\nPrerequisites:
phone:write:admin Rate Limit Label: Light
(Required) Unique Identifier of the device.
\n","type":"text/plain"},"type":"string","value":"Get detailed information about a specific desk phone device.
\nPrerequisites:
phone:write:admin Rate Limit Label: Light
(Required) Unique Identifier of the device.
\n","type":"text/plain"},"type":"string","value":"The MAC address of the desk phone.
\nNote: If you're using a wireless phone, enter the wired MAC address, not the wireless MAC address.
Display name of the desk phone.
\n"},{"key":"type","value":"Manufacturer (brand) name of the device.
\n"},{"key":"model","value":"Model name of the device.
\n"},{"key":"assigned_to","value":"User ID or email address of the user to whom this device is to be assigned. The User ID and the email of the user can be retrieved using the List Users API.
\n"}]},"url":"https://api.zoom.us/v2/phone/devices","description":"By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to add a desk phone and assign it to a user.
\nPrerequisites:
phone:write:admin Rate Limit Label: Light
List all the desk phone devices 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.
\nScopes: phone:read:admin\n
\nPrerequisites:
Rate Limit Label: Medium
(Required) State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
\n","type":"text/plain"},"key":"next_page_token","value":"The number of records returned within a single API call.
\n","type":"text/plain"},"key":"page_size","value":"30"}],"variable":[]}},"response":[{"id":"19807192-a224-4ec7-a4af-104f4fc9306e","name":"**HTTP Status Code:** `200`Provide either the id or the number field. Only a max of 5 numbers can be assigned to a call queue at a time.
After buying phone number(s), you can assign it, allowing callers to directly dial a number to reach a call queue.
\nPrerequisites:
phone:write:adminLight(Required) Unique Identifier of the Call Queue.
\n","type":"text/plain"},"type":"string","value":"Use this API to unbind all phone numbers that are assigned to a Call Queue After successful unbinding, the numbers will appear in the Unassigned tab.
If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead.
\nPrerequisites:
phone:write:adminLight(Required) Unique Identifier of the Call Queue. This can be retrieved from List Call Queues API.
\n","type":"text/plain"},"type":"string","value":"After assigning a phone number, you can unbind it if you don't want it to be assigned to a Call Queue. Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the Unassigned tab.
\nPrerequisites:
phone:write:adminLight(Required) Unique Identifier of the Call Queue. This can be retrieved from the List Call Queues API.
\n","type":"text/plain"},"type":"string","value":"(Required) Unique Identifier of the Phone Number.
\n","type":"text/plain"},"type":"string","value":"A maximum of 10 members can be added at a time.
\n"}]},"url":"https://api.zoom.us/v2/phone/call_queues/:callQueueId/members","description":"Add phone users and/or common area phones as members to a specific Call Queue.
\nPrerequisites: