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:
phone:read:admin
Granular Scopes:
phone:read:group_setting:admin
Rate Limit Label
:
LIGHT
Request Params
| 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":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e","transcription_start_prompt":{"enable":"\u003cboolean\u003e","audio_id":"\u003cstring\u003e","audio_name":"\u003cstring\u003e"}},"local_survivability_mode":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"select_outbound_caller_id":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","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":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_videomail":"\u003cboolean\u003e","allow_share":"\u003cboolean\u003e","allow_virtual_background":"\u003cboolean\u003e"},"voicemail_transcription":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","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":"account","modified":"\u003cboolean\u003e"},"restricted_call_hours":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e","time_zone":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"restricted_hours_applied":"\u003cboolean\u003e","restricted_holiday_hours_applied":"\u003cboolean\u003e","allow_internal_calls":"\u003cboolean\u003e"},"allowed_call_locations":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","locations_applied":"\u003cboolean\u003e","allow_internal_calls":"\u003cboolean\u003e"},"check_voicemails_over_phone":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"auto_call_recording":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","recording_calls":"inbound","recording_transcription":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_start_prompt_audio_id":"\u003cstring\u003e","recording_explicit_consent":"\u003cboolean\u003e","allow_stop_resume_recording":"\u003cboolean\u003e","disconnect_on_recording_failure":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":20,"play_beep_time_interval":15,"play_beep_member":"recordingSide"}},"ad_hoc_call_recording":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_delete":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_explicit_consent":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":40,"play_beep_time_interval":10,"play_beep_member":"allMember"}},"zoom_phone_on_mobile":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e","allow_calling_sms_mms":"\u003cboolean\u003e"},"zoom_phone_on_pwa":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"sms_etiquette_tool":{"enable":"\u003cboolean\u003e","modified":"\u003cboolean\u003e","sms_etiquette_policy":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","rule":1,"content":"\u003cstring\u003e","action":1,"active":"\u003cboolean\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","rule":2,"content":"\u003cstring\u003e","action":1,"active":"\u003cboolean\u003e"}]},"outbound_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e"},"outbound_sms":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"international_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"sms":{"enable":"\u003cboolean\u003e","international_sms":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"e2e_encryption":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"call_handling_forwarding":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e","call_forwarding_type":4},"call_overflow":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","call_overflow_type":1},"call_transferring":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","call_transferring_type":1},"elevate_to_meeting":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"call_park":{"enable":"\u003cboolean\u003e","expiration_period":45,"call_not_picked_up_action":"\u003cinteger\u003e","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":"invalid","modified":"\u003cboolean\u003e"},"hand_off_to_room":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"mobile_switch_to_carrier":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e"},"delegation":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","modified":"\u003cboolean\u003e"},"audio_intercom":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e"},"block_list_for_inbound_calls_and_messaging":{"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":"invalid","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":9},"peer_to_peer_media":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"advanced_encryption":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","disable_incoming_unencrypted_voicemail":"\u003cboolean\u003e"},"display_call_feedback_survey":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e","feedback_type":2,"feedback_mos":{"enable":"\u003cboolean\u003e","min":"\u003cstring\u003e","max":"\u003cstring\u003e"},"feedback_duration":{"enable":"\u003cboolean\u003e","min":"\u003cinteger\u003e","max":"\u003cinteger\u003e"}}}