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: Scopes: Granular Scopes: Rate Limit Label:
phone:read:adminphone:read:site_setting:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"location_based_routing": {
"enable": "<boolean>",
"place_receive_pstn_calls": "<boolean>",
"enable_media_off_load_pstn_calls": "<boolean>"
},
"business_hours": {
"custom_hour_type": 2,
"custom_hours": [
{
"from": "<string>",
"to": "<string>",
"type": 1,
"weekday": 2
},
{
"from": "<string>",
"to": "<string>",
"type": 0,
"weekday": 4
}
],
"overflow": {
"allow_caller_to_reach_operator": "<boolean>",
"operator": {
"extension_id": "<string>",
"extension_number": "<long>",
"display_name": "<string>",
"extension_type": "sharedLineGroup"
},
"allow_caller_to_check_voicemail": "<boolean>"
}
},
"closed_hours": {
"overflow": {
"allow_caller_to_reach_operator": "<boolean>",
"operator": {
"extension_id": "<string>",
"extension_number": "<long>",
"display_name": "<string>",
"extension_type": "zoomRoom"
},
"allow_caller_to_check_voicemail": "<boolean>"
}
},
"holiday_hours": {
"holidays": [
{
"holiday_id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
},
{
"holiday_id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
}
],
"overflow": {
"allow_caller_to_reach_operator": "<boolean>",
"operator": {
"extension_id": "<string>",
"extension_number": "<long>",
"display_name": "<string>",
"extension_type": "commonArea"
},
"allow_caller_to_check_voicemail": "<boolean>"
}
},
"security": {
"device_types": [
"<string>",
"<string>"
]
},
"outbound_caller_id": {
"auto_receptionists_numbers": "<boolean>",
"call_queue_numbers": "<boolean>",
"share_line_group_numbers": "<boolean>",
"show_outbound_caller_id_for_internal_call": "<boolean>"
},
"audio_prompt": {
"language": "<string>",
"greeting_leave_voicemail_instruction": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"greeting_menu_leave_or_check_voicemail": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"greeting_menu_connect_to_operator_or_leave_voicemail": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"greeting_menu_connect_to_operator_leave_or_check_voicemail": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"leave_voicemail_introduction": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"message_greeting": {
"business_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"closed_hours": {
"audio_id": "<string>",
"name": "<string>"
},
"holiday_hours": {
"audio_id": "<string>",
"name": "<string>"
}
},
"audio_while_connecting": {
"audio_id": "<string>",
"name": "<string>"
},
"hold_music": {
"audio_id": "<string>",
"name": "<string>"
}
},
"desk_phone": {
"hot_desking_session_timeout": {
"number": 3,
"unit": "hours"
}
},
"dial_by_name": {
"status": "<boolean>",
"inherit": "<boolean>",
"rule": "first_name"
},
"billing_account": {
"id": "<string>",
"name": "<string>"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType' -H 'Accept: application/json'
ENDPOINTS