openapi: 3.2.0 info: title: Phone Sites 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: Sites paths: /phone/sites: get: tags: - Sites summary: List phone sites description: "Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account. \n \n**Prerequisites:** \n \n* Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n* Pro or a higher account with Zoom Phone enabled.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sites:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: listPhoneSites parameters: - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 - name: next_page_token in: query description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. required: false schema: type: string example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2 - name: site_name in: query description: The name of the site you want to search. required: false schema: type: string example: Main Site responses: '200': description: OK content: application/json: schema: type: object properties: next_page_token: type: string description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: nav48KOj42vYPSG4f0cCdT575bZ980did22 page_size: type: integer description: The number of records returned within a single API call. example: 10 sites: type: array description: List of site(s). items: type: object properties: country: type: object properties: code: type: string description: The two lettered country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US name: type: string description: The name of the country. example: United States description: The country of the site. id: type: string description: The site ID is the unique identifier of the site. example: SQv52YtkRLC2dwrDdYtGsA main_auto_receptionist: type: object properties: extension_id: type: string description: The extension ID example: pl1XprjhTQK1CCMVKTqCFA extension_number: type: integer description: The extension number format: int64 example: 12345 id: type: string description: The identifier of the [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). example: Kbdc9lv_SBCuPMjj_lhxVA name: type: string description: The name of the auto receptionist. example: ApiTA_R_2020_07_12_00_41_57_145 description: The auto receptionist for each site. name: type: string description: The name of the site. example: ApiTA_Site_2020_07_12_00_41_57_141 site_code: type: integer description: The site code example: 1 total_records: type: integer description: The total number of records returned. example: 20 '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:read:admin - phone:read:list_sites:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_sites:admin post: tags: - Sites summary: Create a phone site description: "Creates a [site](https://support.zoom.us/hc/en-us/articles/360020809672) that allows you to organize the Zoom Phone users in your organization.\n\n**Prerequisites:**\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n* Pro or a higher account with Zoom Phone enabled.\n\n\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:write:site:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: createPhoneSite requestBody: content: application/json: schema: required: - auto_receptionist_name - default_emergency_address - name type: object properties: auto_receptionist_name: type: string description: The display name of the [auto-receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-) for the site. example: ApiTA_R_2020_07_12_00_41_57_145 source_auto_receptionist_id: type: string description: The ID of the [auto-receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-) that you can copy. example: 0m0dGevHR2ulyMgxFLeVEA default_emergency_address: required: - address_line1 - city - country - state_code - zip type: object properties: address_line1: type: string description: The address Line 1 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the house number and street name. example: 55 Almaden Boulevard address_line2: type: string description: The address Line 2 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the building number, floor number, unit, and others. example: 8 Floor city: type: string description: The city of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: SAN JOSE country: maxLength: 2 minLength: 2 type: string description: The two-lettered country code (Alpha-2 code in ISO-3166 format) of the site's [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: US state_code: type: string description: The state code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: CA zip: type: string description: The zip code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: '95113' description: The default emergency address. If the address provided is not an exact match, it uses the system generated corrected address. name: maxLength: 255 minLength: 1 type: string description: The name of the site. example: Main site short_extension: type: object properties: length: type: integer description: 'The length of short extension numbers for the site. Since there is a default 6-digit limit on extensions, the short extension can be two to five digits. The length of site code added to the length of short extension cannot exceed a value of `6` For example, the length of `site_code`+ length of `short_extension` should always be less than or equal to 6.' example: 4 default: 3 description: The short extension of the phone site. site_code: type: integer description: 'The identifier for a site. This field is required when the site code is enabled. ' example: 2 sip_zone: type: object properties: id: type: string description: The SIP zone ID. example: 2J9UXzGuTaqCdZ8sw_0jBw description: If the account enabled the `Display Custom SIP Zone Options on Web Portal` feature, then selecting a SIP zone nearest to your site might help reduce latency and improve call quality. force_off_net: type: object properties: enable: type: boolean description: 'By enabling Force Off-Net, calls from users or extensions between sites route through the PSTN network. Users in this site are only allowed to be part of the advanced functionality (eg. Auto Receptionists, Call Queues) configured in this site. ' example: true allow_extension_only_users_call_users_outside_site: type: boolean description: This setting allows extension only users to call to users outside the site. example: true description: 'It requires the account to enable the `Force Calls out to the PSTN network` feature. ' india_state_code: type: string description: The India site’s state code. This field only applies to India based accounts. example: CG india_city: type: string description: The India site’s city. This field only applies to India based accounts. example: Bemetara india_sdca_npa: type: string description: The India site’s Short Distance Calling Area (sdca) Numbering Plan Area (npa). This field is linked to the “state_code“ field. This field only applies to India based accounts. example: '7700' india_entity_name: type: string description: When select the Indian sip zone, then need to set the entity name. This field only applies to India based accounts. example: india-test-entity responses: '201': description: '**HTTP Status Code:** `201` **Created** Site created successfully.' content: application/json: schema: type: object properties: id: type: string description: ' The site ID is the unique identifier of a site.' example: SQv52YtkRLC2dwrDdYtGsA name: type: string description: ' The name of the site.' example: ApiTA_Site_2020_07_12_00_41_57_141 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Invalid site code length.
Country information is invalid.
This address could not be validated or geocoded.
\n**Error Code:** `400`
\n For India sites, state and city should not be empty.
\n**Error Code:** `400`
\n Short Distance Calling Area is invalid.
\n**Error Code:** `400`
\n India Entity Name is required.
\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:write:site:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:site:admin /phone/sites/{siteId}: get: tags: - Sites summary: Get phone site details description: "Returns information on a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). \n\nSites allow you to organize Zoom Phone users in your organization. \n\n**Prerequisites** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: getASite parameters: - name: siteId in: path description: The unique identifier of the site. required: true schema: type: string example: SQv52YtkRLC2dwrDdYtGsA responses: '200': description: "**HTTP Status Code:** `200` \n \nSite information retrieved successfully." content: application/json: schema: type: object properties: country: type: object properties: code: type: string description: The two lettered country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US name: type: string description: The name of the country. example: United States description: The country of the site. id: type: string description: The site ID is the unique identifier of the site. example: SQv52YtkRLC2dwrDdYtGsA main_auto_receptionist: type: object properties: extension_id: type: string description: The extension ID. example: pl1XprjhTQK1CCMVKTqCFA extension_number: type: integer description: The extension number. format: int64 example: 12345 id: type: string description: The unique identifier of the auto receptionist. example: Kbdc9lv_SBCuPMjj_lhxVA name: type: string description: The name of the auto receptionist. example: ApiTA_R_2020_07_12_00_41_57_145 description: ' The [main auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312#h_bc7ff1d5-0e6c-40cd-b889-62010cb98c57) for each site.' name: type: string description: The name of the site. example: ApiTA_Site_2020_07_12_00_41_57_141 short_extension: type: object properties: length: type: integer description: The length of the short extension number for the site. example: 3 default: 3 description: The short extension of the phone site. site_code: type: integer description: The [site code](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b). example: 321 policy: type: object properties: select_outbound_caller_id: type: object properties: enable: type: boolean description: Whether to allow the current extension to change the outbound caller ID when placing calls. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true allow_hide_outbound_caller_id: type: boolean description: Whether to allow the current extension to hide outbound caller ID. example: true description: ' Whether to allow the current extension to change the outbound caller ID when placing calls.' personal_audio_library: type: object properties: enable: type: boolean description: This field allows users to access, share, download, or delete voicemail or videomail. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true allow_music_on_hold_customization: type: boolean description: Whether to allow music on hold customization. example: true allow_voicemail_and_message_greeting_customization: type: boolean description: Whether to allow voicemail and message greeting customization. example: true description: Allows users to change their own Audio Library. voicemail: type: object properties: allow_delete: type: boolean description: This setting allows users to delete their own voicemail. It displays only when using the new policy framework. example: true allow_download: type: boolean description: This setting allows users to download their own voicemail. It displays only when using the new policy framework. example: false allow_videomail: type: boolean description: This setting allows users to access, share, download or delete video mail example: true enable: type: boolean description: This setting allows users to access, receive, or share voicemail and video mail. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true description: Allows users to access, share, download, and to delete voicemail and videomail voicemail_transcription: type: object properties: enable: type: boolean description: Whether to allow users to access transcriptions of voicemails from the Zoom client, the Zoom web portal, and email notifications. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true description: When this setting is enabled, voicemail and videomail transcriptions will be created and remain accessible even if the setting is later disabled. If the setting is disabled, new voicemail and videomail transcriptions will not be generated. voicemail_notification_by_email: type: object properties: include_voicemail_file: type: boolean description: Whether to include the voicemail file. example: true include_voicemail_transcription: type: boolean description: Whether to include the voicemail transcription. example: false forward_voicemail_to_email: type: boolean description: Whether to forward the voicemail to email. example: true enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true description: Once enabled, users receive email notifications when there is a new voicemail from users, call queues, auto receptionists, or shared line groups. Users who disabled the shared voicemail notification by email policy receive notifications. They display when the voicemail policy uses the new policy framework. shared_voicemail_notification_by_email: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Once enabled, users will receive email notification when there is a new shared voicemail/videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, users will not receive notifications. They only display when the voicemail policy uses the new policy framework. international_calling: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true description: Whether to allow extensions to place international calls outside of the calling plan. zoom_phone_on_mobile: type: object properties: allow_calling_clients: type: array description: The clients in this list are allowed to make and receive calls. items: type: string description: "The acceptable value is \nios\nandroid\nintune\nblackberry." example: ios enum: - ios - android - intune - blackberry allow_sms_mms_clients: type: array description: The clients in this list are allowed to use the SMS/MMS function. items: type: string description: "The acceptable value is \nios\nandroid\nintune\nblackberry." example: ios enum: - ios - android - intune - blackberry allow_calling_sms_mms: type: boolean description: This field allows calling and SMS/MMS functions on mobile. example: true deprecated: true enable: type: boolean description: This field allows users to use Zoom Phone on mobile clients (iOS, iPad OS and Android). example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, you can reset settings to display when using the new policy framework. example: true description: Allows user to use Zoom Phone on mobile clients (iOS, iPad OS and Android). sms: type: object properties: enable: type: boolean description: Whether to allow users, call queues, and auto receptionists to send and receive messages. You need to assign a valid calling plan and phone number to each user for them to send and receive messages. example: true international_sms: type: boolean description: Whether the user can send and receive international messages. example: true international_sms_countries: type: array description: The country to which users can send and receive international messages. The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). items: type: string description: Country example: US locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true allow_copy: type: boolean description: This field allows users to copy message. example: true allow_paste: type: boolean description: 'This field allows users to use the paste function to paste content (e.g. text or images) into SMS/MMS conversations. ' example: true description: Allows users, call queues and auto receptionists to send and receive messages. You will still need to assign a valid calling plan and phone number to each user in order for them to send and receive messages. Do not enable this control if you intend to use SMS services with a third party SMS provider. elevate_to_meeting: type: object properties: enable: type: boolean description: Whether to allow users to elevate their phone calls to a meeting. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allow users to elevate their phone calls to a meeting. hand_off_to_room: type: object properties: enable: type: boolean description: Whether to allow users to send a call to a Zoom Room. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display when using the new policy framework. example: true description: Allows users to send a call to a Zoom Room mobile_switch_to_carrier: type: object properties: enable: type: boolean description: Whether to allow the user to switch from a Zoom Phone to their native carrier. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allows user to switch from Zoom Phone to their native carrier delegation: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Whether the user can use [call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation-shared-lines-appearance-). ad_hoc_call_recording: type: object properties: enable: type: boolean description: Whether the current extension can record and save calls to the cloud. example: true recording_start_prompt: type: boolean description: Whether a prompt plays to call participants when the recording has started. example: false recording_transcription: type: boolean description: Whether the call recording transcription is enabled. example: true play_recording_beep_tone: type: object properties: enable: type: boolean description: Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework. example: true play_beep_volume: type: integer description: The side tone beep volume. It displays only when `enable` is set to `true`. example: 60 enum: - 0 - 20 - 40 - 60 - 80 - 100 play_beep_time_interval: type: integer description: The beep time interval in seconds. It displays only when `enable` is set to true. example: 15 enum: - 5 - 10 - 15 - 20 - 25 - 30 - 60 - 120 play_beep_member: type: string description: The beep sides. It displays only when `enable` is set to true. example: allMember enum: - allMember - recordingSide description: Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework. locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: A list of ad hoc call recording settings. auto_call_recording: type: object properties: allow_stop_resume_recording: type: boolean description: Whether the stop and resume of automatic call recording is enabled. example: true disconnect_on_recording_failure: type: boolean description: Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls. example: true enable: type: boolean description: Whether automatic call recording is enabled. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true recording_calls: type: string description: "The type of calls automatically recorded: \n* `inbound` \n* `outbound` \n* `both`" example: inbound enum: - inbound - outbound - both recording_explicit_consent: type: boolean description: "Whether the `Press 1 option that provides recording consent` is enabled.\n\nDeprecated: This field will be deprecated in a future release. As an alternative, use the `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` to operate inbound and outbound prompt separately.\n\nNote: \n* If customers opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent` and `inbound_audio_notification.recording_explicit_consent` will remain consistent. When the field is updated, the `inbound_audio_notification.recording_explicit_consent` will be also updated.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent. When the field is updated, the `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` will be also updated." example: true deprecated: true recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started.\n\nDeprecated: This field will be deprecated in a future release. As an alternative, use the `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` to operate inbound and outbound prompt separately.\n\nNote: \n* If customers opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt` and `inbound_audio_notification.recording_start_prompt` will remain consistent. When the field is updated, the `inbound_audio_notification.recording_start_prompt` will be also updated.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent. When the field is updated, the `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` will be also updated." example: true deprecated: true recording_transcription: type: boolean description: Whether the call recording transcription is enabled. example: true play_recording_beep_tone: type: object properties: enable: type: boolean description: Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework. example: true play_beep_volume: type: integer description: The side tone beep volume. It displays only when `enable` is set to `true`. example: 60 enum: - 0 - 20 - 40 - 60 - 80 - 100 play_beep_time_interval: type: integer description: The beep time interval in seconds. It displays only when the `enable` is set to true. example: 15 enum: - 5 - 10 - 15 - 20 - 25 - 30 - 60 - 120 play_beep_member: type: string description: The beep sides. It displays only when the `enable` is set to true. example: allMember enum: - allMember - recordingSide description: Plays the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework. inbound_audio_notification: type: object properties: recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started for inbound call is enabled.\n\nNote: \n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` with the same value." example: true recording_explicit_consent: type: boolean description: "Whether the **Press 1** option that provides recording consent for inbound call is enabled.\n\nNote: \n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` with the same value." example: true description: Whether a prompt plays to call participants when the recording has started for inbound call is enabled. outbound_audio_notification: type: object properties: recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started for outbound call is enabled.\n\nNote: \n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` with the same value." example: true recording_explicit_consent: type: boolean description: "Whether the **Press 1** option that provides recording consent for outbound call is enabled.\n\nNote: \n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent.\n* If customers do not opt for an OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` with the same value." example: true description: Whether a prompt plays to call participants when the recording has started for outbound call is enabled. description: A list of the site's automatic call recording settings. call_handling_forwarding_to_other_users: type: object properties: enable: type: boolean example: true call_forwarding_type: type: integer description: "`1` - Low restriction (external numbers not allowed)\n`2` - Medium restriction (external numbers and external contacts not allowed)\n `3` - High restriction (external numbers, external contacts and internal extensions without inbound automatic call recording not allowed)\n`4` - No restriction" example: 1 enum: - 1 - 2 - 3 - 4 locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Whether to allow users to forward their calls to other numbers. check_voicemails_over_phone: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users to modify the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Whether to allow extension owners or members of a shared line group to check voicemails for extension numbers over the phone using PIN code. call_queue_pickup_code: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: After enabling the feature, a unique pickup code generates for each queue, which can be customized in the `Call Queue` profile. Queued calls can be answered with the pickup code by the users under the same site. shared_line_group_pickup_code: type: object properties: enable: type: boolean description: By enabling the feature, a unique pickup code will be generated for each Shared Line Group which can be customized in the Shared line group profile. Shared Line Group calls can be answered with the pickup code by users at the same site. example: true description: After enabling the feature, a unique pickup code will be generated for each Shared Line Group which can be customized in the Shared line group profile. Shared Line Group calls can be answered with the pickup code by users at the same site. call_queue_opt_out_reason: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true call_queue_opt_out_reasons_list: type: array description: The opt-out reasons list items: type: object properties: code: type: string example: Break system: type: boolean description: The system default reason. It cannot be edited. example: true enable: type: boolean example: true description: The opt-out reason. description: The opt-out reasons for call queues. When enabled, call queue members need to select an opt-out reason when they turn off the `receive queue call` feature. show_user_last_transferred_call: type: boolean description: Whether to show the user who last transferred the call. Viewing preferences display on the incoming call panel. Selections made here do not affect the information shown in call logs. example: true auto_delete_data_after_retention_duration: type: object properties: enable: type: boolean description: This field allows Zoom to automatically delete data after the retention duration has lapsed. example: true reset: type: boolean description: Whether the current settings will use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: false locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been changed from inherited defaults. If true, the settings can be reset. example: true items: type: array description: The retention policy configurations for different data types. items: type: object properties: type: type: string description: The data type subject to the retention policy. example: callLog enum: - callLog - callSummary - pushToTalkLog - onDemandRecording - automaticRecording - voicemail - videomail - sms - fax duration: type: integer description: 'The retention duration. `-1` means unlimited. * When Advanced Retention is **not activated**: for `year`, the valid range is `-1` or `1-10`; for `month`, `-1` or `1-18`; for `day`, `-1` or `1-60`. * When Advanced Retention is **activated**: `time_unit` is always `day`, and the valid range is `-1` or `1-4000`. If a request supplies `year` or `month` while Advanced Retention is activated, the value is converted to `day` using `1 year = 365 day` and `1 month = 30 day`.' example: 180 time_unit: type: string description: The unit of time. When Advanced Retention is activated, the response always returns `day`. example: day enum: - year - month - day delete_type: type: integer description: "The deletion policy.\n * `1` - soft delete\n * `2` - permanent delete" example: 1 enum: - 1 - 2 permanently_delete_after_days: type: integer description: The number of days after which the data will be permanently deleted automatically. Use `-1` to retain data indefinitely. example: -1 description: 'Allows Zoom to automatically delete data after the retention duration has lapsed. **Note:** When **Advanced Retention** is activated on the account, only `day` is supported as `time_unit`. If the API request payload uses `year` or `month`, values will be converted to `day` automatically (`1 year` = `365 day`, `1 month` = `30 day`), and the response will always return `time_unit` as `day`.' call_park: type: object properties: call_not_picked_up_action: type: integer description: "The action when a parked call is not picked up. \n `100` - Ring back to parker \n`0` - Forward to voicemail of the parker \n`9` - Disconnect \n `50` - Forward to another extension" example: 50 enable: type: boolean description: Whether to allow calls placed on hold to be resumed from another location with a retrieval code. example: true expiration_period: type: integer description: A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code generates. example: 3 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 forward_to: type: object properties: display_name: type: string description: The extension's name. example: ZOOM_API Test extension_id: type: string description: The extension ID. example: TO586CYlQFC_WCUvPRXytA extension_number: type: integer description: The extension number. format: int64 example: 100014 extension_type: type: string description: "The type of extension: \n* `user` \n* `zoomRoom` \n* `commonArea`\n* `ciscoRoom/polycomRoom` \n* `autoReceptionist` \n* `sharedLineGroup` \n* `callQueue`" example: user enum: - user - zoomRoom - commonArea - ciscoRoom/polycomRoom - autoReceptionist - callQueue - sharedLineGroup id: type: string description: The ID of the extension `user`, `zoomRoom`, `commonArea`, `ciscoRoom/polycomRoom`, `autoReceptionist`, `callQueue` or `sharedLineGroup`. example: oG_nYRFuTJiY1tu0Fur_4Q description: The extension's forwarding information. sequence: type: integer description: "This field chooses how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment parks the call at the next available BLF key. Random assignment parks the call at a randomly selected BLF key. \n`0` - Random \n`1` - Sequential" example: 1 enum: - 0 - 1 locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: false locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allow calls placed on hold to be resumed from another location using a retrieval code. call_overflow: type: object properties: call_overflow_type: type: integer description: "`1` - Can forward to internal extensions and to external contacts \n`2` - Can forward only to internal extensions \n`3` - Can forward only to internal extensions that require inbound Automatic Call Recording \n`4` - Can forward to internal extensions, external contacts, and external numbers" example: 1 enum: - 1 - 2 - 3 - 4 enable: type: boolean description: Whether to allow users to forward their calls to other numbers. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allow users to forward their calls to other numbers when a call is not answered call_transferring: type: object properties: call_transferring_type: type: integer description: "1-No restriction \n2-Medium restriction (external numbers and external contacts not allowed) \n3-High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed) \n4-Low restriction (external numbers not allowed)" example: 1 enum: - 1 - 2 - 3 - 4 enable: type: boolean description: Whether to allow users to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allows user to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions. audio_intercom: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Whether to allow hands-free peer-to-peer conversations. When you receive an intercom call, the phone beeps to notify the user of the incoming intercom call, and the user's phone automatically answers the intercom call. block_calls_without_caller_id: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Whether to calls without caller ID will be blocked. block_external_calls: type: object properties: enable: type: boolean example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using old or new policy framework. example: true block_business_hours: type: boolean description: This field blocks external calls during business hours example: true block_closed_hours: type: boolean description: This field blocks external calls during closed hours example: true block_holiday_hours: type: boolean description: This field blocks external calls during holiday hours example: true block_call_action: type: integer description: The action when a call is blocked. `9` - Disconnect, `0`- Forward to voicemail or videomail. example: 0 enum: - 0 - 9 block_call_change_type: type: integer description: This setting applies only in the old policy framework. It applies changes to new extensions or all extensions. `1` - All extension, `0` - New extensions. example: 0 enum: - 0 - 1 e2e_encryption: type: object properties: enable: type: boolean description: Whether to allow users to switch their calls to `End-to-End Encryption`. If users have `Automatic Call Recording` turned on, they cannot use `End-to-End Encryption`. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Allows users to switch their calls to End-to-End Encryption description: Set rules for blocking external calls during business, closed, and holiday hours. This feature is only available for user, Zoom Room and common areas. force_off_net: type: object properties: enable: type: boolean description: By enabling Force Off-Net, calls from users or extensions between sites route through the PSTN network. Users within this site can only be part of advanced functionality (eg. Auto Receptionists, Call Queues) for this site. Users require a paid Zoom license and BYOC-P phone numbers to call between sites. example: true allow_extension_only_users_call_users_outside_site: type: boolean description: This setting allows extension only users to call to users outside the site. example: true description: 'It requires the account to enable the `Force Calls out to the PSTN network` feature. ' external_calling_on_zoom_room_common_area: type: object properties: enable: type: boolean description: This field allows Zoom Rooms to call external phone numbers based on the calling plans example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows Zoom Rooms to call external phone numbers based on the calling plans zoom_phone_on_pwa: type: object properties: allow_calling: type: boolean description: This field allows users to use calling on Zoom Progressive Web App example: true allow_sms_mms: type: boolean description: This field allows users to use SMS/MMS on Zoom Progressive Web App example: true enable: type: boolean description: This field allows users to use Zoom Phone on Zoom Progressive Web App example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to use Zoom Phone on Zoom Progressive Web App sms_auto_reply: type: object properties: enable: type: boolean description: This field enables SMS Auto Reply feature for User, Auto Receptionist, and Call Queue example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field enables SMS Auto Reply feature for User, Auto Receptionist, and Call Queue allow_end_user_edit_call_handling: type: object properties: enable: type: boolean description: This field allows users to edit call handling settings.Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to edit call handling settings.Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client. allow_caller_reach_operator: type: object properties: enable: type: boolean description: This field enables users to allow their callers to reach an operator.Once disabled, users will not be able to route their calls to an operator as part of the "When a call is not answered" setting. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field enables users to allow their callers to reach an operator.Once disabled, users will not be able to route their calls to an operator as part of the "When a call is not answered" setting. forward_call_outside_of_site: type: object properties: enable: type: boolean description: This field allows users to forward their calls outside of their own site.Once disabled, users will only be able to forward their calls to users, call queues, shared line groups, etc., within their own site. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to forward their calls outside of their own site.Once disabled, users will only be able to forward their calls to users, call queues, shared line groups, etc., within their own site. allow_mobile_home_phone_callout: type: object properties: enable: type: boolean description: This field allows users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. obfuscate_sensitive_data_during_call: type: object properties: enable: type: boolean description: Once enabled, when a user on an active call presses a dial pad key on screen or number on the keyboard, the client DTMF tones will be muted and the numbers will be masked on the screen. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Once enabled, when a user on an active call presses a dial pad key on screen or number on the keyboard, the client DTMF tones will be muted and the numbers will be masked on the screen. prevent_users_upload_audio_files: type: object properties: enable: type: boolean description: Once enabled, users will not be able to upload audios on the web portal. Users will be still able to access text-to-speech or record audio files. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: Once enabled, users will not be able to upload audios on the web portal. Users will be still able to access text-to-speech or record audio files. voicemail_tasks: type: object properties: enable: type: boolean description: This field allows users to extract tasks from English voicemail transcriptions. Users need to have voicemail transcription policy enabled. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to extract tasks from English voicemail transcriptions. Users need to have voicemail transcription policy enabled. voicemail_intent_based_prioritization: type: object properties: enable: type: boolean description: This field allows users to prioritize urgent voicemails based on predefined priority topics. Users need to have voicemail transcription policy enabled. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: This field allows users to prioritize urgent voicemails based on predefined priority topics. Users need to have voicemail transcription policy enabled. team_sms_thread_summary: type: object properties: enable: type: boolean description: This field allows users to summarize and extract tasks from English SMS conversations. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true description: 'This field allows users to summarize and extract tasks from English SMS conversations. ' display_call_feedback_survey: type: object properties: enable: type: boolean description: Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator can prohibit users from modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset and display when using the new policy framework. example: true feedback_type: type: integer description: This field allows you to display feedback survey, `1` - display for every call, `2` - display when call quality issues are detected. Default `1`, if set with value `2`, need to set `feed_back_mos` or `feedback_duration`. example: 1 enum: - 1 - 2 feedback_mos: type: object properties: enable: type: boolean description: 'Whether to display end-of-call experience feedback survey when call mos score issues are detected. ' example: true min: maximum: 4.5 minimum: 1 type: number description: 'The minimum MOS score. ' example: 1.5 max: maximum: 4.5 minimum: 1 type: number description: 'The maximum MOS score. ' example: 3.5 description: 'The MOS score. Min: 1.0, Max: 3.0, format one decimal point.' feedback_duration: type: object properties: enable: type: boolean description: 'The display end-of-call experience feedback survey when call duration issues are detected. ' example: true min: maximum: 60 minimum: 0 type: integer description: The minimum call duration. example: 0 max: maximum: 60 minimum: 0 type: integer description: 'The maximum call duration. ' example: 10 description: The call duration, in seconds, 0-60. description: Displays a thumbs up/down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong. call_live_transcription: type: object properties: enable: type: boolean description: Enables let users turn on live transcriptions for a call. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. example: true transcription_start_prompt: type: object properties: enable: type: boolean description: Enables play of a prompt to call participants when the transcription has started. example: true audio_id: type: string description: The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA audio_name: type: string description: The audio prompt file name. example: example.mp3 description: Whether to play a prompt to call participants when the transcription has started. description: Whether to let users turn on live transcriptions for a call. call_screening: type: object properties: enable: type: boolean description: Enables incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. example: true exclude_user_company_contacts: type: boolean description: Whether exclude user and company contacts from call screening, calls will reach users as normal. example: false description: Whether to incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes. sms_template: type: object properties: enable: type: boolean description: Enables the use of pre-defined templates to help users compose messages. Power Pack license is required for this feature to work. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. example: true sms_template_list: maxItems: 50 type: array description: The SMS template list. items: type: object properties: sms_template_id: type: string description: The SMS template ID. example: 0qWIP8S8QXmo6KShUIyvZA name: type: string description: The SMS template name. example: name description: type: string description: The SMS template description. example: description content: type: string description: 'Text to Display. This text will be editable by users. Customer input fields may be added by using the buttons below. Customer information will be removed if not available. ' example: content active: type: boolean description: Whether it is active. example: true description: Whether to use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work. advanced_encryption: type: object properties: enable: type: boolean description: This field allows voicemail to be encrypted with keys that are not accessible to Zoom servers. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true disable_incoming_unencrypted_voicemail: type: boolean description: Whether to disable incoming unencrypted voicemail. example: true description: Whether to allow voicemail to be encrypted with keys which are not accessible to Zoom servers. These voicemails can be decrypted only by the intended user recipient. Shared line appearance, shared line group, call queue, or auto receptionist voicemail will not be encrypted, but can still be played. Email to voicemail, transcriptions, ability to check voicemails by dialing into the voicemail system, or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user does who inherits this policy does not have a Power Pack license, the policy will not be applied. customize_line_name: type: object properties: enable: type: boolean description: Enables the line name template to be applied to all the desk phones on your account. Make sure there is enough space on the desk phone to display the line name. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true user_line_name: type: string description: The user line name. example: phoneNumber enum: - phoneNumber - extensionNumber - displayName - displayName;extensionNumber - firstName;extensionNumber - firstName;lastName;extensionNumber common_area_line_name: type: string description: The common area line name. example: phoneNumber enum: - phoneNumber - extensionNumber - displayName - displayName;extensionNumber description: Whether to enable the line name template to be applied to all the desk phones on your account. Make sure there is enough space on the desk phone to display the line name. auto_opt_out_in_call_queue: type: object properties: enable: type: boolean description: Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true prompt_before_opt_out_call_queue: type: boolean description: Once enabled, always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom. example: true description: Whether to enable auto Opt-out from Call Queue after logging out from Zoom. incoming_call_notification: type: object properties: enable: type: boolean description: This field allows users to select if an incoming call notification would block their current activity. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true block_type: type: string description: The incoming call notification block type. `block_activity` means "Block my current activity", `continue_with_alert` means "Alert me but allow me to continue my current activity". example: block_activity enum: - block_activity - continue_with_alert description: Allows users to select if an incoming call notification would block their current activity. call_summary: type: object properties: enable: type: boolean description: This field allows users to generate a summary of a phone call. For users who enable Call summary during a call, a summary will be automatically sent to them on the client and the web portal after the call has ended. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true auto_call_summary: type: boolean description: This field enables automatic call summary. example: true call_summary_start_prompt: type: object properties: enable: type: boolean description: Whether to play a prompt to call participant when call summary has started. example: true audio_id: type: string description: The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA audio_name: type: string description: The audio prompt file name. example: example.mp3 description: Whether to play a prompt to call participant when call summary has started. description: Allows users to generate a summary of a phone call. For users who enable Call summary during a call, a summary will be automatically sent to them on the client and the web portal after the call has ended. It requires the account to enable the `Enable Phone Call Summary` feature. schedule_firmware_update: type: object properties: enable: type: boolean description: Whether to define how often and when to update firmware of the devices. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: account enum: - invalid - account modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework). example: true repeat_type: type: string description: The repeat type. example: weekly enum: - weekly - monthly repeat_setting: description: The repeat setting oneOf: - title: weekly setting type: object properties: weekly_setting: type: object properties: weekday: type: string description: The day of the week. example: monday default: monday enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: The weekly setting. description: The weekly setting. It only returns when `repeat_type` is `weekly`. - title: monthly setting description: The monthly setting. Only return when `repeat_type` is `monthly` oneOf: - title: by week and day type: object properties: week_and_day: type: object properties: week_of_month: maximum: 4 minimum: 1 type: integer description: Which week of the month to perform updates example: 1 weekday: type: string description: The day of the selected week to perform updates example: monday default: monday enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: Repeat by week and day description: Repeat by week and day - title: by specific date type: object properties: specific_date: type: object properties: day_of_month: maximum: 31 minimum: 0 type: integer description: The specific day of the month for updates. `0` means "Last day" example: 10 description: Repeat by specific date description: Repeat by specific date time_period_start: maximum: 23 minimum: 0 type: integer description: The time period start time. 15 means 3 PM. example: 15 time_period_end: maximum: 23 minimum: 0 type: integer description: The time period end time. 16 means 4 PM. example: 16 time_zone: type: string description: The [time zone list](https://developer.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats. example: Asia/Shanghai end_setting: type: object properties: never_end: type: boolean description: Never ends. example: true end_date: type: string description: 'The end date in the format \"yyyy-MM-dd\". Only return when `never_end` is false. ' format: date example: '2025-01-01' description: The end setting. description: Defines how often and when to update firmware of the devices. zoom_phone_on_desktop: type: object properties: allow_calling_clients: type: array description: The clients in this list are allowed to make and receive calls. items: type: string description: "The acceptable value is \nmac_os\nwindows\nvdi_client\nlinux." example: mac_os enum: - mac_os - windows - vdi_client - linux allow_sms_mms_clients: type: array description: The clients in this list are allowed to use the SMS/MMS function. items: type: string description: "The acceptable value is \nmac_os\nwindows\nvdi_client\nlinux." example: mac_os enum: - mac_os - windows - vdi_client - linux enable: type: boolean description: Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI clinet and Linux). example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits the modification of the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, you can reset settings to display when using the new policy framework. example: true description: Allows user to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux). manage_call_routing_for_unassigned_numbers: type: object properties: enable: type: boolean description: Whether to enable call routing for unassigned numbers. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: false locked_by: type: string description: Which level has locked this setting. example: account enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been changed from inherited defaults. If true, the settings can be reset. example: true incoming_call_action: type: string description: The routing action for incoming calls to unassigned numbers. - Disconnect the call. - Play a message and then disconnect. - Forward the call to another extension. example: disconnect enum: - disconnect - play_message_then_disconnect - forward_to_another_extension incoming_call_routing_setting: description: The routing setting. Only returns when is not . oneOf: - title: Play a Message then Disconnect type: object properties: audio_id: type: string description: The audio prompt file ID. example: yCT14TwySDGVUypVlKNEyA audio_name: type: string description: The audio prompt file name. example: routing-message.mp3 description: The routing setting. Only returns when is . - title: Forward to Another Extension type: object properties: forward_extension_id: type: string description: The ID of the extension to forward calls to. example: jN9mb38lQTaMgxUq3Nd6ow forward_extension_type: type: string description: The type of the extension to forward calls to. example: user enum: - user - callQueue - autoReceptionist - commonArea - sharedLineGroup - zoomRoom - ciscoRoom/PolycomRoom forward_extension_name: type: string description: The display name of the extension to forward calls to. example: user A forward_extension_number: type: integer description: The extension number of the extension to forward calls to. format: int64 example: 101014 description: The routing setting. Only returns when is . description: Allows calls to numbers not assigned to an extension to be handled according to the configured settings. This applies to calls originating both inside and outside the account. show_custom_disclaimer_when_using_zoom_phone: type: object properties: enable: type: boolean description: Whether this policy is enabled. example: false locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: false locked_by: type: string description: The level of administrator that restricts modification of the current settings. example: account enum: - invalid - account - site display_frequency: type: string description: The display frequency. example: first_time_only enum: - first_time_only - every_time - every_month - every_quarter - every_6_months - every_year custom_disclaimer_list: type: array description: The list of custom disclaimers. items: type: object properties: language: type: string description: "The audio prompt language code. \n\nEnglish: `en` \n\nDeutsch: `de` \n\nEspañol: `es` \n\nFrançais: `fr` \n\nItaliano: `it` \n\nNederlands: `nl` \n\nPortuguês: `pt` \n\nJapanese: `ja` \n\nKorean: `ko` \n\nChinese: `zh-cn` \n\nTaiwanese: `zh-tw` \n\nNorsk: `no` \n\nРусский: `ru` \n\nBahasa Melayu: `ms` \n\nTiếng Việt: `vi` \n\nУкраїнська: `uk` \n\nBahasa Indonesia: `id` \n\nPolski: `pl` \n\nTürkçe: `tr` " example: en enum: - en - de - es - fr - it - nl - pt - ja - ko - zh-cn - zh-tw - 'no' - ru - ms - vi - uk - id - pl - tr title: maxLength: 60 type: string description: The custom disclaimer title. example: tilte body: maxLength: 500 type: string description: The custom disclaimer body. example: body default: type: boolean description: Whether this language is the default disclaimer. Participants using languages not configured in this list will see the disclaimer marked as default. **Exactly one item in the list must have `default` set to `true`** when the list is non-empty. example: true description: Whether to show a custom disclaimer when starting to use the Zoom Phone service. description: The [site policy setting](https://support.zoom.us/hc/en-us/articles/360033511872-Changing-Zoom-Phone-policy-settings#h_af4d1935-9cb1-44d2-9a10-9bfba10d58a7). sip_zone: type: object properties: id: type: string description: The SIP Zone ID. example: 2J9UXzGuTaqCdZ8sw_0jBw name: type: string description: The SIP Zone name. example: sip-zone01 description: When you select a SIP zone nearest to your site, it might help reduce latency and improve call quality. caller_id_name: type: string description: When you place an outbound call with a number as the caller ID, the caller ID name and the number display to the called party. The caller ID name can be up to 15 characters. example: CallerIdName india_state_code: type: string description: The India site’s state code. This field only applies to India based accounts. example: CG india_city: type: string description: The India site’s city. This field only applies to India based accounts. example: Bemetara india_sdca_npa: type: string description: The India site’s Short Distance Calling Area (sdca) Numbering Plan Area (npa). This field is linked to the “state_code“ field. This field only applies to India based accounts. example: '7700' india_entity_name: type: string description: When select the Indian sip zone, then need to set the entity name. This field only applies to India based accounts. example: india-test-entity default_emergency_address: type: object properties: address_line1: type: string description: The emergency address line 1. example: 55 ALMADEN BLVD address_line2: type: string description: The emergency address line 2. example: 8 Floor city: type: string description: The emergency address city. example: San Jose country: type: string description: The emergency address country. example: US id: type: string description: The emergency address ID. example: Qza2T_KATwCeUfTkzGsOmQ is_default: type: boolean description: Whether the emergency address is default or not. example: true level: type: integer description: "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address." example: 1 enum: - 0 - 1 - 2 state_code: type: string description: The emergency address state code. example: CA status: type: integer description: "The emergency address verification status: \n* `1` — Verification not required. \n* `2` — Unverified. \n* `3` — Verification requested. \n* `4` — Verified. \n* `5` — Rejected. \n* `6` — Verification failed." example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 zip: type: string description: The emergency address zip code. example: '95113' description: The site's emergency address. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n The site 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:read:admin - phone:read:site:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:site:admin delete: tags: - Sites summary: Delete a phone site description: " Use this API to delete a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) in a Zoom account. To delete a site, in the query parameter, you must provide the site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license. \n* [Multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) must be enabled.\n\n\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:site:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: deletePhoneSite parameters: - name: siteId in: path description: The unique identifier of the site. required: true schema: type: string example: SQv52YtkRLC2dwrDdYtGsA - name: transfer_site_id in: query description: The site ID of another site where the assets of the current site (users, numbers and phones) can be transferred. required: true schema: type: string example: 8f71O6rWT8KFUGQmJIFAdQ responses: '204': description: "**HTTP Status Code:** `204` \n \nSite deleted." '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `400`
\nUnable to transfer to the same site.
\nMain company number can not change {phoneNumber}.
\nSite does not exist.\n\n" '409': description: "**HTTP Status Code:** `409`
\n Conflict\n\n**Error Code:** `409`
\nConflict target extension number, try later.\n\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:site:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:site:admin patch: tags: - Sites summary: Update phone site details description: "Updates information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). \n\nIt allows you to organize Zoom Phone users in your organization. \n\n\n**Prerequisites** \nAn account must have a Pro or a higher plan with Zoom Phone license.\n\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:update:site:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: updateSiteDetails parameters: - name: siteId in: path description: The unique identifier of the site. required: true schema: type: string example: NjHmTu16Qfe8yOiNJuekXA requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the site. example: The SJ site site_code: type: integer description: The [site code](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b). example: 2341 short_extension: type: object properties: length: type: integer description: This setting specifies the length of short extension numbers for the site. example: 3 ranges: maxItems: 10 type: array description: The range list. After adding a short extension range, the newly assigned extension numbers start from the `range_from` value. items: type: object properties: range_from: type: string description: The short extension's starting range number, which can be a non-negative value. This value **must** be less than the `range_to` value. example: '123' range_to: type: string description: The short extension's ending range number, which can be a non-negative value. This value **cannot** be less than or equal to the `range_from` value. example: '456' description: items description: The short extension of the phone site. default_emergency_address: required: - address_line1 - city - country - state_code - zip type: object properties: address_line1: type: string description: The address Line 1 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the house number and street name. example: 55 Almaden Blvd address_line2: type: string description: The address Line 2 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the building number, floor number, unit, and others example: Test 3 city: type: string description: The city of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: San Jose country: maxLength: 2 minLength: 2 type: string description: The two-lettered country code (Aplha-2 code in ISO-3166 format) of the site's [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: US state_code: type: string description: The state code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: CA zip: type: string description: The zip code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address). example: '95113' description: The default emergency address. If the address is not an exact match, we use the system generated corrected address. sip_zone: type: object properties: id: type: string description: The SIP zone ID. example: 2J9UXzGuTaqCdZ8sw_0jBw description: If the account enabled the `Display Custom SIP Zone Options on Web Portal` feature, then selecting a SIP zone nearest to your site helps reduce latency and improve call quality. caller_id_name: type: string description: When an outbound call uses a number as the caller ID, the caller ID name and the number display to the called party. The caller ID name can be up to 15 characters. The user can reset the caller ID name by setting it to "". example: CallerIdName policy: type: object properties: select_outbound_caller_id: type: object properties: enable: type: boolean description: Whether to allow the current extension to change the outbound caller ID when placing calls. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true allow_hide_outbound_caller_id: type: boolean description: Whether to allow the current extension to hide outbound caller ID. example: true description: Whether to allow the current extension to change the outbound caller ID when placing calls. personal_audio_library: type: object properties: enable: type: boolean description: This setting allows users to access, share, download, or delete voicemail or videomail. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true allow_music_on_hold_customization: type: boolean description: Whether to allow music on hold customization. example: true allow_voicemail_and_message_greeting_customization: type: boolean description: Whether to allow voicemail and message greeting customization. example: true description: Allows users to change their own Audio Library. voicemail: type: object properties: allow_delete: type: boolean description: This setting allows users to delete their own voicemail. It displays only when using the new policy framework. example: true allow_download: type: boolean description: This setting allows users to download their own voicemail. It displays only when using the new policy framework. example: false allow_videomail: type: boolean description: Whether to allow users to access, share, download, or delete the videomail example: true enable: type: boolean description: Whether to allow users to access, receive, or share voicemail and videomail. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to access, share, download, and to delete voicemail and videomail. voicemail_transcription: type: object properties: enable: type: boolean description: Whether to allow users to access transcriptions of voicemails from the Zoom client, Zoom web portal, and email notifications. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: When you enable this setting, the system creates voicemail and videomail transcriptions and keeps them accessible, even if you disable the setting later. When you disable the setting, the system stops generating new transcriptions. voicemail_notification_by_email: type: object properties: include_voicemail_file: type: boolean description: Whether to include the voicemail file. example: true include_voicemail_transcription: type: boolean description: Whether to include the voicemail transcription. example: false forward_voicemail_to_email: type: boolean description: Whether to forward the voicemail to email. example: true enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Once enabled, users receive email notifications when there is a new voicemail from users, call queues, auto receptionists, or shared line groups. Users who disabled the shared voicemail notification by email policy will not receive notifications. This setting only displays when the voicemail policy uses the new policy framework. shared_voicemail_notification_by_email: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Once enabled, users receive email notification when there is a new shared voicemail or videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, users will not receive notifications. This setting only displays when the voicemail policy uses the new policy framework. international_calling: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether to allow extensions to place international calls outside of the calling plan. zoom_phone_on_mobile: type: object properties: allow_calling_sms_mms: type: boolean description: Whether to allow calling and SMS/MMS functions on mobile. example: true deprecated: true enable: type: boolean description: Whether to allow users to use Zoom Phone on mobile clients (iOS, iPad OS and Android). example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true allow_calling_clients: maxItems: 10 type: array description: The clients in this list are allowed to make and receive calls. items: type: string description: "The acceptable value is \nios\nandroid\nintune\nblackberry." example: ios enum: - ios - android - intune - blackberry allow_sms_mms_clients: maxItems: 10 type: array description: The clients in this list are allowed to use the SMS/MMS function. items: type: string description: "The acceptable value is \nios\nandroid\nintune\nblackberry." example: ios enum: - ios - android - intune - blackberry description: Allows users to use Zoom Phone on mobile clients (iOS, iPad OS and Android). sms: type: object properties: enable: type: boolean description: Whether to allow users, call queues, and auto receptionists to send and receive messages. You need to assign a valid calling plan and phone number to each user for them to send and receive messages. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true international_sms: type: boolean description: Whether the user can send and receive international messages. example: true international_sms_countries: maxItems: 200 type: array description: The country which users can send and receive international messages. The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). items: type: string description: 'Country ISO code ' example: US allow_copy: type: boolean description: This field allows users to copy messages. example: true allow_paste: type: boolean description: 'This field allows users to use the paste function to paste content (e.g. text or images) into SMS/MMS conversations. ' example: true description: Allows users, call queues, and auto receptionists to send and receive messages. You will still need to assign a valid calling plan and phone number to each user in order for them to send and receive messages. Do not enable this control if you intend to use SMS services with a third party SMS provider. elevate_to_meeting: type: object properties: enable: type: boolean description: Whether to allow users to elevate their phone calls to a meeting. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to elevate their phone calls to a meeting. hand_off_to_room: type: object properties: enable: type: boolean description: Whether to allow users to send a call to a Zoom Room. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to send a call to a Zoom Room. mobile_switch_to_carrier: type: object properties: enable: type: boolean description: Whether to allow the user to switch from a Zoom Phone to their native carrier. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to switch from Zoom Phone to their native carrier. delegation: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether the user can use [call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation-shared-lines-appearance-). ad_hoc_call_recording: type: object properties: enable: type: boolean description: Whether the current extension can record and save calls to the cloud. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true recording_start_prompt: type: boolean description: Whether a prompt plays to call participants when the recording has started. example: false recording_transcription: type: boolean description: Whether call recording transcription is enabled. example: true play_recording_beep_tone: type: object properties: enable: type: boolean description: Whether to play a side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework. example: true play_beep_volume: type: integer description: The volume of the side tone beep. It displays only when `enable` is set to `true`. example: 60 enum: - 0 - 20 - 40 - 60 - 80 - 100 play_beep_time_interval: type: integer description: The beep time interval in seconds. It displays only when `enable` is true. example: 15 enum: - 5 - 10 - 15 - 20 - 25 - 30 - 60 - 120 play_beep_member: type: string description: The beep sides. It displays only when `enable` is true. example: allMember enum: - allMember - recordingSide description: Whether to play the side tone beep for recorded users while recording. description: A list of ad hoc call recording settings. auto_call_recording: type: object properties: allow_stop_resume_recording: type: boolean description: Whether the stop and resume of automatic call recording is enabled. example: true disconnect_on_recording_failure: type: boolean description: Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls. example: true enable: type: boolean description: Whether automatic call recording is enabled. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true recording_calls: type: string description: "The type of calls automatically recorded: \n* `inbound` \n* `outbound` \n* `both`" example: inbound enum: - inbound - outbound - both recording_explicit_consent: type: boolean description: "Whether the `Press 1 to provide recording consent` is enabled.\n\nDeprecated: This field will be deprecated in a future release. As an alternative, use the `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` to operate the inbound and outbound prompt separately.\n\nNote: \n* if customers who opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent` and `inbound_audio_notification.recording_explicit_consent` will remain consistent. When the field is updated, the `inbound_audio_notification.recording_explicit_consent` will be also updated.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent. when the field is updated, the `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` will be also updated." example: true deprecated: true recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started.\n\nDeprecated: This field will be deprecated in a future release. As an alternative, use the `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` to operate the inbound and outbound prompt separately.\n\nNote: \n* if customers who opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt` and `inbound_audio_notification.recording_start_prompt` will remain consistent. When the field is updated, the `inbound_audio_notification.recording_start_prompt` will be also updated.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent. when the field is updated, the `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` will be also updated." example: true deprecated: true recording_transcription: type: boolean description: Whether call recording transcription is enabled. example: true play_recording_beep_tone: type: object properties: enable: type: boolean description: Whether to play a side tone beep for recorded users while recording. It only displays when auto call recording policy uses the new framework. example: true play_beep_volume: type: integer description: The volume of the side tone beep. It displays only when `enable` is set to `true`. example: 60 enum: - 0 - 20 - 40 - 60 - 80 - 100 play_beep_time_interval: type: integer description: The beep time interval in seconds. It displays only when `enable` is true. example: 15 enum: - 5 - 10 - 15 - 20 - 25 - 30 - 60 - 120 play_beep_member: type: string description: The beep sides. It displays only when `enable` is true. example: allMember enum: - allMember - recordingSide description: Whether to play the side tone beep for recorded users while recording. inbound_audio_notification: type: object properties: recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started for inbound call is enabled.\n\nNote: \n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` with the same value." example: true recording_explicit_consent: type: boolean description: "Whether the **Press 1** option that provides recording consent for inbound call is enabled.\n\nNote: \n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` with the same value." example: true description: Whether a prompt plays to call participants when the recording has started for inbound call is enabled. outbound_audio_notification: type: object properties: recording_start_prompt: type: boolean description: "Whether a prompt plays to call participants when the recording has started for outbound call is enabled.\n\nNote: \n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_start_prompt`, `inbound_audio_notification.recording_start_prompt`, and `outbound_audio_notification.recording_start_prompt` always remain consistent.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_start_prompt` and `outbound_audio_notification.recording_start_prompt` with the same value." example: true recording_explicit_consent: type: boolean description: "Whether the **Press 1** option that provides recording consent for outbound call is enabled.\n\nNote: \n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, the values of `recording_explicit_consent`, `inbound_audio_notification.recording_explicit_consent`, and `outbound_audio_notification.recording_explicit_consent` always remain consistent.\n* if customers who do not opt OP flag named `Enable Caller Based Consent Options`, update both `inbound_audio_notification.recording_explicit_consent` and `outbound_audio_notification.recording_explicit_consent` with the same value." example: true description: Whether a prompt plays to call participants when the recording has started for outbound call is enabled. description: A list of the site's automatic call recording settings. call_handling_forwarding_to_other_users: type: object properties: enable: type: boolean example: true call_forwarding_type: type: integer description: "`1` - Low restriction (external numbers not allowed)\n`2` - Medium restriction (external numbers and external contacts not allowed)\n `3` - High restriction (external numbers, external contacts and internal extensions without inbound automatic call recording not allowed)\n`4` - No restriction" example: 1 enum: - 1 - 2 - 3 - 4 reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether to allow users to forward their calls to other numbers. check_voicemails_over_phone: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether to allow extension owners or members of a shared line group to check voicemails for extension numbers over the phone using the PIN code. call_queue_pickup_code: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: After enabling the feature, a unique pickup code generates for each queue. It can be customized in the Call Queue profile. Queue calls can be answered with the pickup code by the users under the same site. shared_line_group_pickup_code: type: object properties: enable: type: boolean description: By enabling the feature, a unique pickup code is generated for each Shared Line Group which can be customized in the Shared line group profile. Shared Line Group calls can be answered with the pickup code by users at the same site. example: true description: After enabling the feature, a unique pickup code will be generated for each Shared Line Group which can be customized in the Shared line group profile. Shared Line Group calls can be answered with the pickup code by users at the same site. call_queue_opt_out_reason: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true call_queue_opt_out_reasons_list: maxItems: 30 type: array description: The reason list. items: type: object properties: code: type: string description: The opt out code. example: Break system: type: boolean description: The reason for the system default. It cannot be edited. example: true enable: type: boolean example: true description: item description: The opt-out reasons for call queues. When enabled, call queue members need to select an opt-out reason when they turn off the `receive queue call` feature. show_user_last_transferred_call: type: boolean description: Whether to show the user who last transferred the call. Viewing preferences display on the incoming call panel. Selections made here will not affect the information shown in call logs. example: true auto_delete_data_after_retention_duration: type: object properties: enable: type: boolean description: This setting allows Zoom to automatically delete data after the retention duration has lapsed. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true items: maxItems: 15 type: array description: The retention policy configurations for different data types. items: type: object properties: type: type: string description: The data type subject to the retention policy. example: callLog enum: - callLog - callSummary - pushToTalkLog - onDemandRecording - automaticRecording - voicemail - videomail - sms - fax duration: type: integer description: 'The retention duration. `-1` means unlimited. * When Advanced Retention is **not activated**: for `year`, the valid range is `-1` or `1-10`; for `month`, `-1` or `1-18`; for `day`, `-1` or `1-60`. * When Advanced Retention is **activated**: `time_unit` should be `day`, with a valid range of `-1` or `1-4000`. If `year` or `month` is supplied, the value is converted to `day` (`1 year = 365 day`, `1 month = 30 day`).' example: 180 time_unit: type: string description: The unit of time. When Advanced Retention is activated, only `day` is honored; `year` and `month` are automatically converted to `day` upon persistence. example: day enum: - year - month - day delete_type: type: integer description: "The deletion policy.\n * `1` - soft delete\n * `2` - permanent delete" example: 1 enum: - 1 - 2 permanently_delete_after_days: type: integer description: The number of days after which the data will be permanently deleted automatically. Use `-1` to retain data indefinitely. example: -1 description: "Allows Zoom to automatically delete data after the retention duration has lapsed. \n\n**Time unit behavior:**\n* When **Advanced Retention** is **not activated**, `time_unit` accepts `year`, `month`, or `day`.\n* When **Advanced Retention** is **activated**, only `day` is supported in the Zoom Web Portal. For API backward compatibility, `year` and `month` are still accepted in the request payload and will be converted to `day` before persistence:\n * `1 year` = `365 day`\n * `1 month` = `30 day`\n \n It is recommended to send `day` directly to avoid implicit conversion." call_park: type: object properties: call_not_picked_up_action: type: integer description: "The action when a parked call is not picked up. \n `100` - Ring back to parker \n`0` - Forward to voicemail of the parker \n`9` - Disconnect \n `50` - Forward to another extension" example: 50 enable: type: boolean description: Whether to allow calls on hold to be resumed from another location with a retrieval code. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true expiration_period: type: integer description: A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code generates. example: 3 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 forward_to_extension_id: type: string description: The extension's forwarding information when `call_not_picked_up_action` uses the `50` - Forward to another extension. example: TO586CYlQFC_WCUvPRXytA sequence: type: integer description: " This field chooses how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment parks the call at the next available BLF key. Random assignment parks the call at a randomly selected BLF key. \n`0` - Random \n`1` - Sequential" example: 1 enum: - 0 - 1 description: Allows calls placed on hold to be resumed from another location using a retrieval code. call_overflow: type: object properties: call_overflow_type: type: integer description: "`1` - Can forward to internal extensions and to external contacts \n`2` - Can forward only to internal extensions\n`3` - Can forward only to internal extensions that require inbound Automatic Call Recording \n`4` - Can forward to internal extensions, external contacts, and external numbers" example: 1 enum: - 1 - 2 - 3 - 4 enable: type: boolean description: Whether to allow users to forward their calls to other numbers. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to forward their calls to other numbers when a call is not answered. call_transferring: type: object properties: call_transferring_type: type: integer description: "1-No restriction \n2-Medium restriction (external numbers and external contacts not allowed) \n3-High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed) \n4-Low restriction (external numbers not allowed)" example: 1 enum: - 1 - 2 - 3 - 4 enable: type: boolean description: Whether to allow users to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Allows users to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions. audio_intercom: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether to allow hands-free peer-to-peer conversations. When an intercom call is received, the phone beeps to notify the user of the incoming intercom call, and the user's phone automatically answers the intercom call. block_calls_without_caller_id: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Whether calls without a caller ID are blocked. block_external_calls: type: object properties: enable: type: boolean example: true reset: type: boolean description: Whether the current settings use the phone account's settings, which are compatible with the old or new policy frameworks. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true block_business_hours: type: boolean description: The field blocks external calls during business hours. example: true block_closed_hours: type: boolean description: This field blocks external calls during closed hours example: true block_holiday_hours: type: boolean description: The field blocks external calls during holiday hours. example: true block_call_action: type: integer description: The action when a call is blocked. 9-Disconnect, 0-Forward to voicemail/videomail. example: 0 enum: - 0 - 9 block_call_change_type: type: integer description: This setting applies only in the old policy framework. It applies changes to new extensions or all extensions. `1` - All extension, `0` - New extensions. example: 0 enum: - 0 - 1 e2e_encryption: type: object properties: enable: type: boolean description: Whether to allow users to switch their calls to `End-to-End Encryption`. If users have `Automatic Call Recording` turned on, they cannot use `End-to-End Encryption`. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset. The settings display in the new policy framework. example: true description: Allows users to switch their calls to End-to-End Encryption. description: The rules for blocking external calls during business, closed, and holiday hours. This feature is only available for User, Zoom Room, and Common Area. force_off_net: type: object properties: enable: type: boolean description: By enabling Force Off-Net, calls from users or extensions between sites route through the PSTN network. Users in this site can only be allowed to be part of advanced functionality (eg. Auto Receptionists, Call Queues) that is configured in this site. Users require a paid Zoom license and BYOC-P phone numbers to call between sites. example: true allow_extension_only_users_call_users_outside_site: type: boolean description: This setting allows extension only users to call to users outside the site. example: true description: 'It requires the account to enable the `Force Calls out to the PSTN network`feature. ' external_calling_on_zoom_room_common_area: type: object properties: enable: type: boolean description: This field allows Zoom Rooms to call external phone numbers based on the calling plans. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows Zoom Rooms to call external phone numbers based on the calling plans. zoom_phone_on_pwa: type: object properties: enable: type: boolean description: This field allows users to use Zoom Phone on Zoom Progressive Web App example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true allow_calling: type: boolean description: This field allows users to use calling on Zoom Progressive Web App example: true allow_sms_mms: type: boolean description: This field allows users to use sms/mms on Zoom Progressive Web App example: true description: This field allows users to use Zoom Phone on Zoom Progressive Web App sms_auto_reply: type: object properties: enable: type: boolean description: This field enables SMS Auto Reply feature for User, Auto Receptionist, and Call Queue example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field enables SMS Auto Reply feature for User, Auto Receptionist, and Call Queue allow_end_user_edit_call_handling: type: object properties: enable: type: boolean description: This field allows users to edit call handling settings. Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows users to edit call handling settings. Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client. allow_caller_reach_operator: type: object properties: enable: type: boolean description: This field enables users to allow their callers to reach an operator .Once disabled, users will not be able to route their calls to an operator as part of the "When a call is not answered" setting. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field enables users to allow their callers to reach an operator.Once disabled, users will not be able to route their calls to an operator as part of the "When a call is not answered" setting. forward_call_outside_of_site: type: object properties: enable: type: boolean description: This field allows users to forward their calls outside of their own site.Once disabled, users will only be able to forward their calls to users, call queues, shared line groups, etc., within their own site. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows users to forward their calls outside of their own site.Once disabled, users will only be able to forward their calls to users, call queues, shared line groups, etc., within their own site. allow_mobile_home_phone_callout: type: object properties: enable: type: boolean description: This field allows users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. obfuscate_sensitive_data_during_call: type: object properties: enable: type: boolean description: Once enabled, when a user on an active call presses a dial pad key on screen or number on the keyboard, the client DTMF tones will be muted and the numbers will be masked on the screen. example: true reset: type: boolean description: Whether the current settings use the phone account's settings, if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Once enabled, when a user on an active call presses a dial pad key on screen or number on the keyboard, the client DTMF tones will be muted and the numbers will be masked on the screen. prevent_users_upload_audio_files: type: object properties: enable: type: boolean description: Once enabled, users will not be able to upload audios on the web portal. Users will be still able to access text-to-speech or record audio files. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: Once enabled, users will not be able to upload audios on the web portal. Users will be still able to access text-to-speech or record audio files. voicemail_tasks: type: object properties: enable: type: boolean description: This field allows users to extract tasks from English voicemail transcriptions. Users need to have voicemail transcription policy enabled. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows users to extract tasks from English voicemail transcriptions. Users need to have voicemail transcription policy enabled. voicemail_intent_based_prioritization: type: object properties: enable: type: boolean description: This field allows users to prioritize urgent voicemails based on predefined priority topics. Users need to have voicemail transcription policy enabled. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: This field allows users to prioritize urgent voicemails based on predefined priority topics. Users need to have voicemail transcription policy enabled. team_sms_thread_summary: type: object properties: enable: type: boolean description: This field allows users to summarize and extract tasks from English SMS conversations. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true description: 'This field allows users to summarize and extract tasks from English SMS conversations. ' display_call_feedback_survey: type: object properties: enable: type: boolean description: Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong. example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true feedback_type: type: integer description: This field allows you to display feedback survey, `1` - display for every call, `2` - display when call quality issues are detected. Default `1`, if set with value `2`, need to set `feed_back_mos` or `feedback_duration`. example: 1 enum: - 1 - 2 feedback_mos: type: object properties: enable: type: boolean description: This field displays end-of-call experience feedback survey when call mos score issues are detected. example: true min: maximum: 4.5 minimum: 1 type: number description: The minimum MOS score. example: 1.5 max: maximum: 4.5 minimum: 1 type: number description: 'The maximum MOS score. ' example: 3.5 description: 'The MOS score. Minimum: 1.0. Maximum: 3.0. The format is one decimal point.' feedback_duration: type: object properties: enable: type: boolean description: This field displays end-of-call experience feedback survey when call duration issues are detected. example: true min: maximum: 60 minimum: 0 type: integer description: 'The minimum call duration. ' example: 0 max: maximum: 60 minimum: 0 type: integer description: 'The maximum call duration. ' example: 10 description: The call duration, in seconds, 0-60. description: Whether a thumbs up or down survey displays at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong. call_live_transcription: type: object properties: enable: type: boolean description: This field enables users to turn on live transcriptions for a call. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true transcription_start_prompt: type: object properties: enable: type: boolean description: This setting enables play a prompt to call participants when the transcription has started. example: true audio_id: type: string description: The unique identifier of the audio item. Only required when `transcription_start_prompt`is enable. example: yCT14TwySDGVUypVlKNEyA description: Whether to play a prompt to call participants when the transcription has started. description: Whether to let users turn on live transcriptions for a call. call_screening: type: object properties: enable: type: boolean description: This setting enables incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true exclude_user_company_contacts: type: boolean description: Whether exclude user and company contacts from call screening, calls will reach users as normal. example: true description: Whether to incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes. sms_template: type: object properties: enable: type: boolean description: This setting enables you to use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true sms_template_list: maxItems: 50 type: array description: The SMS template list. items: required: - sms_template_id type: object properties: sms_template_id: type: string description: The SMS template ID. example: 0qWIP8S8QXmo6KShUIyvZA active: type: boolean description: Whether it is active or not. example: true description: Whether to use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work. advanced_encryption: type: object properties: enable: type: boolean description: Allows voicemail to be encrypted with keys which are not accessible to Zoom servers. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true disable_incoming_unencrypted_voicemail: type: boolean description: Whether to disable incoming unencrypted voicemail. example: true description: 'Whether to allow voicemail to be encrypted with keys which are not accessible to Zoom servers. These voicemails can be decrypted only by the intended user recipient. Shared line appearance, shared line group, call queue, or auto receptionist voicemail will not be encrypted, but can still be played. Email to voicemail, transcriptions, ability to check voicemails by dialing into the voicemail system, or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user does who inherits this policy does not have a Power Pack license, the policy will not be applied. ' customize_line_name: type: object properties: enable: type: boolean description: This setting enables the line name template to be applied to all the desk phones on your account. Make sure there is enough space on the desk phone to display the line name. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true user_line_name: type: string description: The user line name. example: phoneNumber enum: - phoneNumber - extensionNumber - displayName - displayName;extensionNumber - firstName;extensionNumber - firstName;lastName;extensionNumber common_area_line_name: type: string description: The common area line name. example: phoneNumber enum: - phoneNumber - extensionNumber - displayName - displayName;extensionNumber description: Whether to enable the line name template will be applied to all the desk phones on your account. Make sure there is enough space on the desk phone to display the line name. auto_opt_out_in_call_queue: type: object properties: enable: type: boolean description: Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true prompt_before_opt_out_call_queue: type: boolean description: Once enabled, always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom. example: true description: Whether to enable auto Opt-out from Call Queue after logging out from Zoom. incoming_call_notification: type: object properties: enable: type: boolean description: Allows users to select if an incoming call notification would block their current activity. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true block_type: type: string description: The incoming call notification block type. `block_activity` means "Block my current activity", `continue_with_alert` means "Alert me but allow me to continue my current activity". example: block_activity enum: - block_activity - continue_with_alert description: Allows users to select if an incoming call notification would block their current activity. call_summary: type: object properties: enable: type: boolean description: Allows users to generate a summary of a phone call. For users who enable call summary during a call, a summary will be automatically sent to them on the client and the web portal after the call has ended. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true auto_call_summary: type: boolean description: This setting enables an automatic call summary. example: true call_summary_start_prompt: type: object properties: enable: type: boolean description: Whether to play a prompt to call participant when call summary has started. example: true audio_id: type: string description: The unique identifier of the audio item. Only required when you enable `call_summary_start_prompt`. example: yCT14TwySDGVUypVlKNEyA description: Whether to play a prompt to call participant when call summary has started. description: This setting allows users to generate a summary of a phone call. For users who enable call summary during a call, a summary will be automatically sent to them on the client and the web portal after the call has ended. It requires the account to enable the `Enable Phone Call Summary` feature. schedule_firmware_update: type: object properties: enable: type: boolean description: Whether to define how often and when to update firmware of the devices. example: true reset: type: boolean description: Whether the current settings use the phone account's settings when the current settings use the new policy framework. example: true repeat_type: type: string description: The repeat type. example: weekly enum: - weekly - monthly repeat_setting: description: The repeat setting. oneOf: - title: weekly setting type: object properties: weekly_setting: type: object properties: weekday: type: string description: ' The day of the week.' example: monday default: monday enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: The weekly setting. description: The weekly setting. Only required when `repeat_type` is `weekly`. - title: monthly setting type: object properties: monthly_setting: description: The monthly setting. oneOf: - title: by week and day type: object properties: week_and_day: type: object properties: week_of_month: maximum: 4 minimum: 1 type: integer description: Which week of the month to perform updates. example: 1 weekday: type: string description: The day of the selected week to perform updates example: monday default: monday enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: Repeats by week and day. description: Repeats by week and day. - title: by specific date type: object properties: specific_date: type: object properties: day_of_month: maximum: 31 minimum: 0 type: integer description: The specific day of the month for updates. `0` means "Last day" example: 10 description: Repeats by specific date. description: Repeats by specific date. description: The monthly setting. Only required when `repeat_type` is `monthly` time_period_start: maximum: 23 minimum: 0 type: integer description: The time period start time. 15 means 3 PM. example: 15 time_period_end: maximum: 23 minimum: 0 type: integer description: 'The time period end time. Example: 16 means 4 PM.' example: 16 time_zone: type: string description: The [time zone list](https://developer.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats. example: Asia/Shanghai end_setting: type: object properties: never_end: type: boolean description: This field indicates the setting never ends. example: true end_date: type: string description: 'The end date in the following format: \"yyyy-MM-dd\". Only required when `never_end` is false.' format: date example: '2025-01-01' description: End setting. description: Defines how often and when to update the firmware of the devices. zoom_phone_on_desktop: type: object properties: enable: type: boolean description: Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI clinet and Linux). example: true reset: type: boolean description: Whether the current settings use the phone account's settings if the current settings use the new policy framework. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true allow_calling_clients: maxItems: 10 type: array description: The clients in this list are allowed to make and receive calls. items: type: string description: "The acceptable value is \nmac_os\nwindows\nvdi_client\nlinux." example: mac_os enum: - mac_os - windows - vdi_client - linux allow_sms_mms_clients: maxItems: 10 type: array description: The clients in this list are allowed to use the SMS/MMS function. items: type: string description: "The acceptable value is \nmac_os\nwindows\nvdi_client\nlinux." example: mac_os enum: - mac_os - windows - vdi_client - linux description: Allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux). manage_call_routing_for_unassigned_numbers: type: object properties: enable: type: boolean description: Whether to enable call routing for unassigned numbers. example: true locked: type: boolean description: Whether the senior administrator allows lower levels to modify this setting. example: true reset: type: boolean description: Whether to reset this setting to inherited defaults from parent level. example: false incoming_call_action: type: string description: The routing action for incoming calls to unassigned numbers. `disconnect` - Disconnect the call. `play_message_then_disconnect` - Play a message and then disconnect. `forward_to_another_extension` - Forward the call to another extension. example: disconnect enum: - disconnect - play_message_then_disconnect - forward_to_another_extension incoming_call_routing_setting: description: The routing setting. Only applies when `incoming_call_action` is not `disconnect`. oneOf: - title: Play a Message then Disconnect type: object properties: audio_id: type: string description: The audio prompt file ID. example: yCT14TwySDGVUypVlKNEyA description: The routing setting. Only applies when `incoming_call_action` is `play_message_then_disconnect`. - title: Forward to Another Extension required: - forward_extension_id type: object properties: forward_extension_id: type: string description: The ID of the extension to forward calls to. Required when `incoming_call_action` is `forward_to_another_extension`. example: jN9mb38lQTaMgxUq3Nd6ow description: The routing setting. Only applies when `incoming_call_action` is `forward_to_another_extension`. description: Manage call routing for unassigned numbers. show_custom_disclaimer_when_using_zoom_phone: type: object properties: enable: type: boolean description: Whether to show a custom disclaimer when starting to use Zoom Phone service. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: false reset: type: boolean description: Whether to reset this setting to inherited defaults from the parent level. example: false display_frequency: type: string description: The display frequency. example: first_time_only enum: - first_time_only - every_time - every_month - every_quarter - every_6_months - every_year custom_disclaimer_list: type: array description: The custom disclaimer list. items: type: object properties: language: type: string description: "The audio prompt language code. \n\nEnglish: `en` \n\nDeutsch: `de` \n\nEspañol: `es` \n\nFrançais: `fr` \n\nItaliano: `it` \n\nNederlands: `nl` \n\nPortuguês: `pt` \n\nJapanese: `ja` \n\nKorean: `ko` \n\nChinese: `zh-cn` \n\nTaiwanese: `zh-tw` \n\nNorsk: `no` \n\nРусский: `ru` \n\nBahasa Melayu: `ms` \n\nTiếng Việt: `vi` \n\nУкраїнська: `uk` \n\nBahasa Indonesia: `id` \n\nPolski: `pl` \n\nTürkçe: `tr` " example: en enum: - en - de - es - fr - it - nl - pt - ja - ko - zh-cn - zh-tw - 'no' - ru - ms - vi - uk - id - pl - tr title: maxLength: 60 type: string description: The custom disclaimer title. example: tilte body: maxLength: 500 type: string description: The custom disclaimer body. example: body default: type: boolean description: Whether this language is the default disclaimer. Participants using languages not configured in this list will see the disclaimer marked as default. **Exactly one item in the list must have `default` set to `true`** when the list is non-empty. example: true description: Whether to show a custom disclaimer when starting to use Zoom Phone service. description: ' The [site policy setting](https://support.zoom.us/hc/en-us/articles/360033511872-Changing-Zoom-Phone-policy-settings#h_af4d1935-9cb1-44d2-9a10-9bfba10d58a7).' responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nSite details updated successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed. Site does not exist.
\nAlign the range with the number of digits entered in `length`
\n`range_from` value must be smaller than `range_to` value.
\nInvalid address: {formattedAddress}.
\nChange country is not allowed.
\nPersonal emergency address could not be changed to default.
\nCannot update emergency address whose status is {status}.
\nThis address could not be validated.
\nInvalid site code length.
\nInvalid short extension number length.
\nInvalid site code length.
\nEach set of ranges cannot have intersections.
\nThe range_from or range_to can not be empty.
\nThe range_from or range_to must be digits only.
\n**Error Code:** `400`
\n Site code is disabled.
\n**Error Code:** `13800`
\n You do not enable OP flag named 'Enable Caller Based Consent Options', please using same value to update 'inbound_audio_notification.recording_start_prompt' and 'outbound_audio_notification.recording_start_prompt'.
\n**Error Code:** `13800`
\n You do not enable OP flag named 'Enable Caller Based Consent Options', please using same value to update 'inbound_audio_notification.recording_start_prompt_audio_id' and 'outbound_audio_notification.recording_start_prompt_audio_id'.
\n**Error Code:** `13800`
\n You do not enable OP flag named 'Enable Caller Based Consent Options', please using same value to update 'inbound_audio_notification.recording_explicit_consent' and 'outbound_audio_notification.recording_explicit_consent'.
\n**Error Code:** `13802`
\n Audio does not exist: {audioId}.
\n**Error Code:** `13803`
\n SMS template does not exist: {sms_template_id}.
\n**Error Code:** `13804`
\n Invalid time period.
\n**Error Code:** `13805`
\n Invalid end date.
\n**Error Code:** `13806`
\n Time zone is invalid: {time_zone}.
\n**Error Code:** `13808`
\n Extension does not exist: {extension_id}
\n**Error Code:** `405`
\n The number of items for short_extension.ranges must not exceed 10.
\n**Error Code:** `405`
\n The number of items for policy.zoom_phone_on_mobile.allow_calling_clients must not exceed 10.
\n**Error Code:** `405`
\n The number of items for policy.zoom_phone_on_mobile.allow_sms_mms_clients must not exceed 10.
\n**Error Code:** `405`
\n The number of items for policy.call_queue_opt_out_reason.call_queue_opt_out_reasons_list must not exceed 30.
\n**Error Code:** `405`
\n The number of items for policy.auto_delete_data_after_retention_duration.items must not exceed 15.
\n**Error Code:** `405`
\n The number of items for policy.sms_template.sms_template_list must not exceed 50.
\n**Error Code:** `405`
\n The number of items for policy.sms.international_sms_countries must not exceed 200.
\n**Error Code:** `405`
\n The number of items for policy.zoom_phone_on_desktop.allow_calling_clients must not exceed 10
\n**Error Code:** `405`
\n The number of items for policy.zoom_phone_on_desktop.allow_sms_mms_clients must not exceed 10.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account 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:update:site:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:site:admin /phone/sites/{siteId}/outbound_caller_id/customized_numbers: get: tags: - Sites summary: List customized outbound caller ID phone numbers description: "Use this API to retrieve phone numbers that can be used as the `site-level` customized outbound caller ID. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_site_customized_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: listSiteCustomizeOutboundCallerNumbers parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: selected in: query description: "Status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list" required: false schema: type: boolean example: true - name: site_id in: query description: For filtering phone numbers that belong to the site. required: false schema: type: string example: SQv52YtkRLC2dwrDdYtGsA - name: extension_type in: query description: The type of the extension to which the phone number belongs. required: false schema: type: string example: callQueue enum: - autoReceptionist - callQueue - sharedLineGroup - name: keyword in: query description: A search keyword for phone or extension numbers. required: false schema: type: string example: '408' - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 - name: next_page_token in: query description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. required: false schema: type: string example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2 responses: '200': description: "**HTTP Status Code:** `200` \n \nCustomized numbers for outbound caller ID listed successfully." content: application/json: schema: type: object properties: customize_numbers: type: array items: type: object properties: customize_id: type: string description: The customization ID. example: 8_RkKw9OQ42oYsXqJJjs4A phone_number_id: type: string description: ID of the phone number. example: 55JUZPwERHuGttd_j4qBsQ phone_number: type: string description: The phone number in E164 format. example: '+12055437350' display_name: type: string description: Name of the phone number. example: test abc incoming: type: boolean description: Whether the incoming policy is enabled for the phone number. example: true outgoing: type: boolean description: Whether the outgoing policy is enabled for the phone number. example: true extension_id: type: string description: The extension ID. example: HaSokHMCSeK8taMdv2vnXQ extension_type: type: string description: The extension type. example: callQueue extension_number: type: string description: The extension number. example: '10001' extension_name: type: string description: The extension name. example: SJ CQ site: type: object properties: id: type: string description: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: Name of the site. example: testSite next_page_token: type: string description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2 page_size: type: integer description: The number of records returned within a single API call for each page. example: 30 total_records: type: integer description: The total number of records returned. example: 10 '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:read:admin - phone:read:list_site_customized_number:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_site_customized_number:admin post: tags: - Sites summary: Add customized outbound caller ID phone numbers description: "Use this API to add the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\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:write:site_customized_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: addSiteOutboundCallerNumbers parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ requestBody: content: application/json: schema: type: object properties: phone_number_ids: maximum: 30 type: array description: The phone number IDs. items: type: string example: 55JUZPwERHuGttd_j4qBsQ responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \nCustomized caller ID numbers added successfully. " content: application/json: schema: {} '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. Site does not exist.
\n\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:write:site_customized_number:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:site_customized_number:admin delete: tags: - Sites summary: Remove customized outbound caller ID phone numbers description: "Use this API to remove the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\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:site_customized_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: deleteSiteOutboundCallerNumbers parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: customize_ids in: query description: The customization IDs. required: false schema: maxItems: 30 type: array items: type: string example: 8_RkKw9OQ42oYsXqJJjs4A responses: '204': description: "**HTTP Status Code:** `204` **Created** \n \nCustomized numbers have been deleted successfully. " '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. Site does not exist.
\n\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:site_customized_number:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:site_customized_number:admin /phone/sites/{siteId}/settings/{settingType}: get: tags: - Sites summary: Get a phone site setting description: " Gets the site setting about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type. Sites allow you to organize Zoom Phone users in your organization.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: getSiteSettingForType parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: settingType in: path description: "The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours` \n* `security` \n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`" required: true schema: type: string example: business_hours enum: - local_based_routing - business_hours - closed_hours - holiday_hours - security - outbound_caller_id - audio_prompt - desk_phone - dial_by_name - billing_account responses: '200': description: "**HTTP Status Code:** `200` \n \nSite setting information retrieved successfully." content: application/json: schema: type: object properties: location_based_routing: type: object properties: enable: type: boolean description: When the policy is enabled, Zoom Phone calls are subject to the policy options defined. example: false place_receive_pstn_calls: type: boolean description: The place and receive PSTN (Public Switched Telephone Network) calls only when inside the locations. example: false enable_media_off_load_pstn_calls: type: boolean description: This field enables media offload for extensions to PSTN (Public Switched Telephone Network) calls. example: false description: The location-based routing setting of the site. business_hours: type: object properties: custom_hour_type: type: integer description: Business Hour Type `1`- 24 hours a day, 7 days a week; `2`- Custom hours. example: 2 enum: - 1 - 2 custom_hours: type: array description: The custom business hours settings. 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: 0 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: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: The option to allow callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension ID. example: FGAMaMWESMCNF0jmEU1emw extension_number: type: integer description: The extension number. format: int64 example: 1000001018 display_name: type: string description: The display name of extension. example: Test_callQueue extension_type: type: string description: "The extension type. \n* `user` \n* `callQueue` \n* `autoReceptionist` \n* `commonArea` \n* `zoomRoom` \n* `ciscoRoom/PolycomRoom` \n* `sharedLineGroup`" example: callQueue enum: - user - callQueue - autoReceptionist - commonArea - zoomRoom - ciscoRoom/PolycomRoom - sharedLineGroup description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: The option to allow callers to check voicemail. example: false description: This field seta the default overflow for business hours for users, Call Queues, and Shared Line Groups. description: This field allows you to set the default business hours for all users, Zoom Rooms, and Common Areas for the site. closed_hours: type: object properties: overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: The option to allow callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension ID. example: FGAMaMWESMCNF0jmEU1emw extension_number: type: integer description: The extension number. format: int64 example: 1000001018 display_name: type: string description: The display name of extension. example: Test_callQueue extension_type: type: string description: "The extension type. \n* `user` \n* `callQueue` \n* `autoReceptionist` \n* `commonArea` \n* `zoomRoom` \n* `ciscoRoom/PolycomRoom` \n* `sharedLineGroup`" example: callQueue enum: - user - callQueue - autoReceptionist - commonArea - zoomRoom - ciscoRoom/PolycomRoom - sharedLineGroup description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: The option to allow callers to check voicemail. example: false description: This field seta the default overflow for business hours for users, Call Queues, and Shared Line Groups. description: This field allows you to set the default closed hours for all users, Zoom Rooms, Common Areas, Auto Receptionists, Call Queues, and Shared Line Groups for the site. holiday_hours: type: object properties: holidays: type: array description: The holiday hours settings. items: type: object properties: holiday_id: type: string description: The holiday ID. example: i3gP6xFUTHqSFrIE6nHs7Q name: type: string description: The name of the holiday. example: Holiday 1 from: type: string description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-08T16:00:00Z' to: type: string description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-09T16:00:00Z' overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: The option to allow callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension ID. example: FGAMaMWESMCNF0jmEU1emw extension_number: type: integer description: The extension number. format: int64 example: 1000001018 display_name: type: string description: The display name of extension. example: Test_callQueue extension_type: type: string description: "The extension type. \n* `user` \n* `callQueue` \n* `autoReceptionist` \n* `commonArea` \n* `zoomRoom` \n* `ciscoRoom/PolycomRoom` \n* `sharedLineGroup`" example: callQueue enum: - user - callQueue - autoReceptionist - commonArea - zoomRoom - ciscoRoom/PolycomRoom - sharedLineGroup description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: The option to allow callers to check voicemail. example: false description: This field seta the default overflow for business hours for users, Call Queues, and Shared Line Groups. description: This field allows you to set the default holiday hours for all users, Zoom Rooms, Common Areas, Auto Receptionists, Call Queues, and Shared Line Groups for the site. security: type: object properties: device_types: type: array description: The effective device types. items: type: string example: Poly trioc60 description: This field upgrades devices from the current site to use the SRTP with AES-256 bit encryption. After adding or removing a device type, devices of the corresponding type will get re-synced. For more information, see [Zoom Phone Encryption](https://support.zoom.us/hc/en-us/articles/360042578911#h_36a22ca1-89f1-4614-8d7e-3c6a957b261c). outbound_caller_id: type: object properties: auto_receptionists_numbers: type: boolean description: When checked, auto receptionists members will use the numbers as the outbound caller ID example: false call_queue_numbers: type: boolean description: When checked, call queue members will use the numbers as the outbound caller ID. example: false share_line_group_numbers: type: boolean description: When checked, share line group members will use the numbers as the outbound caller ID. example: false show_outbound_caller_id_for_internal_call: type: boolean description: When a call is made to an internal extension that uses the numbers associated with Auto Receptionist or Call Queue as the caller ID, the receiver sees an outbound caller ID selected by the caller. example: false description: The outbound caller ID setting. audio_prompt: type: object properties: language: type: string description: "The audio prompt language code. \n American English: `en-US` \n \nBritish English: `en-GB` \n \nEspañol americano: `es-US` \n \nFrançais canadien: `fr-CA` \n \nDansk: `da-DK` \n \nDeutsch: `de-DE` \n \nEspañol: `es-ES` \n \nFrançais: `fr-FR` \n \nItaliano: `it-IT` \n \nNederlands: `nl-NL` \n \nPortugues portugal: `pt-PT` \n \nJapanese: `ja-JP` \n \nKorean: `ko-KO` \n \nPortugues brasil: `pt-BR` \n \nChinese: `zh-CN` \n \nTaiwanese: `zh-TW` \n " example: en-GB greeting_leave_voicemail_instruction: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. greeting_menu_leave_or_check_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. greeting_menu_connect_to_operator_or_leave_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. greeting_menu_connect_to_operator_leave_or_check_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. leave_voicemail_introduction: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. message_greeting: type: object properties: business_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. audio_while_connecting: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. hold_music: type: object properties: audio_id: type: string description: The audio item ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still 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: yCT14TwySDGVUypVlKNEyA name: type: string description: The name of the audio item. example: hello.mp3 description: The audio prompt setting for respective hours. description: The audio prompt setting. desk_phone: type: object properties: hot_desking_session_timeout: required: - number type: object properties: number: type: integer example: 5 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 30 unit: type: string description: "The `minutes` - available if the `number` values are: '5, 10, 15, 30' \n`hours` - not available if the `number` value is '30'." example: minutes default: hours enum: - minutes - hours description: The set duration after which users are signed out of hot desking devices. general_setting: type: object properties: setting_type: type: string description: The setting type. `account_setting` will use the configuration defined at the account level. `custom_setting` allows custom configurations to be defined specifically for this Site. example: account_setting default: account_setting enum: - account_setting - custom_setting web_interface: type: boolean description: Enables desk phone web interface. Only returns when `setting_type` is `custom_setting`. example: false description: These general configurations of the desk phones in your account can be set globally, but some settings may not work for individual models. You need to manually reboot the desk phones to apply these changes. description: The desk phone setting. dial_by_name: type: object properties: status: type: boolean description: Whether to allow callers to search for an extension by the first or last name. Currently supports English only. example: true inherit: type: boolean description: Whether to inherit the dial by name directory maintained at the account level. This directory is read-only to sites. example: false rule: type: string description: The search extensions by first or last name. Callers must enter at least two characters to perform a name search. example: last_name enum: - first_name - last_name description: The dial by name directory setting. billing_account: type: object properties: id: type: string description: The billing account ID. example: 3WWAEiEjTj2IQuyDiKMd_A name: type: string description: The billing account name. example: Delhi billing description: The billing account setting. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Site 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:read:admin - phone:read:site_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:site_setting:admin post: tags: - Sites summary: Add a site setting description: "Sites allow you to organize Zoom Phone users in your organization. Use this API to add a site setting to a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\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:write:site_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: addSiteSetting parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: settingType in: path description: "The site setting type: \n* `holiday_hours` \n* `security`." required: true schema: type: string example: security enum: - holiday_hours - security requestBody: content: application/json: schema: type: object properties: device_type: type: string description: The device type. Enable SRTP AES-256 encryption on the site for the specified device type. Used for `device_security` setting type. example: Poly trioc60 holidays: type: array description: The holiday hours settings. items: type: object properties: name: type: string description: The name of the holiday. example: Holiday 1 from: type: string description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-08T16:00:00Z' to: type: string description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-09T16:00:00Z' responses: '201': description: "**HTTP Status Code** `201` \n \nCreated Successfully." content: application/json: schema: type: object properties: holidays: type: array description: The settings for holiday hours. items: type: object properties: holiday_id: type: string description: The holiday ID. example: i3gP6xFUTHqSFrIE6nHs7Q name: type: string description: The name of the holiday. example: Holiday 1 from: type: string description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-08T16:00:00Z' to: type: string description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-09T16:00:00Z' '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. Site does not exist.
\n\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:write:site_setting:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:site_setting:admin delete: tags: - Sites summary: Delete a site setting description: "Sites allow you to organize Zoom Phone users in your organization. Use this API to delete the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672).\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\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:site_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: deleteSiteSetting parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: settingType in: path description: "The site setting type: \n* `holiday_hours` \n* `security`." required: true schema: type: string example: security enum: - holiday_hours - security - name: device_type in: query description: The device type. Enable SRTP AES-256 encryption on the site for the specified device type. Used for `security` setting type. required: false schema: type: string example: Poly trioc60 - name: holiday_id in: query description: The holiday hour setting ID. Used for `holiday_hours` setting type. required: false schema: type: string example: n6wfnyoFSmWwY121cPe66g responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nThe site setting have been deleted successfully. " '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. Site does not exist.
\n\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:site_setting:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:site_setting:admin patch: tags: - Sites summary: Update the site setting description: "Allows you to organize Zoom Phone users in your organization. You can update the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\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:update:site_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: updateSiteSetting parameters: - name: siteId in: path description: The site ID. required: true schema: type: string example: kLD4F3WBT-O9LYE31C0tRQ - name: settingType in: path description: "The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`\n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`" required: true schema: type: string example: business_hours enum: - local_based_routing - business_hours - closed_hours - holiday_hours - outbound_caller_id - audio_prompt - desk_phone - dial_by_name - billing_account requestBody: content: application/json: schema: type: object properties: location_based_routing: type: object properties: enable: type: boolean description: When the policy is enabled, Zoom Phone calls will be subject to the policy options defined. example: false place_receive_pstn_calls: type: boolean description: This setting places and receives PSTN (Public Switched Telephone Network) calls only when inside the locations. example: false enable_media_off_load_pstn_calls: type: boolean description: This setting enables media offload for extensions to PSTN (Public Switched Telephone Network) calls. example: false description: The location-based routing setting of the site. It's used for `local_based_routing` setting type. business_hours: type: object properties: custom_hour_type: type: integer description: The business hour type `1`- 24 hours a Day, 7 days a week, `2`- Custom hours. example: 2 enum: - 1 - 2 custom_hours: maxItems: 7 type: array description: The settings for custom business hours. items: type: object properties: from: type: string description: The start time for custom hours in `HH:mm` format. example: 09:00 to: type: string description: The end time custom hours 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: 0 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: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: This setting allows callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension's ID. example: p4O_BLMGS7ejPPMaBzgpcQ description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: This setting allows callers to check voicemail. example: false description: Sets the default overflow for business hours for users, call queues and shared line groups. description: Sets the default business hours for all users, Zoom Rooms, and Common Areas for the site. It's used for the `business_hours` setting type. closed_hours: type: object properties: overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: Allows callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension's ID. example: p4O_BLMGS7ejPPMaBzgpcQ description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: Allows callers to check voicemail. example: false description: Sets the default overflow for business hours for users, Call Queues and Shared Line Groups. description: Sets the default closed hours for all users, Zoom Rooms, Common Areas, Auto Receptionists, Call Queues and Shared Line Groups for the site. Used for `closed_hours` setting type. holiday_hours: type: object properties: holidays: maxItems: 10 type: array description: The settings for holiday hours. items: type: object properties: holiday_id: type: string description: The holiday's ID. example: i3gP6xFUTHqSFrIE6nHs7Q name: type: string description: The name of the holiday. example: Holiday 1 from: type: string description: The holiday start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-08T16:00:00Z' to: type: string description: The holiday end date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-09T16:00:00Z' overflow: type: object properties: allow_caller_to_reach_operator: type: boolean description: Allows callers to reach an operator. example: true operator: type: object properties: extension_id: type: string description: The extension's ID. example: p4O_BLMGS7ejPPMaBzgpcQ description: The operator to allow callers to reach. allow_caller_to_check_voicemail: type: boolean description: Allows callers to check voicemail. example: false description: Sets the default overflow for business hours for users, call queues and shared line groups. description: Sets the default holiday hours for all users, Zoom Rooms, common areas, auto receptionists, call queues and shared linegroups for the site. It's used for the `holiday_hours` setting type. outbound_caller_id: type: object properties: auto_receptionists_numbers: type: boolean description: When checked, auto receptionists members will use the numbers as the outbound caller ID example: false call_queue_numbers: type: boolean description: When checked, call queue members will use the numbers as the outbound caller ID. example: false share_line_group_numbers: type: boolean description: When checked, share line group members will use the numbers as the outbound caller ID. example: false show_outbound_caller_id_for_internal_call: type: boolean description: When a call is made to an internal extension that uses the numbers associated with Auto Receptionist or Call Queue as the caller ID, the receiver will see an outbound caller ID selected by the caller. example: false description: The outbound caller ID setting. It's used for the `outbound_caller_id` setting type. audio_prompt: type: object properties: language: type: string description: "The audio prompt language code. \n American English: `en-US` \n \nBritish English: `en-GB` \n \nEspañol americano: `es-US` \n \nFrançais canadien: `fr-CA` \n \nDansk: `da-DK` \n \nDeutsch: `de-DE` \n \nEspañol: `es-ES` \n \nFrançais: `fr-FR` \n \nItaliano: `it-IT` \n \nNederlands: `nl-NL` \n \nPortugues portugal: `pt-PT` \n \nJapanese: `ja-JP` \n \nKorean: `ko-KO` \n \nPortugues brasil: `pt-BR` \n \nChinese: `zh-CN` \n \nTaiwanese: `zh-TW` \n " example: en-GB greeting_leave_voicemail_instruction: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: Audio prompt for `Greeting & Leave voicemail instruction` greeting_menu_leave_or_check_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: 'The audio prompt for `Greeting & Menu: Leave or check voicemail`' greeting_menu_connect_to_operator_or_leave_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: 'The audio prompt for `Greeting & Menu: Connect to operator or leave voicemail`' greeting_menu_connect_to_operator_leave_or_check_voicemail: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: 'Audio prompt for `Greeting & Menu: Connect to operator, leave or check voicemail`' leave_voicemail_introduction: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: The audio prompt for `Leave voicemail instruction` message_greeting: type: object properties: business_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. closed_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. holiday_hours: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: The audio prompt for `Message Greeting` audio_while_connecting: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. hold_music: type: object properties: audio_id: type: string description: The unique identifier of the audio item. example: yCT14TwySDGVUypVlKNEyA description: The audio prompt setting for respective hours. description: The audio prompt setting. Used for `audio_prompt` setting type. desk_phone: type: object properties: hot_desking_session_timeout: required: - number type: object properties: number: type: integer description: The number example: 5 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 30 unit: type: string description: "`The `minutes`. This seeting is only available if the `number` values are: '5, 10, 15, 30' \n`hours` - not available if the `number` value is '30'" example: minutes default: hours enum: - minutes - hours description: The set duration after which users are signed out of hot desking devices. description: The desk phone setting. general_setting: type: object properties: setting_type: type: string description: The setting type. `account_setting` will use the configuration defined at the account level. `custom_setting` allows custom configurations to be defined specifically for this Site. example: account_setting default: account_setting enum: - account_setting - custom_setting web_interface: type: boolean description: This setting enables desk phone web interface. This field is only available when `setting_type` is `custom_setting`. example: false description: These general configurations of the desk phones in your account can be set globally, but some settings may not work for individual models. You need to manually reboot the desk phones to apply these changes. dial_by_name: type: object properties: status: type: boolean description: Whether to allow callers to search for an extension by the first or last name. Currently supports English only. example: true inherit: type: boolean description: Whether to inherit the dial by name directory maintained at the account level. This directory is `read-only` to sites. example: false rule: type: string description: The search extensions by first or last name. Callers must enter at least 2 characters to perform a name search. example: last_name enum: - first_name - last_name description: The dial by name directory setting. billing_account: type: object properties: id: type: string description: The billing account ID. example: 3WWAEiEjTj2IQuyDiKMd_A description: The billing account setting. responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed. Site does not exist.
Prompt files do not exist, audio IDs: {0}.
Hot-desking session timeout setting is invalid.
Invalid field.

\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:update:site_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:site_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