Zoom Phone API

Zoom Phone API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

Zoom Phone API | Zoom Public Workspace | API documentation

Accept

List phone numbers

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.

next_page_token

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.

type

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`

extension_type

The number of records returned within a single API call.

page_size

The type of phone number. The value can be either `toll` or `tollfree`.

number_type

This field includes or excludes pending numbers in the response. The value can be either `true` or `false`.

pending_numbers

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.

site_id

"{\n  \"next_page_token\": \"\u003cstring\u003e\",\n  \"page_size\": \"\u003cinteger\u003e\",\n  \"phone_numbers\": [\n    {\n      \"assignee\": {\n        \"extension_number\": \"\u003clong\u003e\",\n        \"id\": \"\u003cstring\u003e\",\n        \"name\": \"\u003cstring\u003e\",\n        \"type\": \"emergencyNumberPool\"\n      },\n      \"capability\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"carrier\": {\n        \"code\": \"\u003cinteger\u003e\",\n        \"name\": \"\u003cstring\u003e\"\n      },\n      \"display_name\": \"\u003cstring\u003e\",\n      \"emergency_address\": {\n        \"address_line1\": \"\u003cstring\u003e\",\n        \"address_line2\": \"\u003cstring\u003e\",\n        \"city\": \"\u003cstring\u003e\",\n        \"country\": \"\u003cstring\u003e\",\n        \"state_code\": \"\u003cstring\u003e\",\n        \"zip\": \"\u003cstring\u003e\"\n      },\n      \"emergency_address_status\": 1,\n      \"emergency_address_update_time\": \"\u003cstring\u003e\",\n      \"id\": \"\u003cstring\u003e\",\n      \"location\": \"\u003cstring\u003e\",\n      \"number\": \"\u003cstring\u003e\",\n      \"number_type\": \"toll\",\n      \"sip_group\": {\n        \"display_name\": \"\u003cstring\u003e\",\n        \"id\": \"\u003cstring\u003e\"\n      },\n      \"site\": {\n        \"id\": \"\u003cstring\u003e\",\n        \"name\": \"\u003cstring\u003e\"\n      },\n      \"source\": \"external\",\n      \"status\": \"pending\"\n    },\n    {\n      \"assignee\": {\n        \"extension_number\": \"\u003clong\u003e\",\n        \"id\": \"\u003cstring\u003e\",\n        \"name\": \"\u003cstring\u003e\",\n        \"type\": \"companyLocation\"\n      },\n      \"capability\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"carrier\": {\n        \"code\": \"\u003cinteger\u003e\",\n        \"name\": \"\u003cstring\u003e\"\n      },\n      \"display_name\": \"\u003cstring\u003e\",\n      \"emergency_address\": {\n        \"address_line1\": \"\u003cstring\u003e\",\n        \"address_line2\": \"\u003cstring\u003e\",\n        \"city\": \"\u003cstring\u003e\",\n        \"country\": \"\u003cstring\u003e\",\n        \"state_code\": \"\u003cstring\u003e\",\n        \"zip\": \"\u003cstring\u003e\"\n      },\n      \"emergency_address_status\": 2,\n      \"emergency_address_update_time\": \"\u003cstring\u003e\",\n      \"id\": \"\u003cstring\u003e\",\n      \"location\": \"\u003cstring\u003e\",\n      \"number\": \"\u003cstring\u003e\",\n      \"number_type\": \"tollfree\",\n      \"sip_group\": {\n        \"display_name\": \"\u003cstring\u003e\",\n        \"id\": \"\u003cstring\u003e\"\n      },\n      \"site\": {\n        \"id\": \"\u003cstring\u003e\",\n        \"name\": \"\u003cstring\u003e\"\n      },\n      \"source\": \"internal\",\n      \"status\": \"pending\"\n    }\n  ],\n  \"total_records\": \"\u003cinteger\u003e\"\n}"

**HTTP Status Code:** `200` **OK**  
 
Phone numbers listed successfully.

Added as a part of security scheme: oauth2

List phone numbers phone Zoom Phone API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

List phone numbers phone Zoom Phone API | Zoom Public Workspace | API documentation

phone-numbers

phone Zoom Phone API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

phone Zoom Phone API | Zoom Public Workspace | API documentation

<h1>Welcome 👋</h1>

<p>Discover curated API workflows for common Zoom Developer use cases to build on one of the world&#39;s most powerful video communication platforms.</p>

<h1>Get Started</h1>

<p>🍴 [fork] the <q>Get Started Fast with Zoom APIs</q> collection and [environment variables]</p>

<p>👀 familiarize yourself with the collection [variables] we reference,</p>

<p>🚀 blast off and explore the collection requests to create on the Zoom Developer platform,</p>

<p>🤝 collaborate on improvements to the collection through [pull requests] and [feedback]</p>

<hr>

<h5>Need some more guidance on how to use the workspace?</h5>

<p>📖 <strong>Informational blog post:</strong> <a href="https://dev.to/gigicodesfullstack/zoom-api-testing-made-easy-with-Qodex-public-workspace-5fh7">Zoom API Testing Made Easy with Qodex Public Workspace</a></p>

<p>📖 <strong>Tutorial blog post:</strong> <a href="https://blog.zoom.us/curated-api-workflows-zoom-Qodex-workspace/">Developers: discover curated API workflows on Qodex</a></p>

<p>🎥 <strong>Video tutorial:</strong> <a href="https://www.youtube.com/watch?v=kQ7hkXBvLe0">Build Video Communications Solutions Faster with Zoom&#39;s Qodex Workspace</a></p>

<hr>

<h5>Other build resources curated by Zoom Developer Advocates:</h5>

<p><strong>Developer forum:</strong> <a href="https://devforum.zoom.us/">https://devforum.zoom.us/</a></p>

<p><strong>Developer-written blogs:</strong> <a href="https://developers.zoom.us/blog/">https://developers.zoom.us/blog/</a></p>

<p><strong>Zoom Developer Youtube channel:</strong> <a href="https://www.youtube.com/@ZoomDevelopers/videos">https://www.youtube.com/@ZoomDevelopers/videos</a></p>


Zoom Public

Github

Developer Website

Zoom Public projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

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	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' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS