openapi: 3.2.0 info: title: Phone Common Areas 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: Common Areas paths: /phone/common_areas: get: tags: - Common Areas summary: List common areas description: "Lists common areas under an account.\n\n**Prerequisites**\n\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: listCommonAreas parameters: - name: page_size in: query description: The total number of records returned from a single API call. required: false schema: maximum: 100 type: integer example: 30 default: 30 - name: next_page_token in: query description: The next page token paginates through large result sets. A next page token returns 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_id in: query description: The unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See Managing multiple sites or Adding a site for details. required: false schema: type: string example: 8f71O6rWT8KFUGQmJIFAdQ - name: calling_type in: query description: The Zoom Phone [calling plan number](https://developers.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). required: false schema: type: integer example: 100 - name: common_area_device_type in: query description: 'The common area device type: - 1 Smartphone - 2 Desk Phone - 3 Zoom Phone Appliance' required: false schema: type: integer example: 1 enum: - 1 - 2 - 3 responses: '200': description: "**HTTP Status Code:** `200` **OK** \n \n The list of common areas retrieved successfully." content: application/json: schema: type: object properties: common_areas: type: array items: type: object properties: calling_plans: type: array items: type: object properties: name: type: string description: The name of the plan. example: US/CA Metered Calling Plan type: type: integer description: The Zoom Phone [calling plan number](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). example: 100 billing_account_id: type: string description: The ID of the billing account. It displays when the common area is in India. example: 3WWAEiEjTj2IQuyDiKMd_A billing_account_name: type: string description: The billing account name. It displays when the common area is in India. example: Delhi billing billing_subscription_id: type: string description: The billing subscription ID. It displays when the account supports billing multiple subscriptions. example: FT-SUBREF-21168178 billing_subscription_name: type: string description: The billing subscription name. It displays when the account supports billing multiple subscriptions. It can be edited through the Billing page. example: My Subscription display_name: type: string description: The display name of the common area. example: test_ca extension_number: type: integer description: The extension number. format: int64 example: 100012347 id: type: string description: The common area ID or common area extension ID. example: JOZmuJ30Spyrw-v9vUzIrA phone_numbers: type: array items: type: object properties: display_name: type: string description: The phone number display name. example: Phone number display name id: type: string description: The phone number ID. example: S5q4FDC3QsOCnO7LqHgqNw number: type: string description: The phone number. example: '+12058945543' source: type: string description: The phone number source. The value can be either `internal` or `external`. example: internal enum: - internal - external site: type: object properties: id: type: string description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) that the common area desk phone is assigned. example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: The name of the site. example: Main Site status: type: string description: The status of the common area. example: offline enum: - online - offline desk_phones: type: array description: The common area's desk phones. items: type: object properties: id: type: string description: The desk phone ID. example: Aky1xpSLSc2PR0XOtj9XWQ display_name: type: string description: The desk phone display name. example: analog_ta device_type: type: string description: The desk phone device type. example: Poly obi504 status: type: string description: The desk phone status. example: offline enum: - online - offline 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: RaO87FrnwXvFQta5aV8sU5C3c9O8s9Nraq2 page_size: type: integer description: The total number of records returned from a single API call. example: 30 '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:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:common_area:admin post: tags: - Common Areas summary: Add a common area description: 'Adds an instance of a common area. You can configure devices shared by users and deployed in shared spaces. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: addCommonArea requestBody: content: application/json: schema: required: - display_name type: object properties: calling_plans: maxItems: 100 type: array items: type: object properties: type: type: integer description: The Zoom Phone [calling plan number](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). example: 100 billing_subscription_id: type: string description: The billing subscription ID. When there is more than one plan type A in this account, it cannot be empty. example: FT-SUBREF-21168178 country_iso_code: type: string description: The two-lettered country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US display_name: type: string description: The display name of the common area. Enter at least three characters. example: test_ca extension_number: type: integer description: The extension number assigned to the common area. If the site code is enabled, provide the short extension number instead. format: int64 example: 1001014 site_id: type: string description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672). You can retrieve the identifier from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. example: 8f71O6rWT8KFUGQmJIFAdQ timezone: type: string description: ' The [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists) for the common area.' example: America/Los_Angeles template_id: type: string description: "The unique identifier of the [Setting Template](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067442). \nYou can retrieve the identifier from the [List setting templates](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listSettingTemplates) API.\nThe setting template must belong to the same site as the common area." example: 2kFqiqSlS5udzWB5QqMiNg responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nThe common area has been added successfully." content: application/json: schema: type: object properties: display_name: type: string description: The display name of the common area. example: test_ca id: type: string description: The common area ID or common area extension ID. example: JOZmuJ30Spyrw-v9vUzIrA '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed.
\n* Timezone not found in the system.\n* This country is not supported by Zoom Phone.\n* Site does not exist: {site_id}.
\n* The template type error or the template does not exist:{template_id}.
\n* The template's site is not the same as the common area's site.

