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: phone:read:admin
Granular Scopes: phone:read:auto_receptionist_ivr:admin
Rate Limit Label: Light
Request Params
| 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":"\u003cstring\u003e","name":"\u003cstring\u003e"},"caller_enters_no_action":{"action":"\u003cinteger\u003e","audio_prompt_repeat":3,"forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","id":"\u003cstring\u003e"}},"key_actions":[{"action":"\u003cinteger\u003e","key":"\u003cstring\u003e","target":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e"},"voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"action":"\u003cinteger\u003e","key":"\u003cstring\u003e","target":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e"},"voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}]}