Logo
Zoom Public API Documentation

phone-common area phones-{common Area Phone Id}

Number of APIs: 3


1. Update common area phone

PATCH {{baseUrl}}/phone/common_area_phones/:commonAreaPhoneId

Use this API to update details on a specific common area phone in an account.

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:write:admin Rate Limit Label: Light

Prerequisites:

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



2. Delete a common area phone

DELETE {{baseUrl}}/phone/common_area_phones/:commonAreaPhoneId

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. Use this API to remove the common area phone from Zoom Phone System in an account.

Prerequisites:

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

Scopes: phone:write:admin

Rate Limit Label: Light



3. Get common area phone details

GET {{baseUrl}}/phone/common_area_phones/:commonAreaPhoneId

Use this API to get details on a specific common area phone in an account.

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.

Prerequisites:

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

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



ENDPOINTS