Default Storage API
Use the external-storages API request to configure where your captured calls are initially saved (your default storage). This API enables you to utilize your customer-side storage to store your calls by default as soon as they are captured.
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. For more information, see Considerations below.
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.
Before adding your customer-side S3 bucket as the default storage, you must first add a CORS policy to the bucket to ensure security standards set by modern browsers are met. For more information. see Prerequisites below.
Once the prerequisites are met, use the following requests to manage your default storage:
Note
The Communication Recording Agent APIs use the following resiliency behaviors to ensure that requests continue to work as expected even when unexpected parameters are present:
Any query parameters in addition to those documented in the API requests linked above (parameters unknown by the system) are ignored.
When requests contain duplicate parameters, the last instance of that duplicated parameter is used for the request; all other duplicates are ignored.
For more information on the above, including examples, see API Overview.
Prerequisites
As mentioned above, before adding an S3 bucket as your default storage, you must first add a CORS policy to the bucket to ensure security standards set by modern browsers are met.
Note
This article does not cover the steps to create an S3 bucket. See the relevant S3 documentation from Amazon here.
Add the following CORS policy to your bucket to enforce that any traffic coming from uniphore.com is safe.
[
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"POST",
"GET",
"DELETE",
"PUT"
],
"AllowedOrigins": [
"https://*.uniphore.com"
],
"ExposeHeaders": [],
"MaxAgeSeconds": 0
}
]Considerations
As mentioned above, 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.
Important
Before making any changes to your default storage, please contact Uniphore support for guidance and assistance from the professional services team. The professional services team will ensure any changes are performed during maintenance windows to avoid any unanticipated issues.
When configuring your new default storage, consider that once the new default storage is configured, any captured call media currently stored in the Uniphore-provided default storage will no longer be accessible via the UI.
To manage your previously captured conversation media, stored in the Uniphore-provided default storage, either:
Keep old calls: Use a "Move Media" Storage Policy to move only your conversation media to a new storage location with matching details to the new default storage, where it's made available using the metadata stored in the Conversation Service.
Moving the conversation media to your customer-side default storage using a move media policy removes the media from Uniphore-provided storage.
Fresh start: Use a "Move Media" Storage Policy and an "Archive Metadata" Storage Policy to move all previously captured conversation media and metadata out of the system to a separate storage location. Then use a "Purge" Storage Policy to remove the previously stored conversations entirely from the system.
Moving the conversation media to your external storage location using a move media policy removes the media from Uniphore-provided storage. Archiving the conversation metadata to your external storage location using an archive metadata policy removes the metadata media from Uniphore Conversation Service. Using the purge policy completely removes any reference to the conversation from the system, including wavedata.json files in the Uniphore default storage and primary indexed metadata such as conversation IDs from the Conversation Service.
Please contact Uniphore support for guidance and assistance from the professional services team before making any changes. There are customer-specific considerations to take into account when deciding which region to use for optimal performance.
Changing regions may result in increased latency.
See the list of supported regions below.
Country | Region |
|---|---|
Australia | AP-SOUTHEAST-2 |
Europe | EU-CENTRAL-1 |
India | US-EAST-2 |
UAE | ME-CENTRAL-1 |
UK | EU-WEST-2 |
US | US-EAST-2 |