List users' phone numbers for a customized outbound caller ID
GET {{baseUrl}}/phone/users/:userId/outbound_caller_id/customized_numbers?selected=<boolean>&site_id=<string>&extension_type=sharedLineGroup&keyword=<string>&page_size=30&next_page_token=<string>
Retrieves phone numbers that can be the user-level customized outbound caller ID.
Prerequisites: * A Business or Enterprise account * A Zoom Phone license.
Scopes: phone:read:admin,phone:read
Granular Scopes: phone:read:list_user_customized_number,phone:read:list_user_customized_number:admin
Rate Limit Label: Light
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
selected | string | The 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 | This field filters phone numbers that belong to the site. | |
extension_type | string | The type of 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":"\u003cstring\u003e","phone_number_id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","incoming":"\u003cboolean\u003e","outgoing":"\u003cboolean\u003e","extension_id":"\u003cstring\u003e","extension_type":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","extension_name":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"customize_id":"\u003cstring\u003e","phone_number_id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","incoming":"\u003cboolean\u003e","outgoing":"\u003cboolean\u003e","extension_id":"\u003cstring\u003e","extension_type":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","extension_name":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}