Logo
Zoom Public API Documentation

phone-devices

Number of APIs: 4


1. Sync deskphones

POST {{baseUrl}}/phone/devices/sync

Use this API to resync all online zero-touch or assisted-provisioning devices in an account or a site. Only allows sending one request every 15 minutes.

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions Scopes: phone:write:admin

Rate Limit Label: Heavy



2. List devices

GET {{baseUrl}}/phone/devices?type=assigned&assignee_type=commonArea&device_source=haas&location_status=unknownAddress&site_id=<string>&device_type=yealink&keyword=<string>&next_page_token=<string>&page_size=30

Lists all the desk phone devices that are configured with Zoom Phone on an account.

Prerequisites:

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

Scopes: phone:read:admin

Granular Scopes: phone:read:list_devices:admin

Rate Limit Label: MEDIUM



3. Add a device

POST {{baseUrl}}/phone/devices

By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to add a desk phone and assign it to a user.

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



4. List devices

GET {{baseUrl}}/phone/devices?type=assigned&assignee_type=user&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30

List all the desk phone devices that are configured with Zoom Phone on an account.

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

Prerequisites:

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



ENDPOINTS