Get phone site details
GET {{baseUrl}}/phone/sites/:siteId
Returns information on a specific site . Sites allow you to organize Zoom Phone users in your organization.
Prerequisites:
enabled .
Scopes:
phone:read:admin
Granular Scopes:
phone:read:site:admin
Rate Limit Label
:
LIGHT
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"country":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"id":"\u003cstring\u003e","main_auto_receptionist":{"extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"name":"\u003cstring\u003e","short_extension":{"length":3},"site_code":"\u003cinteger\u003e","policy":{"select_outbound_caller_id":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e","allow_hide_outbound_caller_id":"\u003cboolean\u003e"},"personal_audio_library":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e","allow_music_on_hold_customization":"\u003cboolean\u003e","allow_voicemail_and_message_greeting_customization":"\u003cboolean\u003e"},"voicemail":{"allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_videomail":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"voicemail_transcription":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"voicemail_notification_by_email":{"include_voicemail_file":"\u003cboolean\u003e","include_voicemail_transcription":"\u003cboolean\u003e","forward_voicemail_to_email":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"shared_voicemail_notification_by_email":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"international_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"zoom_phone_on_mobile":{"allow_calling_sms_mms":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"sms":{"enable":"\u003cboolean\u003e","international_sms":"\u003cboolean\u003e","international_sms_countries":["\u003cstring\u003e","\u003cstring\u003e"],"locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"elevate_to_meeting":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"hand_off_to_room":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"mobile_switch_to_carrier":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"delegation":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"ad_hoc_call_recording":{"enable":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":0,"play_beep_time_interval":25,"play_beep_member":"allMember"},"locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"auto_call_recording":{"allow_stop_resume_recording":"\u003cboolean\u003e","disconnect_on_recording_failure":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e","recording_calls":"outbound","recording_explicit_consent":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":0,"play_beep_time_interval":15,"play_beep_member":"recordingSide"}},"call_handling_forwarding_to_other_users":{"enable":"\u003cboolean\u003e","call_forwarding_type":4,"locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"check_voicemails_over_phone":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"call_queue_pickup_code":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"call_queue_opt_out_reason":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e","call_queue_opt_out_reasons_list":[{"code":"\u003cstring\u003e","system":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},{"code":"\u003cstring\u003e","system":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"}]},"show_user_last_transferred_call":"\u003cboolean\u003e","auto_delete_data_after_retention_duration":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","items":[{"type":"sms","duration":"\u003cinteger\u003e","time_unit":"day"},{"type":"callLog","duration":"\u003cinteger\u003e","time_unit":"day"}],"delete_type":2},"call_park":{"call_not_picked_up_action":"\u003cinteger\u003e","enable":"\u003cboolean\u003e","expiration_period":3,"forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"user","id":"\u003cstring\u003e"},"sequence":0,"locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"call_overflow":{"call_overflow_type":3,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"call_transferring":{"call_transferring_type":2,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"audio_intercom":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"block_calls_without_caller_id":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"block_external_calls":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e","block_business_hours":"\u003cboolean\u003e","block_closed_hours":"\u003cboolean\u003e","block_holiday_hours":"\u003cboolean\u003e","block_call_action":0,"block_call_change_type":1,"e2e_encryption":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"}},"force_off_net":{"enable":"\u003cboolean\u003e","allow_extension_only_users_call_users_outside_site":"\u003cboolean\u003e"}},"sip_zone":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"caller_id_name":"\u003cstring\u003e"}