Get call handling settings

GET {{baseUrl}}/phone/extension/:extensionId/call_handling/settings

Returns information about a Zoom Phone's call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our API guide or Zoom support article Customizing call handling settings . Applicable to user, call queue, auto receptionist, or shared line group call handling at this time. Prerequisites: * Pro or a higher account with Zoom Phone enabled

Scopes: phone:read:admin

Granular Scopes: phone:read:list_call_handling_settings:admin

Rate Limit Label : LIGHT

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{"business_hours":[{"settings":{"allow_callers_check_voicemail":"\u003cboolean\u003e","allow_members_to_reset":"\u003cboolean\u003e","audio_while_connecting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"call_distribution":{"handle_multiple_calls":"\u003cboolean\u003e","ring_duration":10,"ring_mode":"rotating","skip_offline_device_phone_number":"\u003cboolean\u003e"},"call_forwarding_settings":[{"description":"\u003cstring\u003e","enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_contact":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","external_contact_id":"\u003cstring\u003e","phone_numbers":["\u003cstring\u003e"]}}],"call_not_answer_action":4,"connect_to_operator":"\u003cboolean\u003e","custom_hours_settings":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e","type":1,"weekday":6}],"greeting_prompt":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"max_call_in_queue":"\u003cinteger\u003e","max_wait_time":30,"music_on_hold":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"receive_call":"\u003cboolean\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","ring_mode":"simultaneous","routing":{"action":"\u003cinteger\u003e","forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"commonArea","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","description":"\u003cstring\u003e","voicemail_greeting":{}},"operator":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"user","id":"\u003cstring\u003e"},"connect_to_operator":"\u003cboolean\u003e","allow_callers_check_voicemail":"\u003cboolean\u003e","voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"require_press_1_before_connecting":"\u003cboolean\u003e","overflow_play_callee_voicemail_greeting":"\u003cboolean\u003e","play_callee_voicemail_greeting":"\u003cboolean\u003e","busy_play_callee_voicemail_greeting":"\u003cboolean\u003e"},"busy_routing":{"action":"\u003cinteger\u003e","forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"user","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","description":"\u003cstring\u003e","voicemail_greeting":{}},"operator":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"sharedLineGroup","id":"\u003cstring\u003e"},"connect_to_operator":"\u003cboolean\u003e","allow_callers_check_voicemail":"\u003cboolean\u003e","voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"require_press_1_before_connecting":"\u003cboolean\u003e","overflow_play_callee_voicemail_greeting":"\u003cboolean\u003e","play_callee_voicemail_greeting":"\u003cboolean\u003e","busy_play_callee_voicemail_greeting":"\u003cboolean\u003e"},"type":2,"wrap_up_time":30},"sub_setting_type":"call_forwarding"}],"closed_hours":[{"settings":{"allow_callers_check_voicemail":"\u003cboolean\u003e","call_forwarding_settings":[{"description":"\u003cstring\u003e","enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_contact":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","external_contact_id":"\u003cstring\u003e","phone_numbers":["\u003cstring\u003e"]}}],"call_not_answer_action":1,"connect_to_operator":"\u003cboolean\u003e","max_wait_time":15,"require_press_1_before_connecting":"\u003cboolean\u003e","ring_mode":"simultaneous","routing":{"action":"\u003cinteger\u003e","forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"callQueue","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","description":"\u003cstring\u003e","voicemail_greeting":{}},"operator":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"commonArea","id":"\u003cstring\u003e"},"connect_to_operator":"\u003cboolean\u003e","allow_callers_check_voicemail":"\u003cboolean\u003e","voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"require_press_1_before_connecting":"\u003cboolean\u003e","overflow_play_callee_voicemail_greeting":"\u003cboolean\u003e","play_callee_voicemail_greeting":"\u003cboolean\u003e","busy_play_callee_voicemail_greeting":"\u003cboolean\u003e"},"busy_routing":{"action":"\u003cinteger\u003e","forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"commonArea","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","description":"\u003cstring\u003e","voicemail_greeting":{}},"operator":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"commonArea","id":"\u003cstring\u003e"},"connect_to_operator":"\u003cboolean\u003e","allow_callers_check_voicemail":"\u003cboolean\u003e","voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"require_press_1_before_connecting":"\u003cboolean\u003e","overflow_play_callee_voicemail_greeting":"\u003cboolean\u003e","play_callee_voicemail_greeting":"\u003cboolean\u003e","busy_play_callee_voicemail_greeting":"\u003cboolean\u003e"}},"sub_setting_type":"call_handling"}],"holiday_hours":[{"details":[{"settings":{"allow_callers_check_voicemail":"\u003cboolean\u003e","call_forwarding_settings":[{"description":"\u003cstring\u003e","enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_contact":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","external_contact_id":"\u003cstring\u003e","phone_numbers":["\u003cstring\u003e"]}}],"call_not_answer_action":14,"connect_to_operator":"\u003cboolean\u003e","from":"\u003cdateTime\u003e","max_wait_time":35,"name":"\u003cstring\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","ring_mode":"simultaneous","routing":{"action":"\u003cinteger\u003e","forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"commonArea","id":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","description":"\u003cstring\u003e","voicemail_greeting":{}},"operator":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"sharedLineGroup","id":"\u003cstring\u003e"},"connect_to_operator":"\u003cboolean\u003e","allow_callers_check_voicemail":"\u003cboolean\u003e","voicemail_greeting":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"require_press_1_before_connecting":"\u003cboolean\u003e","overflow_play_callee_voicemail_greeting":"\u003cboolean\u003e","play_callee_voicemail_greeting":"\u003cboolean\u003e","busy_play_callee_voicemail_greeting":"\u003cboolean\u003e"},"to":"\u003cdateTime\u003e"},"sub_setting_type":"holiday"}],"holiday_id":"\u003cstring\u003e"}]}