Zoom Public API Documentation
Get a phone site setting
GET {{baseUrl}}/phone/sites/:siteId/settings/:settingType
Sites allow you to organize Zoom Phone users in your organization. Use this API to get site setting about a specific site according to the setting type. Prerequisites: Scope: Rate Limit Label:
phone:read:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"location_based_routing": {
"enable": false,
"place_receive_pstn_calls": false,
"enable_media_off_load_pstn_calls": false
},
"business_hours": {
"custom_hour_type": 2,
"custom_hours": [
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 1
},
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 1
}
],
"overflow": {
"allow_caller_to_reach_operator": true,
"operator": {
"extension_id": "FGAMaMWESMCNF0jmEU1emw",
"extension_number": 1000001018,
"display_name": "Test_callQueue",
"extension_type": "callQueue"
},
"allow_caller_to_check_voicemail": false
}
},
"closed_hours": {
"overflow": {
"allow_caller_to_reach_operator": true,
"operator": {
"extension_id": "FGAMaMWESMCNF0jmEU1emw",
"extension_number": 1000001018,
"display_name": "Test_callQueue",
"extension_type": "callQueue"
},
"allow_caller_to_check_voicemail": false
}
},
"holiday_hours": {
"holidays": [
{
"holiday_id": "i3gP6xFUTHqSFrIE6nHs7Q",
"name": "Holiday 1",
"from": "2022-03-08T16:00:00Z",
"to": "2022-03-09T16:00:00Z"
},
{
"holiday_id": "i3gP6xFUTHqSFrIE6nHs7Q",
"name": "Holiday 1",
"from": "2022-03-08T16:00:00Z",
"to": "2022-03-09T16:00:00Z"
}
],
"overflow": {
"allow_caller_to_reach_operator": true,
"operator": {
"extension_id": "FGAMaMWESMCNF0jmEU1emw",
"extension_number": 1000001018,
"display_name": "Test_callQueue",
"extension_type": "callQueue"
},
"allow_caller_to_check_voicemail": false
}
},
"security": {
"device_types": [
"Poly trioc60",
"Poly trioc60"
]
},
"outbound_caller_id": {
"auto_receptionists_numbers": false,
"call_queue_numbers": false,
"share_line_group_numbers": false,
"show_outbound_caller_id_for_internal_call": false
},
"audio_prompt": {
"language": "en-GB",
"greeting_leave_voicemail_instruction": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"greeting_menu_leave_or_check_voicemail": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"greeting_menu_connect_to_operator_or_leave_voicemail": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"greeting_menu_connect_to_operator_leave_or_check_voicemail": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"leave_voicemail_introduction": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"message_greeting": {
"business_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"closed_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"holiday_hours": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"audio_while_connecting": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
},
"hold_music": {
"id": "yCT14TwySDGVUypVlKNEyA",
"name": "hello.mp3"
}
},
"dial_by_name": {
"status": true,
"inherit": false,
"rule": "last_name"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType' -H 'Accept: application/json'
ENDPOINTS