openapi: 3.2.0 info: title: Phone Shared Line Group 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: Shared Line Group paths: /phone/shared_line_groups: get: tags: - Shared Line Group summary: List shared line groups description: "Lists all the shared line groups. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This capability gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_shared_line_groups:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`" operationId: listSharedLineGroups parameters: - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 - name: next_page_token in: query description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. required: false schema: type: string example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2 responses: '200': description: "**HTTP Status Code:** `200` **OK** \n\nShared Line Groups returned." content: application/json: schema: type: object properties: next_page_token: type: string description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: MnriWtiIAzrEfe3EW5ORlj6TFBFqL57AC42 page_size: maximum: 300 type: integer description: The number of records returned within a single API call. example: 30 default: 30 shared_line_groups: type: array items: type: object properties: display_name: type: string description: The display name of the shared line group. example: jamieSLGTest extension_id: type: string description: The extension ID. example: FkOFn6d5SGqqqIkyDSXrTg extension_number: type: integer description: The extension number assigned to the Shared Line Group. format: int64 example: 1000123471 id: type: string description: The unique identifier of the Shared Line Group. example: RQinnFtmTJ25mx89tW5Cmw phone_numbers: type: array description: The phone numbers assigned to the shared line group. items: type: object properties: id: type: string description: The unique identifier of the phone number. example: 55JUZPwERHuGttd_j4qBsQ number: type: string description: The phone number in E164 format. example: '+12058945565' status: type: string description: The status of the number. example: available enum: - pending - available site: type: object properties: id: type: string description: The unique identifier of the [site](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/getASite). example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: The name of the site. example: Main Site status: type: string description: The status of the shared line group. example: active enum: - active - inactive total_records: type: integer description: The total records found in the response for this request. example: 14 '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_shared_line_groups:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_shared_line_groups:admin post: tags: - Shared Line Group summary: Create a shared line group description: "Creates a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: createASharedLineGroup requestBody: content: application/json: schema: required: - display_name type: object properties: description: maxLength: 255 type: string description: The description for the shared line group. example: test shared line display_name: maxLength: 200 type: string description: The name to identify the shared line group. example: Mtest sharedLineGroup extension_number: type: integer description: 'Extension number to be assigned to the shared line group. If a [site code has been assigned](https://support.zoom.us/hc/en-us/articles/360020809672#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number ' format: int64 example: 1000123487 site_id: type: string description: 'The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) that you would like to use for the shared line group. You will only be able to add members that belong to this site to the shared line group. This field is required only if the [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) option has been enabled for the account.' example: 8f71O6rWT8KFUGQmJIFAdQ responses: '201': description: '**HTTP Status Code:** `201` **Created** Shared Line Group created successfully.' content: application/json: schema: type: object properties: id: type: string description: ' The unique identifier of the shared line group.' example: RQinnFtmTJ25mx89tW5Cmw display_name: type: string description: ' The display name of the shared line group.' example: jamieSLGTest '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n**Error Code:** `400`
\n Extension number {extensionNumber} is already used.


\n**Error Code:** `409`
\n Invalid short number length.
\nNumber {extensionNumber} is a reserved extension number.
\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:shared_line_group:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:shared_line_group:admin /phone/shared_line_groups/{sharedLineGroupId}: get: tags: - Shared Line Group summary: Get a shared line group description: " Returns a list of all the shared line groups. \n \n A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \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:shared_line_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: getASharedLineGroup parameters: - name: sharedLineGroupId in: path description: The unique identifier of the shared line group. required: true schema: type: string example: RQinnFtmTJ25mx89tW5Cmw responses: '200': description: OK content: application/json: schema: type: object properties: display_name: type: string description: The display name of the shared line group. example: jamieSLGTest extension_id: type: string description: The extension ID of the shared line group. example: WfsrPERXS8inWrpH1Hi_KQ extension_number: type: integer description: The extension number assigned to the shared line group. format: int64 example: 1000123471 id: type: string description: The unique identifier of the shared line group. example: RQinnFtmTJ25mx89tW5Cmw members: type: object properties: users: type: array description: The users who are members of the shared line group. items: type: object properties: id: type: string description: The unique identifier of the user. example: mNlwFK9ISMKC2toK9oDTcg name: type: string description: The name of the user. example: ZOOM_API Test extension_id: type: string description: The extension ID of the user. example: oeDyBe8zT2SzOZW6gQJXUA common_areas: type: array items: type: object properties: id: type: string description: The unique identifier of the common area. example: HIlHzOEzS8ymQPFBZ-39AQ name: type: string description: The name of the common area. example: Common Area extension_id: type: string description: The extension ID of the common area. example: HIlHzOEzS8ymQPFBZ-39AQ description: This field allows you to view current [members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_3ffbbb77-a009-4c09-91e4-81fc264b61d6) of the shared line group. phone_numbers: type: array description: The object representing information about phone number(s) assigned to the group. items: type: object properties: id: type: string description: The unique identifier of the phone number. example: '---M1padRvSUtw7YihN7sA' number: type: string description: The phone number in E164 format. example: '14232058798' primary_number: type: string description: "If you have multiple direct phone numbers assigned to the shared line group, this is the primary number selected for desk phones. \n\nThe primary number shares the same line as the extension number. This means if a caller is routed to the shared line group through an auto receptionist, the line associated with the primary number will be used." example: '14232058798' site: type: object properties: id: type: string description: The unique identifier of the [site](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/getASite). example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: The name of the site. example: Main Site description: The site assigned to the shared line group. status: type: string description: The status of the shared line group. example: active enum: - active - inactive timezone: type: string description: The [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Shared Line Group. example: Pacific/Midway policy: type: object properties: voicemail_access_members: uniqueItems: true type: array description: The shared voicemail access member list. items: allOf: - allOf: - type: object properties: access_user_id: type: string description: The Zoom user ID or email or common area ID to share or update the access permissions with. example: w0RChiauQeqRlv5fgxYULQ allow_download: type: boolean description: This field specifies whether the member has download permissions. Not applicable to `commonArea`. The default is **false**. example: false allow_delete: type: boolean description: This field specifies whether the member has delete permissions. The default is **false**. example: false allow_sharing: type: boolean description: This field specifies whether the member has permission to share. The default is **false**. example: false - type: object properties: shared_id: type: string description: The shared voicemail ID that the member can access. example: --e8ugg0SeS-9clgrDkn2w - type: object properties: access_user_type: type: string description: 'The type of access member: `user` or `commonArea`.' example: user enum: - user - commonArea description: The shared line group policy list. cost_center: type: string description: The cost center name. example: Cost center department: type: string description: The department name. example: Department audio_prompt_language: type: string description: "The language for all default audio prompts for the Shared Line Group. \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 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 recording_storage_location: type: string description: "Where the recording will be stored. Recording includes Phone recordings, voicemail, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\nNote: \n* If the setting is locked at the Account level, it can't be updated." example: US enum: - US - AU - CA - DE - IN - JP - SG - BR - CN - MX own_storage_name: type: string description: The name of your own storage. Use your own storage provided by Oracle Cloud Infrastructure (OCI) to store Zoom Phone recordings, voicemails, and voicemail transcripts, and custom greeting prompts. example: us-oracle-storage allow_privacy: type: boolean description: Whether to allow members to prevent others from picking up a held call, and listening, whispering, barging, or taking over a call if it's configured. example: true '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n " '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Shared line group does not exist: {sharedLineGroupId}.
\n**Error Code:** `2001`
\n Account does not exist.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read:shared_line_group:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:shared_line_group:admin /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings: get: tags: - Shared Line Group summary: Get shared line group call handling setting description: 'Returns the call handling setting of a shared line group for the specified hour type. **Prerequisites:** * A Pro or higher account with a 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:shared_line_group_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: getSharedLineGroupCallHandlingSetting parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - name: hour_type in: query description: The hour type of the call handling setting. Defaults to `business_hours` if not provided. 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`
\n Shared line group call handling setting retrieved successfully.\n\n " content: application/json: schema: type: object properties: call_distribution_setting: type: object properties: max_wait_time: type: integer description: The maximum wait time, in seconds, that the shared line group rings all members before the unanswered-call action takes effect. Only meaningful when `hour_type` is `business_hours`. example: 30 enum: - 7 - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 description: The call distribution settings that control how long the shared line group rings all members before the unanswered-call action takes effect. Only returned when `hour_type` is `business_hours`. call_handling_setting: type: object properties: overflow_action: type: string description: 'The overflow action to take when an incoming call is not answered. This corresponds to the **Overflow** > **Route to** dropdown in the shared line group settings UI: * `forward_to_voicemail` — Forward to voicemail. * `forward_to_extension` — Forward to another internal extension. The target extension type is identified by `forward_to_extension.extension_type`. Supported types: `user`, `callQueue`, `autoReceptionist`, `commonArea`, `sharedLineGroup`, `zoomRoom`, `ciscoRoom/PolycomRoom`. * `forward_to_external_contact` — Forward to an external contact. * `forward_to_external_number` — Forward to an external phone number. * `forward_to_zoom_contact_center` — Forward to a Zoom Contact Center number. * `play_message_then_disconnect` — Play a message and then disconnect. * `disconnect` — Disconnect. * `forward_to_teams` — Forward to a Microsoft Teams Resource Account. Only returned when the account has Zoom Phone for Microsoft Teams enabled.' example: forward_to_voicemail enum: - forward_to_voicemail - play_message_then_disconnect - forward_to_extension - forward_to_ivr - forward_to_partner_contact_center - forward_to_external_number - forward_to_external_contact - forward_to_zoom_contact_center - forward_to_voicemail_access - forward_to_teams - disconnect overflow_action_setting: description: The overflow action settings based on the `overflow_action` value. Only present when `overflow_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`. description: Only returned when `overflow_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. description: Only returned when `overflow_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 `overflow_action` is `forward_to_external_contact`. - title: Forward to External Number type: object properties: forward_phone_number: type: string description: The external phone number to forward calls to in [E.164 format](https://en.wikipedia.org/wiki/E.164). example: '+12058945656' description: Only returned when `overflow_action` is `forward_to_external_number`. - title: Forward to Zoom Contact Center type: object properties: forward_to_zoom_contact_center: type: object properties: zoom_contact_center_number: type: string description: The Zoom Contact Center phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). example: '+12058945656' zoom_contact_center_flow_name: type: string description: The display name of the Zoom Contact Center flow that the number belongs to. example: Sales Flow description: The Zoom Contact Center number to forward calls to. description: Only returned when `overflow_action` is `forward_to_zoom_contact_center`. - 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 `overflow_action` is `play_message_then_disconnect`. - title: Forward to Microsoft Teams Resource Account type: object properties: forward_to_teams: type: object properties: teams_app_id: type: string description: The Microsoft Teams Resource Account ID. example: OJGi5xOFQPmrJbKg68-iWg teams_voice_app_name: type: string description: The Microsoft Teams Resource Account display name. example: Sales Teams RA description: The Microsoft Teams Resource Account to forward calls to. Only available when the account has Zoom Phone for Microsoft Teams enabled. description: Only returned when `overflow_action` is `forward_to_teams`. 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 Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:read:admin - phone:read:shared_line_group_call_handling_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:shared_line_group_call_handling_setting:admin /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings/{hourType}: patch: tags: - Shared Line Group summary: Update shared line group call handling setting description: 'Update the call handling setting of a shared line group for the specified hour type. At least one of `call_distribution_setting` or `call_handling_setting` must be provided in the request body. `call_distribution_setting` is only allowed when `hour_type` is `business_hour`. **Prerequisites:** * A Pro or higher account with a 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:shared_line_group_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: updateSharedLineGroupCallHandlingSetting parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - 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: max_wait_time: type: integer description: The maximum wait time, in seconds, that the shared line group rings all members before the unanswered call action takes effect. example: 30 enum: - 7 - 10 - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 description: The call distribution settings. Only allowed when `hour_type` is `business_hours`. call_handling_setting: type: object properties: overflow_action: type: string description: 'The overflow action to take when an incoming call is not answered. This corresponds to the **Overflow** > **Route to** dropdown in the shared line group settings UI: * `forward_to_voicemail` — Forward to voicemail. * `forward_to_extension` — Forward to another internal extension. The target extension type is identified by `forward_to_extension.extension_type`. * `forward_to_external_contact` — Forward to an external contact. * `forward_to_external_number` — Forward to an external phone number. * `forward_to_zoom_contact_center` — Forward to a Zoom Contact Center number. * `play_message_then_disconnect` — Play a message and then disconnect. * `disconnect` — Disconnect. * `forward_to_teams` — Forward to a Microsoft Teams Resource Account. Only allowed when the account has Zoom Phone for Microsoft Teams enabled.' example: forward_to_voicemail enum: - forward_to_voicemail - play_message_then_disconnect - forward_to_extension - forward_to_ivr - forward_to_partner_contact_center - forward_to_external_number - forward_to_external_contact - forward_to_zoom_contact_center - forward_to_voicemail_access - forward_to_teams - disconnect overflow_action_setting: description: The overflow action settings based on the `overflow_action` value. Required when `overflow_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. 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`. description: Provide this object when `overflow_action` is `forward_to_voicemail`. - title: Forward to Another Extension type: object properties: forward_to_extension: required: - extension_id type: object properties: extension_id: type: string description: The extension ID to forward calls to. example: jN9mb38lQTaMgxUq3Nd6ow description: The extension to forward calls to. description: Provide this object when `overflow_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: Provide this object when `overflow_action` is `forward_to_external_contact`. - title: Forward to External Number required: - forward_phone_number type: object properties: forward_phone_number: type: string description: The external phone number to forward calls to in [E.164 format](https://en.wikipedia.org/wiki/E.164). example: '+12058945656' description: Provide this object when `overflow_action` is `forward_to_external_number`. - title: Forward to Zoom Contact Center type: object properties: forward_to_zoom_contact_center: required: - zoom_contact_center_number type: object properties: zoom_contact_center_number: type: string description: The Zoom Contact Center phone number to forward calls to in [E.164 format](https://en.wikipedia.org/wiki/E.164). example: '+12058945656' description: The Zoom Contact Center number to forward calls to. description: Provide this object when `overflow_action` is `forward_to_zoom_contact_center`. - 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: Provide this object when `overflow_action` is `play_message_then_disconnect`. - title: Forward to Microsoft Teams Resource Account type: object properties: forward_to_teams: required: - teams_app_id type: object properties: teams_app_id: type: string description: The Microsoft Teams Resource Account ID. example: OJGi5xOFQPmrJbKg68-iWg description: The Microsoft Teams Resource Account to forward calls to. description: Provide this object when `overflow_action` is `forward_to_teams`. Only allowed when the account has Zoom Phone for Microsoft Teams enabled. description: The call handling settings. responses: '204': description: '**HTTP Status Code:** `204` Shared line group call handling setting updated successfully.' '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**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:** `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 Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:write:admin - phone:update:shared_line_group_call_handling_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:shared_line_group_call_handling_setting:admin /phone/shared_line_groups/{sharedLineGroupId}/policies: get: tags: - Shared Line Group summary: Get a shared line group policy description: 'Returns the policy setting of a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792). **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:shared_line_group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: getSharedLineGroupPolicy parameters: - name: sharedLineGroupId in: path description: The unique identifier of the shared line group. required: true schema: type: string example: nqerMCD0Tu6RPGoCpVbPtA responses: '200': description: '**HTTP Status Code:** `200` **OK** Successfully retrieved the shared line group policy.' content: application/json: schema: type: object properties: check_voicemails_over_phone: required: - enable - locked type: object properties: enable: type: boolean description: Whether to allow members in this shared line group to check voicemails for this group over phone using a PIN code. example: true locked: type: boolean description: Whether the senior administrator allows users to modify the current settings. example: true locked_by: type: string description: Which level of administrator prohibits modifying the current settings. example: site enum: - invalid - account - site modified: type: boolean description: Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework). example: true '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Shared line group does not exist:{sharedLineGroupId}.
\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:shared_line_group_policy:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:shared_line_group_policy:admin patch: tags: - Shared Line Group summary: Update a shared line group policy description: "Updates the policy setting of a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792). \n\n**Prerequisites:**\n* Pro or higher account plan 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:update:shared_line_group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: updateSharedLineGroupPolicy parameters: - name: sharedLineGroupId in: path description: The unique identifier of the shared line group. required: true schema: type: string example: nqerMCD0Tu6RPGoCpVbPtA requestBody: content: application/json: schema: type: object properties: check_voicemails_over_phone: type: object properties: enable: type: boolean description: Whether to allow members in this shared line group to check voicemails for this group over phone using a PIN code. example: true reset: type: boolean description: Whether the current settings use the phone account's settings (applicable if the current settings are using the new policy framework). example: true responses: '204': description: "**HTTP Status Code:** `204` \n **No Content** \n \nShared line group policy updated successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\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:shared_line_group_policy:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:shared_line_group_policy:admin /phone/shared_line_groups/{sharedLineGroupId}/settings: get: tags: - Shared Line Group summary: Get shared line group settings description: 'Returns shared line group settings. **Prerequisites:** * A Pro or higher account with a 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:shared_line_group_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: getSharedLineGroupSettings parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - name: setting_type in: query description: 'The setting item to query. Defaults to `business_hours` if not provided. Allowed values: `holiday_hours`, `business_hours`, `break_hours`.' required: false schema: type: string example: business_hours enum: - holiday_hours - business_hours - break_hours responses: '200': description: "**HTTP Status Code:** `200` \n \nShared line group setting object returned." content: application/json: schema: description: The shared line group setting. oneOf: - title: Holiday hour settings type: object properties: holiday_hours: 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: Returned only when the setting type is `holiday_hours`. - title: Business hour settings 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: Break hour settings 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* `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 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. description: Returned only when the setting type is `break_hours`. '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:read:admin - phone:read:shared_line_group_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:shared_line_group_setting:admin /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}: post: tags: - Shared Line Group summary: Add shared line group setting description: 'Adds the shared line group setting according to the setting type. **Prerequisites** * A Pro or higher account with a 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:shared_line_group_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: addSharedLineGroupSetting parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - name: settingType in: path description: 'The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`.' required: true schema: type: string example: holiday_hours enum: - holiday_hours - break_hours requestBody: content: application/json: schema: oneOf: - title: Holiday hour 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: required: - from - name - to 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. 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' description: Each holiday. description: This field is only required when the setting type is `holiday_hours`. description: Use this schema 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 hour settings. This field is only required when the setting type is `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`. Must be after the `from` time. example: '13:00' description: Only required 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 required 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: The list of break hours. This field is only required when the setting type is `break_hours`. description: Use this schema when the setting type is `break_hours`. `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: description: The shared line group setting created according to the setting type. oneOf: - title: Holiday hour settings type: object properties: holiday_hours: type: object properties: holidays: type: array description: The list of holidays. Returned only when the setting type is `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 description: The holiday hours. Returned only when the setting type is `holiday_hours`. description: Returned 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 hour settings. Returned only when the setting type is `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: The list of break hours. Returned only when the setting type is `break_hours`. description: Returned only when the setting type is `break_hours`. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\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 Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:write:admin - phone:write:shared_line_group_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:shared_line_group_setting:admin delete: tags: - Shared Line Group summary: Delete shared line group setting description: 'Deletes the shared line group setting according to the setting type. **Prerequisites** * A Pro or higher account with a 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:delete:shared_line_group_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: deleteSharedLineGroupSetting parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - name: settingType in: path description: 'The setting type to delete. Allowed values: `holiday_hours`, `break_hours`.' required: true schema: type: string example: holiday_hours enum: - holiday_hours - break_hours - name: holiday_hour_id in: query description: The holiday hour ID. Required when `settingType` is `holiday_hours`. required: false schema: type: string example: TNxfEp2WT9emyCsAQt4qnA - name: break_hour_id in: query description: The break hour ID. Required when `settingType` is `break_hours`. **Note:** `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:** `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 Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:write:admin - phone:delete:shared_line_group_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_group_setting:admin patch: tags: - Shared Line Group summary: Update shared line group setting description: 'Update the shared line group setting according to the setting type. **Prerequisites** * A Pro or higher account with a 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:shared_line_group_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: updateSharedLineGroupSetting parameters: - name: sharedLineGroupId in: path description: The shared line group ID. required: true schema: type: string example: qQ3hQmrrR3KhV4XshW6z4Q - name: settingType in: path description: 'The setting type that corresponds to the setting item you want to modify. Allowed values: `holiday_hours`, `business_hours`, `break_hours`.' required: true schema: type: string example: business_hours enum: - holiday_hours - business_hours - break_hours requestBody: content: application/json: schema: oneOf: - title: Holiday hour settings type: object properties: holiday_hours: type: object properties: holidays: maxItems: 10 minItems: 1 type: array description: The 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. description: Use this schema when the setting type is `holiday_hours`. - title: Business hour settings 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 type: object properties: break_hours: type: object properties: break_hour_settings: maxItems: 5 type: array description: The list of break hour configurations. 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 required 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 required 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: The break hours settings. description: Use this schema when the setting type is `break_hours`. **Note:** `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:** `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 Shared line group does not exist: {sharedLineGroupId}.
\n" security: - openapi_oauth: - phone:write:admin - phone:update:shared_line_group_setting:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:shared_line_group_setting:admin /phone/shared_line_groups/{slgId}: delete: tags: - Shared Line Group summary: Delete a shared line group description: "Deletes a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. \n\n**Prerequisites:** \n * Pro or higher account with Zoom Phone license.\n * Account owner or admin privileges \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:shared_line_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteASharedLineGroup parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nShared Line Group Deleted." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:delete:shared_line_group:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_group:admin patch: tags: - Shared Line Group summary: Update a shared line group description: " Updates the information about a shared line group. \n \n A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. Members of the shared line group can access to the group's direct phone number and voicemail. \n\n**Prerequisites** \n \n* Pro or higher account with Zoom Phone license\n* Account owner or admin privileges \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:shared_line_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: updateASharedLineGroup parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w requestBody: content: application/json: schema: type: object properties: display_name: type: string description: The display name of the shared line group. example: slg_name_2020_12_22_06_52_34_430 extension_number: type: integer description: The extension number assigned to the shared line group. format: int64 example: 1000001007 primary_number: type: string description: The phone number that you would like to assign as the primary number for this shared line group example: '14232058798' status: type: string description: The status of the shared line group. example: active enum: - active - inactive timezone: type: string description: The [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Shared Line Group. example: Pacific/Midway cost_center: type: string description: The cost center name. example: Cost center department: type: string description: The department name. example: Department audio_prompt_language: type: string description: "The language for all default audio prompts for the Shared Line Group. \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 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 recording_storage_location: type: string description: "Where the recording will be stored. Recording includes Phone recordings, voicemail, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\nNote: \n* If the setting is locked at the Account level, it can't be updated." example: US enum: - US - AU - CA - DE - IN - JP - SG - BR - CN - MX allow_privacy: type: boolean description: Whether to allow members to prevent others from picking up a held call, and listening, whispering, barging, or taking over a call if it's configured. example: true responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n\nThe shared line group updated successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n**Error Code:** `409`
\n * Invalid short number length.
\n* Number {extensionNumber} is a reserved extension number.


