Qodex.ai

List common areas

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

Use this API to list common areas under an account.

Note: For use by customers who opted for Common Area Optimization

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Scopes: phone:read:admin

Rate Limit Label: Medium

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_areas":[{"calling_plans":[{"name":"US/CA Metered Calling Plan","type":100},{"name":"US/CA Metered Calling Plan","type":100}],"display_name":"test_ca","id":"JOZmuJ30Spyrw-v9vUzIrA","phone_numbers":[{"display_name":"Phone number display name","id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"},{"display_name":"Phone number display name","id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"}],"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"status":"offline","desk_phones":[{"id":"Aky1xpSLSc2PR0XOtj9XWQ","display_name":"analog_ta","device_type":"Poly obi504","status":"offline"},{"id":"Aky1xpSLSc2PR0XOtj9XWQ","display_name":"analog_ta","device_type":"Poly obi504","status":"offline"}]},{"calling_plans":[{"name":"US/CA Metered Calling Plan","type":100},{"name":"US/CA Metered Calling Plan","type":100}],"display_name":"test_ca","id":"JOZmuJ30Spyrw-v9vUzIrA","phone_numbers":[{"display_name":"Phone number display name","id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"},{"display_name":"Phone number display name","id":"S5q4FDC3QsOCnO7LqHgqNw","number":"+12058945543","source":"internal"}],"site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"status":"offline","desk_phones":[{"id":"Aky1xpSLSc2PR0XOtj9XWQ","display_name":"analog_ta","device_type":"Poly obi504","status":"offline"},{"id":"Aky1xpSLSc2PR0XOtj9XWQ","display_name":"analog_ta","device_type":"Poly obi504","status":"offline"}]}],"next_page_token":"RaO87FrnwXvFQta5aV8sU5C3c9O8s9Nraq2","page_size":74153108}