NiCE Masking API

: Recording Masking management

GitHub OpenAPI

Operations 2

POST /interaction-recording-management-service/v1/interactions/mask Mask voice and screen recording for privacy compliance #
POST /interaction-recording-management-service/v1/interactions/unmask Unmask voice and screen recording for privacy compliance #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nice:nice-masking-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nice-masking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nice Masking API
  version: v1
  description: 'Operations tagged Masking across 2 of this provider''s published API definitions: nice-recording-interactions.json, nice-recording-interactions-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Masking
  description: ': Recording Masking management'
paths:
  /interaction-recording-management-service/v1/interactions/mask:
    post:
      tags:
      - Masking
      summary: Mask voice and screen recording for privacy compliance
      description: 'Stop voice and screen recording of a call in which the agent associated with the specified user ID is participating. A call to the API stops recording of voice and screen for every participant on the call.


        The Mask and Unmask APIs enable masking voice and screen recordings when an agent is collecting sensitive information and then unmasking the recording. The ability to mask and unmask recordings helps organizations to maintain compliance with privacy, PCI, and GDPR regulations. These APIs allow automatic (by an application) or manual (by an agent) masking and unmasking of recordings. You submit a mask or unmask request for a specific user.


        The API call can be requested whether the call is being recorded or not. Agents can be trained to always "mask" a call when gathering sensitive data or for other reasons, even if it appears to them that the call is not being recorded. This is because any given call may be recorded through an admin initiated request or one of the agent’s applications without the agent''s knowledge.


        Permissions - To mask or unmask a recording, you need the ‘Search & Playback >APIs > Multi-ACD Masking API’ permission enabled.


        Note - This API is only available for CXone Multi-ACD utilizing CXone Recording, for more information on CXone Multi-ACD, see the online help CXone Multi-ACD. If you are using CXone ACD you should refer to the Agent API.'
      operationId: post-interaction-mask
      parameters:
      - name: userId
        in: query
        description: 'ID of a user in CXone User Hub (type: UUID). User ID can be obtained using Admin API (<a href="https://developer.niceincontact.com/API/AdminAPI#/Agents/get-agents">Admin APIs</a> )'
        required: true
        schema:
          type: string
          format: UUID
      responses:
        '200':
          description: Successful operation. Call is being masked.
        '202':
          description: Operation is in process. Mask request accepted and the request is being processed.
        '401':
          description: The requesting user has failed to authenticate.
        '403':
          description: The requesting user is not authorized to perform the operation.
        '404':
          description: Not found, no active interactions for agent. No open call was found for the agent with the provided user ID.
        '422':
          description: Operation is not supported for internal calls
        '425':
          description: Interaction is locked while processing previous mask/unmask request. The mask request cannot be handled since the service is busy with previous request.
        '500':
          description: Internal server error.
        '504':
          description: The request was timed out.
  /interaction-recording-management-service/v1/interactions/unmask:
    post:
      tags:
      - Masking
      summary: Unmask voice and screen recording for privacy compliance
      description: 'Resume voice and screen recording of a call in which the agent associated with the specified user ID is participating. Note, no action occurs if the call was not recorded when masking was requested, or a stop recording event was received during masking operation.


        The Mask and Unmask APIs enable masking voice and screen recordings when an agent is collecting sensitive information and then unmasking the recording. The ability to mask and unmask recordings helps organizations to maintain compliance with privacy, PCI, and GDPR regulations. These APIs allow automatic (by an application) or manual (by an agent) masking and unmasking of recordings. You submit a mask or unmask request for a specific user.


        The API call can be requested whether the call is being recorded or not. Agents can be trained to always "mask" a call when gathering sensitive data or for other reasons, even if it appears to them that the call is not being recorded. This is because any given call may be recorded through an admin initiated request or one of the agent’s applications without the agent''s knowledge.


        Permissions - To mask or unmask a recording, you need the ‘Search & Playback >APIs > Multi-ACD Masking API’ permission enabled.


        Note - This API is only available for CXone Multi-ACD utilizing CXone Recording, for more information on CXone Multi-ACD, see the online help CXone Multi-ACD. If you are using CXone ACD you should refer to the Agent API.'
      operationId: post-interaction-unmask
      parameters:
      - name: userId
        in: query
        description: 'ID of a user in CXone User Hub (type: UUID). User ID can be obtained using Admin API (<a href="https://developer.niceincontact.com/API/AdminAPI#/Agents/get-agents">Admin APIs</a>)'
        required: true
        schema:
          type: string
          format: UUID
      responses:
        '200':
          description: Successful operation. Call is being masked.
        '202':
          description: Operation is in process. Unmask request accepted and the request is being processed.
        '401':
          description: The requesting user has failed to authenticate.
        '403':
          description: The requesting user is not authorized to perform the operation
        '404':
          description: ' Not found, no active interactions for agent. No open call was found for the agent with the provided user ID'
        '422':
          description: Operation is not supported for internal calls
        '425':
          description: Interaction is locked while processing previous mask/unmask request. The unmask request cannot be handled since the service is busy with previous request.
        '500':
          description: Internal server error.
        '504':
          description: The request was timed out.
x-refined-from:
- nice-recording-interactions.json
- nice-recording-interactions-openapi.yml