Zoom Public API Documentation
Get auto receptionist IVR
GET {{baseUrl}}/phone/auto_receptionists/:autoReceptionistId/ivr?hours_type=business_hours&holiday_id=YpLBylKbQKe1vEB1iSGatQ
Use this API to get an interactive voice response (IVR) system of the specified auto receptionist. Scopes: Prerequisites:
* A Business or Enterprise account
* A Zoom Phone licensephone:read:admin
Rate Limit Label: Light
Body
PARAM
| Key | Datatype | Required | Description |
hours_type
|
string | Query hours type, `business_hours` or `closed_hours`, default `business_hours`. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"audio_prompt": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "example.mp3"
},
"caller_enters_no_action": {
"action": 15,
"audio_prompt_repeat": 3,
"forward_to": {
"display_name": "ZOOM_API Test",
"extension_id": "z97zV9NsSoa846i-ag3uEw",
"extension_number": "exercitation esse mollit ut Lorem",
"id": "EVqEKnrMRWyPr705Fk5h2w"
}
},
"key_actions": [
{
"action": 200,
"key": "0",
"target": {
"display_name": "ZOOM_API Test",
"extension_id": "TO586CYlQFC_WCUvPRXytA",
"extension_number": "101002",
"id": "oG_nYRFuTJiY1tu0Fur_4Q",
"phone_number": "+12055437350"
},
"voicemail_greeting": {
"id": "j2IsurWLRR-yWcbNGqPnaA",
"name": "custom.wav"
}
},
{
"action": 200,
"key": "0",
"target": {
"display_name": "ZOOM_API Test",
"extension_id": "TO586CYlQFC_WCUvPRXytA",
"extension_number": "101002",
"id": "oG_nYRFuTJiY1tu0Fur_4Q",
"phone_number": "+12055437350"
},
"voicemail_greeting": {
"id": "j2IsurWLRR-yWcbNGqPnaA",
"name": "custom.wav"
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/ivr?hours_type=business_hours&holiday_id=YpLBylKbQKe1vEB1iSGatQ?hours_type=business_hours&holiday_id=YpLBylKbQKe1vEB1iSGatQ' -H 'Accept: application/json'
ENDPOINTS