\n**Error Code:** `400`
\n Extension number {extensionNumber} is already used.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \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:shared_line_group:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:shared_line_group:admin /phone/shared_line_groups/{slgId}/members: post: tags: - Shared Line Group summary: Add members to a shared line group description: "[Adds members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. Note that a member can only be added to one shared line group. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: addMembersToSharedLineGroup parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w requestBody: content: application/json: schema: type: object properties: members: type: object properties: common_area_ids: type: array description: The unique identifier of the [common area](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/listCommonAreas), retrievable from the List Common Areas API. items: type: string example: iewGNg-LSYa0ghhkr4d0Hg users: type: array description: The Zoom Phone users on the account. items: type: object properties: email: type: string description: The email address of the user. example: largepbx3_018638@largepbx3.com id: type: string description: The unique identifier of the user. example: gLGURYbRTSup_z4CkSwKuA description: The members can comprise of users on the account as well as common areas. You can add a maximum of 10 members at once. responses: '201': description: "**HTTP Status Code:** `201` **Created** \nMembers added successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n User not found: {userId}.
\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:shared_line_member:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:shared_line_member:admin delete: tags: - Shared Line Group summary: Unassign members from a shared line group description: "Unassigns **all** existing members from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\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:shared_line_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteMembersOfSLG parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w responses: '204': description: '**HTTP Status Code:** `204` **No Content** Members unassigned successfully.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:delete:shared_line_member:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_member:admin /phone/shared_line_groups/{slgId}/members/{memberId}: delete: tags: - Shared Line Group summary: Unassign a member from a shared line group description: "Unassigns **a specific member** from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\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:shared_line_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteAMemberSLG parameters: - name: slgId in: path description: The unique identifier of the shared line group from which you would like to remove a member. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w - name: memberId in: path description: The unique identifier of the member who is to be removed. required: true schema: type: string example: DnEopNmXQEGU2uvvzjgojw responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n\nMembers unassigned successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:delete:shared_line_member:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_member:admin /phone/shared_line_groups/{slgId}/phone_numbers: post: tags: - Shared Line Group summary: Assign phone numbers description: "Assigns phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n * Pro or higher account with Zoom Phone license.\n * A valid Shared Line Group\n * Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: assignPhoneNumbersSLG parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w requestBody: content: application/json: schema: type: object properties: phone_numbers: maxItems: 5 type: array description: The phone number(s) to be assigned to the shared line group. items: type: object properties: id: type: string description: The unique identifier of the phone number. example: '---M1padRvSUtw7YihN7sA' number: type: string description: The phone number. example: '14232058798' responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \nPhone number(s) assigned successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Phone number does not exist.


