List phone numbers
GET {{baseUrl}}/phone/numbers?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&type=all&extension_type=user&page_size=30&number_type=toll&pending_numbers=false&site_id=8f71O6rWT8KFUGQmJIFAdQ
Use this API to list all Zoom Phone numbers in a Zoom account.
Scopes:
phone:read:admin
Rate Limit Label
:
Medium
Prerequisites:
- A Pro or higher account plan
- A Zoom Phone license
Request Params
| Key | Datatype | Required | Description |
| next_page_token | string | | 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. |
| type | string | | Query response by number assignment. The value can be one of the following:
<br>
assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. <br>unassigned: The number is not assigned to anyone.<br>
all: Include both assigned and unassigned numbers in the response.<br>
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 value can be one of the following:<br>
user<br> callQueue<br> autoReceptionist<br>
commonAreaPhone |
| 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 | boolean | | Include or exclude pending numbers in the response. The value can be either true or false. |
| site_id | string | | 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. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"bkOcmnm6mn6ioYAi10BcgRiEL38WzAo6jP2","page_size":30,"phone_numbers":[{"assignee":{"extension_number":47317542,"id":"Y40mS72DRamFgGh0V1Ul_Q","name":"User Name","type":"user"},"capability":["incoming","incoming"],"carrier":{"code":1,"name":"Bandwidth"},"display_name":"abc","emergency_address":{"address_line1":"55 ALMADEN BLVD","address_line2":"test 7","city":"SAN JOSE","country":"US","state_code":"CA","zip":"95113"},"emergency_address_status":1,"emergency_address_update_time":"2022-02-18T07:20:19Z","id":"aMy7P9DMS9iNRkpwXNfRbw","location":"United States","number":"+12008001005","number_type":"toll","sip_group":{"display_name":"RRRR","id":"8MhK7ea4Q4ihIQ4TD_g0kw"},"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"source":"external","status":"available"},{"assignee":{"extension_number":-27970745,"id":"Y40mS72DRamFgGh0V1Ul_Q","name":"User Name","type":"user"},"capability":["incoming","incoming"],"carrier":{"code":1,"name":"Bandwidth"},"display_name":"abc","emergency_address":{"address_line1":"55 ALMADEN BLVD","address_line2":"test 7","city":"SAN JOSE","country":"US","state_code":"CA","zip":"95113"},"emergency_address_status":1,"emergency_address_update_time":"2022-02-18T07:20:19Z","id":"aMy7P9DMS9iNRkpwXNfRbw","location":"United States","number":"+12008001005","number_type":"toll","sip_group":{"display_name":"RRRR","id":"8MhK7ea4Q4ihIQ4TD_g0kw"},"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"source":"external","status":"available"}],"total_records":50}