Zoom Public API Documentation
List customized outbound caller ID phone numbers
GET {{baseUrl}}/phone/sites/:siteId/outbound_caller_id/customized_numbers?selected=<boolean>&site_id=<string>&extension_type=sharedLineGroup&keyword=<string>&page_size=30&next_page_token=<string>
Use this API to retrieve phone numbers that can be used as the Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license. Scopes: Granular Scopes: Rate Limit Label: site-level customized outbound caller ID.
* Multiple sites must be enabled. phone:read:adminphone:read:list_site_customized_number:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
selected
|
string | Status of the phone numbers. `true`- Numbers already added to the custom list. `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
|
string | 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 paginates through a large set of results. A next page token is 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": "<string>",
"phone_number_id": "<string>",
"phone_number": "<string>",
"display_name": "<string>",
"incoming": "<boolean>",
"outgoing": "<boolean>",
"extension_id": "<string>",
"extension_type": "<string>",
"extension_number": "<string>",
"extension_name": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
}
},
{
"customize_id": "<string>",
"phone_number_id": "<string>",
"phone_number": "<string>",
"display_name": "<string>",
"incoming": "<boolean>",
"outgoing": "<boolean>",
"extension_id": "<string>",
"extension_type": "<string>",
"extension_number": "<string>",
"extension_name": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
}
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId/outbound_caller_id/customized_numbers?selected=<boolean>&site_id=<string>&extension_type=sharedLineGroup&keyword=<string>&page_size=30&next_page_token=<string>?selected=<boolean>&site_id=<string>&extension_type=sharedLineGroup&keyword=<string>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS