openapi: 3.0.0
info:
  title: Webex Admin Address Book Contact Service Queue API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Contact Service Queue
paths:
  /organization/{orgid}/contact-service-queue:
    get:
      tags:
      - Contact Service Queue
      summary: List Contact Service Queue(s)
      description: "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
      operationId: getAllFilteredConfig_1
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: filter
        in: query
        description: "Specify a filter based on which the results will be fetched. Supported filterable fields:  id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
        required: false
        schema:
          type: string
        example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
      - name: channelTypes
        in: query
        description: ' [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.'
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
        example:
        - TELEPHONY
        - CHAT
      - name: attributes
        in: query
        description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      - name: singleObjectResponse
        in: query
        description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactServiceQueueDTOList'
              example:
              - recordingPermitted: true
                ivrRequeueUrl: https://www.youtube.com
                agentsLastUpdatedByUserEmailPrefix: string
                personalizedAIRouting: string
                timezone: America/New_York
                socialChannelType: MESSENGER
                controlFlowScriptUrl: https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield
                description: Queue created by system
                monitoringPermitted: true
                vendorId: AB123CSDR
                queueLevelRealTimeTranscriptionsInclusion: INCLUDED
                channelType: TELEPHONY
                queueRoutingType: TEAM_BASED
                recordingAllCallsPermitted: true
                organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                recordingPauseDuration: 2
                systemDefault: false
                defaultMusicInQueueMediaFileId: defaultmusic_on_hold.wav
                queueLevelPredictedWaitTimeInclusion: INCLUDED
                queueLevelAutoCsatInclusion: INCLUDED
                serviceLevelThreshold: 0
                routingType: SKILLS_BASED
                skillBasedRoutingType: BEST_AVAILABLE_AGENT
                createdTime: string
                lastUpdatedTime: string
                id: 93912f11-6017-404b-bf14-5331890b1797
                maxTimeInQueue: 2
                xspVersion: xsp-24.0
                maxActiveContacts: 5
                pauseRecordingPermitted: true
                checkAgentAvailability: true
                outdialCampaignEnabled: true
                assistantSkill: string
                parkingPermitted: true
                agentsLastUpdatedByUserName: string
                active: true
                version: 1
                queueLevelSummariesInclusion: INCLUDED
                overflowNumber: '1245677'
                agentsLastUpdatedTime: 1742556600000
                queueLevelSentimentAnalysisInclusion: INCLUDED
                name: Queue-1
                queueType: INBOUND
                subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478
                manuallyAssignable: false
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    post:
      tags:
      - Contact Service Queue
      summary: Create a new Contact Service Queue
      description: Create a new Contact Service Queue in a given organization.
      operationId: createConfig_16
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: The Contact Service Queue object to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactServiceQueueDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/bulk:
    post:
      tags:
      - Contact Service Queue
      summary: Bulk save Contact Service Queue(s)
      description: Create, Update or delete Contact Service Queue(s) in bulk in a given organization.
      operationId: saveAllConfig_16
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: The list of Contact Service Queue items for bulk save.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequestDTOContactServiceQueueDTO'
        required: true
      responses:
        '207':
          description: Multi-Status
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkResponseDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    patch:
      tags:
      - Contact Service Queue
      summary: Bulk partial update Contact Service Queue(s)
      description: Update some or all properties for multiple Contact Service Queue(s) in bulk in a given organization.
      operationId: patchAllConfig_1
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: 'For each of the item to update,

          We only need to provide the patch JSON.

          Only the following properties are mandatory to identify unique item for update. Other properties are optional.

          Mandatory Properties: [id]

          All properties that can be updated via PUT Api are allowed to be updated.

          To nullify a property or remove it, specify null as value for the Json property.

          Valid value for requestAction property is ''SAVE''. It is optional property and default SAVE is assumed.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequestDTOContactServiceQueueDTO'
            example:
              items:
              - item:
                  id: 26e2df70-0f77-41b8-8e8f-1d76e92c9638
                  assistantSkill:
                    assistantSkillId: 26e2df70-0f77-41b8-8e8f-1d76e92c9639
                itemIdentifier: 0
                requestAction: SAVE
        required: true
      responses:
        '207':
          description: Multi-Status
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkResponseDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/bulk-export:
    get:
      tags:
      - Contact Service Queue
      summary: Bulk export Contact Service Queue(s)
      description: Export all Contact Service Queue(s) in a given organization.
      operationId: bulkExport_14
      deprecated: true
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: type
        in: query
        description: Indicates the queue type; can be INBOUND or OUTBOUND.
        required: true
        schema:
          type: string
          enum:
          - INBOUND
          - OUTBOUND
        example: INBOUND
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkExportDTOContactServiceQueueBulkExportDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}:
    get:
      tags:
      - Contact Service Queue
      summary: List Skill CSQs by Skill Profile
      description: Retrieve skill-based Contact Service Queues by skill profile ID in a given organization.
      operationId: getSkillBasedCSQsBySkillProfileIdPublic
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeSkillBasedCSQDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}/internal:
    get:
      tags:
      - Contact Service Queue
      summary: List Internal Skill CSQs by Profile
      description: Retrieve skill-based Contact Service Queues by skill profile ID for internal use in a given organization.
      operationId: getSkillBasedCSQsBySkillProfileId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeSkillBasedCSQDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/by-team-id/{id}/internal:
    get:
      tags:
      - Contact Service Queue
      summary: List Team CSQs by Team ID
      description: Retrieve team-based Contact Service Queues by team ID for internal use in a given organization.
      operationId: getTeamBasedCSQByTeamId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeMappedCSQDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/by-user-ci-id/{ciUserId}/internal:
    get:
      tags:
      - Contact Service Queue
      summary: List Agent CSQs by CI User ID
      description: Retrieve agent-based Contact Service Queues by CI user ID for internal use in a given organization.
      operationId: getAgentBasedCSQsByCiUserId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: ciUserId
        in: path
        description: ciUserId
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeMappedCSQDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/delete-reference:
    post:
      tags:
      - Contact Service Queue
      summary: Delete CSQ References
      description: Delete references for Contact Service Queues in a given organization.
      operationId: deleteReferences
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
      requestBody:
        description: The field references to delete.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldRequestBody'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile:
    post:
      tags:
      - Contact Service Queue
      summary: List CSQs by Skills and Profile
      description: Retrieve skill-based Contact Service Queues by dynamic skills and skill profile in a given organization.
      operationId: getSkillBasedCSQsByDynamicSkillsAndSkillProfile
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: The skill profile and dynamic skills filter criteria.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkillBasedQueueRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeMappedCSQDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId:
    post:
      tags:
      - Contact Service Queue
      summary: List CSQs by User and Profile
      description: Retrieve skill-based Contact Service Queues by user ID and skill profile ID in a given organization.
      operationId: getSkillBasedCSQsBySkillProfileIdAndUserId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: The user ID and skill profile filter criteria.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkillBasedQueueRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeMappedCSQDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues:
    post:
      tags:
      - Contact Service Queue
      summary: List Manually Assignable CSQs
      description: Retrieve manually assignable Contact Service Queues in a given organization.
      operationId: getManuallyAssignableCSQs
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        description: The agent and team filter criteria for assignable queues.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManuallyAssignableQueuesRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeMappedCSQDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/purge-inactive-entities:
    post:
      tags:
      - Contact Service Queue
      summary: Purge inactive Contact Service Queue(s)
      description: Purge inactive Contact Service Queue(s) older than the configured interval for a given organization.
      operationId: purgeInactiveConfig_8
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: nextStartId
        in: query
        description: This is the entity ID from which items for the next purge batch with be selected.
        required: false
        schema:
          type: string
          default: ''
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/skill-based-queues/by-ci-user-id/{id}/internal:
    get:
      tags:
      - Contact Service Queue
      summary: List Skill CSQs by CI User ID
      description: Retrieve skill-based Contact Service Queues by CI user ID for internal use in a given organization.
      operationId: getSkillBasedCSQsByCiUserId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeSkillBasedCSQDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/{id}:
    get:
      tags:
      - Contact Service Queue
      summary: Get specific Contact Service Queue by ID
      description: Retrieve an existing Contact Service Queue by ID in a given organization.
      operationId: getConfig_18
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      - name: agentsUpdatedInfo
        in: query
        description: If `true`, returns the user details who has last updated the agents list in an agent based queue.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    put:
      tags:
      - Contact Service Queue
      summary: Update specific Contact Service Queue by ID
      description: Update an existing Contact Service Queue by ID in a given organization.
      operationId: updateConfig_18
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      requestBody:
        description: The updated Contact Service Queue object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactServiceQueueDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '412':
          description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    delete:
      tags:
      - Contact Service Queue
      summary: Delete specific Contact Service Queue by ID
      description: Delete an existing Contact Service Queue by ID in a given organization.
      operationId: deleteConfig_16
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '412':
          description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/{id}/incoming-references:
    get:
      tags:
      - Contact Service Queue
      summary: List CSQ References by ID
      description: Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.
      operationId: getIncomingReferences_14
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      - name: type
        in: query
        description: Entity type of the other entity that has a reference to this specific entity.
        required: false
        schema:
          type: string
        example: type_text
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EntityReferenceInfoDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/contact-service-queue/v2/bulk:
    post:
      tags:
      - Contact Service Queue
      summary: Bulk save Contact Service Queue(s)
      description: Create, Update or delete Contact Service Queue(s) in bulk in a given organization.
      operationId: saveAllConfigV2
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequestDTOContactServiceQueueDTO'
        required: true
      responses:
        '207':
          description: Multi-Status
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkResponseDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue:
    get:
      tags:
      - Contact Service Queue
      summary: List Contact Service Queue(s)
      description: "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
      operationId: getAllFilteredConfigWithPagedMetaData
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: filter
        in: query
        description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
        required: false
        schema:
          type: string
        example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
      - name: attributes
        in: query
        description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(name, description)


          The examples below show some search queries

          - "Cisco"

          - field=="name";value=="Cisco"

          - fields=in=("name","description");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      - name: desktopProfileFilter
        in: query
        description: If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.
        schema:
          type: boolean
          default: false
          example: true
      - name: provisioningView
        in: query
        description: If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.
        schema:
          type: boolean
          default: false
          example: false
      - name: singleObjectResponse
        in: query
        description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
        schema:
          type: boolean
          default: false
          example: false
      - name: includeAIMappingCount
        in: query
        description: If set to true, the API response will include the count of each AI features mapped to the entity.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/MetaDataPagedCSQ'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContactServiceQueueDTO'
              example:
                data:
                - recordingPermitted: true
                  ivrRequeueUrl: https://www.youtube.com
                  agentsLastUpdatedByUserEmailPrefix: string
                  personalizedAIRouting: string
                  timezone: America/New_York
                  socialChannelType: MESSENGER
                  controlFlowScriptUrl: https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield
                  description: Queue created by system
                  monitoringPermitted: true
                  vendorId: AB123CSDR
                  queueLevelRealTimeTranscriptionsInclusion: INCLUDED
                  channelType: TELEPHONY
                  queueRoutingType: TEAM_BASED
                  recordingAllCallsPermitted: true
                  organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                  recordingPauseDuration: 2
                  systemDefault: false
                  defaultMusicInQueueMediaFileId: defaultmusic_on_hold.wav
                  queueLevelPredictedWaitTimeInclusion: INCLUDED
                  queueLevelAutoCsatInclusion: INCLUDED
                  serviceLevelThreshold: 0
                  routingType: SKILLS_BASED
                  skillBasedRoutingType: BEST_AVAILABLE_AGENT
                  createdTime: string
                  lastUpdatedTime: string
                  id: 93912f11-6017-404b-bf14-5331890b1797
                  maxTimeInQueue: 2
                  xspVersion: xsp-24.0
                  maxActiveContacts: 5
                  pauseRecordingPermitted: true
                  checkAgentAvailability: true
                  outdialCampaignEnabled: true
                  assistantSkill: string
                  parkingPermitted: true
                  agentsLastUpdatedByUserName: string
                  active: true
                  version: 1
                  queueLevelSummariesInclusion: INCLUDED
                  overflowNumber: 1245677
                  agentsLastUpdatedTime: '2025-03-21T10:30:00Z'
                  queueLevelSentimentAnalysisInclusion: INCLUDED
                  name: Queue-1
                  queueType: INBOUND
                  subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478
                  manuallyAssignable: false
                meta:
                  additionalProp1: string
                  additionalProp3: string
                  additionalProp2: string
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    post:
      tags:
      - Contact Service Queue
      summary: Create a new Contact Service Queue
      description: Create a new Contact Service Queue in a given organization.
      operationId: createConfig_17
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactServiceQueueDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/agent-based-queues:
    get:
      tags:
      - Contact Service Queue
      summary: List agent based Contact Service Queue(s)by user ID
      description: Retrieve a list of agent based Contact Service Queue(s) by user iD in a given organization.
      operationId: getCSQByUserIDForAgentBasedQueue
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: userid
        in: path
        required: true
        schema:
          type: string
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email)


          The examples below show some search queries

          - "Cisco"

          - field=="firstName";value=="Cisco"

          - fields=in=("firstName","lastName");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/skill-based-queues:
    get:
      tags:
      - Contact Service Queue
      summary: List skill based Contact Service Queue(s)by user ID
      description: Retrieve a list of skill based Contact Service Queue(s) by user ID in a given organization.
      operationId: getSkillBasedQueuesByUserId
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: userid
        in: path
        required: true
        schema:
          type: string
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email)


          The examples below show some search queries

          - "Cisco"

          - field=="firstName";value=="Cisco"

          - fields=in=("firstName","lastName");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/team-based-queues:
    get:
      tags:
      - Contact Service Queue
      summary: List team based Contact Service Queue(s)by user ID
      description: Retrieve a list of team based Contact Service Queue(s) by user ID in a given organization.
      operationId: getCSQByUserIDForTeamBasedQueue
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: userid
        in: path
        required: true
        schema:
          type: string
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email)


          The examples below show some search queries

          - "Cisco"

          - field=="firstName";value=="Cisco"

          - fields=in=("firstName","lastName");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/fetch-by-grouped-assistant-skill:
    post:
      tags:
      - Contact Service Queue
      summary: List queue mapping summary grouped by Assistant Skill
      description: Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping.
      operationId: getAllCSQGroupedAssistantSkill
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CSQGroupedAssistantSkillRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeCSQGroupedAssistantSkillResponseDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/{id}:
    get:
      tags:
      - Contact Service Queue
      summary: Get specific Contact Service Queue by ID
      description: Retrieve an existing Contact Service Queue by ID in a given organization.
      operationId: getConfig_19
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      - name: agentsUpdatedInfo
        in: query
        description: If `true`, returns the user details who has last updated the agents list in an agent based queue.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
    put:
      tags:
      - Contact Service Queue
      summary: Update specific Contact Service Queue by ID
      description: Update an existing Contact Service Queue by ID in a given organization.
      operationId: updateConfig_19
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactServiceQueueDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContactServiceQueueDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '412':
          description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v2/contact-service-queue/{id}/reassign-agents:
    post:
      tags:
      - Contact Service Queue
      summary: Add or remove agents/users to/from an agent based queue
      description: This API can be used by a contact center supervisor to add or remove agents to/from an agent based queue that they have access to by virtue of their user profile access rights. Additionally, the request payload should contain the user id(s) managed by the supervisor.
      operationId: reassignAgents
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Contact Service Queue.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReassignAgentsRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
  /organization/{orgid}/v3/contact-service-queue:
    get:
      tags:
      - Contact Service Queue
      summary: List Contact Service Queue(s)
      description: "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
      operationId: getAllFilteredConfigWithMetaDataV3
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: filter
        in: query
        description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
        required: false
        schema:
          type: string
        example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
      - name: attributes
        in: query
        description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(name, description)


          The examples below show some search queries

          - "Cisco"

          - field=="name";value=="Cisco"

          - fields=in=("name","description");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
        example: 100
      - name: desktopProfileFilter
        in: query
        description: If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.
        schema:
          type: boolean
          default: false
          example: false
      - name: provisioningView
        in: query
        description: If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.
        schema:
          type: boolean
          default: false
          example: false
      - name: singleObjectResponse
        in: query
        description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseMetaEnvelopeContactServiceQueueDTOMetaDataPagedInfo'
              example:
              - recordingPermitted: true
                ivrRequeueUrl: https://www.youtube.com
                agentsLastUpdatedByUserEmailPrefix: string
                personalizedAIRouting: string
                timezone: America/New_York
                socialChannelType: MESSENGER
                controlFlowScriptUrl: https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield
                description: Queue created by system
                monitoringPermitted: true
                vendorId: AB123CSDR
                queueLevelRealTimeTranscriptionsInclusion: INCLUDED
                channelType: TELEPHONY
                queueRoutingType: TEAM_BASED
                recordingAllCallsPermitted: true
                organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                recordingPauseDuration: 2
                systemDefault: false
                defaultMusicInQueueMediaFileId: defaultmusic_on_hold.wav
                queueLevelPredictedWaitTimeInclusion: INCLUDED
                queueLevelAutoCsatInclusion: INCLUDED
                serviceLevelThreshold: 0
                routingType: SKILLS_BASED
                skillBasedRoutingType: BEST_AVAILABLE_AGENT
                createdTime: string
                lastUpdatedTime: string
                id: 93912f11-6017-404b-bf14-5331890b1797
                maxTimeInQueue: 2
                xspVersion: xsp-24.0
                maxActiveContacts: 5
                pauseRecordingPermitted: true
                checkAgentAvailability: true
                outdialCampaignEnabled: true
                assistantSkill: string
                parkingPermitted: true
                agentsLastUpdatedByUserName: string
                active: true
                version: 1
                queueLevelSummariesInclusion: INCLUDED
                overflowNumber: 1245677
                agentsLastUpdatedTime: '2025-03-21T10:30:00Z'
                queueLevelSentimentAnalysisInclusion: INCLUDED
                name: Queue-1
                queueType: INBOUND
                subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478
                manuallyAssignable: false
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: true
components:
  schemas:
    Response:
      type: object
      properties:
        code:
          type: integer
          format: int32
        details:
          type: object
          additionalProperties:
            type: object
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    ApiErrorResponse:
      description: Response body for an API error.
      type: object
      properties:
        trackingId:
          type: string
          description: "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services"
          example: c1a4fcef-aee2-4dea-8977-29f594760552
        error:
          description: An object containing details about the error.
          $ref: '#/components/schemas/ErrorDetails'
    Link:
      type: object
      properties:
        href:
          type: string
        hreflang:
          type: string
        title:
          type: string
        type:
          type: string
        deprecation:
          type: string
        profile:
          type: string
        name:
          type: string
        templated:
          type: boolean
    SkillBasedQueueRequestDTO:
      type: object
      description: Request DTO for querying skill-based Contact Service Queues.
      properties:
        skillProfileId:
          type: string
          description: The skill profile ID to filter queues by.
        dynamicSkills:
          type: array
          description: List of dynamic skills to filter queues by.
          items:
            $ref: '#/components/schemas/DynamicSkillDTO'
        userId:
          type: string
          description: The user ID to filter queues by.
    ResponseEnvelopeMappedCSQDTO:
      type: object
      description: Response envelope containing mapped Contact Service Queue data.
      properties:
        meta:
          type: object
          description: Metadata about the response.
          additionalProperties: {}
        data:
          type: array
          description: List of mapped Contact Service Queue items.
          items:
            $ref: '#/components/schemas/MappedCSQDTO'
    ContactServiceQueueDTO:
      type: object
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
          example: 93912f11-6017-404b-bf14-5331890b1797
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        name:
          type: string
          description: Name of the Contact Service Queue
          example: Queue-1
        description:
          type: string
          description: (Optional) A short description of the queue.
          example: Queue created by system
        queueType:
          type: string
          description: 'This can be the following


            INBOUND


            OUTBOUND'
          enum:
          - INBOUND
          - OUTBOUND
          example: INBOUND
        checkAgentAvailability:
          type: boolean
          description: This setting specifies whether the system can exclude teams with no logged in agents for the relevant routing strategies. It does not support Social Channel Type.
          example: true
        channelType:
          type: string
          description: "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, SOCIAL_CHANNEL, and CHAT. \n\nFor TELEPHONY channelType, the following fields are mandatory - recordingPermitted, ivrRequeueUrl, recordingAllCallsPermitted, monitoringPermitted, parkingPermitted, pauseRecordingPermitted, controlFlowScriptUrl, defaultMusicInQueueMediaFileId."
          enum:
          - TELEPHONY
          - EMAIL
          - FAX
          - CHAT
          - VIDEO
          - OTHERS
          - SOCIAL_CHANNEL
          - WORK_ITEM
          example: TELEPHONY
        socialChannelType:
          type: string
          description: 'This can be the following


            MESSAGEBIRD


            MESSENGER'
          enum:
          - MESSAGEBIRD
          - MESSENGER
          - WHATSAPP
          - APPLE_BUSINESS_CHAT
          - GOOGLE_BUSINESS_MESSAGES
          example: MESSENGER
        serviceLevelThreshold:
          type: integer
          format: int32
          description: The time in seconds that a customer request can be in a queue before the system flags it as outside the service level. It does not support Social Channel Type.
          example: 0
        maxActiveContacts:
          type: integer
          format: int32
          description: The maximum number of simultaneous contacts allowed for this queue. It does not support Social Channel Type.
          example: 5
        maxTimeInQueue:
          type: integer
          format: int32
          description: 'The time in seconds after which the system distributes the queued customer request to the overflow number that you provision for this queue. '
          example: 2
        defaultMusicInQueueMediaFileId:
          type: string
          description: "Identifies the default audio file which will be played for calls when they arrive or are waiting in queue. \nThis setting is available only for the Telephony channel type."
          example: defaultmusic_on_hold.wav
        timezone:
          type: string
          description: (Optional) Any routing strategy for this queue uses the time zone that you select here.
          example: America/New_York
        active:
          type: boolean
          description: Specify whether the queue is active or not active
          example: true
        outdialCampaignEnabled:
          type: boolean
          description: Should be specified only for outdial queues; if enabled, then Call Distribution and Queue Routing Type can be specified.
          example: true
        monitoringPermitted:
          type: boolean
          description: "Indicates whether or not monitoring is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        parkingPermitted:
          type: boolean
          description: "Indicates whether or not parking is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingPermitted:
          type: boolean
          description: "Indicates whether or not recording is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingAllCallsPermitted:
          type: boolean
          description: "Indicates whether or not recording all calls is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        pauseRecordingPermitted:
          type: boolean
          description: "Indicates whether or not pausing the recording is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingPauseDuration:
          type: integer
          format: int32
          description: "The duration in seconds of pause in recording. \nThis setting is available only for the Telephony channel type."
          example: 2
        controlFlowScriptUrl:
          type: string
          description: 'The URL for the queue or the default control script of the queue. If you do not use the routing strategy module to configure the control script, the system automatically populates the URL.

            This setting is available only for the Telephony channel type.'
          example: https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield
        ivrRequeueUrl:
          type: string
          description: This setting is available only for the Telephony channel type.
          example: https://www.youtube.com
        overflowNumber:
          type: string
          description: 'The destination phone number to which the system distributes the customer calls when they exceed the Maximum Time in Queue that you have set in the routing strategy.

            This setting is applicable only for the Telephony channel type and it is optional.'
          example: 1245677
        vendorId:
          type: string
          description: 'The unique alphanumeric string that maps this queue to the vendor.

            This setting is available only for the Telephony channel type and it is optional.'
          example: AB123CSDR
        routingType:
          type: string
          description: 'This can be one of the following


            LONGEST_AVAILABLE_AGENT


            SKILLS_BASED(skillBasedRoutingType is mandatory to define)'
          enum:
          - LONGEST_AVAILABLE_AGENT
          - SKILLS_BASED
          - CIRCULAR
          - LINEAR
          example: SKILLS_BASED
        skillBasedRoutingType:
          type: string
          description: 'This can be the following


            LONGEST_AVAILABLE_AGENT


            BEST_AVAILABLE_AGENT'
          enum:
          - LONGEST_AVAILABLE_AGENT
          - BEST_AVAILABLE_AGENT
          example: BEST_AVAILABLE_AGENT
        queueRoutingType:
          type: string
          description: 'This can be the following


            TEAM_BASED


            QUEUE_BASED'
          enum:
          - TEAM_BASED
          - SKILL_BASED
          - AGENT_BASED
          example: TEAM_BASED
        queueSkillRequirements:
          type: array
          items:
            $ref: '#/components/schemas/QueueSkillRequirementDTO'
          uniqueItems: true
        agents:
          type: array
          description: The list of agents for AgentBased queue
          example:
          - id: 16c93b13-f1e9-4a4f-bc47-957b9075a56f
            ciUserId: 660e0a5a-8230-47d7-ae98-047fb180e1ff
          items:
            $ref: '#/components/schemas/QueueAgentsDTO'
        callDistributionGroups:
          type: array
          items:
            $ref: '#/components/schemas/CallDistributionGroupDTO'
          uniqueItems: true
        xspVersion:
          type: string
          description: (Optional) Used to subscribe for recording events.
          example: xsp-24.0
          maxLength: 80
          minLength: 0
        subscriptionId:
          type: string
          description: (Optional) Used to subscribe for recording events.
          example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478
          maxLength: 80
          minLength: 0
        assistantSkill:
          $ref: '#/components/schemas/AssistantSkillMappingDTO'
        systemDefault:
          type: boolean
          description: Indicates whether the created resource is system created or not
          example: false
        manuallyAssignable:
          type: boolean
          description: If `true`, the queue can be manually assigned.
          example: false
        agentsLastUpdatedByUserName:
          type: string
          description: The name of the user who last modified the agents list.
        agentsLastUpdatedByUserEmailPrefix:
          type: string
          description: The email of the user who last modified the agents list.
        agentsLastUpdatedTime:
          type: integer
          format: int64
          description: The date when the agents list was last modified.
          example: '2025-03-21T10:30:00Z'
        queueLevelSummariesInclusion:
          type: string
          description: 'Queue level summaries inclusion type. Used only when Queue inclusion for summaries is set to ''Specific Queues'' at the org level AI Assistant->Summaries configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelSentimentAnalysisInclusion:
          type: string
          description: 'Queue level sentiment analysis inclusion type. Used only when Queue inclusion for sentiment analysis is set to ''Specific Queues'' at the org level AI Assistant->Quality Management configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelPredictedWaitTimeInclusion:
          type: string
          description: 'Queue level predicted wait time inclusion type. Used only when Queue inclusion for predicted wait time is set to ''Specific Queues'' at the org level AI Assistant->Predicted Wait Time configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelAutoCsatInclusion:
          type: string
          description: 'Queue level auto CSAT inclusion type. Used only when Queue inclusion for auto CSAT is set to ''Specific Queues'' at the org level AI Assistant->Auto CSAT configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelRealTimeTranscriptionsInclusion:
          type: string
          description: 'Queue level real time transcriptions inclusion type. Used only when Queue inclusion for real time transcriptions is set to ''Specific Queues'' at the org level AI Assistant->Real Time Transcriptions configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        personalizedAIRouting:
          $ref: '#/components/schemas/QueuePersonalizedAIRoutingDTO'
          description: Personalized AI Routing configuration for this queue. Controls AI-based intelligent routing to optimize agent selection based on ML predictions. When enabled, contacts are routed to agents predicted to have the best outcome based on configured KPIs. Requires 'personalized-ai-routing' permission and feature flag enablement. See QueuePersonalizedAIRoutingDTO for state transition requirements.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
      required:
      - active
      - callDistributionGroups
      - channelType
      - checkAgentAvailability
      - maxActiveContacts
      - maxTimeInQueue
      - name
      - queueRoutingType
      - queueType
      - routingType
      - serviceLevelThreshold
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
          description: Link to the current page.
          example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=1&pageSize=10
        first:
          type: string
          description: Link to the first page.
          example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10
        last:
          type: string
          description: Link to the last page.
          example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=4&pageSize=10
        next:
          type: string
          description: Link to the next page.
          example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=2&pageSize=10
        prev:
          type: string
          description: Link to the previous page.
          example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10
      required:
      - self
    QueueSkillRequirementDTO:
      type: object
      description: Skill requirement for the queue
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
          example: 93912f11-6017-404b-bf14-5331890b1797
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        skillId:
          type: string
          description: Skill ID reference
          example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
          minLength: 1
        skillName:
          type: string
          description: Indicates the name of the skill. Once created, name cannot be modified.
          example: German Speaking
        skillType:
          type: string
          description: 'This can be of the following types


            PROFICIENCY: id = 0


            BOOLEAN: id = 1


            TEXT: id = 2


            ENUM: id = 3


            Once created, skillType cannot be modified.

            '
          example: BOOLEAN
        condition:
          type: string
          description: Indicates a value that represents a skill the agent has.
          example: IS_NOT
        skillValue:
          type: string
          description: A short textual description that represents a skill the agent has.
          example: Credit card SME
          minLength: 1
        weight:
          type: integer
          format: int32
          description: Weight for proficiency skill requirement
          example: 100
          maximum: 1000
        dynamicSkill:
          type: boolean
          description: Indicates whether the skill is a dynamic skill or not. Default value is false.
          example: false
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
      required:
      - condition
      - skillId
      - skillValue
    EntityInfo:
      type: object
      properties:
        id:
          type: string
          description: id
          example: id.
        name:
          type: string
          description: name
          example: name.
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
            description: A map containing additional attributes of entity where both the key and value are Strings.
            example: '{"key1":"value1","key2":"value2"}'
          description: A map containing additional attributes of entity where both the key and value are Strings.
          example:
            key1: value1
            key2: value2
        createdDate:
          type: string
        lastModifiedDate:
          type: string
        version:
          type: integer
          format: int32
    CSQGroupedAssistantSkillResponseDTO:
      type: object
      description: Queue mapping summary per Assistant Skill
      properties:
        assistantSkillId:
          type: string
          description: ID of Assistant Skill in AI Studio
          example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
        associatedQueueCount:
          type: integer
          format: int64
          description: Number of queues mapped to this Assistant Skill ID
        lastAssistantSkillUpdatedTime:
          type: integer
          format: int64
          description: Last updated time Assistant Skill mapping i.e. timestamp corresponding to most recently added queue mapping
    CallDistributionGroupDTO:
      type: object
      properties:
        agentGroups:
          type: array
          items:
            $ref: '#/components/schemas/AgentGroupDTO'
          uniqueItems: true
        order:
          type: integer
          format: int32
          description: The order of this call distribution group.
          example: 1
        duration:
          type: integer
          format: int32
          default: 0
          description: (Optional)The duration in seconds after which a contact in queue will be distributed to this group.
          example: 2
    ManuallyAssignableQueuesRequest:
      type: object
      description: Request body for fetching manually assignable Contact Service Queues.
      properties:
        agentId:
          type: string
          description: The ID of the agent to check queue assignments for.
        teamId:
          type: string
          description: The ID of the team to check queue assignments for.
    MetaDataPagedInfo:
      type: object
      properties:
        orgid:
          type: string
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
        page:
          type: integer
          format: int32
          description: Current page number.
          example: 1
        pageSize:
          type: integer
          format: int32
          description: Page size for current data set.
          example: 20
        totalPages:
          type: integer
          format: int32
          description: Number of pages.
          example: 5
        totalRecords:
          type: integer
          format: int64
          description: Total number of items.
          example: 100
        links:
          type: object
          $ref: '#/components/schemas/PaginationLinks'
          additionalProperties:
            type: string
    ContactServiceQueueBulkExportDTO:
      type: object
      description: DTO for bulk export of Contact Service Queue data.
      properties:
        name:
          type: string
          description: Name of the Contact Service Queue.
        description:
          type: string
          description: A short description of the queue.
        type:
          type: string
          description: The queue type, such as INBOUND or OUTBOUND.
        channelType:
          type: string
          description: The channel type of the queue.
        routingType:
          type: string
          description: The routing type for this queue.
        monitoringPermitted:
          type: boolean
          description: Indicates whether monitoring is permitted.
        parkingPermitted:
          type: boolean
          description: Indicates whether parking is permitted.
        recordingPermitted:
          type: boolean
          description: Indicates whether recording is permitted.
        recordingAllCallsPermitted:
          type: boolean
          description: Indicates whether recording all calls is permitted.
        pauseRecordingPermitted:
          type: boolean
          description: Indicates whether pausing the recording is permitted.
        recordingPauseDuration:
          type: integer
          format: int32
          description: The duration in seconds of pause in recording.
        maxTimeInQueue:
          type: integer
          format: int32
          description: The time in seconds after which the queued request is distributed to the overflow number.
        defaultMusicInQueueMediaFile:
          type: string
          description: The default audio file played for calls when they arrive or are waiting in queue.
        serviceLevelThreshold:
          type: string
          description: The time in seconds before the system flags a request as outside the service level.
        timezone:
          type: string
          description: The time zone used by routing strategies for this queue.
        imiOrgType:
          type: string
          description: The IMI organization type associated with this queue.
        skillBasedRoutingType:
          type: string
          description: The skill-based routing type for this queue.
        outdialCampaignEnabled:
          type: boolean
          description: Indicates whether outdial campaign is enabled.
        queueRoutingType:
          type: string
          description: The queue routing type.
        callDistributionGroups:
          type: array
          description: The call distribution groups configured for this queue.
          items:
            $ref: '#/components/schemas/CallDistributionGroupBulkExportDTO'
          uniqueItems: true
        queueSkillRequirements:
          type: array
          description: The skill requirements configured for this queue.
          items:
            $ref: '#/components/schemas/QueueSkillRequirementDTO'
          uniqueItems: true
        agents:
          type: array
          description: The list of agent IDs assigned to this queue.
          items:
            type: string
        manuallyAssignable:
          type: boolean
          description: Indicates whether the queue can be manually assigned.
        queueLevelSummariesInclusion:
          type: string
          description: Queue level summaries inclusion type.
          enum:
          - NOT_APPLICABLE
          - EXCLUDED
          - INCLUDED
        queueLevelSentimentAnalysisInclusion:
          type: string
          description: Queue level sentiment analysis inclusion type.
          enum:
          - NOT_APPLICABLE
          - EXCLUDED
          - INCLUDED
        queueLevelPredictedWaitTimeInclusion:
          type: string
          description: Queue level predicted wait time inclusion type.
          enum:
          - NOT_APPLICABLE
          - EXCLUDED
          - INCLUDED
        queueLevelAutoCsatInclusion:
          type: string
          description: Queue level auto CSAT inclusion type.
          enum:
          - NOT_APPLICABLE
          - EXCLUDED
          - INCLUDED
        queueLevelRealTimeTranscriptionsInclusion:
          type: string
          description: Queue level real time transcriptions inclusion type.
          enum:
          - NOT_APPLICABLE
          - EXCLUDED
          - INCLUDED
        assistantSkill:
          $ref: '#/components/schemas/AssistantSkillMappingDTO'
          description: The assistant skill mapping for this queue.
    SkillBasedCSQDTO:
      type: object
      description: Skill-based Contact Service Queue data transfer object.
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource.
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        channelType:
          type: string
          description: The channel type of the queue.
        name:
          type: string
          description: Name of the Contact Service Queue.
        skillScore:
          type: integer
          format: int32
          description: The skill score for matching this queue.
        qsrType:
          type: string
          description: The queue skill requirement type.
        dynamicSkillScore:
          type: integer
          format: int32
          description: The dynamic skill score for matching this queue.
        skillProfileSkillsMatch:
          type: boolean
          description: Indicates whether the skill profile skills match.
        dynamicSkillsMatch:
          type: boolean
          description: Indicates whether the dynamic skills match.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
    BulkResponseItemDTO:
      type: object
      properties:
        itemIdentifier:
          type: integer
          description: Unique item identifier for a bulk operation.
          format: int32
          example: 10
        status:
          type: integer
          description: Indicates the error status code.
          format: int32
          example: 400
        operationType:
          type: string
          description: The kind of operation desired of an entity.
          example: CREATE
          enum:
          - CREATE
          - UPDATE
          - DELETE
          - GET
        href:
          type: string
          description: The resource URI of an entity.
          example: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
        apiError:
          $ref: '#/components/schemas/ApiErrorResponse'
      example:
        apiError:
          error:
            key: '400'
            message:
            - description: 'siteId: not found for given orgId.'
              entity: string
              references:
              - id: string
                name: string
            reason: dependency exists
          trackingId: ccconfig_c1a4fcef-aee2-4dea-8977-29f594760552
        href: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
        itemIdentifier: 10
        operationType: CREATE
        status: 400
    BulkExportDTOContactServiceQueueBulkExportDTO:
      type: object
      description: Bulk export Dto
      example:
        totalResources: 100
        pageNumber: 0
        pageSize: 50
        rel: last
        resources: []
      properties:
        totalResources:
          type: integer
          format: int32
          description: Total number of items.
          example: 100
        pageNumber:
          type: integer
          format: int32
          description: Current page number.
          example: 0
        pageSize:
          type: integer
          format: int32
          description: Page size for current data set.
          example: 50
        rel:
          type: string
          description: Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.
          example: last
        resources:
          type: array
          description: Indicate the page resources
          items:
            $ref: '#/components/schemas/ContactServiceQueueBulkExportDTO'
    QueuePersonalizedAIRoutingDTO:
      type: object
      description: Queue-level Personalized AI Routing configuration. Enables intelligent agent routing based on AI/ML predictions.
      properties:
        aiRoutingMode:
          type: string
          default: NONE
          description: 'AI Routing mode. Valid transitions: NONE → EVALUATION; EVALUATION → ACTIVE or NONE; ACTIVE → NONE. NONE: AI routing disabled (default). EVALUATION: Shadow mode - AI predictions are generated but not used for routing (for testing/validation). ACTIVE: AI routing enabled - contacts are routed based on AI predictions.'
          enum:
          - NONE
          - EVALUATION
          - ACTIVE
          example: EVALUATION
        aiRoutingKPIId:
          type: string
          description: AI Routing KPI ID - the performance metric used by AI to optimize routing decisions. This should reference a valid KPI configured in the AI routing system. Required when aiRoutingMode is EVALUATION or ACTIVE.
          example: 63beec53-8a61-489f-afc6-bb03c8c73834
        evaluationModeStartTime:
          type: integer
          format: int64
          description: Timestamp (epoch milliseconds) when EVALUATION mode was activated. Automatically set by the system when transitioning from NONE to EVALUATION. Used to track evaluation duration and readiness for ACTIVE mode transition.
          example: 1730269619000
          readOnly: true
    QueueAgentsDTO:
      type: object
      properties:
        id:
          type: string
          description: Id of an agent in WxCC
          example: b0503c7f-d13c-4d74-9eb5-64f3c818b8c7
        ciUserId:
          type: string
          description: Id of an agent in Common Identity
          example: c71876ae-ddfa-4049-9a1b-298535152578
      required:
      - id
    OperationError:
      description: An error message providing details about the operation failure.
      type: object
      properties:
        description:
          type: string
          description: A human readable explanation for the occurrence of an error.
          example: Incorrect Credentials.
    FieldRequestBody:
      type: object
      description: Request body containing field references for delete operations.
      properties:
        references:
          type: object
          description: A map of reference field names to their values.
          additionalProperties:
            type: string
    ResponseEnvelopeRoutingBasedQueueDTO:
      type: object
      description: Response envelope containing routing-based Contact Service Queue data.
      properties:
        meta:
          type: object
          description: Metadata about the response.
          additionalProperties: {}
        data:
          type: array
          description: List of routing-based Contact Service Queue items.
          items:
            $ref: '#/components/schemas/RoutingBasedQueueDTO'
    CallDistributionGroupBulkExportDTO:
      type: object
      description: Call distribution group data for bulk export.
      properties:
        agentGroups:
          type: array
          description: The agent groups in this call distribution group.
          items:
            $ref: '#/components/schemas/AgentGroupsBulkExportDTO'
          uniqueItems: true
        order:
          type: integer
          format: int32
          description: The order of this call distribution group.
        duration:
          type: integer
          format: int32
          description: The duration in seconds after which a contact in queue will be distributed to this group.
    CSQGroupedAssistantSkillRequestDTO:
      type: object
      description: Request payload for fetching queue mapping summary grouped by Assistant Skill
      properties:
        assistantSkillIds:
          type: array
          description: List of AssistantSkill ids to fetch. If property is unspecified or set to null, then all assistantSkillIds mapped will be returned.
          example:
          - f53c8b54-46ca-43f6-ba05-08426a46e23d
          - a53c8b54-46ca-43f6-ba05-08426a46e23f
          items:
            type: string
          uniqueItems: true
    BulkRequestDTOContactServiceQueueDTO:
      type: object
      description: Bulk request DTO containing a list of Contact Service Queue items for bulk operations.
      properties:
        items:
          type: array
          description: List of items in the bulk request.
          items:
            $ref: '#/components/schemas/BulkRequestItemDTOContactServiceQueueDTO'
    ErrorDetails:
      description: Details of an error.
      type: object
      properties:
        key:
          type: string
          description: An application defined error code.
          example: '401'
        message:
          type: array
          description: A message providing details about the error.
          items:
            $ref: '#/components/schemas/OperationError'
    ResponseEnvelopeSkillBasedCSQDTO:
      type: object
      description: Response envelope containing skill-based Contact Service Queue data.
      properties:
        meta:
          type: object
          description: Metadata about the response.
          additionalProperties: {}
        data:
          type: array
          description: List of skill-based Contact Service Queue items.
          items:
            $ref: '#/components/schemas/SkillBasedCSQDTO'
    AssistantSkillMappingDTO:
      type: object
      properties:
        assistantSkillId:
          type: string
          description: Id of an Assistant Skill mapped to the Contact Service Queue
          example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
        assistantSkillUpdatedTime:
          type: integer
          format: int64
          description: Time(in epoch milliseconds) when assistant skill mapping was last updated.
          example: 1617536244000
          readOnly: true
    BulkResponseDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BulkResponseItemDTO'
    ReassignAgentsRequestDTO:
      type: object
      properties:
        add:
          type: array
          items:
            type: string
          uniqueItems: true
        remove:
          type: array
          items:
            type: string
          uniqueItems: true
    BulkRequestItemDTOContactServiceQueueDTO:
      type: object
      description: List of items in the bulk request.
      properties:
        itemIdentifier:
          type: integer
          format: int32
          description: Unique item identifier for a bulk operation.
          example: 10
        item:
          $ref: '#/components/schemas/ContactServiceQueueDTO'
          description: The Contact Service Queue data for this bulk request item.
        requestAction:
          type: string
          description: Identifier for action type. Possible values are `SAVE` and `DELETE`.
          example: SAVE
    RoutingBasedQueueDTO:
      type: object
      description: Routing-based Contact Service Queue data transfer object.
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource.
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        name:
          type: string
          description: Name of the Contact Service Queue.
        routingPattern:
          type: string
          description: The routing pattern for this queue.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
    AgentGroupDTO:
      type: object
      properties:
        teamId:
          type: string
          description: ID of a team
          example: 93912f11-6017-404b-bf14-5331890b1797
    ResponseMetaEnvelopeContactServiceQueueDTOMetaDataPagedInfo:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaDataPagedInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ContactServiceQueueDTO'
    EntityReferenceInfoDTO:
      type: object
      properties:
        description:
          type: string
          description: Description about reference info.
          example: list of referenced entities
        meta:
          $ref: '#/components/schemas/MetaDataReferencesPagingInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityInfo'
    ContactServiceQueueDTOList:
      type: object
      description: Contact Service Queue list data transfer object with condensed fields for list operations.
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
          example: 93912f11-6017-404b-bf14-5331890b1797
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        name:
          type: string
          description: Name of the Contact Service Queue
          example: Queue-1
        description:
          type: string
          description: (Optional) A short description of the queue.
          example: Queue created by system
        queueType:
          type: string
          description: 'This can be the following


            INBOUND


            OUTBOUND'
          enum:
          - INBOUND
          - OUTBOUND
          example: INBOUND
        checkAgentAvailability:
          type: boolean
          description: This setting specifies whether the system can exclude teams with no logged in agents for the relevant routing strategies. It does not support Social Channel Type.
          example: true
        channelType:
          type: string
          description: "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, SOCIAL_CHANNEL, and CHAT. \n\nFor TELEPHONY channelType, the following fields are mandatory - recordingPermitted, ivrRequeueUrl, recordingAllCallsPermitted, monitoringPermitted, parkingPermitted, pauseRecordingPermitted, controlFlowScriptUrl, defaultMusicInQueueMediaFileId."
          enum:
          - TELEPHONY
          - EMAIL
          - FAX
          - CHAT
          - VIDEO
          - OTHERS
          - SOCIAL_CHANNEL
          - WORK_ITEM
          example: TELEPHONY
        socialChannelType:
          type: string
          description: 'This can be the following


            MESSAGEBIRD


            MESSENGER'
          enum:
          - MESSAGEBIRD
          - MESSENGER
          - WHATSAPP
          - APPLE_BUSINESS_CHAT
          - GOOGLE_BUSINESS_MESSAGES
          example: MESSENGER
        serviceLevelThreshold:
          type: integer
          format: int32
          description: The time in seconds that a customer request can be in a queue before the system flags it as outside the service level. It does not support Social Channel Type.
          example: 0
        maxActiveContacts:
          type: integer
          format: int32
          description: The maximum number of simultaneous contacts allowed for this queue. It does not support Social Channel Type.
          example: 5
        maxTimeInQueue:
          type: integer
          format: int32
          description: 'The time in seconds after which the system distributes the queued customer request to the overflow number that you provision for this queue. '
          example: 2
        defaultMusicInQueueMediaFileId:
          type: string
          description: "Identifies the default audio file which will be played for calls when they arrive or are waiting in queue. \nThis setting is available only for the Telephony channel type."
          example: defaultmusic_on_hold.wav
        timezone:
          type: string
          description: (Optional) Any routing strategy for this queue uses the time zone that you select here.
          example: America/New_York
        active:
          type: boolean
          description: Specify whether the queue is active or not active
          example: true
        outdialCampaignEnabled:
          type: boolean
          description: Should be specified only for outdial queues; if enabled, then Call Distribution and Queue Routing Type can be specified.
          example: true
        monitoringPermitted:
          type: boolean
          description: "Indicates whether or not monitoring is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        parkingPermitted:
          type: boolean
          description: "Indicates whether or not parking is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingPermitted:
          type: boolean
          description: "Indicates whether or not recording is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingAllCallsPermitted:
          type: boolean
          description: "Indicates whether or not recording all calls is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        pauseRecordingPermitted:
          type: boolean
          description: "Indicates whether or not pausing the recording is permitted. \nThis setting is available only for the Telephony channel type."
          example: true
        recordingPauseDuration:
          type: integer
          format: int32
          description: "The duration in seconds of pause in recording. \nThis setting is available only for the Telephony channel type."
          example: 2
        controlFlowScriptUrl:
          type: string
          description: 'The URL for the queue or the default control script of the queue. If you do not use the routing strategy module to configure the control script, the system automatically populates the URL.

            This setting is available only for the Telephony channel type.'
          example: https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield
        ivrRequeueUrl:
          type: string
          description: This setting is available only for the Telephony channel type.
          example: https://www.youtube.com
        overflowNumber:
          type: string
          description: 'The destination phone number to which the system distributes the customer calls when they exceed the Maximum Time in Queue that you have set in the routing strategy.

            This setting is applicable only for the Telephony channel type and it is optional.'
          example: '1245677'
        vendorId:
          type: string
          description: 'The unique alphanumeric string that maps this queue to the vendor.

            This setting is available only for the Telephony channel type and it is optional.'
          example: AB123CSDR
        routingType:
          type: string
          description: 'This can be one of the following


            LONGEST_AVAILABLE_AGENT


            SKILLS_BASED(skillBasedRoutingType is mandatory to define)'
          enum:
          - LONGEST_AVAILABLE_AGENT
          - SKILLS_BASED
          - CIRCULAR
          - LINEAR
          example: SKILLS_BASED
        skillBasedRoutingType:
          type: string
          description: 'This can be the following


            LONGEST_AVAILABLE_AGENT


            BEST_AVAILABLE_AGENT'
          enum:
          - LONGEST_AVAILABLE_AGENT
          - BEST_AVAILABLE_AGENT
          example: BEST_AVAILABLE_AGENT
        queueRoutingType:
          type: string
          description: 'This can be the following


            TEAM_BASED


            QUEUE_BASED'
          enum:
          - TEAM_BASED
          - SKILL_BASED
          - AGENT_BASED
          example: TEAM_BASED
        xspVersion:
          type: string
          description: (Optional) Used to subscribe for recording events.
          example: xsp-24.0
          maxLength: 80
          minLength: 0
        subscriptionId:
          type: string
          description: (Optional) Used to subscribe for recording events.
          example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478
          maxLength: 80
          minLength: 0
        assistantSkill:
          $ref: '#/components/schemas/AssistantSkillMappingDTO'
          description: The assistant skill mapping for this queue.
        systemDefault:
          type: boolean
          description: Indicates whether the created resource is system created or not
          example: false
        manuallyAssignable:
          type: boolean
          description: If `true`, the queue can be manually assigned.
          example: false
        agentsLastUpdatedByUserName:
          type: string
          description: The name of the user who last modified the agents list.
        agentsLastUpdatedByUserEmailPrefix:
          type: string
          description: The email of the user who last modified the agents list.
        agentsLastUpdatedTime:
          type: integer
          format: int64
          description: The date when the agents list was last modified.
          example: 1742556600000
        queueLevelSummariesInclusion:
          type: string
          description: 'Queue level summaries inclusion type. Used only when Queue inclusion for summaries is set to ''Specific Queues'' at the org level AI Assistant->Summaries configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelSentimentAnalysisInclusion:
          type: string
          description: 'Queue level sentiment analysis inclusion type. Used only when Queue inclusion for sentiment analysis is set to ''Specific Queues'' at the org level AI Assistant->Quality Management configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelPredictedWaitTimeInclusion:
          type: string
          description: 'Queue level predicted wait time inclusion type. Used only when Queue inclusion for predicted wait time is set to ''Specific Queues'' at the org level AI Assistant->Predicted Wait Time configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelAutoCsatInclusion:
          type: string
          description: 'Queue level auto CSAT inclusion type. Used only when Queue inclusion for auto CSAT is set to ''Specific Queues'' at the org level AI Assistant->Auto CSAT configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        queueLevelRealTimeTranscriptionsInclusion:
          type: string
          description: 'Queue level real time transcriptions inclusion type. Used only when Queue inclusion for real time transcriptions is set to ''Specific Queues'' at the org level AI Assistant->Real Time Transcriptions configuration.

            During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED''

            During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.'
          example: INCLUDED
        personalizedAIRouting:
          $ref: '#/components/schemas/QueuePersonalizedAIRoutingDTO'
          description: Personalized AI Routing configuration for this queue. Controls AI-based intelligent routing to optimize agent selection based on ML predictions. When enabled, contacts are routed to agents predicted to have the best outcome based on configured KPIs. Requires 'personalized-ai-routing' permission and feature flag enablement. See QueuePersonalizedAIRoutingDTO for state transition requirements.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
    AgentGroupsBulkExportDTO:
      type: object
      description: Agent group data for bulk export.
      properties:
        teamName:
          type: string
          description: The name of the team in this agent group.
        siteName:
          type: string
          description: The name of the site associated with this agent group.
    MappedCSQDTO:
      type: object
      description: Mapped Contact Service Queue data transfer object.
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource.
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        channelType:
          type: string
          description: The channel type of the queue.
        name:
          type: string
          description: Name of the Contact Service Queue.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
    DynamicSkillDTO:
      type: object
      description: Dynamic skill data transfer object for skill-based queue filtering.
      properties:
        skillId:
          type: string
          description: The ID of the skill.
        textValue:
          type: string
          description: The text value for a text-type skill.
        booleanValue:
          type: boolean
          description: The boolean value for a boolean-type skill.
        proficiencyValue:
          type: integer
          format: int32
          description: The proficiency value for a proficiency-type skill.
        enumSkillValues:
          type: array
          description: The set of enum values for an enum-type skill.
          items:
            type: string
          uniqueItems: true
    MetaDataReferencesPagingInfo:
      title: MetaDataReferencesPagingInfo
      type: object
      properties:
        orgid:
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
          type: string
          description: Org ID
          format: uuid
          example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
        page:
          type: integer
          description: Current page number
          format: int32
          example: 1
        pageSize:
          type: integer
          description: Page size for current data set
          format: int32
          example: 100
        totalPages:
          type: integer
          description: Number of pages
          format: int32
          example: 1
        totalRecords:
          type: integer
          description: Total number of items
          format: int32
          example: 1000
        links:
          type: object
          description: Map of pagination links with self, next, prev, last and first
          example:
            next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=2&pageSize=10
            last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10
            prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
            self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10
            first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
        referencedEntities:
          type: array
          description: List of referenced entities
          example:
          - agent-profile
          - entrypoint
          items:
            type: string
        currentEntity:
          type: string
          description: Name of current entity
          example: entity_name
      description: Metadata of response for references with paging information
    ResponseEnvelopeCSQGroupedAssistantSkillResponseDTO:
      type: object
      properties:
        meta:
          type: object
          additionalProperties: {}
        data:
          type: array
          items:
            $ref: '#/components/schemas/CSQGroupedAssistantSkillResponseDTO'
    MetaDataPagedCSQ:
      type: object
      properties:
        orgid:
          type: string
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
        page:
          type: integer
          format: int32
          description: Current page number.
          example: 1
        pageSize:
          type: integer
          format: int32
          description: Page size for current data set.
          example: 20
        totalPages:
          type: integer
          format: int32
          description: Number of pages.
          example: 5
        totalRecords:
          type: integer
          format: int64
          description: Total number of items.
          example: 100
        links:
          type: object
          description: Map of pagination links.
          $ref: '#/components/schemas/PaginationLinks'
          additionalProperties:
            type: string
        actualSummariesInclusionCount:
          type: integer
          format: int64
          description: Indicates the actual number of queues included for AI assistant-generated summaries in a given organization, including queues that are access-restricted for the user requesting the data.
          example: 100
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps