List Zoom Rooms under Zoom Phone license
GET {{baseUrl}}/phone/rooms?page_size=30&next_page_token=<string>&site_id=<string>&calling_type=<integer>&keyword=<string>
Retrieves a list of Zoom Rooms under the account that has the Zoom Phone license assigned.Prerequisites: * A Pro or higher account plan * A Zoom Phone license
Scopes: phone:read:admin
Granular Scopes: phone:read:list_rooms:admin
Rate Limit Label: MEDIUM
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | The number of records returned from a single API call. | |
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. | |
site_id | string | The site ID retrievable from the List Phone Sites API. | |
calling_type | string | The type of calling plan. | |
keyword | string | The Zoom room name or phone number from which to filter the results . |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"rooms":[{"calling_plans":[{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"calling_plans":[{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"total_records":"\u003cinteger\u003e"}