GET /phone/numbers
A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters.
Prerequisites:
- Pro or higher plan with Zoom phone license
Scope:phone:read:admin
Rate Limit Label:Medium
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pending_numbers |
Boolean | No |
Include or exclude pending numbers in the response. The value can be either |
site_id |
String | No |
Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See Managing multiple sites or Adding a site for details. |
page_size |
Integer | No |
The number of records returned within a single API call. Default value: 30 |
type |
String | No |
Query response by number assignment. The value can be one of the following:
Valid values:
|
extension_type |
String | No |
The type of assignee to whom the number is assigned. The value can be one of the following: Valid values:
|
next_page_token |
String | No |
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. |
number_type |
String | No |
The type of phone number. The value can be either Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.