Zoom Public API Documentation
List phone numbers for a site's customized outbound caller ID
GET {{baseUrl}}/phone/sites/:siteId/outbound_caller_id/customized_numbers?selected=true&site_id=SQv52YtkRLC2dwrDdYtGsA&extension_type=callQueue&keyword=408&page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
Use this API to retrieve phone numbers that can be used as the Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license. Scope: Rate Limit Label: site-level customized outbound caller ID.
* Multiple sites must be enabled. phone:read:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
selected
|
boolean | Status of the phone numbers.<br>`true`- Numbers already added to the custom list. <br>`false`- Numbers not yet added to the custom list | |
site_id
|
string | For filtering phone numbers that belong to the site. | |
extension_type
|
string | The type of the extension to which the phone number belongs. | |
keyword
|
number | A search keyword for phone or extension numbers. | |
page_size
|
number | The number of records returned within a single API call. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"customize_numbers": [
{
"customize_id": "8_RkKw9OQ42oYsXqJJjs4A",
"phone_number_id": "55JUZPwERHuGttd_j4qBsQ",
"phone_number": "+12055437350",
"display_name": "test abc",
"incoming": true,
"outgoing": true,
"extension_id": "HaSokHMCSeK8taMdv2vnXQ",
"extension_type": "callQueue",
"extension_number": "est dolor dolor",
"extension_name": "SJ CQ",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "testSite"
}
},
{
"customize_id": "8_RkKw9OQ42oYsXqJJjs4A",
"phone_number_id": "55JUZPwERHuGttd_j4qBsQ",
"phone_number": "+12055437350",
"display_name": "test abc",
"incoming": true,
"outgoing": true,
"extension_id": "HaSokHMCSeK8taMdv2vnXQ",
"extension_type": "callQueue",
"extension_number": "cillum Ut voluptate in Excepteur",
"extension_name": "SJ CQ",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "testSite"
}
}
],
"next_page_token": "BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2",
"page_size": 30,
"total_records": 10
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId/outbound_caller_id/customized_numbers?selected=true&site_id=SQv52YtkRLC2dwrDdYtGsA&extension_type=callQueue&keyword=408&page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2?selected=true&site_id=SQv52YtkRLC2dwrDdYtGsA&extension_type=callQueue&keyword=408&page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2' -H 'Accept: application/json'
ENDPOINTS