List an account's zoom phone settings
GET {{baseUrl}}/phone/account_settings?setting_types=<string>
Returns an account's Zoom phone settings.
Prerequisites: * A Business or Enterprise account * A Zoom Phone license
Scopes: phone:read:admin
Granular Scopes: phone:read:list_account_settings:admin
Rate Limit Label: LIGHT
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
setting_types | string | The comma separated list of the setting items you want to fetch. Allowed values: call_live_transcription ,local_survivability_mode ,external_calling_on_zoom_room_common_area , 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 , auto_call_recording , ad_hoc_call_recording , international_calling , outbound_calling , outbound_sms , sms , sms_etiquette_tool , zoom_phone_on_mobile , zoom_phone_on_pwa , e2e_encryption , call_handling_forwarding_to_other_users , call_overflow , call_transferring , elevate_to_meeting , call_park , hand_off_to_room , mobile_switch_to_carrier , delegation , audio_intercom , block_calls_without_caller_id , block_external_calls ,call_queue_opt_out_reason ,auto_delete_data_after_retention_duration ,auto_call_from_third_party_apps , override_default_port ,peer_to_peer_media ,advanced_encryption ,display_call_feedback_survey ,block_list_for_inbound_calls_and_messaging ,block_calls_as_threat . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"call_live_transcription":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","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":"invalid"},"external_calling_on_zoom_room_common_area":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"select_outbound_caller_id":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","allow_hide_outbound_caller_id":"\u003cboolean\u003e"},"personal_audio_library":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","allow_music_on_hold_customization":"\u003cboolean\u003e","allow_voicemail_and_message_greeting_customization":"\u003cboolean\u003e"},"voicemail":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","allow_videomail":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_delete":"\u003cboolean\u003e","allow_share":"\u003cboolean\u003e","allow_virtual_background":"\u003cboolean\u003e"},"voicemail_transcription":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"voicemail_notification_by_email":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","include_voicemail_file":"\u003cboolean\u003e","include_voicemail_transcription":"\u003cboolean\u003e","forward_voicemail_to_email":"\u003cboolean\u003e"},"shared_voicemail_notification_by_email":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"restricted_call_hours":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","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":"invalid","locations_applied":"\u003cboolean\u003e","allow_internal_calls":"\u003cboolean\u003e"},"check_voicemails_over_phone":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"auto_call_recording":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","recording_calls":"both","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_member":"allMembers","play_beep_volume":80,"play_beep_time_interval":60}},"ad_hoc_call_recording":{"recording_transcription":false,"allow_download":true,"allow_delete":false,"recording_start_prompt":false,"recording_explicit_consent":false,"play_recording_beep_tone":{"enable":true,"play_beep_member":"allMembers","play_beep_volume":60,"play_beep_time_interval":120},"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"international_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"outbound_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"outbound_sms":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"sms":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","international_sms":"\u003cboolean\u003e"},"sms_etiquette_tool":{"sms_etiquette_policy":[{"id":"Lorem d","name":"proident non","description":"laborum","rule":2,"content":"cupidatat","action":1,"active":false},{"id":"et sed","name":"mollit occaecat veniam","description":"occaecat commodo","rule":2,"content":"Ut aliquip","action":2,"active":true}],"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"zoom_phone_on_mobile":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","allow_calling_sms_mms":"\u003cboolean\u003e"},"zoom_phone_on_pwa":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"e2e_encryption":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"call_handling_forwarding_to_other_users":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","call_forwarding_type":4},"call_overflow":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","call_overflow_type":2},"call_transferring":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid","call_transferring_type":4},"elevate_to_meeting":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"call_park":{"expiration_period":25,"call_not_picked_up_action":75981537,"forward_to":{"display_name":"nisi consectetur in magna non","extension_id":"cillum id","extension_number":55261343,"extension_type":"ciscoRoom/polycomRoom","id":"aute dolor irure"},"sequence":1,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"hand_off_to_room":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"mobile_switch_to_carrier":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"delegation":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"audio_intercom":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"block_calls_without_caller_id":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"block_external_calls":{"block_business_hours":true,"block_closed_hours":true,"block_holiday_hours":true,"block_call_action":9,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"call_queue_opt_out_reason":{"call_queue_opt_out_reasons_list":[{"code":"Excepteur Duis i","system":true,"enable":false},{"code":"consequat aliqua ut cillum","system":true,"enable":false}],"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"auto_delete_data_after_retention_duration":{"items":[{"type":"onDemandRecording","duration":-17949473,"time_unit":"day"},{"type":"callLog","duration":-30906276,"time_unit":"day"}],"delete_type":2,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"auto_call_from_third_party_apps":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"override_default_port":{"min_port":-41667702,"max_port":-95568124,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"peer_to_peer_media":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"advanced_encryption":{"disable_incoming_unencrypted_voicemail":false,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"display_call_feedback_survey":{"feedback_type":1,"feedback_mos":{"enable":false,"min":"nulla ullamco minim","max":"exercitation et consectetur"},"feedback_duration":{"enable":true,"min":-15324878,"max":-60299975},"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"invalid"},"block_list_for_inbound_calls_and_messaging":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"block_calls_as_threat":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"\u003cstring\u003e"}}