Get phone site details
GET {{baseUrl}}/phone/sites/:siteId
Sites allow you to organize Zoom Phone users in your organization. Use this API to get information on a specific site .
Prerequisites:
enabled .
Scope:
phone:read:admin
Rate Limit Label
:
Light
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"country":{"code":"US","name":"United States"},"id":"SQv52YtkRLC2dwrDdYtGsA","main_auto_receptionist":{"extension_id":"pl1XprjhTQK1CCMVKTqCFA","extension_number":12345,"id":"Kbdc9lv_SBCuPMjj_lhxVA","name":"ApiTA_R_2020_07_12_00_41_57_145"},"name":"ApiTA_Site_2020_07_12_00_41_57_141","short_extension":{"length":3},"site_code":321,"policy":{"select_outbound_caller_id":{"enable":true,"locked":true,"locked_by":"site","modified":true},"personal_audio_library":{"enable":true,"locked":true,"locked_by":"site","modified":true,"allow_music_on_hold_customization":true,"allow_voicemail_and_message_greeting_customization":true},"voicemail":{"allow_delete":true,"allow_download":false,"allow_videomail":true,"enable":true,"locked":true,"locked_by":"site","modified":true},"voicemail_transcription":{"enable":true,"locked":true,"locked_by":"site","modified":true},"voicemail_notification_by_email":{"include_voicemail_file":true,"include_voicemail_transcription":false,"forward_voicemail_to_email":true,"enable":true,"locked":true,"locked_by":"site","modified":true},"shared_voicemail_notification_by_email":{"enable":true,"locked":true,"locked_by":"site","modified":true},"international_calling":{"enable":true,"locked":true,"locked_by":"site","modified":true},"zoom_phone_on_mobile":{"allow_calling_sms_mms":true,"enable":true,"locked":true,"locked_by":"site","modified":true},"sms":{"enable":true,"international_sms":true,"international_sms_countries":["US","US"],"locked":true,"locked_by":"site","modified":true},"elevate_to_meeting":{"enable":true,"locked":true,"locked_by":"site","modified":true},"hand_off_to_room":{"enable":true,"locked":true,"locked_by":"site","modified":true},"mobile_switch_to_carrier":{"enable":true,"locked":true,"locked_by":"site","modified":true},"delegation":{"enable":true,"locked":true,"locked_by":"site","modified":true},"ad_hoc_call_recording":{"enable":true,"recording_start_prompt":false,"recording_transcription":true,"locked":true,"locked_by":"account","modified":true},"auto_call_recording":{"allow_stop_resume_recording":true,"disconnect_on_recording_failure":true,"enable":true,"locked":true,"locked_by":"account","modified":true,"recording_calls":"inbound","recording_explicit_consent":true,"recording_start_prompt":true,"recording_transcription":true,"play_side_tone_beep":true,"play_side_tone_beep_volume":0,"play_beep_time_interval":null},"call_handling_forwarding_to_other_users":{"enable":true,"call_forwarding_type":1,"locked":true,"locked_by":"site","modified":true},"check_voicemails_over_phone":{"enable":true,"locked":true,"locked_by":"site","modified":true},"call_queue_pickup_code":{"enable":true,"locked":true,"locked_by":"site","modified":true},"call_queue_opt_out_reason":{"enable":true,"locked":true,"locked_by":"site","modified":true,"call_queue_opt_out_reasons_list":[{"code":"Break","system":true,"enable":true},{"code":"Break","system":true,"enable":true}]},"show_user_last_transferred_call":true,"auto_delete_data_after_retention_duration":{"enable":true,"reset":true,"locked":false,"locked_by":"site","items":[{"type":"callLog","duration":-1,"time_unit":"year"},{"type":"callLog","duration":-1,"time_unit":"year"}],"delete_type":1},"call_park":{"call_not_picked_up_action":50,"enable":true,"expiration_period":3,"forward_to":{"display_name":"ZOOM_API Test","extension_id":"TO586CYlQFC_WCUvPRXytA","extension_number":100014,"extension_type":"user","id":"oG_nYRFuTJiY1tu0Fur_4Q"},"sequence":1,"locked":false,"locked_by":"site","modified":true},"call_overflow":{"call_overflow_type":1,"enable":true,"locked":true,"locked_by":"site","modified":true},"call_transferring":{"call_transferring_type":1,"enable":true,"locked":true,"locked_by":"site","modified":true},"audio_intercom":{"enable":true,"locked":true,"locked_by":"site","modified":true},"block_calls_without_caller_id":{"enable":true,"locked":true,"locked_by":"site","modified":true},"block_external_calls":{"enable":true,"locked":true,"locked_by":"site","modified":true,"block_business_hours":true,"block_closed_hours":true,"block_holiday_hours":true,"block_call_action":0,"block_call_change_type":0}}}