Zoom Public API Documentation
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: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_numbers:adminMEDIUM
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 | 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](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": "<integer>",
"phone_numbers": [
{
"assignee": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"type": "emergencyNumberPool"
},
"capability": [
"<string>",
"<string>"
],
"carrier": {
"code": "<integer>",
"name": "<string>"
},
"display_name": "<string>",
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"state_code": "<string>",
"zip": "<string>"
},
"emergency_address_status": 1,
"emergency_address_update_time": "<string>",
"id": "<string>",
"location": "<string>",
"number": "<string>",
"number_type": "toll",
"sip_group": {
"display_name": "<string>",
"id": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"source": "external",
"status": "pending"
},
{
"assignee": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"type": "companyLocation"
},
"capability": [
"<string>",
"<string>"
],
"carrier": {
"code": "<integer>",
"name": "<string>"
},
"display_name": "<string>",
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"state_code": "<string>",
"zip": "<string>"
},
"emergency_address_status": 2,
"emergency_address_update_time": "<string>",
"id": "<string>",
"location": "<string>",
"number": "<string>",
"number_type": "tollfree",
"sip_group": {
"display_name": "<string>",
"id": "<string>"
},
"site": {
"id": "<string>",
"name": "<string>"
},
"source": "internal",
"status": "pending"
}
],
"total_records": "<integer>"
} |
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