Skip to main content

Uniphore Customer Portal

API Overview

This topic provides a brief overview/summary of the features and functions provided by each of the U-Capture APIs.

Many of the U-Capture APIs use filters to determine which conversations the request should apply to or get, filters use conversation metadata to only apply to or get conversations that match the filter's specific metadata conditions. See Filters for information to help build your understanding of how Filters work to various levels of complexity, as well as see a full list of filter parameters and valid values.

Reference

Description

Annotation APIs

Manage annotations in your U-Capture system. Annotations work as notes for a captured conversation, these can be offset to a specific time in the conversation and are categorized under annotation headers.

Audit Log API

Manage audit logs in your U-Capture system. Every Action and Event in the system is logged for system management and monitoring purposes.

Conversations APIs

Review your captured and live conversations (post-call and real-time).

Export APIs

Manage exports in your U-Capture system. An export is a method for exporting conversation data as a zip file - containing metadata, audio, and/or captured screen recordings.

Endpoint APIs

Define where your recorded data is exported to (export Endpoints) and stored in (Storage Location Endpoints).

Locks APIs

Manage the locks in your U-Capture system. Locks can be used to lock a recording to prevent manual or automatic deletion – great for things like legal hold, complaint resolution, specialized retention, etc.

Media APIs

Use the Media APIs to get links to the media (Audio, Screen Recording) for your captured conversations and get the audio for live conversations in realtime.

Policy APIs

Manage policies in your U-Capture system, U‑Capture Policies allow you to perform automated actions against your captured conversation data including recording control, retention and archiving, transcription, export, and access control. These are all designed to help with your regulatory and data retention and management requirements.

Preference APIs

Manage your saved views, the are used to determine what metadata columns to display and in what order, as well as setting a filter for the view to only show conversations matching specified criteria such as a specific date/time range.

User API

Get information about users.