NICE API

openapi: 3.1.0
info:
  title: NICE API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 27 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; NICE has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 23
    pages-with-code: 4
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.niceincontact.com/API/MediaPlaybackAPI
  - https://developer.niceincontact.com/API/VoiceBiometricHubAPI
  - https://developer.niceincontact.com/Documentation/GettingStarted
  - https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted
  - https://developer.niceincontact.com/WhatsNew
  - https://developer.niceincontact.com/Documentation/UsingEvents
  - https://developer.niceincontact.com/Documentation/BYOCMiddleware
  - https://developer.niceincontact.com/Documentation/AgentSessionEvents
servers:
- url: https://api-do72.dev.nice-incontact.com
paths:
  /.well-known/openid-configuration:
    get:
      operationId: get_well_known_openid_configuration
      tags:
      - API
      summary: GET /.well-known/openid-configuration
      x-source: https://developer.niceincontact.com/Documentation/GettingStarted
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWellKnownOpenidConfigurationResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --location ''https://cxone.niceincontact.com/.well-known/openid-configuration'' '
  /InContactAPI/services/v24.0/agents/{agentid}:
    get:
      operationId: get_InContactAPI_services_v24_0_agents_agentid
      tags:
      - Incontactapi
      summary: GET /InContactAPI/services/v24.0/agents/{agentId}
      x-source: https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted
      parameters:
      - name: agentid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -V -Uri https://api-do72.dev.nice-incontact.com/InContactAPI/services/v24.0/agents/24211 -Headers $headers -Method Get\
          \ \n Response of Get API \nHTTP/1.1 200 Success \nDate: Tue, 04 Oct 2022 05:54:42 GMT \nContent-Type: application/json; charset=utf-8\
          \ \nContent-Length: 2832 \nConnection: keep-alive \nSet-Cookie: AWSALB=QPdTfDlGPznsXMYThl3dUJoFXs51RkncnbJHcq1caUGMfV8YEgXi51Nnj71CB1jJGCblp9GXU1a/SmtP3H"
  /InContactAPI/services/v7.0/tags:
    get:
      operationId: get_InContactAPI_services_v7_0_tags
      tags:
      - Incontactapi
      summary: GET /InContactAPI/services/v7.0/tags
      x-source: https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v -Uri https://api-do72.dev.nice-incontact.com/InContactAPI/services/v7.0/tags -Headers $headers -Body $postParams -Method\
          \ Post \n Response for Post API \nHTTP/1.1 200 Success \nDate: Tue, 04 Oct 2022 05:47:57 GMT \nContent-Type: application/json; charset=utf-8\
          \ \nContent-Length: 12 \nConnection: keep-alive \nSet-Cookie: AWSALB=MygFfOFRmipEDszBapvTh/ic+nb7Ajk7a8rDCLusshxa+ArYAVWB+6VK1DMBEQZ/HHljZLP7"
  /channels:
    post:
      operationId: post_channels
      tags:
      - Channels
      summary: Create a digital channel for your BYOC integration.
      x-source: https://developer.niceincontact.com/Documentation/BYOCMiddleware
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostChannelsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /contacts:
    post:
      operationId: post_contacts
      tags:
      - Contacts
      summary: Submit a bulk download request via POST /contacts.
      x-source: https://developer.niceincontact.com/API/MediaPlaybackAPI
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostContactsResponse'
      x-evidence:
        kind: documentation
  /incontactapi/services/v30.0/agents/$AGENT_ID/custom-event:
    put:
      operationId: put_incontactapi_services_v30_0_agents_AGENT_ID_custom_event
      tags:
      - Incontactapi
      summary: PUT /incontactapi/services/v30.0/agents/$AGENT_ID/custom-event
      x-source: https://developer.niceincontact.com/Documentation/UsingEvents
      parameters:
      - name: data
        in: query
        required: false
        schema:
          type: string
      - name: eventName
        in: query
        required: false
        schema:
          type: string
      - name: persistInMemory
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PUT \"https://api-$AREA.$DOMAIN/incontactapi/services/v30.0/agents/$AGENT_ID/custom-event?eventName=From_Postman&persistInMemory=false&data=Sent_from_Postman\"\
          \ \n Request Type : PUT \n Fields : \n Parameter \n Type \n Details \n agentId \n String \n The agent ID value that identifies the target\
          \ agent. \n eventName \n String \n The name of the event. This must be used by any consumers of the event. \n pe"
  /perform-action:
    post:
      operationId: post_perform_action
      tags:
      - Perform Action
      summary: External API for Voice Biometric Hub that provides endpoints for managing voice biometric operations
      description: Initiate an action using POST /perform-action
      x-source: https://developer.niceincontact.com/API/VoiceBiometricHubAPI
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /result:
    get:
      operationId: get_result
      tags:
      - Result
      summary: External API for Voice Biometric Hub that provides endpoints for managing voice biometric operations
      description: Poll for results using GET /result (supports long‑polling up to 120 seconds)
      x-source: https://developer.niceincontact.com/API/VoiceBiometricHubAPI
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /segments:
    post:
      operationId: post_segments
      tags:
      - Segments
      summary: Submit a bulk download request via POST /segments.
      x-source: https://developer.niceincontact.com/API/MediaPlaybackAPI
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSegmentsResponse'
      x-evidence:
        kind: documentation
  /status/{requestid}:
    get:
      operationId: get_status_requestid
      tags:
      - Status
      summary: Poll GET /status/{requestId} to track progress and retrieve the download location.
      x-source: https://developer.niceincontact.com/API/MediaPlaybackAPI
      parameters:
      - name: requestid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusRequestidResponse'
      x-evidence:
        kind: documentation
  /user-management/v1/teams:
    post:
      operationId: post_user_management_v1_teams
      tags:
      - User Management
      summary: 'API : POST /user-management/v1/teams'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_user_management_v1_teams
      tags:
      - User Management
      summary: 'API : PUT /user-management/v1/teams'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v1/teams/search:
    post:
      operationId: post_user_management_v1_teams_search
      tags:
      - User Management
      summary: 'API : POST /user-management/v1/teams/search'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v1/teams/{teamid}:
    get:
      operationId: get_user_management_v1_teams_teamid
      tags:
      - User Management
      summary: 'API : GET /user-management/v1/teams/{teamId}'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: teamid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v1/users:
    get:
      operationId: get_user_management_v1_users
      tags:
      - User Management
      summary: 'API : GET /user-management/v1/users'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v1/users/invite:
    post:
      operationId: post_user_management_v1_users_invite
      tags:
      - User Management
      summary: 'API : POST /user-management/v1/users/invite'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v1/users/{userid}:
    get:
      operationId: get_user_management_v1_users_userid
      tags:
      - User Management
      summary: 'API : GET /user-management/v1/users/{userId}'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v2/teams:
    post:
      operationId: post_user_management_v2_teams
      tags:
      - User Management
      summary: 'API : POST /user-management/v2/teams'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_user_management_v2_teams
      tags:
      - User Management
      summary: 'API : PUT /user-management/v2/teams'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v2/teams/{teamid}:
    get:
      operationId: get_user_management_v2_teams_teamid
      tags:
      - User Management
      summary: 'API : GET /user-management/v1/teams/{teamId}, GET /user-management/v2/teams/{teamId}'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: teamid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v2/{v2id}/search:
    post:
      operationId: post_user_management_v2_v2id_search
      tags:
      - User Management
      summary: 'API : POST /user-management/v2/teams/search'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at v2Id
  /user-management/v3/teams:
    put:
      operationId: put_user_management_v3_teams
      tags:
      - User Management
      summary: 'Replacement : PUT /user-management/v3/teams'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v3/teams/search:
    post:
      operationId: post_user_management_v3_teams_search
      tags:
      - User Management
      summary: 'API : POST /user-management/v3/teams/search'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v3/teams/{teamid}:
    get:
      operationId: get_user_management_v3_teams_teamid
      tags:
      - User Management
      summary: 'Replacement : GET /user-management/v3/teams/{teamId}'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: teamid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v3/users/{userid}:
    get:
      operationId: get_user_management_v3_users_userid
      tags:
      - User Management
      summary: 'Replacement : GET /user-management/v3/users/{userId}'
      x-source: https://developer.niceincontact.com/WhatsNew
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-management/v4/teams/search:
    post:
      operationId: post_user_management_v4_teams_search
      tags:
      - User Management
      summary: 'Replacement : POST /user-management/v4/teams/search'
      x-source: https://developer.niceincontact.com/WhatsNew
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /voice-print-status:
    get:
      operationId: get_voice_print_status
      tags:
      - Voice Print Status
      summary: External API for Voice Biometric Hub that provides endpoints for managing voice biometric operations
      description: Check enrollment status using GET /voice-print-status
      x-source: https://developer.niceincontact.com/API/VoiceBiometricHubAPI
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetWellKnownOpenidConfigurationResponse:
      type: object
      properties:
        issuer:
          type: string
        authorization_endpoint:
          type: string
        token_endpoint:
          type: string
        userinfo_endpoint:
          type: string
        jwks_uri:
          type: string
        token_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
        token_endpoint_auth_signing_alg_values_supported:
          type: array
          items:
            type: string
        end_session_endpoint:
          type: string
        scopes_supported:
          type: array
          items:
            type: string
        response_types_supported:
          type: array
          items:
            type: string
        subject_types_supported:
          type: array
          items:
            type: string
        id_token_signing_alg_values_supported:
          type: array
          items:
            type: string
        request_object_signing_alg_values_supported:
          type: array
          items:
            type: string
        display_values_supported:
          type: array
          items:
            type: string
        claim_types_supported:
          type: array
          items:
            type: string
        code_challenge_methods_supported:
          type: array
          items:
            type: string
    PostChannelsRequest:
      type: object
      properties:
        externalPlatformIcon:
          type: string
          description: Icon value for the channel, must be one of the allowed enum values.
      required:
      - externalPlatformIcon
    PostContactsResponse:
      type: object
      properties:
        requestId:
          type: string
          description: Identifier returned in the 202 response to track the asynchronous download request.
    PostSegmentsResponse:
      type: object
      properties:
        requestId:
          type: string
          description: Identifier returned in the 202 response to track the asynchronous download request.
    GetStatusRequestidResponse:
      type: object
      properties:
        status:
          type: string
          description: Current status of the bulk download request (e.g., Success, InProgress, Failed).
        downloadUrl:
          type: string
          description: URL to the generated downloadable media file when status is Success.
tags:
- name: API
- name: Channels
- name: Contacts
- name: Incontactapi
- name: Perform Action
- name: Result
- name: Segments
- name: Status
- name: User Management
- name: Voice Print Status