\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:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area:admin /phone/common_areas/activation_code: post: tags: - Common Areas summary: Generate activation codes for common areas description: 'Generates activation codes for common areas. You can add up to 50 common areas at a time. **Prerequisites** - Pro or a higher account with Zoom Phone license - Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** ' operationId: Generateactivationcodesforcommonareas requestBody: content: application/json: schema: required: - common_area_ids type: object properties: common_area_ids: maxItems: 50 type: array description: 'The `common_area_ids` is an array. Each element is the unique identifier of the common area. You can retrieve it from the [List Common Areas](https://developers.zoom.us/docs/api/phone/#tag/common-areas/GET/phone/common_areas/activation_codes) API. ' items: type: string description: The common area ID or common area extension ID. example: 5NmyHmVoRWWk4YT5ad6oxg responses: '201': description: 'HTTP Status Code: 201 Generate Activation Codes successfully.' content: application/json: schema: type: object properties: common_areas_activation_codes: maxItems: 50 type: array description: The activation code information of the common areas. items: type: object properties: common_area_id: type: string description: The common area ID or common area extension ID. example: JOZmuJ30Spyrw-v9vUzIrA display_name: type: string description: The display name of the common area. example: test_ca extension_number: type: integer description: The extension number. example: 100012347 activation_code: type: string description: The activation code. example: 5678-2345-1234-1234 activation_code_expiration: type: string description: 'The time when the activation code expires (format: ''yyyy-MM-ddThh:dd:ssZ'').' example: '2021-10-08T16:12:04Z' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Common area size must be less than 50.
\n**Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n**Error Code:** `400`
\n Common area smartphones feature is disabled.
\n" '403': description: "**HTTP Status Code:** `403`
\n Forbidden \n\n **Error Code:** `403`
\n You do not have permission.
\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:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area:admin /phone/common_areas/activation_codes: get: tags: - Common Areas summary: List activation codes description: "Returns a list of activation code information of the common areas under an account.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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_common_area_activation_codes:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** " operationId: listActivationCodes parameters: - name: page_size in: query description: The total number of records returned from a single API call. required: false schema: maximum: 100 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 returns 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` **OK** \n \n The list of activation codes of the common areas retrieved successfully." content: application/json: schema: type: object properties: common_areas_activation_codes: type: array description: The activation code information of the common areas. items: type: object properties: common_area_id: type: string description: The common area ID or common area extension ID. example: JOZmuJ30Spyrw-v9vUzIrA display_name: type: string description: The display name of the common area. example: test_ca extension_number: type: integer description: The extension number. format: int64 example: 100012347 activation_code: type: string description: The activation code. example: 5678-2345-1234-1234 activation_code_expiration: type: string description: 'The time when the activation code expires (format: ''yyyy-MM-ddThh:dd:ssZ'').' example: '2021-10-08T16:12:04Z' status: type: string description: "The values of this field can be `used` or `not_used`. \n \n used: The common area has been logged in to a smartphone through an activation code. \n \n not_used: The common area is never logged in to a smartphone through an activation code." example: used enum: - used - not_used site: type: object properties: site_id: type: string description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) that the common area is assigned. example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: The name of the site. example: Main Site next_page_token: type: string description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: RaO87FrnwXvFQta5aV8sU5C3c9O8s9Nraq2 page_size: type: integer description: The total number of records returned from a single API call. example: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n The next page token is invalid or expired.
\n**Error Code:** `400`
\n The account_id is invalid.
\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:list_common_area_activation_codes:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_common_area_activation_codes:admin /phone/common_areas/template_id/{templateId}: post: tags: - Common Areas summary: Apply template to common areas description: 'Applies a template to common areas. You can add up to 50 common areas at a time. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:apply_template_to_common_areas:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: ApplyTemplatetoCommonAreas parameters: - name: templateId in: path description: "The template ID is the unique identifier of the [Setting Template](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067442). \nYou can retrieve the identifier from the [List setting templates](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listSettingTemplates) API.\nIf the account enabled [multiple sites](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716#h_05c88e35-1593-491f-b1a8-b7139a75dc15), the setting template must belong to the same site as the common areas." required: true schema: type: string example: 2kFqiqSlS5udzWB5QqMiNg requestBody: content: application/json: schema: type: object properties: common_area_ids: maxItems: 50 type: array description: The `common_area_ids` is an array. Each element is the unique identifier of the [Common Area](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/listCommonAreas). It can be retrieved from the List Common Areas API. items: type: string description: The common area ID or common area extension ID. example: 5NmyHmVoRWWk4YT5ad6oxg responses: '201': description: '**HTTP Status Code:** `201` Template applied successfully.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n The template's site is not the same as the common area's site.
\n**Error Code:** `400`
\n Common area size must be less than 50.
\nYou need to have administrative privileges to edit this site.
\n**Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found The template type error or the template does not exist:{templateId}. \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:apply_template_to_common_areas:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:apply_template_to_common_areas:admin /phone/common_areas/{commonAreaId}: get: tags: - Common Areas summary: Get common area details description: "Returns detailed information on the common area.\n\n**Prerequisites** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: getACommonArea parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg responses: '200': description: "**HTTP Status Code:** `200` **OK** \n \nCommon area details returned successfully." content: application/json: schema: type: object properties: area_code: type: string description: The area code of the common area. example: '408' calling_plans: type: array items: type: object properties: name: type: string description: The calling plan name. example: US/CA Metered Calling Plan type: type: integer description: The calling plan type. example: 100 billing_account_id: type: string description: The billing account ID. It displays when the common area is in India. example: 3WWAEiEjTj2IQuyDiKMd_A billing_account_name: type: string description: The billing account name. It displays when the common area is in India. example: Delhi billing billing_subscription_id: type: string description: The billing subscription ID. It displays when the account supports billing multiple subscriptions. example: FT-SUBREF-21168178 billing_subscription_name: type: string description: The billing subscription name. It displays when the account supports billing multiple subscriptions. It can be edited via the Billing page. example: My Subscription cost_center: type: string description: The cost center the common area belongs to. example: pbx_cost_center 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 country_code: type: string description: The country calling code. example: '1' name: type: string description: The common area's country name. example: United States description: The common area country information. department: type: string description: The department the common area belongs to. example: department_pbx display_name: type: string description: The display name of the common area. example: test_ca extension_number: type: integer description: The extension number. format: int64 example: 100012347 default_transcription_language: type: string description: "The default language selection for features such as voicemail and call recording.\n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)" example: en-US enum: - en-US - en-GB - es-US - fr-CA - da-DK - de-DE - es-ES - fr-FR - it-IT - nl-NL - pt-PT - ja - ko-KR - pt-BR - zh-CN emergency_address: type: object properties: address_line1: type: string description: The emergency location address line 1. example: 55 Almaden Blvd address_line2: type: string description: The emergency location address line 2. example: 6th floor city: type: string description: The emergency location address city. example: San Jose country: type: string description: The country of the emergency location. example: US id: type: string description: The emergency location address ID. example: gBGwqgwoTb-DiSCA75tMWw state_code: type: string description: The emergency location 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` — Verfied. \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 emergency address information. id: type: string description: The common area ID or common area extension ID. example: SHzioi3ZR9SXv-XkLbmYCg outbound_caller_ids: type: array items: type: object properties: is_default: type: boolean description: 'Whether the outbound caller ID is the default one: if `true`, the outbound caller ID is the default caller ID.' example: true name: type: string description: The outbound caller name. example: Direct Number number: type: string description: The outbound caller number. example: '+12055437350' phone_numbers: type: array items: type: object properties: display_name: type: string description: The display name of the phone number. example: office phone id: type: string description: The phone number ID. example: TqH98ec8RVCu6Z00aBv9ow number: type: string description: The phone number. example: '+12055437350' source: type: string description: 'The phone number source: `internal` or `external`' example: internal enum: - internal - external policy: type: object properties: 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 prohibits modifying the current settings. example: account enum: - account - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true description: Whether the current extension can make international calls outside of their calling plan. outbound_calling: type: object properties: enable: type: boolean description: Whether to define calling rules to restrict user or extension from calling specific countries, cities or numbers. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework). example: true 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: true recording_transcription: type: boolean description: Whether the call recording transcription is enabled. example: true locked: type: boolean description: Whether the senior administrator allow 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: - account - user_group - site 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 of and resuming of automatic call recording is enabled. example: true enable: type: boolean description: Whether the 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: - account - user_group - site recording_calls: type: string description: "The type of calls automatically recorded: \n* `inbound` \n* `outbound` \n* `both`" example: inbound enum: - inbound - outbound - both recording_transcription: type: boolean description: Whether the call recording transcription is enabled. example: true 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 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 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 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 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 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 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 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 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 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: A list of the user's automatic call recording settings. call_park: type: object properties: call_not_picked_up_action: type: integer description: The action when a parked call is not picked up. 100-Ring back to parker, 0-Forward to voicemail of the parker, 9-Disconnect, 50-Forward to another extension. example: 9 enable: type: boolean description: Whether to allow calls placed on hold to be resumed from another location using a retrieval code. example: true expiration_period: type: integer description: A time limit for parked calls and unit minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated. example: 10 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: test extension name extension_id: type: string description: The extension ID. example: CcrEGgmeQem1uyJsuIRKwA extension_number: type: integer description: The extension number. format: int64 example: 1000123477 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: fWOgOALdT1ei4vjXK-QYsA description: The extension's forwarding information. 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: - account - user_group - site hand_off_to_room: type: object properties: enable: type: boolean description: Whether to allow extensions 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 prohibits the modification of the current settings. example: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true 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 allow_hide_outbound_caller_id: type: boolean description: Whether to allow the current extension to hide outbound caller id. 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: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true mobile_switch_to_carrier: type: object properties: enable: type: boolean description: Whether to allow the extension 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: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true voicemail_transcription: type: object properties: enable: type: boolean description: When this setting is enabled, voicemail 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. 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: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true 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 enable: type: boolean description: If enabled, the extension will receive email notifications when there is a new voicemail from users, call queues, auto receptionists, or shared line groups. 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: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset in the update call. example: true 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 prohibits modifying the current settings. example: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified.If modified, they can be reset in the update call. example: true description: Whether the user can check voicemails of users and shared line groups over phone using a PIN code. 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 modifying the current settings. example: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset in the update call. example: true description: Allow common area to use delegation. ios_call_kit: 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: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset in the update call. example: true description: Use CallKit always for Incoming call notifications on iOS/iPadOS devices. hide_zoom_phone_calls_in_ios: 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: account enum: - account - user_group - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset in the update call. example: true description: Hide Zoom Phone calls in iOS/iPadOS device call history. description: A list of the common area's policies. Policies are exceptions to the common area's restrictions. site: type: object properties: id: type: string description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned. example: SQv52YtkRLC2dwrDdYtGsA name: type: string description: The name of the site. example: Main site '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Common area does not exist: {commonAreaId}.
\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:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:common_area:admin delete: tags: - Common Areas summary: Delete a common area description: "Removes the common area. \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\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:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteCommonArea parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \ncommon area deleted successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {0}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:delete:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:common_area:admin patch: tags: - Common Areas summary: Update common area description: 'Updates the common area information. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: updateCommonArea parameters: - name: commonAreaId in: path required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg requestBody: content: application/json: schema: type: object properties: area_code: type: string description: The area code of the common area. example: '408' cost_center: type: string description: The cost center the common area belongs to. example: cost_center_pbx country_iso_code: type: string description: The two-lettered country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US department: type: string description: The department of which the common area belongs. example: department_pbx display_name: type: string description: The display name of the common area. example: common area 01 emergency_address_id: type: string description: The emergency location's address ID. example: gBGwqgwoTb-DiSCA75tMWw extension_number: type: integer description: The extension number of the phone. If the site code is enabled, provide the short extension number instead. format: int64 example: 1001014 outbound_caller_id: type: string description: The user's outbound caller ID phone number in E164 format. example: '+12055437350' policy: type: object properties: international_calling: type: object properties: enable: type: boolean description: If enabled, the common area can use international calling. example: true reset: type: boolean description: If reset, the common area international calling setting resets to the default setting. example: true description: Whether the current extension can make international calls outside of their calling plan. 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: true recording_explicit_consent: type: boolean description: Whether to press 1 to provide consent to be recorded. example: true recording_transcription: type: boolean description: Whether call recording transcription is enabled. example: true reset: type: boolean description: Whether the user's ad hoc recording reset option will use the phone site's settings. 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 of and resuming of automatic call recording is enabled. example: true enable: type: boolean description: Whether automatic call recording is enabled. 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_transcription: type: boolean description: Whether call recording transcription is enabled. example: true reset: type: boolean description: Whether the user's automatic call recording reset option will use the phone site's settings. example: true 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 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 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 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 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: A list of the user's automatic call recording settings. call_park: type: object properties: call_not_picked_up_action: type: integer description: The action when a parked call is not picked up. 100-Ring back to parker, 0-Forward to voicemail of the parker, 9-Disconnect, 50-Forward to another extension. example: 50 enum: - 0 - 9 - 50 - 100 enable: type: boolean description: Whether to allow calls placed on hold to be resumed from another location using a retrieval code. example: true expiration_period: type: integer description: A time limit for parked calls, unit minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated. example: 10 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 ID. example: CcrEGgmeQem1uyJsuIRKwA hand_off_to_room: type: object properties: enable: type: boolean description: 'This field enables an extension to send a call to a Zoom Room. Note: this policy applies to smartphone devices only and requires the "Common area smartphones" policy to be enabled.' example: true 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 allow_hide_outbound_caller_id: type: boolean description: Whether to allow the current extension to hide outbound caller id. example: true 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 voicemail_transcription: type: object properties: enable: type: boolean description: When this setting is enabled, voicemail 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. example: true reset: type: boolean description: Whether the extension's voicemail transcription reset option will use the phone site's(enable multiple site) or account's(disable multiple site) settings. example: true voicemail_notification_by_email: type: object properties: include_voicemail_file: type: boolean description: Whether to include voicemail file. example: true include_voicemail_transcription: type: boolean description: Whether to include voicemail transcription. example: true enable: type: boolean description: If enabled, extension will receive email notifications when there is a new voicemail from users, call queues, auto receptionists or shared line groups. example: true reset: type: boolean description: Whether the extension's voicemail notification by email reset option will use the phone site's(enable multiple site) or account's(disable multiple site) settings. example: true check_voicemails_over_phone: type: object properties: enable: type: boolean description: If enabled, user can check voicemails over phone using a PIN code. example: true reset: type: boolean description: Whether the user's check voicemail over phone reset option will use the phone site's settings. example: true delegation: type: boolean description: Whether the extension can use [call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation-shared-lines-appearance-). example: true ios_call_kit: type: object properties: enable: type: boolean description: If enable, CallKit will always be used for Zoom Phone incoming call notifications on iOS/iPadOS devices. The maximum number of concurrent calls supported will decrease from four to two. example: true reset: type: boolean description: Whether the extension's callkit reset option will use the phone site's(enable multiple site) or account's(disable multiple site) settings. example: true description: Uses CallKit always for Incoming call notifications on iOS/iPadOS devices. hide_phone_call_history_in_ios: type: object properties: enable: type: boolean description: When set to true, Zoom Phone calls will no longer appear in the iOS/iPadOS Recent list. This requires CallKit to be enabled and client version 6.3.0 or later. example: true reset: type: boolean description: Whether the extension's hide phone call history in ios reset option will use the phone site's(enable multiple site) or account's(disable multiple site) settings. example: true description: Hides Zoom Phone calls in iOS/iPadOS device call history. description: A list of the common area's policies. site_id: type: string description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned. example: SQv52YtkRLC2dwrDdYtGsA timezone: type: string description: ' The [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists) for the common area.' example: Europe/Berlin default_transcription_language: type: string description: "The default language selection for features such as voicemail and call recording.\n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)" example: en-US enum: - en-US - en-GB - es-US - fr-CA - da-DK - de-DE - es-ES - fr-FR - it-IT - nl-NL - pt-PT - ja - ko-KR - pt-BR - zh-CN responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nCommon area information updated successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {0}.
\n**Error Code:** `409`
\n A conflict occurred with the target extension number. Try again later.
\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:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area:admin /phone/common_areas/{commonAreaId}/call_handling/settings: get: tags: - Common Areas summary: Get common area call handling setting description: 'Returns the call handling setting of a common area for the specified hour type. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: getCommonAreaCallHandlingSetting parameters: - name: commonAreaId in: path description: The unique identifier of the common area. required: true schema: type: string example: OJGi5xOFQPmrJbKg68-iWg - name: hour_type in: query description: The hour type of the call handling setting. required: false schema: type: string example: business_hours enum: - business_hours - closed_hours - holiday_hours - break_hours - name: holiday_hour_id in: query description: The holiday hour ID. Required when `hour_type` is `holiday_hours`. required: false schema: type: string example: TNxfEp2WT9emyCsAQt4qnA - name: break_hour_id in: query description: The break hour ID. Required when `hour_type` is `break_hours`. required: false schema: type: string example: ULfeE4mgSImyelNmTekUfg responses: '200': description: '**HTTP Status Code:** `200` Common area call handling setting retrieved successfully.' content: application/json: schema: type: object properties: call_distribution_setting: type: object properties: ring_device: type: boolean description: Whether to ring the device when a call comes in. example: true ring_duration: type: integer description: The number of seconds the device rings before the unanswered action is triggered. example: 30 enum: - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 description: The call distribution settings that control how incoming calls are routed to the user's devices. call_handling_setting: type: object properties: call_not_answer_action: type: string description: 'The action to take when a call is not answered: * `forward_to_voicemail` — Forward to voicemail. * `forward_to_extension` — Forward to an extension. * `forward_to_external_contact` — Forward to an external contact. * `play_message_then_disconnect` — Play a message and then disconnect. * `disconnect` — Disconnect.' example: forward_to_voicemail enum: - forward_to_voicemail - forward_to_extension - forward_to_external_contact - play_message_then_disconnect - disconnect call_not_answer_action_setting: description: The call handling setting based on the `call_not_answer_action` value. Only present when `call_not_answer_action` is not `disconnect`. oneOf: - title: Forward to Voicemail type: object properties: allow_callers_check_voicemail: type: boolean description: Whether to allow callers to check voicemail. example: false connect_to_operator: type: boolean description: Whether to allow callers to reach an operator. example: false operator_extension: type: object properties: extension_id: type: string description: The operator's extension ID. example: jN9mb38lQTaMgxUq3Nd6ow extension_number: type: integer description: The operator's extension number. format: int64 example: 101014 extension_name: type: string description: The operator's display name. example: user A extension_type: type: string description: The operator's extension type. example: user enum: - user - callQueue - autoReceptionist - commonArea - sharedLineGroup - zoomRoom - ciscoRoom/PolycomRoom description: The operator's extension information. Only present when `connect_to_operator` is `true`. voicemail_greeting: 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: voicemail-greeting.mp3 description: The voicemail greeting prompt. leave_voicemail_instruction: 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: leave-voicemail-instruction.mp3 description: The leave voicemail instruction prompt. Only returned when `connect_to_operator` or `allow_callers_check_voicemail` is `true`. play_callee_voicemail_greeting: type: boolean description: Whether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. Only returned when `connect_to_operator` is `true`. example: false description: Only returned when `call_not_answer_action` is `forward_to_voicemail`. - title: Forward to Another Extension type: object properties: forward_to_extension: type: object properties: extension_id: type: string description: The extension ID. example: jN9mb38lQTaMgxUq3Nd6ow extension_number: type: integer description: The extension number. format: int64 example: 101014 extension_name: type: string description: The extension display name. example: user A extension_type: type: string description: The extension type. example: user enum: - user - callQueue - autoReceptionist - commonArea - sharedLineGroup - zoomRoom - ciscoRoom/PolycomRoom description: The extension to forward calls to. play_callee_voicemail_greeting: type: boolean description: Whether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. example: false description: Only returned when `call_not_answer_action` is `forward_to_extension`. - title: Forward to External Contact type: object properties: forward_to_external_contact: type: object properties: external_contact_id: type: string description: The external contact's ID. example: OJGi5xOFQPmrJbKg68-iWg external_contact_name: type: string description: The external contact's name. example: Johnson external_contact_email: type: string description: The external contact's email address. example: example@example.com phone_numbers: type: array description: The external contact's phone numbers. items: type: string example: '+12058945656' description: The external contact to forward calls to. description: Only returned when `call_not_answer_action` is `forward_to_external_contact`. - title: Play a Message then Disconnect type: object properties: message_greeting: 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: message.mp3 description: The message audio prompt played before disconnecting. description: Only returned when `call_not_answer_action` is `play_message_then_disconnect`. description: The call handling settings. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read:common_area_call_handling_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:common_area_call_handling_setting:admin /phone/common_areas/{commonAreaId}/call_handling/settings/{hourType}: patch: tags: - Common Areas summary: Update common area call handling setting description: 'Update the call handling setting of a common area for the specified hour type. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: updateCommonAreaCallHandlingSetting parameters: - name: commonAreaId in: path description: The unique identifier of the common area. required: true schema: type: string example: OJGi5xOFQPmrJbKg68-iWg - name: hourType in: path description: The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`. required: true schema: type: string example: business_hours enum: - business_hours - closed_hours - holiday_hours - break_hours requestBody: content: application/json: schema: type: object properties: holiday_hour_id: type: string description: The holiday hour ID. Required when `hourType` is `holiday_hours`. example: TNxfEp2WT9emyCsAQt4qnA break_hour_id: type: string description: The break hour ID. Required when `hourType` is `break_hours`. example: ULfeE4mgSImyelNmTekUfg call_distribution_setting: type: object properties: ring_device: type: boolean description: Whether to ring the device when a call comes in. example: true ring_duration: type: integer description: The number of seconds the device rings before the unanswered action is triggered. example: 30 enum: - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 description: The call distribution settings that control how incoming calls are routed to the common area. call_handling_setting: type: object properties: call_not_answer_action: type: string description: 'The action to take when a call is not answered: * `forward_to_voicemail` — Forward to voicemail. * `forward_to_extension` — Forward to an extension. * `forward_to_external_contact` — Forward to an external contact. * `play_message_then_disconnect` — Play a message and then disconnect. * `disconnect` — Disconnect.' example: forward_to_voicemail enum: - forward_to_voicemail - forward_to_extension - forward_to_external_contact - play_message_then_disconnect - disconnect call_not_answer_action_setting: description: The call handling setting based on the `call_not_answer_action` value. Only present when `call_not_answer_action` is not `disconnect`. oneOf: - title: Forward to Voicemail type: object properties: allow_callers_check_voicemail: type: boolean description: Whether to allow callers to check voicemail. example: false connect_to_operator: type: boolean description: Whether to allow callers to reach an operator. example: false operator_extension: type: object properties: extension_id: type: string description: The operator's extension ID. example: jN9mb38lQTaMgxUq3Nd6ow description: The operator's extension information. Only required when `connect_to_operator` is `true`. voicemail_greeting: type: object properties: audio_id: type: string description: The audio prompt file ID. example: yCT14TwySDGVUypVlKNEyA description: The voicemail greeting prompt. leave_voicemail_instruction: type: object properties: audio_id: type: string description: The audio prompt file ID. example: yCT14TwySDGVUypVlKNEyA description: The leave voicemail instruction prompt. This only takes effect when `connect_to_operator` or `allow_callers_check_voicemail` is `true`. play_callee_voicemail_greeting: type: boolean description: Whether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. This only takes effect when `connect_to_operator` is `true`. example: false description: Only used when `call_not_answer_action` is `forward_to_voicemail`. - title: Forward to Extension type: object properties: forward_to_extension: required: - extension_id type: object properties: extension_id: type: string description: The extension ID. example: jN9mb38lQTaMgxUq3Nd6ow description: The extension to forward calls to. play_callee_voicemail_greeting: type: boolean description: Whether to play the callee's voicemail greeting when the caller reaches the end of the forwarding sequence. example: false description: Only used when `call_not_answer_action` is `forward_to_extension`. - title: Forward to External Contact type: object properties: forward_to_external_contact: required: - external_contact_id type: object properties: external_contact_id: type: string description: The external contact's ID. example: OJGi5xOFQPmrJbKg68-iWg description: The external contact to forward calls to. description: Only used when `call_not_answer_action` is `forward_to_external_contact`. - title: Play a Message then Disconnect type: object properties: message_greeting: type: object properties: audio_id: type: string description: The audio prompt file ID. example: yCT14TwySDGVUypVlKNEyA description: The message audio prompt played before disconnecting. description: Only used when `call_not_answer_action` is `play_message_then_disconnect`. description: The call handling settings. responses: '204': description: Common area call handling setting updated successfully. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13802`
\n Audio does not exist: {audioId}.
\n**Error Code:** `13808`
\n Extension does not exist: {extension_id}.
\n**Error Code:** `13810`
\n External contact does not exist: {0}.
\n**Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n" security: - openapi_oauth: - phone:write:admin - phone:update:common_area_call_handling_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area_call_handling_setting:admin /phone/common_areas/{commonAreaId}/calling_plans: post: tags: - Common Areas summary: Assign calling plans to a common area description: 'Assigns calling plans to a common area. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: assignCallingPlansToCommonArea parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg requestBody: content: application/json: schema: required: - calling_plans type: object properties: calling_plans: maxItems: 20 type: array items: required: - type type: object properties: type: type: integer description: The Zoom Phone [calling plan number](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). example: 100 billing_account_id: type: string description: The billing account ID. If the user is in India, the field is required. example: 3WWAEiEjTj2IQuyDiKMd_A billing_subscription_id: type: string description: The billing subscription ID. When there is more than one plan type A in this account, it cannot be empty. example: FT-SUBREF-21168178 responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nAssigning calling plans to the common area is successful." content: application/json: schema: type: object properties: calling_plans: maxItems: 20 type: array items: type: object properties: name: type: string description: The calling plan name. example: US/CA Metered Calling Plan type: type: integer description: The Zoom Phone [calling plan number](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). example: 100 billing_account_id: type: string description: The billing account ID. It displays when the common area is in India. example: 3WWAEiEjTj2IQuyDiKMd_A billing_account_name: type: string description: The billing account name. It displays when the common area is in India. example: Delhi billing '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n The common area does not exist: {commonAreaId}.
\n**Error Code:** `405`
\n The number of items for `calling_plans` must not exceed 20.
\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:common_area_calling_plan:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area_calling_plan:admin /phone/common_areas/{commonAreaId}/calling_plans/{type}: delete: tags: - Common Areas summary: Unassign a calling plan from the common area description: "Use this API to unassign a calling plan from the common area.\n\n**Prerequisites:** \n* A Pro or higher account with a Zoom Phone license \n* An account owner or admin permissions \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:common_area_calling_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: unassignCallingPlansFromCommonArea parameters: - name: commonAreaId in: path description: The Common area ID or common area extension ID. required: true schema: type: string example: SHzioi3ZR9SXv-XkLbmYCg - name: type in: path description: The Zoom Phone [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to remove. required: true schema: type: string example: '100' - name: billing_account_id in: query description: The billing account ID. If the common area is in India, the parameter is required. required: false schema: type: string example: 3WWAEiEjTj2IQuyDiKMd_A responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n Removing assigned calling plans from common area is successful." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n The common area does not exist: {commonAreaId}.
\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:common_area_calling_plan:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:common_area_calling_plan:admin /phone/common_areas/{commonAreaId}/phone_numbers: post: tags: - Common Areas summary: Assign phone numbers to a common area description: 'Assigns phone numbers to a common area. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: assignPhoneNumbersToCommonArea parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg requestBody: content: application/json: schema: required: - phone_numbers type: object properties: phone_numbers: maxItems: 20 type: array items: type: object properties: id: type: string description: The phone number ID. example: TqH98ec8RVCu6Z00aBv9ow number: type: string description: The phone number. example: '+12055437350' responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nAssigned phone numbers to the common area successfully." content: application/json: schema: type: object properties: phone_numbers: maxItems: 20 type: array items: type: object properties: id: type: string description: The phone number ID. example: TqH98ec8RVCu6Z00aBv9ow number: type: string description: The phone number. example: '+12055437350' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n**Error Code:** `405`
\n The number of items for `phone_numbers` must not exceed 20.
\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:common_area_number:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area_number:admin /phone/common_areas/{commonAreaId}/phone_numbers/{phoneNumberId}: delete: tags: - Common Areas summary: Unassign phone numbers from common area description: 'Unassigns a phone number from a common area. **Prerequisites** * A Pro or a higher account with a Zoom Phone license * An account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: unassignPhoneNumbersFromCommonArea parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: SHzioi3ZR9SXv-XkLbmYCg - name: phoneNumberId in: path description: The phone number or the phone number ID. required: true schema: type: string example: TqH98ec8RVCu6Z00aBv9ow responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nRemoving assigned phone numbers from common area is successful." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n The common area does not exist: {commonAreaId}.
\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:common_area_number:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:common_area_number:admin /phone/common_areas/{commonAreaId}/pin_code: patch: tags: - Common Areas summary: Update common area pin code description: "Updates the common area pin code.\n\n**Prerequisites**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions, This depends on whether [The PIN cannot be viewed by the admin](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069783) is 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:update:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: UpdateCommonAreaPinCode parameters: - name: commonAreaId in: path required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg requestBody: content: application/json: schema: required: - pin_code type: object properties: pin_code: type: string description: The pin code to access voicemail, hot desking, unlock desk phones, and call authorized-required. example: '67941' responses: '204': description: '**HTTP Status Code:** `204` **No Content** Common area pin code updated successfully.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Validation failed.
\n* The PIN Code cannot be updated by the admin.\n* PIN code could only include numbers.\n* Invalid PIN code. PIN code must be {0} digits long. \n* Invalid PIN code. PIN code must be {0} to {1} digits long.\n* Invalid PIN code. Your PIN code must not be the same as the extension number.\n* Invalid PIN code. The PIN code must not contain a group of repeated digits.\n* PIN code cannot be an ascending or descending group of digits.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \nCommon area does not exist: {commonAreaId}. \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:update:common_area:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area:admin /phone/common_areas/{commonAreaId}/settings: get: tags: - Common Areas summary: Get common area settings description: 'Returns common area settings. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_common_area_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: getCommonAreaSettings parameters: - name: commonAreaId in: path description: The common area ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg - name: setting_type in: query description: "The setting item to query. Defaults to `desk_phone` if not provided. \n\nAllowed values: `desk_phone`, `holiday_hours`, `custom_hours`, `business_hours`, `break_hours`." required: false schema: type: string example: desk_phone enum: - desk_phone - holiday_hours - custom_hours - business_hours - break_hours responses: '200': description: "**HTTP Status Code:** `200` \n \nCommon Area Setting object returned." content: application/json: schema: description: The common area setting. oneOf: - title: Returned only when the setting type is desk_phone or not specified. type: object properties: desk_phones: type: array description: Desk phones. items: type: object properties: id: type: string description: The desk phone ID. example: Aky1xpSLSc2PR0XOtj9XWQ display_name: type: string description: The desk phone display name. example: analog_ta device_type: type: string description: The desk phone device type. example: Poly obi504 status: type: string description: The desk phone status. example: offline enum: - online - offline mac_address: type: string description: The MAC address or serial number of the device. example: 203a07240534 hot_desking: type: object properties: status: type: string description: "This field allows the hot desking feature to the current device: letting the guest user sign in to the desk phone. You can't use the desk phone until the guest user signs out. \nOptions include:\n* `unsupported` \n* `on` \n* `off`" example: 'off' enum: - unsupported - 'on' - 'off' description: Hot desking. private_ip: type: string description: The private IP of the registered device. example: 192.168.10.13 public_ip: type: string description: The public IP of the registered device. example: 220.148.231.126 - title: Returned only when the setting type is holiday_hours. type: object properties: holiday_hours: type: array description: Holiday hours. items: type: object properties: holiday_id: type: string description: The holiday ID. example: ULfeE4mgSImyelNmTekUfg name: type: string description: The name of the holiday. example: test from: type: string description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-05T00:00:00Z' to: type: string description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. format: date-time example: '2022-03-06T00:00:00Z' - title: Returned only when the setting type is custom_hours. type: object properties: custom_hours_settings: type: object properties: custom_hours: type: array description: The custom hours settings. items: type: object properties: from: type: string description: The custom hours start time `HH:mm` format. example: 09:00 to: type: string description: The custom hours end time in `HH:mm` format. example: '18:00' type: type: integer description: "The type of custom hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours." example: 1 enum: - 0 - 1 - 2 weekday: type: integer description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday" example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 custom_hour_type: type: integer description: "The type of custom hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Custom hours. \n\n." example: 2 enum: - 1 - 2 description: Custom hours. deprecated: true deprecated: true - title: Returned only when the setting type is business_hours. type: object properties: business_hours_settings: type: object properties: business_hours: maxItems: 7 type: array description: The business hours settings. items: type: object properties: from: type: string description: The business hours start time in `HH:mm` format. example: 09:00 to: type: string description: The business hours end time in `HH:mm` format. example: '18:00' type: type: integer description: "The type of business hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours." example: 1 enum: - 0 - 1 - 2 weekday: type: integer description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday." example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 business_hour_type: type: integer description: "The type of business hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Customized hours." example: 2 enum: - 1 - 2 description: The business hours settings. description: Returned only when the setting type is `business_hours`. - title: Returned only when the setting type is break_hours. type: object properties: break_hours: type: array description: The list of break hours. items: type: object properties: break_hour_id: type: string description: The unique identifier of the break hour. example: R4GeDFaLTpeQb1jPDCuPhA break_hour_name: maxLength: 255 minLength: 1 type: string description: The name of the break hour. example: Lunch Break break_hour_type: type: string description: "The type of break hour schedule: \n\n* `every_business_day` — The break applies at the same time on every business day. \n\n* `custom_hours` — The break applies on specific days of the week with individually configured times." example: every_business_day enum: - every_business_day - custom_hours break_hour_setting: description: The break hour time configuration. The structure depends on the `break_hour_type` field. oneOf: - title: Every Business Day required: - from - to type: object properties: from: type: string description: The start time of the break in `HH:mm` format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time. example: '13:00' description: Only returned when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days. - title: Custom Hours required: - days type: object properties: days: maxItems: 7 type: array description: The list of days with configured break times. Only includes days that have break hours enabled. items: required: - from - to - weekday type: object properties: weekday: type: integer description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday." example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 enable: type: boolean description: Whether the break hour is enabled on this day. example: true from: type: string description: The start time of the break on this day in `HH:mm` format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break on this day in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time. example: '13:00' description: Only returned when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\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:list_common_area_settings:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_common_area_settings:admin /phone/common_areas/{commonAreaId}/settings/{settingType}: post: tags: - Common Areas summary: Add common area setting description: 'Adds the common area setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: AddCommonAreaSetting parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg - name: settingType in: path description: 'The setting item to add. Allowed values: `desk_phone`, `holiday_hours`, `break_hours`.' required: true schema: type: string example: desk_phone enum: - desk_phone - holiday_hours - break_hours requestBody: content: application/json: schema: oneOf: - title: The device ID. type: object properties: device_id: type: string description: The desk phone ID.This field is only required for the `desk_phone` setting type. example: ULfeE4mgSImyelNmTekUfg - title: Holiday settings type: object properties: holiday_hours: type: object properties: holidays: maxItems: 10 minItems: 1 type: array description: The holiday list. The minimum is one item, and the maximum is 10 items. items: type: object properties: name: type: string description: The name of the holiday. example: holiday name from: type: string description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-05T00:00:00Z' to: type: string description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-06T00:00:00Z' description: Each holiday. description: This field is only required for the `holiday_hours` setting type. - title: Break hour settings type: object properties: break_hours: type: object properties: break_hour_settings: maxItems: 5 type: array description: The list of break hours. items: required: - break_hour_name - break_hour_type type: object properties: break_hour_name: maxLength: 255 minLength: 1 type: string description: The name of the break hour. example: Lunch Break break_hour_type: type: string description: "The type of break hour schedule. \n* `every_business_day` — The break applies at the same time on every business day. \n* `custom_hours` — The break applies on specific days of the week with individually configured times." example: every_business_day enum: - every_business_day - custom_hours break_hour_setting: description: The break hour time configuration. The structure depends on the `break_hour_type` field. oneOf: - title: Every Business Day required: - from - to type: object properties: from: type: string description: The start time of the break in HH:mm format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break in HH:mm format (24-hour clock). For example, `13:00`. This value must be after the `from` time. example: '13:00' description: Only applicable when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days. - title: Custom Hours required: - days type: object properties: days: maxItems: 7 type: array description: The list of days with configured break times. Only includes days that have break hours enabled. items: required: - from - to - weekday type: object properties: weekday: type: integer description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday" example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 enable: type: boolean description: Whether the break hour is enabled on this day. example: true from: type: string description: The start time of the break on this day in HH:mm format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break on this day in HH:mm format (24-hour clock). For example, `13:00`. This value must be after the `from` time. example: '13:00' description: Only applicable when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges. description: This field is only required for the `break_hours` setting type. The `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`. responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully." content: application/json: schema: oneOf: - title: desk phones type: object properties: desk_phones: maxItems: 3 type: array description: All desk phones.Returned only when the setting type is desk_phone. items: type: object properties: id: type: string description: The desk phone ID. example: Aky1xpSLSc2PR0XOtj9XWQ display_name: type: string description: The desk phone display name. example: analog_ta - title: Holiday settings type: object properties: holiday_hours: type: object properties: holidays: maxItems: 10 type: array items: type: object properties: holiday_id: type: string description: The holiday ID. example: ULfeE4mgSImyelNmTekUfg name: type: string description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: holiday name from: type: string description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-05T00:00:00Z' to: type: string description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-06T00:00:00Z' description: All holiday hour settings. Returns only when the setting type is `holiday_hours`. - title: Break hour settings type: object properties: break_hours: type: object properties: break_hour_settings: maxItems: 5 type: array description: The list of break hours. items: required: - break_hour_id - break_hour_name type: object properties: break_hour_id: type: string description: The unique identifier of the break hour. example: R4GeDFaLTpeQb1jPDCuPhA break_hour_name: maxLength: 255 minLength: 1 type: string description: The name of the break hour. example: Lunch Break description: This field is only returned for the `break_hours` setting type. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n**Error Code:** `405`
\n The number of items for holiday_hours.holidays must not exceed 10.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\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:common_area_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area_setting:admin delete: tags: - Common Areas summary: Delete common area setting description: "Removes the common area subsetting from desk phones. \n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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:common_area_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteCommonAreaSetting parameters: - name: commonAreaId in: path description: The common area ID or common area extension ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg - name: settingType in: path description: 'The setting type to delete. Allowed values: `desk_phone`, `holiday_hours`, `break_hours`.' required: true schema: type: string example: desk_phone enum: - desk_phone - holiday_hours - break_hours - name: device_id in: query description: The desk phone ID. You should complete the `desk_phone settingType`field. required: false schema: type: string example: TNxfEp2WT9emyCsAQt4qnA - name: holiday_hour_id in: query description: The holiday hour ID. You should complete the `holiday_hours settingType`field. required: false schema: type: string example: TNxfEp2WT9emyCsAQt4qnA - name: break_hour_id in: query description: The break hour ID. Required when `settingType` is `break_hours`. `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`. required: false schema: type: string example: ULfeE4mgSImyelNmTekUfg responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n The common area does not exist: {0}.
\n**Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\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:common_area_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:common_area_setting:admin patch: tags: - Common Areas summary: Update common area setting description: 'Updates the common area setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateCommonAreaSetting parameters: - name: commonAreaId in: path description: The common area ID. required: true schema: type: string example: 5NmyHmVoRWWk4YT5ad6oxg - name: settingType in: path description: 'This setting corresponds to the setting item you want to modify. Allowed values: `desk_phone`, `holiday_hours`, `business_hours`, `custom_hours`, `break_hours`.' required: true schema: type: string example: desk_phone enum: - desk_phone - holiday_hours - custom_hours - business_hours - break_hours requestBody: content: application/json: schema: oneOf: - title: Desk phones. This field is only required for the `desk_phone` setting type. type: object properties: desk_phones: maxItems: 3 type: array description: The desk phones. items: type: object properties: id: type: string description: The desk phone ID. example: ULfeE4mgSImyelNmTekUfg hot_desking: type: object properties: status: type: string description: "This field allows the hot desking feature to the current device: allows the guest user to sign in to the desk phone. You can't use the desk phone until the guest user signs out. \nOptions include:\n* `on` \n* `off`" example: 'off' enum: - 'on' - 'off' description: Hot desking. - title: Holiday settings. This field is only required for the `holiday_hours` setting type. type: object properties: holiday_hours: type: object properties: holidays: maxItems: 10 minItems: 1 type: array description: Holidays items: type: object properties: holiday_id: type: string description: The holiday ID. example: ULfeE4mgSImyelNmTekUfg name: type: string description: The name of the holiday. example: test from: type: string description: The holiday's start date and time, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-05T00:00:00Z' to: type: string description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. example: '2022-03-06T00:00:00Z' description: The holiday hours. - title: Custom hours settings. This action ignores break hours and may create breaks outside of defined business hours.This field is only required for the `custom_hours` setting type. type: object properties: custom_hours_settings: type: object properties: custom_hours: maxItems: 7 type: array description: The custom hours settings. items: type: object properties: from: type: string description: The custom hours start time `HH:mm` format. example: 09:00 to: type: string description: The custom hours end time in `HH:mm` format. example: '18:00' type: type: integer description: "The type of custom hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours." example: 1 enum: - 0 - 1 - 2 weekday: type: integer description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday" example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 custom_hour_type: type: integer description: "The type of custom hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Custom hours. \n\n." example: 2 enum: - 1 - 2 description: Custom hour settings. deprecated: true deprecated: true - title: Business hour settings.This field is only required for the `business_hours` setting type. type: object properties: business_hours_settings: type: object properties: business_hours: maxItems: 7 type: array description: The business hours settings. items: type: object properties: from: type: string description: The business hours start time in `HH:mm` format. example: 09:00 to: type: string description: The business hours end time in `HH:mm` format. example: '18:00' type: type: integer description: "The type of business hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours." example: 1 enum: - 0 - 1 - 2 weekday: type: integer description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday." example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 business_hour_type: type: integer description: "The type of business hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Customized hours." example: 2 enum: - 1 - 2 description: The business hours settings. description: Use this schema when the setting type is `business_hours`. - title: Break hour settings.This field is only required for the `break_hours` setting type. type: object properties: break_hours: type: object properties: break_hour_settings: maxItems: 5 type: array description: The list of break hour settings. items: type: object properties: break_hour_id: type: string description: The unique identifier of the break hour. example: R4GeDFaLTpeQb1jPDCuPhA break_hour_name: maxLength: 255 minLength: 1 type: string description: The name of the break hour. example: Lunch Break break_hour_type: type: string description: "The type of break hour schedule: \n* `every_business_day` — The break applies at the same time on every business day. \n* `custom_hours` — The break applies on specific days of the week with individually configured times." example: every_business_day enum: - every_business_day - custom_hours break_hour_setting: description: The break hour time configuration. The structure depends on the `break_hour_type` field. oneOf: - title: Every Business Day required: - from - to type: object properties: from: type: string description: The start time of the break in `HH:mm` format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time. example: '13:00' description: Only applicable when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days. - title: Custom Hours required: - days type: object properties: days: maxItems: 7 type: array description: The list of days with configured break times. Only includes days that have break hours enabled. items: required: - from - to - weekday type: object properties: weekday: type: integer description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday." example: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 enable: type: boolean description: Whether the break hour is enabled on this day. example: true from: type: string description: The start time of the break on this day in `HH:mm` format (24-hour clock). For example, `12:00`. example: '12:00' to: type: string description: The end time of the break on this day in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time. example: '13:00' description: Only applicable when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges. description: This field is only required for the `break_hours` setting type. The `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`. responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Common area does not exist: {commonAreaId}.
\n**Error Code:** `405`
\n The number of items for desk_phones must not exceed 3.
\n**Error Code:** `405`
\n The number of items for custom_hours_settings.custom_hours must not exceed 7.
\n**Error Code:** `405`
\n The number of items for holiday_hours.holidays must not exceed 10.
\n**Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\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:common_area_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area_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