Logo
Zoom Public API Documentation

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: * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be enabled.

Scope: phone:read:admin

Rate Limit Label: Light

 

Body PARAM

Key Datatype Required Description 



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
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId' -H 'Accept: application/json'

ENDPOINTS