Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Accounts
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Chatbot Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Reports
Roles
Rooms
Rooms Account
Rooms Location
SIP Phone
TrackingField
TSP
Users
Webinars
Rooms Devices
SIP Connected Audio
Deprecated API Endpoints
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Data Compliance

Zoom Phone APIs


API description Method Endpoint
List Zoom Phone calling plans of an account GET /v2/accounts/{accountId}/phone/calling_plans
Assign calling plan to a user POST /v2/accounts/{accountId}/phone/users/{userId}/calling_plans
Unassign user's calling plans DELETE /v2/accounts/{accountId}/phone/users/{userId}/calling_plans/{type}
List phone users GET /v2/accounts/{accountId}/phone/users
Get user's profile GET /v2/accounts/{accountId}/phone/users/userId
Update user's profile PATCH /v2/accounts/{accountId}/phone/users/{userId}
Get user's settings GET /v2/accounts/{accountId}/phone/users/{userId}/settings
Update account's settings PATCH /v2/accounts/{accountId}/phone/settings
Add user's subsettings POST /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Update user's subsettings PATCH /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Delete user's subsettings DELETE /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Get user's phone recordings GET /v2/accounts/{accountId}/phone/users/{userId}/recordings
List account's phone recordings GET /v2/accounts/{accountId}/phone/users/{userId}/recordings
List user's voicemails GET /v2/accounts/{accountId}/phone/users/{userId}/voice_mails
Get voicemail details GET /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}
Delete a voicemail DELETE /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}
List user's phone numbers GET /v2/accounts/{accountId}/phone/numbers
Get phone number details GET /v2/accounts/{accountId}/phone/numbers/{numberId}
Delete a phone number DELETE /v2/accounts/{accountId}/phone/users/{userId}/phone_numbers/{phoneNumberId}
Change main company phone number PUT /v2/accounts/{accountId}/phone/company_number
Create a phone site POST /v2/accounts/{accountId}/phone/sites
Update a phone site PATCH /v2/accounts/{accountId}/phone/sites/{siteId}
List phone sites GET /v2/accounts/{accountId}/phone/sites
Get site details GET /v2/accounts/{accountId}/phone/sites/{siteId}
Delete a site DELETE /v2/accounts/{accountId}/phone/sites/{siteId}
Add a device POST /v2/accounts/{accountId}/phone/devices

Update a device PATCH /v2/accounts/{accountId}/phone/devices/{deviceId}
List all devices GET /v2/accounts/{accountId}/phone/devices/{deviceId}
Get device details GET /v2/accounts/{accountId}/phone/devices
Delete a device DELETE /v2/accounts/{accountId}/phone/devices/{deviceId}
List BYOC sip trunks of a Zoom Phone account. GET /v2/accounts/{accountId}/phone/sip_trunk/trunks

Zoom Phone call queues APIs

API description Method Endpoint
Create a call queue POST /v2/accounts/{accountId}/phone/call_queues
List call queues GET /v2/accounts/{accountId}/phone/call_queues
Get call queue details GET /v2/accounts/{accountId}/phone/call_queues/{callQueueId}
Update call queue details PATCH /v2/accounts/{accountId}/phone/call_queues/{callQueueId}
Assign numbers to a call queue POST /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers
Add members to a call queue POST /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members
Unassign all phone numbers from a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers
Unassign a single phone number DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}
Remove all members from a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members
Remove a member from a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members/{memberId}
Change call queue manager PUT /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/manager
Get recordings of a call queue GET /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/recordings
Delete a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}

Zoom Phone auto-receptionists APIs

API description Method Endpoint
Add an auto receptionist POST /v2/accounts/{accountId}/phone/auto_receptionists
Update auto receptionist details PATCH /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}
Assign phone numbers POST /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/phone_numbers
Unassign all phone numbers DELETE /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/phone_numbers
Unassign a single phone number DELETE /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}

Zoom Phone common area phones APIs

API description Method Endpoint
Add a common area phone POST /v2/accounts/{accountId}/phone/common_area_phones
List common area phones GET /v2/accounts/{accountId}/phone/common_area_phones

Get common area phone details GET /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}
Update common area phone details PATCH /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}
Delete a common area phone DELETE /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}

Zoom Phone blocked lists APIs

API description Method Endpoint
Create a blocked list POST /v2/accounts/{accountId}/phone/blocked_list
List blocked list GET /v2/accounts/{accountId}/phone/blocked_list
Get details of a blocked list GET /v2/accounts/{accountId}/phone/blocked_list/{blockedListId}
Update details of a blocked list PATCH /v2/accounts/{accountId}/phone/blocked_list/{blockedListId}
Delete a blocked list DELETE /v2/accounts/{accountId}/phone/blocked_list/{blockedListId}

Zoom Phone call logs APIs

API description Method Endpoint
List call logs of an account GET /v2/accounts/{accountId}/phone/call_logs

List call logs of a user GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs
Get call log details GET /v2/accounts/{accountId}/phone/call_logs/{callLogId}
Delete a call log DELETE /v2/accounts/{accountId}/phone/users/{userId}/call_logs/{callLogId}
List call logs' metrics GET /v2/accounts/{accountId}/phone/metrics/call_logs
Get call log metrics details GET /v2/accounts/{accountId}/phone/metrics/call_logs/{callId}
Get call log QoS GET /v2/accounts/{accountId}/phone/metrics/call_logs/{callId}/qos

Zoom Phone shared line groups APIs

API description Method Endpoint
Create a shared line group POST /v2/accounts/{accountId}/phone/shared_line_groups
List all shared line groups GET /v2/accounts/{accountId}/phone/shared_line_groups
Get details of a shared line group GET /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}
Update a shared line group PATCH /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLingGroupId}
Add members to a shared line group POST /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/members
Remove a member from a shared line group DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/members/{memberId}
Remove all members from a shared line group DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/members
Assign phone numbers POST /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/phone_numbers
Unassign a phone number DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/phone_numbers/{phoneNumberId}
Delete a shared line group DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}