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
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
Roles
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
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
Video SDK Events
Zoom Room Events
Deprecated API Endpoints

Account

API description Method Endpoint
Set up a Zoom Phone account POST /v2/accounts/{accountId}/phone/setup
Assign SIP trunks POST /v2/accounts/{accountId}/phone/sip_trunk/trunks
Update SIP trunk details PATCH /v2/accounts/{accountId}/phone/sip_trunk/trunks/{sipTrunkId}

Audio library

API description Method Endpoint
Add audio items POST /v2/accounts/{accountId}/phone/users/{userId}/audios/batch
List audio items GET /v2/accounts/{accountId}/phone/users/{userId}/audios
Update an audio item PATCH /v2/accounts/{accountId}/phone/audios/{audioId}
Delete an audio item DELETE /v2/accounts/{accountId}/phone/audios/{audioId}
Get an audio item GET /v2/accounts/{accountId}/phone/audios/{audioId}

Auto receptionists

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
List receptionists GET /v2/accounts/{accountId}/phone/auto_receptionists

Blocked lists

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}

Call logs

API description Method Endpoint
Get account’s call logs GET /v2/accounts/{accountId}/phone/call_logs
Get call log details GET /v2/accounts/{accountId}/phone/call_logs/{callLogId}
Get user’s call logs GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs
Delete a user’s call log GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs/{callLogId}
Add a client code to a call log PUT /v2/accounts/{accountId}/phone/call_logs/{callLogId}/client_code

Call queues

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

Carrier reseller

API description Method Endpoint
Create phone numbers POST /v2/accounts/{accountId}/phone/carrier_reseller/numbers
Activate phone numbers PATCH /v2/accounts/{accountId}/phone/carrier_reseller/numbers
Delete a phone number DELETE /v2/accounts/{accountId}/phone/carrier_reseller/numbers/{number}
List phone numbers GET /v2/accounts/{accountId}/phone/carrier_reseller/numbers

Common area phones

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}
Assign phone numbers to common area phone POST /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers
Unassign a phone number from a common area phone DELETE /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers/{phoneNumberId}
Assign calling plans to common area phone POST /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}/calling_plans
Unassign a calling plan from a common area phone DELETE /v2/accounts/{accountId}/phone/common_area_phones/{commonAreaPhoneId}/calling_plans/{type}

Dashboard

API description Method Endpoint
List call logs GET /v2/accounts/{accountId}/phone/metrics/call_logs
Get call details from call log GET /v2/accounts/{accountId}/phone/metrics/call_logs/{callId}
Get call QoS GET /v2/accounts/{accountId}/phone/metrics/call_logs/{callId}/qos

Devices

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
Sync deskphones POST /v2/accounts/{accountId}/phone/devices/sync

Directory backup routing rules

API description Method Endpoint
Add a directory backup routing rule POST /v2/accounts/{accountId}/phone/outing_rules
List directory backup routing rules GET /v2/accounts/{accountId}/phone/outing_rules
Update the directory backup routing rule PATCH /v2/accounts/{accountId}/phone/routing_rules/{routingRuleId}
Delete a directory backup routing rule DELETE /v2/accounts/{accountId}/phone/routing_rules/{routingRuleId}
Get a directory backup routing rule GET /v2/accounts/{accountId}/phone/routing_rules/{routingRuleId}

Emergency service locations

API description Method Endpoint
Batch add emergency service locations POST /v2/accounts/{accountId}/phone/batch_locations
List emergency service locations GET /v2/accounts/{accountId}/phone/locations
Add an emergency service location POST /v2/accounts/{accountId}/phone/locations
Delete an emergency location DELETE /v2/accounts/{accountId}/phone/locations/{locationId}
Get emergency service location details GET /v2/accounts/{accountId}/phone/locations/{locationId}
Update emergency service location PATCH /v2/accounts/{accountId}/phone/locations/{locationId}

External contacts

API description Method Endpoint
List external contacts GET /v2/accounts/{accountId}/phone/external_contacts
Add an external contact POST /v2/accounts/{accountId}/phone/external_contacts
Delete an external contact DELETE /v2/accounts/{accountId}/phone/external_contacts/{externalContactId}
Get external contact details GET /v2/accounts/{accountId}/phone/external_contacts/{externalContactId}
Update external contact PATCH /v2/accounts/{accountId}/phone/external_contacts/{externalContactId}

IVR

API description Method Endpoint
Get auto receptionist IVR GET /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/ivr
Update auto receptionist IVR PATCH /v2/accounts/{accountId}/phone/auto_receptionists/{autoReceptionistId}/ivr

Monitoring groups

API description Method Endpoint
Create a monitoring group POST /v2/accounts/{accountId}/phone/monitoring_groups
Get a list of monitoring groups on an account GET /v2/accounts/{accountId}/phone/monitoring_groups
Get monitoring group by ID GET /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}
Update a monitoring group PATCH /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}
Delete a monitoring group DELETE /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}
Get members of a monitoring group GET /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}/monitor_members
Add members to a monitoring group POST /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}/monitor_members
Remove all monitors or monitored members from a monitoring group DELETE /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}/monitor_members
Remove a member from a monitoring group DELETE /v2/accounts/{accountId}/phone/monitoring_groups/{monitoringGroupId}/monitor_members/{memberExtensionId}

