Logo
Zoom Public API Documentation

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

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "business_hours": [ { "settings": { "allow_callers_check_voicemail": "<boolean>", "allow_members_to_reset": "<boolean>", "audio_while_connecting": { "id": "<string>", "name": "<string>" }, "call_distribution": { "handle_multiple_calls": "<boolean>", "ring_duration": 10, "ring_mode": "rotating", "skip_offline_device_phone_number": "<boolean>" }, "call_forwarding_settings": [ { "description": "<string>", "enable": "<boolean>", "id": "<string>", "phone_number": "<string>", "external_contact": { "name": "<string>", "email": "<string>", "external_contact_id": "<string>", "phone_numbers": [ "<string>" ] } } ], "call_not_answer_action": 4, "connect_to_operator": "<boolean>", "custom_hours_settings": [ { "from": "<string>", "to": "<string>", "type": 1, "weekday": 6 } ], "greeting_prompt": { "id": "<string>", "name": "<string>" }, "max_call_in_queue": "<integer>", "max_wait_time": 30, "music_on_hold": { "id": "<string>", "name": "<string>" }, "receive_call": "<boolean>", "require_press_1_before_connecting": "<boolean>", "ring_mode": "simultaneous", "routing": { "action": "<integer>", "forward_to": { "display_name": "<string>", "extension_id": "<string>", "extension_number": "<long>", "extension_type": "commonArea", "id": "<string>", "phone_number": "<string>", "description": "<string>", "voicemail_greeting": {} }, "operator": { "display_name": "<string>", "extension_id": "<string>", "extension_number": "<long>", "extension_type": "user", "id": "<string>" }, "connect_to_operator": "<boolean>", "allow_callers_check_voicemail": "<boolean>", &q
Curl
curl -X GET 'https://api.zoom.us/v2/phone/extension/:extensionId/call_handling/settings' -H 'Accept: application/json'

ENDPOINTS