GET {{baseUrl}}/phone/numbers?next_page_token=<string>&type=assigned&extension_type=meetingService&page_size=30&number_type=toll&pending_numbers=<boolean>&site_id=<string>
Returns a list all Zoom Phone numbers in a Zoom account. Prerequisites:
* A Pro or higher account plan
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:admin
phone:read:list_numbers:admin
MEDIUM
Body
PARAM
Key | Datatype | Required | Description |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
type
|
string | The query response by number assignment. The value can be one of the following: `assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist, or a common area in an account. `unassigned`: The number is not assigned to anyone. `all`: Include both assigned and unassigned numbers in the response. `byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response. | |
extension_type
|
string | The type of assignee to whom the number is assigned. The parameter can be set only if `type` parameter is set as `assigned`. The value can be one of the following: `user` `callQueue` `autoReceptionist` `commonArea` `emergencyNumberPool` `companyLocation` `meetingService` | |
page_size
|
number | The number of records returned within a single API call. | |
number_type
|
string | The type of phone number. The value can be either `toll` or `tollfree`. | |
pending_numbers
|
string | This field includes or excludes pending numbers in the response. The value can be either `true` or `false`. | |
site_id
|
string | Curl curl -X GET 'https://api.zoom.us/v2/phone/numbers?next_page_token=<string>&type=assigned&extension_type=meetingService&page_size=30&number_type=toll&pending_numbers=<boolean>&site_id=<string>?next_page_token=<string>&type=assigned&extension_type=meetingService&page_size=30&number_type=toll&pending_numbers=<boolean>&site_id=<string>' -H 'Accept: application/json' ENDPOINTS |