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
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
patch

/phone/auto_receptionists/{autoReceptionistId}/ivr

Use this API to update the interactive voice response (IVR) system of the specified auto receptionist.

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

Prerequisites:

  • A Business or Enterprise account
  • A Zoom Phone license

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
holiday_id
string

Auto receptionist holiday hours ID. If both holiday_id and hours_type are passed, holiday_id has a high priority and hours_type is invalid.

hours_type
string

Hours type. business_hours (default) or closed_hours.

audio_prompt_id
string

Audio prompt file ID.

key_action
object
caller_enters_no_action
object

The action if caller enters no action after the prompt played.

Responses

HTTP Status Code: 204 No Content
Auto Receptionist IVR updated.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
autoReceptionistId
$$.env
1 variable not set
oauth_access_token