List Phone Numbers

A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters.**Prerequisites:*** Pro or higher plan with Zoom phone license**Scope:** phone:read:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium

listPhoneNumbers(
  next_page_token = NULL,
  type = NULL,
  extension_type = NULL,
  page_size = NULL,
  number_type = NULL,
  pending_numbers = NULL,
  site_id = NULL,
  return_response = F
)

Arguments

next_page_token	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.
type	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 autoreceptionist or a common area phone in an account. unassigned: The number is not assigned to anyone.all: Include both assigned and unassigned numbers in the response.
extension_type	The type of assignee to whom the number is assigned. The value can be one of the following:user callQueue autoReceptionistcommonAreaPhone
page_size	The number of records returned within a single API call.
number_type	The type of phone number. The value can be either toll or tollfree.
pending_numbers	Include or exclude pending numbers in the response. The value can be either true or false.
site_id	Unique identifier of the site. Use this query parameter if you have enabled multiple sites https://support.zoom.us/hc/enus/articles/360020809672Managingmultiplesites#h_05c88e351593491fb1a8b7139a75dc15 and would like to filter the response of this API call by a specific phone site https://support.zoom.us/hc/enus/articles/360020809672Managingmultiplesites .
return_response	Whether to return the response instead of the response content. Defaults to FALSE.

Arguments

Contents