Phone numbers

API description Method Endpoint
List phone numbers GET /v2/accounts/{accountId}/phone/numbers
Assign phone number to user POST /v2/accounts/{accountId}/phone/users/{userId}/phone_numbers
Unassign phone number DELETE /v2/accounts/{accountId}/phone/users/{userId}/phone_numbers/{phoneNumberId}
Get phone number details GET /v2/accounts/{accountId}/phone/numbers/{numberId}
Update phone number details PATCH /v2/accounts/{accountId}/phone/numbers/{numberId}

Provider Exchange

API description Method Endpoint
Add peering phone numbers POST /v2/accounts/{accountId}/phone/peering/numbers
Update peering phone numbers PATCH /v2/accounts/{accountId}/phone/peering/numbers
Remove peering phone numbers DELETE /v2/accounts/{accountId}/phone/peering/numbers
List peering phone numbers GET /v2/accounts/{accountId}/phone/peering/numbers

Recordings

API description Method Endpoint
Get call recordings GET /v2/accounts/{accountId}/phone/recordings
Get user’s recordings GET /v2/accounts/{accountId}/phone/users/{userId}/recordings
Get an account’s call recordings GET /v2/accounts/{accountId}/phone/call_logs/{id}/recordings
Download a recording transcript GET /v2/accounts/{accountId}/phone/recording_transcript/download/{recordingId}

Reports

API description Method Endpoint
Get operation log reports GET /v2/accounts/{accountId}/phone/reports/operationlogs

Setting templates

API description Method Endpoint
Add a setting template POST /v2/accounts/{accountId}/phone/setting_templates
List setting templates GET /v2/accounts/{accountId}/phone/setting_templates
Get setting template details GET /v2/accounts/{accountId}/phone/setting_templates/{templateId}
Update a setting template PATCH /v2/accounts/{accountId}/phone/setting_templates/{templateId}

Settings

API description Method Endpoint
Add BYOC phone numbers POST /v2/accounts/{accountId}/phone/byoc_numbers
List calling plans GET /v2/accounts/{accountId}/phone/calling_plans
Change main company number PUT /v2/accounts/{accountId}/phone/company_number
List ported numbers GET /v2/accounts/{accountId}/phone/ported_numbers/orders
Get ported number details GET /v2/accounts/{accountId}/phone/ported_numbers/orders/{orderId}
List BYOC SIP trunks GET /v2/accounts/{accountId}/phone/sip_trunk/trunks
List SIP groups GET /v2/accounts/{accountId}/phone/sip_groups
Get phone account settings GET /v2/accounts/{accountId}/phone/settings
Update phone account settings PATCH /v2/accounts/{accountId}/phone/settings

Shared access

API description Method Endpoint
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}

Shared line groups

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 all phone numbers DELETE /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}

Sites

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}

SMS

API description Method Endpoint
Get account’s SMS sessions GET /v2/accounts/{accountId}/phone/sms/sessions
Get SMS by message ID GET /v2/accounts/{accountId}/phone/sms/sessions/{sessionId}/messages/{messageId}
Get SMS session details GET /v2/accounts/{accountId}/phone/sms/sessions/{sessionId}
Get user’s SMS sessions GET /v2/accounts/{accountId}/phone/users/{userId}/sms/sessions

Users

API description Method Endpoint
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 user’s settings PATCH /v2/accounts/{accountId}/phone/users/{userId}/settings
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}

Voicemails

API description Method Endpoint
Get voicemails GET /v2/accounts/{accountId}/phone/voice_mails
Delete a voicemail DELETE /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}
Get user’s voicemails GET /v2/accounts/{accountId}/phone/users/{userId}/voice_mails
Get user voicemail details from a call log GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs/{id}/voice_mail
Get voicemail details GET /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}

Zoom Rooms

API description Method Endpoint
Assign phone numbers to a Zoom Room POST /v2/accounts/{accountId}/phone/rooms/{roomId}/phone_numbers
Assign calling plans to a Zoom Room POST /v2/accounts/{accountId}/phone/rooms/{roomId}/calling_plans
Remove a phone number from a Zoom Room DELETE /v2/accounts/{accountId}/phone/rooms/{roomId}/phone_numbers/{phoneNumberId}
Remove a calling plan from a Zoom Room DELETE /v2/accounts/{accountId}/phone/rooms/{roomId}/calling_plans/{type}
List Zoom Rooms under Zoom Phone license GET /v2/accounts/{accountId}/phone/rooms
Get a Zoom Room under Zoom Phone license GET /v2/accounts/{accountId}/phone/rooms/{roomId}
Update a Zoom Room under Zoom Phone license PATCH /v2/accounts/{accountId}/phone/rooms/{roomId}