Zoom Public API Documentation
Get group phone settings
GET {{baseUrl}}/phone/groups/:groupId/settings?setting_types=<string>
Returns group phone settings. Prerequisites:
* Account must have a Pro or a higher plan with Zoom Phone license. Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:group_setting:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
setting_types
|
string | This setting corresponds to the setting item you want to modify. It is separated by a comma. Allowed values: `call_live_transcription`, `local_survivability_mode`, `select_outbound_caller_id`, `personal_audio_library`, `voicemail`, `voicemail_transcription`, `voicemail_notification_by_email`, `shared_voicemail_notification_by_email`, `restricted_call_hours`, `allowed_call_locations`, `check_voicemails_over_phone`, `connect_to_operator`, `auto_call_recording`, `ad_hoc_call_recording`, `outbound_calling`, `outbound_sms`, `international_calling`, `sms`, `zoom_phone_on_mobile`, `zoom_phone_on_pwa`, `sms_etiquette_tool`, `e2e_encryption`, `call_handling_forwarding`, `call_overflow`, `call_transferring`, `elevate_to_meeting`, `call_park`, `hand_off_to_room`, `mobile_switch_to_carrier`, `delegation`, `audio_intercom`, `block_list_for_inbound_calls_and_messaging`, `block_calls_without_caller_id`, `block_external_calls`, `peer_to_peer_media`, `advanced_encryption`, `display_call_feedback_survey`. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"call_live_transcription": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>",
"transcription_start_prompt": {
"enable": "<boolean>",
"audio_id": "<string>",
"audio_name": "<string>"
}
},
"local_survivability_mode": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"select_outbound_caller_id": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"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": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"allow_videomail": "<boolean>",
"allow_share": "<boolean>",
"allow_virtual_background": "<boolean>"
},
"voicemail_transcription": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"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": "account",
"modified": "<boolean>"
},
"restricted_call_hours": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>",
"time_zone": {
"id": "<string>",
"name": "<string>"
},
"restricted_hours_applied": "<boolean>",
"restricted_holiday_hours_applied": "<boolean>",
"allow_internal_calls": "<boolean>"
},
"allowed_call_locations": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"locations_applied": "<boolean>",
"allow_internal_calls": "<boolean>"
},
"check_voicemails_over_phone": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"auto_call_recording": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"recording_calls": "inbound",
"recording_transcription": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_start_prompt_audio_id": "<string>",
"recording_explicit_consent": "<boolean>",
"allow_stop_resume_recording": "<boolean>",
"disconnect_on_recording_failure": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 20,
"play_beep_time_interval": 15,
"play_beep_member": "recordingSide"
}
},
"ad_hoc_call_recording": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>",
"recording_transcription": "<boolean>",
"allow_download": "<boolean>",
"allow_delete": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_explicit_consent": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 40,
"play_beep_time_interval": 10,
"play_beep_member": "allMember"
}
},
"zoom_phone_on_mobile": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>",
"allow_calling_sms_mms": "<boolean>"
},
"zoom_phone_on_pwa": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"sms_etiquette_tool": {
"enable": "<boolean>",
"modified": "<boolean>",
"sms_etiquette_policy": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"rule": 1,
"content": "<string>",
"action": 1,
"active": "<boolean>"
},
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"rule": 2,
"content": "<string>",
"action": 1,
"active": "<boolean>"
}
]
},
"outbound_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>"
},
"outbound_sms": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"international_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"sms": {
"enable": "<boolean>",
"international_sms": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"e2e_encryption": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"call_handling_forwarding": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>",
"call_forwarding_type": 4
},
"call_overflow": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"call_overflow_type": 1
},
"call_transferring": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"call_transferring_type": 1
},
"elevate_to_meeting": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"call_park": {
"enable": "<boolean>",
"expiration_period": 45,
"call_not_picked_up_action": "<integer>",
"forward_to": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"extension_type": "user",
"id": "<string>"
},
"sequence": 0,
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"hand_off_to_room": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"mobile_switch_to_carrier": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>"
},
"delegation": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"modified": "<boolean>"
},
"audio_intercom": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>"
},
"block_list_for_inbound_calls_and_messaging": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"block_calls_without_caller_id": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "invalid",
"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": 9
},
"peer_to_peer_media": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"advanced_encryption": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"disable_incoming_unencrypted_voicemail": "<boolean>"
},
"display_call_feedback_survey": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>",
"feedback_type": 2,
"feedback_mos": {
"enable": "<boolean>",
"min": "<string>",
"max": "<string>"
},
"feedback_duration": {
"enable": "<boolean>",
"min": "<integer>",
"max": "<integer>"
}
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/groups/:groupId/settings?setting_types=<string>?setting_types=<string>' -H 'Accept: application/json'
ENDPOINTS