Zoom Phone Call Queues API

openapi: 3.2.0
info:
  title: Phone Call Queues 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: Call Queues
paths:
  /phone/call_queue_analytics:
    get:
      tags:
      - Call Queues
      summary: List call queue analytics
      description: 'Returns the call queue analytics overview.


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


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


        **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
      operationId: callqueueanalytics
      parameters:
      - name: page_size
        in: query
        description: The number of records returned within a single API call.
        required: false
        schema:
          maximum: 300
          type: integer
          example: 30
          default: 30
      - name: from
        in: query
        description: The call start time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The earliest data available for query is from 2 years ago. If unspecified, returns data within the 24 hours.
        required: true
        schema:
          type: string
          format: date
          example: '2025-05-01'
      - name: to
        in: query
        description: The call end time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. Queries must be within a one-year interval. If unspecified, it would be present day
        required: true
        schema:
          type: string
          format: date
          example: '2025-05-15'
      - 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: site_id
        in: query
        description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
        required: false
        schema:
          type: string
          example: lA68sMSVQ6GAUcGg_GH0nQ
      - name: call_queue_ext_ids
        in: query
        description: The call queue extension ID list.
        required: false
        schema:
          maxItems: 300
          type: array
          example: []
          items:
            type: string
            example: 8f71O6rWT8KFUGQmJIFAdQ
      - name: department
        in: query
        description: The department of which the call queue belongs.
        required: false
        schema:
          type: string
          example: IT department
      - name: cost_center
        in: query
        description: The cost center where the call queue belongs.
        required: false
        schema:
          type: string
          example: HR cost center
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**Call Queues analytics listed successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  call_queues:
                    type: array
                    description: A list with call queue historical analytics data.
                    items:
                      type: object
                      properties:
                        call_queue_id:
                          type: string
                          description: The unique identifier of the call queue.
                          example: 3PNsZB50TNev4pgBjtKeDw
                        call_queue_name:
                          type: string
                          description: The name of the call queue.
                          example: test call queue
                        call_queue_ext_id:
                          type: string
                          description: The extension of the call queue.
                          example: 8f71O6rWT8KFUGQmJIFAdQ
                        inbound_calls:
                          type: integer
                          description: The number of inbound calls.
                          example: 500
                        completed_calls:
                          type: integer
                          description: The number of completed calls.
                          example: 450
                        abandoned_calls:
                          type: integer
                          description: The number of abandoned calls.
                          example: 40
                        overflowed_calls:
                          type: integer
                          description: The number of overflowed calls.
                          example: 10
                        avg_handle_time:
                          type: integer
                          description: The average handle time for call in seconds.
                          example: 180
                        avg_wrap_up_time:
                          type: integer
                          description: The average wrap up time for calls in seconds.
                          example: 60
                        avg_in_queue_wait_time:
                          type: integer
                          description: The average call wait time in seconds.
                          example: 30
                        max_in_queue_wait_time:
                          type: integer
                          description: The max call wait time in seconds.
                          example: 120
                        outbound_calls:
                          type: integer
                          description: The number of outbound calls.
                          example: 300
                        outbound_connected_calls:
                          type: integer
                          description: The number of connected outbound calls.
                          example: 450
                        outbound_unconnected_calls:
                          type: integer
                          description: The number of unconnected outbound calls.
                          example: 30
                        site_name:
                          type: string
                          description: The name of the site for the CQ.
                          example: SJ Site
                        site_id:
                          type: string
                          description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
                          example: lA68sMSVQ6GAUcGg_GH0nQ
                  from:
                    type: string
                    description: The start time and date of the log.
                    example: '2021-10-01'
                  to:
                    type: string
                    description: The end time and date of the log.
                    example: '2021-10-12'
                  page_size:
                    type: integer
                    description: The number of records returned within a single API call for each page.
                    example: 30
                  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: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Validation Failed <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/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_call_queues:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_call_queues:admin
  /phone/call_queues:
    get:
      tags:
      - Call Queues
      summary: List call queues
      description: "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to list Call queues.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
      operationId: listCallQueues
      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 from a single API call.
        required: false
        schema:
          maximum: 100
          type: integer
          example: 30
          default: 30
      - name: site_id
        in: query
        description: Unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
        required: false
        schema:
          type: string
          example: 8f71O6rWT8KFUGQmJIFAdQ
      - name: cost_center
        in: query
        description: The call queue's cost center.
        required: false
        schema:
          type: string
          example: CQ cost center
      - name: department
        in: query
        description: The call queue's department.
        required: false
        schema:
          type: string
          example: Phone department
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Call Queues listed successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  call_queues:
                    type: array
                    items:
                      type: object
                      properties:
                        extension_id:
                          type: string
                          description: The extension ID.
                          example: DgKe5UPTTlODBvcgmRIlPw
                        extension_number:
                          type: integer
                          description: The extension number assigned to the queue.
                          format: int64
                          example: 26000026001
                        id:
                          type: string
                          description: Unique identifier of the call queue.
                          example: 3PNsZB50TNev4pgBjtKeDw
                        name:
                          type: string
                          description: Name of the Call Queue.
                          example: ApiTA_2020_12_21_19_54_05_476
                        phone_numbers:
                          type: array
                          description: Phone number(s) assigned to the call queue.
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Unique identifier of the assigned phone number.
                                example: KsxwNLEhQ0SJ4U4Bor4ShA
                              number:
                                type: string
                                description: The phone number.
                                example: '+12058945717'
                              source:
                                type: string
                                description: Source
                                example: internal
                                enum:
                                - internal
                                - external
                        site:
                          type: object
                          properties:
                            id:
                              type: string
                              description: 'Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the Call Queue is assigned. '
                              example: 8f71O6rWT8KFUGQmJIFAdQ
                            name:
                              type: string
                              description: Name of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
                              example: Main Site
                        status:
                          type: string
                          description: 'Status of the Call Queue.

                            `active`: Call queue is enabled and active.

                            `inactive`: Call queue is inactive. Inactive call queues cannot be called but will retain its settings and appear in the [Call Queues](https://zoom.us/pbx/page/telephone/groups#/groups) page.'
                          example: active
                          enum:
                          - active
                          - inactive
                  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: OvrVMfenVmKgsH0SqfWQ2jgUsHFGXeanCB2
                  page_size:
                    maximum: 300
                    type: integer
                    description: The number of records returned from a single API call.
                    example: 30
                  total_records:
                    type: integer
                    description: The total number of records found for this query.
                    example: 1
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_call_queues:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_call_queues:admin
    post:
      tags:
      - Call Queues
      summary: Create a call queue
      description: "[Creates a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413). Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on.\n You can add phone users or common areas to call queues.\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* 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:write:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: createCallQueue
      requestBody:
        content:
          application/json:
            schema:
              required:
              - name
              - site_id
              type: object
              properties:
                cost_center:
                  type: string
                  description: The cost center name.
                  example: testCostCenter
                department:
                  type: string
                  description: The department name.
                  example: testDepartment
                description:
                  maxLength: 32
                  type: string
                  description: The description for the call queue.
                  example: testDescription
                extension_number:
                  type: integer
                  description: 'The phone extension number for the site.



                    If a site code has been [assigned](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number instead of the original extension number.'
                  format: int64
                  example: 10
                members:
                  type: object
                  properties:
                    common_area_ids:
                      maxItems: 10
                      type: array
                      description: "**Optional**\n\n The unique identifier of the [common area](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/listCommonAreas). This can be retrieved from the [List Common Areas](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCommonAreas) API."
                      items:
                        type: string
                        example: 1pegM6NlSfCEP_jBCfX94A
                    users:
                      maxItems: 10
                      type: array
                      description: The object of the user. It provides either the 'id' (userId) field or the 'email address' of the user.
                      items:
                        type: object
                        properties:
                          email:
                            type: string
                            description: The email address of the user. It can be retrieved from the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/users) API.
                            format: email
                            example: 2021050800001@testapi.com
                          id:
                            type: string
                            description: The user ID. It can be retrieved from the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/users) API.
                            example: dksc_wq67sach2_3jxs
                  description: A list of one or more phone users to be included in the call queue. It provides either users or common area(s), or at least one user in the users object.
                name:
                  maxLength: 32
                  minLength: 1
                  type: string
                  description: The name of the call queue.
                  example: callhandling0001_Not_Delete
                site_id:
                  type: string
                  description: The unique identifier of the site. It's required only if [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) have been enabled. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
                  example: lA68sMSVQ6GAUcGg_GH0nQ
      responses:
        '201':
          description: '**HTTP Status Code:** `201` **Created**


            Call queue created successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  extension_number:
                    type: integer
                    description: The extension number assigned for the call queue.
                    format: int64
                    example: 26000026010
                  id:
                    type: string
                    description: The unique identifier of the call queue.
                    example: IU8_1qAGS1Gf-3e56B_1Lw
                  name:
                    type: string
                    description: The name of the call queue.
                    example: callhandling0001_Not_Delete
                  status:
                    type: string
                    description: 'The status of the call queue.


                      `active`: Call queue is enabled and active.


                      `inactive`: Call queue is inactive. Inactive call queues cannot be called but will retain its settings and appear in the [Call Queues](https://zoom.us/pbx/page/telephone/groups#/groups) page.'
                    example: active
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Validation Failed.\n\nMultiple Site is disabled.\n\nSite does not exist.\n {extensionNumber} is out of range\n Exceeded the maximum number to add members per time <br>\n**Error Code:** `400` <br>\n Invalid short number length.\n Extension number {extensionNumber} is already used. <br>\n**Error Code:** `412` <br>\n The maximum number of Call Queue members is up to {maxSize}. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User not found: {userId} <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:write:call_queue:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:write:call_queue:admin
  /phone/call_queues/{callQueueId}:
    get:
      tags:
      - Call Queues
      summary: Get call queue details
      description: "Routes incoming calls to a group of users and returns information on a specific call queue. \n\nFor instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. \n\n\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: getACallQueue
      parameters:
      - name: callQueueId
        in: path
        description: The unique identifier of the call queue. You can retrieve it from the [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues).
        required: true
        schema:
          type: string
          example: 3PNsZB50TNev4pgBjtKeDw
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Call Queue details retrieved successfully. '
          content:
            application/json:
              schema:
                type: object
                properties:
                  cost_center:
                    type: string
                    description: The name of the cost center.
                    example: testCostCenter
                  department:
                    type: string
                    description: The name of the department.
                    example: testDepartment
                  extension_id:
                    type: string
                    description: The extension ID.
                    example: DgKe5UPTTlODBvcgmRIlPw
                  extension_number:
                    type: integer
                    description: The extension number assigned to the call queue.
                    format: int64
                    example: 26000026001
                  id:
                    type: string
                    description: The unique identifier of the call queue.
                    example: 3PNsZB50TNev4pgBjtKeDw
                  members:
                    type: object
                    properties:
                      users:
                        maxItems: 300
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The unique identifier of the user.
                              example: yNCY-HBHQ36rkXEXYTwu2g
                            level:
                              type: string
                              description: 'The level of the user. The value can be one of the following:


                                `manager`: A call queue manager has the privilege to change call queue settings, policy settings and manage recordings and voicemail inbox. There can only be one manager for each call queue.



                                `user`: Regular user without the privileges of a manager.'
                              example: user
                              enum:
                              - manager
                              - user
                            name:
                              type: string
                              description: The name of the user.
                              example: APITA AUTO
                            receive_call:
                              type: boolean
                              description: Whether the user can receive calls or not.
                              example: true
                            extension_id:
                              type: string
                              description: The extension ID of the user.
                              example: oeDyBe8zT2SzOZW6gQJXUA
                      common_areas:
                        maxItems: 300
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The unique identifier of the common area.
                              example: HIlHzOEzS8ymQPFBZ-39AQ
                            name:
                              type: string
                              description: The name of the common area.
                              example: Common Area
                            extension_id:
                              type: string
                              description: The extension ID of common area.
                              example: HIlHzOEzS8ymQPFBZ-39AQ
                  name:
                    type: string
                    description: The name of the call queue.
                    example: ApiTA_2020_12_21_19_54_05_476
                  phone_numbers:
                    maxItems: 50
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the number.
                          example: KsxwNLEhQ0SJ4U4Bor4ShA
                        number:
                          type: string
                          description: The phone number.
                          example: '+12058945717'
                        source:
                          type: string
                          description: The source.
                          example: internal
                          enum:
                          - internal
                          - external
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
                        example: lA68sMSVQ6GAUcGg_GH0nQ
                      name:
                        type: string
                        description: The name of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
                        example: ApiTA_Site_2020_07_12_00_42_50_109
                  status:
                    type: string
                    description: The status of the call queue.
                    example: active
                    enum:
                    - active
                    - inactive
                  policy:
                    type: object
                    properties:
                      voicemail_access_members:
                        maxItems: 50
                        uniqueItems: true
                        type: array
                        description: The shared voicemail access member list.
                        items:
                          allOf:
                          - type: object
                            properties:
                              access_user_id:
                                type: string
                                description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type.
                                example: w0RChiauQeqRlv5fgxYULQ
                              access_user_type:
                                type: string
                                description: 'The extension type of a member in the shared voicemail access member list. Allowed: user | commonArea.'
                                example: commonArea
                                enum:
                                - commonArea
                                - user
                              allow_download:
                                type: boolean
                                description: Whether the member has download permissions. The default is **false**.
                                example: false
                              allow_delete:
                                type: boolean
                                description: Whether the member has delete permissions. The default is **false**.
                                example: false
                              allow_sharing:
                                type: boolean
                                description: Whether the member has the permission to share. The default is **false**.
                                example: false
                          - type: object
                            pr

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