Get call handling settings

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

Use this API to get information about a Zoom Phone's call handling settings. For more information, read our Customizing call handling settings documentation.

Applicable to user, call queue, or auto receptionist call handling at this time.

Scopes: phone:read:admin
Rate Limit Label : Light

Prerequisites:

• Pro or a higher account with Zoom Phone enabled

HEADERS

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

RESPONSES

status: OK

{"business_hours":[{"settings":{"allow_callers_check_voicemail":true,"allow_members_to_reset":true,"audio_while_connecting":{"id":"qPwtDrrcSua8O0_n0bDRDg","name":"Default"},"call_distribution":{"handle_multiple_calls":true,"ring_duration":10,"ring_mode":"simultaneous","skip_offline_device_phone_number":true},"call_forwarding_settings":[{"description":"testNumber","enable":true,"id":"qPvrfrrcrf843cdfvbDRDg","phone_number":"+12058945565"},{"description":"testNumber","enable":true,"id":"qPvrfrrcrf843cdfvbDRDg","phone_number":"+12058945565"}],"call_not_answer_action":2,"connect_to_operator":true,"custom_hours_settings":[{"from":"09:00","to":"18:00","type":1,"weekday":5},{"from":"09:00","to":"18:00","type":1,"weekday":5}],"greeting_prompt":{"id":"0","name":"test"},"max_call_in_queue":5,"max_wait_time":30,"music_on_hold":{"id":"fdsij3he89qj2-23uie","name":"Default"},"receive_call":true,"require_press_1_before_connecting":true,"ring_mode":"simultaneous","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"type":1,"wrap_up_time":30},"sub_setting_type":"call_forwarding"},{"settings":{"allow_callers_check_voicemail":true,"allow_members_to_reset":true,"audio_while_connecting":{"id":"qPwtDrrcSua8O0_n0bDRDg","name":"Default"},"call_distribution":{"handle_multiple_calls":true,"ring_duration":10,"ring_mode":"simultaneous","skip_offline_device_phone_number":true},"call_forwarding_settings":[{"description":"testNumber","enable":true,"id":"qPvrfrrcrf843cdfvbDRDg","phone_number":"+12058945565"},{"description":"testNumber","enable":true,"id":"qPvrfrrcrf843cdfvbDRDg","phone_number":"+12058945565"}],"call_not_answer_action":2,"connect_to_operator":true,"custom_hours_settings":[{"from":"09:00","to":"18:00","type":1,"weekday":5},{"from":"09:00","to":"18:00","type":1,"weekday":5}],"greeting_prompt":{"id":"0","name":"test"},"max_call_in_queue":5,"max_wait_time":30,"music_on_hold":{"id":"fdsij3he89qj2-23uie","name":"Default"},"receive_call":true,"require_press_1_before_connecting":true,"ring_mode":"simultaneous","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"type":1,"wrap_up_time":30},"sub_setting_type":"call_forwarding"}],"closed_hours":[{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"sd8683_fwh39_F3hfsd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"sd8683_fwh39_F3hfsd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":true,"max_wait_time":null,"require_press_1_before_connecting":true,"ring_mode":"simultaneous","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}}},"sub_setting_type":"call_forwarding"},{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"sd8683_fwh39_F3hfsd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"sd8683_fwh39_F3hfsd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":true,"max_wait_time":30,"require_press_1_before_connecting":true,"ring_mode":"simultaneous","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}}},"sub_setting_type":"call_forwarding"}],"holiday_hours":[{"details":[{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":false,"from":"2022-05-01T00:00:00Z","max_wait_time":null,"name":"Labor Day","require_press_1_before_connecting":true,"ring_mode":"sequential","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"to":"2022-05-05T00:00:00Z"},"sub_setting_type":"call_forwarding"},{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":false,"from":"2022-05-01T00:00:00Z","max_wait_time":60,"name":"Labor Day","require_press_1_before_connecting":true,"ring_mode":"sequential","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"to":"2022-05-05T00:00:00Z"},"sub_setting_type":"call_forwarding"}],"holiday_id":"ewhu3i9-f3f3-fiohed"},{"details":[{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":false,"from":"2022-05-01T00:00:00Z","max_wait_time":60,"name":"Labor Day","require_press_1_before_connecting":true,"ring_mode":"sequential","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"to":"2022-05-05T00:00:00Z"},"sub_setting_type":"call_forwarding"},{"settings":{"allow_callers_check_voicemail":true,"call_forwarding_settings":[{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"},{"description":"testDescription","enable":false,"id":"dash32943QWfjiofejd","phone_number":"+12058945583"}],"call_not_answer_action":2,"connect_to_operator":false,"from":"2022-05-01T00:00:00Z","max_wait_time":60,"name":"Labor Day","require_press_1_before_connecting":true,"ring_mode":"sequential","routing":{"forward_to":{"display_name":"api_ta_test","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w","phone_number":"18889843519","voicemail_greeting":{}},"operator":{"display_name":"user A","extension_id":"jN9mb38lQTaMgxUq3Nd6ow","extension_number":101014,"extension_type":"user","id":"DYHrdpjrS3uaOf7dPkkg8w"}},"to":"2022-05-05T00:00:00Z"},"sub_setting_type":"call_forwarding"}],"holiday_id":"ewhu3i9-f3f3-fiohed"}]}