Access Recordings From External Applications

You can play back and download CXone Recordings from external applications, such as from your CRM system.

There are 2 main ways of accessing recordings from outside CXone:

Media Playback API

You can use this API to access CXone Recording media and metadata.

Use of the Media Playback API may require additional fees. Consult your contract or contact your CXone Account Representative for more information.

  • When playing back an interaction:

    • For voice-only and voice-and-screen media types, the API transfers the interaction metadata and a link to the media file.

    • For chat and email media types, the API transfers the interaction metadata and the transcript. If the media type is set to all (and not specifically set to chat or email), then if there is a screen recording, you will also get a link to the media file for digitalClosed Any non-voice channel such as chat, email, SMS, work item, and messaging channels interactions.

  • When downloading, the API transfers a link to the media file.

The Media Playback API is available in the DEVone Developer Community portal.

Before You Start

Before you can start using the Media Playback API, you must set up user permissions, generate an access key, and follow the registration and authentication process explained on the developer portal. Required permissions:

  • If you're searching for recordings that are not under your account, they you need the Search & Playback > Player > Play/download recordings: Play Any permission.

  • If you want the request to return Sentiments and Categories, they you also need the Search & Playback > Player > View sentiments and categories permission.

GET Contacts

Access the full contact (the entire interaction with all segments) based on ACD Call ID. The ACD Call ID depends on the ACD solution, for example, this is the same as the CXone Master Contact ID.

You can find the correct ACD Call ID in the following ways:

  • Use the Master Contact ID from the Contact History Report.

  • Use the ACD Call ID from the output of Data Extraction API Metadata entity.

Keep in mind that using the ACD Call ID GET method, you can play back or download interactions recorded from December 13, 2018. Accessing an interaction recorded before December 13, 2018 will give an Interaction Not Found error.

GET Statements

Access a recording statement based on ACD Contact ID and Statement ID. The ACD Contact ID depends on the ACD solution, for example, here the acdContactId is the Master Contact IDClosed The master or parent ID for one or more related contacts. A new master contact ID will be assigned if a contact has been transferred 3 or more times..

The URL returned by the API is valid for 30 minutes or the duration of the call, whichever is longer.

Access Media Files From Your CRM System

You can play back or download media files directly from your CRM system using a URL.

Generate the URL in Studio and integrate it into your CRM system. Professional Services can help you, but there might be a fee for this service. Contact your CXone Account Representative to learn more.

For example:

  • Play back the file:

    • Voice or digital recording: https://na1.nice-incontact.com/player/#/cxone-player/acd-contacts/acdContactId

    • Recorded statement:  https://na1.nice-incontact.com/player/#/cxone-player/acd-contacts/acdContactId/statements/statementId

    The URL for play back launches the CXone Player by default. You can configure it to open in other players.

  • Download the file:

    • Voice and screen recording: https://na1.nice-incontact.com/media-download/#/acd-contacts?acdContactId=acdContactId&isDownload=true

    • Voice only: https://na1.nice-incontact.com/media-download/#/acd-contacts?acdContactId=acdContactId&isDownload=true&mediaType=voice-only

    • Recorded statement: https://na1.nice-incontact.com/media-download/#/acd-contacts/acdContactId/statements/statementId?isDownload=true&mediaType=voice-only

    The filename is formatted as CXone recording_{agent name}_{call start time}[UTC]_{id}.mp4. Note that the date in the filename is in UTC, unlike the Player, which is displayed in your local time zone.

The acdContactId is the CXone Master Contact IDClosed The master or parent ID for one or more related contacts. A new master contact ID will be assigned if a contact has been transferred 3 or more times..