List phone numbers
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:
phone:read:admin
Granular Scopes:
phone:read:list_numbers:admin
Rate Limit Label
:
MEDIUM
Request Params
| 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 | | The 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":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","phone_numbers":[{"assignee":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"emergencyNumberPool"},"capability":["\u003cstring\u003e","\u003cstring\u003e"],"carrier":{"code":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"display_name":"\u003cstring\u003e","emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","state_code":"\u003cstring\u003e","zip":"\u003cstring\u003e"},"emergency_address_status":1,"emergency_address_update_time":"\u003cstring\u003e","id":"\u003cstring\u003e","location":"\u003cstring\u003e","number":"\u003cstring\u003e","number_type":"toll","sip_group":{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"source":"external","status":"pending"},{"assignee":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"companyLocation"},"capability":["\u003cstring\u003e","\u003cstring\u003e"],"carrier":{"code":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"display_name":"\u003cstring\u003e","emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","state_code":"\u003cstring\u003e","zip":"\u003cstring\u003e"},"emergency_address_status":2,"emergency_address_update_time":"\u003cstring\u003e","id":"\u003cstring\u003e","location":"\u003cstring\u003e","number":"\u003cstring\u003e","number_type":"tollfree","sip_group":{"display_name":"\u003cstring\u003e","id":"\u003cstring\u003e"},"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"source":"internal","status":"pending"}],"total_records":"\u003cinteger\u003e"}