# Customize the Call Handling API
The [Call Handling](/docs/api/phone/#tag/call-handling) API supports call handling settings for [users](#users), [auto receptionists](#auto-receptionists), and [call queues](#call-queues).
This guide provides information to help you customize the call handling settings in your Zoom Phone account.
## Users
Call handling settings for users.
- [Get call handling settings](#get-call-handling-settings)
- [Add a call handling setting](#add-a-call-handling-setting)
- [Holiday subsetting](#holiday-subsetting)
- [Call forwarding subsetting](#call_forwarding-subsetting)
- [Update a call handling setting](#update-a-call-handling-setting)
- [Custom hours subsetting](#custom_hours-subsetting)
- [Call forwarding subsetting](#call_forwarding-subsetting-1)
- [Call handling subsetting](#call_handling-subsetting)
- [Holiday subsetting](#holiday-subsetting-1)
### Add a call handling setting
**User**
[POST /phone/extension/\{extensionId}/call_handling/settings/\{settingType}](/docs/api/phone/#tag/call-handling/POST/phone/extension/{extensionId}/call_handling/settings/{settingType})
### `holiday` subsetting
**User**
Manages the _holiday list_ and _call handling_ settings where the `name` is the holiday name.
### Allowed fields
**User**
- `name`
- `from`
- `to`
### Sample code
```json
{
"settings": {
"from": "2021-11-06T01:33:47Z",
"name": "holiday_2021_11_05_01_33_47_972",
"to": "2021-11-07T01:33:47Z"
},
"sub_setting_type": "holiday"
}
```
### `call_forwarding` subsetting
User call handling manages:
- Call handling for business hours / closed hours / holiday hours.
- Add phone number
- External number
**Note**: The `phone_number` must be in E.164 format with the country code.
### Allowed fields
**User**
- `phone_number`
- `description`
### Sample code
**User**
```json
{
"settings": {
"description": "callforwarding_2021_11_05_01_33_31_209",
"phone_number": "+8615812345678"
},
"sub_setting_type": "call_forwarding"
}
```
### Update a call handling setting
**User**
[PATCH /phone/extension/\{extensionId}/call_handling/settings/\{settingType}](/docs/api/phone/#tag/call-handling/PATCH/phone/extension/{extensionId}/call_handling/settings/{settingType})
### `custom_hours` subsetting
**User**
- Business hours
- 24 hours a day, 7 days a week
- Custom hours
- `type`
- `1` — 24 hours a day, 7 days a week
- `custom_hours_settings.type`
- `0` — Exclude this day from business hours
- `1` — 24 hours
- `2` — Customized hours
### Allowed fields
**User**
- `type`
- `custom_hours_settings`
- `weekday`
- `type`
- `from`
- `to`
### Sample
**User**
- 24 hours
```json
{
"settings": {
"type": 1
},
"sub_setting_type": "custom_hours"
}
```
- Custom hours
```json
{
"settings": {
"custom_hours_settings": [
{
"type": 0,
"weekday": 1
},
{
"type": 1,
"weekday": 2
},
{
"from": "09:00",
"to": "18:00",
"type": 2,
"weekday": 3
},
{
"from": "09:30",
"to": "18:30",
"type": 2,
"weekday": 4
},
{
"from": "09:46",
"to": "18:46",
"type": 2,
"weekday": 5
},
{
"type": 0,
"weekday": 6
},
{
"type": 1,
"weekday": 7
}
],
"type": 2
},
"sub_setting_type": "custom_hours"
}
```
### `call_forwarding` subsetting
**User**
- Call handling for business hours / closed hours / holiday hours
- `call_forwarding_settings.id`
The `call_forwarding_id` identifies the external number to edit
- `require_press_1_before_connecting`
The equivalent to _Require to press 1 before connecting the call_ in the web portal
### Allowed fields
**User**
- `require_press_1_before_connecting`
- `call_forwarding_settings`
- `id`
- `phone_number`
- `description`
- `enable`
### Sample code
**User**
```json
{
"settings": {
"call_forwarding_settings": [
{
"description": "callforwarding_2021_11_05_07_27_25_944",
"enable": false,
"id": "BnPmv_BOQDOC3jRHQkxz_g",
"phone_number": "+8615812345678"
}
],
"require_press_1_before_connecting": true
},
"sub_setting_type": "call_forwarding"
}
```
### `call_handling` subsetting
User call handling for business hours / closed hours / holiday hours.
Web portal
| Field |
Action |
| `ring_mode` |
_Call handling ring mode_ |
| `call_not_answer_action` |
_When a call is not answered_ |
| `forward_to_extension_id` |
- _Forward to another extension_ - Forward to user, Zoom Room,
common area, auto receptionist, call queue, shared line group -
_Forward to external contacts_ (target)
|
| `connect_to_operator` `operator_extension_id` |
_Forward to voicemail_ or _videomail_ `connect_to_operator`
_Allow callers to reach an operator_ `operator_extension_id`
_Connect to operator_ User, Zoom Rooms, common area, auto
receptionist, call queue, and shared line group
|
### Allowed fields
**User**
- `holiday_id`
- `ring_mode`
- `max_wait_time`
- `call_not_answer_action`
- `forward_to_extension_id`
- `connect_to_operator`
- `operator_extension_id`
### Sample code
**User**
```json
{
"settings": {
"call_not_answer_action": 1,
"connect_to_operator": true,
"forward_to_extension_id": "MHNcW4CrS-6muS_IgziYxg",
"holiday_id": "iy8wmtnvSkuP0HIYBnLfUA",
"max_wait_time": 45,
"operator_extension_id": "DgKe5UPTTlODBvcgmRIlPw",
"ring_mode": "simultaneous"
},
"sub_setting_type": "call_handling"
}
```
### `holiday` subsetting
**User**
Equivalent to managing the _holiday list_ and _call handling_ settings under _holiday hours_ in the web portal.
### Allowed fields
**User**
- `holiday_id`
- `name`
- `from`
- `to`
### Sample code
**User**
```json
{
"sub_setting_type": "holiday",
"settings": {
"holiday_id": "N-FEFnBBRRShJRwuxrvMSA",
"name": "holiday_2021_11_05_01_16_49_299",
"from": "2021-11-06T01:26:49Z",
"to": "2021-11-07T01:26:49Z"
}
}
```
---
### Get call handling settings
**User**
[GET /phone/extension/\{extensionId}/call_handling/settings](/docs/api/phone/#tag/call-handling/GET/phone/extension/{extensionId}/call_handling/settings)
Web portal
| Field |
Action |
|
`routing.action`
|
_When a call is not answered_
|
|
`forward_to`
|
- _Forward to another extension_
- _Forward to_ user, Zoom Rooms, common area, auto receptionist, call queue, shared line group
- _Forward to external contacts_ (target)
|
|
- `connect_to_operator`
- `operator`
|
_Forward to voicemail or videomail_
- `connect_to_operator` — _Allow callers to reach an operator_
- `operator` — _Connect to operator_
User, Zoom Rooms, common area, auto receptionist, call queue, shared line group
|
### Fields
**User**
| `sub_setting_type` |
`settings` |
| **** |
|
| **** |
- `type` - `custom_hours_settings` - `weekday` - `type` - `from`
- `to` - `require_press_1_before_connecting` -
`call_forwarding_settings` - `id` - `description` - `enable` -
`phone_number` - `routing` - `action` - `connect_to_operator` -
`forward_to` - `id` - `extension_id` - `extension_type` -
`extension_number` - `display_name` - `phone_number` -
`operator` - `id` - `extension_id` - `extension_type` -
`extension_number` - `display_name` - `ring_mode` -
`max_wait_time`
|
### Sample code
**User**
```json
{
"business_hours": [
{
"settings": {
"type": 2,
"custom_hours_settings": [
{
"weekday": 1,
"type": 0,
"from": "09:00",
"to": "18:00"
},
{
"weekday": 2,
"type": 1,
"from": "00:00",
"to": "00:00"
},
{
"weekday": 3,
"type": 2,
"from": "09:00",
"to": "18:00"
},
{
"weekday": 4,
"type": 2,
"from": "09:30",
"to": "18:30"
},
{
"weekday": 5,
"type": 2,
"from": "09:46",
"to": "18:46"
},
{
"weekday": 6,
"type": 0,
"from": "09:00",
"to": "18:00"
},
{
"weekday": 7,
"type": 1,
"from": "00:00",
"to": "00:00"
}
]
},
"sub_setting_type": "custom_hours"
},
{
"settings": {
"call_forwarding_settings": [
{
"id": "9aZLs_GqQb2qypzDgVWyzQ",
"description": "Zoom Applications",
"enable": false
},
{
"id": "CcRWqDQ-TeGoFd0TD2T08w",
"description": "Desk Phone",
"enable": true
},
{
"id": "qNvyvDu2RzOw7AAhaZXOyw",
"description": "ttttt",
"enable": true,
"phone_number": "+8615812345678"
}
],
"require_press_1_before_connecting": true
},
"sub_setting_type": "call_forwarding"
},
{
"settings": {
"routing": {
"action": 1,
"operator": {
"id": "oG_nYRFuTJiY1tu0Fur_4Q",
"extension_id": "TO586CYlQFC_WCUvPRXytA",
"extension_number": 17000017002,
"extension_type": "user",
"display_name": "ZOOM_API Test"
},
"connect_to_operator": true
},
"ring_mode": "simultaneous",
"max_wait_time": 20
},
"sub_setting_type": "call_handling"
}
],
"closed_hours": [
{
"settings": {
"call_forwarding_settings": [
{
"id": "INYrRpOORcWcl1L1LTrZRA",
"description": "Zoom Applications",
"enable": true
},
{
"id": "ePtRbl3qR56EQDmAHAIObw",
"description": "callforwarding_2021_10_09_06_04_55_717",
"enable": true,
"phone_number": "+8615812345678"
}
],
"require_press_1_before_connecting": false
},
"sub_setting_type": "call_forwarding"
},
{
"settings": {
"routing": {
"action": 9,
"forward_to": {
"id": "1",
"extension_id": "OJGi5xOFQPmrJbKg68-iWg",
"display_name": "Test_add_01_1",
"phone_number": "+8615812345678"
}
},
"ring_mode": "simultaneous",
"max_wait_time": 15
},
"sub_setting_type": "call_handling"
}
],
"holiday_hours": [
{
"details": [
{
"settings": {
"name": "tetet",
"from": "2021-10-07T16:00:00Z",
"to": "2021-10-08T16:00:00Z"
},
"sub_setting_type": "holiday"
},
{
"settings": {
"call_forwarding_settings": [
{
"id": "m-bN6mktRH-DmtA_9Zvr5A",
"description": "Zoom Applications",
"enable": false
}
],
"require_press_1_before_connecting": true
},
"sub_setting_type": "call_forwarding"
},
{
"settings": {
"routing": {
"action": 1,
"connect_to_operator": false
},
"ring_mode": "simultaneous",
"max_wait_time": 30
},
"sub_setting_type": "call_handling"
}
],
"holiday_id": "6CTG5Fc5SrKFjkSvFia1FQ"
},
{
"details": [
{
"settings": {
"name": "tetetetetette",
"from": "2021-10-08T16:00:00Z",
"to": "2021-10-09T16:00:00Z"
},
"sub_setting_type": "holiday"
},
{
"settings": {
"call_forwarding_settings": [
{
"id": "I2Paop_fQ5y5ItHLuxOvkw",
"description": "Zoom Applications",
"enable": false
}
],
"require_press_1_before_connecting": true
},
"sub_setting_type": "call_forwarding"
},
{
"settings": {
"routing": {
"action": 1,
"connect_to_operator": false
},
"ring_mode": "simultaneous",
"max_wait_time": 30
},
"sub_setting_type": "call_handling"
}
],
"holiday_id": "lSA-kaflQLWXs_OPRh7vXA"
},
{
"details": [
{
"settings": {
"name": "holiday_2021_11_05_01_33_47_973",
"from": "2021-11-06T01:43:47Z",
"to": "2021-11-07T01:43:47Z"
},
"sub_setting_type": "holiday"
},
{
"settings": {
"call_forwarding_settings": [
{
"id": "tZLnG8EYRiKEtjs3BjnSkA",
"description": "Zoom Applications",
"enable": false
},
{
"id": "HR9I6mo7RZu0t5rAIVfkNQ",
"description": "callforwarding_2021_11_05_01_33_47_974",
"enable": true,
"phone_number": "+8615812345678"
}
],
"require_press_1_before_connecting": true
},
"sub_setting_type": "call_forwarding"
},
{
"settings": {
"routing": {
"action": 1,
"connect_to_operator": false
},
"ring_mode": "simultaneous",
"max_wait_time": 30
},
"sub_setting_type": "call_handling"
}
],
"holiday_id": "iy8wmtnvSkuP0HIYBnLfUA"
}
]
}
```
---
## Auto receptionists
Call handling settings for auto receptionists.
- [Get call handling settings](#get-call-handling-settings-1)
- [Add a call handling setting](#add-a-call-handling-setting-1)
- [Update a call handling setting](#update-a-call-handling-setting-1)
- [Custom hours subsetting](#custom_hours-subsetting-1)
- [Call handling subsetting](#call_handling-subsetting-1)
- [Holiday subsetting](#holiday-subsetting-2)
### Add a call handling setting
**Auto receptionist**
[POST /phone/extension/\{extensionId}/call_handling/settings/\{settingType}](/docs/api/phone/#tag/call-handling/POST/phone/extension/{extensionId}/call_handling/settings/{settingType}).
### Subsetting
**Auto receptionist**
- `holiday`
Manages the _holiday list_ and _call handling_ settings where the `name` is the holiday name.
### Allowed fields
**Auto receptionist**
- `name`
- `from`
- `to`
### Sample code
**Auto receptionist**
```json
{
"sub_setting_type": "holiday",
"settings": {
"name": "holiday_2021_11_05_01_33_47_972",
"from": "2021-11-06T01:33:47Z",
"to": "2021-11-07T01:33:47Z"
}
}
```
---
### Update a call handling setting
**Auto receptionist**
[PATCH /phone/extension/\{extensionId}/call_handling/settings/\{settingType}](/docs/api/phone/#tag/call-handling/PATCH/phone/extension/{extensionId}/call_handling/settings/{settingType}). - [Custom hours](#custom_hours-subsetting-1)
### `custom_hours` subsetting
**Auto receptionist**
- Business hours
- 24 hours a day, 7 days a week
- Custom hours
- `type`
- 1 — 24 hours a day, 7 days a week
- `custom_hours_settings.type`
- `0` — Exclude this day from business hour
- `1` — 24 hours
- `2` — Customized hours
### Allowed fields
**Auto receptionist**
- `type`
- `custom_hours_settings`
- `weekday`
- `type`
- `from`
- `to`
### Sample code
**Auto receptionist**
- 24 hours a day, 7 days a week
```json
{
"settings": {
"type": 1
},
"sub_setting_type": "custom_hours"
}
```
- Custom hours
```json
{
"settings": {
"custom_hours_settings": [
{
"type": 0,
"weekday": 1
},
{
"type": 1,
"weekday": 2
},
{
"from": "10:00",
"to": "18:00",
"type": 2,
"weekday": 3
},
{
"from": "09:30",
"to": "18:30",
"type": 2,
"weekday": 4
},
{
"from": "10:47",
"to": "18:47",
"type": 2,
"weekday": 5
},
{
"type": 0,
"weekday": 6
},
{
"type": 1,
"weekday": 7
}
],
"type": 2
},
"sub_setting_type": "custom_hours"
}
```
### `holiday` subsetting
**Auto receptionist**
Equivalent to managing the _holiday list_ and _call handling_ setting under _holiday hours_ in the web portal for auto receptionists.
### Allowed fields
**Auto receptionist**
- `holiday_id`
- `name`
- `from`
- `to`
### Sample code
**Auto receptionist**
```json
{
"sub_setting_type": "holiday",
"settings": {
"holiday_id": "N-FEFnBBRRShJRwuxrvMSA",
"name": "holiday_2021_11_05_01_16_49_299",
"from": "2021-11-06T01:26:49Z",
"to": "2021-11-07T01:26:49Z"
}
}
```
### `call_handling` subsetting
**Auto receptionist**
Call handling for business hours / closed hours / holiday hours.
Web portal
| Field |
Action |
| `call_not_answer_action` |
_Route to_ |
| `forward_to_extension_id` |
- _Voicemail_ and _Leave Voicemail to_ - Current extension,
user, auto receptionist, call queue, shared line group - User,
Zoom Room, common area, auto receptionist, call queue, shared
line group, external contacts, phone number (E.164)
|
### Allowed fields
**Auto receptionist**
- `holiday_id`
- `call_not_answer_action`
- `forward_to_extension_id`
- `greeting_prompt_id`
### Sample code
**Auto receptionist**
```json
{
"settings": {
"call_not_answer_action": 10,
"greeting_prompt_id": "",
"phone_number": "+161422604**"
},
"sub_setting_type": "call_handling"
}
```
---
### Get call handling settings
**Auto receptionist**
[GET /phone/extension/\{extensionId}/call_handling/settings](/docs/api/phone/#tag/call-handling/GET/phone/extension/{extensionId}/call_handling/settings)
### Fields
| `sub_setting_type` |
`settings` |
|
- `type` - `custom_hours_settings` - `weekday` - `type` - `from`
- `to` - `routing` - `action` - `forward_to` - `id` -
`extension_id` - `extension_type` - `extension_number` -
`display_name` - `phone_number` - `voicemail_greeting` - `id` -
`name` - `greeting_prompt` - `id` - `name`
|
### Sample code
**Auto receptionist**
```json
{
"business_hours": [
{
"settings": {
"custom_hours_settings": [
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 1
},
{
"from": "00:00",
"to": "00:00",
"type": 1,
"weekday": 2
},
{
"from": "10:00",
"to": "18:00",
"type": 2,
"weekday": 3
},
{
"from": "09:30",
"to": "18:30",
"type": 2,
"weekday": 4
},
{
"from": "10:47",
"to": "18:47",
"type": 2,
"weekday": 5
},
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 6
},
{
"from": "00:00",
"to": "00:00",
"type": 1,
"weekday": 7
}
],
"type": 2
},
"sub_setting_type": "custom_hours"
},
{
"settings": {
"greeting_prompt": {
"id": "0",
"name": "disable"
},
"routing": {
"action": 1,
"forward_to": {
"display_name": "ApiTA_2020_12_21_19_54_10_639",
"extension_id": "JGiv4OfoRGeVBuqN1nio6g",
"extension_number": 9000009003,
"extension_type": "callQueue",
"id": "hmLDXP8wSUKY132M7fgQ6A",
"voicemail_greeting": {
"id": "",
"name": "default"
}
}
}
},
"sub_setting_type": "call_handling"
}
],
"closed_hours": [
{
"settings": {
"greeting_prompt": {
"id": "0",
"name": "disable"
},
"routing": {
"action": 9,
"forward_to": {
"display_name": "Test_add_ec_01",
"extension_id": "y0brV9dgQyCYid1h9ILCOw",
"id": "Test_add_ec_01"
}
}
},
"sub_setting_type": "call_handling"
}
],
"holiday_hours": [
{
"details": [
{
"settings": {
"from": "2021-10-31T16:00:00Z",
"name": "Too1",
"to": "2021-11-01T16:00:00Z"
},
"sub_setting_type": "holiday"
},
{
"settings": {
"greeting_prompt": {
"id": "",
"name": "default"
},
"routing": {
"action": 1,
"forward_to": {
"display_name": "callhandling0001",
"extension_id": "_lZt3CtgSQ-Wm00MCyt2vg",
"extension_number": 1000000009,
"extension_type": "autoReceptionist",
"id": "iKBmdpVuRkqmvt9SvhnTxA",
"voicemail_greeting": {
"id": "eMwL2fvmTVm-2xiZFXAa_Q",
"name": "custom0001.wav"
}
}
}
},
"sub_setting_type": "call_handling"
}
],
"holiday_id": "2Jifr_0LTVqonIAY70uBKA"
}
]
}
```
---
## Call queues
Call handling settings for call queues.
- [Get call handling settings](#get-call-handling-settings-2)
- [Add a call handling setting](#add-a-call-handling-setting-2)
- [Update a call handling setting](#update-a-call-handling-setting-2)
- [Custom hours subsetting](#custom_hours-subsetting-2)
- [Call handling subsetting](#call_handling-subsetting-2)
- [Holiday subsetting](#holiday-subsetting-3)
### Add a call handling setting
**Call queue**
[POST /phone/extension/\{extensionId}/call_handling/settings/\{settingType}](/docs/api/phone/#tag/call-handling/POST/phone/extension/{extensionId}/call_handling/settings/{settingType}).
### Subsetting
- `holiday`
Manages the _holiday list_ and _call handling_ settings where the `name` is the holiday name.
### Allowed fields
**Call queue**
- `name`
- `from`
- `to`
### Sample code
**Call queue**
```json
{
"sub_setting_type": "holiday",
"settings": {
"name": "holiday_2021_11_05_01_33_47_972",
"from": "2021-11-06T01:33:47Z",
"to": "2021-11-07T01:33:47Z"
}
}
```
---
### Update a call handling setting
**Call queue**
[ATCH /phone/extension/\{extensionId}/call_handling/settings\{settingType}](/docs/api/phone/#tag/call-handling/PATCH/phone/extension/{extensionId}/call_handling/settings/{settingType})
### `custom_hours` subsetting
**Call queue**
- Business hours
- 24 hours a day, 7 days a week
- Custom hours
- `type`
- `1` — 24 hours a day, 7 days a week
- `custom_hours_settings.type`
- `0` — Exclude this day from business hour
- `1` — 24 hours
- `2` — Customized hours
- `allow_members_to_reset`
Allow queue members to set their own business hours
### Allowed fields
**Call queue**
- `allow_members_to_reset`
- `type`
- `custom_hours_settings`
- `weekday`
- `type`
- `from`
- `to`
### Sample code
**Call queue**
- 24 hours a day, 7 days a week
```json
{
"settings": {
"allow_members_to_reset": true,
"type": 1
},
"sub_setting_type": "custom_hours"
}
```
- Custom hours
```json
{
"settings": {
"allow_members_to_reset": false,
"custom_hours_settings": [
{
"type": 0,
"weekday": 1
},
{
"type": 1,
"weekday": 2
},
{
"from": "10:00",
"to": "18:00",
"type": 2,
"weekday": 3
},
{
"from": "10:30",
"to": "18:30",
"type": 2,
"weekday": 4
},
{
"from": "10:46",
"to": "18:46",
"type": 2,
"weekday": 5
},
{
"type": 0,
"weekday": 6
},
{
"type": 1,
"weekday": 7
}
],
"type": 2
},
"sub_setting_type": "custom_hours"
}
```
### `holiday` subsetting
**Call queue**
Equivalent to managing the _holiday list_ and _call handling_ settings under _holiday hours_ in the web portal.
### Allowed fields
**Call queue**
- `holiday_id`
- `name`
- `from`
- `to`
### Sample code
**Call queue**
```json
{
"sub_setting_type": "holiday",
"settings": {
"holiday_id": "N-FEFnBBRRShJRwuxrvMSA",
"name": "holiday_2021_11_05_01_16_49_299",
"from": "2021-11-06T01:26:49Z",
"to": "2021-11-07T01:26:49Z"
}
}
```
---
### `call_handling` subsetting
**Call queue**
Call handling for business hours / closed hours / holiday hours.
Web portal
| Field |
Action |
| `call_not_answer_action` |
_Overflow_ |
| `forward_to_extension_id` |
_Voicemail_ and _Leave Voicemail to_ - Current extension, user,
auto receptionist, call queue, shared line group - User, Zoom
Room, common area, auto receptionist, call queue, shared line
group, external contacts, phone number (E.164)
|
| `connect_to_operator` `operator_extension_id` |
_Forward to voicemail or videomail_ `connect_to_ operator`
_Allow callers to reach an operator_ `operator_extension_id`
_Connect to operator_ User, Zoom Rooms, common area, auto
receptionist, call queue, and shared line group
|
### Allowed fields
**Call queue**
- `holiday_id`
- `max_wait_time`
- `call_not_answer_action`
- `forward_to_extension_id`
- `connect_to_operator`
- `operator_extension_id`
- `voicemail_greeting_id`
For business hours only:
- `receive_call`
Receives calls while on a call
- `greeting_prompt_id`
- `audio_while_connecting_id`
- `music_on_hold_id`
- `wrap_up_time`
- `max_call_in_queue`
- `call_distribution`
- `ring_mode` for _Sequential_ or _Rotating_ modes
Calls ring for a specific time before trying the next available queue member
- `ring_duration`
Ringing duration for each member
- `handle_multiple_calls`
Handles multiple incoming calls simultaneously
- `skip_offline_device_phone_number`
Skips offline devices and phone numbers when ringing
### Sample code
**Call queue**
```json
{
"settings": {
"audio_while_connecting_id": "",
"call_distribution": {
"handle_multiple_calls": false,
"ring_duration": 35,
"ring_mode": "sequential",
"skip_offline_device_phone_number": false
},
"call_not_answer_action": 1,
"connect_to_operator": true,
"forward_to_extension_id": "0LA1BWO5Sh2faTQXrKvYRw",
"greeting_prompt_id": "0",
"max_call_in_queue": 49,
"max_wait_time": 10,
"music_on_hold_id": "",
"operator_extension_id": "JGiv4OfoRGeVBuqN1nio6g",
"receive_call": true,
"voicemail_greeting_id": "",
"wrap_up_time": 15
},
"sub_setting_type": "call_handling"
}
```
---
### Get call handling settings
**Call queue**
[GET /phone/extension/\{extensionId}/call_handling/settings](/docs/api/phone/#tag/call-handling/GET/phone/extension/{extensionId}/call_handling/settings)
Web portal
| Field |
Action |
| `routing` |
_Overflow_ |
| `forward_to` |
_Voicemail_ and _Leave Voicemail to_ - Current extension, user,
auto receptionist, call queue, shared line group - User, Zoom
Room, common area, auto receptionist, call queue, shared line
group, external contacts, phone number (E.164)
|
| `connect_to_operator` `operator` |
_Forward to voicemail_ or _videomail_ `connect_to_ operator`
_Allow callers to reach an operator_ `operator` _Connect to
operator to_ User, Zoom Rooms, common area, auto receptionist,
call queue, shared line group
|
### Fields
**Call queue**
|
|
| **`sub_setting_type`** |
|
| **`settings`** |
- `type` - `custom_hours_settings` - `weekday` - `type` - `from`
- `to` - `routing` - `action` - `forward_to` - `id` -
`extension_id` - `extension_type` - `extension_number` -
`display_name` - `phone_number` - `voicemail_greeting` - `id` -
`name` - `greeting_prompt` - `id` - `name`
|
### Sample code
**Call queue**
```json
{
"business_hours": [
{
"settings": {
"allow_members_to_reset": false,
"custom_hours_settings": [
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 1
},
{
"from": "00:00",
"to": "00:00",
"type": 1,
"weekday": 2
},
{
"from": "10:00",
"to": "18:00",
"type": 2,
"weekday": 3
},
{
"from": "10:30",
"to": "18:30",
"type": 2,
"weekday": 4
},
{
"from": "10:46",
"to": "18:46",
"type": 2,
"weekday": 5
},
{
"from": "09:00",
"to": "18:00",
"type": 0,
"weekday": 6
},
{
"from": "00:00",
"to": "00:00",
"type": 1,
"weekday": 7
}
],
"type": 2
},
"sub_setting_type": "custom_hours"
},
{
"settings": {
"audio_while_connecting": {
"id": "",
"name": "default"
},
"call_distribution": {
"handle_multiple_calls": false,
"ring_duration": 35,
"ring_mode": "sequential",
"skip_offline_device_phone_number": false
},
"greeting_prompt": {
"id": "0",
"name": "disable"
},
"max_call_in_queue": 49,
"max_wait_time": 10,
"music_on_hold": {
"id": "",
"name": "default"
},
"routing": {
"action": 1,
"connect_to_operator": true,
"forward_to": {
"display_name": "callhandling0001_Not_Delete",
"extension_id": "0LA1BWO5Sh2faTQXrKvYRw",
"extension_number": 1000000101,
"extension_type": "callQueue",
"id": "IU8_1qAGS1Gf-3e56B_1Lw"
},
"operator": {
"display_name": "ApiTA_2020_12_21_19_54_10_639",
"extension_id": "JGiv4OfoRGeVBuqN1nio6g",
"extension_number": 9000009003,
"extension_type": "callQueue",
"id": "hmLDXP8wSUKY132M7fgQ6A"
}
},
"wrap_up_time": 15
},
"sub_setting_type": "call_handling"
}
],
"closed_hours": [
{
"settings": {
"routing": {
"action": 9,
"forward_to": {
"display_name": "Test_add_ec_01",
"extension_id": "y0brV9dgQyCYid1h9ILCOw",
"id": "Test_add_ec_01"
}
}
},
"sub_setting_type": "call_handling"
}
],
"holiday_hours": [
{
"details": [
{
"settings": {
"from": "2021-11-01T17:00:00Z",
"name": "TUT01",
"to": "2021-11-02T16:00:00Z"
},
"sub_setting_type": "holiday"
},
{
"settings": {
"routing": {
"action": 10,
"forward_to": {
"phone_number": "+8615812345678"
}
}
},
"sub_setting_type": "call_handling"
}
],
"holiday_id": "PEgEN0CiSaCY-sD1dM3l8w"
}
]
}
```