openapi: 3.0.0
info:
  title: Webex Admin Address Book Desktop Profile 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: Desktop Profile
paths:
  /organization/{orgid}/agent-profile:
    get:
      tags:
      - Desktop Profile
      summary: List Desktop Profile(s)
      description: "Retrieve a list of Desktop Profile(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: getAllConfig_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: 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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) '
        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
          example: 0
          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
          example: 100
          default: 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
          example: false
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentProfileResponseDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    post:
      tags:
      - Desktop Profile
      summary: Create a new Desktop Profile
      description: Create a new Desktop Profile in a given organization.
      operationId: createConfig_28
      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/AgentProfileDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgentProfileResponseDTO'
        '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'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/agent-profile/bulk:
    post:
      tags:
      - Desktop Profile
      summary: Bulk save Desktop Profile(s)
      description: Create, Update or delete Desktop Profile(s) in bulk in a given organization.
      operationId: saveAllConfig_24
      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/BulkRequestDTOAgentProfileDTO'
        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'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/agent-profile/bulk-export:
    get:
      tags:
      - Desktop Profile
      summary: Bulk export Desktop Profile(s)
      description: Export all Desktop Profile(s) in a given organization.
      operationId: bulkExport_21
      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: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          example: 0
          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
          example: 100
          default: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkExportDTOAgentProfileBulkExportDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/agent-profile/purge-inactive-entities:
    post:
      tags:
      - Desktop Profile
      summary: Purge inactive Desktop Profile(s)
      description: Purge inactive Desktop Profile(s) older than the configured interval for a given organization.
      operationId: purgeInactiveConfig_11
      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'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/agent-profile/{id}:
    get:
      tags:
      - Desktop Profile
      summary: Get specific Desktop Profile by ID
      description: Retrieve an existing Desktop Profile by ID in a given organization.
      operationId: getConfig_28
      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 Desktop Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgentProfileResponseDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    put:
      tags:
      - Desktop Profile
      summary: Update specific Desktop Profile by ID
      description: Update an existing Desktop Profile by ID in a given organization.
      operationId: updateConfig_28
      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 Desktop Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentProfileDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgentProfileResponseDTO'
        '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'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    delete:
      tags:
      - Desktop Profile
      summary: Delete specific Desktop Profile by ID
      description: Delete an existing Desktop Profile by ID in a given organization.
      operationId: deleteConfig_25
      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 Desktop Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/agent-profile/{id}/incoming-references:
    get:
      tags:
      - Desktop Profile
      summary: List references for a specific Desktop Profile
      description: Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.
      operationId: getIncomingReferences_20
      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
          example: 0
          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
          example: 100
          default: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EntityReferenceInfoDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
  /organization/{orgid}/v2/agent-profile:
    get:
      tags:
      - Desktop Profile
      summary: List Desktop Profile(s)
      description: "Retrieve a list of Desktop Profile(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: getAllConfigWithMetaData_26
      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, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, 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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) '
        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
          example: 0
          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
          example: 100
          default: 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
          example: false
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/MetaDataWithPagingInfo'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentProfileResponseDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
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'
    viewableStatistics:
      required:
      - accessQueueStats
      - accessTeamStats
      type: object
      properties:
        organizationId:
          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: ID of the contact center organization. It is required to define for the following operations - All bulk save operations
          format: uuid
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        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
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          format: int32
          example: 1
        agentStats:
          type: boolean
          description: Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.
          example: true
        accessQueueStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all queues.


            SPECIFIC — Select Queues drop-down list to enable the agent to display statistics for specific queues.


            NONE — To prevent the agent from displaying queue statistics.


            '
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        contactServiceQueues:
          uniqueItems: true
          type: array
          description: This setting should be specified when Access Queue Statistics is SPECIFIC.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: This setting should be specified when Access Queue Statistics is SPECIFIC.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        loggedInTeamStats:
          type: boolean
          description: Indicates whether the agent can view statistics for the team or not.
          example: true
        accessTeamStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all teams.


            SPECIFIC — Select Teams drop-down list to enable the agent to display statistics for specific teams.


            NONE — To prevent the agent from displaying teams statistics.


            '
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        teams:
          uniqueItems: true
          type: array
          description: 'This setting should be specified when Access Team Statistics is SPECIFIC. '
          example:
          - apim_team_516789
          - apim_team_6123456
          items:
            type: string
            description: 'This setting should be specified when Access Team Statistics is SPECIFIC. '
            example: '["apim_team_516789","apim_team_6123456"]'
        createdTime:
          type: integer
          description: Creation time(in epoch millis) of this resource.
          format: int64
          readOnly: true
          example: 1617536244000
        lastUpdatedTime:
          type: integer
          description: Time(in epoch millis) when this resource was last updated.
          format: int64
          readOnly: true
          example: 1617536244000
    BulkRequestDTOAgentProfileDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BulkRequestItemDTOAgentProfileDTO'
    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
    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
    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
    AgentProfileBulkExportDTO:
      required:
      - accessBuddyTeam
      - accessEntryPoint
      - accessIdleCode
      - accessQueue
      - accessQueueStats
      - accessTeamStats
      - accessWrapUpCode
      - agentDNValidation
      - name
      - parentType
      type: object
      properties:
        name:
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9\._\s\-\(\)]+$
          type: string
          description: Enter a name for the agent profile.
          example: Agent-Profile(Auto WrapUp)
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: (Optional) Enter a description of the profile.
          example: This profile allows agent to auto wrap-up time and extend the wrap-up time.
        parentType:
          type: string
          description: 'This can be the following


            ORGANIZATION: The agent profile is available to all sites at your enterprise.


            SITE: The agent profile is available to a specific site.'
          example: SITE
        siteId:
          type: string
          description: 'Identifier for a site which is a physical contact center location under the control of your enterprise. '
          example: 8e6bb6da-2a78-4768-bef9-7e229f92af22
        screenPopup:
          type: boolean
          description: Indicates whether to allow external pop-up screens(true) or not(false).
          example: true
        lastAgentRouting:
          type: boolean
          description: This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).
          example: true
        autoWrapUp:
          type: boolean
          description: Indicates whether to allow auto wrap-up(true) or not(false).
          example: true
        autoAnswer:
          type: boolean
          description: Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).
          example: true
        autoWrapAfterSeconds:
          type: integer
          description: This setting allows auto wrap-up after seconds
          format: int32
          example: 15
        agentAvailableAfterOutdial:
          type: boolean
          description: 'Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.

            '
          example: true
        allowAutoWrapUpExtension:
          type: boolean
          description: Indicates whether to allow auto wrap-up extension(true) or not(false).
          example: true
        accessWrapUpCode:
          type: string
          description: 'Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:


            ALL — To make all wrap-up codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
          enum:
          - ALL
          - SPECIFIC
        wrapUpCodes:
          uniqueItems: true
          type: array
          description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
          example:
          - WrapUp_Sale
          - WrapUp_Field
          items:
            type: string
            description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
            example: '["WrapUp_Sale","WrapUp_Field"]'
        accessIdleCode:
          type: string
          description: 'Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:


            ALL — To make all idle codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
        idleCodes:
          uniqueItems: true
          type: array
          description: Specify the Idle codes list that the agents can select in Agent Desktop.
          example:
          - aux_code_sale
          - aux_code2
          items:
            type: string
            description: Specify the Idle codes list that the agents can select in Agent Desktop.
            example: '["aux_code_sale","aux_code2"]'
        accessQueue:
          type: string
          description: 'Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all queues available.


            SPECIFIC — To make specific queues available


            NONE — If you do not want to make any queues available as transfer targets.


            '
          example: ALL
        queues:
          uniqueItems: true
          type: array
          description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        accessEntryPoint:
          type: string
          description: 'Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all entry points available.


            SPECIFIC — To make specific entry points available


            NONE — If you do not want to make any entry points available as transfer targets.


            '
          example: ALL
        entryPoints:
          uniqueItems: true
          type: array
          description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
          example:
          - apim_entry_516789
          - apim_entry_6123456
          items:
            type: string
            description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
            example: '["apim_entry_516789","apim_entry_6123456"]'
        accessBuddyTeam:
          type: string
          description: 'Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:


            ALL —  To make the agents on all teams available.


            SPECIFIC — To make agents on specific teams available, then select teams from the drop-down list


            NONE — If you do not want to make any teams available for consultation, conference, or call transfer.


            '
          example: ALL
        buddyTeamsList:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/SiteTeamPairDTO'
        consultToQueue:
          type: boolean
          description: Indicates whether you  want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.
          example: true
        outdialEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make outdial calls(true) or not(false).
          example: true
        outdialEntryPoint:
          type: string
          description: If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        addressBook:
          type: string
          description: Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        dialPlanEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).
          example: true
        dialPlans:
          uniqueItems: true
          type: array
          description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
          example:
          - US
          - Any Format
          items:
            type: string
            description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
            example: '["US","Any Format"]'
        outdialANI:
          type: string
          description: This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        agentDNValidation:
          type: string
          description: "Specify Unrestricted to allow agents to use any DN to log in to the Agent Desktop. \nTo restrict the DN that the agent can enter, select one of the following. \nProvisioned Value restricts the login DN to the default value that you provision for the agent. \nValidation Criteria restricts the login DN to the format specified in the Validation Criteria setting.\n"
          example: SPECIFIC
        agentDNValidationCriteria:
          type: string
          description: This setting occurs only if you select Validation Criteria in the Validation For Agent DN.
          example: SPECIFIC
        agentDNValidationCriterions:
          uniqueItems: true
          type: array
          description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
          example:
          - DN_5_Sept
          - DN_7_Jan
          items:
            type: string
            description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
            example: '["DN_5_Sept","DN_7_Jan"]'
        agentStats:
          type: boolean
          description: Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.
          example: true
        accessQueueStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all queues.


            SPECIFIC — Select Queues drop-down list to enable the agent to display statistics for specific queues.


            NONE — To prevent the agent from displaying queue statistics.


            '
          example: SPECIFIC
        viewableStatsQueue:
          uniqueItems: true
          type: array
          description: This setting should be specified when Access Queue Statistics is SPECIFIC.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: This setting should be specified when Access Queue Statistics is SPECIFIC.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        loggedInTeamStats:
          type: boolean
          description: Indicates whether the agent can view statistics for the team or not.
          example: true
        accessTeamStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all teams.


            SPECIFIC — Select Teams drop-down list to enable the agent to display statistics for specific teams.


            NONE — To prevent the agent from displaying teams statistics.


            '
          example: SPECIFIC
        viewableStatsTeam:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/SiteTeamPairDTO'
        thresholdRules:
          uniqueItems: true
          type: array
          description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

            If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
          example:
          - Threshold_monitor_agent
          - Threshold_call_data
          items:
            type: string
            description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

              If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
            example: '["Threshold_monitor_agent","Threshold_call_data"]'
        loginVoiceOptions:
          uniqueItems: true
          type: array
          description: List of Login Voice Options
          example:
          - AGENT_DN
          - EXTENSION
          items:
            type: string
            description: Login voice options.
            example: AGENT_DN
            enum:
            - AGENT_DN
            - EXTENSION
            - BROWSER
        showUserDetailsMS:
          type: boolean
          description: Specify whether the show user details of microsoft account user enabled or not
          example: true
        stateSynchronizationMS:
          type: boolean
          description: Specify whether the state synchronization of microsoft account user enabled or not
          example: true
        showUserDetailsWebex:
          type: boolean
          description: Specify whether the show user details of webex account user enabled or not
          example: true
        stateSynchronizationWebex:
          type: boolean
          description: Specify whether the state synchronization of webex account user enabled or not
          example: true
    AgentProfileDTO:
      required:
      - accessBuddyTeam
      - accessEntryPoint
      - accessIdleCode
      - accessQueue
      - accessWrapUpCode
      - active
      - agentDNValidation
      - name
      - parentType
      - viewableStatistics
      type: object
      properties:
        organizationId:
          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: ID of the contact center organization. It is required to define for the following operations - All bulk save operations
          format: uuid
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        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
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          format: int32
          example: 1
        name:
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9\._\s\-\(\)]+$
          type: string
          description: Enter a name for the agent profile.
          example: Agent-Profile(Auto WrapUp)
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: (Optional) Enter a description of the profile.
          example: This profile allows agent to auto wrap-up time and extend the wrap-up time.
        parentType:
          type: string
          description: 'This can be the following


            ORGANIZATION: The agent profile is available to all sites at your enterprise.


            SITE: The agent profile is available to a specific site.'
          example: SITE
          enum:
          - ORGANIZATION
          - SITE
        siteId:
          type: string
          description: 'Identifier for a site which is a physical contact center location under the control of your enterprise. '
          example: 8e6bb6da-2a78-4768-bef9-7e229f92af22
        screenPopup:
          type: boolean
          description: Indicates whether to allow external pop-up screens(true) or not(false).
          example: true
        lastAgentRouting:
          type: boolean
          description: This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).
          example: true
        autoWrapUp:
          type: boolean
          description: Indicates whether to allow auto wrap-up(true) or not(false).
          example: true
        autoAnswer:
          type: boolean
          description: Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).
          example: true
        autoWrapAfterSeconds:
          type: integer
          description: This setting allows auto wrap-up after seconds
          format: int32
          example: 15
        agentAvailableAfterOutdial:
          type: boolean
          description: 'Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.

            '
          example: true
        allowAutoWrapUpExtension:
          type: boolean
          description: Indicates whether to allow auto wrap-up extension(true) or not(false).
          example: true
        accessWrapUpCode:
          type: string
          description: 'Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:


            ALL — To make all wrap-up codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        wrapUpCodes:
          uniqueItems: true
          type: array
          description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
          example:
          - WrapUp_Sale
          - WrapUp_Field
          items:
            type: string
            description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
            example: '["WrapUp_Sale","WrapUp_Field"]'
        accessIdleCode:
          type: string
          description: 'Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:


            ALL — To make all idle codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        idleCodes:
          uniqueItems: true
          type: array
          description: Specify the Idle codes list that the agents can select in Agent Desktop.
          example:
          - aux_code_sale
          - aux_code2
          items:
            type: string
            description: Specify the Idle codes list that the agents can select in Agent Desktop.
            example: '["aux_code_sale","aux_code2"]'
        accessQueue:
          type: string
          description: 'Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all queues available.


            SPECIFIC — To make specific queues available


            NONE — If you do not want to make any queues available as transfer targets.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        queues:
          uniqueItems: true
          type: array
          description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        accessEntryPoint:
          type: string
          description: 'Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all entry points available.


            SPECIFIC — To make specific entry points available


            NONE — If you do not want to make any entry points available as transfer targets.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        entryPoints:
          uniqueItems: true
          type: array
          description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
          example:
          - apim_entry_516789
          - apim_entry_6123456
          items:
            type: string
            description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
            example: '["apim_entry_516789","apim_entry_6123456"]'
        accessBuddyTeam:
          type: string
          description: 'Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:


            ALL —  To make the agents on all teams available.


            SPECIFIC — To make agents on specific teams available, then select teams from the drop-down list


            NONE — If you do not want to make any teams available for consultation, conference, or call transfer.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        buddyTeams:
          uniqueItems: true
          type: array
          description: Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.
          example:
          - 5_Jan_Testing
          - 7_Feb_Testing
          items:
            type: string
            description: Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.
            example: '["5_Jan_Testing","7_Feb_Testing"]'
        consultToQueue:
          type: boolean
          description: Indicates whether you  want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.
          example: true
        outdialEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make outdial calls(true) or not(false).
          example: true
        outdialEntryPointId:
          type: string
          description: If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        outdialANIId:
          type: string
          description: This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        addressBookId:
          type: string
          description: Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        dialPlanEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).
          example: true
        dialPlans:
          uniqueItems: true
          type: array
          description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
          example:
          - US
          - Any Format
          items:
            type: string
            description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
            example: '["US","Any Format"]'
        agentDNValidation:
          type: string
          description: "Specify Unrestricted to allow agents to use any DN to log in to the Agent Desktop. \nTo restrict the DN that the agent can enter, select one of the following. \nProvisioned Value restricts the login DN to the default value that you provision for the agent. \nValidation Criteria restricts the login DN to the format specified in the Validation Criteria setting.\n"
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        agentDNValidationCriteria:
          type: string
          description: This setting occurs only if you select Validation Criteria in the Validation For Agent DN.
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        agentDNValidationCriterions:
          uniqueItems: true
          type: array
          description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
          example:
          - DN_5_Sept
          - DN_7_Jan
          items:
            type: string
            description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
            example: '["DN_5_Sept","DN_7_Jan"]'
        loginVoiceOptions:
          uniqueItems: true
          type: array
          description: Login voice options.
          example:
          - AGENT_DN
          - EXTENSION
          - BROWSER
          items:
            type: string
            description: Login voice options.
            example: AGENT_DN
            enum:
            - AGENT_DN
            - EXTENSION
            - BROWSER
        viewableStatistics:
          $ref: '#/components/schemas/ViewableStatisticsDTO'
        thresholdRules:
          uniqueItems: true
          type: array
          description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

            If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
          example:
          - Threshold_monitor_agent
          - Threshold_call_data
          items:
            type: string
            description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

              If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
            example: '["Threshold_monitor_agent","Threshold_call_data"]'
        active:
          type: boolean
          description: Specify whether the agent profile is active or not Active.
          example: true
        timeoutDesktopInactivityCustomEnabled:
          type: boolean
          description: This setting enabled time out desktop inactivity feature.
          example: true
        showUserDetailsMS:
          type: boolean
          description: Specify whether the show user details of microsoft account user enabled or not
          example: true
        stateSynchronizationMS:
          type: boolean
          description: Specify whether the state synchronization of microsoft account user enabled or not
          example: true
        showUserDetailsWebex:
          type: boolean
          description: Specify whether the show user details of webex account user enabled or not
          example: true
        stateSynchronizationWebex:
          type: boolean
          description: Specify whether the state synchronization of webex account user enabled or not
          example: true
        timeoutDesktopInactivityMins:
          maximum: 10000
          minimum: 3
          type: integer
          description: This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).
          format: int32
          example: 5
        systemDefault:
          type: boolean
          description: Indicates whether the created resource is system created or not
          example: false
        createdTime:
          type: integer
          description: Creation time(in epoch millis) of this resource.
          format: int64
          readOnly: true
          example: 1617536244000
        lastUpdatedTime:
          type: integer
          description: Time(in epoch millis) when this resource was last updated.
          format: int64
          readOnly: true
          example: 1617536244000
    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.
    ViewableStatisticsDTO:
      required:
      - accessQueueStats
      - accessTeamStats
      type: object
      properties:
        organizationId:
          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: ID of the contact center organization. It is required to define for the following operations - All bulk save operations
          format: uuid
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        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
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          format: int32
          example: 1
        agentStats:
          type: boolean
          description: Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.
          example: true
        accessQueueStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all queues.


            SPECIFIC — Select Queues drop-down list to enable the agent to display statistics for specific queues.


            NONE — To prevent the agent from displaying queue statistics.


            '
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        contactServiceQueues:
          uniqueItems: true
          type: array
          description: This setting should be specified when Access Queue Statistics is SPECIFIC.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: This setting should be specified when Access Queue Statistics is SPECIFIC.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        loggedInTeamStats:
          type: boolean
          description: Indicates whether the agent can view statistics for the team or not.
          example: true
        accessTeamStats:
          type: string
          description: 'This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:


            ALL —  To enable the agent to display statistics for all teams.


            SPECIFIC — Select Teams drop-down list to enable the agent to display statistics for specific teams.


            NONE — To prevent the agent from displaying teams statistics.


            '
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        teams:
          uniqueItems: true
          type: array
          description: 'This setting should be specified when Access Team Statistics is SPECIFIC. '
          example:
          - apim_team_516789
          - apim_team_6123456
          items:
            type: string
            description: 'This setting should be specified when Access Team Statistics is SPECIFIC. '
            example: '["apim_team_516789","apim_team_6123456"]'
        createdTime:
          type: integer
          description: Creation time(in epoch millis) of this resource.
          format: int64
          readOnly: true
          example: 1617536244000
        lastUpdatedTime:
          type: integer
          description: Time(in epoch millis) when this resource was last updated.
          format: int64
          readOnly: true
          example: 1617536244000
      description: " Specifies the Statistics that agent of this profile can view.\n "
    SiteTeamPairDTO:
      type: object
      properties:
        siteName:
          type: string
          description: Indicates the name of the site. Generally, it is the name of the geographical location. It is required only during a create or an update operation.
          example: California
        teamName:
          type: string
          description: Enter the name for the team. Generally, use names that indicate the function of the team, such as Billing or Customer Support. This field should be specified for create and update operation. Two teams in the same site in an organization cannot share the same name.
          example: inline-pcs-team
    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'
    BulkExportDTOAgentProfileBulkExportDTO:
      type: object
      properties:
        totalResources:
          type: integer
          description: Total number of items
          format: int32
          example: 100
        pageNumber:
          type: integer
          description: Current page number
          format: int32
          example: 0
        pageSize:
          type: integer
          description: Page size for current data set
          format: int32
          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
          items:
            $ref: '#/components/schemas/AgentProfileBulkExportDTO'
    BulkResponseDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BulkResponseItemDTO'
    MetaDataWithPagingInfo:
      type: object
      description: Metadata of response with paging information
      properties:
        orgid:
          type: string
          format: uuid
          description: Organization ID.
          example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
          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}$
        page:
          type: integer
          format: int32
          description: Current page number.
          example: 1
        pageSize:
          type: integer
          format: int32
          description: Page size for current data set.
          example: 100
        totalPages:
          type: integer
          format: int32
          description: Number of pages.
          example: 1
        totalRecords:
          type: integer
          format: int32
          description: Total number of items.
          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/entity-name?page=2&pageSize=10
            last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=3&pageSize=10
            prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10
            self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=1&pageSize=10
            first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10
      title: MetaDataWithPagingInfo
    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'
    AgentProfileResponseDTO:
      required:
      - accessBuddyTeam
      - accessEntryPoint
      - accessIdleCode
      - accessQueue
      - accessWrapUpCode
      - active
      - agentDNValidation
      - name
      - parentType
      type: object
      properties:
        organizationId:
          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: ID of the contact center organization. It is required to define for the following operations - All bulk save operations
          format: uuid
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        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
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          format: int32
          example: 1
        name:
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9\._\s\-\(\)]+$
          type: string
          description: Enter a name for the agent profile.
          example: Agent-Profile(Auto WrapUp)
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: (Optional) Enter a description of the profile.
          example: This profile allows agent to auto wrap-up time and extend the wrap-up time.
        parentType:
          type: string
          description: 'This can be the following


            ORGANIZATION: The agent profile is available to all sites at your enterprise.


            SITE: The agent profile is available to a specific site.'
          example: SITE
          enum:
          - ORGANIZATION
          - SITE
        siteId:
          type: string
          description: 'Identifier for a site which is a physical contact center location under the control of your enterprise. '
          example: 8e6bb6da-2a78-4768-bef9-7e229f92af22
        screenPopup:
          type: boolean
          description: Indicates whether to allow external pop-up screens(true) or not(false).
          example: true
        lastAgentRouting:
          type: boolean
          description: This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).
          example: true
        autoWrapUp:
          type: boolean
          description: Indicates whether to allow auto wrap-up(true) or not(false).
          example: true
        autoAnswer:
          type: boolean
          description: Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).
          example: true
        autoWrapAfterSeconds:
          type: integer
          description: This setting allows auto wrap-up after seconds
          format: int32
          example: 15
        agentAvailableAfterOutdial:
          type: boolean
          description: 'Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.

            '
          example: true
        allowAutoWrapUpExtension:
          type: boolean
          description: Indicates whether to allow auto wrap-up extension(true) or not(false).
          example: true
        accessWrapUpCode:
          type: string
          description: 'Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:


            ALL — To make all wrap-up codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        wrapUpCodes:
          uniqueItems: true
          type: array
          description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
          example:
          - WrapUp_Sale
          - WrapUp_Field
          items:
            type: string
            description: Specify the wrap-up codes list that the agents can select when they wrap up a contact.
            example: '["WrapUp_Sale","WrapUp_Field"]'
        accessIdleCode:
          type: string
          description: 'Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:


            ALL — To make all idle codes available.


            SPECIFIC — To make specific codes available.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        idleCodes:
          uniqueItems: true
          type: array
          description: Specify the Idle codes list that the agents can select in Agent Desktop.
          example:
          - aux_code_sale
          - aux_code2
          items:
            type: string
            description: Specify the Idle codes list that the agents can select in Agent Desktop.
            example: '["aux_code_sale","aux_code2"]'
        accessQueue:
          type: string
          description: 'Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all queues available.


            SPECIFIC — To make specific queues available


            NONE — If you do not want to make any queues available as transfer targets.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        queues:
          uniqueItems: true
          type: array
          description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
          example:
          - apim_queue_516789
          - apim_queue_6123456
          items:
            type: string
            description: Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.
            example: '["apim_queue_516789","apim_queue_6123456"]'
        accessEntryPoint:
          type: string
          description: 'Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:


            ALL — To make all entry points available.


            SPECIFIC — To make specific entry points available


            NONE — If you do not want to make any entry points available as transfer targets.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        entryPoints:
          uniqueItems: true
          type: array
          description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
          example:
          - apim_entry_516789
          - apim_entry_6123456
          items:
            type: string
            description: Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.
            example: '["apim_entry_516789","apim_entry_6123456"]'
        accessBuddyTeam:
          type: string
          description: 'Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:


            ALL —  To make the agents on all teams available.


            SPECIFIC — To make agents on specific teams available, then select teams from the drop-down list


            NONE — If you do not want to make any teams available for consultation, conference, or call transfer.


            '
          example: ALL
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        buddyTeams:
          uniqueItems: true
          type: array
          description: Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.
          example:
          - 5_Jan_Testing
          - 7_Feb_Testing
          items:
            type: string
            description: Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.
            example: '["5_Jan_Testing","7_Feb_Testing"]'
        consultToQueue:
          type: boolean
          description: Indicates whether you  want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.
          example: true
        outdialEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make outdial calls(true) or not(false).
          example: true
        outdialEntryPointId:
          type: string
          description: If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        outdialANIId:
          type: string
          description: This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        addressBookId:
          type: string
          description: Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
        dialPlanEnabled:
          type: boolean
          description: Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).
          example: true
        dialPlans:
          uniqueItems: true
          type: array
          description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
          example:
          - US
          - Any Format
          items:
            type: string
            description: 'This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. '
            example: '["US","Any Format"]'
        timeoutDesktopInactivityCustomEnabled:
          type: boolean
          description: This setting enabled time out desktop inactivity feature.
          example: true
        showUserDetailsMS:
          type: boolean
          description: Specify whether the show user details of microsoft account user enabled or not
          example: true
        stateSynchronizationMS:
          type: boolean
          description: Specify whether the state synchronization of microsoft account user enabled or not
          example: true
        showUserDetailsWebex:
          type: boolean
          description: Specify whether the show user details of webex account user enabled or not
          example: true
        stateSynchronizationWebex:
          type: boolean
          description: Specify whether the state synchronization of webex account user enabled or not
          example: true
        timeoutDesktopInactivityMins:
          maximum: 10000
          minimum: 3
          type: integer
          description: This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).
          format: int32
          example: 5
        agentDNValidation:
          type: string
          description: "Specify Unrestricted to allow agents to use any DN to log in to the Agent Desktop. \nTo restrict the DN that the agent can enter, select one of the following. \nProvisioned Value restricts the login DN to the default value that you provision for the agent. \nValidation Criteria restricts the login DN to the format specified in the Validation Criteria setting.\n"
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        agentDNValidationCriteria:
          type: string
          description: This setting occurs only if you select Validation Criteria in the Validation For Agent DN.
          example: SPECIFIC
          enum:
          - SPECIFIC
          - ALL
          - PROVISIONED_VALUE
          - NONE
        agentDNValidationCriterions:
          uniqueItems: true
          type: array
          description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
          example:
          - DN_5_Sept
          - DN_7_Jan
          items:
            type: string
            description: This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.
            example: '["DN_5_Sept","DN_7_Jan"]'
        loginVoiceOptions:
          uniqueItems: true
          type: array
          description: List of Login Voice Options
          example:
          - AGENT_DN
          - EXTENSION
          items:
            type: string
            description: Login voice options.
            example: AGENT_DN
            enum:
            - AGENT_DN
            - EXTENSION
            - BROWSER
        viewableStatistics:
          $ref: '#/components/schemas/viewableStatistics'
        thresholdRules:
          uniqueItems: true
          type: array
          description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

            If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
          example:
          - Threshold_monitor_agent
          - Threshold_call_data
          items:
            type: string
            description: 'The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.

              If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.'
            example: '["Threshold_monitor_agent","Threshold_call_data"]'
        active:
          type: boolean
          description: Specify whether the agent profile is active or not Active.
          example: true
        systemDefault:
          type: boolean
          description: Indicates whether the created resource is system created or not
          example: false
        createdTime:
          type: integer
          description: Creation time(in epoch millis) of this resource.
          format: int64
          readOnly: true
          example: 1617536244000
        lastUpdatedTime:
          type: integer
          description: Time(in epoch millis) when this resource was last updated.
          format: int64
          readOnly: true
          example: 1617536244000
    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
    BulkRequestItemDTOAgentProfileDTO:
      type: object
      properties:
        itemIdentifier:
          type: integer
          description: Unique item identifier for a bulk operation.
          format: int32
          example: 10
        item:
          $ref: '#/components/schemas/AgentProfileDTO'
        requestAction:
          type: string
          description: Identifier for action type. Possible values can be SAVE and DELETE.
          example: SAVE
  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