Manage Endpoints and Storage Locations Introduction
Article Version 1.4
Endpoints and Storage Locations define where your recorded data is exported to (Endpoints) and stored (Storage Locations).
Endpoints
Endpoints are a way of defining a location to export captured data to. Once a data Endpoint is configured, using either the Webhook or Real-time Stream (Socket) Export Channel, automated export policies can be set up to export stored or live data (media, metadata, transcriptions). Using these policies, you can define specific recordings to export to your Endpoints and trigger the export automatically, as needed.
For information on how to view your existing Endpoints or create new Endpoints, see View and Create Endpoints.
For more information on export policies, see Export Policies in the Manage Communication Recording Agent Policies topic.
Storage Locations
Communication Recording Agent makes use of cloud storage to store your captured data (Audio, Metadata, transcriptions). Storage locations can be defined to provide additional “hot, warm, or cold storage” facilities and flexible archiving options. Combined with the Policy Engine features, these provide an extensive archive and storage policy capability to automatically move data between storage facilities for archive purposes.
For example, you may need to keep recent calls readily available for review, whereas older calls may only need to be kept for compliance purposes. Using automated storage policies, you can move your captured data from a "hot" storage location to a cheaper cold storage location when the captured data matches a specific condition set in a storage policy filter.
For information on how to view your existing Storage Locations or create new Storage Locations, see View and Create Storage Locations.
For more information on storage policies, see Storage Policies in the Manage Communication Recording Agent Policies topic.
Default Storage
To change your default storage location, where your captured calls are initially saved, use the /v1/media/external-storages APIs.
For detailed information on default storage APIs, including prerequisite information, essential considerations, and API request information, see the full Default Storage API documentation here.
Note
The default storage only stores captured media (audio and screen recording). Conversation metadata is stored in the Conversation Service regardless of the configured default storage.
Caution
Ideally, this configuration should be set as part of the initial deployment of Communication Recording Agent. However, if this configuration needs to be changed after initial deployment, there are important considerations to be made, including what happens to previously captured conversations and that changes are performed during maintenance windows. Please contact Uniphore support for guidance and assistance from the professional services team, and see the full Default Storage API documentation here.
New in this Article:
Version 1.1 of this article has the following general updates:
Screenshots have been updated to reflect enhancements on the Endpoints and Storage Locations pages.
Instructions updated to reflect adjustments to the navigation steps required to get to the Endpoints and Storage Locations pages.
Version 1.2 of this article has the following general updates:
U-Capture is now the Communication Recording Agent. This product name change has been made throughout the article, but may not be present in every aspect of the product at the time of reading.
Version 1.3 of this article has the following general updates:
A video has been created to demonstrate the steps to create a new Storage Location.
Version 1.4 of this article has the following general updates:
Information has been added above to highlight the Communication Recording Agent API capability to set an external (customer-side) storage location as the default storage for captured calls.
Endpoints and Storage Locations - FAQ
The following answers common questions about Endpoints and Storage Locations and provides links to further reading on each subject.
Q: What are Endpoints used for?
A: Endpoints define locations to export captured data (media, metadata, transcriptions) to. They utilize Webhook or Real-time Stream (Socket) channels and employ automated export policies to send specific recordings to your designated locations. For more information, see above, or seeView and Create Endpoints.
Q: What are Storage Locations used for?
A: Storage Locations provide cloud storage for captured data (audio, metadata, transcriptions) with flexible archiving options. They enable "hot, warm, or cold storage" facilities that can automatically move data between storage tiers for cost optimization and compliance purposes. For more information, see above, or see View and Create Storage Locations.
Q: How do I view my existing Endpoints?
A: Navigate to Configurations > Configure (under Communication Recording Agent) > Endpoints. You'll see a list showing Name, Description, Export Channel, URI, and Authentication status. Click the arrow > to view detailed properties. For more information, see View and Create Endpoints.
Q: How do I create a new Endpoint?
A: Go to Configurations > Configure > Endpoints, click + Create, select an Export Channel (Webhook or Realtime Stream), then enter required details including Name, URI, and optional settings like Authorization, Request Timeout, and Certificate security preferences. For more information, see View and Create Endpoints.
Q: How do I view my existing Storage Locations?
A: Navigate to Configurations > Configure (under Communication Recording Agent) > Storage Locations. You'll see a list displaying Name, Host, Bucket, Region, and Folder. Click the arrow > to see additional details like Access Key and Secret Key. For more information, see View and Create Storage Locations.
Q: How do I add a new Storage Location?
A: Go to Configuration > Configure > Storage Locations, click + Create, then enter details for your existing S3 bucket including Name, Host, Bucket, Region (e.g., eu-west-2), Access Key, and Secret Key. Optional fields include Description and Folder. For more information, see View and Create Storage Locations.
Q: What's an example use case for Storage Locations?
A: Recent calls can be kept in "hot" storage for easy review, while older calls needed only for compliance can be automatically moved to cheaper "cold" storage using automated storage policies based on specific conditions.