\n**Error Code:** `300`
\n Validation failed.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Phone number does not belong to this account
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Shared line group 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:write:shared_line_group_number:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:shared_line_group_number:admin delete: tags: - Shared Line Group summary: Unassign all phone numbers description: "Unassigns all the phone numbers that have been assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\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:shared_line_group_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deletePhoneNumbersSLG parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: uvsOCaiDQR2M-NviKFHo0w responses: '204': description: '**HTTP Status Code:** `204` **No Content** Phone Numbers unassigned successfully.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Phone number does not exist
\n**Error Code:** `300`
\n
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Phone number does not belong to this account
\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:shared_line_group_number:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_group_number:admin /phone/shared_line_groups/{slgId}/phone_numbers/{phoneNumberId}: delete: tags: - Shared Line Group summary: Unassign a phone number description: "Unassigns a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid shared line group\n* Account owner or admin privileges\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:shared_line_group_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: deleteAPhoneNumberSLG parameters: - name: slgId in: path required: true schema: type: string - name: phoneNumberId in: path description: The unique identifier of the phone number which is to be unassigned. This can be retrieved from Get a Shared Line Group API. required: true schema: type: string example: '---M1padRvSUtw7YihN7sA' responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \nPhone Numbers unassigned successfully." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Phone number does not exist


