This action downloads recordings from Genesys. It requires that the recording_info action has been run first to get the recording information.
You can define the start and end dates for the recording downloads, as well as the media type.
The recording_info table contains a column called 'action', which is not populated by CX Vizz. You can set the field for individual records to some value, for example 'download', and then pass
action_filter='download' to this action and it will only download recordings for those conversaitons. You can set max_concurrent_downloads to help with particularly large numbers of recordings.
The output_to parameter is required and should be set to a configured storage profile or, for backwards compatibility only, a direct storage destination.
- Preferred: Set output_to to a storage profile name and configure the actual destination under StorageProfiles:<profile-name>. For example, set output_to to 'recordings_archive' and configure StorageProfiles:recordings_archive = 's3://eu-west-2,##ACCESSKEY##,##SECRET##,mybucket'.
- S3 Storage (legacy inline format): 's3://<region>,<access key>,<secret>,<bucket name>'.
- Azure Blob Storage (legacy inline format): 'blob://<connectionstring>,<container>'.
- Local File Storage: Set output_to to 'file://<directory>'. The directory is the path to the directory where the files will be saved. For example, 'file:///tmp'. Note that this option is not available when CX Vizz is being run in a docker container.
- No storage: Set output_to to 'null://none'. This is provided for debugging purposes only.
Parameters
| Parameter | Description | |
|---|---|---|
| start_date | Required | the start date of the range to download |
| end_date | Required | the end date of the range to download |
| media_type | Optional | the media type to use (audio, chat, email, or message) |
| action_filter | Optional | the action filter to use |
| max_concurrent_downloads | Optional | the maximum number of concurrent downloads. Default is 40 unless specified here. |
| output_to | Required | where to output the downloaded recordings |
Tables Affected
Variables Set
No variables set.
Permissions needed
- recording:recording:view or recording:recordingSegment:view
Examples
- recordings( start_date='2024-01-01', end_date='2024-01-08', media_type='email', output_to='recordings_archive' )