Skip to main content

NICE NTR or NRX

Overview​

A NICE Trading Recording (NTR) system is a deployment of the recording software developed and sold by NICE Systems. This system receives call recordings from 3rd party solutions, stores them and makes them available for search and replay.

The Focus integration allows for NICE NTR customers to pull communications from Focus into NICE.

This integration uses the NICE GET Interface.

warning

Please keep in mind that any data leaving the Focus platform is no longer covered by the security constrains built into the Focus. Any communications needed for evidential integrity (BS10008), ISO or GPR requests will still need to processed via Focus

Integration​

Most of the integration will be completed on the NICE NTR/NTX system directly that will request communications from the Focus NTR/NTX integration layer.

Once you have installed and setup the NICE GET installer (or if migrating to Focus) you will need to set the app settings within the Nice.Ingest.Get.CallPrrocessorService.exe.config file within your install directory.

NICe settings

You will need to set the bellow option:

  • DataExchangeURL: BASE_URL/ntr/api
  • AuthenticationType: Basic
warning

The Focus support team are not able to help with setting or updating this local configuration, please contact your NICE support contract if you need assistance. The below information is provided to help with integration only and not as a guild, your NICE integration documentation should assist you with setting up this service.

Supported endpoints​

Supported endpoints are:

All request types must be as per the NICE documentation.

Get call list​

Request example:​

  • Request type: GET
  • Content-Type: application/json
  • Request URL: BASE_URL/ntr/api/getcalllist
  • Authentication: Username / Password
  • Query string options (examples):
    • limit=10 - Seconds to process all calls in GetCallList
    • maxprocesstime=300 - Seconds to process all calls in GetCallList
  • Body: empty

Request response:​

{
    "calllist": [
        "10119",
        "10120",
        "10121",
        "10122",
        "10123",
        "10124",
        "10125",
        "10126",
        "10127",
        "10128"
    ]
}

Call Retrieve​

This endpoint is used to download the communications provided in the above list.

note

Only communications provided in the above list will be able to be downloaded

Request example:​

  • Request type: GET
  • Content-Type: application/json
  • Request URL: BASE_URL/ntr/api/callretrieve
  • Authentication: Username / Password
  • Query string options (examples):
    • callid=10119 - Callid from above list
  • Body: empty

Request response:​

The response will be a multipart message including Metadata and Media (Binary encoded) the metadata example is below:

{
  "StartTime": "2025-04-25T14:45:30.000Z",
  "EndTime": "2025-04-25T14:47:01.000Z",
  "CallId": "10119",
  "Duration": 91,
  "Direction": "Outbound",
  "CallingParty": "447778899110",
  "CalledParty": "447778899111",
  "AudioFile": {
    "FileName": "Recording-10119.mp3",
    "Md5Checksum": "3bd69bd765ddba74db7a1fba87d55d09"
  }
}

Call processed​

After processing the audio and Meta data, NICE should confirm that the sync was successful.

Request example:​

  • Request type: GET
  • Content-Type: application/json
  • Request URL: BASE_URL/api/ntr/api/callprocessed
  • Authentication: Username / Password
  • Body:
{
    "processresult": {
        "CallId": "10119",
        "code": "200",
        "description": "Handover successful. Audio ingested into NTR"
    }
}

Request response:​

{
    "callProcessedResult": {
        "processed": true,
        "callId": 10119
    }
}