openapi: 3.2.0
info:
title: Phone Call Handling API
description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
contact:
name: Zoom Developers
url: https://developer.zoom.us/
version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Call Handling
paths:
/phone/extension/{extensionId}/call_handling/settings:
get:
tags:
- Call Handling
summary: Get call handling settings
description: 'Returns information about a Zoom Phone 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](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-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
**Deprecation notice:** This API is planned for deprecation.
Use the resource-specific APIs instead:
* For user call handling settings, use `GET /phone/users/{userId}/call_handling/settings`.
* For common area call handling settings, use `GET /phone/common_areas/{commonAreaId}/call_handling/settings`.
* For auto receptionist call handling settings, use `GET /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings`.
* For call queue call handling settings, use `GET /phone/call_queues/{callQueueId}/call_handling/settings`.
* For shared line group call handling settings, use `GET /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings`.
* For user profile, holiday hour, custom hour, or other user setting data, use `GET /phone/users/{userId}/settings`.
* For common area holiday hour, custom hour, or other setting data, use `GET /phone/common_areas/{commonAreaId}/settings`.
* For auto receptionist holiday hour, custom hour, or other setting data, use `GET /phone/auto_receptionists/{autoReceptionistId}/settings`.
* For call queue holiday hour, custom hour, or other setting data, use `GET /phone/call_queues/{callQueueId}/settings`.
* For shared line group holiday hour, custom hour, or other setting data, use `GET /phone/shared_line_groups/{sharedLineGroupId}/settings`.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_handling_settings:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: getCallHandling
parameters:
- name: extensionId
in: path
description: The extension ID.
required: true
schema:
type: string
example: nNGsNx2zRDyiIXWVI23FCQ
responses:
'200':
description: "**HTTP Status Code:** `200` \n OK"
content:
application/json:
schema:
type: object
properties:
business_hours:
type: array
description: The information about business hours settings.
items:
type: object
properties:
settings:
type: object
properties:
allow_callers_check_voicemail:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nWhether to allow the callers to check voicemails over a phone. Required only when the `call_not_answer_action` setting is set to `1` (Forward to a voicemail)."
example: true
deprecated: true
allow_members_to_reset:
type: boolean
description: 'This field allows queue members to set their own business hours. It allows queue members'' business hours to override the default hours of the call queue.
Required for `Call Queue custom_hours` sub-setting.'
example: true
audio_while_connecting:
type: object
properties:
id:
type: string
description: The audio-while-connecting prompt ID. If the audio was removed from the user's audio library, it's marked with a prefix (for example, `removed_vWby3OZaQlS1nAdmEAqgwA`). You can use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
example: qPwtDrrcSua8O0_n0bDRDg
name:
type: string
description: The audio while connecting the prompt name.
example: Default
description: 'Returns the audio played when the inbound callers are waiting to be routed to the next available call queue member.
* empty char - default
* `ring_tone` - "Ring Tone" option
* `0` - disable
Returned only for the `Call Queue` `call_handling` sub-setting.'
call_distribution:
type: object
properties:
handle_multiple_calls:
type: boolean
description: 'The maximum number of calls that can be handled simultaneously is less than half of the total amount of available call queue members. Note that the first incoming call might not be answered first.
Returned only except `simultaneous` ring mode.'
example: true
ring_duration:
type: integer
description: "The ringing duration for each member:\n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nReturned only except `simultaneous` ring mode."
example: 10
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
ring_mode:
type: string
description: "The call distribution ring mode: \n* `simultaneous` \n* `sequential` \n* `rotating` \n* `longest_idle`"
example: simultaneous
enum:
- simultaneous
- sequential
- rotating
- longest_idle
skip_offline_device_phone_number:
type: boolean
description: "1. Devices with Zoom app or client not launched and mobile phone with screen locked will be skipped. \n\n2. Phone numbers added to user's call handling settings are skipped.\n\nReturned only except `simultaneous` ring mode."
example: true
description: "This option distributes incoming calls.\n\nIf `Sequential` or `Rotating` is selected, calls ring for a specific time before trying the next available queue member. \n\nReturned only for the `call_handling` sub-setting."
call_forwarding_settings:
type: array
description: The call forwarding settings. It returns only for the `call_forwarding` sub-setting.
items:
type: object
properties:
description:
type: string
description: The external phone number's description.
example: testNumber
enable:
type: boolean
description: Whether to receive a call.
example: true
id:
type: string
description: The call forwarding's ID.
example: qPvrfrrcrf843cdfvbDRDg
phone_number:
type: string
description: The external phone number in E164 format.
example: '+12058945565'
external_contact:
type: object
properties:
name:
type: string
description: The external contact's username or extension display name.
example: Johnson
email:
type: string
description: The external contact's email address.
example: example@example.com
external_contact_id:
type: string
description: The external contact's ID.
example: OJGi5xOFQPmrJbKg68-iWg
phone_numbers:
type: array
description: The external contact's phone numbers.
items:
type: string
example: '+12058945656'
call_not_answer_action:
type: integer
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nThe action to take when a call is not answered: \n* `1` — Forward to a voicemail. \n* `2` — Forward to the user. \n* `4` — Forward to the common area. \n* `6` — Forward to the auto receptionist. \n* `7` — Forward to a call queue. \n* `8` — Forward to a shared line group. \n* `9` — Forward to an external contact. \n* `10` - Forward to a phone number. \n* `11` — Disconnect. \n* `12` — Play a message, then disconnect. \n* `13` - Forward to message. \n* `14` - Forward to interactive voice response (IVR). \n\nReturned only for the `call_handling` sub-setting."
example: 2
deprecated: true
enum:
- 1
- 2
- 4
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
connect_to_operator:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nWhether to allow callers to reach an operator. Returns only when `call_not_answer_action` is set to `1` (Forward to a voicemail)."
example: true
deprecated: true
custom_hours_settings:
type: array
description: The custom hours settings. It returns only for the `custom_hours` sub-setting.
items:
type: object
properties:
from:
type: string
description: The custom hours start time and `HH:mm` format.
example: 09:00
to:
type: string
description: The custom hours end time in `HH:mm` format.
example: '18:00'
type:
type: integer
description: "The type of custom hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours."
example: 1
enum:
- 0
- 1
- 2
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"
example: 5
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
greeting_prompt:
type: object
properties:
id:
type: string
description: "The greeting audio prompt ID. \n\n Options: empty char - default and `0` - disable \n\n If the audio was removed from the user's audio library, it's marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API. "
example: '0'
name:
type: string
description: The greeting audio prompt name.
example: test
description: 'The greeting audio prompt
Returns only for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.'
max_call_in_queue:
type: integer
description: 'The maximum number of calls in queue.
Specify the maximum number of callers to place in the queue. When this number is exceeded, callers will be routed based on the overflow option. Up to 60.
Returned only for the `Call Queue` `call_handling` sub-setting.'
example: 5
max_wait_time:
type: integer
description: "The maximum wait time, in seconds, for `simultaneous` ring mode or the ring duration for each device for `sequential` ring mode: \n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nSpecify how long a caller waits in the queue. Once the wait time is exceeded, the caller is rerouted based on the overflow option for call queue`:\n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n* `120` \n* `180` \n* `240` \n* `300` \n* `600` \n* `900` \n* `1200` \n* `1500` \n* `1800` \n\nReturned only for the `call_handling` sub-setting."
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
- 600
- 900
- 1200
- 1500
- 1800
music_on_hold:
type: object
properties:
id:
type: string
description: The music on hold prompt ID. If the audio was removed from the user's audio library, it's marked with a prefix, (for example, `removed_vWby3OZaQlS1nAdmEAqgwA`). You can use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
example: fdsij3he89qj2-23uie
name:
type: string
description: The music on hold prompt name.
example: Default
description: 'The music on hold prompt. This field is an option to choose music for inbound callers when they''re placed on hold by a call queue member.
empty char - default and `0` - disable.
Returned only for the `Call Queue` `call_handling` sub-setting.'
receive_call:
type: boolean
description: "This field enables calls to be received during a current call. When enabled, call queue members can receive new incoming calls notification even on the call. \n\nReturned only for the `Call Queue` `call_handling` sub-setting."
example: true
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. This field helps to ensure missed calls do not reach to your personal voicemail. This field returns only for the `call_forwarding` sub-setting.
example: true
ring_mode:
type: string
description: "The call handling ring mode: \n* `simultaneous` \n* `sequential` \n\nReturned only for the `call_handling` sub-setting."
example: simultaneous
enum:
- simultaneous
- sequential
routing:
type: object
properties:
action:
type: integer
description: "The action to take when a call is not answered during Business Hours: \n* `1` — Forward to a Voicemail. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `2` — Forward to the User. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `3` — Forward to the Zoom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `4` — Forward to the Common Area. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `5` — Forward to the Cisco/Polycom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `6` — Forward to the Auto Receptionist. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `7` — Forward to a Call Queue. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `8` — Forward to a Shared Line Group. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `9` — Forward to an External Contact. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `10` - Forward to a Phone Number. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `11` — Disconnect. Applicable to `User`, `Call Queue`, or `Shared Line Group`. \n* `12` — Play a message, then disconnect. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group` \n* `14` - Forward to an Interactive Voice Response (IVR). Applicable to `Auto Receptionist`. \n* `15` — Forward to a Partner Contact Center. Applicable to `Auto Receptionist`. \n* `18` — Forward to Microsoft Teams Resource Account. Required the license of Zoom Phone for Microsoft Teams. Applicable to `Call queue`, `Auto Receptionist`, or `Shared Line group`. \n* `19` — Forward to a Zoom Contact Center. Required Zoom Contact Center license. Applicable to `Call Queue`, `Auto Receptionist`, or `Shared Line Group`."
example: 1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 14
- 15
- 18
- 19
forward_to:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: api_ta_test
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `autoReceptionist` \n* `callQueue`"
example: user
enum:
- user
- autoReceptionist
- callQueue
- commonArea
id:
type: string
description: The ID of the extension for `user`, `autoReceptionist`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
phone_number:
type: string
description: "The extension's phone number or forward to an external number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: '+18889843519'
description:
type: string
description: "This field forwards to an external number description. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: forward to phone number +18889843519.
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Voicemail greeting
description: The voicemail greeting prompt. It returns only when the `action` in the `routing` section is set to `1` (Forward to a voicemail) for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.
zcc_phone_number:
type: string
description: "The Zoom Contact Center phone number to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: '12055903036'
zcc_phone_number_display_name:
type: string
description: "The display name of the Zoom Contact Center phone number to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: Display name - (205) 690-3036(American English)
partner_contact_center_id:
type: string
description: "The ID of the Partner Contact Center to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`."
example: 0Qa7FFTfR0CgzpgwUrcxtQ
pcc_phone_number_display_name:
type: string
description: "The display name of the Partner Contact Center to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`."
example: Test contact center
teams_app_id:
type: string
description: "The ID of the Microsoft Teams Voice App to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: wgYRHE6ITJOZmV6DBvoyZw
teams_voice_app_name:
type: string
description: "The display name of the Microsoft Teams Voice App to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: Test Teams app
description: "The information about the call forwarding target. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `1` (Forward to voicemail) for unanswered calls, this field is used to display the specific extension to which voicemails are forwarded. This scenario applies to `Auto Receptionist` and `Call Queue`. \n* Secnario 2: when `action` in the `routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue), `8`(Forward to a Shared Line Group) or `9`(forward to an External Contact) for unanswered calls, this field is used to display the extension to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 3: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 4: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`. \n* Secnario 5: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 6: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
operator:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: user A
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `commonArea` \n* `sharedLineGroup` \n* `callQueue`"
example: user
enum:
- user
- commonArea
- sharedLineGroup
- callQueue
id:
type: string
description: The ID of the extension for `user`, `commonArea`, `sharedLineGroup`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
description: "The the operator to whom the call is being forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
connect_to_operator:
type: boolean
description: "Whether to allow callers to reach an operator. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
example: true
allow_callers_check_voicemail:
type: boolean
description: "Whether to allow the callers to check voicemails over a phone. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User` \n* `Shared Line Group`"
example: true
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Greeting voicemail
description: 'The voicemail greeting audio prompt
Returns only for the `user` and `call_handling` subsetting. It displays when the `action` in the `routing` section is set to `1` - Forward to a voicemail.'
voicemail_leaving_instruction:
type: object
properties:
id:
type: string
description: "The voicemail leaving instruction prompt ID. \n\n Options: empty char - default"
example: LxC4hMD8TJeFpwRcB_QWkA
name:
type: string
description: The voicemail leaving instruction prompt name.
example: Voicemail greeting
description: "The voicemail leaving instruction prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `routing` section is set to `1` (Forward to a voicemail), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
message_greeting:
type: object
properties:
id:
type: string
description: "The message greeting prompt ID. \n\n Options: empty char - default"
example: di936zivT46YBCt3dr15GQ
name:
type: string
description: The message greeting prompt name.
example: Message greeting
description: "The message greeting prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `routing` section is set to `12` (Play a message, then disconnect). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. It helps to ensure that missed calls do not reach to your personal voicemail. It returns for the `Forward to an external number` and `Forward to External Contacts` options.
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue) or `8`(Forward to a Shared Line Group). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is only included in `busy_routing` section.` \n\nWhether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. It displays when `busy_routing` action is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number."
example: true
deprecated: true
description: "The extension's forwarding or overflow information when a call is not answered during Business Hours. \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`."
busy_routing:
type: object
properties:
action:
type: integer
description: "The action to take when the user is busy on another call during Business Hours: \n* `21` - Call waiting. \n* `22` - Play a busy signal. \n* `1` — Forward to a voicemail/videomail. \n* `2` - Forward to the user. \n* `4` - Forward to the common area. \n* `6` - Forward to the auto receptionist. \n* `7` - Forward to a call queue. \n* `8` - Forward to a shared line group. \n* `9` - Forward to an external contact. \n* `10` - Forward to an external number. \n* `12` — Play a message, then disconnect."
example: 1
forward_to:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: api_ta_test
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `autoReceptionist` \n* `callQueue`"
example: user
enum:
- user
- autoReceptionist
- callQueue
- commonArea
id:
type: string
description: The ID of the extension for `user`, `autoReceptionist`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
phone_number:
type: string
description: "The extension's phone number or forward to an external number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
example: '+18889843519'
description:
type: string
description: "This field forwards to an external number description. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
example: forward to phone number +18889843519.
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Voicemail greeting
description: The voicemail greeting prompt. It returns only when the `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.
description: "The information about the call forwarding target. \n\nThis field is only available in the following scenarios: \n* Secnario 1: when `action` in the `busy_routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue), `8`(Forward to a Shared Line Group) or `9`(forward to an External Contact) for the user busy on another call, this field is used to display the extension to which the call will be forwarded. This scenario applies to `User`. \n* Secnario 2: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
operator:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: user A
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `commonArea` \n* `sharedLineGroup` \n* `callQueue`"
example: user
enum:
- user
- commonArea
- sharedLineGroup
- callQueue
id:
type: string
description: The ID of the extension for `user`, `commonArea`, `sharedLineGroup`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
description: "The the operator to whom the call is being forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
connect_to_operator:
type: boolean
description: "Whether to allow callers to reach an operator. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
allow_callers_check_voicemail:
type: boolean
description: "Whether to allow the callers to check voicemails over a phone. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Greeting voicemail
description: 'The voicemail greeting audio prompt
Returns only for the `user` and `call_handling` subsetting options. It displays when the `action` in the `busy_routing` section is set to `1` - Forward to a voicemail.'
voicemail_leaving_instruction:
type: object
properties:
id:
type: string
description: "The voicemail leaving instruction prompt ID. \n\n Options: empty char - default"
example: LxC4hMD8TJeFpwRcB_QWkA
name:
type: string
description: The voicemail leaving instruction prompt name.
example: Voicemail greeting
description: "The voicemail leaving instruction prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `busy_routing` section is set to `1` (Forward to a voicemail), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n\nApplicable to the extension as shown below:\n* `User`"
message_greeting:
type: object
properties:
id:
type: string
description: "The message greeting prompt ID. \n\n Options: empty char - default"
example: di936zivT46YBCt3dr15GQ
name:
type: string
description: The message greeting prompt name.
example: Message greeting
description: "The message greeting prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `busy_routing` section is set to `12` (Play a message, then disconnect). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. This field helps to ensure that missed calls do not reach to your personal voicemail. It returns for the `Forward to an external number` and `Forward to External Contacts` options.
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is only included in the `routing` section.` \n\nWhether to play the callee's voicemail greeting when the caller reaches the end of forwarding sequence. It displays when `call_not_answer_action` is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number."
example: true
deprecated: true
play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue) or `8`(Forward to a Shared Line Group). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
description: "The extension's forwarding or overflow information when the user is busy on another call during Business Hours. \n\nApplicable to the extension as shown below:\n* `User`."
type:
type: integer
description: "The type of custom hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Custom hours. \n\nReturns only for the `custom_hours` sub-setting."
example: 1
enum:
- 1
- 2
wrap_up_time:
type: integer
description: "The wrap up time in seconds. \nSpecify the duration before the next queue call is routed to a member in call queue:\n* `0` \n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n* `120` \n* `180` \n* `240` \n* `300`\n\nReturns only for the `call_handling` sub-setting option."
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
description: The business hours settings.
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_forwarding` \n* `custom_hours` \n* `call_handling`"
example: call_forwarding
enum:
- call_forwarding
- custom_hours
- call_handling
closed_hours:
type: array
description: The information about the closed hours settings.
items:
type: object
properties:
settings:
type: object
properties:
allow_callers_check_voicemail:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nWhether to allow the callers to check voicemails over a phone. It's required only when the `call_not_answer_action` setting is set to `1` (Forward to a voicemail)."
example: true
deprecated: true
call_forwarding_settings:
type: array
description: The call forwarding settings. It returns only for the `call_forwarding` sub-setting options.
items:
type: object
properties:
description:
type: string
description: The external phone number description.
example: testDescription
enable:
type: boolean
description: Whether to receive a call.
example: false
id:
type: string
description: The call forwarding ID.
example: sd8683_fwh39_F3hfsd
phone_number:
type: string
description: The external phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format.
example: '+12058945583'
external_contact:
type: object
properties:
name:
type: string
description: The external contact's username or extension display name.
example: Johnson
email:
type: string
description: The external contact's email address.
example: example@example.com
external_contact_id:
type: string
description: The external contact's ID.
example: OJGi5xOFQPmrJbKg68-iWg
phone_numbers:
type: array
description: The external contact's phone numbers.
items:
type: string
example: '+12058945656'
call_not_answer_action:
type: integer
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nThe action to take when a call is not answered: \n* `1` — Forward to a voicemail. \n* `2` — Forward to the user. \n* `4` — Forward to the common area. \n* `6` — Forward to the auto receptionist. \n* `7` — Forward to a call queue. \n* `8` — Forward to a shared line group. \n* `9` — Forward to an external contact. \n* `10` - Forward to a phone number. \n* `11` — Disconnect. \n* `12` — Play a message, then disconnect. \n* `13` - Forward to message. \n* `14` - Forward to interactive voice response (IVR). \n\nReturns only for the `call_handling` sub-setting option."
example: 2
deprecated: true
enum:
- 1
- 2
- 4
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
connect_to_operator:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is not included in the actual response.` \n\nWhether to allow callers to reach an operator. It returns only when the `call_not_answer_action` setting is set to `1` (Forward to a voicemail)."
example: true
deprecated: true
max_wait_time:
type: integer
description: "The maximum wait time, in seconds, for `simultaneous` ring mode or the ring duration for each device for `sequential` ring mode: \n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nReturns only for the `call_handling` sub-setting option."
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. It helps to ensure that missed calls do not reach to your personal voicemail. It returns only for the `call_forwarding` sub-setting option.
example: true
ring_mode:
type: string
description: "The call handling's ring mode setting: \n* `simultaneous` \n* `sequential` \n\nReturns only for the `call_handling` sub-setting option."
example: simultaneous
enum:
- simultaneous
- sequential
routing:
type: object
properties:
action:
type: integer
description: "The action to take when a call is not answered during Closed Hours: \n* `1` — Forward to a Voicemail. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `2` — Forward to the User. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `3` — Forward to the Zoom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `4` — Forward to the Common Area. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `5` — Forward to the Cisco/Polycom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `6` — Forward to the Auto Receptionist. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `7` — Forward to a Call Queue. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `8` — Forward to a Shared Line Group. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `9` — Forward to an External Contact. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `10` - Forward to a Phone Number. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `11` — Disconnect. Applicable to `User`, `Call Queue`, or `Shared Line Group`. \n* `12` — Play a message, then disconnect. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group` \n* `14` - Forward to an Interactive Voice Response (IVR). Applicable to `Auto Receptionist`. \n* `15` — Forward to a Partner Contact Center. Applicable to `Auto Receptionist`. \n* `18` — Forward to Microsoft Teams Resource Account. Required the license of Zoom Phone for Microsoft Teams. Applicable to `Call queue`, `Auto Receptionist`, or `Shared Line group`. \n* `19` — Forward to a Zoom Contact Center. Required Zoom Contact Center license. Applicable to `Call Queue`, `Auto Receptionist`, or `Shared Line Group`."
example: 1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 14
- 15
- 18
- 19
forward_to:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: api_ta_test
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `autoReceptionist` \n* `callQueue`"
example: user
enum:
- user
- autoReceptionist
- callQueue
- commonArea
id:
type: string
description: The ID of the extension for `user`, `autoReceptionist`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
phone_number:
type: string
description: "The extension's phone number or forward to an external number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: '+18889843519'
description:
type: string
description: "This field forwards to an external number description. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: forward to phone number +18889843519.
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Voicemail greeting
description: The voicemail greeting prompt. It returns only when the `action` in the `routing` section is set to `1` (Forward to a voicemail) for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.
zcc_phone_number:
type: string
description: "The Zoom Contact Center phone number to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: '12055903036'
zcc_phone_number_display_name:
type: string
description: "The display name of the Zoom Contact Center phone number to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: Display name - (205) 690-3036(American English)
partner_contact_center_id:
type: string
description: "The ID of the Partner Contact Center to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`."
example: 0Qa7FFTfR0CgzpgwUrcxtQ
pcc_phone_number_display_name:
type: string
description: "The display name of the Partner Contact Center to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`."
example: Test contact center
teams_app_id:
type: string
description: "The ID of the Microsoft Teams Voice App to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: wgYRHE6ITJOZmV6DBvoyZw
teams_voice_app_name:
type: string
description: "The display name of the Microsoft Teams Voice App to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
example: Test Teams app
description: "The information about the call forwarding target: \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `routing` section is set to `1` (Forward to voicemail) for unanswered calls, this field is used to display the specific extension to which voicemails are forwarded. This scenario applies to `Auto Receptionist` and `Call Queue`. \n* Secnario 2: when `action` in the `routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue), `8`(Forward to a Shared Line Group) or `9`(forward to an External Contact) for unanswered calls, this field is used to display the extension to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 3: When `action` in the `routing` section is set to `19` (Forward to a Zoom Contact Center) for unanswered calls, this field is used to display the specific Zoom Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 4: When `action` in the `routing` section is set to `15` (Forward to a Partner Contact Center) for unanswered calls, this field is used to display the specific Partner Contact Center to which the call will be forwarded. This scenario applies to `Auto Receptionist`. \n* Secnario 5: When `action` in the `routing` section is set to `10` (Forward to Phone number/External number) for unanswered calls, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`. \n* Secnario 6: When `action` in the `routing` section is set to `18` (Forward to Microsoft Teams Resource Account) for unanswered calls, this field is used to display the specific Microsoft Teams Voice App to which the call will be forwarded. This scenario applies to `Auto Receptionist`, `Call Queue` and `Shared Line Group`."
operator:
type: object
properties:
display_name:
type: string
description: The extension name.
example: user A
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `commonArea` \n* `sharedLineGroup` \n* `callQueue`"
example: user
enum:
- user
- commonArea
- sharedLineGroup
- callQueue
id:
type: string
description: The ID of the extension for `user`, `commonArea`, `sharedLineGroup`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
description: "The the operator to whom the call is being forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
connect_to_operator:
type: boolean
description: "Whether to allow callers to reach an operator. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
example: true
allow_callers_check_voicemail:
type: boolean
description: "Whether to allow the callers to check voicemails over a phone. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User` \n* `Shared Line Group`"
example: true
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Greeting voicemail
description: 'The voicemail greeting audio prompt
Returns only for the `user` and `call_handling` subsetting options. It displays when the `action` in the `routing` section is set to `1` - Forward to a voicemail.'
voicemail_leaving_instruction:
type: object
properties:
id:
type: string
description: "The voicemail leaving instruction prompt ID. \n\n Options: empty char - default"
example: LxC4hMD8TJeFpwRcB_QWkA
name:
type: string
description: The voicemail leaving instruction prompt name.
example: Voicemail greeting
description: "The voicemail leaving instruction prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `routing` section is set to `1` (Forward to a voicemail), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
message_greeting:
type: object
properties:
id:
type: string
description: "The message greeting prompt ID. \n\n Options: empty char - default"
example: di936zivT46YBCt3dr15GQ
name:
type: string
description: The message greeting prompt name.
example: Message greeting
description: "The message greeting prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `routing` section is set to `12` (Play a message, then disconnect). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. This field helps to ensure that missed calls do not reach to your personal voicemail. It returns for the `Forward to an external number` and `Forward to External Contacts` options.
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue) or `8`(Forward to a Shared Line Group). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is only included in the `busy_routing` section.` \n\nWhether to play callee's voicemail greeting when caller reaches end of forwarding sequence. It displays when `busy_routing` action is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number."
example: true
deprecated: true
description: "The extension's forwarding or overflow information when a call is not answered during Closed Hours. \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`."
busy_routing:
type: object
properties:
action:
type: integer
description: "The action to take when the user is busy on another call during Closed Hours: \n* `21` - Call waiting. \n* `22` - Play a busy signal. \n* `1` — Forward to a voicemail/videomail. \n* `2` - Forward to the user. \n* `4` - Forward to the common area. \n* `6` - Forward to the auto receptionist. \n* `7` - Forward to a call queue. \n* `8` - Forward to a shared line group. \n* `9` - Forward to an external contact. \n* `10` - Forward to an external number. \n* `12` — Play a message, then disconnect."
example: 1
forward_to:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: api_ta_test
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `autoReceptionist` \n* `callQueue`"
example: user
enum:
- user
- autoReceptionist
- callQueue
- commonArea
id:
type: string
description: The ID of the extension for `user`, `autoReceptionist`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
phone_number:
type: string
description: "The extension's phone number or forward to an external number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
example: '+18889843519'
description:
type: string
description: "This field forwards to an external number description. \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
example: forward to phone number +18889843519.
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Voicemail greeting
description: The voicemail greeting prompt. It returns only when the `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.
description: "The information about the call forwarding target: \n\nThis field is only available in the following scenarios: \n* Secnario 1: when `action` in the `busy_routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue), `8`(Forward to a Shared Line Group) or `9`(forward to an External Contact) for the user busy on another call, this field is used to display the extension to which the call will be forwarded. This scenario applies to `User`. \n* Secnario 2: When `action` in the `busy_routing` section is set to `10` (Forward to Phone number/External number) for the user busy on another call, this field is used to display the specific Phone number/External number to which the call will be forwarded. This scenario applies to `User`."
operator:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: user A
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `commonArea` \n* `sharedLineGroup` \n* `callQueue`"
example: user
enum:
- user
- commonArea
- sharedLineGroup
- callQueue
id:
type: string
description: The ID of the extension for `user`, `commonArea`, `sharedLineGroup`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
description: "The the operator to whom the call is being forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
connect_to_operator:
type: boolean
description: "Whether to allow callers to reach an operator. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
allow_callers_check_voicemail:
type: boolean
description: "Whether to allow the callers to check voicemails over a phone. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: b_fFF75hRgCtzG7Dw7wQgQ
name:
type: string
description: The voicemail greeting audio prompt name.
example: Greeting voicemail
description: 'The voicemail greeting audio prompt
Returns only for the `user` and `call_handling` subsetting options. It displays when the `action` in the `busy_routing` section is set to `1` - Forward to a voicemail.'
voicemail_leaving_instruction:
type: object
properties:
id:
type: string
description: "The voicemail leaving instruction prompt ID. \n\n Options: empty char - default"
example: LxC4hMD8TJeFpwRcB_QWkA
name:
type: string
description: The voicemail leaving instruction prompt name.
example: Voicemail greeting
description: "The voicemail leaving instruction prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `busy_routing` section is set to `1` (Forward to a voicemail), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n\nApplicable to the extension as shown below:\n* `User`"
message_greeting:
type: object
properties:
id:
type: string
description: "The message greeting prompt ID. \n\n Options: empty char - default"
example: di936zivT46YBCt3dr15GQ
name:
type: string
description: The message greeting prompt name.
example: Message greeting
description: "The message greeting prompt.\n\nThis field is only available in the following scenarios: \n* Secnario 1: The the `action` in the `busy_routing` section is set to `12` (Play a message, then disconnect). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. This field helps to ensure that missed calls do not reach to your personal voicemail. Returned for the `Forward to an external number` and `Forward to External Contacts` options.
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: "`Note: This field is invalid and part of incorrect documentation. It is only included in the `routing` section.` \n\nWhether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. It displays when `call_not_answer_action` is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number."
example: true
deprecated: true
play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n\nApplicable to the extension as shown below:\n* `User`"
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `action` in the `busy_routing` section is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue) or `8`(Forward to a Shared Line Group). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
description: "The extension's forwarding or overflow information when the user is busy on another call during Closed Hours. \n\nApplicable to the extension as shown below:\n* `User`."
description: The closed hours settings.
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_forwarding` \n* `call_handling`"
example: call_forwarding
enum:
- call_forwarding
- call_handling
holiday_hours:
type: array
description: The information about the holiday hours settings.
items:
type: object
properties:
details:
type: array
description: The information about the holiday call handling.
items:
type: object
properties:
settings:
type: object
properties:
allow_callers_check_voicemail:
type: boolean
description: Whether to allow the callers to check voicemails over a phone. It's required only when the `call_not_answer_action` setting is set to `1` (Forward to a voicemail).
example: true
call_forwarding_settings:
type: array
description: The call forwarding settings. It returns only for the `call_forwarding` sub-setting option.
items:
type: object
properties:
description:
type: string
description: The external phone number's description.
example: testDescription
enable:
type: boolean
description: Whether to receive a call.
example: false
id:
type: string
description: The call forwarding's ID.
example: dash32943QWfjiofejd
phone_number:
type: string
description: The external phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) format.
example: '+12058945583'
external_contact:
type: object
properties:
name:
type: string
description: The external contact's username or extension display name.
example: Johnson
email:
type: string
description: The external contact's email address.
example: example@example.com
external_contact_id:
type: string
description: The external contact's ID.
example: OJGi5xOFQPmrJbKg68-iWg
phone_numbers:
type: array
description: The external contact's phone numbers.
items:
type: string
example: '+12058945656'
call_not_answer_action:
type: integer
description: "The action to take when a call is not answered: \n* `1` — Forward to a voicemail. \n* `2` — Forward to the user. \n* `4` — Forward to the common area. \n* `6` — Forward to the auto receptionist. \n* `7` — Forward to a call queue. \n* `8` — Forward to a shared line group. \n* `9` — Forward to an external contact. \n* `10` - Forward to a phone number. \n* `11` — Disconnect. \n* `12` — Play a message, then disconnect. \n* `13` - Forward to message. \n* `14` - Forward to interactive voice response (IVR). \n\nReturned only for the `call_handling` sub-setting."
example: 2
enum:
- 1
- 2
- 4
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
connect_to_operator:
type: boolean
description: Whether to allow callers to reach an operator. It returns only when the `call_not_answer_action` setting is set to `1` (Forward to a voicemail).
example: false
from:
type: string
description: The holiday start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. It returns only for the `holiday` sub-setting.
format: date-time
example: '2022-05-01T00:00:00Z'
max_wait_time:
type: integer
description: "The maximum wait time, in seconds, for `simultaneous` ring mode or the ring duration for each device for `sequential` ring mode: \n* `10` \n* `15` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nReturned only for the `call_handling` sub-setting."
example: 60
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
name:
type: string
description: The holiday name. It returns only for the `holiday` sub-setting.
example: Labor Day
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. It returns only for the `call_forwarding` sub-setting.
example: true
ring_mode:
type: string
description: "The call handling's ring mode setting: \n* `simultaneous` \n* `sequential` \n\nReturned only for the `call_handling` sub-setting."
example: sequential
enum:
- simultaneous
- sequential
routing:
type: object
properties:
action:
type: integer
description: "The extension's forwarding or overflow information. For `call_not_answered`: \n* `1` — Forward to a voicemail/videomail. \n* `2` - Forward to the user. \n* `4` - Forward to the common area. \n* `6` - Forward to the auto receptionist. \n* `7` - Forward to a call queue. \n* `8` - Forward to a shared line group. \n* `9` - Forward to an external contact. \n* `10` - Forward to an external number. \n* `11` — Disconnect. \n* `12` — Play a message, then disconnect.\n\nFor `busy_on_another_call_action`: \n* `21` - Call waiting. \n* `22` - Play a busy signal. \n* `1` — Forward to a voicemail/videomail. \n* `2` - Forward to the user. \n* `4` - Forward to the common area. \n* `6` - Forward to the auto receptionist. \n* `7` - Forward to a call queue. \n* `8` - Forward to a shared line group. \n* `9` - Forward to an external contact. \n* `10` - Forward to an external number. \n* `12` — Play a message, then disconnect."
example: 1
forward_to:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: api_ta_test
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `autoReceptionist` \n* `callQueue`"
example: user
enum:
- user
- autoReceptionist
- callQueue
- commonArea
id:
type: string
description: The ID of the extension for `user`, `autoReceptionist`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
phone_number:
type: string
description: The extension's phone number or forward to an external number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format.
example: '+18889843519'
description:
type: string
description: This field forwards to an external number description.
example: forward to phone number +18889843519.
voicemail_greeting:
type: object
description: The voicemail greeting prompt. It returns only when `call_not_answer_action` is set to `1` (Forward to a voicemail) for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting.
description: The extension's forwarding information. It returns the response when `call_not_answer_action` or `busy_on_another_call_action` is set to `2` (Forward to the user), `4` (Forward to the common area), `6` (Forward to the auto receptionist), `7` (Forward to a call queue), `8` (Forward to a shared line group), `9` (Forward to an external contact), or `10` (Forward to an external number).
operator:
type: object
properties:
display_name:
type: string
description: The extension's name.
example: user A
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_type:
type: string
description: "The type of extension: \n* `user` \n* `commonArea` \n* `sharedLineGroup` \n* `callQueue`"
example: user
enum:
- user
- commonArea
- sharedLineGroup
- callQueue
id:
type: string
description: The ID of the extension for `user`, `commonArea`, `sharedLineGroup`, `device`, or `callQueue`.
example: DYHrdpjrS3uaOf7dPkkg8w
description: This field allows callers to reach an operator. Its a response returned when the `call_not_answer_action` or `busy_on_another_call_action` setting is set to `1` (Forward to a voicemail) and `connect_to_operator` setting is set to `true`.
connect_to_operator:
type: boolean
description: Whether to allow callers to reach an operator. It returns only for the `user` and `call_handling` subsetting. It displays when the `call_not_answer_action` setting or `busy_on_another_call_action` setting is set to `1` (Forward to a voicemail).
example: true
allow_callers_check_voicemail:
type: boolean
description: Whether to allow the callers to check voicemails over a phone. It returns only for the `user` and `call_handling` subsetting. It displays when the `call_not_answer_action` setting or `busy_on_another_call_action` setting is set to `1` (Forward to a voicemail).
example: true
voicemail_greeting:
type: object
properties:
id:
type: string
description: "The voicemail greeting audio prompt ID. \n\n Options: empty char - default"
example: '0'
name:
type: string
description: The voicemail greeting audio prompt name.
example: test
description: 'The voicemail greeting audio prompt
Returned only for the `user` and `call_handling` subsetting. It displays when `busy_on_another_call_action` action or `call_not_answer_action` set to `1` - Forward to a voicemail.'
require_press_1_before_connecting:
type: boolean
description: When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. This field helps to ensure that missed calls do not reach to your personal voicemail. Returned for the `Forward to an external number` and `Forward to External Contacts` options.
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: Whether to play callee's voicemail greeting when caller reaches end of forwarding sequence. It displays when `call_not_answer_action` is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number.
example: true
play_callee_voicemail_greeting:
type: boolean
description: Whether to play callee's voicemail greeting when caller reaches end of forwarding sequence. It displays when `busy_routing` action or `call_not_answer_action` is set to `1` - Forward to a voicemail.
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: Whether to play callee's voicemail greeting when caller reaches end of forwarding sequence. It displays when `busy_routing` action is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number.
example: true
description: The extension's forwarding or overflow information. It returns the response when `call_not_answer_action` or `busy_on_another_call_action` is set to `1` (Forward to a voicemail), `2` (Forward to the user), `4` (Forward to the common area), `6` (Forward to the auto receptionist), `7` (Forward to a call queue), `8` (Forward to a shared line group), `9` (Forward to an external contact), or `10` (Forward to an external number).
to:
type: string
description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. It returns only for the `holiday` sub-setting.
format: date-time
example: '2022-05-05T00:00:00Z'
description: The sub-setting information.
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_forwarding` \n* `call_handling` \n* `holiday`"
example: call_forwarding
enum:
- call_forwarding
- call_handling
- holiday
holiday_id:
type: string
description: The holiday's ID.
example: ewhu3i9-f3f3-fiohed
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Extension does not exist: {0}
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:read:admin
- phone:read:list_call_handling_settings:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_call_handling_settings:admin
/phone/extension/{extensionId}/call_handling/settings/{settingType}:
post:
tags:
- Call Handling
summary: Add a call handling setting
description: 'Adds Zoom Phone call handling subsettings for your phone system. Call handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, see our [API guide](https://developers.zoom.us/docs/api/phone/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).
**Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.**
**Prerequisites:**
* A Pro or higher account with Zoom Phone enabled
**Deprecation notice:** This API is planned for deprecation.
Use the resource-specific APIs instead:
* To add user call forwarding settings, use `POST /phone/users/{userId}/call_forward_settings/{hourType}`.
* To add holiday hour settings for users, use `POST /phone/users/{userId}/profile_settings/{settingType}`.
* To add holiday hour or break hour settings for common areas, use `POST /phone/common_areas/{commonAreaId}/settings/{settingType}`.
* To add holiday hour or break hour settings for auto receptionists, use `POST /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}`.
* To add holiday hour or break hour settings for call queues, use `POST /phone/call_queues/{callQueueId}/settings/{settingType}`.
* To add holiday hour or break hour settings for shared line groups, use `POST /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}`.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_handling_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: addCallHandling
parameters:
- name: extensionId
in: path
description: The extension ID.
required: true
schema:
type: string
example: nNGsNx2zRDyiIXWVI23FCQ
- name: settingType
in: path
description: "The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
required: true
schema:
type: string
example: business_hours
enum:
- business_hours
- closed_hours
- holiday_hours
requestBody:
content:
application/json:
schema:
oneOf:
- title: Call forwarding settings
type: object
properties:
settings:
type: object
properties:
holiday_id:
type: string
description: The holiday's ID. This field is only required for the `call_forwarding` sub-setting.
example: qPvrfrrcrf843cdfvbDRDg
description:
type: string
description: The external phone number's description. This field is only required for the `call_forwarding` sub-setting.
example: testDescription
phone_number:
type: string
description: The external phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164). This field is only required for the `call_forwarding` sub-setting.
example: '+12058945795'
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_forwarding`"
example: call_forwarding
enum:
- call_forwarding
- title: Holiday settings
type: object
properties:
settings:
type: object
properties:
name:
type: string
description: The name of the holiday. This field is only required for the `holiday` sub-setting.
example: test
from:
type: string
description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This field is only required for the `holiday` sub-setting.
format: date-time
example: '2022-03-05T00:00:00Z'
to:
type: string
description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. It's only required for the `holiday` sub-setting.
format: date-time
example: '2022-03-06T00:00:00Z'
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `holiday`"
example: holiday
enum:
- holiday
responses:
'201':
description: "**HTTP Status Codes** `201` \n Created."
content:
application/json:
schema:
description: sub_setting_type
oneOf:
- title: call_forwarding
type: object
properties:
call_forwarding_id:
type: string
description: The call forwarding's ID. The response only returns this value when you create a `call_forwarding` sub-setting.
example: qPvrfrrcrf843cdfvbDRDg
- title: holiday
type: object
properties:
holiday_id:
type: string
description: The holiday's ID. The response only returns this value when you create a `holiday` sub-setting.
example: fwDSdod32xmXw43rsda
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n This operation is not supported.
Request failed because the **Call Forwarding to External Numbers** feature is not enabled.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Extension does not exist: {extensionId}
Holiday does not exist.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_handling_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_handling_setting:admin
delete:
tags:
- Call Handling
summary: Delete a call handling setting
description: "Deletes 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](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.** \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone enabled\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: deleteCallHandling
parameters:
- name: extensionId
in: path
description: The extension ID.
required: true
schema:
type: string
example: nNGsNx2zRDyiIXWVI23FCQ
- name: settingType
in: path
description: "The type of call handling setting: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
required: true
schema:
type: string
example: business_hours
enum:
- business_hours
- closed_hours
- holiday_hours
- name: call_forwarding_id
in: query
description: The call forwarding's ID. Use this parameter if you pass the `call_forwarding_id` value for the `settingType` parameter.
required: false
schema:
type: string
example: qPvrfrrcrf843cdfvbDRDg
- name: holiday_id
in: query
description: The holiday's ID. Use this parameter if you pass the `holiday_id` value for the `settingType` parameter.
required: false
schema:
type: string
example: ewhu3i9-f3f3-fiohed
responses:
'204':
description: "**HTTP Status Codes** `204` \n Call handling setting successfully deleted."
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call forwarding does not exist: {callForwardingId}.
Holiday does not exist.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_handling_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_handling_setting:admin
patch:
tags:
- Call Handling
summary: Update a call handling setting
description: 'Updates a Zoom Phone call handling setting.
Call handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, read our [Call Handling API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-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
**Deprecation notice:** This API is planned for deprecation.
Use the resource-specific APIs instead:
* For user call handling settings, including user call forwarding settings, use `PATCH /phone/users/{userId}/call_handling/settings/{hourType}`.
* For common area call handling settings, use `PATCH /phone/common_areas/{commonAreaId}/call_handling/settings/{hourType}`.
* For auto receptionist call handling settings, use `PATCH /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings/{hourType}`.
* For call queue call handling settings, use `PATCH /phone/call_queues/{callQueueId}/call_handling/settings/{hourType}`.
* For shared line group call handling settings, use `PATCH /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings/{hourType}`.
* For user profile, holiday hour, custom hour, or other settings, use `PATCH /phone/users/{userId}/settings`.
* For common area holiday hour, custom hour, or other settings, use `PATCH /phone/common_areas/{commonAreaId}/settings/{settingType}`.
* For auto receptionist holiday hour, custom hour, or other settings, use `PATCH /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}`.
* For call queue holiday hour, custom hour, or other settings, use `PATCH /phone/call_queues/{callQueueId}/settings/{settingType}`.
* For shared line group holiday hour, custom hour, or other settings, use `PATCH /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}`.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_handling_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: updateCallHandling
parameters:
- name: extensionId
in: path
description: The extension ID.
required: true
schema:
type: string
example: nNGsNx2zRDyiIXWVI23FCQ
- name: settingType
in: path
description: "The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
required: true
schema:
type: string
example: closed_hours
enum:
- business_hours
- closed_hours
- holiday_hours
requestBody:
content:
application/json:
schema:
oneOf:
- title: Call forwarding settings
type: object
properties:
settings:
type: object
properties:
call_forwarding_settings:
maxItems: 10
type: array
description: The call forwarding settings. It's only required for the `call_forwarding` sub-setting.
items:
type: object
properties:
description:
type: string
description: The external phone number's description.
example: testDescription
enable:
type: boolean
description: Whether to receive a call.
example: true
id:
type: string
description: The call forwarding's ID.
example: qPvrfrrcrf843cdfvbDRDg
phone_number:
type: string
description: The external phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) format.
example: '+12058945527'
external_contact:
type: object
properties:
external_contact_id:
type: string
description: The external contact's ID. It updates the external contact's `call_forwarding` sub-setting to where the call will be forwarded.
example: OJGi5xOFQPmrJbKg68-iWg
require_press_1_before_connecting:
type: boolean
description: 'When a call is forwarded to a personal phone number, whether the user must press "1" before the call connects. Enable this option to ensure missed calls do not reach to your personal voicemail. It''s required for the `call_forwarding` sub-setting.
Press 1 is always enabled and is required for `callQueue` type extension calls.'
example: true
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_forwarding`"
example: call_forwarding
enum:
- call_forwarding
- title: Holiday settings
type: object
properties:
settings:
type: object
properties:
from:
type: string
description: The holiday's start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. It's required for the `holiday` sub-setting.
format: date-time
example: '2022-05-01T00:00:00Z'
holiday_id:
type: string
description: The holiday's ID. It's required for the `holiday` sub-setting.
example: qPvrfrrcrf843cdfvbDRDg
name:
type: string
description: The name of the holiday. It's required for the `holiday` sub-setting.
example: Default
to:
type: string
description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. It's required for the `holiday` sub-setting.
format: date-time
example: '2022-05-01T00:00:00Z'
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `holiday`"
example: holiday
enum:
- holiday
- title: Custom hours settings
type: object
properties:
settings:
type: object
properties:
allow_members_to_reset:
type: boolean
description: 'This field allows queue members to set their own business hours. This field allows queue members'' business hours to override the default hours of the call queue.
Only required for `Call Queue custom_hours` sub-setting.'
example: true
custom_hours_settings:
maxItems: 7
type: array
description: The custom hours settings. It's only required for the `custom_hours` sub-setting.
items:
type: object
properties:
from:
type: string
description: The custom hours start time `HH:mm` format.
example: 09:00
to:
type: string
description: The custom hours end time in `HH:mm` format.
example: '18:00'
type:
type: integer
description: "The type of custom hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours."
example: 1
enum:
- 0
- 1
- 2
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
type:
type: integer
description: "The type of custom hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Custom hours. \n\nThis is only required for the `custom_hours` sub-setting."
example: 2
enum:
- 1
- 2
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `custom_hours`"
example: custom_hours
enum:
- custom_hours
- title: Call handling settings
type: object
properties:
settings:
type: object
properties:
allow_callers_check_voicemail:
type: boolean
description: "Whether to allow the callers to check voicemails. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail). \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail).(Only applicable to the `User`) \n\nApplicable to the extension as shown below:\n* `User` \n* `Shared Line Group`"
example: true
allow_members_to_reset:
type: boolean
description: 'This field allows queue members to set their own business hours. This field allows queue members'' business Hours to override the default hours of the call queue.
Only required for `Call Queue custom_hours` sub-setting.'
example: true
audio_while_connecting_id:
type: string
description: 'The audio while connecting the prompt ID. This option can select the audio played for the inbound callers when they are waiting to be routed to the next available call queue member.
Options:
* empty char - default
* `ring_tone` - "Ring Tone" option
* `0` - disable
This is only required for the `Call Queue` `call_handling` sub-setting.'
example: qPwtDrrcSua8O0_n0bDRDg
call_distribution:
type: object
properties:
handle_multiple_calls:
type: boolean
description: 'The maximum number of calls that can be handled simultaneously is less than half of the total amount of available call queue members. Note that the first incoming call may not be answered first.
Required except for `simultaneous` ring mode.'
example: true
ring_duration:
type: integer
description: "The ringing duration for each member:\n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nRequired except for `simultaneous` ring mode."
example: 10
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
ring_mode:
type: string
description: "The call distribution ring mode: \n* `simultaneous` \n* `sequential` \n* `rotating` \n* `longest_idle`."
example: rotating
enum:
- simultaneous
- sequential
- rotating
- longest_idle
skip_offline_device_phone_number:
type: boolean
description: "1. Devices with Zoom app or client not launched and mobile phone with screen locked will be skipped. \n\n2. Phone numbers added to user's call handling settings will be skipped.\n\nRequired except for `simultaneous` ring mode."
example: true
description: "This option distributes incoming calls.\n\nIf `Sequential` or `Rotating` is selected, calls will ring for a specific time before trying the next available queue member. \n\nThis is only required for the `call_handling` sub-setting."
call_not_answer_action:
type: integer
description: "The action to take when a call is not answered: \n* `1` — Forward to a Voicemail. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `2` — Forward to the User. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `3` — Forward to the Zoom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `4` — Forward to the Common Area. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `5` — Forward to the Cisco/Polycom Room. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `6` — Forward to the Auto Receptionist. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `7` — Forward to a Call Queue. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `8` — Forward to a Shared Line Group. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `9` — Forward to an External Contact. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `10` - Forward to a Phone Number. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n* `11` — Disconnect. Applicable to `User`, `Call Queue`, or `Shared Line Group`. \n* `12` — Play a message, then disconnect. Applicable to `User`, `Call Queue`, `Auto Receptionist`, or `Shared Line Group` \n* `14` - Forward to an Interactive Voice Response (IVR). Applicable to `Auto Receptionist`. \n* `15` — Forward to a Partner Contact Center. Applicable to `Auto Receptionist`. \n* `18` — Forward to Microsoft Teams Resource Account. Required the license of Zoom Phone for Microsoft Teams. Applicable to `Call queue`, `Auto Receptionist`, or `Shared Line group`. \n* `19` — Forward to a Zoom Contact Center. Required Zoom Contact Center license. Applicable to `Call Queue`, `Auto Receptionist`, or `Shared Line Group`. \n\nThis is only required for the `call_handling` sub-setting."
example: 4
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 14
- 15
- 18
- 19
busy_on_another_call_action:
type: integer
description: "The action to take when the user is busy on another call: \n* `1` — Forward to a voicemail. \n* `2` — Forward to the user. \n* `4` — Forward to the common area. \n* `6` — Forward to the auto receptionist. \n* `7` — Forward to a call queue. \n* `8` — Forward to a shared line group. \n* `9` — Forward to an external contact. \n* `10` - Forward to a phone number. \n* `12` — Play a message, then disconnect. \n* `21` — Call waiting. \n* `22` — Play a busy signal. \n\nOnly required for the `call_handling` sub-setting and only the `User` supports it."
example: 4
enum:
- 1
- 2
- 4
- 6
- 7
- 8
- 9
- 10
- 12
- 21
- 22
busy_require_press_1_before_connecting:
type: boolean
description: When one is busy on another call, the receiver needs to press 1 before connecting the call for it to be forwarded to an external contact or a number. This option ensures that forwarded calls won't reach the voicemail box for the external contact or a number.
example: true
un_answered_require_press_1_before_connecting:
type: boolean
description: "When a call is unanswered, press 1 before connecting the call to forward to an external contact or a number. This option ensures that forwarded calls won't reach the voicemail box for the external contact or a number. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `9`(Forward to an External Contact) or `10`(Forward to a Phone Number). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
overflow_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` setting is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue) or `8`(Forward to a Shared Line Group). \n\nApplicable to the extension as shown below:\n* `User`"
example: true
play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of forwarding sequence. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`.(Only applicable to the `User`) \n\nApplicable to the extension as shown below:\n* `User`"
example: true
busy_play_callee_voicemail_greeting:
type: boolean
description: "Whether to play callee's voicemail greeting when the caller reaches the end of the forwarding sequence. \n\nIt displays when `busy_on_another_call_action` action is set to `2` - Forward to the user, `4` - Forward to the common area, `6` - Forward to the auto receptionist, `7` - Forward to a call queue, `8` - Forward to a shared line group, `9` - Forward to an external contact, `10` - Forward to an external number."
example: true
phone_number:
type: string
description: "The extension's phone number or forward to an external number in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `10` (Forward to a Phone Number). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
example: '+18889843519'
description:
type: string
description: "This field describes the phone number to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `10` (Forward to a Phone Number). \n\nApplicable to the extension as shown below:\n* `User`"
example: forward to phone number +18889843519.
busy_phone_number:
type: string
description: "The extension's phone number or forward to an external number in [E.164 format](https://en.wikipedia.org/wiki/E.164) format. \n\nIt sets when `busy_on_another_call_action` action is set to `10` - Forward to an external number."
example: '+18889843519'
busy_description:
type: string
description: This field forwards to an external number description (optional). It sets when `busy_on_another_call_action` action is set to `10` - Forward to an external number.
example: forward to phone number +18889843519.
connect_to_operator:
type: boolean
description: "Whether to allow callers to reach an operator. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail). \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail). \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
example: true
forward_to_extension_id:
type: string
description: "The forwarding extension ID: \n\nThis field is only available in the following scenarios: \n* Secnario 1: When `call_not_answer_action` is set to `1` (Forward to voicemail) for unanswered calls, this field is used to set the specific extension to which voicemails are forwarded. This scenario applies to `Auto Receptionist` and `Call Queue`. \n* Secnario 2: when `call_not_answer_action` setting is set to: `2`(Forward to the User), `3`(Forward to the Zoom Room), `4`(Forward to the Common Area), `5`(Forward to the Cisco/Polycom Room), `6`(Forward to the Auto Receptionist), `7`(Forward to a Call Queue), `8`(Forward to a Shared Line Group) or `9`(forward to an External Contact) for unanswered calls, this field specifies the extension to which the call will be forwarded. This scenario applies to `User`, `Auto Receptionist`, `Call Queue` and `Shared Line Group`"
example: qPvrfrrcrf843cdfvbDRDg
busy_forward_to_extension_id:
type: string
description: 'The forwarding extension ID that''s required only when busy_on_another_call_action setting is set to: 2 - Forward to the user. 4 - Forward to the common area. 6 - Forward to the auto receptionist. 7 - Forward to a call queue. 8 - Forward to a shared line group. or 9 - forward to an external contact.'
example: qPvrfrrcrf843cdfvbDRDg
greeting_prompt_id:
type: string
description: "The greeting audio prompt ID. \n\nOptions: empty char - default and `0` - disable \n\nThis is only required for the `Call Queue` or `Auto Receptionist` `call_handling` sub-setting."
example: qPwe233-f34cdfv45RDg
max_call_in_queue:
type: integer
description: 'The maximum number of calls in queue.
Specify the maximum number of callers to place in the queue. When this number is exceeded, callers will be routed based on the overflow option. Up to 60.
It''s required for the `Call Queue` `call_handling` sub-setting.'
example: 7
max_wait_time:
type: integer
description: "The maximum wait time, in seconds, for `simultaneous` ring mode or the ring duration for each device for `sequential` ring mode: \n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n\nSpecify how long a caller will wait in the queue. Once the wait time is exceeded, the caller will be rerouted based on the overflow option for `Call Queue`:\n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n* `120` \n* `180` \n* `240` \n* `300` \n* `600` \n* `900` \n* `1200` \n* `1500` \n* `1800` \n\nThis is only required for the `call_handling` sub-setting."
example: 20
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
- 600
- 900
- 1200
- 1500
- 1800
music_on_hold_id:
type: string
description: "The music on hold prompt ID. This field is an option to choose music for inbound callers when they're placed on hold by a call queue member.\n\n Options: empty char - default and `0` - disable \n\nOnly required for the `Call Queue` `call_handling` sub-setting."
example: fdsij3he89qj2-23uie
operator_extension_id:
type: string
description: "The extension ID of the operator to whom the call is being forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`. \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail) and the `connect_to_operator` is `true`.(Only applicable to the `User`) \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
example: qPvrfrrcrf843cdfvbDRDg
receive_call:
type: boolean
description: "This field receives calls while on a call. When enabled, call queue members can receive new incoming calls notification even on the call. \n\nIt's required for the `Call Queue call handling` sub-setting."
example: true
ring_mode:
type: string
description: "The call handling ring mode: \n* `simultaneous` \n* `sequential`. For user business hours, `ring_mode` needs to be set with `max_wait_time`."
example: sequential
enum:
- simultaneous
- sequential
voicemail_greeting_id:
type: string
description: "The voicemail greeting prompt ID. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail). \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail).(Only applicable to the `User`) \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
example: qPwtDrrcSua8O0_n0bDRDg
voicemail_leaving_instruction_id:
type: string
description: "The voicemail leaving instruction prompt ID. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `1` (Forward to a voicemail), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n* Secnario 2: The `busy_on_another_call_action` is set to `1` (Forward to a voicemail).(Only applicable to the `User`), and either `connect_to_operator` or `allow_callers_check_voicemail` is set to `true`. \n\nApplicable to the extension as shown below:\n* `User` \n* `Call Queue` \n* `Shared Line Group`"
example: FI1RIIUTQgiof3RKV30y8Q
message_greeting_id:
type: string
description: "The message greeting prompt ID. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `12` (Play a message, then disconnect). \n\nApplicable to the extension as shown below:\n* `User` \n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
example: ELGNz5QdR9Gt4Q8Q6zbWlQ
forward_to_zcc_phone_number:
type: string
description: "The Zoom Contact Center phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) format, to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `19` (Forward to a Zoom Contact Center). \n\nApplicable to the extension as shown below:\n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
example: '12056903036'
forward_to_partner_contact_center_id:
type: string
description: "The Partner Contact Center Setting ID to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `15` (Forward to a Partner Contact Center). \n\nApplicable to the extension as shown below:\n* `Auto Receptionist`"
example: 0Qa7FFTfR0CgzpgwUrcxtQ
forward_to_teams_id:
type: string
description: "The Microsoft Teams Voice App ID to which the call is forwarded. \n\nThis field is only available in the following scenarios: \n* Secnario 1: The `call_not_answer_action` is set to `18` (Forward to Microsoft Teams Resource Account). \n\nApplicable to the extension as shown below:\n* `Auto Receptionist` \n* `Call Queue` \n* `Shared Line Group`"
example: 8fd2159d-2495-4ec4-8101-7a182f2da802
wrap_up_time:
type: integer
description: "The wrap up time in seconds. \nSpecify the duration before the next queue call is routed to a member in call queue:\n* `0` \n* `10` \n* `15` \n* `20` \n* `25` \n* `30` \n* `35` \n* `40` \n* `45` \n* `50` \n* `55` \n* `60` \n* `120` \n* `180` \n* `240` \n* `300`\n\nThis is only required for the `call_handling` sub-setting."
example: 25
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
sub_setting_type:
type: string
description: "The type of sub-setting: \n* `call_handling`"
example: call_handling
enum:
- call_handling
responses:
'204':
description: "**HTTP Status Codes** `204` \n Call handling settings successfully updated."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Since 'Allow callers to reach an operator' and 'Allow callers to check voicemail' are disabled, you can't update the voicemail leaving instruction.
\n**Error Code:** `400`
\n The forwarding of busy on another call and the forwarding of unanswered calls are both not set to 'Forward to voicemail/videomail', so you can't update the voicemail leaving instruction.
\n**Error Code:** `400`
\n Invalid customer hours from/to time for weekday: {weekday}.
\n**Error Code:** `400`
\n Invalid holiday from/to time.
\n**Error Code:** `400`
\n Failed to overflow to an external contact since the user overflow policy is restricted.
\n**Error Code:** `400`
\n Failed to overflow to an external number since the user overflow policy is restricted.
\n**Error Code:** `400`
\n Failed to overflow to an internal extension without inbound Automatic Call Recording since the user overflow policy is restricted.
\n**Error Code:** `400`
\n Failed to overflow to an extension since the user overflow policy is disabled.
\n**Error Code:** `400`
\n The extension's voicemail policy is disabled.
\n**Error Code:** `400`
\n You cannot assign yourself as the operator.
\n**Error Code:** `400`
\n The user business hours ring mode and max wait time need to be set together.
\n**Error Code:** `405`
\n The number of items for custom_hours_settings must not exceed 7.
\n**Error Code:** `405`
\n The number of items for call_forwarding_settings must not exceed 10.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call forwarding does not exist: {callForwardingId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_handling_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_handling_setting:admin
components:
securitySchemes:
openapi_authorization:
type: apiKey
name: Authorization
in: header
openapi_oauth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /
tokenUrl: ''
refreshUrl: ''
scopes:
phone:read:admin: phone:read:admin
phone:read:list_account_settings:admin: phone:read:list_account_settings:admin
phone:write:admin: phone:write:admin
phone:write:customized_number:admin: phone:write:customized_number:admin
phone:read:list_customized_number:admin: phone:read:list_customized_number:admin
phone:delete:customized_number:admin: phone:delete:customized_number:admin
phone:write:alert_setting:admin: phone:write:alert_setting:admin
phone:read:list_alert_settings:admin: phone:read:list_alert_settings:admin
phone:read:alert_setting:admin: phone:read:alert_setting:admin
phone:patch:alert_setting:admin: phone:patch:alert_setting:admin
phone:delete:alert_setting:admin: phone:delete:alert_setting:admin
phone:read: phone:read
phone:read:audio: phone:read:audio
phone:read:audio:admin: phone:read:audio:admin
phone:write: phone:write
phone:delete:audio: phone:delete:audio
phone:delete:audio:admin: phone:delete:audio:admin
phone:update:audio: phone:update:audio
phone:update:audio:admin: phone:update:audio:admin
phone:read:list_audios: phone:read:list_audios
phone:read:list_audios:admin: phone:read:list_audios:admin
phone:write:audio: phone:write:audio
phone:write:audio:admin: phone:write:audio:admin
phone:write:batch_audios: phone:write:batch_audios
phone:write:batch_audios:admin: phone:write:batch_audios:admin
phone:read:list_auto_receptionists:admin: phone:read:list_auto_receptionists:admin
phone:write:auto_receptionist:admin: phone:write:auto_receptionist:admin
phone:delete:auto_receptionist:admin: phone:delete:auto_receptionist:admin
phone:update:auto_receptionist:admin: phone:update:auto_receptionist:admin
phone:read:auto_receptionist:admin: phone:read:auto_receptionist:admin
phone:read:auto_receptionist_call_handling_setting:admin: phone:read:auto_receptionist_call_handling_setting:admin
phone:update:auto_receptionist_call_handling_setting:admin: phone:update:auto_receptionist_call_handling_setting:admin
phone:delete:auto_receptionist_number:admin: phone:delete:auto_receptionist_number:admin
phone:write:auto_receptionist_number:admin: phone:write:auto_receptionist_number:admin
phone:update:auto_receptionist_policy:admin: phone:update:auto_receptionist_policy:admin
phone:read:auto_receptionist_policy:admin: phone:read:auto_receptionist_policy:admin
phone:delete:auto_receptionist_policy:admin: phone:delete:auto_receptionist_policy:admin
phone:write:auto_receptionist_policy:admin: phone:write:auto_receptionist_policy:admin
phone:read:auto_receptionist_setting:admin: phone:read:auto_receptionist_setting:admin
phone:write:auto_receptionist_setting:admin: phone:write:auto_receptionist_setting:admin
phone:update:auto_receptionist_setting:admin: phone:update:auto_receptionist_setting:admin
phone:delete:auto_receptionist_setting:admin: phone:delete:auto_receptionist_setting:admin
phone:read:list_billing_accounts:admin: phone:read:list_billing_accounts:admin
phone:read:billing_account:admin: phone:read:billing_account:admin
phone:write:blocked_list:admin: phone:write:blocked_list:admin
phone:read:list_blocked_lists:admin: phone:read:list_blocked_lists:admin
phone:delete:blocked_list:admin: phone:delete:blocked_list:admin
phone:read:blocked_list:admin: phone:read:blocked_list:admin
phone:update:blocked_list:admin: phone:update:blocked_list:admin
phone:read:list_call_handling_settings:admin: phone:read:list_call_handling_settings:admin
phone:update:call_handling_setting:admin: phone:update:call_handling_setting:admin
phone:delete:call_handling_setting:admin: phone:delete:call_handling_setting:admin
phone:write:call_handling_setting:admin: phone:write:call_handling_setting:admin
phone_call_log:read: phone_call_log:read
phone_call_log:read:admin: phone_call_log:read:admin
phone:read:call_log:admin: phone:read:call_log:admin
phone:read:list_call_logs:admin: phone:read:list_call_logs:admin
phone:update:call_log:admin: phone:update:call_log:admin
phone:read:ai_call_summary: phone:read:ai_call_summary
phone:read:ai_call_summary:admin: phone:read:ai_call_summary:admin
phone:read:list_call_logs: phone:read:list_call_logs
phone_call_log:write: phone_call_log:write
phone_call_log:write:admin: phone_call_log:write:admin
phone:delete:call_log: phone:delete:call_log
phone:delete:call_log:admin: phone:delete:call_log:admin
phone:read:list_call_queues:admin: phone:read:list_call_queues:admin
phone:write:call_queue:admin: phone:write:call_queue:admin
phone:delete:call_queue:admin: phone:delete:call_queue:admin
phone:update:call_queue:admin: phone:update:call_queue:admin
phone:read:call_queue:admin: phone:read:call_queue:admin
phone:read:call_queue_call_handling_setting:admin: phone:read:call_queue_call_handling_setting:admin
phone:update:call_queue_call_handling_setting:admin: phone:update:call_queue_call_handling_setting:admin
phone:read:call_queue_custom_group:admin: phone:read:call_queue_custom_group:admin
phone:write:call_queue_custom_group:admin: phone:write:call_queue_custom_group:admin
phone:update:call_queue_custom_group:admin: phone:update:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:admin: phone:delete:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:master: phone:delete:call_queue_custom_group:master
phone:master: phone:master
phone:read:call_queue_custom_group:master: phone:read:call_queue_custom_group:master
phone:write:call_queue_custom_group_member:admin: phone:write:call_queue_custom_group_member:admin
phone:delete:call_queue_custom_group_member:admin: phone:delete:call_queue_custom_group_member:admin
phone:write:call_queue_member:admin: phone:write:call_queue_member:admin
phone:delete:call_queue_member:admin: phone:delete:call_queue_member:admin
phone:read:list_call_queue_members:admin: phone:read:list_call_queue_members:admin
phone:write:call_queue_number:admin: phone:write:call_queue_number:admin
phone:delete:call_queue_number:admin: phone:delete:call_queue_number:admin
phone:read:call_queue_policy:admin: phone:read:call_queue_policy:admin
phone:update:call_queue_policy:admin: phone:update:call_queue_policy:admin
phone:write:call_queue_policy:admin: phone:write:call_queue_policy:admin
phone:delete:call_queue_policy:admin: phone:delete:call_queue_policy:admin
phone:read:list_call_queue_recordings:admin: phone:read:list_call_queue_recordings:admin
phone:read:call_queue_setting:admin: phone:read:call_queue_setting:admin
phone:write:call_queue_setting:admin: phone:write:call_queue_setting:admin
phone:delete:call_queue_setting:admin: phone:delete:call_queue_setting:admin
phone:update:call_queue_setting:admin: phone:update:call_queue_setting:admin
phone:update:carrier_number:admin: phone:update:carrier_number:admin
phone:write:carrier_number:admin: phone:write:carrier_number:admin
phone:read:list_carrier_numbers:admin: phone:read:list_carrier_numbers:admin
phone:delete:carrier_number:admin: phone:delete:carrier_number:admin
phone:write:common_area:admin: phone:write:common_area:admin
phone:read:common_area:admin: phone:read:common_area:admin
phone:read:list_common_area_activation_codes:admin: phone:read:list_common_area_activation_codes:admin
phone:write:apply_template_to_common_areas:admin: phone:write:apply_template_to_common_areas:admin
phone:delete:common_area:admin: phone:delete:common_area:admin
phone:update:common_area:admin: phone:update:common_area:admin
phone:read:common_area_call_handling_setting:admin: phone:read:common_area_call_handling_setting:admin
phone:update:common_area_call_handling_setting:admin: phone:update:common_area_call_handling_setting:admin
phone:write:common_area_calling_plan:admin: phone:write:common_area_calling_plan:admin
phone:delete:common_area_calling_plan:admin: phone:delete:common_area_calling_plan:admin
phone:write:common_area_number:admin: phone:write:common_area_number:admin
phone:delete:common_area_number:admin: phone:delete:common_area_number:admin
phone:read:list_common_area_settings:admin: phone:read:list_common_area_settings:admin
phone:update:common_area_setting:admin: phone:update:common_area_setting:admin
phone:delete:common_area_setting:admin: phone:delete:common_area_setting:admin
phone:write:common_area_setting:admin: phone:write:common_area_setting:admin
phone:read:call_qos:admin: phone:read:call_qos:admin
phone:read:default_emergency_address:admin: phone:read:default_emergency_address:admin
phone:read:detectable_personal_location:admin: phone:read:detectable_personal_location:admin
phone:read:location_sharing_permission:admin: phone:read:location_sharing_permission:admin
phone:read:nomadic_emergency_services:admin: phone:read:nomadic_emergency_services:admin
phone:read:realtime_location_devices:admin: phone:read:realtime_location_devices:admin
phone:read:realtime_location_users:admin: phone:read:realtime_location_users:admin
phone:read:list_tracked_locations:admin: phone:read:list_tracked_locations:admin
phone:update:device_line_keys: phone:update:device_line_keys
phone:update:device_line_keys:admin: phone:update:device_line_keys:admin
phone:read:device_line_keys: phone:read:device_line_keys
phone:read:device_line_keys:admin: phone:read:device_line_keys:admin
phone:delete:directory:admin: phone:delete:directory:admin
phone:read:directory:admin: phone:read:directory:admin
phone:write:directory:admin: phone:write:directory:admin
phone:write:emergency_address:admin: phone:write:emergency_address:admin
phone:read:list_emergency_addresses:admin: phone:read:list_emergency_addresses:admin
phone:read:emergency_address:admin: phone:read:emergency_address:admin
phone:delete:emergency_address:admin: phone:delete:emergency_address:admin
phone:update:emergency_address:admin: phone:update:emergency_address:admin
phone:write:batch_emergency_locations:admin: phone:write:batch_emergency_locations:admin
phone:read:list_emergency_locations:admin: phone:read:list_emergency_locations:admin
phone:write:emergency_location:admin: phone:write:emergency_location:admin
phone:read:emergency_location:admin: phone:read:emergency_location:admin
phone:update:emergency_location:admin: phone:update:emergency_location:admin
phone:delete:emergency_location:admin: phone:delete:emergency_location:admin
phone:write:external_contact:admin: phone:write:external_contact:admin
phone:read:list_external_contacts:admin: phone:read:list_external_contacts:admin
phone:delete:external_contact:admin: phone:delete:external_contact:admin
phone:read:external_contact:admin: phone:read:external_contact:admin
phone:update:external_contact:admin: phone:update:external_contact:admin
phone:write:send_fax: phone:write:send_fax
phone:write:send_fax:admin: phone:write:send_fax:admin
phone:read:list_fax_log: phone:read:list_fax_log
phone:read:list_fax_log:admin: phone:read:list_fax_log:admin
phone:read:fax_log:admin: phone:read:fax_log:admin
phone:read:fax_log: phone:read:fax_log
phone:delete:fax_log: phone:delete:fax_log
phone:delete:fax_log:admin: phone:delete:fax_log:admin
phone:read:list_firmware_update_rules:admin: phone:read:list_firmware_update_rules:admin
phone:write:firmware_update_rule:admin: phone:write:firmware_update_rule:admin
phone:delete:firmware_update_rule:admin: phone:delete:firmware_update_rule:admin
phone:update:firmware_update_rule:admin: phone:update:firmware_update_rule:admin
phone:read:firmware_update_rule:admin: phone:read:firmware_update_rule:admin
phone:read:list_firmwares:admin: phone:read:list_firmwares:admin
phone:read:list_call_pickup_groups:admin: phone:read:list_call_pickup_groups:admin
phone:write:call_pickup_group:admin: phone:write:call_pickup_group:admin
phone:read:call_pickup_group:admin: phone:read:call_pickup_group:admin
phone:update:call_pickup_group:admin: phone:update:call_pickup_group:admin
phone:delete:call_pickup_group:admin: phone:delete:call_pickup_group:admin
phone:write:call_pickup_group_member:admin: phone:write:call_pickup_group_member:admin
phone:read:call_pickup_group_member:admin: phone:read:call_pickup_group_member:admin
phone:delete:call_pickup_group_member:admin: phone:delete:call_pickup_group_member:admin
phone:update:group_policy:admin: phone:update:group_policy:admin
phone:read:group_policy:admin: phone:read:group_policy:admin
phone:read:group_setting:admin: phone:read:group_setting:admin
phone:read:auto_receptionist_ivr:admin: phone:read:auto_receptionist_ivr:admin
phone:update:auto_receptionist_ivr:admin: phone:update:auto_receptionist_ivr:admin
phone:read:list_extension_inbound_block_rules:admin: phone:read:list_extension_inbound_block_rules:admin
phone:read:list_extension_inbound_block_rules: phone:read:list_extension_inbound_block_rules
phone:delete:extension_inbound_block_rule:admin: phone:delete:extension_inbound_block_rule:admin
phone:delete:extension_inbound_block_rule: phone:delete:extension_inbound_block_rule
phone:write:extension_inbound_block_rule:admin: phone:write:extension_inbound_block_rule:admin
phone:write:extension_inbound_block_rule: phone:write:extension_inbound_block_rule
phone:delete:extension_inbound_block_rule_stat:admin: phone:delete:extension_inbound_block_rule_stat:admin
phone:read:list_extension_inbound_block_rules_stat:admin: phone:read:list_extension_inbound_block_rules_stat:admin
phone:update:inbound_blocked_for_all:admin: phone:update:inbound_blocked_for_all:admin
phone:delete:inbound_block_rule:admin: phone:delete:inbound_block_rule:admin
phone:read:list_inbound_block_rules:admin: phone:read:list_inbound_block_rules:admin
phone:write:inbound_block_rule:admin: phone:write:inbound_block_rule:admin
phone:update:inbound_block_rule:admin: phone:update:inbound_block_rule:admin
phone:update:line_keys: phone:update:line_keys
phone:update:line_keys:admin: phone:update:line_keys:admin
phone:read:line_keys: phone:read:line_keys
phone:read:line_keys:admin: phone:read:line_keys:admin
phone:delete:line_keys: phone:delete:line_keys
phone:delete:line_keys:admin: phone:delete:line_keys:admin
phone:read:list_monitoring_groups:admin: phone:read:list_monitoring_groups:admin
phone:write:monitoring_group:admin: phone:write:monitoring_group:admin
phone:delete:monitoring_group:admin: phone:delete:monitoring_group:admin
phone:update:monitoring_group:admin: phone:update:monitoring_group:admin
phone:read:monitoring_group:admin: phone:read:monitoring_group:admin
phone:read:list_monitoring_group_members:admin: phone:read:list_monitoring_group_members:admin
phone:write:monitoring_group_member:admin: phone:write:monitoring_group_member:admin
phone:delete:monitoring_group_member:admin: phone:delete:monitoring_group_member:admin
phone:read:common_area_outbound_calling_rule:admin: phone:read:common_area_outbound_calling_rule:admin
phone:update:common_area_outbound_calling_rule:admin: phone:update:common_area_outbound_calling_rule:admin
phone:write:common_area_outbound_calling_rule:admin: phone:write:common_area_outbound_calling_rule:admin
phone:delete:common_area_outbound_calling_rule:admin: phone:delete:common_area_outbound_calling_rule:admin
phone:read:list_outbound_calling_rules:admin: phone:read:list_outbound_calling_rules:admin
phone:update:outbound_calling_rule:admin: phone:update:outbound_calling_rule:admin
phone:write:outbound_calling_rule:admin: phone:write:outbound_calling_rule:admin
phone:delete:outbound_calling_rule:admin: phone:delete:outbound_calling_rule:admin
phone:update:site_outbound_calling_rule:admin: phone:update:site_outbound_calling_rule:admin
phone:read:site_outbound_calling_rule:admin: phone:read:site_outbound_calling_rule:admin
phone:write:site_outbound_calling_rule:admin: phone:write:site_outbound_calling_rule:admin
phone:delete:site_outbound_calling_rule:admin: phone:delete:site_outbound_calling_rule:admin
phone:update:user_outbound_calling_rule:admin: phone:update:user_outbound_calling_rule:admin
phone:read:user_outbound_calling_rule:admin: phone:read:user_outbound_calling_rule:admin
phone:write:user_outbound_calling_rule:admin: phone:write:user_outbound_calling_rule:admin
phone:delete:user_outbound_calling_rule:admin: phone:delete:user_outbound_calling_rule:admin
phone:read:list_devices:admin: phone:read:list_devices:admin
phone:write:device:admin: phone:write:device:admin
phone:write:sync_device:admin: phone:write:sync_device:admin
phone:update:device:admin: phone:update:device:admin
phone:delete:device:admin: phone:delete:device:admin
phone:read:device:admin: phone:read:device:admin
phone:write:device_extension:admin: phone:write:device_extension:admin
phone:delete:device_extension:admin: phone:delete:device_extension:admin
phone:update:device_provision_template:admin: phone:update:device_provision_template:admin
phone:write:reboot_device:admin: phone:write:reboot_device:admin
phone:write:byo_carrier_number:admin: phone:write:byo_carrier_number:admin
phone:delete:number:admin: phone:delete:number:admin
phone:read:list_numbers:admin: phone:read:list_numbers:admin
phone:update:site_number:admin: phone:update:site_number:admin
phone:read:numbers:admin: phone:read:numbers:admin
phone:update:number:admin: phone:update:number:admin
phone:write:user_number: phone:write:user_number
phone:write:user_number:admin: phone:write:user_number:admin
phone:delete:user_number: phone:delete:user_number
phone:delete:user_number:admin: phone:delete:user_number:admin
phone:read:list_calling_plans:admin: phone:read:list_calling_plans:admin
phone:read:list_roles:admin: phone:read:list_roles:admin
phone:write:role:admin: phone:write:role:admin
phone:update:role:admin: phone:update:role:admin
phone:read:role:admin: phone:read:role:admin
phone:delete:role:admin: phone:delete:role:admin
phone:read:role_member:admin: phone:read:role_member:admin
phone:write:role_member:admin: phone:write:role_member:admin
phone:delete:role_member:admin: phone:delete:role_member:admin
phone:write:private_directory_member:admin: phone:write:private_directory_member:admin
phone:read:list_private_directory_members:admin: phone:read:list_private_directory_members:admin
phone:update:private_directory_member:admin: phone:update:private_directory_member:admin
phone:delete:private_directory_member:admin: phone:delete:private_directory_member:admin
phone_peering:read:admin: phone_peering:read:admin
phone:read:list_peering_numbers:admin: phone:read:list_peering_numbers:admin
phone_peering:write:admin: phone_peering:write:admin
phone:write:peering_number:admin: phone:write:peering_number:admin
phone:delete:peering_number:admin: phone:delete:peering_number:admin
phone:update:peering_number:admin: phone:update:peering_number:admin
phone:write:provision_template:admin: phone:write:provision_template:admin
phone:read:list_provision_templates:admin: phone:read:list_provision_templates:admin
phone:update:provision_template:admin: phone:update:provision_template:admin
phone:read:provision_template:admin: phone:read:provision_template:admin
phone:delete:provision_template:admin: phone:delete:provision_template:admin
phone_recording:read: phone_recording:read
phone_recording:read:admin: phone_recording:read:admin
phone:read:call_recording: phone:read:call_recording
phone:read:call_recording:admin: phone:read:call_recording:admin
phone:read:recording_transcript: phone:read:recording_transcript
phone:read:recording_transcript:admin: phone:read:recording_transcript:admin
phone:read:list_call_recordings:admin: phone:read:list_call_recordings:admin
phone_recording:write: phone_recording:write
phone_recording:write:admin: phone_recording:write:admin
phone:update:call_recording: phone:update:call_recording
phone:update:call_recording:admin: phone:update:call_recording:admin
phone:delete:call_recording: phone:delete:call_recording
phone:delete:call_recording:admin: phone:delete:call_recording:admin
phone:read:list_recordings: phone:read:list_recordings
phone:read:list_recordings:admin: phone:read:list_recordings:admin
phone:read:call_charges:admin: phone:read:call_charges:admin
phone:read:fax_charges:admin: phone:read:fax_charges:admin
phone:read:operation_logs:admin: phone:read:operation_logs:admin
phone:read:sms_charges:admin: phone:read:sms_charges:admin
phone:read:list_routing_rules:admin: phone:read:list_routing_rules:admin
phone:write:routing_rule:admin: phone:write:routing_rule:admin
phone:update:routing_rule:admin: phone:update:routing_rule:admin
phone:read:routing_rule:admin: phone:read:routing_rule:admin
phone:delete:routing_rule:admin: phone:delete:routing_rule:admin
phone_sms:write: phone_sms:write
phone_sms:write:admin: phone_sms:write:admin
phone:read:sms_message: phone:read:sms_message
phone:read:sms_message:admin: phone:read:sms_message:admin
phone_sms:read: phone_sms:read
phone_sms:read:admin: phone_sms:read:admin
phone:read:list_sms_sessions: phone:read:list_sms_sessions
phone:read:list_sms_sessions:admin: phone:read:list_sms_sessions:admin
phone:read:sms_session: phone:read:sms_session
phone:read:sms_session:admin: phone:read:sms_session:admin
phone:read:list_sms_campaigns:admin: phone:read:list_sms_campaigns:admin
phone:read:sms_campaign:admin: phone:read:sms_campaign:admin
phone:write:sms_campaign_number:admin: phone:write:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status:admin: phone:read:sms_campaign_number_opt_status:admin
phone:update:sms_campaign_number_opt_status:admin: phone:update:sms_campaign_number_opt_status:admin
phone:delete:sms_campaign_number:admin: phone:delete:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status: phone:read:sms_campaign_number_opt_status
phone:read:sms_consent_number_opt_status:admin: phone:read:sms_consent_number_opt_status:admin
phone:write:setting_template:admin: phone:write:setting_template:admin
phone:read:list_setting_templates:admin: phone:read:list_setting_templates:admin
phone:update:setting_template:admin: phone:update:setting_template:admin
phone:read:setting_template:admin: phone:read:setting_template:admin
phone:update:policy:admin: phone:update:policy:admin
phone:read:policy:admin: phone:read:policy:admin
phone:read:list_ported_numbers:admin: phone:read:list_ported_numbers:admin
phone:read:ported_number:admin: phone:read:ported_number:admin
phone:update:settings:admin: phone:update:settings:admin
phone:read:settings:admin: phone:read:settings:admin
phone:read:list_sip_groups:admin: phone:read:list_sip_groups:admin
phone:read:list_sip_trunks:admin: phone:read:list_sip_trunks:admin
phone:read:list_shared_line_appearances:admin: phone:read:list_shared_line_appearances:admin
phone:read:list_shared_line_groups:admin: phone:read:list_shared_line_groups:admin
phone:write:shared_line_group:admin: phone:write:shared_line_group:admin
phone:read:shared_line_group:admin: phone:read:shared_line_group:admin
phone:read:shared_line_group_call_handling_setting:admin: phone:read:shared_line_group_call_handling_setting:admin
phone:update:shared_line_group_call_handling_setting:admin: phone:update:shared_line_group_call_handling_setting:admin
phone:read:shared_line_group_policy:admin: phone:read:shared_line_group_policy:admin
phone:update:shared_line_group_policy:admin: phone:update:shared_line_group_policy:admin
phone:read:shared_line_group_setting:admin: phone:read:shared_line_group_setting:admin
phone:update:shared_line_group_setting:admin: phone:update:shared_line_group_setting:admin
phone:delete:shared_line_group_setting:admin: phone:delete:shared_line_group_setting:admin
phone:write:shared_line_group_setting:admin: phone:write:shared_line_group_setting:admin
phone:update:shared_line_group:admin: phone:update:shared_line_group:admin
phone:delete:shared_line_group:admin: phone:delete:shared_line_group:admin
phone:delete:shared_line_member:admin: phone:delete:shared_line_member:admin
phone:write:shared_line_member:admin: phone:write:shared_line_member:admin
phone:delete:shared_line_group_number:admin: phone:delete:shared_line_group_number:admin
phone:write:shared_line_group_number:admin: phone:write:shared_line_group_number:admin
phone:delete:shared_line_group_policy:admin: phone:delete:shared_line_group_policy:admin
phone:write:shared_line_group_policy:admin: phone:write:shared_line_group_policy:admin
phone:read:list_sites:admin: phone:read:list_sites:admin
phone:write:site:admin: phone:write:site:admin
phone:read:site:admin: phone:read:site:admin
phone:delete:site:admin: phone:delete:site:admin
phone:update:site:admin: phone:update:site:admin
phone:read:list_site_customized_number:admin: phone:read:list_site_customized_number:admin
phone:delete:site_customized_number:admin: phone:delete:site_customized_number:admin
phone:write:site_customized_number:admin: phone:write:site_customized_number:admin
phone:read:site_setting:admin: phone:read:site_setting:admin
phone:write:site_setting:admin: phone:write:site_setting:admin
phone:delete:site_setting:admin: phone:delete:site_setting:admin
phone:update:site_setting:admin: phone:update:site_setting:admin
phone:read:list_users:admin: phone:read:list_users:admin
phone:write:batch_users:admin: phone:write:batch_users:admin
phone:update:batch_users:admin: phone:update:batch_users:admin
phone:read:user: phone:read:user
phone:read:user:admin: phone:read:user:admin
phone:update:user: phone:update:user
phone:update:user:admin: phone:update:user:admin
phone:delete:user_call_handling_setting: phone:delete:user_call_handling_setting
phone:delete:user_call_handling_setting:admin: phone:delete:user_call_handling_setting:admin
phone:write:user_call_handling_setting: phone:write:user_call_handling_setting
phone:write:user_call_handling_setting:admin: phone:write:user_call_handling_setting:admin
phone:read:user_call_handling_setting:admin: phone:read:user_call_handling_setting:admin
phone:read:user_call_handling_setting: phone:read:user_call_handling_setting
phone:update:user_call_handling_setting:admin: phone:update:user_call_handling_setting:admin
phone:update:user_call_handling_setting: phone:update:user_call_handling_setting
phone:write:calling_plan: phone:write:calling_plan
phone:write:calling_plan:admin: phone:write:calling_plan:admin
phone:update:calling_plan: phone:update:calling_plan
phone:update:calling_plan:admin: phone:update:calling_plan:admin
phone:delete:users_calling_plan: phone:delete:users_calling_plan
phone:delete:users_calling_plan:admin: phone:delete:users_calling_plan:admin
phone:read:list_user_customized_number: phone:read:list_user_customized_number
phone:read:list_user_customized_number:admin: phone:read:list_user_customized_number:admin
phone:write:user_customized_number: phone:write:user_customized_number
phone:write:user_customized_number:admin: phone:write:user_customized_number:admin
phone:delete:user_customized_number: phone:delete:user_customized_number
phone:delete:user_customized_number:admin: phone:delete:user_customized_number:admin
phone:update:user_policy:admin: phone:update:user_policy:admin
phone:read:user_policy:admin: phone:read:user_policy:admin
phone:delete:user_setting: phone:delete:user_setting
phone:delete:user_setting:admin: phone:delete:user_setting:admin
phone:write:user_setting:admin: phone:write:user_setting:admin
phone:write:user_setting: phone:write:user_setting
phone:read:user_setting:admin: phone:read:user_setting:admin
phone:read:user_setting: phone:read:user_setting
phone:update:user_setting: phone:update:user_setting
phone:update:user_setting:admin: phone:update:user_setting:admin
phone:update:shared_setting: phone:update:shared_setting
phone:update:shared_setting:admin: phone:update:shared_setting:admin
phone:write:shared_setting: phone:write:shared_setting
phone:write:shared_setting:admin: phone:write:shared_setting:admin
phone:delete:shared_setting: phone:delete:shared_setting
phone:delete:shared_setting:admin: phone:delete:shared_setting:admin
phone_voicemail:read: phone_voicemail:read
phone_voicemail:read:admin: phone_voicemail:read:admin
phone:read:voicemail: phone:read:voicemail
phone:read:voicemail:admin: phone:read:voicemail:admin
phone:read:list_voicemails: phone:read:list_voicemails
phone:read:list_voicemails:admin: phone:read:list_voicemails:admin
phone_voicemail:write: phone_voicemail:write
phone_voicemail:write:admin: phone_voicemail:write:admin
phone:update:voicemail: phone:update:voicemail
phone:update:voicemail:admin: phone:update:voicemail:admin
phone:delete:voicemail: phone:delete:voicemail
phone:delete:voicemail:admin: phone:delete:voicemail:admin
phone:read:list_rooms:admin: phone:read:list_rooms:admin
phone:write:room:admin: phone:write:room:admin
phone:read:room:admin: phone:read:room:admin
phone:delete:room:admin: phone:delete:room:admin
phone:update:room:admin: phone:update:room:admin
phone:write:room_calling_plan:admin: phone:write:room_calling_plan:admin
phone:delete:room_calling_plan:admin: phone:delete:room_calling_plan:admin
phone:write:room_phone_number:admin: phone:write:room_phone_number:admin
phone:delete:room_phone_number:admin: phone:delete:room_phone_number:admin
externalDocs:
description: Find out more about Swagger
url: https://swagger.io