openapi: 3.2.0
info:
  title: Zoom Phone Phone Numbers API
  version: '2'
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  description: 'Operations tagged Phone Numbers across 2 of this provider''s published API definitions: zoom-phone-api-openapi.json, zoom-phone-number-management-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Phone Numbers
paths:
  /phone/byoc_numbers:
    post:
      tags:
      - Phone Numbers
      summary: Add BYOC phone numbers
      description: "Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.\n\n**Prerequisites** \n* A Business or Enterprise plan \n* A Zoom Phone license\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:byo_carrier_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: addBYOCNumber
      requestBody:
        content:
          application/json:
            schema:
              required:
              - carrier
              - phone_numbers
              type: object
              properties:
                carrier:
                  type: string
                  description: Name of the carrier.
                  example: Bandwidth
                phone_numbers:
                  maxItems: 50
                  type: array
                  description: Phone number(s) to be added to Zoom. The value should be in e164 format.
                  items:
                    type: string
                    example: '+8618251885564'
                sip_group_id:
                  type: string
                  description: Sip group id.
                  example: GgyGPoRESCKAD8JpGXjJ8w
                site_id:
                  type: string
                  description: Unique identifier of the site. This field is only required if you have enabled multiple sites in the account. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.
                  example: 8f71O6rWT8KFUGQmJIFAdQ
      responses:
        '201':
          description: '**HTTP Status Code:** `201` **Created**'
          content:
            application/json:
              schema:
                type: object
                properties:
                  phone_numbers:
                    maxItems: 50
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier of the phone number.
                          example: LzPlp8GwR6iytydAq2luIg
                        number:
                          type: string
                          description: Phone number in e164 format.
                          example: '8618251885565'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Validation failed. <br>\n**Error Code:** `400` <br>\n Batch phone numbers are limited to 50 per request. <br>\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `124` <br>\n Account does not exist: {accountId}. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n The following account carrier does not exist: {0}. <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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:write:byo_carrier_number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:write:byo_carrier_number:admin
    servers:
    - url: https://api.zoom.us/v2
  /phone/numbers:
    get:
      tags:
      - Phone Numbers
      summary: List phone numbers
      description: "Returns a list all Zoom Phone numbers in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\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_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: listAccountPhoneNumbers
      parameters:
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      - name: type
        in: query
        description: "The query response by number assignment. The value can be one of the following:\n  \n \n`assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist, or a common area in an account.   \n `unassigned`: The number is not assigned to anyone.  \n \n`all`: Include both assigned and unassigned numbers in the response.  \n \n`byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response."
        required: false
        schema:
          type: string
          example: all
          enum:
          - assigned
          - unassigned
          - byoc
          - all
      - name: extension_type
        in: query
        description: "The type of assignee to whom the number is assigned. The parameter can be set only if `type` parameter is set as `assigned`. The value can be one of the following:  \n \n`user`  \n  `callQueue`  \n  `autoReceptionist`  \n `commonArea`  \n `emergencyNumberPool`  \n `companyLocation`  \n `meetingService`"
        required: false
        schema:
          type: string
          example: user
          enum:
          - user
          - callQueue
          - autoReceptionist
          - commonArea
          - emergencyNumberPool
          - companyLocation
          - meetingService
      - name: page_size
        in: query
        description: The number of records returned within a single API call.
        required: false
        schema:
          maximum: 100
          type: integer
          example: 30
          default: 30
      - name: number_type
        in: query
        description: The type of phone number. The value can be either `toll` or `tollfree`.
        required: false
        schema:
          type: string
          example: toll
          enum:
          - toll
          - tollfree
      - name: pending_numbers
        in: query
        description: This field includes or excludes pending numbers in the response. The value can be either `true` or `false`.
        required: false
        schema:
          type: boolean
          example: false
      - name: site_id
        in: query
        description: The unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.
        required: false
        schema:
          type: string
          example: 8f71O6rWT8KFUGQmJIFAdQ
      - name: phone_number
        in: query
        description: The phone number in E164 format.
        required: false
        schema:
          type: string
          example: '+12008001005'
      responses:
        '200':
          description: "**HTTP Status Code:** `200` **OK**  \n \nPhone numbers listed successfully."
          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 returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.)
                    example: bkOcmnm6mn6ioYAi10BcgRiEL38WzAo6jP2
                  page_size:
                    type: integer
                    description: The number of records returned within a single API call.
                    example: 30
                  phone_numbers:
                    type: array
                    items:
                      type: object
                      properties:
                        assignee:
                          type: object
                          properties:
                            extension_number:
                              type: integer
                              description: The extension number of the phone.
                              format: int64
                              example: 1000001101
                            id:
                              type: string
                              description: The unique identifier of the user to whom the number has been assigned.
                              example: Y40mS72DRamFgGh0V1Ul_Q
                            name:
                              type: string
                              description: The name of the user to whom the number has been assigned.
                              example: User Name
                            type:
                              type: string
                              description: "This field indicates to whom the phone number belongs.  \n \n`user`: Number has been assigned to an existing phone user that allows them to receive calls through their extension number or direct phone number.  \n  `callQueue`: Phone number has been assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).  \n `autoReceptionist`: Phone number has been assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-).  \n `commonArea`: Phone number has been assigned to a [common area](https://support.zoom.us/hc/en-us/articles/4481136653709-May-2022-New-Common-Area-Experience).  \n  `emergencyNumberPool` `companyLocation` `meetingService`"
                              example: user
                              enum:
                              - user
                              - callQueue
                              - autoReceptionist
                              - commonArea
                              - emergencyNumberPool
                              - companyLocation
                              - meetingService
                              - sharedLineGroup
                        capability:
                          type: array
                          description: The capability for the phone number, whether it can take incoming calls, make outgoing calls, or both. Values include `incoming`, `outgoing`, or both values.
                          items:
                            type: string
                            example: incoming
                        carrier:
                          type: object
                          properties:
                            code:
                              type: integer
                              description: The carrier code.
                              example: 1
                            name:
                              type: string
                              description: The name of the carrier to which the phone number is assigned.
                              example: Bandwidth
                          description: This field displays when the `type` request parameter is `byoc`.
                        display_name:
                          type: string
                          description: The display name for the phone number.
                          example: abc
                        emergency_address:
                          type: object
                          properties:
                            address_line1:
                              type: string
                              description: The address Line 1 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that consists of the house number and street name.
                              example: 55 ALMADEN BLVD
                            address_line2:
                              type: string
                              description: Address Line 2 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that consists of building number, floor number, unit and so on.
                              example: test 7
                            city:
                              type: string
                              description: The city of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                              example: SAN JOSE
                            country:
                              maxLength: 2
                              minLength: 2
                              type: string
                              description: The two-lettered country code (Aplha-2 code in ISO-3166 format) standard of the site's [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                              example: US
                            state_code:
                              type: string
                              description: The state code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                              example: CA
                            zip:
                              type: string
                              description: The zip code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                              example: '95113'
                          description: This field displays when the `type` request parameter is `byoc`.
                        emergency_address_status:
                          type: integer
                          description: 'This field displays when the `type` request parameter is `byoc`. The emergency address status: `1`-carrier update required, `2`-confirmed'
                          example: 1
                          enum:
                          - 1
                          - 2
                        emergency_address_update_time:
                          type: string
                          description: 'This field displays when the `type` request parameter is `byoc`. The time of emergency address information update (format: ''yyyy-MM-ddThh:dd:ssZ'').'
                          example: '2022-02-18T07:20:19Z'
                        id:
                          type: string
                          description: The unique identifier of the phone number.
                          example: aMy7P9DMS9iNRkpwXNfRbw
                        location:
                          type: string
                          description: The location (city, state and country) where the phone number is assigned.
                          example: United States
                        number:
                          type: string
                          description: The phone number in E164 format.
                          example: '+12008001005'
                        number_type:
                          type: string
                          description: "The type of number. Values can be one of the following:  \n \n`toll`, `tollfree`"
                          example: toll
                          enum:
                          - toll
                          - tollfree
                        sip_group:
                          type: object
                          properties:
                            display_name:
                              type: string
                              description: The name of the SIP group.
                              example: RRRR
                            id:
                              type: string
                              description: The ID of the SIP group. See the **Creating SIP groups** section in [Creating a shared directory of external contacts](https://support.zoom.us/hc/en-us/articles/360037050092-Creating-a-shared-directory-of-external-contacts) for details.
                              example: 8MhK7ea4Q4ihIQ4TD_g0kw
                          description: This field displays when the `type` request parameter is `byoc`.
                        site:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) in which the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, you sites could be created based on different office locations.
                              example: 8f71O6rWT8KFUGQmJIFAdQ
                            name:
                              type: string
                              description: The name of the site where the phone number is assigned.
                              example: Main Site
                        source:
                          type: string
                          description: The source of the phone number.
                          example: external
                          enum:
                          - internal
                          - external
                        status:
                          type: string
                          description: The status of the number.
                          example: available
                          enum:
                          - pending
                          - available
                  total_records:
                    type: integer
                    description: The total number of records returned.
                    example: 50
        '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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_numbers:admin
    delete:
      tags:
      - Phone Numbers
      summary: Delete unassigned phone numbers
      description: "Deletes unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be removed in a single request.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\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:number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: deleteUnassignedPhoneNumbers
      parameters:
      - name: phone_numbers
        in: query
        description: Comma seperated list of unassigned phone numbers in E164 format or phone number IDs.
        required: true
        schema:
          maxItems: 20
          minItems: 1
          type: array
          items:
            type: string
            example: 8_RkKw9OQ42oYsXqJJjs4A
      responses:
        '204':
          description: '**HTTP Status Code:** `204`

            The Phone numbers successfully removed.'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n The number of items for the query parameter `phone_numbers` must be between 1 and 20 inclusive. <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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:delete:number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:delete:number:admin
    servers:
    - url: https://api.zoom.us/v2
  /phone/numbers/sites/{siteId}:
    patch:
      tags:
      - Phone Numbers
      summary: Update a site's unassigned phone numbers
      description: "Updates a site's unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be updated in a single request. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
      operationId: updateSiteForUnassignedPhoneNumbers
      parameters:
      - name: siteId
        in: path
        description: Unique identifier of the site
        required: true
        schema:
          type: string
          example: 8f71O6rWT8KFUGQmJIFAdQ
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                phone_numbers:
                  maxItems: 20
                  type: array
                  description: The phone number ID or a phone number in E164 format.
                  items:
                    type: string
                    example: 8_RkKw9OQ42oYsXqJJjs4A
      responses:
        '204':
          description: '**HTTP Status Code:** `204` **No Content**



            Site successfully updated.'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `300` <br>\n\n\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:update:site_number:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:site_number:admin
    servers:
    - url: https://api.zoom.us/v2
  /phone/numbers/{phoneNumberId}:
    get:
      tags:
      - Phone Numbers
      summary: Get a phone number
      description: "Returns information about an account's Zoom Phone number.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom phone license\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:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: getPhoneNumberDetails
      parameters:
      - name: phoneNumberId
        in: path
        description: The unique identifier of the phone number retrieved from the List phone numbers API.
        required: true
        schema:
          type: string
          example: iHE1MQAET2iV85MbfaQmwg
      responses:
        '200':
          description: "**HTTP Status Code:** `200` **OK**  \n \nPhone number details retrieved successfully."
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignee:
                    type: object
                    properties:
                      audio_prompt_language:
                        type: string
                        example: en-GB
                      display_number:
                        type: string
                        description: This field indicates the meeting service, defines the format, and displays the number in meeting invitations and emails.
                        example: display_name_123
                      extension_number:
                        type: integer
                        description: The extension number of the phone.
                        format: int64
                        example: 1000001101
                      greeting:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can still use this audio ID to get the audio information in the [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
                            example: 4CRwFZtVTa67JcfO37iQqA
                          name:
                            type: string
                            description: The audio prompt file name.
                            example: TestName
                        description: This field indicates the meeting service. You can only upload one audio file. The accepted format is .wav (also 8k, mono, ULAW or ALAW). If no audio file uploads, Zoom uses the &quot;Telephone welcome message&quot; setting in account settings.
                      id:
                        type: string
                        description: 'The ID of the user. The following are assigned: emergency number pool (if the account has multiple sites enabled, the ID is `siteId`, else `accountId`), and company location. '
                        example: rYgfsrduSXWCxr94poMN5g
                      label:
                        type: string
                        description: 'Optional. This field indicates the meeting service. This label will be appended to the number in parentheses, and will appear in meeting invitations and the zoom client. Formatting rules:

                          Maximum 32 characters

                          Do not use digits

                          Do not use characters &quot;(&quot; &quot;)&quot; &quot;,&quot; &quot;;&quot; or &quot;:&quot;'
                        example: abcd
                      meeting_id:
                        type: string
                        description: The meeting ID for the meeting service.
                        example: abcd
                      name:
                        type: string
                        description: The name of the user to whom the number, emergency number pool, and company location are assigned.
                        example: Test name
                      on_hold_music:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can use this audio ID to get the audio information in the [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
                            example: 4CRwFZtVTa67JcfO37iQqA
                          name:
                            type: string
                            description: The audio prompt file name.
                            example: Audio1
                        description: This field indicates the meeting service. You can only upload one audio file. The accepted format is .wav (also 8k, mono, ULAW or ALAW). If no audio file uploads, Zoom uses the &quot;Telephone on-hold music&quot; setting in account settings.
                      type:
                        type: string
                        description: "This field indicates to whom the phone number belongs.  \n \n`user`: Number has been assigned to an existing phone user and allows them to receive calls through their extension number or direct phone number.  \n  `callQueue`: Phone number has been assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).  \n \n`autoReceptionist`: Phone number has been assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-).  \n \n`commonArea`: Phone number has been assigned to a common area(https://support.zoom.us/hc/en-us/articles/4481136653709-May-2022-New-Common-Area-Experience).  \n  `emergencyNumberPool` `companyLocation` `meetingService`"
                        example: user
                        enum:
                        - user
                        - callQueue
                        - autoReceptionist
                        - commonArea
                        - emergencyNumberPool
                        - companyLocation
                        - meetingService
                  capability:
                    type: array
                    description: "The capability of the phone number to receive incoming calls, make outgoing calls, or both. \n\nValues are `incoming`, `outgoing`, or both values."
                    items:
                      type: string
                      example: incoming
                  carrier:
                    type: object
                    properties:
                      code:
                        type: integer
                        description: The  carrier code.
                        example: 2
                      name:
                        type: string
                        description: The carrier name.
                        example: Inteliquent
                  display_name:
                    type: string
                    description: The display name of the phone number.
                    example: Display name
                  emergency_address:
                    type: object
                    properties:
                      address_line1:
                        type: string
                        description: The address Line 1 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that consists of the house number and street name.
                        example: 55 ALMADEN BLVD
                      address_line2:
                        type: string
                        description: The address Line 2 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that consists of the building number, floor number, unit, and so on.
                        example: test 7
                      city:
                        type: string
                        description: The city of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: SAN JOSE
                      country:
                        maxLength: 2
                        minLength: 2
                        type: string
                        description: The two-lettered country code (Alpha-2 code in ISO-3166 format) standard of the site's [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: US
                      state_code:
                        type: string
                        description: The state code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: CA
                      zip:
                        type: string
                        description: The zip Code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: '95113'
                    description: 'This field displays when the number is a `byoc` number. '
                  emergency_address_status:
                    type: integer
                    description: "This field displays when the number is a `byoc` number. \n\nThe emergency address status: 1-carrier update required, 2-confirmed"
                    example: 1
                    enum:
                    - 1
                    - 2
                  emergency_address_update_time:
                    type: string
                    description: "Thia fieild displays when the number is a `byoc` number. \n\nThe emergency address information update time(format: 'yyyy-MM-ddThh:dd:ssZ')."
                    example: '2022-02-18T07:20:19Z'
                  id:
                    type: string
                    description: The unique identifier of the phone number.
                    example: iHE1MQAET2iV85MbfaQmwg
                  location:
                    type: string
                    description: The assigned location (city, state and country) of the phone number.
                    example: Mz83e03MT1efcUvxdKlq3w
                  number:
                    type: string
                    description: The phone number in E164 format.
                    example: '+18886510412'
                  number_type:
                    type: string
                    description: "The type of number. \n\nThe values can be one of the following:  \n \n`toll`, `tollfree`"
                    example: toll
                    enum:
                    - toll
                    - tollfree
                  sip_group:
                    type: object
                    properties:
                      display_name:
                        type: string
                        description: The SIP group display name.
                        example: RRRR
                      id:
                        type: string
                        description: The SIP group ID.
                        example: 8MhK7ea4Q4ihIQ4TD_g0kw
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: "The target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) assigned to the phone number. \n\nSites allow you to organize phone users in your organization. For example, your sites could be created based on different office locations."
                        example: 8f71O6rWT8KFUGQmJIFAdQ
                      name:
                        type: string
                        description: The name of the site where the phone number is assigned.
                        example: Main Site
                  source:
                    type: string
                    description: The source of phone number.
                    example: external
                    enum:
                    - internal
                    - external
                  status:
                    type: string
                    description: The status of the number.
                    example: available
                    enum:
                    - pending
                    - available
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Phone number does not exist, phonenumberId:{phoneNumberId} <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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:numbers:admin
    patch:
      tags:
      - Phone Numbers
      summary: Update a phone number
      description: "Updates a Zoom Phone number's information.\n\n**Prerequisites:** \n* A Paid account\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:number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: updatePhoneNumberDetails
      parameters:
      - name: phoneNumberId
        in: path
        description: The unique identifier of the phone number.
        required: true
        schema:
          type: string
          example: uvsOCaiDQR2M-NviKFHo0w
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                capability:
                  maxItems: 2
                  type: array
                  description: 'THe phone number''s capability. Values: `outgoing` or `incoming`. Add one or both.'
                  items:
                    type: string
                    example: incoming
                display_name:
                  type: string
                  description: The phone number display name.
                  example: Display Name
                emergency_address_status:
                  type: integer
                  description: This field confirms BYOC phone number's emergency address status. 2-confirmed
                  example: 1
                sip_group_id:
                  type: string
                  description: The SIP group ID, only used for BYOC phone number update.
                  example: 8MhK7ea4Q4ihIQ4TD_g0kw
      responses:
        '204':
          description: "**HTTP Status Code:** `204`  \n \nNo Content"
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n The value of capability is invalid. Provide a valid capability and try again.\nYou cannot update it to a non-BYOC trunk group, because some BYOC numbers are using the SIP Group.\nThe phone number is not in binding.\nThe phone number is not BYOC phone number. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Phone number does not exist. ID: {0}. <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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:update:number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:number:admin
    servers:
    - url: https://api.zoom.us/v2
  /phone/users/{userId}/phone_numbers:
    post:
      tags:
      - Phone Numbers
      summary: Assign a phone number to a user
      description: 'Assigns a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone.**Prerequisites:** * A Business or Enterprise account * A Zoom Phone license


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_number`,`phone:write:user_number:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
      operationId: assignPhoneNumber
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
          example: IqoQmDRqS-aIoXqV_FZ88w
      requestBody:
        description: Provide either the ID or phone number in the request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                phone_numbers:
                  maxItems: 10
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        description: ID for phone number
                        example: iHE1MQAET2iV85MbfaQmwg
                      number:
                        type: string
                        description: Phone number in E164 format.
                        example: '+18887193005'
      responses:
        '200':
          description: "**HTTP Status Code:** `200`   \n \nPhone number assigned successfully. \n"
          content:
            application/json:
              schema:
                type: object
                properties:
                  phone_numbers:
                    maxItems: 10
                    type: array
                    description: Assigned phone number
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: ID of the phone number
                          example: iHE1MQAET2iV85MbfaQmwg
                        number:
                          type: string
                          description: The phone number that is assigned to the user.
                          example: '+18887193005'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Invalid user id. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n This user does not exist: {userId}. <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:write
        - phone:write:admin
        - phone:write:user_number
        - phone:write:user_number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write
        - phone:write:admin
        x-granular-scopes:
        - phone:write:user_number
        - phone:write:user_number:admin
    servers:
    - url: https://api.zoom.us/v2
  /phone/users/{userId}/phone_numbers/{phoneNumberId}:
    delete:
      tags:
      - Phone Numbers
      summary: Unassign a phone number
      description: "Unassigns Zoom Phone user's [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6).\n\nAfter assigning a phone number, you can remove it if you do not want it to be assigned to anyone.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_number`,`phone:delete:user_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: UnassignPhoneNumber
      parameters:
      - name: userId
        in: path
        description: This field provides either the user ID or email address of the user.
        required: true
        schema:
          type: string
          example: IqoQmDRqS-aIoXqV_FZ88w
      - name: phoneNumberId
        in: path
        description: 'This field provides either the phone number or phone number ID of the user. '
        required: true
        schema:
          type: string
          example: iHE1MQAET2iV85MbfaQmwg
      responses:
        '204':
          description: '**HTTP Status Code:** `204`

            The phone number has been unassigned successfully.'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Invalid user id. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist. <br>\n**Error Code:** `2001` <br>\n Account does not exist. <br>\n**Error Code:** `400` <br>\n Invalid query parameter \"phone_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
        - phone:write:admin
        - phone:delete:user_number
        - phone:delete:user_number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write
        - phone:write:admin
        x-granular-scopes:
        - phone:delete:user_number
        - phone:delete:user_number:admin
    servers:
    - url: https://api.zoom.us/v2
  /number_management/allocation:
    patch:
      tags:
      - Phone Numbers
      summary: Allocate/Unallocate phone numbers
      description: 'Allocates or unallocates phone numbers for those with CPL routing.


        <p>Note: When allocating phone numbers, if there are any native numbers, they must belong to the same country or region, and have the same number plan.</p>


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:numbers:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`'
      operationId: AllocateNumber
      requestBody:
        content:
          application/json:
            schema:
              required:
              - allocated_product
              - numbers
              type: object
              properties:
                numbers:
                  maxItems: 10
                  type: array
                  description: A list of phone numbers.
                  items:
                    type: string
                    description: The phone number ID.
                    example: 8nObzGKRTGxoNDZ5JIEHQ
                allocated_product:
                  type: string
                  description: The phone number's allocated product. Use the value UNALLOCATED to unallocate phone numbers.
                  example: ZOOM_PHONE
                  enum:
                  - ZOOM_PHONE
                  - ZOOM_CONTACT_CENTER
                  - UNALLOCATED
                site_id:
                  type: string
                  description: The site the numbers will be allocated for Zoom Phone.
                  example: 8nObzGKRTGxoNDZ5JIEHQ
      responses:
        '204':
          description: ' The phone numbers have been allocated succeefully'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameter or operation \n\n **Error Code:** `100002` <br>\n Phone number not found <br>\n**Error Code:** `200002` <br>\n Unable to switch products for the number <br>\n**Error Code:** `1002010` <br>\n The site does not exist <br>\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  Lack of valid authentication \n\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:
        - number_management_numbers:write:admin
        - number_management:write:numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - PbxAdmin:Edit
        - ContactCenterMgt:Edit
        x-macro-scopes:
        - number_management_numbers:write:admin
        x-granular-scopes:
        - number_management:write:numbers:admin
    servers:
    - url: https://api.zoom.us/v2
  /number_management/byoc_numbers:
    post:
      tags:
      - Phone Numbers
      summary: Add BYOC phone numbers
      description: "Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.\n\n**Prerequisites:** \n* A Business or Enterprise plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:byoc_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: AddBYOCPhoneNumber
      requestBody:
        content:
          application/json:
            schema:
              required:
              - allocated_product
              - phone_numbers
              type: object
              properties:
                allocated_product:
                  type: string
                  description: The partners can allocate phone numbers for exclusive use by a specific Zoom Product (ZOOM_PHONE or ZOOM_CONTACT_CENTER).
                  example: ZOOM_PHONE
                  enum:
                  - ZOOM_PHONE
                  - ZOOM_CONTACT_CENTER
                country_iso:
                  type: string
                  description: "The two-lettered country code (Alpha-2 code in ISO-3166 format). \n- When the input number is a local number, country_iso is required. \n- When the input number is a E164 number, `country_iso` is optional."
                  example: US
                site_id:
                  type: string
                  description: 'The unique identifier of the site. This field is only required if you have enabled multiple sites in the account. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.

                    - If add a zoom phone number, and multiple sites is  enabled, `site_id` is required'
                  example: 8f71O6rWT8KFUGQmJIFAdQ
                phone_numbers:
                  maxItems: 100
                  type: array
                  description: Whether a input local number or E164 number.
                  items:
                    type: string
                    example: '+8618251885564'
                sip_group_id:
                  type: string
                  description: 'The SIP group ID.

                    - If adding a Zoom Phone number, and BYOC SIP Group is optional, `sip_group_id` is required. It can input  ZOOM_PHONE or COMMON `sip_group_id`

                    - If adding a Zoom Contact Center number, `sip_group_id` is required, and can input ZOOM_CONTACT_CENTER or COMMON `sip_group_id`. '
                  example: FLofRFDxSNiSd68iRZrZmg
                enable_pci_pal:
                  type: boolean
                  description: '- If you add a Zoom phone number and want to enable `enable_pci_pal`, you first need to enable Enable Compliance APIs in the Zoom Phone OP.

                    - If you add a Zoom Contact Center number and want to enable `enable_pci_pal`, you first need to enable PCI SIP Integration in the Zoom Contact Center OP.'
                  example: true
      responses:
        '201':
          description: '**HTTP Status Code:** `201` **Created**   BYOC phone numbers successfully added. '
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1000` <br>\n Some data failed.for example: [ {\"phoneNumber\":\"+12098888111\",\"reason\":\"Phone Number format invalid\"}, {\"phoneNumber\":\"+12090000011\",\"reason\":\"Phone Number already exists\"} ] <br>\n**Error Code:** `1004` <br>\n BYOC Phone Numbers are not enabled for this account <br>\n**Error Code:** `1003_001` <br>\n Too many numbers, should less than 100,contact zoom support team for more numbers <br>\n**Error Code:** `100_001` <br>\n Sip Group not found <br>\n**Error Code:** `200_005` <br>\n Current sip group don't support PCIPal <br>\n**Error Code:** `1002_003` <br>\n Site cannot be empty in zoom phone <br>\n**Error Code:** `1002_010` <br>\n The site does not exist <br>\n"
        '403':
          description: "**HTTP Status Code:** `403` <br>\n Forbidden  You do not have permission. \n\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:
        - number_management_numbers:write:admin
        - number_management:write:byoc_numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - PbxAdmin:Edit
        - ContactCenterMgt:Edit
        x-macro-scopes:
        - number_management_numbers:write:admin
        x-granular-scopes:
        - number_management:write:byoc_numbers:admin
    servers:
    - url: https://api.zoom.us/v2
  /number_management/numbers:
    get:
      tags:
      - Phone Numbers
      summary: List phone numbers
      description: 'Returns a list of phone numbers in an account. See section <b>Information in the phone number table</b> of [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581) for more details.


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_numbers:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
      operationId: listPhoneNumbers
      parameters:
      - name: page_size
        in: query
        description: The number of records returned within a single API call.
        required: false
        schema:
          maximum: 200
          type: integer
          example: 30
          default: 30
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: Fh98ehf98wehf9wehfhw
      - name: allocated_product
        in: query
        description: The product associated with the allocated number.
        required: false
        schema:
          type: string
          example: ZOOM_PHONE
          enum:
          - UNALLOCATED
          - ZOOM_PHONE
          - ZOOM_CONTACT_CENTER
      - name: number_type
        in: query
        description: The type of phone number.
        required: false
        schema:
          type: string
          example: Toll
          enum:
          - Toll
          - TollFree
          - VirtualService
          - Mobile
          - SharedCost
          - National
          - ITFS
      - name: number_status
        in: query
        description: The status of phone number.
        required: false
        schema:
          type: string
          example: Normal
          enum:
          - Normal
          - Pending
      - name: number_source
        in: query
        description: The source of phone number.
        required: false
        schema:
          type: string
          example: Zoom
          enum:
          - Zoom
          - ZoomPorted
          - ZoomReserved
          - ThirdPartyNumber
          - BYOCCloud
          - BYOCPremises
      - name: site_id
        in: query
        description: The site ID for the Zoom phone number.
        required: false
        schema:
          type: string
      - name: assigned_to_type
        in: query
        description: The type of target assigned to the number.
        required: false
        schema:
          type: string
          example: User
          enum:
          - PhoneUnassigned
          - User
          - CallQueue
          - AutoReceptionist
          - CiscoPolycomRoom
          - SharedLineGroup
          - GroupCallPickup
          - CommonArea
          - EmergencyNumberPool
          - CompanyLocation
          - PersonalLocation
          - MeetingService
          - LocalSurvivability
          - LocalSurvivabilityEmergencyNumberPool
          - MicrosoftTeamsResourceAccount
          - DistributionGroup
          - ContactCenterUnassigned
          - DialInToVideoEngagements
          - DefaultSystemOutgoingSMS
          - DefaultAgentOutgoingSMS
          - DefaultCallerID
          - Voice
          - SMS
      - name: keyword
        in: query
        description: This field allows you to search by phone number. Only prefix matching is available for search.
        required: false
        schema:
          type: string
          example: '1205'
      responses:
        '200':
          description: The list of phone numbers.
          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 returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: xuWXDDeGFkx0dyRtuwQR3M9NWIoMVD9e0a2
                  page_size:
                    type: integer
                    description: The page size in use.
                    example: 100
                  numbers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the phone number.
                          example: iHE1MQAET2iV85MbfaQmwg
                        number:
                          type: string
                          description: The phone number in E.164 format.
                          example: '+1203030333'
                        allocated_product:
                          type: string
                          description: The product assigned to the phone number.
                          example: ZOOM_CONTACT_CENTER
                          enum:
                          - UNALLOCATED
                          - ZOOM_PHONE
                          - ZOOM_CONTACT_CENTER
                        number_type:
                          type: string
                          description: The type of phone number.
                          example: Toll
                          enum:
                          - Toll
                          - TollFree
                          - VirtualService
                          - Mobile
                          - SharedCost
                          - National
                          - ITFS
                        display_name:
                          type: string
                          description: The display name for the phone number in Zoom Phone.
                          example: Alice
                        caller_id_name:
                          type: string
                          description: The caller ID name for a Contact Center number.
                          example: Bob Company
                        carrier:
                          type: object
                          properties:
                            code:
                              type: integer
                              description: The carrier code.
                              example: 2
                            name:
                              type: string
                              description: The name of the carrier.
                              example: Bandwidth
                          description: The carrier information for the Provider Exchange number.
                        capability:
                          type: array
                          description: The capability of the phone number.  The value can be Incoming, Outgoing, Messaging, PCIPal, and `EmergencyCalls` or any combination of them.
                          items:
                            type: string
                            description: The capability of the phone number
                            example: Incoming
                            enum:
                            - Incoming
                            - Outgoing
                            - Messaging
                            - PCIPal
                            - EmergencyCalls
                        source:
                          type: string
                          description: The source of phone number.
                          example: Zoom
                          enum:
                          - Zoom
                          - ZoomPorted
                          - ZoomReserved
                          - ThirdPartyNumber
                          - BYOCCloud
                          - BYOCPremises
                        status:
                          type: string
                          description: The status of the number.
                          example: Pending
                          enum:
                          - Normal
                          - Pending
                        emergency_address:
                          type: object
                          properties:
                            address_line1:
                              type: string
                              description: The house number and street name.
                              example: 53 Rav Road
                            address_line2:
                              type: string
                              description: The information about the building, floor, unit, and so on.
                              example: Floor 1
                            city:
                              type: string
                              description: The city in the address.
                              example: San Jose
                            county:
                              type: string
                              description: The county of the address for the Ireland address.
                              example: CO. Cork
                            state_code:
                              type: string
                              description: The state ISO code of the address.
                              example: CA
                            country:
                              type: string
                              description: The two-lettered country code (Alpha-2 code in ISO-3166 format).
                              example: US
                            zip:
                              type: string
                              description: The zip or postal code.
                              example: '95113'
                          description: The emergency address to bind to the phone number.
                        address_update_required:
                          type: boolean
                          description: The true value indicates the number's address need to be updated for BYOC Premise numbers.
                          example: true
                        emergency_address_update_time:
                          type: string
                          description: The updated timestamp of the number's address, in the format 'yyyy-MM-ddTHH:mm:ssZ'. It's used for Phone BYOC-Premises numbers.
                          example: '2024-10-29T14:18:28Z'
                        site:
                          type: object
                          properties:
                            site_id:
                              type: string
                              description: The site ID.
                              example: 8f71O6rWT8KFUGQmJIFAdQ
                            name:
                              type: string
                              description: The site name.
                              example: Main Site
                          description: The site associated with the phone number.
                        assigned_list:
                          type: array
                          items:
                            type: object
                            properties:
                              assigned_to_id:
                                type: string
                                description: "In Zoom Phone, this value can represent the ID of the user, emergency number pool (where the ID is either `siteId` if multiple sites are enabled, or `accountId` if not), or company location, depending on the `assigned_to_type `field.\nIn Contact Center, this field also has different meanings\n2: number assigned to Dial-in to Video Engagements \n3: number assigned to Default System Outgoing SMS\n4: number assigned to Default Caller ID\n8: number assigned to Default Agent Outgoing SMS\nOther: number assigned for specific use case , such as flow, queue and so on."
                                example: rYgfsrduSXWCxr94poMN5g
                              assigned_to_name:
                                type: string
                                description: The name of the user assigned with the number, emergency number pool, and company location.
                                example: Alice Bob
                              assigned_to_type:
                                type: string
                                description: This field indicates to whom the phone number belongs.
                                example: User
                                enum:
                                - User
                                - CallQueue
                                - AutoReceptionist
                                - CiscoPolycomRoom
                                - SharedLineGroup
                                - GroupCallPickup
                                - CommonArea
                                - EmergencyNumberPool
                                - CompanyLocation
                                - PersonalLocation
                                - MeetingService
                                - LocalSurvivability
                                - LocalSurvivabilityEmergencyNumberPool
                                - MicrosoftTeamsResourceAccount
                                - DistributionGroup
                              source_channel:
                                type: string
                                description: The channel of number that is only for Contact Center.
                                example: Voice
                                enum:
                                - Voice
                                - SMS
                              extension_number:
                                type: string
                                description: The extension number of an extension (e.g., user) for Zoom Phone
                                example: '6503'
                        sip_group:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The SIP group's ID.
                              example: vZWksdNbRkKTdzOth09skw
                            name:
                              type: string
                              description: The ID of the SIP group. See the **Creating SIP groups** section in [Creating a shared directory of external contacts](https://support.zoom.us/hc/en-us/articles/360037050092-Creating-a-shared-directory-of-external-contacts) for details.
                              example: SIP 01
                        location:
                          type: object
                          properties:
                            country:
                              type: string
                              description: The name of the country.
                              example: United States
                            city:
                              type: string
                              description: The phone number of the city location.
                              example: San Jose
                            state:
                              type: string
                              description: The state or province's name.
                              example: California
                          description: The phone number's area.
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `999` <br>\n Invalid value (e.g., allocated_product, number_type, number_soruce) <br>\n**Error Code:** `1002010` <br>\n The site does not exist <br>\n**Error Code:** `1003100` <br>\n The next page token is either invalid or has expired <br>\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  Lack of valid authentication \n\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:
        - number_management_numbers:read:admin
        - number_management:read:list_numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - ContactCenterMgt:Edit
        - PbxAdmin:Read
        x-macro-scopes:
        - number_management_numbers:read:admin
        x-granular-scopes:
        - number_management:read:list_numbers:admin
    delete:
      tags:
      - Phone Numbers
      summary: Delete phone numbers
      description: 'Deletes phone numbers.


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:master`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:numbers:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
      operationId: DeleteNumbers
      parameters:
      - name: numbers
        in: query
        description: A list of phone numbers to be delete.
        required: true
        schema:
          maxItems: 10
          type: array
          example:
          - iHE1MQAET2iV85MbfaQmwg
          - vZWksdNbRkKTdzOth09skw
          items:
            type: string
      responses:
        '204':
          description: The phone numbers have been deleted successfully.
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameter \n\n **Error Code:** `100002` <br>\n Phone number not found <br>\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  Lack of valid authentication \n\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:
        - number_management_numbers:write:master
        - number_management:delete:numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - PbxAdmin:Edit
        - ContactCenterMgt:Edit
        x-macro-scopes:
        - number_management_numbers:write:master
        x-granular-scopes:
        - number_management:delete:numbers:admin
    servers:
    - url: https://api.zoom.us/v2
  /number_management/numbers/{phoneNumberId}:
    get:
      tags:
      - Phone Numbers
      summary: Get a phone number
      description: "Returns information about an account's phone number. \n\nFor more details, see the section <b>Information in the phone number table</b> in [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: getPhoneNumber
      parameters:
      - name: phoneNumberId
        in: path
        description: The unique identifier of the phone number retrieved from the [List phone numbers](https://developers.zoom.us/docs/api/phone/#tag/carrier-reseller/GET/phone/carrier_reseller/numbers) API.
        required: true
        schema:
          type: string
          example: iHE1MQAET2iV85MbfaQmwg
      responses:
        '200':
          description: The phone number details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier of the phone number.
                    example: iHE1MQAET2iV85MbfaQmwg
                  number:
                    type: string
                    description: The phone number in E.164 format.
                    example: '+1203030333'
                  allocated_product:
                    type: string
                    description: The product assigned to the phone number.
                    example: ZOOM_CONTACT_CENTER
                    enum:
                    - UNALLOCATED
                    - ZOOM_PHONE
                    - ZOOM_CONTACT_CENTER
                  number_type:
                    type: string
                    description: The type of the phone number.
                    example: Toll
                    enum:
                    - Toll
                    - TollFree
                    - VirtualService
                    - Mobile
                    - SharedCost
                    - National
                    - ITFS
                  display_name:
                    type: string
                    description: The display name of the phone number for Zoom Phone numbers.
                    example: Alice
                  caller_id_name:
                    type: string
                    description: The caller ID name for the Contact Center numbers.
                    example: Bob Company
                  carrier:
                    type: object
                    properties:
                      code:
                        type: integer
                        description: The carrier code.
                        example: 2
                      name:
                        type: string
                        description: The name of the carrier.
                        example: Bandwidth
                    description: The carrier information for Provider Exchange numbers.
                  capability:
                    type: array
                    description: The capability of the phone number. The value can be Incoming, Outgoing, Messaging, PCIPal and Emergency Calls or any combination of them.
                    items:
                      type: string
                      description: The capability of the phone number.
                      example: Incoming
                      enum:
                      - Incoming
                      - Outgoing
                      - Messaging
                      - PCIPal
                      - EmergencyCalls
                  source:
                    type: string
                    description: The source of phone number.
                    example: Zoom
                    enum:
                    - Zoom
                    - ZoomPorted
                    - ZoomReserved
                    - ThirdPartyNumber
                    - BYOCCloud
                    - BYOCPremises
                  status:
                    type: string
                    description: The status of the number.
                    example: Pending
                    enum:
                    - Normal
                    - Pending
                  emergency_address:
                    type: object
                    properties:
                      address_line1:
                        type: string
                        description: The house number and street name.
                        example: 53 Rav Road
                      address_line2:
                        type: string
                        description: The field lists the building, floor, unit, and so on.
                        example: Floor 1
                      city:
                        type: string
                        description: The city of the address.
                        example: San Jose
                      county:
                        type: string
                        description: The county of the address, applicable for an Ireland address
                        example: CO. Cork
                      state_code:
                        type: string
                        description: The state ISO code of the address.
                        example: CA
                      country:
                        type: string
                        description: The two-lettered country code (Alpha-2 code in ISO-3166 format)
                        example: US
                      zip:
                        type: string
                        description: The zip or postal code.
                        example: '95113'
                    description: The emergency address bind to the phone number.
                  address_update_required:
                    type: boolean
                    description: The true value indicates the number's address need to be updated, applicable for BYOC Premise numbers.
                    example: true
                  emergency_address_update_time:
                    type: string
                    description: 'The updated timestamp of the number''s address, in the format ''yyyy-MM-ddTHH:mm:ssZ''. It''s used for Phone BYOC-Premises numbers. '
                    example: '2024-10-29T14:18:28Z'
                  site:
                    type: object
                    properties:
                      site_id:
                        type: string
                        description: The site ID.
                        example: 8f71O6rWT8KFUGQmJIFAdQ
                      name:
                        type: string
                        description: The name of the site.
                        example: Main Site
                    description: The site associated with the phone number.
                  assigned_list:
                    type: array
                    items:
                      type: object
                      properties:
                        assigned_to_id:
                          type: string
                          description: "In Zoom Phone, this value can represent the ID of the user, emergency number pool (where the ID is either `siteId` if multiple sites are enabled, or `accountId` if not), or company location, depending on the `assigned_to_type` field.\nIn Contact Center, this field also has different meanings.\n2: Number assigned to Dial-in to Video Engagements \n3: number assigned to Default System Outgoing SMS\n4: number assigned to Default Caller ID\n8: number assigned to Default Agent Outgoing SMS\nOther: number assigned for specific use case , such as flow, queue."
                          example: rYgfsrduSXWCxr94poMN5g
                        assgined_to_name:
                          type: string
                          description: The name of the user to whom the number, emergency number pool, and company location are assigned.
                          example: Alice Bob
                        assigned_to_type:
                          type: string
                          description: This field indicates to whom the phone number belongs.
                          example: User
                          enum:
                          - User
                          - CallQueue
                          - AutoReceptionist
                          - CiscoPolycomRoom
                          - SharedLineGroup
                          - GroupCallPickup
                          - CommonArea
                          - EmergencyNumberPool
                          - CompanyLocation
                          - PersonalLocation
                          - MeetingService
                          - LocalSurvivability
                          - LocalSurvivabilityEmergencyNumberPool
                          - MicrosoftTeamsResourceAccount
                          - DistributionGroup
                        source_channel:
                          type: string
                          description: The channel of number. (Only for Contact Center)
                          example: Voice
                          enum:
                          - Voice
                          - SMS
                        extension_number:
                          type: string
                          description: The extension number of an extension. (e.g., user). This field is applicable for Zoom Phone.
                          example: '6503'
                        meeting_id:
                          type: string
                          description: The meeting ID for Phone meeting service.
                          example: 964 3020 9491
                        greeting:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can use this audio ID to get the audio information in the [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
                              example: vWby3OZaQlS1nAdmEAqgwA
                            name:
                              type: string
                              description: 'The audio file name of the greeting prompt. '
                              example: hotspot.wav
                          description: This field applicable for meeting service.
                        on_hold_music:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The audio prompt file ID. If the audio is no longer in the user's audio library, it will be marked with a prefix, `removed_vWby3OZaQlS1nAdmEAqgwA` for example. You can use this audio ID to get the audio information in the [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.
                              example: vWby3OZaQlS1nAdmEAqgwA
                            name:
                              type: string
                              description: 'The audio file name of the on hold music prompt. '
                              example: music.wav
                          description: This field applicable for the meeting service.
                        display_number:
                          type: string
                          description: The displayed phone number in meeting invitations and emails for the meeting service.
                          example: +1 360 209 5623
                        label:
                          type: string
                          description: This label appends to the number in parentheses, and appears in meeting invitations and the Zoom client for the meeting service.
                          example: xxx
                  sip_group:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The ID of the SIP group. For details, see the **Creating SIP groups** section in [Creating a shared directory of external contacts](https://support.zoom.us/hc/en-us/articles/360037050092-Creating-a-shared-directory-of-external-contacts).
                        example: vZWksdNbRkKTdzOth09skw
                      name:
                        type: string
                        description: The SIP group display name
                        example: Sip 01
                  location:
                    type: object
                    properties:
                      country:
                        type: string
                        description: The name of the country.
                        example: United States
                      city:
                        type: string
                        description: The phone number's city location.
                        example: San Jose
                      state:
                        type: string
                        description: The state or province name.
                        example: California
                    description: The phone number area.
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  Lack of valid authentication \n\n "
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  The phone number not found \n\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:
        - number_management_numbers:read:admin
        - number_management:read:numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - ContactCenterMgt:Edit
        - PbxAdmin:Read
        x-macro-scopes:
        - number_management_numbers:read:admin
        x-granular-scopes:
        - number_management:read:numbers:admin
    patch:
      tags:
      - Phone Numbers
      summary: Update a phone number
      description: 'Updates a phone number''s information.


        **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`


        **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:numbers:admin`


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
      operationId: updatePhoneNumberDetail
      parameters:
      - name: phoneNumberId
        in: path
        description: The unique identifier for the phone number retrieved from the List Phone Numbers API.
        required: true
        schema:
          type: string
          example: tDiG8cmnQmCaMRqbZ730Cw
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                display_name:
                  type: string
                  description: Zoom Phone numbers use a phone number display name with a limit of 32 characters or fewer.
                  example: Bob
                caller_id_name:
                  type: string
                  description: The caller ID name has 15 characters or fewer, and should have at least one alpha character. The Contact Center supports only US/CA Virtual Service numbers.
                  example: Alice
                confirm_address_update:
                  type: boolean
                  description: Whether to confirm the emergency address update for Zoom Phone BYOC Premises numbers.
                  example: true
                sip_group_id:
                  type: string
                  description: This field retrieves the SIP group ID from the List Sip Group API for use with BYOC Premise phone numbers.
                  example: ybFTE3KXRIC7vJ8kOdmjWg
                capability:
                  type: object
                  properties:
                    incoming:
                      type: boolean
                      description: A value of true enables the capability. A value of false disables it.
                      example: true
                    outgoing:
                      type: boolean
                      description: A value of true enables the capability. A value of false disables it.
                      example: false
                  description: Applicable for Zoom Phone numbers.
      responses:
        '204':
          description: Succeed to update the phone number
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameter or operation \n\n **Error Code:** `999` <br>\n Invalid Field <br>\n**Error Code:** `100001` <br>\n Sip Group not found <br>\n**Error Code:** `200001` <br>\n The capability cannot be updated <br>\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized  Lack of valid authentication \n\n "
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  Phone number not found \n\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:
        - number_management_numbers:write:admin
        - number_management:update:numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions:
        - PbxAdmin:Edit
        - ContactCenterMgt:Edit
        x-macro-scopes:
        - number_management_numbers:write:admin
        x-granular-scopes:
        - number_management:update:numbers:admin
    servers:
    - url: https://api.zoom.us/v2
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
x-refined-from:
- zoom-phone-api-openapi.json
- zoom-phone-number-management-openapi.json