Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Chatbot Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
Roles
Rooms
Rooms Account
Rooms Location
SIP Phone
TrackingField
TSP
Users
Webinars
Rooms Devices
SIP Connected Audio
Deprecated API Endpoints
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Phone Dashboard
Archiving Events
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
Deprecated API Endpoints

Zoom Phone APIs

API description Method Endpoint
List phone numbers GET /v2/accounts/{accountId}/phone/numbers
Get user’s profile GET /v2/accounts/{accountId}/phone/users/{userId}
Update user’s profile PATCH /v2/accounts/{accountId}/phone/users/{userId}
Update BYOC (bring your own carrier) settings PATCH /v2/accounts/{accountId}/phone/settings
Get user’s settings GET /v2/accounts/{accountId}/phone/users/{userId}/settings
Get user’s recordings GET /v2/accounts/{accountId}/phone/users/{userId}/recordings
Get user’s voicemails GET /v2/accounts/{accountId}/phone/users/{userId}/voice_mails
Set up shared access POST /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Update shared access PATCH /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Remove shared access DELETE /v2/accounts/{accountId}/phone/users/{userId}/settings/{settingType}
Unassign phone number DELETE /v2/accounts/{accountId}/phone/users/{userId}/phone_numbers/{phoneNumberId}
Assign calling plan to a user POST /v2/accounts/{accountId}/phone/users/{userId}/calling_plans
Unassign user’s calling plan DELETE /v2/accounts/{accountId}/phone/users/{userId}/calling_plans/{type}
Get call recordings GET /phone/recordings
List BYOC SIP trunks GET /v2/accounts/{accountId}/phone/sip_trunk/trunks
Get phone number details GET /v2/accounts/{accountId}/phone/numbers/{numberId}
Update phone number details PATCH /v2/accounts/{accountId}/phone/numbers/{numberId}
Change main company number PUT /v2/accounts/{accountId}/phone/company_number
List calling plans GET /v2/accounts/{accountId}/phone/calling_plans
List phone users GET /v2/accounts/{accountId}/phone/users
Delete a voicemail DELETE /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}

Zoom Phone auto-receptionists APIs

API description Method Endpoint
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 phone number DELETE /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}
Add an auto receptionist POST /v2/accounts/{accountId}/phone/auto_receptionists

Zoom Phone blocked lists APIs

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

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}
Delete a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}
Assign numbers to a call queue POST /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers
Unassign all phone numbers from a call queue DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers
Unassign a phone number DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}
Add members to a call queue POST /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members
Unassign all members DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members
Unassign a member DELETE /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/members/{memberId}
Change call queue manager PUT /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/manager
Get call queue recordings GET /v2/accounts/{accountId}/phone/call_queues/{callQueueId}/recordings

Zoom Phone dashboard APIs

API description Method Endpoint
List call logs GET /v2/accounts/{accountId}/phone/call_logs
List call logs of a user GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs
List call logs’ metrics. GET /v2/accounts/{accountId}/phone/metrics/call_logs
Get call QoS GET /v2/accounts/{accountId}/phone/metrics/call_logs/{callId}/qos

Zoom Phone devices APIs

API description Method Endpoint
Add a device POST /v2/accounts/{accountId}/phone/devices
List devices GET /v2/accounts/{accountId}/phone/devices/{deviceId}
Update a device PATCH /v2/accounts/{accountId}/phone/devices/{deviceId}
Delete a device DELETE /v2/accounts/{accountId}/phone/devices/{deviceId}
Get device details GET /v2/accounts/{accountId}/phone/devices

Zoom Phone shared line groups APIs

API description Method Endpoint
Create a shared line group POST /v2/accounts/{accountId}/phone/shared_line_groups
List shared line groups GET /v2/accounts/{accountId}/phone/shared_line_groups
Get 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}
Delete a shared line group DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}
Add members to a shared line group POST /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/members
Unassign a member from a shared line group DELETE /v2/accounts/{accountId}/phone/shared_line_groups/{sharedLineGroupId}/members/{memberId}
Unassign 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}

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 site APIs

API description Method Endpoint
Create a phone site POST /v2/accounts/{accountId}/phone/sites
List phone sites GET /v2/accounts/{accountId}/phone/sites
Get site details GET /v2/accounts/{accountId}/phone/sites/{siteId}
Delete a phone site DELETE /v2/accounts/{accountId}/phone/sites/{siteId}
Update phone site details PATCH /v2/accounts/{accountId}/phone/sites/{siteId}