\n**Error Code:** `300`
\n
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Phone number does not belong to this account
\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:shared_line_group_number:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_group_number:admin /phone/shared_line_groups/{slgId}/policies/{policyType}: post: tags: - Shared Line Group summary: Add a policy setting to a shared line group description: "Adds the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to set up shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: addSLGPolicySubSetting parameters: - name: slgId in: path description: The slg ID. required: true schema: type: string example: loiSdBeXS-iL-QERBqE8Sg - name: policyType in: path description: 'This setting corresponds to tbe policy item you wish to add. Allowed values: `voice_mail`.' required: true schema: type: string example: voice_mail requestBody: content: application/json: schema: type: object properties: voicemail_access_members: maxItems: 10 uniqueItems: true type: array description: The shared voicemail access member list. items: type: object properties: access_user_id: type: string description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type. example: w0RChiauQeqRlv5fgxYULQ access_user_type: type: string description: 'The extension type of the member to be added in the shared voicemail access member list. The default type will be user if empty. Allowed: user | commonArea.' example: commonArea enum: - commonArea - user allow_download: type: boolean description: Whether the member has download permissions. Not applicable to `commonArea`. The default is **false**. example: false allow_delete: type: boolean description: Whether the member has delete permissions. The default is **false**. example: false allow_sharing: type: boolean description: Whether the member has permission to share. The default is **false**. example: false responses: '201': description: "**HTTP Status Code** `201` \n \nCreated Successfully." content: application/json: schema: type: object properties: voicemail_access_members: maxItems: 10 uniqueItems: true type: array description: The shared access member list. items: allOf: - allOf: - type: object properties: access_user_id: type: string description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or unique identifier of the common area depending on the access user type. example: w0RChiauQeqRlv5fgxYULQ access_user_type: type: string description: 'The extension type of the member to be added in the shared voicemail access member list. Allowed: user | commonArea.' example: commonArea enum: - commonArea - user allow_download: type: boolean description: Whether the member has download permissions. Not applicable to `commonArea`. The default is **false**. example: false allow_delete: type: boolean description: Whether the member has delete permissions. The default is **false**. example: false allow_sharing: type: boolean description: Whether the member has permission to share. The default is **false**. example: false - type: object properties: shared_id: type: string description: The shared voicemail ID that the member can access. example: --e8ugg0SeS-9clgrDkn2w - type: object properties: access_user_type: type: string description: 'The type of access member: `user` or `commonArea`.' example: user enum: - user - commonArea '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n The number of items for voicemail_access_members must not exceed 10.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Shared line group 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:write:shared_line_group_policy:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:shared_line_group_policy:admin delete: tags: - Shared Line Group summary: Delete an SLG policy setting description: "Removes the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to remove shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \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:shared_line_group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: removeSLGPolicySubSetting parameters: - name: slgId in: path description: The shared line group ID. required: true schema: type: string example: '' - name: policyType in: path description: 'This setting corresponds to tbe policy item you wish to remove. Allowed values: `voice_mail`.' required: true schema: type: string example: voice_mail - name: shared_ids in: query description: The comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting. required: true schema: maxItems: 20 type: array example: [] items: type: string example: 8_RkKw9OQ42oYsXqJJjs4A responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n " '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:delete:shared_line_group_policy:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:shared_line_group_policy:admin patch: tags: - Shared Line Group summary: Update an SLG policy setting description: "Updates the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to update shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \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:shared_line_group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: updateSLGPolicySubSetting parameters: - name: slgId in: path required: true schema: type: string - name: policyType in: path description: 'This setting corresponds to tbe policy item you wish to update. Allowed values: `voice_mail`.' required: true schema: type: string example: voice_mail requestBody: content: application/json: schema: type: object properties: voicemail_access_members: maxItems: 10 type: array description: The shared voicemail access member list. items: allOf: - type: object properties: access_user_id: type: string description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type. example: w0RChiauQeqRlv5fgxYULQ access_user_type: type: string description: 'The extension type of the member to be added in the shared voicemail access member list. The default type will be user if empty. Allowed: user | commonArea.' example: commonArea enum: - commonArea - user allow_download: type: boolean description: Whether the member has download permissions. Not applicable to `commonArea`. The default is **false**. example: false allow_delete: type: boolean description: Whether the member has delete permissions. The default is **false**. example: false allow_sharing: type: boolean description: Whether the member has permission to share. The default is **false**. example: false - type: object properties: shared_id: type: string description: The shared voicemail ID that the member can access. example: --e8ugg0SeS-9clgrDkn2w responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Shared line group 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:update:shared_line_group_policy:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:shared_line_group_policy: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