Zoom Public API Documentation
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:
* Account must have a Pro or a higher plan with Zoom Phone license.
* Multiple sites must be enabled. Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:site:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"country": {
"code": "<string>",
"name": "<string>"
},
"id": "<string>",
"main_auto_receptionist": {
"extension_id": "<string>",
"extension_number": "<long>",
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"short_extension": {
"length": 3
},
"site_code": "<integer>",
"policy": {
"select_outbound_caller_id": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>",
"allow_hide_outbound_caller_id": "<boolean>"
},
"personal_audio_library": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>",
"allow_music_on_hold_customization": "<boolean>",
"allow_voicemail_and_message_greeting_customization": "<boolean>"
},
"voicemail": {
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"allow_videomail": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"voicemail_transcription": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"voicemail_notification_by_email": {
"include_voicemail_file": "<boolean>",
"include_voicemail_transcription": "<boolean>",
"forward_voicemail_to_email": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"shared_voicemail_notification_by_email": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"international_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"zoom_phone_on_mobile": {
"allow_calling_sms_mms": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"sms": {
"enable": "<boolean>",
"international_sms": "<boolean>",
"international_sms_countries": [
"<string>",
"<string>"
],
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"elevate_to_meeting": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"hand_off_to_room": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"mobile_switch_to_carrier": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"delegation": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"ad_hoc_call_recording": {
"enable": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 0,
"play_beep_time_interval": 25,
"play_beep_member": "allMember"
},
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"auto_call_recording": {
"allow_stop_resume_recording": "<boolean>",
"disconnect_on_recording_failure": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>",
"recording_calls": "outbound",
"recording_explicit_consent": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 0,
"play_beep_time_interval": 15,
"play_beep_member": "recordingSide"
}
},
"call_handling_forwarding_to_other_users": {
"enable": "<boolean>",
"call_forwarding_type": 4,
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"check_voicemails_over_phone": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"call_queue_pickup_code": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"call_queue_opt_out_reason": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>",
"call_queue_opt_out_reasons_list": [
{
"code": "<string>",
"system": "<boolean>",
"enable": "<boolean>"
},
{
"code": "<string>",
"system": "<boolean>",
"enable": "<boolean>"
}
]
},
"show_user_last_transferred_call": "<boolean>",
"auto_delete_data_after_retention_duration": {
"enable": "<boolean>",
"reset": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"items": [
{
"type": "sms",
"duration": "<integer>",
"time_unit": "day"
},
{
"type": "callLog",
"duration": "<integer>",
"time_unit": "day"
}
],
"delete_type": 2
},
"call_park": {
"call_not_picked_up_action": "<integer>",
"enable": "<boolean>",
"expiration_period": 3,
"forward_to": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"extension_type": "user",
"id": "<string>"
},
"sequence": 0,
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"call_overflow": {
"call_overflow_type": 3,
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"call_transferring": {
"call_transferring_type": 2,
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"audio_intercom": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"block_calls_without_caller_id": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"block_external_calls": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>",
"block_business_hours": "<boolean>",
"block_closed_hours": "<boolean>",
"block_holiday_hours": "<boolean>",
"block_call_action": 0,
"block_call_change_type": 1,
"e2e_encryption": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
}
},
"force_off_net": {
"enable": "<boolean>",
"allow_extension_only_users_call_users_outside_site": "<boolean>"
}
},
"sip_zone": {
"id": "<string>",
"name": "<string>"
},
"caller_id_name": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId' -H 'Accept: application/json'
ENDPOINTS