Qodex.ai

List common area phones

GET {{baseUrl}}/phone/common_area_phones?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2

Use this API to list all of an account's common area phones.

A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.

Scopes: phone:read:admin Rate Limit Label: Medium

Prerequisites:

  • Pro or a higher account with Zoom Phone license.
  • Account owner or admin permissions.
  • A supported device

Request Params

KeyDatatypeRequiredDescription
page_sizenumberThe total number of records returned from a single API call.
next_page_tokenstringThe 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"common_area_phones":[{"calling_plans":[{"name":"US/CA Metered Calling Plan","type":100},{"name":"US/CA Metered Calling Plan","type":100}],"device_type":"Other","display_name":"test_cap","id":"JOZmuJ30Spyrw-v9vUzIrA","mac_address":"0004f25eec3a","phone_numbers":[{"id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"},{"id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"}],"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"status":"offline"},{"calling_plans":[{"name":"US/CA Metered Calling Plan","type":100},{"name":"US/CA Metered Calling Plan","type":100}],"device_type":"Other","display_name":"test_cap","id":"JOZmuJ30Spyrw-v9vUzIrA","mac_address":"0004f25eec3a","phone_numbers":[{"id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"},{"id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"}],"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"status":"offline"}],"next_page_token":"T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2","page_size":30,"total_records":35}