Zoom Phone Shared Line Group API

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` <br>\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` <br>\n Bad Request \n\n **Error Code:** `300` <br>\n  <br>\n**Error Code:** `400` <br>\n Extension number {extensionNumber} is already used.<br><br> <br>\n**Error Code:** `409` <br>\n Invalid short number length. <br>\nNumber {extensionNumber} is a reserved extension number. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\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\n<b>Note:</b> \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` <br>\n Bad Request  \n\n "
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Shared line group does not exist: {sharedLineGroupId}. <br>\n**Error Code:** `2001` <br>\n Account does not exist. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\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` <br>\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 extensio

# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-shared-line-group-api-openapi.yml