Zoom Public API Documentation
Get auto receptionist IVR
GET {{baseUrl}}/phone/auto_receptionists/:autoReceptionistId/ivr?hours_type=business_hours&holiday_id=<string>
Gets an interactive voice response (IVR) system of the specified auto receptionist. Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:auto_receptionist_ivr:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
hours_type
|
string | The query hours type: `business_hours` or `closed_hours`, default `business_hours`. | |
holiday_id
|
string | The 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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"audio_prompt": {
"id": "<string>",
"name": "<string>"
},
"caller_enters_no_action": {
"action": "<integer>",
"audio_prompt_repeat": 3,
"forward_to": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<string>",
"id": "<string>"
}
},
"key_actions": [
{
"action": "<integer>",
"key": "<string>",
"target": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<string>",
"id": "<string>",
"phone_number": "<string>"
},
"voicemail_greeting": {
"id": "<string>",
"name": "<string>"
}
},
{
"action": "<integer>",
"key": "<string>",
"target": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<string>",
"id": "<string>",
"phone_number": "<string>"
},
"voicemail_greeting": {
"id": "<string>",
"name": "<string>"
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/ivr?hours_type=business_hours&holiday_id=<string>?hours_type=business_hours&holiday_id=<string>' -H 'Accept: application/json'
ENDPOINTS