Zoom Phone Settings API

openapi: 3.2.0
info:
  title: Phone Settings API
  description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n  To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n  All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Settings
paths:
  /phone/policies/{policyType}:
    get:
      tags:
      - Settings
      summary: Get account policy details
      description: 'Returns the account policy details.


        **Prerequisites**

        * Pro or higher account plan with Zoom phone license


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


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


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
      operationId: GetAccountPolicyDetails
      parameters:
      - name: policyType
        in: path
        description: 'This field specifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.


          Supported values:

          - `allow_emergency_calls`: Controls whether emergency calls are allowed.'
        required: true
        schema:
          type: string
          example: restricted_call_hours
          enum:
          - allow_emergency_calls
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Get account policy details successfully.'
          content:
            application/json:
              schema:
                oneOf:
                - title: Allow Emergency Calls
                  type: object
                  properties:
                    allow_emergency_calls:
                      type: object
                      properties:
                        enable:
                          type: boolean
                          description: Whether users in this account are allowed to make emergency calls.
                          example: true
                        locked:
                          type: boolean
                          description: Whether this setting is locked by the account administrator and cannot be overridden at lower levels (user_group, site, or extension).
                          example: true
                        locked_by:
                          type: string
                          description: This field specifies the configuration level that has enforced the lock. This indicates where the setting was originally locked and cannot be overridden.
                          example: account
                          enum:
                          - invalid
                          - account
                        allow_emergency_calls_from_clients:
                          type: boolean
                          description: Whether users are allowed to make emergency calls from zoom clients.
                          example: true
                        allow_emergency_calls_from_deskphones:
                          type: boolean
                          description: Whether users are allowed to make emergency calls from desk phones.
                          example: true
                      description: The account-level settings for whether emergency calls are allowed for users and from specific device types.
                  description: This field is returned only when `policyType` is `allow_emergency_calls`.
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Invalid value for parameter 'policyType'. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:policy:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:policy:admin
    patch:
      tags:
      - Settings
      summary: Update account policy
      description: "Updates the account's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) policy.\n\n**Prerequisites** \n* A Business or Enterprise account \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:update:policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`"
      operationId: updateAccountPolicy
      parameters:
      - name: policyType
        in: path
        description: 'This field epecifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.


          Supported values:

          - `allow_emergency_calls`: Controls whether emergency calls are allowed.'
        required: true
        schema:
          type: string
          example: allow_emergency_calls
          enum:
          - allow_emergency_calls
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - title: Allow Emergency Calls
                type: object
                properties:
                  allow_emergency_calls:
                    type: object
                    properties:
                      enable:
                        type: boolean
                        description: Whether users in this account are allowed to make emergency calls.
                        example: true
                      locked:
                        type: boolean
                        description: Whether this setting is locked by the account administrator and cannot be overridden at lower levels (user_group, site, or extension).
                        example: true
                      allow_emergency_calls_from_clients:
                        type: boolean
                        description: Whether users are allowed to make emergency calls from zoom clients.
                        example: true
                      allow_emergency_calls_from_deskphones:
                        type: boolean
                        description: Whether users are allowed to make emergency calls from desk phones.
                        example: true
                    description: THe account-level settings for whether emergency calls are allowed for users and from specific device types.
                description: This field is supported only when `policyType` is `allow_emergency_calls`.
      responses:
        '204':
          description: "**HTTP Status Code:** `204`  \n \nAccount policy updated."
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Invalid value for parameter 'policyType'. <br>\n**Error Code:** `400` <br>\n The 'reset' field is not allowed at the account level. <br>\n**Error Code:** `400` <br>\n Lock and reset operations cannot be performed simultaneously. <br>\n**Error Code:** `400` <br>\n Reset cannot be combined with other operations. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\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:admin
        - phone:update:policy:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:policy:admin
  /phone/ported_numbers/orders:
    get:
      tags:
      - Settings
      summary: List ported numbers
      description: "Use this API to list ported 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`,`phone_peering:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_ported_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: listPortedNumbers
      parameters:
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      - name: 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
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Ported Phone numbers listed successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  next_page_token:
                    type: string
                    description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42
                  page_size:
                    type: integer
                    description: The number of records returned within a single API call.
                    example: 30
                  ported_numbers:
                    type: array
                    items:
                      type: object
                      properties:
                        numbers:
                          type: array
                          description: The ported numbers.
                          items:
                            type: string
                            example: '+12058945752'
                        order_id:
                          type: string
                          description: The ported numbers' order ID.
                          example: '2021080307332974349'
                        replacing_numbers:
                          type: array
                          description: The ported numbers' replacement numbers.
                          items:
                            type: object
                            properties:
                              source_number:
                                type: string
                                description: The source number.
                                example: '+12058945752'
                              target_number:
                                type: string
                                description: The replaced number.
                                example: '+12058945755'
                        status:
                          type: string
                          description: The ported numbers' status.
                          example: Canceled
                          enum:
                          - Not_Submitted
                          - Waiting
                          - Processing
                          - Successfully
                          - Rejected
                          - Canceled
                          - FOC
                        submission_date_time:
                          type: string
                          description: 'The time ported numbers were submitted (format: ''yyyy-MM-ddThh:dd:ssZ'').'
                          example: '2021-08-03T07:33:29Z'
                  total_records:
                    type: integer
                    description: The total number of records returned.
                    example: 2
        '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_peering:read:admin
        - phone:read:list_ported_numbers:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        - phone_peering:read:admin
        x-granular-scopes:
        - phone:read:list_ported_numbers:admin
  /phone/ported_numbers/orders/{orderId}:
    get:
      tags:
      - Settings
      summary: Get ported numbers details
      description: "Returns details on the ported numbers by specifying `order_id`.\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`,`phone_peering:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ported_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: getPortedNumbersDetails
      parameters:
      - name: orderId
        in: path
        description: Order ID of the ported numbers. This can be retrieved from the List Ported Numbers API.
        required: true
        schema:
          type: string
          example: '2021080307332974349'
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Ported numbers details retrieved successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  contact_emails:
                    type: string
                    description: Contact emails of transferring numbers.
                    example: example@163.com
                  contact_number:
                    type: string
                    description: Contact numbers for transferring numbers.
                    example: '2058945753'
                  isp:
                    type: string
                    description: Ported numbers' ISP.
                    example: Twilio International
                  numbers:
                    type: array
                    description: Ported numbers.
                    items:
                      type: string
                      example: '+12058945752'
                  order_id:
                    type: string
                    description: Ported numbers' order ID.
                    example: '2021080307332974349'
                  original_billing_info:
                    type: object
                    properties:
                      account_number:
                        type: string
                        example: '111223'
                      address:
                        type: object
                        properties:
                          city:
                            type: string
                            example: San Jose
                          country:
                            type: string
                            example: US
                          house_number:
                            type: string
                            example: '55'
                          state_code:
                            type: string
                            example: CA
                          street_name:
                            type: string
                            example: ALMADEN BLVD
                          zip:
                            type: string
                            example: '95113'
                      authorizing_person:
                        type: string
                        example: zz
                      billing_telephone_number:
                        type: string
                        example: '2058945751'
                      company:
                        type: string
                        example: zm
                      customer_requested_date:
                        type: string
                        example: '2021-08-06'
                      pin:
                        type: string
                        example: '111223'
                    description: Ported numbers' original billing info.
                  printed_name:
                    type: string
                    description: Printed names on transferring numbers.
                    example: Jiang
                  replacing_numbers:
                    type: array
                    description: The ported numbers' replacement numbers.
                    items:
                      type: object
                      properties:
                        source_number:
                          type: string
                          description: The source number.
                          example: '+12058945752'
                        target_number:
                          type: string
                          description: The replaced number.
                          example: '+12058945755'
                  status:
                    type: string
                    description: Ported numbers' status.
                    example: Canceled
                    enum:
                    - Not_Submitted
                    - Waiting
                    - Processing
                    - Successfully
                    - Rejected
                    - Canceled
                    - FOC
                  submission_date_time:
                    type: string
                    description: 'The time ported numbers were submitted (format: ''yyyy-MM-ddThh:dd:ssZ'').'
                    example: '2021-08-03T07:33:29Z'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Portin order 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 "
      deprecated: true
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone_peering:read:admin
        - phone:read:ported_number:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        - phone_peering:read:admin
        x-granular-scopes:
        - phone:read:ported_number:admin
  /phone/settings:
    get:
      tags:
      - Settings
      summary: Get phone account settings
      description: "Returns an account's settings.\n\n**Prerequisites:**\n* A Business or Enterprise account \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:settings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
      operationId: phoneSetting
      responses:
        '200':
          description: "**HTTP Status Code:** `200`   \n Account setting returned. "
          content:
            application/json:
              schema:
                type: object
                properties:
                  byoc:
                    type: object
                    properties:
                      enable:
                        type: boolean
                        description: The swtich for the BYOC function.
                        example: true
                    description: The BYOC setting
                  country:
                    type: object
                    properties:
                      code:
                        type: string
                        description: The country code.
                        example: US
                      name:
                        type: string
                        description: The country name.
                        example: United States
                  multiple_sites:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        description: The multiple sites switch.
                        example: true
                      site_code:
                        type: boolean
                        description: The site code switch.
                        example: true
                  show_device_ip_for_call_log:
                    type: object
                    properties:
                      enable:
                        type: boolean
                        description: If the value of this field is `true`, it allows `/phone/call_logs` and `/phone/call_logs/{callLogId}` APIs to show `device_public_ip` and `device_private_ip` in the response.
                        example: true
                  multiple_party_conference:
                    type: object
                    properties:
                      enable:
                        type: boolean
                        description: If the value of this field is `true`, it allows multiple parties to join the conference.
                        example: true
                  billing_account:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The billing account ID.
                        example: 3WWAEiEjTj2IQuyDiKMd_A
                      name:
                        type: string
                        description: The billing account name.
                        example: Delhi billing
                    description: The billing account setting.
                description: The Zoom account setting
        '403':
          description: "**HTTP Status Code:** `403` <br>\n Forbidden \n\n **Error Code:** `2031` <br>\n Zoom Phone has not been enabled for this account. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:settings:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:settings:admin
    patch:
      tags:
      - Settings
      summary: Update phone account settings
      description: "Updates Zoom Phone [account settings](https://support.zoom.us/hc/en-us/articles/360025846692).\n\n**Prerequisites:** \n* A Business or Enterprise 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:settings:admin`"
      operationId: updatePhoneSettings
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                byoc:
                  type: object
                  properties:
                    enable:
                      type: boolean
                      description: Setting the value of this field to `true` allows a sub account to add BYOC numbers from the Zoom web admin portal.
                      example: true
                  description: "Only [master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this MA API to enable BYOC(Bring your own carrier) option for a sub account.  \n \n\n**Scope**:  \n \n* `phone:master`   \n \n\n**Prerequisites**:   \n \n* Business or enterprise Account.  \n "
                multiple_sites:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      description: When the value is set to `true` for [site management](https://support.zoom.us/hc/en-us/articles/360020809672), your current site defaults to your Main Site.
                      example: true
                    site_code:
                      type: object
                      properties:
                        enable:
                          type: boolean
                          description: You must enable multiple sites before you can set this value to `true`.
                          example: true
                        short_extension_length:
                          type: integer
                          description: This field must be configured before you can set the site code to `true`. The range is [2, 10] if the account's `15-Digit Max Length Extensions` feature is enabled; if not, [2, 5].
                          example: 3
                show_device_ip_for_call_log:
                  type: object
                  properties:
                    enable:
                      type: boolean
                      description: This field must be set to `true` to allow `/phone/call_logs` and `/phone/call_logs/{callLogId}` APIs to show `device_public_ip` and `device_private_ip` in the response.
                      example: true
                billing_account:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The billing account ID.
                      example: 3WWAEiEjTj2IQuyDiKMd_A
                  description: The billing account setting.
      responses:
        '204':
          description: "**Response HTTP code**: `204` **No Content.**  \n \nUpdated successfully.\n\n"
        '401':
          description: "**HTTP Status Code:** `401` <br>\n Unauthorized \n\n **Error Code:** `124` <br>\n Account does not exist: {accountId}. <br>\n"
        '403':
          description: "**HTTP Status Code:** `403` <br>\n Forbidden \n\n **Error Code:** `2031` <br>\n Zoom Phone has not been enabled for this account. <br>\n"
        '412':
          description: "**HTTP Status Code:** `412` <br>\n undefined \n\n **Error Code:** `412` <br>\n Disable multiple sites after deleting other sites. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:update:settings:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:settings:admin
  /phone/sip_groups:
    get:
      tags:
      - Settings
      summary: List SIP groups
      description: "Returns a list of SIP (Session Initiation Protocol) groups.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sip_groups:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: listSipGroups
      parameters:
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      - name: page_size
        in: query
        description: The number of records returned within a single API call.
        required: false
        schema:
          maximum: 300
          type: integer
          example: 30
          default: 30
      responses:
        '200':
          description: '**HTTP Status Code:** `200`


            SIP groups successfully listed.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  next_page_token:
                    type: string
                    description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: IXIhcpJWscHfISSKTcdl2QpSMLyRE38zH92
                  page_size:
                    type: integer
                    description: The number of records returned with a single API call.
                    example: 3
                  sip_groups:
                    type: array
                    description: SIP group information.
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                          description: The SIP group's description.
                          example: test SIP group
                        display_name:
                          type: string
                          description: The SIP group's display name.
                          example: RRRR
                        id:
                          type: string
                          description: The SIP group's ID.
                          example: 8MhK7ea4Q4ihIQ4TD_g0kw
                        send_sip_group_name:
                          type: boolean
                          description: Whether the SIP group's name is sent in the SIP header.
                          example: false
                          enum:
                          - true
                          - false
                        sip_trunk:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The SIP trunk group's ID.
                              example: VWQU-veBQnm08EtBkUGnbw
                            name:
                              type: string
                              description: The SIP trunk group's name.
                              example: TESTAPI01
                          description: The SIP trunk group.
        '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_sip_groups:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_sip_groups:admin
  /phone/sip_trunk/trunks:
    get:
      tags:
      - Settings
      summary: List BYOC SIP trunks
      description: "Returns a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zo

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